appwrite 16.1.0 → 18.0.0

data/lib/appwrite/services/account.rb

@@ -29,7 +29,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to allow a new user to register a new account in your
         # project. After the user registration completes successfully, you can use
         # the
@@ -79,7 +78,6 @@ module Appwrite
             )
         end
 
-        
         # Update currently logged in user account email address. After changing user
         # address, the user confirmation status will get reset. A new confirmation
         # email is not sent automatically however you can use the send confirmation
@@ -122,7 +120,6 @@ module Appwrite
             )
         end
 
-        
         # Get the list of identities for the currently logged in user.
         #
         # @param [Array] 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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
@@ -147,7 +144,6 @@ module Appwrite
             )
         end
 
-        
         # Delete an identity by its unique ID.
         #
         # @param [String] identity_id Identity ID.
@@ -176,7 +172,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to create a JSON Web Token. You can use the resulting JWT
         # to authenticate on behalf of the current user when working with the
         # Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
@@ -204,7 +199,6 @@ module Appwrite
             )
         end
 
-        
         # Get the list of latest security activity logs for the currently logged in
         # user. Each log returns user IP address, location and date and time of log.
         #
@@ -230,7 +224,6 @@ module Appwrite
             )
         end
 
-        
         # Enable or disable MFA on an account.
         #
         # @param [] mfa Enable or disable MFA.
@@ -260,7 +253,6 @@ module Appwrite
             )
         end
 
-        
         # Add an authenticator app to be used as an MFA factor. Verify the
         # authenticator using the [verify
         # authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator)
@@ -293,7 +285,6 @@ module Appwrite
             )
         end
 
-        
         # Verify an authenticator app after adding it using the [add
         # authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
         # method.
@@ -331,7 +322,6 @@ module Appwrite
             )
         end
 
-        
         # Delete an authenticator for a user by ID.
         #
         # @param [AuthenticatorType] type Type of authenticator.
@@ -360,7 +350,6 @@ module Appwrite
             )
         end
 
-        
         # Begin the process of MFA verification after sign-in. Finish the flow with
         # [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
         # method.
@@ -392,7 +381,6 @@ module Appwrite
             )
         end
 
-        
         # Complete the MFA challenge by providing the one-time password. Finish the
         # process of MFA verification by providing the one-time password. To begin
         # the flow, use
@@ -432,7 +420,6 @@ module Appwrite
             )
         end
 
-        
         # List the factors available on the account to be used as a MFA challange.
         #
         #
@@ -455,7 +442,6 @@ module Appwrite
             )
         end
 
-        
         # Get recovery codes that can be used as backup for MFA flow. Before getting
         # codes, they must be generated using
         # [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
@@ -481,7 +467,6 @@ module Appwrite
             )
         end
 
-        
         # Generate recovery codes as backup for MFA flow. It's recommended to
         # generate and show then immediately after user successfully adds their
         # authehticator. Recovery codes can be used as a MFA verification type in
@@ -509,7 +494,6 @@ module Appwrite
             )
         end
 
-        
         # Regenerate recovery codes that can be used as backup for MFA flow. Before
         # regenerating codes, they must be first generated using
         # [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
@@ -536,7 +520,6 @@ module Appwrite
             )
         end
 
-        
         # Update currently logged in user account name.
         #
         # @param [String] name User name. Max length: 128 chars.
@@ -566,7 +549,6 @@ module Appwrite
             )
         end
 
-        
         # Update currently logged in user password. For validation, user is required
         # to pass in the new password, and the old password. For users created with
         # OAuth, Team Invites and Magic URL, oldPassword is optional.
@@ -600,7 +582,6 @@ module Appwrite
             )
         end
 
-        
         # Update the currently logged in user's phone number. After updating the
         # phone number, the phone verification status will be reset. A confirmation
         # SMS is not sent automatically, however you can use the [POST
@@ -640,7 +621,6 @@ module Appwrite
             )
         end
 
-        
         # Get the preferences as a key-value object for the currently logged in user.
         #
         #
