appwrite-web-server-preview-isomorphic-chiragagg5k 0.0.0-rc.2
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/LICENSE +1 -0
- package/README.md +46 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +23912 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +23884 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +27711 -0
- package/package.json +50 -0
- package/types/channel.d.ts +74 -0
- package/types/client.d.ts +345 -0
- package/types/enums/adapter.d.ts +4 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/authentication-factor.d.ts +6 -0
- package/types/enums/authenticator-type.d.ts +3 -0
- package/types/enums/backup-services.d.ts +8 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/browser.d.ts +16 -0
- package/types/enums/build-runtime.d.ts +94 -0
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/compression.d.ts +5 -0
- package/types/enums/credit-card.d.ts +19 -0
- package/types/enums/database-type.d.ts +6 -0
- package/types/enums/databases-index-type.d.ts +6 -0
- package/types/enums/deployment-download-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +8 -0
- package/types/enums/email-template-locale.d.ts +133 -0
- package/types/enums/email-template-type.d.ts +9 -0
- package/types/enums/execution-method.d.ts +9 -0
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/flag.d.ts +197 -0
- package/types/enums/framework.d.ts +17 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/image-format.d.ts +9 -0
- package/types/enums/image-gravity.d.ts +11 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/message-priority.d.ts +4 -0
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/messaging-provider-type.d.ts +5 -0
- package/types/enums/method-id.d.ts +9 -0
- package/types/enums/name.d.ts +15 -0
- package/types/enums/o-auth-provider.d.ts +45 -0
- package/types/enums/order-by.d.ts +4 -0
- package/types/enums/password-hash.d.ts +13 -0
- package/types/enums/platform-type.d.ts +7 -0
- package/types/enums/policy-id.d.ts +11 -0
- package/types/enums/protocol-id.d.ts +5 -0
- package/types/enums/relation-mutate.d.ts +5 -0
- package/types/enums/relationship-type.d.ts +6 -0
- package/types/enums/runtime.d.ts +94 -0
- package/types/enums/scopes.d.ts +89 -0
- package/types/enums/secure.d.ts +4 -0
- package/types/enums/service-id.d.ts +19 -0
- package/types/enums/smtp-encryption.d.ts +5 -0
- package/types/enums/tables-db-index-type.d.ts +6 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/vcs-reference-type.d.ts +5 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +85 -0
- package/types/models.d.ts +6555 -0
- package/types/operator.d.ts +180 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +442 -0
- package/types/role.d.ts +70 -0
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +1016 -0
- package/types/services/activities.d.ts +51 -0
- package/types/services/avatars.d.ts +327 -0
- package/types/services/backups.d.ts +282 -0
- package/types/services/databases.d.ts +2297 -0
- package/types/services/functions.d.ts +755 -0
- package/types/services/graphql.d.ts +50 -0
- package/types/services/health.d.ts +482 -0
- package/types/services/locale.d.ts +71 -0
- package/types/services/messaging.d.ts +1996 -0
- package/types/services/project.d.ts +2342 -0
- package/types/services/realtime.d.ts +155 -0
- package/types/services/sites.d.ts +714 -0
- package/types/services/storage.d.ts +428 -0
- package/types/services/tables-db.d.ts +2242 -0
- package/types/services/teams.d.ts +348 -0
- package/types/services/tokens.d.ts +124 -0
- package/types/services/users.d.ts +1191 -0
- package/types/services/webhooks.d.ts +176 -0
|
@@ -0,0 +1,2342 @@
|
|
|
1
|
+
import { Client, type ServerAuth } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
import { MethodId } from '../enums/method-id';
|
|
4
|
+
import { Scopes } from '../enums/scopes';
|
|
5
|
+
import { PolicyId } from '../enums/policy-id';
|
|
6
|
+
import { ProtocolId } from '../enums/protocol-id';
|
|
7
|
+
import { ServiceId } from '../enums/service-id';
|
|
8
|
+
import { Secure } from '../enums/secure';
|
|
9
|
+
import { EmailTemplateType } from '../enums/email-template-type';
|
|
10
|
+
import { EmailTemplateLocale } from '../enums/email-template-locale';
|
|
11
|
+
export type Project = Omit<ProjectRuntime, 'client'>;
|
|
12
|
+
declare class ProjectRuntime {
|
|
13
|
+
client: Client<ServerAuth>;
|
|
14
|
+
constructor(client: Client<ServerAuth>);
|
|
15
|
+
/**
|
|
16
|
+
* Delete a project.
|
|
17
|
+
*
|
|
18
|
+
* @throws {AppwriteException}
|
|
19
|
+
* @returns {Promise<{}>}
|
|
20
|
+
*/
|
|
21
|
+
delete(): Promise<{}>;
|
|
22
|
+
/**
|
|
23
|
+
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
24
|
+
*
|
|
25
|
+
* @param {MethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
26
|
+
* @param {boolean} params.enabled - Auth method status.
|
|
27
|
+
* @throws {AppwriteException}
|
|
28
|
+
* @returns {Promise<Models.Project>}
|
|
29
|
+
*/
|
|
30
|
+
updateAuthMethod(params: {
|
|
31
|
+
methodId: MethodId;
|
|
32
|
+
enabled: boolean;
|
|
33
|
+
}): Promise<Models.Project>;
|
|
34
|
+
/**
|
|
35
|
+
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
36
|
+
*
|
|
37
|
+
* @param {MethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
38
|
+
* @param {boolean} enabled - Auth method status.
|
|
39
|
+
* @throws {AppwriteException}
|
|
40
|
+
* @returns {Promise<Models.Project>}
|
|
41
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
|
+
*/
|
|
43
|
+
updateAuthMethod(methodId: MethodId, enabled: boolean): Promise<Models.Project>;
|
|
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>;
|
|
101
|
+
/**
|
|
102
|
+
* Get a list of all API keys from the current project.
|
|
103
|
+
*
|
|
104
|
+
* @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: expire, accessedAt, name, scopes
|
|
105
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
106
|
+
* @throws {AppwriteException}
|
|
107
|
+
* @returns {Promise<Models.KeyList>}
|
|
108
|
+
*/
|
|
109
|
+
listKeys(params?: {
|
|
110
|
+
queries?: string[];
|
|
111
|
+
total?: boolean;
|
|
112
|
+
}): Promise<Models.KeyList>;
|
|
113
|
+
/**
|
|
114
|
+
* Get a list of all API keys from the current project.
|
|
115
|
+
*
|
|
116
|
+
* @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: expire, accessedAt, name, scopes
|
|
117
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
118
|
+
* @throws {AppwriteException}
|
|
119
|
+
* @returns {Promise<Models.KeyList>}
|
|
120
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
121
|
+
*/
|
|
122
|
+
listKeys(queries?: string[], total?: boolean): Promise<Models.KeyList>;
|
|
123
|
+
/**
|
|
124
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
125
|
+
*
|
|
126
|
+
* You can also create an ephemeral API key if you need a short-lived key instead.
|
|
127
|
+
*
|
|
128
|
+
* @param {string} params.keyId - Key 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.
|
|
129
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
130
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
131
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
132
|
+
* @throws {AppwriteException}
|
|
133
|
+
* @returns {Promise<Models.Key>}
|
|
134
|
+
*/
|
|
135
|
+
createKey(params: {
|
|
136
|
+
keyId: string;
|
|
137
|
+
name: string;
|
|
138
|
+
scopes: Scopes[];
|
|
139
|
+
expire?: string;
|
|
140
|
+
}): Promise<Models.Key>;
|
|
141
|
+
/**
|
|
142
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
143
|
+
*
|
|
144
|
+
* You can also create an ephemeral API key if you need a short-lived key instead.
|
|
145
|
+
*
|
|
146
|
+
* @param {string} keyId - Key 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.
|
|
147
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
148
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
149
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
150
|
+
* @throws {AppwriteException}
|
|
151
|
+
* @returns {Promise<Models.Key>}
|
|
152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
153
|
+
*/
|
|
154
|
+
createKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
155
|
+
/**
|
|
156
|
+
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
157
|
+
*
|
|
158
|
+
* You can also create a standard API key if you need a longer-lived key instead.
|
|
159
|
+
*
|
|
160
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
161
|
+
* @param {number} params.duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
162
|
+
* @throws {AppwriteException}
|
|
163
|
+
* @returns {Promise<Models.EphemeralKey>}
|
|
164
|
+
*/
|
|
165
|
+
createEphemeralKey(params: {
|
|
166
|
+
scopes: Scopes[];
|
|
167
|
+
duration: number;
|
|
168
|
+
}): Promise<Models.EphemeralKey>;
|
|
169
|
+
/**
|
|
170
|
+
* Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
171
|
+
*
|
|
172
|
+
* You can also create a standard API key if you need a longer-lived key instead.
|
|
173
|
+
*
|
|
174
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
175
|
+
* @param {number} duration - Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
176
|
+
* @throws {AppwriteException}
|
|
177
|
+
* @returns {Promise<Models.EphemeralKey>}
|
|
178
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
179
|
+
*/
|
|
180
|
+
createEphemeralKey(scopes: Scopes[], duration: number): Promise<Models.EphemeralKey>;
|
|
181
|
+
/**
|
|
182
|
+
* Get a key by its unique ID.
|
|
183
|
+
*
|
|
184
|
+
* @param {string} params.keyId - Key ID.
|
|
185
|
+
* @throws {AppwriteException}
|
|
186
|
+
* @returns {Promise<Models.Key>}
|
|
187
|
+
*/
|
|
188
|
+
getKey(params: {
|
|
189
|
+
keyId: string;
|
|
190
|
+
}): Promise<Models.Key>;
|
|
191
|
+
/**
|
|
192
|
+
* Get a key by its unique ID.
|
|
193
|
+
*
|
|
194
|
+
* @param {string} keyId - Key ID.
|
|
195
|
+
* @throws {AppwriteException}
|
|
196
|
+
* @returns {Promise<Models.Key>}
|
|
197
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
198
|
+
*/
|
|
199
|
+
getKey(keyId: string): Promise<Models.Key>;
|
|
200
|
+
/**
|
|
201
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
202
|
+
*
|
|
203
|
+
* @param {string} params.keyId - Key ID.
|
|
204
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
205
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
206
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
207
|
+
* @throws {AppwriteException}
|
|
208
|
+
* @returns {Promise<Models.Key>}
|
|
209
|
+
*/
|
|
210
|
+
updateKey(params: {
|
|
211
|
+
keyId: string;
|
|
212
|
+
name: string;
|
|
213
|
+
scopes: Scopes[];
|
|
214
|
+
expire?: string;
|
|
215
|
+
}): Promise<Models.Key>;
|
|
216
|
+
/**
|
|
217
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
218
|
+
*
|
|
219
|
+
* @param {string} keyId - Key ID.
|
|
220
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
221
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
222
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
223
|
+
* @throws {AppwriteException}
|
|
224
|
+
* @returns {Promise<Models.Key>}
|
|
225
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
226
|
+
*/
|
|
227
|
+
updateKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
228
|
+
/**
|
|
229
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
230
|
+
*
|
|
231
|
+
* @param {string} params.keyId - Key ID.
|
|
232
|
+
* @throws {AppwriteException}
|
|
233
|
+
* @returns {Promise<{}>}
|
|
234
|
+
*/
|
|
235
|
+
deleteKey(params: {
|
|
236
|
+
keyId: string;
|
|
237
|
+
}): Promise<{}>;
|
|
238
|
+
/**
|
|
239
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
240
|
+
*
|
|
241
|
+
* @param {string} keyId - Key ID.
|
|
242
|
+
* @throws {AppwriteException}
|
|
243
|
+
* @returns {Promise<{}>}
|
|
244
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
245
|
+
*/
|
|
246
|
+
deleteKey(keyId: string): Promise<{}>;
|
|
247
|
+
/**
|
|
248
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
249
|
+
*
|
|
250
|
+
* @param {string[]} params.labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
251
|
+
* @throws {AppwriteException}
|
|
252
|
+
* @returns {Promise<Models.Project>}
|
|
253
|
+
*/
|
|
254
|
+
updateLabels(params: {
|
|
255
|
+
labels: string[];
|
|
256
|
+
}): Promise<Models.Project>;
|
|
257
|
+
/**
|
|
258
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
259
|
+
*
|
|
260
|
+
* @param {string[]} labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
261
|
+
* @throws {AppwriteException}
|
|
262
|
+
* @returns {Promise<Models.Project>}
|
|
263
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
264
|
+
*/
|
|
265
|
+
updateLabels(labels: string[]): Promise<Models.Project>;
|
|
266
|
+
/**
|
|
267
|
+
* Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.
|
|
268
|
+
*
|
|
269
|
+
* @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
|
|
270
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
271
|
+
* @throws {AppwriteException}
|
|
272
|
+
* @returns {Promise<Models.MockNumberList>}
|
|
273
|
+
*/
|
|
274
|
+
listMockPhones(params?: {
|
|
275
|
+
queries?: string[];
|
|
276
|
+
total?: boolean;
|
|
277
|
+
}): Promise<Models.MockNumberList>;
|
|
278
|
+
/**
|
|
279
|
+
* Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.
|
|
280
|
+
*
|
|
281
|
+
* @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
|
|
282
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
283
|
+
* @throws {AppwriteException}
|
|
284
|
+
* @returns {Promise<Models.MockNumberList>}
|
|
285
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
286
|
+
*/
|
|
287
|
+
listMockPhones(queries?: string[], total?: boolean): Promise<Models.MockNumberList>;
|
|
288
|
+
/**
|
|
289
|
+
* Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.
|
|
290
|
+
*
|
|
291
|
+
* @param {string} params.number - Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.
|
|
292
|
+
* @param {string} params.otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
293
|
+
* @throws {AppwriteException}
|
|
294
|
+
* @returns {Promise<Models.MockNumber>}
|
|
295
|
+
*/
|
|
296
|
+
createMockPhone(params: {
|
|
297
|
+
number: string;
|
|
298
|
+
otp: string;
|
|
299
|
+
}): Promise<Models.MockNumber>;
|
|
300
|
+
/**
|
|
301
|
+
* Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.
|
|
302
|
+
*
|
|
303
|
+
* @param {string} number - Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.
|
|
304
|
+
* @param {string} otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
305
|
+
* @throws {AppwriteException}
|
|
306
|
+
* @returns {Promise<Models.MockNumber>}
|
|
307
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
308
|
+
*/
|
|
309
|
+
createMockPhone(number: string, otp: string): Promise<Models.MockNumber>;
|
|
310
|
+
/**
|
|
311
|
+
* Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.
|
|
312
|
+
*
|
|
313
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
314
|
+
* @throws {AppwriteException}
|
|
315
|
+
* @returns {Promise<Models.MockNumber>}
|
|
316
|
+
*/
|
|
317
|
+
getMockPhone(params: {
|
|
318
|
+
number: string;
|
|
319
|
+
}): Promise<Models.MockNumber>;
|
|
320
|
+
/**
|
|
321
|
+
* Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.
|
|
322
|
+
*
|
|
323
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
324
|
+
* @throws {AppwriteException}
|
|
325
|
+
* @returns {Promise<Models.MockNumber>}
|
|
326
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
327
|
+
*/
|
|
328
|
+
getMockPhone(number: string): Promise<Models.MockNumber>;
|
|
329
|
+
/**
|
|
330
|
+
* Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.
|
|
331
|
+
*
|
|
332
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
333
|
+
* @param {string} params.otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
334
|
+
* @throws {AppwriteException}
|
|
335
|
+
* @returns {Promise<Models.MockNumber>}
|
|
336
|
+
*/
|
|
337
|
+
updateMockPhone(params: {
|
|
338
|
+
number: string;
|
|
339
|
+
otp: string;
|
|
340
|
+
}): Promise<Models.MockNumber>;
|
|
341
|
+
/**
|
|
342
|
+
* Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.
|
|
343
|
+
*
|
|
344
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
345
|
+
* @param {string} otp - One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
346
|
+
* @throws {AppwriteException}
|
|
347
|
+
* @returns {Promise<Models.MockNumber>}
|
|
348
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
349
|
+
*/
|
|
350
|
+
updateMockPhone(number: string, otp: string): Promise<Models.MockNumber>;
|
|
351
|
+
/**
|
|
352
|
+
* Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.
|
|
353
|
+
*
|
|
354
|
+
* @param {string} params.number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
355
|
+
* @throws {AppwriteException}
|
|
356
|
+
* @returns {Promise<{}>}
|
|
357
|
+
*/
|
|
358
|
+
deleteMockPhone(params: {
|
|
359
|
+
number: string;
|
|
360
|
+
}): Promise<{}>;
|
|
361
|
+
/**
|
|
362
|
+
* Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.
|
|
363
|
+
*
|
|
364
|
+
* @param {string} number - Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
365
|
+
* @throws {AppwriteException}
|
|
366
|
+
* @returns {Promise<{}>}
|
|
367
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
368
|
+
*/
|
|
369
|
+
deleteMockPhone(number: string): Promise<{}>;
|
|
370
|
+
/**
|
|
371
|
+
* Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.
|
|
372
|
+
*
|
|
373
|
+
* @throws {AppwriteException}
|
|
374
|
+
* @returns {Promise<Models.OAuth2ProviderList>}
|
|
375
|
+
*/
|
|
376
|
+
listOAuth2Providers(): Promise<Models.OAuth2ProviderList>;
|
|
377
|
+
/**
|
|
378
|
+
* Update the project OAuth2 Amazon configuration.
|
|
379
|
+
*
|
|
380
|
+
* @param {string} params.clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
381
|
+
* @param {string} params.clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
382
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
383
|
+
* @throws {AppwriteException}
|
|
384
|
+
* @returns {Promise<Models.OAuth2Amazon>}
|
|
385
|
+
*/
|
|
386
|
+
updateOAuth2Amazon(params?: {
|
|
387
|
+
clientId?: string;
|
|
388
|
+
clientSecret?: string;
|
|
389
|
+
enabled?: boolean;
|
|
390
|
+
}): Promise<Models.OAuth2Amazon>;
|
|
391
|
+
/**
|
|
392
|
+
* Update the project OAuth2 Amazon configuration.
|
|
393
|
+
*
|
|
394
|
+
* @param {string} clientId - 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
395
|
+
* @param {string} clientSecret - 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
396
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
397
|
+
* @throws {AppwriteException}
|
|
398
|
+
* @returns {Promise<Models.OAuth2Amazon>}
|
|
399
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
400
|
+
*/
|
|
401
|
+
updateOAuth2Amazon(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Amazon>;
|
|
402
|
+
/**
|
|
403
|
+
* Update the project OAuth2 Apple configuration.
|
|
404
|
+
*
|
|
405
|
+
* @param {string} params.serviceId - 'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web
|
|
406
|
+
* @param {string} params.keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
407
|
+
* @param {string} params.teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
408
|
+
* @param {string} params.p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
409
|
+
* @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.
|
|
410
|
+
* @throws {AppwriteException}
|
|
411
|
+
* @returns {Promise<Models.OAuth2Apple>}
|
|
412
|
+
*/
|
|
413
|
+
updateOAuth2Apple(params?: {
|
|
414
|
+
serviceId?: string;
|
|
415
|
+
keyId?: string;
|
|
416
|
+
teamId?: string;
|
|
417
|
+
p8File?: string;
|
|
418
|
+
enabled?: boolean;
|
|
419
|
+
}): Promise<Models.OAuth2Apple>;
|
|
420
|
+
/**
|
|
421
|
+
* Update the project OAuth2 Apple configuration.
|
|
422
|
+
*
|
|
423
|
+
* @param {string} serviceId - 'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web
|
|
424
|
+
* @param {string} keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
425
|
+
* @param {string} teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
426
|
+
* @param {string} p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
427
|
+
* @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.
|
|
428
|
+
* @throws {AppwriteException}
|
|
429
|
+
* @returns {Promise<Models.OAuth2Apple>}
|
|
430
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
431
|
+
*/
|
|
432
|
+
updateOAuth2Apple(serviceId?: string, keyId?: string, teamId?: string, p8File?: string, enabled?: boolean): Promise<Models.OAuth2Apple>;
|
|
433
|
+
/**
|
|
434
|
+
* Update the project OAuth2 Auth0 configuration.
|
|
435
|
+
*
|
|
436
|
+
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
437
|
+
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
438
|
+
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
439
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
440
|
+
* @throws {AppwriteException}
|
|
441
|
+
* @returns {Promise<Models.OAuth2Auth0>}
|
|
442
|
+
*/
|
|
443
|
+
updateOAuth2Auth0(params?: {
|
|
444
|
+
clientId?: string;
|
|
445
|
+
clientSecret?: string;
|
|
446
|
+
endpoint?: string;
|
|
447
|
+
enabled?: boolean;
|
|
448
|
+
}): Promise<Models.OAuth2Auth0>;
|
|
449
|
+
/**
|
|
450
|
+
* Update the project OAuth2 Auth0 configuration.
|
|
451
|
+
*
|
|
452
|
+
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
453
|
+
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
454
|
+
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
455
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
456
|
+
* @throws {AppwriteException}
|
|
457
|
+
* @returns {Promise<Models.OAuth2Auth0>}
|
|
458
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
459
|
+
*/
|
|
460
|
+
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
461
|
+
/**
|
|
462
|
+
* Update the project OAuth2 Authentik configuration.
|
|
463
|
+
*
|
|
464
|
+
* @param {string} params.clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
465
|
+
* @param {string} params.clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
466
|
+
* @param {string} params.endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
467
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
468
|
+
* @throws {AppwriteException}
|
|
469
|
+
* @returns {Promise<Models.OAuth2Authentik>}
|
|
470
|
+
*/
|
|
471
|
+
updateOAuth2Authentik(params?: {
|
|
472
|
+
clientId?: string;
|
|
473
|
+
clientSecret?: string;
|
|
474
|
+
endpoint?: string;
|
|
475
|
+
enabled?: boolean;
|
|
476
|
+
}): Promise<Models.OAuth2Authentik>;
|
|
477
|
+
/**
|
|
478
|
+
* Update the project OAuth2 Authentik configuration.
|
|
479
|
+
*
|
|
480
|
+
* @param {string} clientId - 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
481
|
+
* @param {string} clientSecret - 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
482
|
+
* @param {string} endpoint - Domain of Authentik instance. For example: example.authentik.com
|
|
483
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
484
|
+
* @throws {AppwriteException}
|
|
485
|
+
* @returns {Promise<Models.OAuth2Authentik>}
|
|
486
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
487
|
+
*/
|
|
488
|
+
updateOAuth2Authentik(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Authentik>;
|
|
489
|
+
/**
|
|
490
|
+
* Update the project OAuth2 Autodesk configuration.
|
|
491
|
+
*
|
|
492
|
+
* @param {string} params.clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
493
|
+
* @param {string} params.clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
494
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
495
|
+
* @throws {AppwriteException}
|
|
496
|
+
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
497
|
+
*/
|
|
498
|
+
updateOAuth2Autodesk(params?: {
|
|
499
|
+
clientId?: string;
|
|
500
|
+
clientSecret?: string;
|
|
501
|
+
enabled?: boolean;
|
|
502
|
+
}): Promise<Models.OAuth2Autodesk>;
|
|
503
|
+
/**
|
|
504
|
+
* Update the project OAuth2 Autodesk configuration.
|
|
505
|
+
*
|
|
506
|
+
* @param {string} clientId - 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
507
|
+
* @param {string} clientSecret - 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
508
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
509
|
+
* @throws {AppwriteException}
|
|
510
|
+
* @returns {Promise<Models.OAuth2Autodesk>}
|
|
511
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
512
|
+
*/
|
|
513
|
+
updateOAuth2Autodesk(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Autodesk>;
|
|
514
|
+
/**
|
|
515
|
+
* Update the project OAuth2 Bitbucket configuration.
|
|
516
|
+
*
|
|
517
|
+
* @param {string} params.key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
518
|
+
* @param {string} params.secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
519
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
520
|
+
* @throws {AppwriteException}
|
|
521
|
+
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
522
|
+
*/
|
|
523
|
+
updateOAuth2Bitbucket(params?: {
|
|
524
|
+
key?: string;
|
|
525
|
+
secret?: string;
|
|
526
|
+
enabled?: boolean;
|
|
527
|
+
}): Promise<Models.OAuth2Bitbucket>;
|
|
528
|
+
/**
|
|
529
|
+
* Update the project OAuth2 Bitbucket configuration.
|
|
530
|
+
*
|
|
531
|
+
* @param {string} key - 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
532
|
+
* @param {string} secret - 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
533
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
534
|
+
* @throws {AppwriteException}
|
|
535
|
+
* @returns {Promise<Models.OAuth2Bitbucket>}
|
|
536
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
537
|
+
*/
|
|
538
|
+
updateOAuth2Bitbucket(key?: string, secret?: string, enabled?: boolean): Promise<Models.OAuth2Bitbucket>;
|
|
539
|
+
/**
|
|
540
|
+
* Update the project OAuth2 Bitly configuration.
|
|
541
|
+
*
|
|
542
|
+
* @param {string} params.clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
543
|
+
* @param {string} params.clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
544
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
545
|
+
* @throws {AppwriteException}
|
|
546
|
+
* @returns {Promise<Models.OAuth2Bitly>}
|
|
547
|
+
*/
|
|
548
|
+
updateOAuth2Bitly(params?: {
|
|
549
|
+
clientId?: string;
|
|
550
|
+
clientSecret?: string;
|
|
551
|
+
enabled?: boolean;
|
|
552
|
+
}): Promise<Models.OAuth2Bitly>;
|
|
553
|
+
/**
|
|
554
|
+
* Update the project OAuth2 Bitly configuration.
|
|
555
|
+
*
|
|
556
|
+
* @param {string} clientId - 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
557
|
+
* @param {string} clientSecret - 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
558
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
559
|
+
* @throws {AppwriteException}
|
|
560
|
+
* @returns {Promise<Models.OAuth2Bitly>}
|
|
561
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
562
|
+
*/
|
|
563
|
+
updateOAuth2Bitly(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Bitly>;
|
|
564
|
+
/**
|
|
565
|
+
* Update the project OAuth2 Box configuration.
|
|
566
|
+
*
|
|
567
|
+
* @param {string} params.clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
568
|
+
* @param {string} params.clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
569
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
570
|
+
* @throws {AppwriteException}
|
|
571
|
+
* @returns {Promise<Models.OAuth2Box>}
|
|
572
|
+
*/
|
|
573
|
+
updateOAuth2Box(params?: {
|
|
574
|
+
clientId?: string;
|
|
575
|
+
clientSecret?: string;
|
|
576
|
+
enabled?: boolean;
|
|
577
|
+
}): Promise<Models.OAuth2Box>;
|
|
578
|
+
/**
|
|
579
|
+
* Update the project OAuth2 Box configuration.
|
|
580
|
+
*
|
|
581
|
+
* @param {string} clientId - 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
582
|
+
* @param {string} clientSecret - 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
583
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
584
|
+
* @throws {AppwriteException}
|
|
585
|
+
* @returns {Promise<Models.OAuth2Box>}
|
|
586
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
587
|
+
*/
|
|
588
|
+
updateOAuth2Box(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Box>;
|
|
589
|
+
/**
|
|
590
|
+
* Update the project OAuth2 Dailymotion configuration.
|
|
591
|
+
*
|
|
592
|
+
* @param {string} params.apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
593
|
+
* @param {string} params.apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
594
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
595
|
+
* @throws {AppwriteException}
|
|
596
|
+
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
597
|
+
*/
|
|
598
|
+
updateOAuth2Dailymotion(params?: {
|
|
599
|
+
apiKey?: string;
|
|
600
|
+
apiSecret?: string;
|
|
601
|
+
enabled?: boolean;
|
|
602
|
+
}): Promise<Models.OAuth2Dailymotion>;
|
|
603
|
+
/**
|
|
604
|
+
* Update the project OAuth2 Dailymotion configuration.
|
|
605
|
+
*
|
|
606
|
+
* @param {string} apiKey - 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
607
|
+
* @param {string} apiSecret - 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
608
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
609
|
+
* @throws {AppwriteException}
|
|
610
|
+
* @returns {Promise<Models.OAuth2Dailymotion>}
|
|
611
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
612
|
+
*/
|
|
613
|
+
updateOAuth2Dailymotion(apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.OAuth2Dailymotion>;
|
|
614
|
+
/**
|
|
615
|
+
* Update the project OAuth2 Discord configuration.
|
|
616
|
+
*
|
|
617
|
+
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
618
|
+
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
619
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
620
|
+
* @throws {AppwriteException}
|
|
621
|
+
* @returns {Promise<Models.OAuth2Discord>}
|
|
622
|
+
*/
|
|
623
|
+
updateOAuth2Discord(params?: {
|
|
624
|
+
clientId?: string;
|
|
625
|
+
clientSecret?: string;
|
|
626
|
+
enabled?: boolean;
|
|
627
|
+
}): Promise<Models.OAuth2Discord>;
|
|
628
|
+
/**
|
|
629
|
+
* Update the project OAuth2 Discord configuration.
|
|
630
|
+
*
|
|
631
|
+
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
632
|
+
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
633
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
634
|
+
* @throws {AppwriteException}
|
|
635
|
+
* @returns {Promise<Models.OAuth2Discord>}
|
|
636
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
637
|
+
*/
|
|
638
|
+
updateOAuth2Discord(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
639
|
+
/**
|
|
640
|
+
* Update the project OAuth2 Disqus configuration.
|
|
641
|
+
*
|
|
642
|
+
* @param {string} params.publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
643
|
+
* @param {string} params.secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
644
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
645
|
+
* @throws {AppwriteException}
|
|
646
|
+
* @returns {Promise<Models.OAuth2Disqus>}
|
|
647
|
+
*/
|
|
648
|
+
updateOAuth2Disqus(params?: {
|
|
649
|
+
publicKey?: string;
|
|
650
|
+
secretKey?: string;
|
|
651
|
+
enabled?: boolean;
|
|
652
|
+
}): Promise<Models.OAuth2Disqus>;
|
|
653
|
+
/**
|
|
654
|
+
* Update the project OAuth2 Disqus configuration.
|
|
655
|
+
*
|
|
656
|
+
* @param {string} publicKey - 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
657
|
+
* @param {string} secretKey - 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
658
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
659
|
+
* @throws {AppwriteException}
|
|
660
|
+
* @returns {Promise<Models.OAuth2Disqus>}
|
|
661
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
662
|
+
*/
|
|
663
|
+
updateOAuth2Disqus(publicKey?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Disqus>;
|
|
664
|
+
/**
|
|
665
|
+
* Update the project OAuth2 Dropbox configuration.
|
|
666
|
+
*
|
|
667
|
+
* @param {string} params.appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
668
|
+
* @param {string} params.appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
669
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
670
|
+
* @throws {AppwriteException}
|
|
671
|
+
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
672
|
+
*/
|
|
673
|
+
updateOAuth2Dropbox(params?: {
|
|
674
|
+
appKey?: string;
|
|
675
|
+
appSecret?: string;
|
|
676
|
+
enabled?: boolean;
|
|
677
|
+
}): Promise<Models.OAuth2Dropbox>;
|
|
678
|
+
/**
|
|
679
|
+
* Update the project OAuth2 Dropbox configuration.
|
|
680
|
+
*
|
|
681
|
+
* @param {string} appKey - 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
682
|
+
* @param {string} appSecret - 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
683
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
684
|
+
* @throws {AppwriteException}
|
|
685
|
+
* @returns {Promise<Models.OAuth2Dropbox>}
|
|
686
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
687
|
+
*/
|
|
688
|
+
updateOAuth2Dropbox(appKey?: string, appSecret?: string, enabled?: boolean): Promise<Models.OAuth2Dropbox>;
|
|
689
|
+
/**
|
|
690
|
+
* Update the project OAuth2 Etsy configuration.
|
|
691
|
+
*
|
|
692
|
+
* @param {string} params.keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
693
|
+
* @param {string} params.sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
694
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
695
|
+
* @throws {AppwriteException}
|
|
696
|
+
* @returns {Promise<Models.OAuth2Etsy>}
|
|
697
|
+
*/
|
|
698
|
+
updateOAuth2Etsy(params?: {
|
|
699
|
+
keyString?: string;
|
|
700
|
+
sharedSecret?: string;
|
|
701
|
+
enabled?: boolean;
|
|
702
|
+
}): Promise<Models.OAuth2Etsy>;
|
|
703
|
+
/**
|
|
704
|
+
* Update the project OAuth2 Etsy configuration.
|
|
705
|
+
*
|
|
706
|
+
* @param {string} keyString - 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
707
|
+
* @param {string} sharedSecret - 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
708
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
709
|
+
* @throws {AppwriteException}
|
|
710
|
+
* @returns {Promise<Models.OAuth2Etsy>}
|
|
711
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
712
|
+
*/
|
|
713
|
+
updateOAuth2Etsy(keyString?: string, sharedSecret?: string, enabled?: boolean): Promise<Models.OAuth2Etsy>;
|
|
714
|
+
/**
|
|
715
|
+
* Update the project OAuth2 Facebook configuration.
|
|
716
|
+
*
|
|
717
|
+
* @param {string} params.appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
718
|
+
* @param {string} params.appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
719
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
720
|
+
* @throws {AppwriteException}
|
|
721
|
+
* @returns {Promise<Models.OAuth2Facebook>}
|
|
722
|
+
*/
|
|
723
|
+
updateOAuth2Facebook(params?: {
|
|
724
|
+
appId?: string;
|
|
725
|
+
appSecret?: string;
|
|
726
|
+
enabled?: boolean;
|
|
727
|
+
}): Promise<Models.OAuth2Facebook>;
|
|
728
|
+
/**
|
|
729
|
+
* Update the project OAuth2 Facebook configuration.
|
|
730
|
+
*
|
|
731
|
+
* @param {string} appId - 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
732
|
+
* @param {string} appSecret - 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
733
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
734
|
+
* @throws {AppwriteException}
|
|
735
|
+
* @returns {Promise<Models.OAuth2Facebook>}
|
|
736
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
737
|
+
*/
|
|
738
|
+
updateOAuth2Facebook(appId?: string, appSecret?: string, enabled?: boolean): Promise<Models.OAuth2Facebook>;
|
|
739
|
+
/**
|
|
740
|
+
* Update the project OAuth2 Figma configuration.
|
|
741
|
+
*
|
|
742
|
+
* @param {string} params.clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
743
|
+
* @param {string} params.clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
744
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
745
|
+
* @throws {AppwriteException}
|
|
746
|
+
* @returns {Promise<Models.OAuth2Figma>}
|
|
747
|
+
*/
|
|
748
|
+
updateOAuth2Figma(params?: {
|
|
749
|
+
clientId?: string;
|
|
750
|
+
clientSecret?: string;
|
|
751
|
+
enabled?: boolean;
|
|
752
|
+
}): Promise<Models.OAuth2Figma>;
|
|
753
|
+
/**
|
|
754
|
+
* Update the project OAuth2 Figma configuration.
|
|
755
|
+
*
|
|
756
|
+
* @param {string} clientId - 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
757
|
+
* @param {string} clientSecret - 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
758
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
759
|
+
* @throws {AppwriteException}
|
|
760
|
+
* @returns {Promise<Models.OAuth2Figma>}
|
|
761
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
762
|
+
*/
|
|
763
|
+
updateOAuth2Figma(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Figma>;
|
|
764
|
+
/**
|
|
765
|
+
* Update the project OAuth2 FusionAuth configuration.
|
|
766
|
+
*
|
|
767
|
+
* @param {string} params.clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
768
|
+
* @param {string} params.clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
769
|
+
* @param {string} params.endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
770
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
771
|
+
* @throws {AppwriteException}
|
|
772
|
+
* @returns {Promise<Models.OAuth2FusionAuth>}
|
|
773
|
+
*/
|
|
774
|
+
updateOAuth2FusionAuth(params?: {
|
|
775
|
+
clientId?: string;
|
|
776
|
+
clientSecret?: string;
|
|
777
|
+
endpoint?: string;
|
|
778
|
+
enabled?: boolean;
|
|
779
|
+
}): Promise<Models.OAuth2FusionAuth>;
|
|
780
|
+
/**
|
|
781
|
+
* Update the project OAuth2 FusionAuth configuration.
|
|
782
|
+
*
|
|
783
|
+
* @param {string} clientId - 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
784
|
+
* @param {string} clientSecret - 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
785
|
+
* @param {string} endpoint - Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
786
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
787
|
+
* @throws {AppwriteException}
|
|
788
|
+
* @returns {Promise<Models.OAuth2FusionAuth>}
|
|
789
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
790
|
+
*/
|
|
791
|
+
updateOAuth2FusionAuth(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2FusionAuth>;
|
|
792
|
+
/**
|
|
793
|
+
* Update the project OAuth2 GitHub configuration.
|
|
794
|
+
*
|
|
795
|
+
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
796
|
+
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
797
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
798
|
+
* @throws {AppwriteException}
|
|
799
|
+
* @returns {Promise<Models.OAuth2Github>}
|
|
800
|
+
*/
|
|
801
|
+
updateOAuth2GitHub(params?: {
|
|
802
|
+
clientId?: string;
|
|
803
|
+
clientSecret?: string;
|
|
804
|
+
enabled?: boolean;
|
|
805
|
+
}): Promise<Models.OAuth2Github>;
|
|
806
|
+
/**
|
|
807
|
+
* Update the project OAuth2 GitHub configuration.
|
|
808
|
+
*
|
|
809
|
+
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
810
|
+
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
811
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
812
|
+
* @throws {AppwriteException}
|
|
813
|
+
* @returns {Promise<Models.OAuth2Github>}
|
|
814
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
815
|
+
*/
|
|
816
|
+
updateOAuth2GitHub(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
817
|
+
/**
|
|
818
|
+
* Update the project OAuth2 Gitlab configuration.
|
|
819
|
+
*
|
|
820
|
+
* @param {string} params.applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
821
|
+
* @param {string} params.secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
822
|
+
* @param {string} params.endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
823
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
824
|
+
* @throws {AppwriteException}
|
|
825
|
+
* @returns {Promise<Models.OAuth2Gitlab>}
|
|
826
|
+
*/
|
|
827
|
+
updateOAuth2Gitlab(params?: {
|
|
828
|
+
applicationId?: string;
|
|
829
|
+
secret?: string;
|
|
830
|
+
endpoint?: string;
|
|
831
|
+
enabled?: boolean;
|
|
832
|
+
}): Promise<Models.OAuth2Gitlab>;
|
|
833
|
+
/**
|
|
834
|
+
* Update the project OAuth2 Gitlab configuration.
|
|
835
|
+
*
|
|
836
|
+
* @param {string} applicationId - 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
837
|
+
* @param {string} secret - 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
838
|
+
* @param {string} endpoint - Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
839
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
840
|
+
* @throws {AppwriteException}
|
|
841
|
+
* @returns {Promise<Models.OAuth2Gitlab>}
|
|
842
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
843
|
+
*/
|
|
844
|
+
updateOAuth2Gitlab(applicationId?: string, secret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Gitlab>;
|
|
845
|
+
/**
|
|
846
|
+
* Update the project OAuth2 Google configuration.
|
|
847
|
+
*
|
|
848
|
+
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
849
|
+
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
850
|
+
* @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
|
+
* @throws {AppwriteException}
|
|
852
|
+
* @returns {Promise<Models.OAuth2Google>}
|
|
853
|
+
*/
|
|
854
|
+
updateOAuth2Google(params?: {
|
|
855
|
+
clientId?: string;
|
|
856
|
+
clientSecret?: string;
|
|
857
|
+
enabled?: boolean;
|
|
858
|
+
}): Promise<Models.OAuth2Google>;
|
|
859
|
+
/**
|
|
860
|
+
* Update the project OAuth2 Google configuration.
|
|
861
|
+
*
|
|
862
|
+
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
863
|
+
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
864
|
+
* @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
|
+
* @throws {AppwriteException}
|
|
866
|
+
* @returns {Promise<Models.OAuth2Google>}
|
|
867
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
868
|
+
*/
|
|
869
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
870
|
+
/**
|
|
871
|
+
* Update the project OAuth2 Keycloak configuration.
|
|
872
|
+
*
|
|
873
|
+
* @param {string} params.clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
874
|
+
* @param {string} params.clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
875
|
+
* @param {string} params.endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
876
|
+
* @param {string} params.realmName - Keycloak realm name. For example: appwrite-realm
|
|
877
|
+
* @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.
|
|
878
|
+
* @throws {AppwriteException}
|
|
879
|
+
* @returns {Promise<Models.OAuth2Keycloak>}
|
|
880
|
+
*/
|
|
881
|
+
updateOAuth2Keycloak(params?: {
|
|
882
|
+
clientId?: string;
|
|
883
|
+
clientSecret?: string;
|
|
884
|
+
endpoint?: string;
|
|
885
|
+
realmName?: string;
|
|
886
|
+
enabled?: boolean;
|
|
887
|
+
}): Promise<Models.OAuth2Keycloak>;
|
|
888
|
+
/**
|
|
889
|
+
* Update the project OAuth2 Keycloak configuration.
|
|
890
|
+
*
|
|
891
|
+
* @param {string} clientId - 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
892
|
+
* @param {string} clientSecret - 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
893
|
+
* @param {string} endpoint - Domain of Keycloak instance. For example: keycloak.example.com
|
|
894
|
+
* @param {string} realmName - Keycloak realm name. For example: appwrite-realm
|
|
895
|
+
* @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.
|
|
896
|
+
* @throws {AppwriteException}
|
|
897
|
+
* @returns {Promise<Models.OAuth2Keycloak>}
|
|
898
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
899
|
+
*/
|
|
900
|
+
updateOAuth2Keycloak(clientId?: string, clientSecret?: string, endpoint?: string, realmName?: string, enabled?: boolean): Promise<Models.OAuth2Keycloak>;
|
|
901
|
+
/**
|
|
902
|
+
* Update the project OAuth2 Kick configuration.
|
|
903
|
+
*
|
|
904
|
+
* @param {string} params.clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
905
|
+
* @param {string} params.clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
906
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
907
|
+
* @throws {AppwriteException}
|
|
908
|
+
* @returns {Promise<Models.OAuth2Kick>}
|
|
909
|
+
*/
|
|
910
|
+
updateOAuth2Kick(params?: {
|
|
911
|
+
clientId?: string;
|
|
912
|
+
clientSecret?: string;
|
|
913
|
+
enabled?: boolean;
|
|
914
|
+
}): Promise<Models.OAuth2Kick>;
|
|
915
|
+
/**
|
|
916
|
+
* Update the project OAuth2 Kick configuration.
|
|
917
|
+
*
|
|
918
|
+
* @param {string} clientId - 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
919
|
+
* @param {string} clientSecret - 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
920
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
921
|
+
* @throws {AppwriteException}
|
|
922
|
+
* @returns {Promise<Models.OAuth2Kick>}
|
|
923
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
924
|
+
*/
|
|
925
|
+
updateOAuth2Kick(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Kick>;
|
|
926
|
+
/**
|
|
927
|
+
* Update the project OAuth2 Linkedin configuration.
|
|
928
|
+
*
|
|
929
|
+
* @param {string} params.clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
930
|
+
* @param {string} params.primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
931
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
932
|
+
* @throws {AppwriteException}
|
|
933
|
+
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
934
|
+
*/
|
|
935
|
+
updateOAuth2Linkedin(params?: {
|
|
936
|
+
clientId?: string;
|
|
937
|
+
primaryClientSecret?: string;
|
|
938
|
+
enabled?: boolean;
|
|
939
|
+
}): Promise<Models.OAuth2Linkedin>;
|
|
940
|
+
/**
|
|
941
|
+
* Update the project OAuth2 Linkedin configuration.
|
|
942
|
+
*
|
|
943
|
+
* @param {string} clientId - 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
944
|
+
* @param {string} primaryClientSecret - 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
945
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
946
|
+
* @throws {AppwriteException}
|
|
947
|
+
* @returns {Promise<Models.OAuth2Linkedin>}
|
|
948
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
949
|
+
*/
|
|
950
|
+
updateOAuth2Linkedin(clientId?: string, primaryClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Linkedin>;
|
|
951
|
+
/**
|
|
952
|
+
* Update the project OAuth2 Microsoft configuration.
|
|
953
|
+
*
|
|
954
|
+
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
955
|
+
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
956
|
+
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
957
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
958
|
+
* @throws {AppwriteException}
|
|
959
|
+
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
960
|
+
*/
|
|
961
|
+
updateOAuth2Microsoft(params?: {
|
|
962
|
+
applicationId?: string;
|
|
963
|
+
applicationSecret?: string;
|
|
964
|
+
tenant?: string;
|
|
965
|
+
enabled?: boolean;
|
|
966
|
+
}): Promise<Models.OAuth2Microsoft>;
|
|
967
|
+
/**
|
|
968
|
+
* Update the project OAuth2 Microsoft configuration.
|
|
969
|
+
*
|
|
970
|
+
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
971
|
+
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
972
|
+
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
973
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
974
|
+
* @throws {AppwriteException}
|
|
975
|
+
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
976
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
977
|
+
*/
|
|
978
|
+
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
979
|
+
/**
|
|
980
|
+
* Update the project OAuth2 Notion configuration.
|
|
981
|
+
*
|
|
982
|
+
* @param {string} params.oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
983
|
+
* @param {string} params.oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
984
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
985
|
+
* @throws {AppwriteException}
|
|
986
|
+
* @returns {Promise<Models.OAuth2Notion>}
|
|
987
|
+
*/
|
|
988
|
+
updateOAuth2Notion(params?: {
|
|
989
|
+
oauthClientId?: string;
|
|
990
|
+
oauthClientSecret?: string;
|
|
991
|
+
enabled?: boolean;
|
|
992
|
+
}): Promise<Models.OAuth2Notion>;
|
|
993
|
+
/**
|
|
994
|
+
* Update the project OAuth2 Notion configuration.
|
|
995
|
+
*
|
|
996
|
+
* @param {string} oauthClientId - 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
997
|
+
* @param {string} oauthClientSecret - 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
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.
|
|
999
|
+
* @throws {AppwriteException}
|
|
1000
|
+
* @returns {Promise<Models.OAuth2Notion>}
|
|
1001
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1002
|
+
*/
|
|
1003
|
+
updateOAuth2Notion(oauthClientId?: string, oauthClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Notion>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Update the project OAuth2 Oidc configuration.
|
|
1006
|
+
*
|
|
1007
|
+
* @param {string} params.clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1008
|
+
* @param {string} params.clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1009
|
+
* @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
|
+
* @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.tokenUrl - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1012
|
+
* @param {string} params.userInfoUrl - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1013
|
+
* @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
|
+
* @throws {AppwriteException}
|
|
1015
|
+
* @returns {Promise<Models.OAuth2Oidc>}
|
|
1016
|
+
*/
|
|
1017
|
+
updateOAuth2Oidc(params?: {
|
|
1018
|
+
clientId?: string;
|
|
1019
|
+
clientSecret?: string;
|
|
1020
|
+
wellKnownURL?: string;
|
|
1021
|
+
authorizationURL?: string;
|
|
1022
|
+
tokenUrl?: string;
|
|
1023
|
+
userInfoUrl?: string;
|
|
1024
|
+
enabled?: boolean;
|
|
1025
|
+
}): Promise<Models.OAuth2Oidc>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Update the project OAuth2 Oidc configuration.
|
|
1028
|
+
*
|
|
1029
|
+
* @param {string} clientId - 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1030
|
+
* @param {string} clientSecret - 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1031
|
+
* @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
|
+
* @param {string} authorizationURL - OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1033
|
+
* @param {string} tokenUrl - OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1034
|
+
* @param {string} userInfoUrl - OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1035
|
+
* @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
|
+
* @throws {AppwriteException}
|
|
1037
|
+
* @returns {Promise<Models.OAuth2Oidc>}
|
|
1038
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1039
|
+
*/
|
|
1040
|
+
updateOAuth2Oidc(clientId?: string, clientSecret?: string, wellKnownURL?: string, authorizationURL?: string, tokenUrl?: string, userInfoUrl?: string, enabled?: boolean): Promise<Models.OAuth2Oidc>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Update the project OAuth2 Okta configuration.
|
|
1043
|
+
*
|
|
1044
|
+
* @param {string} params.clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1045
|
+
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1046
|
+
* @param {string} params.domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1047
|
+
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1048
|
+
* @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.
|
|
1049
|
+
* @throws {AppwriteException}
|
|
1050
|
+
* @returns {Promise<Models.OAuth2Okta>}
|
|
1051
|
+
*/
|
|
1052
|
+
updateOAuth2Okta(params?: {
|
|
1053
|
+
clientId?: string;
|
|
1054
|
+
clientSecret?: string;
|
|
1055
|
+
domain?: string;
|
|
1056
|
+
authorizationServerId?: string;
|
|
1057
|
+
enabled?: boolean;
|
|
1058
|
+
}): Promise<Models.OAuth2Okta>;
|
|
1059
|
+
/**
|
|
1060
|
+
* Update the project OAuth2 Okta configuration.
|
|
1061
|
+
*
|
|
1062
|
+
* @param {string} clientId - 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1063
|
+
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1064
|
+
* @param {string} domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1065
|
+
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1066
|
+
* @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.
|
|
1067
|
+
* @throws {AppwriteException}
|
|
1068
|
+
* @returns {Promise<Models.OAuth2Okta>}
|
|
1069
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1070
|
+
*/
|
|
1071
|
+
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Update the project OAuth2 Paypal configuration.
|
|
1074
|
+
*
|
|
1075
|
+
* @param {string} params.clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1076
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1077
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1078
|
+
* @throws {AppwriteException}
|
|
1079
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
1080
|
+
*/
|
|
1081
|
+
updateOAuth2Paypal(params?: {
|
|
1082
|
+
clientId?: string;
|
|
1083
|
+
secretKey?: string;
|
|
1084
|
+
enabled?: boolean;
|
|
1085
|
+
}): Promise<Models.OAuth2Paypal>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Update the project OAuth2 Paypal configuration.
|
|
1088
|
+
*
|
|
1089
|
+
* @param {string} clientId - 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1090
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1091
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1092
|
+
* @throws {AppwriteException}
|
|
1093
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
1094
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1095
|
+
*/
|
|
1096
|
+
updateOAuth2Paypal(clientId?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Paypal>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1099
|
+
*
|
|
1100
|
+
* @param {string} params.clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1101
|
+
* @param {string} params.secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1102
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1103
|
+
* @throws {AppwriteException}
|
|
1104
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
1105
|
+
*/
|
|
1106
|
+
updateOAuth2PaypalSandbox(params?: {
|
|
1107
|
+
clientId?: string;
|
|
1108
|
+
secretKey?: string;
|
|
1109
|
+
enabled?: boolean;
|
|
1110
|
+
}): Promise<Models.OAuth2Paypal>;
|
|
1111
|
+
/**
|
|
1112
|
+
* Update the project OAuth2 PaypalSandbox configuration.
|
|
1113
|
+
*
|
|
1114
|
+
* @param {string} clientId - 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1115
|
+
* @param {string} secretKey - 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1116
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1117
|
+
* @throws {AppwriteException}
|
|
1118
|
+
* @returns {Promise<Models.OAuth2Paypal>}
|
|
1119
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1120
|
+
*/
|
|
1121
|
+
updateOAuth2PaypalSandbox(clientId?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2Paypal>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Update the project OAuth2 Podio configuration.
|
|
1124
|
+
*
|
|
1125
|
+
* @param {string} params.clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1126
|
+
* @param {string} params.clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1127
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1128
|
+
* @throws {AppwriteException}
|
|
1129
|
+
* @returns {Promise<Models.OAuth2Podio>}
|
|
1130
|
+
*/
|
|
1131
|
+
updateOAuth2Podio(params?: {
|
|
1132
|
+
clientId?: string;
|
|
1133
|
+
clientSecret?: string;
|
|
1134
|
+
enabled?: boolean;
|
|
1135
|
+
}): Promise<Models.OAuth2Podio>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Update the project OAuth2 Podio configuration.
|
|
1138
|
+
*
|
|
1139
|
+
* @param {string} clientId - 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1140
|
+
* @param {string} clientSecret - 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1141
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1142
|
+
* @throws {AppwriteException}
|
|
1143
|
+
* @returns {Promise<Models.OAuth2Podio>}
|
|
1144
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1145
|
+
*/
|
|
1146
|
+
updateOAuth2Podio(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Podio>;
|
|
1147
|
+
/**
|
|
1148
|
+
* Update the project OAuth2 Salesforce configuration.
|
|
1149
|
+
*
|
|
1150
|
+
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1151
|
+
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1152
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1153
|
+
* @throws {AppwriteException}
|
|
1154
|
+
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
1155
|
+
*/
|
|
1156
|
+
updateOAuth2Salesforce(params?: {
|
|
1157
|
+
customerKey?: string;
|
|
1158
|
+
customerSecret?: string;
|
|
1159
|
+
enabled?: boolean;
|
|
1160
|
+
}): Promise<Models.OAuth2Salesforce>;
|
|
1161
|
+
/**
|
|
1162
|
+
* Update the project OAuth2 Salesforce configuration.
|
|
1163
|
+
*
|
|
1164
|
+
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1165
|
+
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1166
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1167
|
+
* @throws {AppwriteException}
|
|
1168
|
+
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
1169
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1170
|
+
*/
|
|
1171
|
+
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
1172
|
+
/**
|
|
1173
|
+
* Update the project OAuth2 Slack configuration.
|
|
1174
|
+
*
|
|
1175
|
+
* @param {string} params.clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1176
|
+
* @param {string} params.clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1177
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1178
|
+
* @throws {AppwriteException}
|
|
1179
|
+
* @returns {Promise<Models.OAuth2Slack>}
|
|
1180
|
+
*/
|
|
1181
|
+
updateOAuth2Slack(params?: {
|
|
1182
|
+
clientId?: string;
|
|
1183
|
+
clientSecret?: string;
|
|
1184
|
+
enabled?: boolean;
|
|
1185
|
+
}): Promise<Models.OAuth2Slack>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Update the project OAuth2 Slack configuration.
|
|
1188
|
+
*
|
|
1189
|
+
* @param {string} clientId - 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1190
|
+
* @param {string} clientSecret - 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1191
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1192
|
+
* @throws {AppwriteException}
|
|
1193
|
+
* @returns {Promise<Models.OAuth2Slack>}
|
|
1194
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1195
|
+
*/
|
|
1196
|
+
updateOAuth2Slack(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Slack>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Update the project OAuth2 Spotify configuration.
|
|
1199
|
+
*
|
|
1200
|
+
* @param {string} params.clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1201
|
+
* @param {string} params.clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1202
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1203
|
+
* @throws {AppwriteException}
|
|
1204
|
+
* @returns {Promise<Models.OAuth2Spotify>}
|
|
1205
|
+
*/
|
|
1206
|
+
updateOAuth2Spotify(params?: {
|
|
1207
|
+
clientId?: string;
|
|
1208
|
+
clientSecret?: string;
|
|
1209
|
+
enabled?: boolean;
|
|
1210
|
+
}): Promise<Models.OAuth2Spotify>;
|
|
1211
|
+
/**
|
|
1212
|
+
* Update the project OAuth2 Spotify configuration.
|
|
1213
|
+
*
|
|
1214
|
+
* @param {string} clientId - 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1215
|
+
* @param {string} clientSecret - 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1216
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1217
|
+
* @throws {AppwriteException}
|
|
1218
|
+
* @returns {Promise<Models.OAuth2Spotify>}
|
|
1219
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1220
|
+
*/
|
|
1221
|
+
updateOAuth2Spotify(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Spotify>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Update the project OAuth2 Stripe configuration.
|
|
1224
|
+
*
|
|
1225
|
+
* @param {string} params.clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1226
|
+
* @param {string} params.apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1227
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1228
|
+
* @throws {AppwriteException}
|
|
1229
|
+
* @returns {Promise<Models.OAuth2Stripe>}
|
|
1230
|
+
*/
|
|
1231
|
+
updateOAuth2Stripe(params?: {
|
|
1232
|
+
clientId?: string;
|
|
1233
|
+
apiSecretKey?: string;
|
|
1234
|
+
enabled?: boolean;
|
|
1235
|
+
}): Promise<Models.OAuth2Stripe>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Update the project OAuth2 Stripe configuration.
|
|
1238
|
+
*
|
|
1239
|
+
* @param {string} clientId - 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1240
|
+
* @param {string} apiSecretKey - 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1241
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1242
|
+
* @throws {AppwriteException}
|
|
1243
|
+
* @returns {Promise<Models.OAuth2Stripe>}
|
|
1244
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1245
|
+
*/
|
|
1246
|
+
updateOAuth2Stripe(clientId?: string, apiSecretKey?: string, enabled?: boolean): Promise<Models.OAuth2Stripe>;
|
|
1247
|
+
/**
|
|
1248
|
+
* Update the project OAuth2 Tradeshift configuration.
|
|
1249
|
+
*
|
|
1250
|
+
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1251
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1252
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1253
|
+
* @throws {AppwriteException}
|
|
1254
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1255
|
+
*/
|
|
1256
|
+
updateOAuth2Tradeshift(params?: {
|
|
1257
|
+
oauth2ClientId?: string;
|
|
1258
|
+
oauth2ClientSecret?: string;
|
|
1259
|
+
enabled?: boolean;
|
|
1260
|
+
}): Promise<Models.OAuth2Tradeshift>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Update the project OAuth2 Tradeshift configuration.
|
|
1263
|
+
*
|
|
1264
|
+
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1265
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1266
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1267
|
+
* @throws {AppwriteException}
|
|
1268
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1269
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1270
|
+
*/
|
|
1271
|
+
updateOAuth2Tradeshift(oauth2ClientId?: string, oauth2ClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Tradeshift>;
|
|
1272
|
+
/**
|
|
1273
|
+
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1274
|
+
*
|
|
1275
|
+
* @param {string} params.oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1276
|
+
* @param {string} params.oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1277
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1278
|
+
* @throws {AppwriteException}
|
|
1279
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1280
|
+
*/
|
|
1281
|
+
updateOAuth2TradeshiftSandbox(params?: {
|
|
1282
|
+
oauth2ClientId?: string;
|
|
1283
|
+
oauth2ClientSecret?: string;
|
|
1284
|
+
enabled?: boolean;
|
|
1285
|
+
}): Promise<Models.OAuth2Tradeshift>;
|
|
1286
|
+
/**
|
|
1287
|
+
* Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1288
|
+
*
|
|
1289
|
+
* @param {string} oauth2ClientId - 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1290
|
+
* @param {string} oauth2ClientSecret - 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1291
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1292
|
+
* @throws {AppwriteException}
|
|
1293
|
+
* @returns {Promise<Models.OAuth2Tradeshift>}
|
|
1294
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1295
|
+
*/
|
|
1296
|
+
updateOAuth2TradeshiftSandbox(oauth2ClientId?: string, oauth2ClientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Tradeshift>;
|
|
1297
|
+
/**
|
|
1298
|
+
* Update the project OAuth2 Twitch configuration.
|
|
1299
|
+
*
|
|
1300
|
+
* @param {string} params.clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1301
|
+
* @param {string} params.clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1302
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1303
|
+
* @throws {AppwriteException}
|
|
1304
|
+
* @returns {Promise<Models.OAuth2Twitch>}
|
|
1305
|
+
*/
|
|
1306
|
+
updateOAuth2Twitch(params?: {
|
|
1307
|
+
clientId?: string;
|
|
1308
|
+
clientSecret?: string;
|
|
1309
|
+
enabled?: boolean;
|
|
1310
|
+
}): Promise<Models.OAuth2Twitch>;
|
|
1311
|
+
/**
|
|
1312
|
+
* Update the project OAuth2 Twitch configuration.
|
|
1313
|
+
*
|
|
1314
|
+
* @param {string} clientId - 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1315
|
+
* @param {string} clientSecret - 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1316
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1317
|
+
* @throws {AppwriteException}
|
|
1318
|
+
* @returns {Promise<Models.OAuth2Twitch>}
|
|
1319
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1320
|
+
*/
|
|
1321
|
+
updateOAuth2Twitch(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Twitch>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Update the project OAuth2 WordPress configuration.
|
|
1324
|
+
*
|
|
1325
|
+
* @param {string} params.clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1326
|
+
* @param {string} params.clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1327
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1328
|
+
* @throws {AppwriteException}
|
|
1329
|
+
* @returns {Promise<Models.OAuth2WordPress>}
|
|
1330
|
+
*/
|
|
1331
|
+
updateOAuth2WordPress(params?: {
|
|
1332
|
+
clientId?: string;
|
|
1333
|
+
clientSecret?: string;
|
|
1334
|
+
enabled?: boolean;
|
|
1335
|
+
}): Promise<Models.OAuth2WordPress>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Update the project OAuth2 WordPress configuration.
|
|
1338
|
+
*
|
|
1339
|
+
* @param {string} clientId - 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1340
|
+
* @param {string} clientSecret - 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1341
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1342
|
+
* @throws {AppwriteException}
|
|
1343
|
+
* @returns {Promise<Models.OAuth2WordPress>}
|
|
1344
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1345
|
+
*/
|
|
1346
|
+
updateOAuth2WordPress(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2WordPress>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Update the project OAuth2 X configuration.
|
|
1349
|
+
*
|
|
1350
|
+
* @param {string} params.customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1351
|
+
* @param {string} params.secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1352
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1353
|
+
* @throws {AppwriteException}
|
|
1354
|
+
* @returns {Promise<Models.OAuth2X>}
|
|
1355
|
+
*/
|
|
1356
|
+
updateOAuth2X(params?: {
|
|
1357
|
+
customerKey?: string;
|
|
1358
|
+
secretKey?: string;
|
|
1359
|
+
enabled?: boolean;
|
|
1360
|
+
}): Promise<Models.OAuth2X>;
|
|
1361
|
+
/**
|
|
1362
|
+
* Update the project OAuth2 X configuration.
|
|
1363
|
+
*
|
|
1364
|
+
* @param {string} customerKey - 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
1365
|
+
* @param {string} secretKey - 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1366
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1367
|
+
* @throws {AppwriteException}
|
|
1368
|
+
* @returns {Promise<Models.OAuth2X>}
|
|
1369
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1370
|
+
*/
|
|
1371
|
+
updateOAuth2X(customerKey?: string, secretKey?: string, enabled?: boolean): Promise<Models.OAuth2X>;
|
|
1372
|
+
/**
|
|
1373
|
+
* Update the project OAuth2 Yahoo configuration.
|
|
1374
|
+
*
|
|
1375
|
+
* @param {string} params.clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1376
|
+
* @param {string} params.clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1377
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1378
|
+
* @throws {AppwriteException}
|
|
1379
|
+
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
1380
|
+
*/
|
|
1381
|
+
updateOAuth2Yahoo(params?: {
|
|
1382
|
+
clientId?: string;
|
|
1383
|
+
clientSecret?: string;
|
|
1384
|
+
enabled?: boolean;
|
|
1385
|
+
}): Promise<Models.OAuth2Yahoo>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Update the project OAuth2 Yahoo configuration.
|
|
1388
|
+
*
|
|
1389
|
+
* @param {string} clientId - 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
1390
|
+
* @param {string} clientSecret - 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1391
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1392
|
+
* @throws {AppwriteException}
|
|
1393
|
+
* @returns {Promise<Models.OAuth2Yahoo>}
|
|
1394
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1395
|
+
*/
|
|
1396
|
+
updateOAuth2Yahoo(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Yahoo>;
|
|
1397
|
+
/**
|
|
1398
|
+
* Update the project OAuth2 Yandex configuration.
|
|
1399
|
+
*
|
|
1400
|
+
* @param {string} params.clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1401
|
+
* @param {string} params.clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1402
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1403
|
+
* @throws {AppwriteException}
|
|
1404
|
+
* @returns {Promise<Models.OAuth2Yandex>}
|
|
1405
|
+
*/
|
|
1406
|
+
updateOAuth2Yandex(params?: {
|
|
1407
|
+
clientId?: string;
|
|
1408
|
+
clientSecret?: string;
|
|
1409
|
+
enabled?: boolean;
|
|
1410
|
+
}): Promise<Models.OAuth2Yandex>;
|
|
1411
|
+
/**
|
|
1412
|
+
* Update the project OAuth2 Yandex configuration.
|
|
1413
|
+
*
|
|
1414
|
+
* @param {string} clientId - 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
1415
|
+
* @param {string} clientSecret - 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1416
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1417
|
+
* @throws {AppwriteException}
|
|
1418
|
+
* @returns {Promise<Models.OAuth2Yandex>}
|
|
1419
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1420
|
+
*/
|
|
1421
|
+
updateOAuth2Yandex(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Yandex>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Update the project OAuth2 Zoho configuration.
|
|
1424
|
+
*
|
|
1425
|
+
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1426
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1427
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1428
|
+
* @throws {AppwriteException}
|
|
1429
|
+
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1430
|
+
*/
|
|
1431
|
+
updateOAuth2Zoho(params?: {
|
|
1432
|
+
clientId?: string;
|
|
1433
|
+
clientSecret?: string;
|
|
1434
|
+
enabled?: boolean;
|
|
1435
|
+
}): Promise<Models.OAuth2Zoho>;
|
|
1436
|
+
/**
|
|
1437
|
+
* Update the project OAuth2 Zoho configuration.
|
|
1438
|
+
*
|
|
1439
|
+
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1440
|
+
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1441
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1442
|
+
* @throws {AppwriteException}
|
|
1443
|
+
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1444
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1445
|
+
*/
|
|
1446
|
+
updateOAuth2Zoho(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Update the project OAuth2 Zoom configuration.
|
|
1449
|
+
*
|
|
1450
|
+
* @param {string} params.clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1451
|
+
* @param {string} params.clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1452
|
+
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1453
|
+
* @throws {AppwriteException}
|
|
1454
|
+
* @returns {Promise<Models.OAuth2Zoom>}
|
|
1455
|
+
*/
|
|
1456
|
+
updateOAuth2Zoom(params?: {
|
|
1457
|
+
clientId?: string;
|
|
1458
|
+
clientSecret?: string;
|
|
1459
|
+
enabled?: boolean;
|
|
1460
|
+
}): Promise<Models.OAuth2Zoom>;
|
|
1461
|
+
/**
|
|
1462
|
+
* Update the project OAuth2 Zoom configuration.
|
|
1463
|
+
*
|
|
1464
|
+
* @param {string} clientId - 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
1465
|
+
* @param {string} clientSecret - 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1466
|
+
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1467
|
+
* @throws {AppwriteException}
|
|
1468
|
+
* @returns {Promise<Models.OAuth2Zoom>}
|
|
1469
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1470
|
+
*/
|
|
1471
|
+
updateOAuth2Zoom(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoom>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1474
|
+
*
|
|
1475
|
+
* @param {string} params.provider - OAuth2 provider key. For example: github, google, apple.
|
|
1476
|
+
* @throws {AppwriteException}
|
|
1477
|
+
* @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
|
+
*/
|
|
1479
|
+
getOAuth2Provider(params: {
|
|
1480
|
+
provider: string;
|
|
1481
|
+
}): 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
|
+
/**
|
|
1483
|
+
* Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key/team IDs) are write-only and always returned empty.
|
|
1484
|
+
*
|
|
1485
|
+
* @param {string} provider - OAuth2 provider key. For example: github, google, apple.
|
|
1486
|
+
* @throws {AppwriteException}
|
|
1487
|
+
* @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
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1489
|
+
*/
|
|
1490
|
+
getOAuth2Provider(provider: string): 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
|
+
/**
|
|
1492
|
+
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1493
|
+
*
|
|
1494
|
+
* @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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName
|
|
1495
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1496
|
+
* @throws {AppwriteException}
|
|
1497
|
+
* @returns {Promise<Models.PlatformList>}
|
|
1498
|
+
*/
|
|
1499
|
+
listPlatforms(params?: {
|
|
1500
|
+
queries?: string[];
|
|
1501
|
+
total?: boolean;
|
|
1502
|
+
}): Promise<Models.PlatformList>;
|
|
1503
|
+
/**
|
|
1504
|
+
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
1505
|
+
*
|
|
1506
|
+
* @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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName
|
|
1507
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1508
|
+
* @throws {AppwriteException}
|
|
1509
|
+
* @returns {Promise<Models.PlatformList>}
|
|
1510
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1511
|
+
*/
|
|
1512
|
+
listPlatforms(queries?: string[], total?: boolean): Promise<Models.PlatformList>;
|
|
1513
|
+
/**
|
|
1514
|
+
* Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.
|
|
1515
|
+
*
|
|
1516
|
+
* @param {string} params.platformId - Platform 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.
|
|
1517
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1518
|
+
* @param {string} params.applicationId - Android application ID. Max length: 256 chars.
|
|
1519
|
+
* @throws {AppwriteException}
|
|
1520
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
1521
|
+
*/
|
|
1522
|
+
createAndroidPlatform(params: {
|
|
1523
|
+
platformId: string;
|
|
1524
|
+
name: string;
|
|
1525
|
+
applicationId: string;
|
|
1526
|
+
}): Promise<Models.PlatformAndroid>;
|
|
1527
|
+
/**
|
|
1528
|
+
* Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.
|
|
1529
|
+
*
|
|
1530
|
+
* @param {string} platformId - Platform 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.
|
|
1531
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1532
|
+
* @param {string} applicationId - Android application ID. Max length: 256 chars.
|
|
1533
|
+
* @throws {AppwriteException}
|
|
1534
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
1535
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1536
|
+
*/
|
|
1537
|
+
createAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
|
|
1538
|
+
/**
|
|
1539
|
+
* Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
|
|
1540
|
+
*
|
|
1541
|
+
* @param {string} params.platformId - Platform ID.
|
|
1542
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1543
|
+
* @param {string} params.applicationId - Android application ID. Max length: 256 chars.
|
|
1544
|
+
* @throws {AppwriteException}
|
|
1545
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
1546
|
+
*/
|
|
1547
|
+
updateAndroidPlatform(params: {
|
|
1548
|
+
platformId: string;
|
|
1549
|
+
name: string;
|
|
1550
|
+
applicationId: string;
|
|
1551
|
+
}): Promise<Models.PlatformAndroid>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
|
|
1554
|
+
*
|
|
1555
|
+
* @param {string} platformId - Platform ID.
|
|
1556
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1557
|
+
* @param {string} applicationId - Android application ID. Max length: 256 chars.
|
|
1558
|
+
* @throws {AppwriteException}
|
|
1559
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
1560
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1561
|
+
*/
|
|
1562
|
+
updateAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
|
|
1563
|
+
/**
|
|
1564
|
+
* Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.
|
|
1565
|
+
*
|
|
1566
|
+
* @param {string} params.platformId - Platform 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.
|
|
1567
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1568
|
+
* @param {string} params.bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
1569
|
+
* @throws {AppwriteException}
|
|
1570
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
1571
|
+
*/
|
|
1572
|
+
createApplePlatform(params: {
|
|
1573
|
+
platformId: string;
|
|
1574
|
+
name: string;
|
|
1575
|
+
bundleIdentifier: string;
|
|
1576
|
+
}): Promise<Models.PlatformApple>;
|
|
1577
|
+
/**
|
|
1578
|
+
* Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.
|
|
1579
|
+
*
|
|
1580
|
+
* @param {string} platformId - Platform 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.
|
|
1581
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1582
|
+
* @param {string} bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
1583
|
+
* @throws {AppwriteException}
|
|
1584
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
1585
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1586
|
+
*/
|
|
1587
|
+
createApplePlatform(platformId: string, name: string, bundleIdentifier: string): Promise<Models.PlatformApple>;
|
|
1588
|
+
/**
|
|
1589
|
+
* Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.
|
|
1590
|
+
*
|
|
1591
|
+
* @param {string} params.platformId - Platform ID.
|
|
1592
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1593
|
+
* @param {string} params.bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
1594
|
+
* @throws {AppwriteException}
|
|
1595
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
1596
|
+
*/
|
|
1597
|
+
updateApplePlatform(params: {
|
|
1598
|
+
platformId: string;
|
|
1599
|
+
name: string;
|
|
1600
|
+
bundleIdentifier: string;
|
|
1601
|
+
}): Promise<Models.PlatformApple>;
|
|
1602
|
+
/**
|
|
1603
|
+
* Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.
|
|
1604
|
+
*
|
|
1605
|
+
* @param {string} platformId - Platform ID.
|
|
1606
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1607
|
+
* @param {string} bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
1608
|
+
* @throws {AppwriteException}
|
|
1609
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
1610
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1611
|
+
*/
|
|
1612
|
+
updateApplePlatform(platformId: string, name: string, bundleIdentifier: string): Promise<Models.PlatformApple>;
|
|
1613
|
+
/**
|
|
1614
|
+
* Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.
|
|
1615
|
+
*
|
|
1616
|
+
* @param {string} params.platformId - Platform 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.
|
|
1617
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1618
|
+
* @param {string} params.packageName - Linux package name. Max length: 256 chars.
|
|
1619
|
+
* @throws {AppwriteException}
|
|
1620
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
1621
|
+
*/
|
|
1622
|
+
createLinuxPlatform(params: {
|
|
1623
|
+
platformId: string;
|
|
1624
|
+
name: string;
|
|
1625
|
+
packageName: string;
|
|
1626
|
+
}): Promise<Models.PlatformLinux>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.
|
|
1629
|
+
*
|
|
1630
|
+
* @param {string} platformId - Platform 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.
|
|
1631
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1632
|
+
* @param {string} packageName - Linux package name. Max length: 256 chars.
|
|
1633
|
+
* @throws {AppwriteException}
|
|
1634
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
1635
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1636
|
+
*/
|
|
1637
|
+
createLinuxPlatform(platformId: string, name: string, packageName: string): Promise<Models.PlatformLinux>;
|
|
1638
|
+
/**
|
|
1639
|
+
* Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.
|
|
1640
|
+
*
|
|
1641
|
+
* @param {string} params.platformId - Platform ID.
|
|
1642
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1643
|
+
* @param {string} params.packageName - Linux package name. Max length: 256 chars.
|
|
1644
|
+
* @throws {AppwriteException}
|
|
1645
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
1646
|
+
*/
|
|
1647
|
+
updateLinuxPlatform(params: {
|
|
1648
|
+
platformId: string;
|
|
1649
|
+
name: string;
|
|
1650
|
+
packageName: string;
|
|
1651
|
+
}): Promise<Models.PlatformLinux>;
|
|
1652
|
+
/**
|
|
1653
|
+
* Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.
|
|
1654
|
+
*
|
|
1655
|
+
* @param {string} platformId - Platform ID.
|
|
1656
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1657
|
+
* @param {string} packageName - Linux package name. Max length: 256 chars.
|
|
1658
|
+
* @throws {AppwriteException}
|
|
1659
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
1660
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1661
|
+
*/
|
|
1662
|
+
updateLinuxPlatform(platformId: string, name: string, packageName: string): Promise<Models.PlatformLinux>;
|
|
1663
|
+
/**
|
|
1664
|
+
* Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
1665
|
+
*
|
|
1666
|
+
* @param {string} params.platformId - Platform 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.
|
|
1667
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1668
|
+
* @param {string} params.hostname - Platform web hostname. Max length: 256 chars.
|
|
1669
|
+
* @throws {AppwriteException}
|
|
1670
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
1671
|
+
*/
|
|
1672
|
+
createWebPlatform(params: {
|
|
1673
|
+
platformId: string;
|
|
1674
|
+
name: string;
|
|
1675
|
+
hostname: string;
|
|
1676
|
+
}): Promise<Models.PlatformWeb>;
|
|
1677
|
+
/**
|
|
1678
|
+
* Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
1679
|
+
*
|
|
1680
|
+
* @param {string} platformId - Platform 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.
|
|
1681
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1682
|
+
* @param {string} hostname - Platform web hostname. Max length: 256 chars.
|
|
1683
|
+
* @throws {AppwriteException}
|
|
1684
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
1685
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1686
|
+
*/
|
|
1687
|
+
createWebPlatform(platformId: string, name: string, hostname: string): Promise<Models.PlatformWeb>;
|
|
1688
|
+
/**
|
|
1689
|
+
* Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.
|
|
1690
|
+
*
|
|
1691
|
+
* @param {string} params.platformId - Platform ID.
|
|
1692
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1693
|
+
* @param {string} params.hostname - Platform web hostname. Max length: 256 chars.
|
|
1694
|
+
* @throws {AppwriteException}
|
|
1695
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
1696
|
+
*/
|
|
1697
|
+
updateWebPlatform(params: {
|
|
1698
|
+
platformId: string;
|
|
1699
|
+
name: string;
|
|
1700
|
+
hostname: string;
|
|
1701
|
+
}): Promise<Models.PlatformWeb>;
|
|
1702
|
+
/**
|
|
1703
|
+
* Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.
|
|
1704
|
+
*
|
|
1705
|
+
* @param {string} platformId - Platform ID.
|
|
1706
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1707
|
+
* @param {string} hostname - Platform web hostname. Max length: 256 chars.
|
|
1708
|
+
* @throws {AppwriteException}
|
|
1709
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
1710
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1711
|
+
*/
|
|
1712
|
+
updateWebPlatform(platformId: string, name: string, hostname: string): Promise<Models.PlatformWeb>;
|
|
1713
|
+
/**
|
|
1714
|
+
* Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.
|
|
1715
|
+
*
|
|
1716
|
+
* @param {string} params.platformId - Platform 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.
|
|
1717
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1718
|
+
* @param {string} params.packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
1719
|
+
* @throws {AppwriteException}
|
|
1720
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
1721
|
+
*/
|
|
1722
|
+
createWindowsPlatform(params: {
|
|
1723
|
+
platformId: string;
|
|
1724
|
+
name: string;
|
|
1725
|
+
packageIdentifierName: string;
|
|
1726
|
+
}): Promise<Models.PlatformWindows>;
|
|
1727
|
+
/**
|
|
1728
|
+
* Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.
|
|
1729
|
+
*
|
|
1730
|
+
* @param {string} platformId - Platform 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.
|
|
1731
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1732
|
+
* @param {string} packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
1733
|
+
* @throws {AppwriteException}
|
|
1734
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
1735
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1736
|
+
*/
|
|
1737
|
+
createWindowsPlatform(platformId: string, name: string, packageIdentifierName: string): Promise<Models.PlatformWindows>;
|
|
1738
|
+
/**
|
|
1739
|
+
* Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.
|
|
1740
|
+
*
|
|
1741
|
+
* @param {string} params.platformId - Platform ID.
|
|
1742
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
1743
|
+
* @param {string} params.packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
1744
|
+
* @throws {AppwriteException}
|
|
1745
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
1746
|
+
*/
|
|
1747
|
+
updateWindowsPlatform(params: {
|
|
1748
|
+
platformId: string;
|
|
1749
|
+
name: string;
|
|
1750
|
+
packageIdentifierName: string;
|
|
1751
|
+
}): Promise<Models.PlatformWindows>;
|
|
1752
|
+
/**
|
|
1753
|
+
* Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.
|
|
1754
|
+
*
|
|
1755
|
+
* @param {string} platformId - Platform ID.
|
|
1756
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
1757
|
+
* @param {string} packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
1758
|
+
* @throws {AppwriteException}
|
|
1759
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
1760
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1761
|
+
*/
|
|
1762
|
+
updateWindowsPlatform(platformId: string, name: string, packageIdentifierName: string): Promise<Models.PlatformWindows>;
|
|
1763
|
+
/**
|
|
1764
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
1765
|
+
*
|
|
1766
|
+
* @param {string} params.platformId - Platform ID.
|
|
1767
|
+
* @throws {AppwriteException}
|
|
1768
|
+
* @returns {Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>}
|
|
1769
|
+
*/
|
|
1770
|
+
getPlatform(params: {
|
|
1771
|
+
platformId: string;
|
|
1772
|
+
}): Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>;
|
|
1773
|
+
/**
|
|
1774
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
1775
|
+
*
|
|
1776
|
+
* @param {string} platformId - Platform ID.
|
|
1777
|
+
* @throws {AppwriteException}
|
|
1778
|
+
* @returns {Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>}
|
|
1779
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1780
|
+
*/
|
|
1781
|
+
getPlatform(platformId: string): Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>;
|
|
1782
|
+
/**
|
|
1783
|
+
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
1784
|
+
*
|
|
1785
|
+
* @param {string} params.platformId - Platform ID.
|
|
1786
|
+
* @throws {AppwriteException}
|
|
1787
|
+
* @returns {Promise<{}>}
|
|
1788
|
+
*/
|
|
1789
|
+
deletePlatform(params: {
|
|
1790
|
+
platformId: string;
|
|
1791
|
+
}): Promise<{}>;
|
|
1792
|
+
/**
|
|
1793
|
+
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
1794
|
+
*
|
|
1795
|
+
* @param {string} platformId - Platform ID.
|
|
1796
|
+
* @throws {AppwriteException}
|
|
1797
|
+
* @returns {Promise<{}>}
|
|
1798
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1799
|
+
*/
|
|
1800
|
+
deletePlatform(platformId: string): Promise<{}>;
|
|
1801
|
+
/**
|
|
1802
|
+
* Get a list of all project policies and their current configuration.
|
|
1803
|
+
*
|
|
1804
|
+
* @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
|
|
1805
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1806
|
+
* @throws {AppwriteException}
|
|
1807
|
+
* @returns {Promise<Models.PolicyList>}
|
|
1808
|
+
*/
|
|
1809
|
+
listPolicies(params?: {
|
|
1810
|
+
queries?: string[];
|
|
1811
|
+
total?: boolean;
|
|
1812
|
+
}): Promise<Models.PolicyList>;
|
|
1813
|
+
/**
|
|
1814
|
+
* Get a list of all project policies and their current configuration.
|
|
1815
|
+
*
|
|
1816
|
+
* @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
|
|
1817
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1818
|
+
* @throws {AppwriteException}
|
|
1819
|
+
* @returns {Promise<Models.PolicyList>}
|
|
1820
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1821
|
+
*/
|
|
1822
|
+
listPolicies(queries?: string[], total?: boolean): Promise<Models.PolicyList>;
|
|
1823
|
+
/**
|
|
1824
|
+
* 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
|
+
*
|
|
1826
|
+
* @param {boolean} params.userId - Set to true if you want make user ID visible to all team members, or false to hide it.
|
|
1827
|
+
* @param {boolean} params.userEmail - Set to true if you want make user email visible to all team members, or false to hide it.
|
|
1828
|
+
* @param {boolean} params.userPhone - Set to true if you want make user phone number visible to all team members, or false to hide it.
|
|
1829
|
+
* @param {boolean} params.userName - Set to true if you want make user name visible to all team members, or false to hide it.
|
|
1830
|
+
* @param {boolean} params.userMFA - Set to true if you want make user MFA status visible to all team members, or false to hide it.
|
|
1831
|
+
* @throws {AppwriteException}
|
|
1832
|
+
* @returns {Promise<Models.Project>}
|
|
1833
|
+
*/
|
|
1834
|
+
updateMembershipPrivacyPolicy(params?: {
|
|
1835
|
+
userId?: boolean;
|
|
1836
|
+
userEmail?: boolean;
|
|
1837
|
+
userPhone?: boolean;
|
|
1838
|
+
userName?: boolean;
|
|
1839
|
+
userMFA?: boolean;
|
|
1840
|
+
}): Promise<Models.Project>;
|
|
1841
|
+
/**
|
|
1842
|
+
* 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..
|
|
1843
|
+
*
|
|
1844
|
+
* @param {boolean} userId - Set to true if you want make user ID visible to all team members, or false to hide it.
|
|
1845
|
+
* @param {boolean} userEmail - Set to true if you want make user email visible to all team members, or false to hide it.
|
|
1846
|
+
* @param {boolean} userPhone - Set to true if you want make user phone number visible to all team members, or false to hide it.
|
|
1847
|
+
* @param {boolean} userName - Set to true if you want make user name visible to all team members, or false to hide it.
|
|
1848
|
+
* @param {boolean} userMFA - Set to true if you want make user MFA status visible to all team members, or false to hide it.
|
|
1849
|
+
* @throws {AppwriteException}
|
|
1850
|
+
* @returns {Promise<Models.Project>}
|
|
1851
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1852
|
+
*/
|
|
1853
|
+
updateMembershipPrivacyPolicy(userId?: boolean, userEmail?: boolean, userPhone?: boolean, userName?: boolean, userMFA?: boolean): Promise<Models.Project>;
|
|
1854
|
+
/**
|
|
1855
|
+
* Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.
|
|
1856
|
+
*
|
|
1857
|
+
* @param {boolean} params.enabled - Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.
|
|
1858
|
+
* @throws {AppwriteException}
|
|
1859
|
+
* @returns {Promise<Models.Project>}
|
|
1860
|
+
*/
|
|
1861
|
+
updatePasswordDictionaryPolicy(params: {
|
|
1862
|
+
enabled: boolean;
|
|
1863
|
+
}): Promise<Models.Project>;
|
|
1864
|
+
/**
|
|
1865
|
+
* Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.
|
|
1866
|
+
*
|
|
1867
|
+
* @param {boolean} enabled - Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.
|
|
1868
|
+
* @throws {AppwriteException}
|
|
1869
|
+
* @returns {Promise<Models.Project>}
|
|
1870
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1871
|
+
*/
|
|
1872
|
+
updatePasswordDictionaryPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1873
|
+
/**
|
|
1874
|
+
* Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.
|
|
1875
|
+
*
|
|
1876
|
+
* Keep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.
|
|
1877
|
+
*
|
|
1878
|
+
* @param {number} params.total - Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.
|
|
1879
|
+
* @throws {AppwriteException}
|
|
1880
|
+
* @returns {Promise<Models.Project>}
|
|
1881
|
+
*/
|
|
1882
|
+
updatePasswordHistoryPolicy(params: {
|
|
1883
|
+
total?: number;
|
|
1884
|
+
}): Promise<Models.Project>;
|
|
1885
|
+
/**
|
|
1886
|
+
* Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.
|
|
1887
|
+
*
|
|
1888
|
+
* Keep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.
|
|
1889
|
+
*
|
|
1890
|
+
* @param {number} total - Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.
|
|
1891
|
+
* @throws {AppwriteException}
|
|
1892
|
+
* @returns {Promise<Models.Project>}
|
|
1893
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1894
|
+
*/
|
|
1895
|
+
updatePasswordHistoryPolicy(total?: number): Promise<Models.Project>;
|
|
1896
|
+
/**
|
|
1897
|
+
* Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.
|
|
1898
|
+
*
|
|
1899
|
+
* @param {boolean} params.enabled - Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.
|
|
1900
|
+
* @throws {AppwriteException}
|
|
1901
|
+
* @returns {Promise<Models.Project>}
|
|
1902
|
+
*/
|
|
1903
|
+
updatePasswordPersonalDataPolicy(params: {
|
|
1904
|
+
enabled: boolean;
|
|
1905
|
+
}): Promise<Models.Project>;
|
|
1906
|
+
/**
|
|
1907
|
+
* Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.
|
|
1908
|
+
*
|
|
1909
|
+
* @param {boolean} enabled - Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.
|
|
1910
|
+
* @throws {AppwriteException}
|
|
1911
|
+
* @returns {Promise<Models.Project>}
|
|
1912
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1913
|
+
*/
|
|
1914
|
+
updatePasswordPersonalDataPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1915
|
+
/**
|
|
1916
|
+
* Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.
|
|
1917
|
+
*
|
|
1918
|
+
* @param {boolean} params.enabled - Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.
|
|
1919
|
+
* @throws {AppwriteException}
|
|
1920
|
+
* @returns {Promise<Models.Project>}
|
|
1921
|
+
*/
|
|
1922
|
+
updateSessionAlertPolicy(params: {
|
|
1923
|
+
enabled: boolean;
|
|
1924
|
+
}): Promise<Models.Project>;
|
|
1925
|
+
/**
|
|
1926
|
+
* Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.
|
|
1927
|
+
*
|
|
1928
|
+
* @param {boolean} enabled - Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.
|
|
1929
|
+
* @throws {AppwriteException}
|
|
1930
|
+
* @returns {Promise<Models.Project>}
|
|
1931
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1932
|
+
*/
|
|
1933
|
+
updateSessionAlertPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1934
|
+
/**
|
|
1935
|
+
* Update maximum duration how long sessions created within a project should stay active for.
|
|
1936
|
+
*
|
|
1937
|
+
* @param {number} params.duration - Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.
|
|
1938
|
+
* @throws {AppwriteException}
|
|
1939
|
+
* @returns {Promise<Models.Project>}
|
|
1940
|
+
*/
|
|
1941
|
+
updateSessionDurationPolicy(params: {
|
|
1942
|
+
duration: number;
|
|
1943
|
+
}): Promise<Models.Project>;
|
|
1944
|
+
/**
|
|
1945
|
+
* Update maximum duration how long sessions created within a project should stay active for.
|
|
1946
|
+
*
|
|
1947
|
+
* @param {number} duration - Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.
|
|
1948
|
+
* @throws {AppwriteException}
|
|
1949
|
+
* @returns {Promise<Models.Project>}
|
|
1950
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1951
|
+
*/
|
|
1952
|
+
updateSessionDurationPolicy(duration: number): Promise<Models.Project>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.
|
|
1955
|
+
*
|
|
1956
|
+
* @param {boolean} params.enabled - Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.
|
|
1957
|
+
* @throws {AppwriteException}
|
|
1958
|
+
* @returns {Promise<Models.Project>}
|
|
1959
|
+
*/
|
|
1960
|
+
updateSessionInvalidationPolicy(params: {
|
|
1961
|
+
enabled: boolean;
|
|
1962
|
+
}): Promise<Models.Project>;
|
|
1963
|
+
/**
|
|
1964
|
+
* Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.
|
|
1965
|
+
*
|
|
1966
|
+
* @param {boolean} enabled - Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.
|
|
1967
|
+
* @throws {AppwriteException}
|
|
1968
|
+
* @returns {Promise<Models.Project>}
|
|
1969
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1970
|
+
*/
|
|
1971
|
+
updateSessionInvalidationPolicy(enabled: boolean): Promise<Models.Project>;
|
|
1972
|
+
/**
|
|
1973
|
+
* Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.
|
|
1974
|
+
*
|
|
1975
|
+
* @param {number} params.total - Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.
|
|
1976
|
+
* @throws {AppwriteException}
|
|
1977
|
+
* @returns {Promise<Models.Project>}
|
|
1978
|
+
*/
|
|
1979
|
+
updateSessionLimitPolicy(params: {
|
|
1980
|
+
total?: number;
|
|
1981
|
+
}): Promise<Models.Project>;
|
|
1982
|
+
/**
|
|
1983
|
+
* Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.
|
|
1984
|
+
*
|
|
1985
|
+
* @param {number} total - Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.
|
|
1986
|
+
* @throws {AppwriteException}
|
|
1987
|
+
* @returns {Promise<Models.Project>}
|
|
1988
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1989
|
+
*/
|
|
1990
|
+
updateSessionLimitPolicy(total?: number): Promise<Models.Project>;
|
|
1991
|
+
/**
|
|
1992
|
+
* Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.
|
|
1993
|
+
*
|
|
1994
|
+
* @param {number} params.total - Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.
|
|
1995
|
+
* @throws {AppwriteException}
|
|
1996
|
+
* @returns {Promise<Models.Project>}
|
|
1997
|
+
*/
|
|
1998
|
+
updateUserLimitPolicy(params: {
|
|
1999
|
+
total?: number;
|
|
2000
|
+
}): Promise<Models.Project>;
|
|
2001
|
+
/**
|
|
2002
|
+
* Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.
|
|
2003
|
+
*
|
|
2004
|
+
* @param {number} total - Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.
|
|
2005
|
+
* @throws {AppwriteException}
|
|
2006
|
+
* @returns {Promise<Models.Project>}
|
|
2007
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2008
|
+
*/
|
|
2009
|
+
updateUserLimitPolicy(total?: number): Promise<Models.Project>;
|
|
2010
|
+
/**
|
|
2011
|
+
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2012
|
+
*
|
|
2013
|
+
* @param {PolicyId} 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
|
+
* @throws {AppwriteException}
|
|
2015
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2016
|
+
*/
|
|
2017
|
+
getPolicy(params: {
|
|
2018
|
+
policyId: PolicyId;
|
|
2019
|
+
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2020
|
+
/**
|
|
2021
|
+
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2022
|
+
*
|
|
2023
|
+
* @param {PolicyId} 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
|
+
* @throws {AppwriteException}
|
|
2025
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>}
|
|
2026
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2027
|
+
*/
|
|
2028
|
+
getPolicy(policyId: PolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy>;
|
|
2029
|
+
/**
|
|
2030
|
+
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2031
|
+
*
|
|
2032
|
+
* @param {ProtocolId} params.protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2033
|
+
* @param {boolean} params.enabled - Protocol status.
|
|
2034
|
+
* @throws {AppwriteException}
|
|
2035
|
+
* @returns {Promise<Models.Project>}
|
|
2036
|
+
*/
|
|
2037
|
+
updateProtocol(params: {
|
|
2038
|
+
protocolId: ProtocolId;
|
|
2039
|
+
enabled: boolean;
|
|
2040
|
+
}): Promise<Models.Project>;
|
|
2041
|
+
/**
|
|
2042
|
+
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2043
|
+
*
|
|
2044
|
+
* @param {ProtocolId} protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
2045
|
+
* @param {boolean} enabled - Protocol status.
|
|
2046
|
+
* @throws {AppwriteException}
|
|
2047
|
+
* @returns {Promise<Models.Project>}
|
|
2048
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2049
|
+
*/
|
|
2050
|
+
updateProtocol(protocolId: ProtocolId, enabled: boolean): Promise<Models.Project>;
|
|
2051
|
+
/**
|
|
2052
|
+
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2053
|
+
*
|
|
2054
|
+
* @param {ServiceId} params.serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging
|
|
2055
|
+
* @param {boolean} params.enabled - Service status.
|
|
2056
|
+
* @throws {AppwriteException}
|
|
2057
|
+
* @returns {Promise<Models.Project>}
|
|
2058
|
+
*/
|
|
2059
|
+
updateService(params: {
|
|
2060
|
+
serviceId: ServiceId;
|
|
2061
|
+
enabled: boolean;
|
|
2062
|
+
}): Promise<Models.Project>;
|
|
2063
|
+
/**
|
|
2064
|
+
* Update properties of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
2065
|
+
*
|
|
2066
|
+
* @param {ServiceId} serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging
|
|
2067
|
+
* @param {boolean} enabled - Service status.
|
|
2068
|
+
* @throws {AppwriteException}
|
|
2069
|
+
* @returns {Promise<Models.Project>}
|
|
2070
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2071
|
+
*/
|
|
2072
|
+
updateService(serviceId: ServiceId, enabled: boolean): Promise<Models.Project>;
|
|
2073
|
+
/**
|
|
2074
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
2075
|
+
*
|
|
2076
|
+
* @param {string} params.host - SMTP server hostname (domain)
|
|
2077
|
+
* @param {number} params.port - SMTP server port
|
|
2078
|
+
* @param {string} params.username - SMTP server username. Leave empty for no authorization.
|
|
2079
|
+
* @param {string} params.password - SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).
|
|
2080
|
+
* @param {string} params.senderEmail - Email address shown in inbox as the sender of the email.
|
|
2081
|
+
* @param {string} params.senderName - Name shown in inbox as the sender of the email.
|
|
2082
|
+
* @param {string} params.replyToEmail - Email used when user replies to the email.
|
|
2083
|
+
* @param {string} params.replyToName - Name used when user replies to the email.
|
|
2084
|
+
* @param {Secure} params.secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2085
|
+
* @param {boolean} params.enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2086
|
+
* @throws {AppwriteException}
|
|
2087
|
+
* @returns {Promise<Models.Project>}
|
|
2088
|
+
*/
|
|
2089
|
+
updateSMTP(params?: {
|
|
2090
|
+
host?: string;
|
|
2091
|
+
port?: number;
|
|
2092
|
+
username?: string;
|
|
2093
|
+
password?: string;
|
|
2094
|
+
senderEmail?: string;
|
|
2095
|
+
senderName?: string;
|
|
2096
|
+
replyToEmail?: string;
|
|
2097
|
+
replyToName?: string;
|
|
2098
|
+
secure?: Secure;
|
|
2099
|
+
enabled?: boolean;
|
|
2100
|
+
}): Promise<Models.Project>;
|
|
2101
|
+
/**
|
|
2102
|
+
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
2103
|
+
*
|
|
2104
|
+
* @param {string} host - SMTP server hostname (domain)
|
|
2105
|
+
* @param {number} port - SMTP server port
|
|
2106
|
+
* @param {string} username - SMTP server username. Leave empty for no authorization.
|
|
2107
|
+
* @param {string} password - SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).
|
|
2108
|
+
* @param {string} senderEmail - Email address shown in inbox as the sender of the email.
|
|
2109
|
+
* @param {string} senderName - Name shown in inbox as the sender of the email.
|
|
2110
|
+
* @param {string} replyToEmail - Email used when user replies to the email.
|
|
2111
|
+
* @param {string} replyToName - Name used when user replies to the email.
|
|
2112
|
+
* @param {Secure} secure - Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.
|
|
2113
|
+
* @param {boolean} enabled - Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
2114
|
+
* @throws {AppwriteException}
|
|
2115
|
+
* @returns {Promise<Models.Project>}
|
|
2116
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2117
|
+
*/
|
|
2118
|
+
updateSMTP(host?: string, port?: number, username?: string, password?: string, senderEmail?: string, senderName?: string, replyToEmail?: string, replyToName?: string, secure?: Secure, enabled?: boolean): Promise<Models.Project>;
|
|
2119
|
+
/**
|
|
2120
|
+
* Send a test email to verify SMTP configuration.
|
|
2121
|
+
*
|
|
2122
|
+
* @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
2123
|
+
* @throws {AppwriteException}
|
|
2124
|
+
* @returns {Promise<{}>}
|
|
2125
|
+
*/
|
|
2126
|
+
createSMTPTest(params: {
|
|
2127
|
+
emails: string[];
|
|
2128
|
+
}): Promise<{}>;
|
|
2129
|
+
/**
|
|
2130
|
+
* Send a test email to verify SMTP configuration.
|
|
2131
|
+
*
|
|
2132
|
+
* @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
2133
|
+
* @throws {AppwriteException}
|
|
2134
|
+
* @returns {Promise<{}>}
|
|
2135
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2136
|
+
*/
|
|
2137
|
+
createSMTPTest(emails: string[]): Promise<{}>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.
|
|
2140
|
+
*
|
|
2141
|
+
* @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
|
|
2142
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2143
|
+
* @throws {AppwriteException}
|
|
2144
|
+
* @returns {Promise<Models.EmailTemplateList>}
|
|
2145
|
+
*/
|
|
2146
|
+
listEmailTemplates(params?: {
|
|
2147
|
+
queries?: string[];
|
|
2148
|
+
total?: boolean;
|
|
2149
|
+
}): Promise<Models.EmailTemplateList>;
|
|
2150
|
+
/**
|
|
2151
|
+
* Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.
|
|
2152
|
+
*
|
|
2153
|
+
* @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
|
|
2154
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2155
|
+
* @throws {AppwriteException}
|
|
2156
|
+
* @returns {Promise<Models.EmailTemplateList>}
|
|
2157
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2158
|
+
*/
|
|
2159
|
+
listEmailTemplates(queries?: string[], total?: boolean): Promise<Models.EmailTemplateList>;
|
|
2160
|
+
/**
|
|
2161
|
+
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2162
|
+
*
|
|
2163
|
+
* @param {EmailTemplateType} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2164
|
+
* @param {EmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2165
|
+
* @param {string} params.subject - Subject of the email template. Can be up to 255 characters.
|
|
2166
|
+
* @param {string} params.message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2167
|
+
* @param {string} params.senderName - Name of the email sender.
|
|
2168
|
+
* @param {string} params.senderEmail - Email of the sender.
|
|
2169
|
+
* @param {string} params.replyToEmail - Reply to email.
|
|
2170
|
+
* @param {string} params.replyToName - Reply to name.
|
|
2171
|
+
* @throws {AppwriteException}
|
|
2172
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
2173
|
+
*/
|
|
2174
|
+
updateEmailTemplate(params: {
|
|
2175
|
+
templateId: EmailTemplateType;
|
|
2176
|
+
locale?: EmailTemplateLocale;
|
|
2177
|
+
subject?: string;
|
|
2178
|
+
message?: string;
|
|
2179
|
+
senderName?: string;
|
|
2180
|
+
senderEmail?: string;
|
|
2181
|
+
replyToEmail?: string;
|
|
2182
|
+
replyToName?: string;
|
|
2183
|
+
}): Promise<Models.EmailTemplate>;
|
|
2184
|
+
/**
|
|
2185
|
+
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2186
|
+
*
|
|
2187
|
+
* @param {EmailTemplateType} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2188
|
+
* @param {EmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2189
|
+
* @param {string} subject - Subject of the email template. Can be up to 255 characters.
|
|
2190
|
+
* @param {string} message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
2191
|
+
* @param {string} senderName - Name of the email sender.
|
|
2192
|
+
* @param {string} senderEmail - Email of the sender.
|
|
2193
|
+
* @param {string} replyToEmail - Reply to email.
|
|
2194
|
+
* @param {string} replyToName - Reply to name.
|
|
2195
|
+
* @throws {AppwriteException}
|
|
2196
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
2197
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2198
|
+
*/
|
|
2199
|
+
updateEmailTemplate(templateId: EmailTemplateType, locale?: EmailTemplateLocale, subject?: string, message?: string, senderName?: string, senderEmail?: string, replyToEmail?: string, replyToName?: string): Promise<Models.EmailTemplate>;
|
|
2200
|
+
/**
|
|
2201
|
+
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2202
|
+
*
|
|
2203
|
+
* @param {EmailTemplateType} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2204
|
+
* @param {EmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2205
|
+
* @throws {AppwriteException}
|
|
2206
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
2207
|
+
*/
|
|
2208
|
+
getEmailTemplate(params: {
|
|
2209
|
+
templateId: EmailTemplateType;
|
|
2210
|
+
locale?: EmailTemplateLocale;
|
|
2211
|
+
}): Promise<Models.EmailTemplate>;
|
|
2212
|
+
/**
|
|
2213
|
+
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2214
|
+
*
|
|
2215
|
+
* @param {EmailTemplateType} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2216
|
+
* @param {EmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2217
|
+
* @throws {AppwriteException}
|
|
2218
|
+
* @returns {Promise<Models.EmailTemplate>}
|
|
2219
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2220
|
+
*/
|
|
2221
|
+
getEmailTemplate(templateId: EmailTemplateType, locale?: EmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
2222
|
+
/**
|
|
2223
|
+
* Get a list of all project environment variables.
|
|
2224
|
+
*
|
|
2225
|
+
* @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
|
|
2226
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2227
|
+
* @throws {AppwriteException}
|
|
2228
|
+
* @returns {Promise<Models.VariableList>}
|
|
2229
|
+
*/
|
|
2230
|
+
listVariables(params?: {
|
|
2231
|
+
queries?: string[];
|
|
2232
|
+
total?: boolean;
|
|
2233
|
+
}): Promise<Models.VariableList>;
|
|
2234
|
+
/**
|
|
2235
|
+
* Get a list of all project environment variables.
|
|
2236
|
+
*
|
|
2237
|
+
* @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
|
|
2238
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
2239
|
+
* @throws {AppwriteException}
|
|
2240
|
+
* @returns {Promise<Models.VariableList>}
|
|
2241
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2242
|
+
*/
|
|
2243
|
+
listVariables(queries?: string[], total?: boolean): Promise<Models.VariableList>;
|
|
2244
|
+
/**
|
|
2245
|
+
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2246
|
+
*
|
|
2247
|
+
* @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.
|
|
2248
|
+
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2249
|
+
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2250
|
+
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
2251
|
+
* @throws {AppwriteException}
|
|
2252
|
+
* @returns {Promise<Models.Variable>}
|
|
2253
|
+
*/
|
|
2254
|
+
createVariable(params: {
|
|
2255
|
+
variableId: string;
|
|
2256
|
+
key: string;
|
|
2257
|
+
value: string;
|
|
2258
|
+
secret?: boolean;
|
|
2259
|
+
}): Promise<Models.Variable>;
|
|
2260
|
+
/**
|
|
2261
|
+
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
2262
|
+
*
|
|
2263
|
+
* @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.
|
|
2264
|
+
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2265
|
+
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2266
|
+
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
2267
|
+
* @throws {AppwriteException}
|
|
2268
|
+
* @returns {Promise<Models.Variable>}
|
|
2269
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2270
|
+
*/
|
|
2271
|
+
createVariable(variableId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
|
|
2272
|
+
/**
|
|
2273
|
+
* Get a variable by its unique ID.
|
|
2274
|
+
*
|
|
2275
|
+
* @param {string} params.variableId - Variable ID.
|
|
2276
|
+
* @throws {AppwriteException}
|
|
2277
|
+
* @returns {Promise<Models.Variable>}
|
|
2278
|
+
*/
|
|
2279
|
+
getVariable(params: {
|
|
2280
|
+
variableId: string;
|
|
2281
|
+
}): Promise<Models.Variable>;
|
|
2282
|
+
/**
|
|
2283
|
+
* Get a variable by its unique ID.
|
|
2284
|
+
*
|
|
2285
|
+
* @param {string} variableId - Variable ID.
|
|
2286
|
+
* @throws {AppwriteException}
|
|
2287
|
+
* @returns {Promise<Models.Variable>}
|
|
2288
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2289
|
+
*/
|
|
2290
|
+
getVariable(variableId: string): Promise<Models.Variable>;
|
|
2291
|
+
/**
|
|
2292
|
+
* Update variable by its unique ID.
|
|
2293
|
+
*
|
|
2294
|
+
* @param {string} params.variableId - Variable ID.
|
|
2295
|
+
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
2296
|
+
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
2297
|
+
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
2298
|
+
* @throws {AppwriteException}
|
|
2299
|
+
* @returns {Promise<Models.Variable>}
|
|
2300
|
+
*/
|
|
2301
|
+
updateVariable(params: {
|
|
2302
|
+
variableId: string;
|
|
2303
|
+
key?: string;
|
|
2304
|
+
value?: string;
|
|
2305
|
+
secret?: boolean;
|
|
2306
|
+
}): Promise<Models.Variable>;
|
|
2307
|
+
/**
|
|
2308
|
+
* Update variable by its unique ID.
|
|
2309
|
+
*
|
|
2310
|
+
* @param {string} variableId - Variable ID.
|
|
2311
|
+
* @param {string} key - Variable key. Max length: 255 chars.
|
|
2312
|
+
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
2313
|
+
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
2314
|
+
* @throws {AppwriteException}
|
|
2315
|
+
* @returns {Promise<Models.Variable>}
|
|
2316
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2317
|
+
*/
|
|
2318
|
+
updateVariable(variableId: string, key?: string, value?: string, secret?: boolean): Promise<Models.Variable>;
|
|
2319
|
+
/**
|
|
2320
|
+
* Delete a variable by its unique ID.
|
|
2321
|
+
*
|
|
2322
|
+
* @param {string} params.variableId - Variable ID.
|
|
2323
|
+
* @throws {AppwriteException}
|
|
2324
|
+
* @returns {Promise<{}>}
|
|
2325
|
+
*/
|
|
2326
|
+
deleteVariable(params: {
|
|
2327
|
+
variableId: string;
|
|
2328
|
+
}): Promise<{}>;
|
|
2329
|
+
/**
|
|
2330
|
+
* Delete a variable by its unique ID.
|
|
2331
|
+
*
|
|
2332
|
+
* @param {string} variableId - Variable ID.
|
|
2333
|
+
* @throws {AppwriteException}
|
|
2334
|
+
* @returns {Promise<{}>}
|
|
2335
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2336
|
+
*/
|
|
2337
|
+
deleteVariable(variableId: string): Promise<{}>;
|
|
2338
|
+
}
|
|
2339
|
+
declare const Project: {
|
|
2340
|
+
new (client: Client<ServerAuth>): Project;
|
|
2341
|
+
};
|
|
2342
|
+
export { Project };
|