@@ -8,7 +8,7 @@ import AppwriteModels
8
8
open class Account : Service {
9
9
10
10
///
11
- /// Get Account
11
+ /// Get account
12
12
///
13
13
/// Get the currently logged in user.
14
14
///
@@ -40,7 +40,7 @@ open class Account: Service {
40
40
}
41
41
42
42
///
43
- /// Get Account
43
+ /// Get account
44
44
///
45
45
/// Get the currently logged in user.
46
46
///
@@ -55,7 +55,7 @@ open class Account: Service {
55
55
}
56
56
57
57
///
58
- /// Update Email
58
+ /// Update email
59
59
///
60
60
/// Update currently logged in user account email address. After changing user
61
61
/// address, the user confirmation status will get reset. A new confirmation
@@ -101,7 +101,7 @@ open class Account: Service {
101
101
}
102
102
103
103
///
104
- /// Update Email
104
+ /// Update email
105
105
///
106
106
/// Update currently logged in user account email address. After changing user
107
107
/// address, the user confirmation status will get reset. A new confirmation
@@ -192,7 +192,7 @@ open class Account: Service {
192
192
}
193
193
194
194
///
195
- /// List Logs
195
+ /// List logs
196
196
///
197
197
/// Get the list of latest security activity logs for the currently logged in
198
198
/// user. Each log returns user IP address, location and date and time of log.
@@ -228,7 +228,7 @@ open class Account: Service {
228
228
}
229
229
230
230
///
231
- /// Update Name
231
+ /// Update name
232
232
///
233
233
/// Update currently logged in user account name.
234
234
///
@@ -264,7 +264,7 @@ open class Account: Service {
264
264
}
265
265
266
266
///
267
- /// Update Name
267
+ /// Update name
268
268
///
269
269
/// Update currently logged in user account name.
270
270
///
@@ -282,7 +282,7 @@ open class Account: Service {
282
282
}
283
283
284
284
///
285
- /// Update Password
285
+ /// Update password
286
286
///
287
287
/// Update currently logged in user password. For validation, user is required
288
288
/// to pass in the new password, and the old password. For users created with
@@ -323,7 +323,7 @@ open class Account: Service {
323
323
}
324
324
325
325
///
326
- /// Update Password
326
+ /// Update password
327
327
///
328
328
/// Update currently logged in user password. For validation, user is required
329
329
/// to pass in the new password, and the old password. For users created with
@@ -346,12 +346,12 @@ open class Account: Service {
346
346
}
347
347
348
348
///
349
- /// Update Phone
349
+ /// Update phone
350
350
///
351
351
/// Update the currently logged in user's phone number. After updating the
352
352
/// phone number, the phone verification status will be reset. A confirmation
353
353
/// SMS is not sent automatically, however you can use the [POST
354
- /// /account/verification/phone](/ docs/client/account#accountCreatePhoneVerification )
354
+ /// /account/verification/phone](https://appwrite.io/ docs/references/cloud/ client-web /account#createPhoneVerification )
355
355
/// endpoint to send a confirmation SMS.
356
356
///
357
357
/// @param String phone
@@ -389,12 +389,12 @@ open class Account: Service {
389
389
}
390
390
391
391
///
392
- /// Update Phone
392
+ /// Update phone
393
393
///
394
394
/// Update the currently logged in user's phone number. After updating the
395
395
/// phone number, the phone verification status will be reset. A confirmation
396
396
/// SMS is not sent automatically, however you can use the [POST
397
- /// /account/verification/phone](/ docs/client/account#accountCreatePhoneVerification )
397
+ /// /account/verification/phone](https://appwrite.io/ docs/references/cloud/ client-web /account#createPhoneVerification )
398
398
/// endpoint to send a confirmation SMS.
399
399
///
400
400
/// @param String phone
@@ -414,7 +414,7 @@ open class Account: Service {
414
414
}
415
415
416
416
///
417
- /// Get Account Preferences
417
+ /// Get account preferences
418
418
///
419
419
/// Get the preferences as a key-value object for the currently logged in user.
420
420
///
@@ -446,7 +446,7 @@ open class Account: Service {
446
446
}
447
447
448
448
///
449
- /// Get Account Preferences
449
+ /// Get account preferences
450
450
///
451
451
/// Get the preferences as a key-value object for the currently logged in user.
452
452
///
@@ -461,7 +461,7 @@ open class Account: Service {
461
461
}
462
462
463
463
///
464
- /// Update Preferences
464
+ /// Update preferences
465
465
///
466
466
/// Update currently logged in user account preferences. The object you pass is
467
467
/// stored as is, and replaces any previous value. The maximum allowed prefs
@@ -499,7 +499,7 @@ open class Account: Service {
499
499
}
500
500
501
501
///
502
- /// Update Preferences
502
+ /// Update preferences
503
503
///
504
504
/// Update currently logged in user account preferences. The object you pass is
505
505
/// stored as is, and replaces any previous value. The maximum allowed prefs
@@ -519,16 +519,16 @@ open class Account: Service {
519
519
}
520
520
521
521
///
522
- /// Create Password Recovery
522
+ /// Create password recovery
523
523
///
524
524
/// Sends the user an email with a temporary secret key for password reset.
525
525
/// When the user clicks the confirmation link he is redirected back to your
526
526
/// app password reset URL with the secret key and email address values
527
527
/// attached to the URL query string. Use the query string params to submit a
528
528
/// request to the [PUT
529
- /// /account/recovery](/ docs/client/account#accountUpdateRecovery) endpoint to
530
- /// complete the process. The verification link sent to the user's email
531
- /// address is valid for 1 hour.
529
+ /// /account/recovery](https://appwrite.io/ docs/references/cloud/ client-web /account#updateRecovery)
530
+ /// endpoint to complete the process. The verification link sent to the user's
531
+ /// email address is valid for 1 hour.
532
532
///
533
533
/// @param String email
534
534
/// @param String url
@@ -564,12 +564,13 @@ open class Account: Service {
564
564
}
565
565
566
566
///
567
- /// Create Password Recovery (confirmation)
567
+ /// Create password recovery (confirmation)
568
568
///
569
569
/// Use this endpoint to complete the user account password reset. Both the
570
570
/// **userId** and **secret** arguments will be passed as query parameters to
571
571
/// the redirect URL you have provided when sending your request to the [POST
572
- /// /account/recovery](/docs/client/account#accountCreateRecovery) endpoint.
572
+ /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery)
573
+ /// endpoint.
573
574
///
574
575
/// Please note that in order to avoid a [Redirect
575
576
/// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
@@ -616,7 +617,7 @@ open class Account: Service {
616
617
}
617
618
618
619
///
619
- /// List Sessions
620
+ /// List sessions
620
621
///
621
622
/// Get the list of active sessions across different devices for the currently
622
623
/// logged in user.
@@ -648,7 +649,7 @@ open class Account: Service {
648
649
}
649
650
650
651
///
651
- /// Delete Sessions
652
+ /// Delete sessions
652
653
///
653
654
/// Delete all sessions from the user account and remove any sessions cookies
654
655
/// from the end client.
@@ -674,7 +675,7 @@ open class Account: Service {
674
675
}
675
676
676
677
///
677
- /// Get Session
678
+ /// Get session
678
679
///
679
680
/// Use this endpoint to get a logged in user's session using a Session ID.
680
681
/// Inputting 'current' will return the current session being used.
@@ -709,7 +710,7 @@ open class Account: Service {
709
710
}
710
711
711
712
///
712
- /// Update OAuth Session (Refresh Tokens )
713
+ /// Update OAuth session (refresh tokens )
713
714
///
714
715
/// Access tokens have limited lifespan and expire to mitigate security risks.
715
716
/// If session was created using an OAuth provider, this route can be used to
@@ -745,12 +746,13 @@ open class Account: Service {
745
746
}
746
747
747
748
///
748
- /// Delete Session
749
+ /// Delete session
749
750
///
750
751
/// Logout the user. Use 'current' as the session ID to logout on this device,
751
752
/// use a session ID to logout on another device. If you're looking to logout
752
753
/// the user on all devices, use [Delete
753
- /// Sessions](/docs/client/account#accountDeleteSessions) instead.
754
+ /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions)
755
+ /// instead.
754
756
///
755
757
/// @param String sessionId
756
758
/// @throws Exception
@@ -776,7 +778,7 @@ open class Account: Service {
776
778
}
777
779
778
780
///
779
- /// Update Status
781
+ /// Update status
780
782
///
781
783
/// Block the currently logged in user account. Behind the scene, the user
782
784
/// record is not deleted but permanently blocked from any access. To
@@ -810,7 +812,7 @@ open class Account: Service {
810
812
}
811
813
812
814
///
813
- /// Update Status
815
+ /// Update status
814
816
///
815
817
/// Block the currently logged in user account. Behind the scene, the user
816
818
/// record is not deleted but permanently blocked from any access. To
@@ -827,7 +829,7 @@ open class Account: Service {
827
829
}
828
830
829
831
///
830
- /// Create Email Verification
832
+ /// Create email verification
831
833
///
832
834
/// Use this endpoint to send a verification message to your user email address
833
835
/// to confirm they are the valid owners of that address. Both the **userId**
@@ -836,8 +838,8 @@ open class Account: Service {
836
838
/// should redirect the user back to your app and allow you to complete the
837
839
/// verification process by verifying both the **userId** and **secret**
838
840
/// parameters. Learn more about how to [complete the verification
839
- /// process](/ docs/client/account#accountUpdateEmailVerification). The
840
- /// verification link sent to the user's email address is valid for 7 days.
841
+ /// process](https://appwrite.io/ docs/references/cloud/ client-web /account#updateVerification).
842
+ /// The verification link sent to the user's email address is valid for 7 days.
841
843
///
842
844
/// Please note that in order to avoid a [Redirect
843
845
/// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
@@ -876,7 +878,7 @@ open class Account: Service {
876
878
}
877
879
878
880
///
879
- /// Create Email Verification (confirmation)
881
+ /// Create email verification (confirmation)
880
882
///
881
883
/// Use this endpoint to complete the user email verification process. Use both
882
884
/// the **userId** and **secret** parameters that were attached to your app URL
@@ -917,14 +919,16 @@ open class Account: Service {
917
919
}
918
920
919
921
///
920
- /// Create Phone Verification
922
+ /// Create phone verification
921
923
///
922
924
/// Use this endpoint to send a verification SMS to the currently logged in
923
925
/// user. This endpoint is meant for use after updating a user's phone number
924
- /// using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone)
926
+ /// using the
927
+ /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone)
925
928
/// endpoint. Learn more about how to [complete the verification
926
- /// process](/docs/client/account#accountUpdatePhoneVerification). The
927
- /// verification code sent to the user's phone number is valid for 15 minutes.
929
+ /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification).
930
+ /// The verification code sent to the user's phone number is valid for 15
931
+ /// minutes.
928
932
///
929
933
/// @throws Exception
930
934
/// @return array
@@ -953,7 +957,7 @@ open class Account: Service {
953
957
}
954
958
955
959
///
956
- /// Create Phone Verification (confirmation)
960
+ /// Create phone verification (confirmation)
957
961
///
958
962
/// Use this endpoint to complete the user phone verification process. Use the
959
963
/// **userId** and **secret** that were sent to your user's phone number to
0 commit comments