@@ -663,7 +643,6 @@ module Appwrite
             )
         end
 
-        
         # Update currently logged in user account preferences. The object you pass is
         # stored as is, and replaces any previous value. The maximum allowed prefs
         # size is 64kB and throws error if exceeded.
@@ -695,7 +674,6 @@ module Appwrite
             )
         end
 
-        
         # Sends the user an email with a temporary secret key for password reset.
         # When the user clicks the confirmation link he is redirected back to your
         # app password reset URL with the secret key and email address values
@@ -738,7 +716,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to complete the user account password reset. Both the
         # **userId** and **secret** arguments will be passed as query parameters to
         # the redirect URL you have provided when sending your request to the [POST
@@ -789,7 +766,6 @@ module Appwrite
             )
         end
 
-        
         # Get the list of active sessions across different devices for the currently
         # logged in user.
         #
@@ -813,7 +789,6 @@ module Appwrite
             )
         end
 
-        
         # Delete all sessions from the user account and remove any sessions cookies
         # from the end client.
         #
@@ -837,7 +812,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to allow a new user to register an anonymous account in
         # your project. This route will also create a new session for the user. To
         # allow the new user to convert an anonymous account to a normal account, you
@@ -867,7 +841,6 @@ module Appwrite
             )
         end
 
-        
         # Allow the user to login into their account by providing a valid email and
         # password combination. This route will create a new session for the user.
         # 
@@ -908,7 +881,9 @@ module Appwrite
             )
         end
 
-        
+        #
+        # @deprecated This API has been deprecated since 1.6.0. Please use `Account.createSession` instead.
+        #
         # Use this endpoint to create a session from token. Provide the **userId**
         # and **secret** parameters from the successful response of authentication
         # flows initiated by token creation. For example, magic URL and phone login.
@@ -946,7 +921,9 @@ module Appwrite
             )
         end
 
-        
+        #
+        # @deprecated This API has been deprecated since 1.6.0. Please use `Account.createSession` instead.
+        #
         # Use this endpoint to create a session from token. Provide the **userId**
         # and **secret** parameters from the successful response of authentication
         # flows initiated by token creation. For example, magic URL and phone login.
@@ -984,7 +961,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to create a session from token. Provide the **userId**
         # and **secret** parameters from the successful response of authentication
         # flows initiated by token creation. For example, magic URL and phone login.
@@ -1022,7 +998,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to get a logged in user's session using a Session ID.
         # Inputting 'current' will return the current session being used.
         #
@@ -1052,7 +1027,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to extend a session's length. Extending a session is
         # useful when session expiry is short. If the session was created using an
         # OAuth provider, this endpoint refreshes the access token from the provider.
@@ -1084,7 +1058,6 @@ module Appwrite
             )
         end
 
-        
         # Logout the user. Use 'current' as the session ID to logout on this device,
         # use a session ID to logout on another device. If you're looking to logout
         # the user on all devices, use [Delete
@@ -1117,7 +1090,6 @@ module Appwrite
             )
         end
 
-        
         # Block the currently logged in user account. Behind the scene, the user
         # record is not deleted but permanently blocked from any access. To
         # completely delete a user, use the Users API instead.
@@ -1143,10 +1115,12 @@ module Appwrite
             )
         end
 
-        
         # Sends the user an email with a secret key for creating a session. If the
-        # provided user ID has not be registered, a new user will be created. Use the
-        # returned user ID and secret and submit a request to the [POST
+        # email address has never been used, a **new account is created** using the
+        # provided `userId`. Otherwise, if the email address is already attached to
+        # an account, the **user ID is ignored**. Then, the user will receive an
+        # email with the one-time password. Use the returned user ID and secret and
+        # submit a request to the [POST
         # /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
         # endpoint to complete the login process. The secret sent to the user's email
         # is valid for 15 minutes.
@@ -1154,8 +1128,9 @@ module Appwrite
         # A user is limited to 10 active sessions at a time by default. [Learn more
         # about session
         # limits](https://appwrite.io/docs/authentication-security#limits).
