@appwrite.io/console 17.0.0 → 18.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/cjs/sdk.js +6007 -4860
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +6004 -4861
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +8009 -4863
- package/package.json +5 -2
- package/types/client.d.ts +25 -1
- package/types/enums/conversation-type.d.ts +9 -0
- package/types/enums/o-auth-2-auth-0-prompt.d.ts +5 -0
- package/types/enums/o-auth-2-discord-prompt.d.ts +4 -0
- package/types/enums/o-auth-2-github-prompt.d.ts +3 -0
- package/types/enums/o-auth-2-kakao-prompt.d.ts +6 -0
- package/types/enums/o-auth-2-microsoft-prompt.d.ts +6 -0
- package/types/enums/o-auth-2-okta-prompt.d.ts +5 -0
- package/types/enums/o-auth-2-salesforce-prompt.d.ts +4 -0
- package/types/enums/o-auth-2-zoho-prompt.d.ts +3 -0
- package/types/enums/project-email-template-id.d.ts +2 -1
- package/types/enums/project-o-auth-2-auth-0-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-2-discord-prompt.d.ts +4 -0
- package/types/enums/project-o-auth-2-git-hub-prompt.d.ts +3 -0
- package/types/enums/project-o-auth-2-kakao-prompt.d.ts +6 -0
- package/types/enums/project-o-auth-2-microsoft-prompt.d.ts +6 -0
- package/types/enums/project-o-auth-2-okta-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-2-salesforce-prompt.d.ts +4 -0
- package/types/enums/project-o-auth-2-zoho-prompt.d.ts +3 -0
- package/types/enums/query-suggestion-resource.d.ts +1 -1
- package/types/index.d.ts +22 -1
- package/types/models.d.ts +68 -7
- package/types/services/account.d.ts +57 -2
- package/types/services/assistant.d.ts +4 -4
- package/types/services/console.d.ts +2 -2
- package/types/services/databases.d.ts +4 -4
- package/types/services/domains.d.ts +4 -4
- package/types/services/growth.d.ts +100 -0
- package/types/services/manager.d.ts +25 -0
- package/types/services/messaging.d.ts +14 -2
- package/types/services/organizations.d.ts +0 -19
- package/types/services/project.d.ts +52 -20
- package/types/services/push.d.ts +153 -0
- package/types/services/tables-db.d.ts +37 -37
- package/types/services/users.d.ts +2 -2
- package/types/topic.d.ts +34 -0
|
@@ -1537,21 +1537,21 @@ export declare class Domains {
|
|
|
1537
1537
|
*
|
|
1538
1538
|
* @param {string} params.domainId - Domain unique ID.
|
|
1539
1539
|
* @throws {AppwriteException}
|
|
1540
|
-
* @returns {Promise<
|
|
1540
|
+
* @returns {Promise<string>}
|
|
1541
1541
|
*/
|
|
1542
1542
|
getZone(params: {
|
|
1543
1543
|
domainId: string;
|
|
1544
|
-
}): Promise<
|
|
1544
|
+
}): Promise<string>;
|
|
1545
1545
|
/**
|
|
1546
1546
|
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1547
1547
|
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1548
1548
|
*
|
|
1549
1549
|
* @param {string} domainId - Domain unique ID.
|
|
1550
1550
|
* @throws {AppwriteException}
|
|
1551
|
-
* @returns {Promise<
|
|
1551
|
+
* @returns {Promise<string>}
|
|
1552
1552
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1553
1553
|
*/
|
|
1554
|
-
getZone(domainId: string): Promise<
|
|
1554
|
+
getZone(domainId: string): Promise<string>;
|
|
1555
1555
|
/**
|
|
1556
1556
|
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1557
1557
|
* All parsed records are imported and then the main domain document is returned.
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Client, UploadProgress } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
import { ConversationType } from '../enums/conversation-type';
|
|
4
|
+
export declare class Growth {
|
|
5
|
+
client: Client;
|
|
6
|
+
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
* Create a conversation with the Appwrite team: support requests, product and docs feedback, enterprise, startup and partner applications, and event sponsorship requests. Signed in console users are identified by their session or JWT; everyone else must pass an email. Attach a file of up to 5MB to support and feedback conversations.
|
|
9
|
+
*
|
|
10
|
+
* @param {ConversationType} params.type - Conversation type.
|
|
11
|
+
* @param {string} params.email - Email address to reply to. Required without a console session, ignored with one.
|
|
12
|
+
* @param {string} params.name - Name of the person filing the conversation. Required for enterprise, startup, partner and sponsorship.
|
|
13
|
+
* @param {string} params.subject - Conversation subject.
|
|
14
|
+
* @param {string} params.message - Conversation message. Required for support, feedback, enterprise and partner.
|
|
15
|
+
* @param {string} params.organizationId - Organization ID the conversation is about. Kept only when the session user is a member.
|
|
16
|
+
* @param {string} params.projectId - Project ID the conversation is about. Kept only when it belongs to the kept organization.
|
|
17
|
+
* @param {object} params.attributes - Additional attributes for the conversation type, as an object or a JSON string.
|
|
18
|
+
* @param {File} params.attachment - File attachment, support and feedback only, max 5MB.
|
|
19
|
+
* @throws {AppwriteException}
|
|
20
|
+
* @returns {Promise<Models.GrowthConversation>}
|
|
21
|
+
*/
|
|
22
|
+
createConversation(params: {
|
|
23
|
+
type: ConversationType;
|
|
24
|
+
email?: string;
|
|
25
|
+
name?: string;
|
|
26
|
+
subject?: string;
|
|
27
|
+
message?: string;
|
|
28
|
+
organizationId?: string;
|
|
29
|
+
projectId?: string;
|
|
30
|
+
attributes?: object;
|
|
31
|
+
attachment?: File;
|
|
32
|
+
onProgress?: (progress: UploadProgress) => void;
|
|
33
|
+
}): Promise<Models.GrowthConversation>;
|
|
34
|
+
/**
|
|
35
|
+
* Create a conversation with the Appwrite team: support requests, product and docs feedback, enterprise, startup and partner applications, and event sponsorship requests. Signed in console users are identified by their session or JWT; everyone else must pass an email. Attach a file of up to 5MB to support and feedback conversations.
|
|
36
|
+
*
|
|
37
|
+
* @param {ConversationType} type - Conversation type.
|
|
38
|
+
* @param {string} email - Email address to reply to. Required without a console session, ignored with one.
|
|
39
|
+
* @param {string} name - Name of the person filing the conversation. Required for enterprise, startup, partner and sponsorship.
|
|
40
|
+
* @param {string} subject - Conversation subject.
|
|
41
|
+
* @param {string} message - Conversation message. Required for support, feedback, enterprise and partner.
|
|
42
|
+
* @param {string} organizationId - Organization ID the conversation is about. Kept only when the session user is a member.
|
|
43
|
+
* @param {string} projectId - Project ID the conversation is about. Kept only when it belongs to the kept organization.
|
|
44
|
+
* @param {object} attributes - Additional attributes for the conversation type, as an object or a JSON string.
|
|
45
|
+
* @param {File} attachment - File attachment, support and feedback only, max 5MB.
|
|
46
|
+
* @throws {AppwriteException}
|
|
47
|
+
* @returns {Promise<Models.GrowthConversation>}
|
|
48
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
|
+
*/
|
|
50
|
+
createConversation(type: ConversationType, email?: string, name?: string, subject?: string, message?: string, organizationId?: string, projectId?: string, attributes?: object, attachment?: File, onProgress?: (progress: UploadProgress) => void): Promise<Models.GrowthConversation>;
|
|
51
|
+
/**
|
|
52
|
+
* Record a self-hosted installation. Every report is stored as its own row; the admin email is optional because headless CLI installs create no account.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} params.email - Admin email from the installation, when an account was created.
|
|
55
|
+
* @param {string} params.name - Admin name.
|
|
56
|
+
* @param {string} params.version - Appwrite version.
|
|
57
|
+
* @param {string} params.domain - Installation domain.
|
|
58
|
+
* @param {string} params.database - Database adapter.
|
|
59
|
+
* @param {string} params.hostIp - Resolved installation host IP address.
|
|
60
|
+
* @param {string} params.userAgent - Installation user agent.
|
|
61
|
+
* @param {string} params.os - Installation operating system.
|
|
62
|
+
* @param {string} params.arch - Installation CPU architecture.
|
|
63
|
+
* @param {number} params.cpus - Installation CPU count.
|
|
64
|
+
* @param {number} params.ram - Installation RAM in MB.
|
|
65
|
+
* @throws {AppwriteException}
|
|
66
|
+
* @returns {Promise<{}>}
|
|
67
|
+
*/
|
|
68
|
+
createInstallation(params?: {
|
|
69
|
+
email?: string;
|
|
70
|
+
name?: string;
|
|
71
|
+
version?: string;
|
|
72
|
+
domain?: string;
|
|
73
|
+
database?: string;
|
|
74
|
+
hostIp?: string;
|
|
75
|
+
userAgent?: string;
|
|
76
|
+
os?: string;
|
|
77
|
+
arch?: string;
|
|
78
|
+
cpus?: number;
|
|
79
|
+
ram?: number;
|
|
80
|
+
}): Promise<{}>;
|
|
81
|
+
/**
|
|
82
|
+
* Record a self-hosted installation. Every report is stored as its own row; the admin email is optional because headless CLI installs create no account.
|
|
83
|
+
*
|
|
84
|
+
* @param {string} email - Admin email from the installation, when an account was created.
|
|
85
|
+
* @param {string} name - Admin name.
|
|
86
|
+
* @param {string} version - Appwrite version.
|
|
87
|
+
* @param {string} domain - Installation domain.
|
|
88
|
+
* @param {string} database - Database adapter.
|
|
89
|
+
* @param {string} hostIp - Resolved installation host IP address.
|
|
90
|
+
* @param {string} userAgent - Installation user agent.
|
|
91
|
+
* @param {string} os - Installation operating system.
|
|
92
|
+
* @param {string} arch - Installation CPU architecture.
|
|
93
|
+
* @param {number} cpus - Installation CPU count.
|
|
94
|
+
* @param {number} ram - Installation RAM in MB.
|
|
95
|
+
* @throws {AppwriteException}
|
|
96
|
+
* @returns {Promise<{}>}
|
|
97
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
98
|
+
*/
|
|
99
|
+
createInstallation(email?: string, name?: string, version?: string, domain?: string, database?: string, hostIp?: string, userAgent?: string, os?: string, arch?: string, cpus?: number, ram?: number): Promise<{}>;
|
|
100
|
+
}
|
|
@@ -123,6 +123,31 @@ export declare class Manager {
|
|
|
123
123
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
124
|
*/
|
|
125
125
|
deleteCache(region?: Region, cache?: CacheTarget, all?: boolean, database?: CacheDatabase, projectId?: string, collectionId?: string, documentId?: string): Promise<{}>;
|
|
126
|
+
/**
|
|
127
|
+
* Blocks or unblocks an organization, the same way a billing-limit block does. Blocking makes the organization read-only, disables its backup policies and spins down its dedicated databases.
|
|
128
|
+
*
|
|
129
|
+
* @param {string} params.teamId - Organization ID.
|
|
130
|
+
* @param {boolean} params.status - Organization status. Set to `false` to block and `true` to unblock.
|
|
131
|
+
* @param {string} params.reason - Optional reason when blocking, kept in the audit trail.
|
|
132
|
+
* @throws {AppwriteException}
|
|
133
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
134
|
+
*/
|
|
135
|
+
updateOrganizationStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
136
|
+
teamId: string;
|
|
137
|
+
status: boolean;
|
|
138
|
+
reason?: string;
|
|
139
|
+
}): Promise<Models.Organization<Preferences>>;
|
|
140
|
+
/**
|
|
141
|
+
* Blocks or unblocks an organization, the same way a billing-limit block does. Blocking makes the organization read-only, disables its backup policies and spins down its dedicated databases.
|
|
142
|
+
*
|
|
143
|
+
* @param {string} teamId - Organization ID.
|
|
144
|
+
* @param {boolean} status - Organization status. Set to `false` to block and `true` to unblock.
|
|
145
|
+
* @param {string} reason - Optional reason when blocking, kept in the audit trail.
|
|
146
|
+
* @throws {AppwriteException}
|
|
147
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
148
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
149
|
+
*/
|
|
150
|
+
updateOrganizationStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, status: boolean, reason?: string): Promise<Models.Organization<Preferences>>;
|
|
126
151
|
/**
|
|
127
152
|
* Updates a console user status using a user ID or email address.
|
|
128
153
|
*
|
|
@@ -42,6 +42,8 @@ export declare class Messaging {
|
|
|
42
42
|
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
43
43
|
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
44
44
|
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
45
|
+
* @param {string} params.replyToEmail - Email address to reply to. If not set, defaults to the sender email address.
|
|
46
|
+
* @param {string} params.replyToName - Name of the reply to recipient. If not set, defaults to the sender name.
|
|
45
47
|
* @param {boolean} params.draft - Is message a draft
|
|
46
48
|
* @param {boolean} params.html - Is content of type HTML
|
|
47
49
|
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
@@ -58,6 +60,8 @@ export declare class Messaging {
|
|
|
58
60
|
cc?: string[];
|
|
59
61
|
bcc?: string[];
|
|
60
62
|
attachments?: string[];
|
|
63
|
+
replyToEmail?: string;
|
|
64
|
+
replyToName?: string;
|
|
61
65
|
draft?: boolean;
|
|
62
66
|
html?: boolean;
|
|
63
67
|
scheduledAt?: string;
|
|
@@ -74,6 +78,8 @@ export declare class Messaging {
|
|
|
74
78
|
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
75
79
|
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
76
80
|
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
81
|
+
* @param {string} replyToEmail - Email address to reply to. If not set, defaults to the sender email address.
|
|
82
|
+
* @param {string} replyToName - Name of the reply to recipient. If not set, defaults to the sender name.
|
|
77
83
|
* @param {boolean} draft - Is message a draft
|
|
78
84
|
* @param {boolean} html - Is content of type HTML
|
|
79
85
|
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
@@ -81,7 +87,7 @@ export declare class Messaging {
|
|
|
81
87
|
* @returns {Promise<Models.Message>}
|
|
82
88
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
83
89
|
*/
|
|
84
|
-
createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
90
|
+
createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], replyToEmail?: string, replyToName?: string, draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
85
91
|
/**
|
|
86
92
|
* Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
87
93
|
*
|
|
@@ -96,6 +102,8 @@ export declare class Messaging {
|
|
|
96
102
|
* @param {boolean} params.html - Is content of type HTML
|
|
97
103
|
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
98
104
|
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
105
|
+
* @param {string} params.replyToEmail - Email address to reply to. Pass an empty string to restore the provider or sender default.
|
|
106
|
+
* @param {string} params.replyToName - Name of the reply to recipient. Pass an empty string to restore the provider or sender default.
|
|
99
107
|
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
100
108
|
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
101
109
|
* @throws {AppwriteException}
|
|
@@ -112,6 +120,8 @@ export declare class Messaging {
|
|
|
112
120
|
html?: boolean;
|
|
113
121
|
cc?: string[];
|
|
114
122
|
bcc?: string[];
|
|
123
|
+
replyToEmail?: string;
|
|
124
|
+
replyToName?: string;
|
|
115
125
|
scheduledAt?: string;
|
|
116
126
|
attachments?: string[];
|
|
117
127
|
}): Promise<Models.Message>;
|
|
@@ -129,13 +139,15 @@ export declare class Messaging {
|
|
|
129
139
|
* @param {boolean} html - Is content of type HTML
|
|
130
140
|
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
131
141
|
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
142
|
+
* @param {string} replyToEmail - Email address to reply to. Pass an empty string to restore the provider or sender default.
|
|
143
|
+
* @param {string} replyToName - Name of the reply to recipient. Pass an empty string to restore the provider or sender default.
|
|
132
144
|
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
133
145
|
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
134
146
|
* @throws {AppwriteException}
|
|
135
147
|
* @returns {Promise<Models.Message>}
|
|
136
148
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
137
149
|
*/
|
|
138
|
-
updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
|
|
150
|
+
updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], replyToEmail?: string, replyToName?: string, scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
|
|
139
151
|
/**
|
|
140
152
|
* Create a new push notification.
|
|
141
153
|
*
|
|
@@ -531,25 +531,6 @@ export declare class Organizations {
|
|
|
531
531
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
532
532
|
*/
|
|
533
533
|
getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
|
|
534
|
-
/**
|
|
535
|
-
* Get an estimate of the charge for the organization current billing cycle.
|
|
536
|
-
*
|
|
537
|
-
* @param {string} params.organizationId - Organization ID
|
|
538
|
-
* @throws {AppwriteException}
|
|
539
|
-
* @returns {Promise<Models.Estimation>}
|
|
540
|
-
*/
|
|
541
|
-
getEstimation(params: {
|
|
542
|
-
organizationId: string;
|
|
543
|
-
}): Promise<Models.Estimation>;
|
|
544
|
-
/**
|
|
545
|
-
* Get an estimate of the charge for the organization current billing cycle.
|
|
546
|
-
*
|
|
547
|
-
* @param {string} organizationId - Organization ID
|
|
548
|
-
* @throws {AppwriteException}
|
|
549
|
-
* @returns {Promise<Models.Estimation>}
|
|
550
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
551
|
-
*/
|
|
552
|
-
getEstimation(organizationId: string): Promise<Models.Estimation>;
|
|
553
534
|
/**
|
|
554
535
|
* Get estimation for deleting an organization.
|
|
555
536
|
*
|
|
@@ -2,8 +2,16 @@ import { Client } from '../client';
|
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { ProjectAuthMethodId } from '../enums/project-auth-method-id';
|
|
4
4
|
import { ProjectKeyScopes } from '../enums/project-key-scopes';
|
|
5
|
+
import { ProjectOAuth2Auth0Prompt } from '../enums/project-o-auth-2-auth-0-prompt';
|
|
6
|
+
import { ProjectOAuth2DiscordPrompt } from '../enums/project-o-auth-2-discord-prompt';
|
|
7
|
+
import { ProjectOAuth2GitHubPrompt } from '../enums/project-o-auth-2-git-hub-prompt';
|
|
5
8
|
import { ProjectOAuth2GooglePrompt } from '../enums/project-o-auth-2-google-prompt';
|
|
9
|
+
import { ProjectOAuth2KakaoPrompt } from '../enums/project-o-auth-2-kakao-prompt';
|
|
10
|
+
import { ProjectOAuth2MicrosoftPrompt } from '../enums/project-o-auth-2-microsoft-prompt';
|
|
6
11
|
import { ProjectOAuth2OidcPrompt } from '../enums/project-o-auth-2-oidc-prompt';
|
|
12
|
+
import { ProjectOAuth2OktaPrompt } from '../enums/project-o-auth-2-okta-prompt';
|
|
13
|
+
import { ProjectOAuth2SalesforcePrompt } from '../enums/project-o-auth-2-salesforce-prompt';
|
|
14
|
+
import { ProjectOAuth2ZohoPrompt } from '../enums/project-o-auth-2-zoho-prompt';
|
|
7
15
|
import { ProjectOAuthProviderId } from '../enums/project-o-auth-provider-id';
|
|
8
16
|
import { ProjectPolicyId } from '../enums/project-policy-id';
|
|
9
17
|
import { ProjectProtocolId } from '../enums/project-protocol-id';
|
|
@@ -498,6 +506,7 @@ export declare class Project {
|
|
|
498
506
|
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
499
507
|
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
500
508
|
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
509
|
+
* @param {ProjectOAuth2Auth0Prompt[]} params.prompt - Array of Auth0 OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Auth0 default.
|
|
501
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.
|
|
502
511
|
* @throws {AppwriteException}
|
|
503
512
|
* @returns {Promise<Models.OAuth2Auth0>}
|
|
@@ -506,6 +515,7 @@ export declare class Project {
|
|
|
506
515
|
clientId?: string;
|
|
507
516
|
clientSecret?: string;
|
|
508
517
|
endpoint?: string;
|
|
518
|
+
prompt?: ProjectOAuth2Auth0Prompt[];
|
|
509
519
|
enabled?: boolean;
|
|
510
520
|
}): Promise<Models.OAuth2Auth0>;
|
|
511
521
|
/**
|
|
@@ -514,12 +524,13 @@ export declare class Project {
|
|
|
514
524
|
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
515
525
|
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
516
526
|
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
527
|
+
* @param {ProjectOAuth2Auth0Prompt[]} prompt - Array of Auth0 OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Auth0 default.
|
|
517
528
|
* @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.
|
|
518
529
|
* @throws {AppwriteException}
|
|
519
530
|
* @returns {Promise<Models.OAuth2Auth0>}
|
|
520
531
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
521
532
|
*/
|
|
522
|
-
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
533
|
+
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, prompt?: ProjectOAuth2Auth0Prompt[], enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
523
534
|
/**
|
|
524
535
|
* Update the project OAuth2 Authentik configuration.
|
|
525
536
|
*
|
|
@@ -703,6 +714,7 @@ export declare class Project {
|
|
|
703
714
|
*
|
|
704
715
|
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
705
716
|
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
717
|
+
* @param {ProjectOAuth2DiscordPrompt[]} params.prompt - Array with at most one Discord OAuth2 prompt value. "none" means: skip the authorization screen for users who already authorized the app with the requested scopes. "consent" means: ask users who already authorized the app to approve it again. Pass an empty array to use the Discord default.
|
|
706
718
|
* @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.
|
|
707
719
|
* @throws {AppwriteException}
|
|
708
720
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -710,6 +722,7 @@ export declare class Project {
|
|
|
710
722
|
updateOAuth2Discord(params?: {
|
|
711
723
|
clientId?: string;
|
|
712
724
|
clientSecret?: string;
|
|
725
|
+
prompt?: ProjectOAuth2DiscordPrompt[];
|
|
713
726
|
enabled?: boolean;
|
|
714
727
|
}): Promise<Models.OAuth2Discord>;
|
|
715
728
|
/**
|
|
@@ -717,12 +730,13 @@ export declare class Project {
|
|
|
717
730
|
*
|
|
718
731
|
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
719
732
|
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
733
|
+
* @param {ProjectOAuth2DiscordPrompt[]} prompt - Array with at most one Discord OAuth2 prompt value. "none" means: skip the authorization screen for users who already authorized the app with the requested scopes. "consent" means: ask users who already authorized the app to approve it again. Pass an empty array to use the Discord default.
|
|
720
734
|
* @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.
|
|
721
735
|
* @throws {AppwriteException}
|
|
722
736
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
723
737
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
724
738
|
*/
|
|
725
|
-
updateOAuth2Discord(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
739
|
+
updateOAuth2Discord(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2DiscordPrompt[], enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
726
740
|
/**
|
|
727
741
|
* Update the project OAuth2 Disqus configuration.
|
|
728
742
|
*
|
|
@@ -881,6 +895,7 @@ export declare class Project {
|
|
|
881
895
|
*
|
|
882
896
|
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
883
897
|
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
898
|
+
* @param {ProjectOAuth2GitHubPrompt[]} params.prompt - Array of GitHub OAuth2 prompt values. "select_account" means: prompt the user to select an account. Pass an empty array to use the GitHub default.
|
|
884
899
|
* @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.
|
|
885
900
|
* @throws {AppwriteException}
|
|
886
901
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -888,6 +903,7 @@ export declare class Project {
|
|
|
888
903
|
updateOAuth2GitHub(params?: {
|
|
889
904
|
clientId?: string;
|
|
890
905
|
clientSecret?: string;
|
|
906
|
+
prompt?: ProjectOAuth2GitHubPrompt[];
|
|
891
907
|
enabled?: boolean;
|
|
892
908
|
}): Promise<Models.OAuth2Github>;
|
|
893
909
|
/**
|
|
@@ -895,12 +911,13 @@ export declare class Project {
|
|
|
895
911
|
*
|
|
896
912
|
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
897
913
|
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
914
|
+
* @param {ProjectOAuth2GitHubPrompt[]} prompt - Array of GitHub OAuth2 prompt values. "select_account" means: prompt the user to select an account. Pass an empty array to use the GitHub default.
|
|
898
915
|
* @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.
|
|
899
916
|
* @throws {AppwriteException}
|
|
900
917
|
* @returns {Promise<Models.OAuth2Github>}
|
|
901
918
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
902
919
|
*/
|
|
903
|
-
updateOAuth2GitHub(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
920
|
+
updateOAuth2GitHub(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GitHubPrompt[], enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
904
921
|
/**
|
|
905
922
|
* Update the project OAuth2 Gitlab configuration.
|
|
906
923
|
*
|
|
@@ -993,6 +1010,7 @@ export declare class Project {
|
|
|
993
1010
|
*
|
|
994
1011
|
* @param {string} params.clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
|
|
995
1012
|
* @param {string} params.clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
|
|
1013
|
+
* @param {ProjectOAuth2KakaoPrompt[]} params.prompt - Array of Kakao OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "create" means: prompt the user to sign up. "select_account" means: prompt the user to select an account. Pass an empty array to use the Kakao default.
|
|
996
1014
|
* @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.
|
|
997
1015
|
* @throws {AppwriteException}
|
|
998
1016
|
* @returns {Promise<Models.OAuth2Kakao>}
|
|
@@ -1000,6 +1018,7 @@ export declare class Project {
|
|
|
1000
1018
|
updateOAuth2Kakao(params?: {
|
|
1001
1019
|
clientId?: string;
|
|
1002
1020
|
clientSecret?: string;
|
|
1021
|
+
prompt?: ProjectOAuth2KakaoPrompt[];
|
|
1003
1022
|
enabled?: boolean;
|
|
1004
1023
|
}): Promise<Models.OAuth2Kakao>;
|
|
1005
1024
|
/**
|
|
@@ -1007,12 +1026,13 @@ export declare class Project {
|
|
|
1007
1026
|
*
|
|
1008
1027
|
* @param {string} clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
|
|
1009
1028
|
* @param {string} clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
|
|
1029
|
+
* @param {ProjectOAuth2KakaoPrompt[]} prompt - Array of Kakao OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "create" means: prompt the user to sign up. "select_account" means: prompt the user to select an account. Pass an empty array to use the Kakao default.
|
|
1010
1030
|
* @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.
|
|
1011
1031
|
* @throws {AppwriteException}
|
|
1012
1032
|
* @returns {Promise<Models.OAuth2Kakao>}
|
|
1013
1033
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1014
1034
|
*/
|
|
1015
|
-
updateOAuth2Kakao(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Kakao>;
|
|
1035
|
+
updateOAuth2Kakao(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2KakaoPrompt[], enabled?: boolean): Promise<Models.OAuth2Kakao>;
|
|
1016
1036
|
/**
|
|
1017
1037
|
* Update the project OAuth2 Keycloak configuration.
|
|
1018
1038
|
*
|
|
@@ -1100,6 +1120,7 @@ export declare class Project {
|
|
|
1100
1120
|
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
1101
1121
|
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
1102
1122
|
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
1123
|
+
* @param {ProjectOAuth2MicrosoftPrompt[]} params.prompt - Array of Microsoft OAuth2 prompt values. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account. Pass an empty array to use the Microsoft default.
|
|
1103
1124
|
* @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.
|
|
1104
1125
|
* @throws {AppwriteException}
|
|
1105
1126
|
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
@@ -1108,6 +1129,7 @@ export declare class Project {
|
|
|
1108
1129
|
applicationId?: string;
|
|
1109
1130
|
applicationSecret?: string;
|
|
1110
1131
|
tenant?: string;
|
|
1132
|
+
prompt?: ProjectOAuth2MicrosoftPrompt[];
|
|
1111
1133
|
enabled?: boolean;
|
|
1112
1134
|
}): Promise<Models.OAuth2Microsoft>;
|
|
1113
1135
|
/**
|
|
@@ -1116,12 +1138,13 @@ export declare class Project {
|
|
|
1116
1138
|
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
1117
1139
|
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
1118
1140
|
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
1141
|
+
* @param {ProjectOAuth2MicrosoftPrompt[]} prompt - Array of Microsoft OAuth2 prompt values. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account. Pass an empty array to use the Microsoft default.
|
|
1119
1142
|
* @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.
|
|
1120
1143
|
* @throws {AppwriteException}
|
|
1121
1144
|
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
1122
1145
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1123
1146
|
*/
|
|
1124
|
-
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
1147
|
+
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, prompt?: ProjectOAuth2MicrosoftPrompt[], enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
1125
1148
|
/**
|
|
1126
1149
|
* Update the project OAuth2 Notion configuration.
|
|
1127
1150
|
*
|
|
@@ -1197,6 +1220,7 @@ export declare class Project {
|
|
|
1197
1220
|
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1198
1221
|
* @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/
|
|
1199
1222
|
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1223
|
+
* @param {ProjectOAuth2OktaPrompt[]} params.prompt - Array of Okta OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Okta default.
|
|
1200
1224
|
* @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.
|
|
1201
1225
|
* @throws {AppwriteException}
|
|
1202
1226
|
* @returns {Promise<Models.OAuth2Okta>}
|
|
@@ -1206,6 +1230,7 @@ export declare class Project {
|
|
|
1206
1230
|
clientSecret?: string;
|
|
1207
1231
|
domain?: string;
|
|
1208
1232
|
authorizationServerId?: string;
|
|
1233
|
+
prompt?: ProjectOAuth2OktaPrompt[];
|
|
1209
1234
|
enabled?: boolean;
|
|
1210
1235
|
}): Promise<Models.OAuth2Okta>;
|
|
1211
1236
|
/**
|
|
@@ -1215,12 +1240,13 @@ export declare class Project {
|
|
|
1215
1240
|
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1216
1241
|
* @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/
|
|
1217
1242
|
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1243
|
+
* @param {ProjectOAuth2OktaPrompt[]} prompt - Array of Okta OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Okta default.
|
|
1218
1244
|
* @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.
|
|
1219
1245
|
* @throws {AppwriteException}
|
|
1220
1246
|
* @returns {Promise<Models.OAuth2Okta>}
|
|
1221
1247
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1222
1248
|
*/
|
|
1223
|
-
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
1249
|
+
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, prompt?: ProjectOAuth2OktaPrompt[], enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
1224
1250
|
/**
|
|
1225
1251
|
* Update the project OAuth2 Paypal configuration.
|
|
1226
1252
|
*
|
|
@@ -1326,6 +1352,7 @@ export declare class Project {
|
|
|
1326
1352
|
*
|
|
1327
1353
|
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1328
1354
|
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1355
|
+
* @param {ProjectOAuth2SalesforcePrompt[]} params.prompt - Array of Salesforce OAuth2 prompt values. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Salesforce default.
|
|
1329
1356
|
* @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.
|
|
1330
1357
|
* @throws {AppwriteException}
|
|
1331
1358
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1333,6 +1360,7 @@ export declare class Project {
|
|
|
1333
1360
|
updateOAuth2Salesforce(params?: {
|
|
1334
1361
|
customerKey?: string;
|
|
1335
1362
|
customerSecret?: string;
|
|
1363
|
+
prompt?: ProjectOAuth2SalesforcePrompt[];
|
|
1336
1364
|
enabled?: boolean;
|
|
1337
1365
|
}): Promise<Models.OAuth2Salesforce>;
|
|
1338
1366
|
/**
|
|
@@ -1340,12 +1368,13 @@ export declare class Project {
|
|
|
1340
1368
|
*
|
|
1341
1369
|
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1342
1370
|
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1371
|
+
* @param {ProjectOAuth2SalesforcePrompt[]} prompt - Array of Salesforce OAuth2 prompt values. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Salesforce default.
|
|
1343
1372
|
* @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.
|
|
1344
1373
|
* @throws {AppwriteException}
|
|
1345
1374
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
1346
1375
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1347
1376
|
*/
|
|
1348
|
-
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
1377
|
+
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, prompt?: ProjectOAuth2SalesforcePrompt[], enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
1349
1378
|
/**
|
|
1350
1379
|
* Update the project OAuth2 Slack configuration.
|
|
1351
1380
|
*
|
|
@@ -1626,6 +1655,7 @@ export declare class Project {
|
|
|
1626
1655
|
*
|
|
1627
1656
|
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1628
1657
|
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1658
|
+
* @param {ProjectOAuth2ZohoPrompt[]} params.prompt - Array of Zoho OAuth2 prompt values. "consent" means: prompt the user for consent. Pass an empty array to use the Zoho default.
|
|
1629
1659
|
* @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.
|
|
1630
1660
|
* @throws {AppwriteException}
|
|
1631
1661
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1633,6 +1663,7 @@ export declare class Project {
|
|
|
1633
1663
|
updateOAuth2Zoho(params?: {
|
|
1634
1664
|
clientId?: string;
|
|
1635
1665
|
clientSecret?: string;
|
|
1666
|
+
prompt?: ProjectOAuth2ZohoPrompt[];
|
|
1636
1667
|
enabled?: boolean;
|
|
1637
1668
|
}): Promise<Models.OAuth2Zoho>;
|
|
1638
1669
|
/**
|
|
@@ -1640,12 +1671,13 @@ export declare class Project {
|
|
|
1640
1671
|
*
|
|
1641
1672
|
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1642
1673
|
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1674
|
+
* @param {ProjectOAuth2ZohoPrompt[]} prompt - Array of Zoho OAuth2 prompt values. "consent" means: prompt the user for consent. Pass an empty array to use the Zoho default.
|
|
1643
1675
|
* @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.
|
|
1644
1676
|
* @throws {AppwriteException}
|
|
1645
1677
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1646
1678
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1647
1679
|
*/
|
|
1648
|
-
updateOAuth2Zoho(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1680
|
+
updateOAuth2Zoho(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2ZohoPrompt[], enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1649
1681
|
/**
|
|
1650
1682
|
* Update the project OAuth2 Zoom configuration.
|
|
1651
1683
|
*
|
|
@@ -2222,11 +2254,11 @@ export declare class Project {
|
|
|
2222
2254
|
*/
|
|
2223
2255
|
updatePasswordPersonalDataPolicy(enabled: boolean): Promise<Models.Project>;
|
|
2224
2256
|
/**
|
|
2225
|
-
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled,
|
|
2257
|
+
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.
|
|
2226
2258
|
*
|
|
2227
|
-
* @param {boolean} params.enabled - Toggle password pwned policy. Set to true to
|
|
2228
|
-
* @param {boolean} params.sessions - Whether
|
|
2229
|
-
* @param {boolean} params.users - Whether
|
|
2259
|
+
* @param {boolean} params.enabled - Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.
|
|
2260
|
+
* @param {boolean} params.sessions - Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.
|
|
2261
|
+
* @param {boolean} params.users - Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.
|
|
2230
2262
|
* @throws {AppwriteException}
|
|
2231
2263
|
* @returns {Promise<Models.Project>}
|
|
2232
2264
|
*/
|
|
@@ -2236,11 +2268,11 @@ export declare class Project {
|
|
|
2236
2268
|
users?: boolean;
|
|
2237
2269
|
}): Promise<Models.Project>;
|
|
2238
2270
|
/**
|
|
2239
|
-
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled,
|
|
2271
|
+
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.
|
|
2240
2272
|
*
|
|
2241
|
-
* @param {boolean} enabled - Toggle password pwned policy. Set to true to
|
|
2242
|
-
* @param {boolean} sessions - Whether
|
|
2243
|
-
* @param {boolean} users - Whether
|
|
2273
|
+
* @param {boolean} enabled - Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.
|
|
2274
|
+
* @param {boolean} sessions - Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.
|
|
2275
|
+
* @param {boolean} users - Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.
|
|
2244
2276
|
* @throws {AppwriteException}
|
|
2245
2277
|
* @returns {Promise<Models.Project>}
|
|
2246
2278
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -2525,7 +2557,7 @@ export declare class Project {
|
|
|
2525
2557
|
/**
|
|
2526
2558
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2527
2559
|
*
|
|
2528
|
-
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification
|
|
2560
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2529
2561
|
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2530
2562
|
* @param {string} params.subject - Subject of the email template. Can be up to 255 characters.
|
|
2531
2563
|
* @param {string} params.message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
@@ -2549,7 +2581,7 @@ export declare class Project {
|
|
|
2549
2581
|
/**
|
|
2550
2582
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2551
2583
|
*
|
|
2552
|
-
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification
|
|
2584
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2553
2585
|
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2554
2586
|
* @param {string} subject - Subject of the email template. Can be up to 255 characters.
|
|
2555
2587
|
* @param {string} message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
@@ -2565,7 +2597,7 @@ export declare class Project {
|
|
|
2565
2597
|
/**
|
|
2566
2598
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2567
2599
|
*
|
|
2568
|
-
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification
|
|
2600
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2569
2601
|
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2570
2602
|
* @throws {AppwriteException}
|
|
2571
2603
|
* @returns {Promise<Models.EmailTemplate>}
|
|
@@ -2577,7 +2609,7 @@ export declare class Project {
|
|
|
2577
2609
|
/**
|
|
2578
2610
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2579
2611
|
*
|
|
2580
|
-
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification
|
|
2612
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2581
2613
|
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2582
2614
|
* @throws {AppwriteException}
|
|
2583
2615
|
* @returns {Promise<Models.EmailTemplate>}
|