react-native-appwrite 0.7.0 → 0.7.1
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/dist/cjs/sdk.js +1096 -1449
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1096 -1449
- package/dist/esm/sdk.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +4 -3
- package/src/services/account.ts +90 -184
- package/src/services/avatars.ts +0 -14
- package/src/services/databases.ts +10 -20
- package/src/services/functions.ts +6 -12
- package/src/services/graphql.ts +4 -8
- package/src/services/locale.ts +16 -32
- package/src/services/messaging.ts +4 -8
- package/src/services/storage.ts +9 -25
- package/src/services/teams.ts +26 -52
- package/types/services/account.d.ts +0 -94
- package/types/services/avatars.d.ts +0 -14
- package/types/services/databases.d.ts +0 -10
- package/types/services/functions.d.ts +0 -6
- package/types/services/graphql.d.ts +0 -4
- package/types/services/locale.d.ts +0 -16
- package/types/services/messaging.d.ts +0 -4
- package/types/services/storage.d.ts +0 -16
- package/types/services/teams.d.ts +0 -26
|
@@ -7,8 +7,6 @@ import { OAuthProvider } from '../enums/o-auth-provider';
|
|
|
7
7
|
export declare class Account extends Service {
|
|
8
8
|
constructor(client: Client);
|
|
9
9
|
/**
|
|
10
|
-
* Get account
|
|
11
|
-
*
|
|
12
10
|
* Get the currently logged in user.
|
|
13
11
|
*
|
|
14
12
|
* @throws {AppwriteException}
|
|
@@ -16,8 +14,6 @@ export declare class Account extends Service {
|
|
|
16
14
|
*/
|
|
17
15
|
get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
|
|
18
16
|
/**
|
|
19
|
-
* Create account
|
|
20
|
-
*
|
|
21
17
|
* Use this endpoint to allow a new user to register a new account in your
|
|
22
18
|
* project. After the user registration completes successfully, you can use
|
|
23
19
|
* the
|
|
@@ -35,8 +31,6 @@ export declare class Account extends Service {
|
|
|
35
31
|
*/
|
|
36
32
|
create<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
37
33
|
/**
|
|
38
|
-
* Update email
|
|
39
|
-
*
|
|
40
34
|
* Update currently logged in user account email address. After changing user
|
|
41
35
|
* address, the user confirmation status will get reset. A new confirmation
|
|
42
36
|
* email is not sent automatically however you can use the send confirmation
|
|
@@ -53,8 +47,6 @@ export declare class Account extends Service {
|
|
|
53
47
|
*/
|
|
54
48
|
updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>;
|
|
55
49
|
/**
|
|
56
|
-
* List identities
|
|
57
|
-
*
|
|
58
50
|
* Get the list of identities for the currently logged in user.
|
|
59
51
|
*
|
|
60
52
|
* @param {string[]} queries
|
|
@@ -63,8 +55,6 @@ export declare class Account extends Service {
|
|
|
63
55
|
*/
|
|
64
56
|
listIdentities(queries?: string[]): Promise<Models.IdentityList>;
|
|
65
57
|
/**
|
|
66
|
-
* Delete identity
|
|
67
|
-
*
|
|
68
58
|
* Delete an identity by its unique ID.
|
|
69
59
|
*
|
|
70
60
|
* @param {string} identityId
|
|
@@ -73,8 +63,6 @@ export declare class Account extends Service {
|
|
|
73
63
|
*/
|
|
74
64
|
deleteIdentity(identityId: string): Promise<{}>;
|
|
75
65
|
/**
|
|
76
|
-
* Create JWT
|
|
77
|
-
*
|
|
78
66
|
* Use this endpoint to create a JSON Web Token. You can use the resulting JWT
|
|
79
67
|
* to authenticate on behalf of the current user when working with the
|
|
80
68
|
* Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
|
|
@@ -86,8 +74,6 @@ export declare class Account extends Service {
|
|
|
86
74
|
*/
|
|
87
75
|
createJWT(): Promise<Models.Jwt>;
|
|
88
76
|
/**
|
|
89
|
-
* List logs
|
|
90
|
-
*
|
|
91
77
|
* Get the list of latest security activity logs for the currently logged in
|
|
92
78
|
* user. Each log returns user IP address, location and date and time of log.
|
|
93
79
|
*
|
|
@@ -97,8 +83,6 @@ export declare class Account extends Service {
|
|
|
97
83
|
*/
|
|
98
84
|
listLogs(queries?: string[]): Promise<Models.LogList>;
|
|
99
85
|
/**
|
|
100
|
-
* Update MFA
|
|
101
|
-
*
|
|
102
86
|
* Enable or disable MFA on an account.
|
|
103
87
|
*
|
|
104
88
|
* @param {boolean} mfa
|
|
@@ -107,8 +91,6 @@ export declare class Account extends Service {
|
|
|
107
91
|
*/
|
|
108
92
|
updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
|
|
109
93
|
/**
|
|
110
|
-
* Create authenticator
|
|
111
|
-
*
|
|
112
94
|
* Add an authenticator app to be used as an MFA factor. Verify the
|
|
113
95
|
* authenticator using the [verify
|
|
114
96
|
* authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator)
|
|
@@ -120,8 +102,6 @@ export declare class Account extends Service {
|
|
|
120
102
|
*/
|
|
121
103
|
createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>;
|
|
122
104
|
/**
|
|
123
|
-
* Verify authenticator
|
|
124
|
-
*
|
|
125
105
|
* Verify an authenticator app after adding it using the [add
|
|
126
106
|
* authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
|
|
127
107
|
* method.
|
|
@@ -133,8 +113,6 @@ export declare class Account extends Service {
|
|
|
133
113
|
*/
|
|
134
114
|
updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
|
|
135
115
|
/**
|
|
136
|
-
* Delete authenticator
|
|
137
|
-
*
|
|
138
116
|
* Delete an authenticator for a user by ID.
|
|
139
117
|
*
|
|
140
118
|
* @param {AuthenticatorType} type
|
|
@@ -143,8 +121,6 @@ export declare class Account extends Service {
|
|
|
143
121
|
*/
|
|
144
122
|
deleteMfaAuthenticator(type: AuthenticatorType): Promise<{}>;
|
|
145
123
|
/**
|
|
146
|
-
* Create MFA challenge
|
|
147
|
-
*
|
|
148
124
|
* Begin the process of MFA verification after sign-in. Finish the flow with
|
|
149
125
|
* [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
|
|
150
126
|
* method.
|
|
@@ -155,8 +131,6 @@ export declare class Account extends Service {
|
|
|
155
131
|
*/
|
|
156
132
|
createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
|
|
157
133
|
/**
|
|
158
|
-
* Create MFA challenge (confirmation)
|
|
159
|
-
*
|
|
160
134
|
* Complete the MFA challenge by providing the one-time password. Finish the
|
|
161
135
|
* process of MFA verification by providing the one-time password. To begin
|
|
162
136
|
* the flow, use
|
|
@@ -170,8 +144,6 @@ export declare class Account extends Service {
|
|
|
170
144
|
*/
|
|
171
145
|
updateMfaChallenge(challengeId: string, otp: string): Promise<Models.Session>;
|
|
172
146
|
/**
|
|
173
|
-
* List factors
|
|
174
|
-
*
|
|
175
147
|
* List the factors available on the account to be used as a MFA challange.
|
|
176
148
|
*
|
|
177
149
|
* @throws {AppwriteException}
|
|
@@ -179,8 +151,6 @@ export declare class Account extends Service {
|
|
|
179
151
|
*/
|
|
180
152
|
listMfaFactors(): Promise<Models.MfaFactors>;
|
|
181
153
|
/**
|
|
182
|
-
* Get MFA recovery codes
|
|
183
|
-
*
|
|
184
154
|
* Get recovery codes that can be used as backup for MFA flow. Before getting
|
|
185
155
|
* codes, they must be generated using
|
|
186
156
|
* [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
|
|
@@ -191,8 +161,6 @@ export declare class Account extends Service {
|
|
|
191
161
|
*/
|
|
192
162
|
getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
|
|
193
163
|
/**
|
|
194
|
-
* Create MFA recovery codes
|
|
195
|
-
*
|
|
196
164
|
* Generate recovery codes as backup for MFA flow. It's recommended to
|
|
197
165
|
* generate and show then immediately after user successfully adds their
|
|
198
166
|
* authehticator. Recovery codes can be used as a MFA verification type in
|
|
@@ -204,8 +172,6 @@ export declare class Account extends Service {
|
|
|
204
172
|
*/
|
|
205
173
|
createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
|
|
206
174
|
/**
|
|
207
|
-
* Regenerate MFA recovery codes
|
|
208
|
-
*
|
|
209
175
|
* Regenerate recovery codes that can be used as backup for MFA flow. Before
|
|
210
176
|
* regenerating codes, they must be first generated using
|
|
211
177
|
* [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
|
|
@@ -216,8 +182,6 @@ export declare class Account extends Service {
|
|
|
216
182
|
*/
|
|
217
183
|
updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
|
|
218
184
|
/**
|
|
219
|
-
* Update name
|
|
220
|
-
*
|
|
221
185
|
* Update currently logged in user account name.
|
|
222
186
|
*
|
|
223
187
|
* @param {string} name
|
|
@@ -226,8 +190,6 @@ export declare class Account extends Service {
|
|
|
226
190
|
*/
|
|
227
191
|
updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.User<Preferences>>;
|
|
228
192
|
/**
|
|
229
|
-
* Update password
|
|
230
|
-
*
|
|
231
193
|
* Update currently logged in user password. For validation, user is required
|
|
232
194
|
* to pass in the new password, and the old password. For users created with
|
|
233
195
|
* OAuth, Team Invites and Magic URL, oldPassword is optional.
|
|
@@ -239,8 +201,6 @@ export declare class Account extends Service {
|
|
|
239
201
|
*/
|
|
240
202
|
updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
|
|
241
203
|
/**
|
|
242
|
-
* Update phone
|
|
243
|
-
*
|
|
244
204
|
* Update the currently logged in user's phone number. After updating the
|
|
245
205
|
* phone number, the phone verification status will be reset. A confirmation
|
|
246
206
|
* SMS is not sent automatically, however you can use the [POST
|
|
@@ -254,8 +214,6 @@ export declare class Account extends Service {
|
|
|
254
214
|
*/
|
|
255
215
|
updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.User<Preferences>>;
|
|
256
216
|
/**
|
|
257
|
-
* Get account preferences
|
|
258
|
-
*
|
|
259
217
|
* Get the preferences as a key-value object for the currently logged in user.
|
|
260
218
|
*
|
|
261
219
|
* @throws {AppwriteException}
|
|
@@ -263,8 +221,6 @@ export declare class Account extends Service {
|
|
|
263
221
|
*/
|
|
264
222
|
getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>;
|
|
265
223
|
/**
|
|
266
|
-
* Update preferences
|
|
267
|
-
*
|
|
268
224
|
* Update currently logged in user account preferences. The object you pass is
|
|
269
225
|
* stored as is, and replaces any previous value. The maximum allowed prefs
|
|
270
226
|
* size is 64kB and throws error if exceeded.
|
|
@@ -275,8 +231,6 @@ export declare class Account extends Service {
|
|
|
275
231
|
*/
|
|
276
232
|
updatePrefs<Preferences extends Models.Preferences>(prefs: object): Promise<Models.User<Preferences>>;
|
|
277
233
|
/**
|
|
278
|
-
* Create password recovery
|
|
279
|
-
*
|
|
280
234
|
* Sends the user an email with a temporary secret key for password reset.
|
|
281
235
|
* When the user clicks the confirmation link he is redirected back to your
|
|
282
236
|
* app password reset URL with the secret key and email address values
|
|
@@ -293,8 +247,6 @@ export declare class Account extends Service {
|
|
|
293
247
|
*/
|
|
294
248
|
createRecovery(email: string, url: string): Promise<Models.Token>;
|
|
295
249
|
/**
|
|
296
|
-
* Create password recovery (confirmation)
|
|
297
|
-
*
|
|
298
250
|
* Use this endpoint to complete the user account password reset. Both the
|
|
299
251
|
* **userId** and **secret** arguments will be passed as query parameters to
|
|
300
252
|
* the redirect URL you have provided when sending your request to the [POST
|
|
@@ -314,8 +266,6 @@ export declare class Account extends Service {
|
|
|
314
266
|
*/
|
|
315
267
|
updateRecovery(userId: string, secret: string, password: string): Promise<Models.Token>;
|
|
316
268
|
/**
|
|
317
|
-
* List sessions
|
|
318
|
-
*
|
|
319
269
|
* Get the list of active sessions across different devices for the currently
|
|
320
270
|
* logged in user.
|
|
321
271
|
*
|
|
@@ -324,8 +274,6 @@ export declare class Account extends Service {
|
|
|
324
274
|
*/
|
|
325
275
|
listSessions(): Promise<Models.SessionList>;
|
|
326
276
|
/**
|
|
327
|
-
* Delete sessions
|
|
328
|
-
*
|
|
329
277
|
* Delete all sessions from the user account and remove any sessions cookies
|
|
330
278
|
* from the end client.
|
|
331
279
|
*
|
|
@@ -334,8 +282,6 @@ export declare class Account extends Service {
|
|
|
334
282
|
*/
|
|
335
283
|
deleteSessions(): Promise<{}>;
|
|
336
284
|
/**
|
|
337
|
-
* Create anonymous session
|
|
338
|
-
*
|
|
339
285
|
* Use this endpoint to allow a new user to register an anonymous account in
|
|
340
286
|
* your project. This route will also create a new session for the user. To
|
|
341
287
|
* allow the new user to convert an anonymous account to a normal account, you
|
|
@@ -349,8 +295,6 @@ export declare class Account extends Service {
|
|
|
349
295
|
*/
|
|
350
296
|
createAnonymousSession(): Promise<Models.Session>;
|
|
351
297
|
/**
|
|
352
|
-
* Create email password session
|
|
353
|
-
*
|
|
354
298
|
* Allow the user to login into their account by providing a valid email and
|
|
355
299
|
* password combination. This route will create a new session for the user.
|
|
356
300
|
*
|
|
@@ -365,8 +309,6 @@ export declare class Account extends Service {
|
|
|
365
309
|
*/
|
|
366
310
|
createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
|
|
367
311
|
/**
|
|
368
|
-
* Update magic URL session
|
|
369
|
-
*
|
|
370
312
|
* Use this endpoint to create a session from token. Provide the **userId**
|
|
371
313
|
* and **secret** parameters from the successful response of authentication
|
|
372
314
|
* flows initiated by token creation. For example, magic URL and phone login.
|
|
@@ -378,8 +320,6 @@ export declare class Account extends Service {
|
|
|
378
320
|
*/
|
|
379
321
|
updateMagicURLSession(userId: string, secret: string): Promise<Models.Session>;
|
|
380
322
|
/**
|
|
381
|
-
* Create OAuth2 session
|
|
382
|
-
*
|
|
383
323
|
* Allow the user to login to their account using the OAuth2 provider of their
|
|
384
324
|
* choice. Each OAuth2 provider should be enabled from the Appwrite console
|
|
385
325
|
* first. Use the success and failure arguments to provide a redirect URL's
|
|
@@ -406,8 +346,6 @@ export declare class Account extends Service {
|
|
|
406
346
|
*/
|
|
407
347
|
createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
|
|
408
348
|
/**
|
|
409
|
-
* Update phone session
|
|
410
|
-
*
|
|
411
349
|
* Use this endpoint to create a session from token. Provide the **userId**
|
|
412
350
|
* and **secret** parameters from the successful response of authentication
|
|
413
351
|
* flows initiated by token creation. For example, magic URL and phone login.
|
|
@@ -419,8 +357,6 @@ export declare class Account extends Service {
|
|
|
419
357
|
*/
|
|
420
358
|
updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
|
|
421
359
|
/**
|
|
422
|
-
* Create session
|
|
423
|
-
*
|
|
424
360
|
* Use this endpoint to create a session from token. Provide the **userId**
|
|
425
361
|
* and **secret** parameters from the successful response of authentication
|
|
426
362
|
* flows initiated by token creation. For example, magic URL and phone login.
|
|
@@ -432,8 +368,6 @@ export declare class Account extends Service {
|
|
|
432
368
|
*/
|
|
433
369
|
createSession(userId: string, secret: string): Promise<Models.Session>;
|
|
434
370
|
/**
|
|
435
|
-
* Get session
|
|
436
|
-
*
|
|
437
371
|
* Use this endpoint to get a logged in user's session using a Session ID.
|
|
438
372
|
* Inputting 'current' will return the current session being used.
|
|
439
373
|
*
|
|
@@ -443,8 +377,6 @@ export declare class Account extends Service {
|
|
|
443
377
|
*/
|
|
444
378
|
getSession(sessionId: string): Promise<Models.Session>;
|
|
445
379
|
/**
|
|
446
|
-
* Update session
|
|
447
|
-
*
|
|
448
380
|
* Use this endpoint to extend a session's length. Extending a session is
|
|
449
381
|
* useful when session expiry is short. If the session was created using an
|
|
450
382
|
* OAuth provider, this endpoint refreshes the access token from the provider.
|
|
@@ -455,8 +387,6 @@ export declare class Account extends Service {
|
|
|
455
387
|
*/
|
|
456
388
|
updateSession(sessionId: string): Promise<Models.Session>;
|
|
457
389
|
/**
|
|
458
|
-
* Delete session
|
|
459
|
-
*
|
|
460
390
|
* Logout the user. Use 'current' as the session ID to logout on this device,
|
|
461
391
|
* use a session ID to logout on another device. If you're looking to logout
|
|
462
392
|
* the user on all devices, use [Delete
|
|
@@ -469,8 +399,6 @@ export declare class Account extends Service {
|
|
|
469
399
|
*/
|
|
470
400
|
deleteSession(sessionId: string): Promise<{}>;
|
|
471
401
|
/**
|
|
472
|
-
* Update status
|
|
473
|
-
*
|
|
474
402
|
* Block the currently logged in user account. Behind the scene, the user
|
|
475
403
|
* record is not deleted but permanently blocked from any access. To
|
|
476
404
|
* completely delete a user, use the Users API instead.
|
|
@@ -480,8 +408,6 @@ export declare class Account extends Service {
|
|
|
480
408
|
*/
|
|
481
409
|
updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
|
|
482
410
|
/**
|
|
483
|
-
* Create push target
|
|
484
|
-
*
|
|
485
411
|
* Use this endpoint to register a device for push notifications. Provide a
|
|
486
412
|
* target ID (custom or generated using ID.unique()), a device identifier
|
|
487
413
|
* (usually a device token), and optionally specify which provider should send
|
|
@@ -496,8 +422,6 @@ export declare class Account extends Service {
|
|
|
496
422
|
*/
|
|
497
423
|
createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
|
|
498
424
|
/**
|
|
499
|
-
* Update push target
|
|
500
|
-
*
|
|
501
425
|
* Update the currently logged in user's push notification target. You can
|
|
502
426
|
* modify the target's identifier (device token) and provider ID (token,
|
|
503
427
|
* email, phone etc.). The target must exist and belong to the current user.
|
|
@@ -511,8 +435,6 @@ export declare class Account extends Service {
|
|
|
511
435
|
*/
|
|
512
436
|
updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
|
|
513
437
|
/**
|
|
514
|
-
* Delete push target
|
|
515
|
-
*
|
|
516
438
|
* Delete a push notification target for the currently logged in user. After
|
|
517
439
|
* deletion, the device will no longer receive push notifications. The target
|
|
518
440
|
* must exist and belong to the current user.
|
|
@@ -523,8 +445,6 @@ export declare class Account extends Service {
|
|
|
523
445
|
*/
|
|
524
446
|
deletePushTarget(targetId: string): Promise<{}>;
|
|
525
447
|
/**
|
|
526
|
-
* Create email token (OTP)
|
|
527
|
-
*
|
|
528
448
|
* Sends the user an email with a secret key for creating a session. If the
|
|
529
449
|
* provided user ID has not be registered, a new user will be created. Use the
|
|
530
450
|
* returned user ID and secret and submit a request to the [POST
|
|
@@ -544,8 +464,6 @@ export declare class Account extends Service {
|
|
|
544
464
|
*/
|
|
545
465
|
createEmailToken(userId: string, email: string, phrase?: boolean): Promise<Models.Token>;
|
|
546
466
|
/**
|
|
547
|
-
* Create magic URL token
|
|
548
|
-
*
|
|
549
467
|
* Sends the user an email with a secret key for creating a session. If the
|
|
550
468
|
* provided user ID has not been registered, a new user will be created. When
|
|
551
469
|
* the user clicks the link in the email, the user is redirected back to the
|
|
@@ -570,8 +488,6 @@ export declare class Account extends Service {
|
|
|
570
488
|
*/
|
|
571
489
|
createMagicURLToken(userId: string, email: string, url?: string, phrase?: boolean): Promise<Models.Token>;
|
|
572
490
|
/**
|
|
573
|
-
* Create OAuth2 token
|
|
574
|
-
*
|
|
575
491
|
* Allow the user to login to their account using the OAuth2 provider of their
|
|
576
492
|
* choice. Each OAuth2 provider should be enabled from the Appwrite console
|
|
577
493
|
* first. Use the success and failure arguments to provide a redirect URL's
|
|
@@ -596,8 +512,6 @@ export declare class Account extends Service {
|
|
|
596
512
|
*/
|
|
597
513
|
createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
|
|
598
514
|
/**
|
|
599
|
-
* Create phone token
|
|
600
|
-
*
|
|
601
515
|
* Sends the user an SMS with a secret key for creating a session. If the
|
|
602
516
|
* provided user ID has not be registered, a new user will be created. Use the
|
|
603
517
|
* returned user ID and secret and submit a request to the [POST
|
|
@@ -616,8 +530,6 @@ export declare class Account extends Service {
|
|
|
616
530
|
*/
|
|
617
531
|
createPhoneToken(userId: string, phone: string): Promise<Models.Token>;
|
|
618
532
|
/**
|
|
619
|
-
* Create email verification
|
|
620
|
-
*
|
|
621
533
|
* Use this endpoint to send a verification message to your user email address
|
|
622
534
|
* to confirm they are the valid owners of that address. Both the **userId**
|
|
623
535
|
* and **secret** arguments will be passed as query parameters to the URL you
|
|
@@ -640,8 +552,6 @@ export declare class Account extends Service {
|
|
|
640
552
|
*/
|
|
641
553
|
createVerification(url: string): Promise<Models.Token>;
|
|
642
554
|
/**
|
|
643
|
-
* Create email verification (confirmation)
|
|
644
|
-
*
|
|
645
555
|
* Use this endpoint to complete the user email verification process. Use both
|
|
646
556
|
* the **userId** and **secret** parameters that were attached to your app URL
|
|
647
557
|
* to verify the user email ownership. If confirmed this route will return a
|
|
@@ -654,8 +564,6 @@ export declare class Account extends Service {
|
|
|
654
564
|
*/
|
|
655
565
|
updateVerification(userId: string, secret: string): Promise<Models.Token>;
|
|
656
566
|
/**
|
|
657
|
-
* Create phone verification
|
|
658
|
-
*
|
|
659
567
|
* Use this endpoint to send a verification SMS to the currently logged in
|
|
660
568
|
* user. This endpoint is meant for use after updating a user's phone number
|
|
661
569
|
* using the
|
|
@@ -670,8 +578,6 @@ export declare class Account extends Service {
|
|
|
670
578
|
*/
|
|
671
579
|
createPhoneVerification(): Promise<Models.Token>;
|
|
672
580
|
/**
|
|
673
|
-
* Update phone verification (confirmation)
|
|
674
|
-
*
|
|
675
581
|
* Use this endpoint to complete the user phone verification process. Use the
|
|
676
582
|
* **userId** and **secret** that were sent to your user's phone number to
|
|
677
583
|
* verify the user email ownership. If confirmed this route will return a 200
|
|
@@ -6,8 +6,6 @@ import { Flag } from '../enums/flag';
|
|
|
6
6
|
export declare class Avatars extends Service {
|
|
7
7
|
constructor(client: Client);
|
|
8
8
|
/**
|
|
9
|
-
* Get browser icon
|
|
10
|
-
*
|
|
11
9
|
* You can use this endpoint to show different browser icons to your users.
|
|
12
10
|
* The code argument receives the browser code as it appears in your user [GET
|
|
13
11
|
* /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
|
|
@@ -28,8 +26,6 @@ export declare class Avatars extends Service {
|
|
|
28
26
|
*/
|
|
29
27
|
getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
|
|
30
28
|
/**
|
|
31
|
-
* Get credit card icon
|
|
32
|
-
*
|
|
33
29
|
* The credit card endpoint will return you the icon of the credit card
|
|
34
30
|
* provider you need. Use width, height and quality arguments to change the
|
|
35
31
|
* output settings.
|
|
@@ -49,8 +45,6 @@ export declare class Avatars extends Service {
|
|
|
49
45
|
*/
|
|
50
46
|
getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
|
|
51
47
|
/**
|
|
52
|
-
* Get favicon
|
|
53
|
-
*
|
|
54
48
|
* Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
|
|
55
49
|
* website URL.
|
|
56
50
|
*
|
|
@@ -62,8 +56,6 @@ export declare class Avatars extends Service {
|
|
|
62
56
|
*/
|
|
63
57
|
getFavicon(url: string): URL;
|
|
64
58
|
/**
|
|
65
|
-
* Get country flag
|
|
66
|
-
*
|
|
67
59
|
* You can use this endpoint to show different country flags icons to your
|
|
68
60
|
* users. The code argument receives the 2 letter country code. Use width,
|
|
69
61
|
* height and quality arguments to change the output settings. Country codes
|
|
@@ -84,8 +76,6 @@ export declare class Avatars extends Service {
|
|
|
84
76
|
*/
|
|
85
77
|
getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
|
|
86
78
|
/**
|
|
87
|
-
* Get image from URL
|
|
88
|
-
*
|
|
89
79
|
* Use this endpoint to fetch a remote image URL and crop it to any image size
|
|
90
80
|
* you want. This endpoint is very useful if you need to crop and display
|
|
91
81
|
* remote images in your app or in case you want to make sure a 3rd party
|
|
@@ -106,8 +96,6 @@ export declare class Avatars extends Service {
|
|
|
106
96
|
*/
|
|
107
97
|
getImage(url: string, width?: number, height?: number): URL;
|
|
108
98
|
/**
|
|
109
|
-
* Get user initials
|
|
110
|
-
*
|
|
111
99
|
* Use this endpoint to show your user initials avatar icon on your website or
|
|
112
100
|
* app. By default, this route will try to print your logged-in user name or
|
|
113
101
|
* email initials. You can also overwrite the user name if you pass the 'name'
|
|
@@ -134,8 +122,6 @@ export declare class Avatars extends Service {
|
|
|
134
122
|
*/
|
|
135
123
|
getInitials(name?: string, width?: number, height?: number, background?: string): URL;
|
|
136
124
|
/**
|
|
137
|
-
* Get QR code
|
|
138
|
-
*
|
|
139
125
|
* Converts a given plain text to a QR code image. You can use the query
|
|
140
126
|
* parameters to change the size and style of the resulting image.
|
|
141
127
|
*
|
|
@@ -4,8 +4,6 @@ import type { Models } from '../models';
|
|
|
4
4
|
export declare class Databases extends Service {
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
|
-
* List documents
|
|
8
|
-
*
|
|
9
7
|
* Get a list of all the user's documents in a given collection. You can use
|
|
10
8
|
* the query params to filter your results.
|
|
11
9
|
*
|
|
@@ -17,8 +15,6 @@ export declare class Databases extends Service {
|
|
|
17
15
|
*/
|
|
18
16
|
listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
|
|
19
17
|
/**
|
|
20
|
-
* Create document
|
|
21
|
-
*
|
|
22
18
|
* Create a new Document. Before using this route, you should create a new
|
|
23
19
|
* collection resource using either a [server
|
|
24
20
|
* integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
|
|
@@ -34,8 +30,6 @@ export declare class Databases extends Service {
|
|
|
34
30
|
*/
|
|
35
31
|
createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
|
|
36
32
|
/**
|
|
37
|
-
* Get document
|
|
38
|
-
*
|
|
39
33
|
* Get a document by its unique ID. This endpoint response returns a JSON
|
|
40
34
|
* object with the document data.
|
|
41
35
|
*
|
|
@@ -48,8 +42,6 @@ export declare class Databases extends Service {
|
|
|
48
42
|
*/
|
|
49
43
|
getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
|
|
50
44
|
/**
|
|
51
|
-
* Update document
|
|
52
|
-
*
|
|
53
45
|
* Update a document by its unique ID. Using the patch method you can pass
|
|
54
46
|
* only specific fields that will get updated.
|
|
55
47
|
*
|
|
@@ -63,8 +55,6 @@ export declare class Databases extends Service {
|
|
|
63
55
|
*/
|
|
64
56
|
updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: object, permissions?: string[]): Promise<Document>;
|
|
65
57
|
/**
|
|
66
|
-
* Delete document
|
|
67
|
-
*
|
|
68
58
|
* Delete a document by its unique ID.
|
|
69
59
|
*
|
|
70
60
|
* @param {string} databaseId
|
|
@@ -5,8 +5,6 @@ import { ExecutionMethod } from '../enums/execution-method';
|
|
|
5
5
|
export declare class Functions extends Service {
|
|
6
6
|
constructor(client: Client);
|
|
7
7
|
/**
|
|
8
|
-
* List executions
|
|
9
|
-
*
|
|
10
8
|
* Get a list of all the current user function execution logs. You can use the
|
|
11
9
|
* query params to filter your results.
|
|
12
10
|
*
|
|
@@ -18,8 +16,6 @@ export declare class Functions extends Service {
|
|
|
18
16
|
*/
|
|
19
17
|
listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
|
|
20
18
|
/**
|
|
21
|
-
* Create execution
|
|
22
|
-
*
|
|
23
19
|
* Trigger a function execution. The returned object will return you the
|
|
24
20
|
* current execution status. You can ping the `Get Execution` endpoint to get
|
|
25
21
|
* updates on the current execution status. Once this endpoint is called, your
|
|
@@ -37,8 +33,6 @@ export declare class Functions extends Service {
|
|
|
37
33
|
*/
|
|
38
34
|
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
|
|
39
35
|
/**
|
|
40
|
-
* Get execution
|
|
41
|
-
*
|
|
42
36
|
* Get a function execution log by its unique ID.
|
|
43
37
|
*
|
|
44
38
|
* @param {string} functionId
|
|
@@ -3,8 +3,6 @@ import { Client } from '../client';
|
|
|
3
3
|
export declare class Graphql extends Service {
|
|
4
4
|
constructor(client: Client);
|
|
5
5
|
/**
|
|
6
|
-
* GraphQL endpoint
|
|
7
|
-
*
|
|
8
6
|
* Execute a GraphQL mutation.
|
|
9
7
|
*
|
|
10
8
|
* @param {object} query
|
|
@@ -13,8 +11,6 @@ export declare class Graphql extends Service {
|
|
|
13
11
|
*/
|
|
14
12
|
query(query: object): Promise<{}>;
|
|
15
13
|
/**
|
|
16
|
-
* GraphQL endpoint
|
|
17
|
-
*
|
|
18
14
|
* Execute a GraphQL mutation.
|
|
19
15
|
*
|
|
20
16
|
* @param {object} query
|
|
@@ -4,8 +4,6 @@ import type { Models } from '../models';
|
|
|
4
4
|
export declare class Locale extends Service {
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
|
-
* Get user locale
|
|
8
|
-
*
|
|
9
7
|
* Get the current user location based on IP. Returns an object with user
|
|
10
8
|
* country code, country name, continent name, continent code, ip address and
|
|
11
9
|
* suggested currency. You can use the locale header to get the data in a
|
|
@@ -18,8 +16,6 @@ export declare class Locale extends Service {
|
|
|
18
16
|
*/
|
|
19
17
|
get(): Promise<Models.Locale>;
|
|
20
18
|
/**
|
|
21
|
-
* List locale codes
|
|
22
|
-
*
|
|
23
19
|
* List of all locale codes in [ISO
|
|
24
20
|
* 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
|
|
25
21
|
*
|
|
@@ -28,8 +24,6 @@ export declare class Locale extends Service {
|
|
|
28
24
|
*/
|
|
29
25
|
listCodes(): Promise<Models.LocaleCodeList>;
|
|
30
26
|
/**
|
|
31
|
-
* List continents
|
|
32
|
-
*
|
|
33
27
|
* List of all continents. You can use the locale header to get the data in a
|
|
34
28
|
* supported language.
|
|
35
29
|
*
|
|
@@ -38,8 +32,6 @@ export declare class Locale extends Service {
|
|
|
38
32
|
*/
|
|
39
33
|
listContinents(): Promise<Models.ContinentList>;
|
|
40
34
|
/**
|
|
41
|
-
* List countries
|
|
42
|
-
*
|
|
43
35
|
* List of all countries. You can use the locale header to get the data in a
|
|
44
36
|
* supported language.
|
|
45
37
|
*
|
|
@@ -48,8 +40,6 @@ export declare class Locale extends Service {
|
|
|
48
40
|
*/
|
|
49
41
|
listCountries(): Promise<Models.CountryList>;
|
|
50
42
|
/**
|
|
51
|
-
* List EU countries
|
|
52
|
-
*
|
|
53
43
|
* List of all countries that are currently members of the EU. You can use the
|
|
54
44
|
* locale header to get the data in a supported language.
|
|
55
45
|
*
|
|
@@ -58,8 +48,6 @@ export declare class Locale extends Service {
|
|
|
58
48
|
*/
|
|
59
49
|
listCountriesEU(): Promise<Models.CountryList>;
|
|
60
50
|
/**
|
|
61
|
-
* List countries phone codes
|
|
62
|
-
*
|
|
63
51
|
* List of all countries phone codes. You can use the locale header to get the
|
|
64
52
|
* data in a supported language.
|
|
65
53
|
*
|
|
@@ -68,8 +56,6 @@ export declare class Locale extends Service {
|
|
|
68
56
|
*/
|
|
69
57
|
listCountriesPhones(): Promise<Models.PhoneList>;
|
|
70
58
|
/**
|
|
71
|
-
* List currencies
|
|
72
|
-
*
|
|
73
59
|
* List of all currencies, including currency symbol, name, plural, and
|
|
74
60
|
* decimal digits for all major and minor currencies. You can use the locale
|
|
75
61
|
* header to get the data in a supported language.
|
|
@@ -79,8 +65,6 @@ export declare class Locale extends Service {
|
|
|
79
65
|
*/
|
|
80
66
|
listCurrencies(): Promise<Models.CurrencyList>;
|
|
81
67
|
/**
|
|
82
|
-
* List languages
|
|
83
|
-
*
|
|
84
68
|
* List of all languages classified by ISO 639-1 including 2-letter code, name
|
|
85
69
|
* in English, and name in the respective language.
|
|
86
70
|
*
|
|
@@ -4,8 +4,6 @@ import type { Models } from '../models';
|
|
|
4
4
|
export declare class Messaging extends Service {
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
|
-
* Create subscriber
|
|
8
|
-
*
|
|
9
7
|
* Create a new subscriber.
|
|
10
8
|
*
|
|
11
9
|
* @param {string} topicId
|
|
@@ -16,8 +14,6 @@ export declare class Messaging extends Service {
|
|
|
16
14
|
*/
|
|
17
15
|
createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
|
|
18
16
|
/**
|
|
19
|
-
* Delete subscriber
|
|
20
|
-
*
|
|
21
17
|
* Delete a subscriber by its unique ID.
|
|
22
18
|
*
|
|
23
19
|
* @param {string} topicId
|