+        # 
         #
-        # @param [String] user_id User 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.
+        # @param [String] user_id User 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.
         # @param [String] email User email.
         # @param [] phrase Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.
         #
@@ -1190,7 +1165,6 @@ module Appwrite
             )
         end
 
-        
         # Sends the user an email with a secret key for creating a session. If the
         # provided user ID has not been registered, a new user will be created. When
         # the user clicks the link in the email, the user is redirected back to the
@@ -1206,7 +1180,7 @@ module Appwrite
         # limits](https://appwrite.io/docs/authentication-security#limits).
         # 
         #
-        # @param [String] user_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+        # @param [String] user_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.
         # @param [String] email User email.
         # @param [String] url URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
         # @param [] phrase Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.
@@ -1243,7 +1217,6 @@ module Appwrite
             )
         end
 
-        
         # Allow the user to login to their account using the OAuth2 provider of their
         # choice. Each OAuth2 provider should be enabled from the Appwrite console
         # first. Use the success and failure arguments to provide a redirect URL's
@@ -1291,7 +1264,6 @@ module Appwrite
             )
         end
 
-        
         # Sends the user an SMS with a secret key for creating a session. If the
         # provided user ID has not be registered, a new user will be created. Use the
         # returned user ID and secret and submit a request to the [POST
@@ -1303,7 +1275,7 @@ module Appwrite
         # about session
         # limits](https://appwrite.io/docs/authentication-security#limits).
         #
-        # @param [String] user_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+        # @param [String] user_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.
         # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
         #
         # @return [Token]
@@ -1336,7 +1308,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to send a verification message to your user email address
         # to confirm they are the valid owners of that address. Both the **userId**
         # and **secret** arguments will be passed as query parameters to the URL you
@@ -1380,7 +1351,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to complete the user email verification process. Use both
         # the **userId** and **secret** parameters that were attached to your app URL
         # to verify the user email ownership. If confirmed this route will return a
@@ -1419,7 +1389,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to send a verification SMS to the currently logged in
         # user. This endpoint is meant for use after updating a user's phone number
         # using the
@@ -1450,7 +1419,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to complete the user phone verification process. Use the
         # **userId** and **secret** that were sent to your user's phone number to
         # verify the user email ownership. If confirmed this route will return a 200
@@ -1489,6 +1457,5 @@ module Appwrite
             )
         end
 
-        
     end 
 end

data/lib/appwrite/services/avatars.rb

@@ -49,7 +49,6 @@ module Appwrite
             )
         end
 
-        
         # The credit card endpoint will return you the icon of the credit card
         # provider you need. Use width, height and quality arguments to change the
         # output settings.
@@ -60,7 +59,7 @@ module Appwrite
         # of image returned is 100x100px.
         # 
         #
-        # @param [CreditCard] code Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
+        # @param [CreditCard] code Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
@@ -91,7 +90,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
         # website URL.
         # 
@@ -122,7 +120,6 @@ module Appwrite
             )
         end
 
-        
         # You can use this endpoint to show different country flags icons to your
         # users. The code argument receives the 2 letter country code. Use width,
         # height and quality arguments to change the output settings. Country codes
@@ -165,7 +162,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to fetch a remote image URL and crop it to any image size
         # you want. This endpoint is very useful if you need to crop and display
         # remote images in your app or in case you want to make sure a 3rd party
@@ -207,7 +203,6 @@ module Appwrite
             )
         end
 
-        
         # Use this endpoint to show your user initials avatar icon on your website or
         # app. By default, this route will try to print your logged-in user name or
         # email initials. You can also overwrite the user name if you pass the 'name'
@@ -252,7 +247,6 @@ module Appwrite
             )
         end
 
-        
         # Converts a given plain text to a QR code image. You can use the query
         # parameters to change the size and style of the resulting image.
         # 
@@ -288,6 +282,5 @@ module Appwrite
             )
         end
 
-        
     end 
 end