appwrite 28.3.1 → 28.4.0

data/lib/appwrite/services/account.rb

@@ -1260,15 +1260,122 @@ module Appwrite
             )
         end
 
+        # Use this endpoint to send a 6-digit password recovery code to the user's
+        # email address. Unlike
+        # [createRecovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery),
+        # this method requires no redirect URL, which makes it suitable for mobile
+        # and desktop apps that cannot host a recovery page. Learn more about how to
+        # [complete the recovery
+        # process](https://appwrite.io/docs/references/cloud/client-web/account#updateRecoveryOTP).
+        # The code sent to the user's email address is valid for 15 minutes.
+        #
+        # Enable the **phrase** parameter to include a randomly generated security
+        # phrase in both the email and the response. Showing that phrase in your app
+        # lets the user confirm the email genuinely came from your request, which
+        # helps protect against phishing.
+        #
+        #
+        # @param [String] email User email.
+        # @param [] phrase Toggle for security phrase. If enabled, email will be sent 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.
+        #
+        # @return [Token]
+        def create_recovery_otp(
+            email:,
+            phrase: nil
+        )
+            if email.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "email"')
+            end
+
+            api_path = '/account/recovery/otp'
+
+            api_params = {
+                email: email,
+                phrase: phrase,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Token
+            )
+        end
+
+        # Use this endpoint to complete the user password recovery process using the
+        # 6-digit code that was emailed by
+        # [createRecoveryOTP](https://appwrite.io/docs/references/cloud/client-web/account#createRecoveryOTP).
+        # Pass the **userId** of the user along with the **secret** code from the
+        # email and the new **password** to set. If confirmed, this route will return
+        # a 200 status code, the code is consumed and the user's password is updated.
+        #
+        #
+        # @param [String] user_id User ID.
+        # @param [String] secret Valid recovery OTP code.
+        # @param [String] password New user password. Must be between 8 and 256 chars.
+        #
+        # @return [Token]
+        def update_recovery_otp(
+            user_id:,
+            secret:,
+            password:
+        )
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if secret.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "secret"')
+            end
+
+            if password.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "password"')
+            end
+
+            api_path = '/account/recovery/otp'
+
+            api_params = {
+                userId: user_id,
+                secret: secret,
+                password: password,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Token
+            )
+        end
+
         # Get the list of active sessions across different devices for the currently
         # logged in user.
         #
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [SessionList]
-        def list_sessions()
+        def list_sessions(
+            total: nil
+        )
             api_path = '/account/sessions'
 
-            api_params = {}
+            api_params = {
+                total: total,
+            }
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
@@ -1287,12 +1394,17 @@ module Appwrite
         # Delete all sessions from the user account and remove any sessions cookies
         # from the end client.
         #
+        # @param [] current Delete the current session too. Use false to sign out of every other session while staying signed in on this one.
         #
         # @return []
-        def delete_sessions()
+        def delete_sessions(
+            current: nil
+        )
             api_path = '/account/sessions'
 
-            api_params = {}
+            api_params = {
+                current: current,
+            }
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
@@ -1346,11 +1458,13 @@ module Appwrite
         #
         # @param [String] email User email.
         # @param [String] password User password. Must be at least 8 chars.
+        # @param [Integer] duration Session length in seconds. Minimum is 60 seconds, and it cannot exceed the project maximum session length. Defaults to the project maximum session length.
         #
         # @return [Session]
         def create_email_password_session(
             email:,
-            password:
+            password:,
+            duration: nil
         )
             api_path = '/account/sessions/email'
 
@@ -1365,6 +1479,100 @@ module Appwrite
             api_params = {
                 email: email,
                 password: password,
+                duration: duration,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Session
+            )
+        end
+
+        # Allow the user to login to their account using an OpenID Connect ID token
+        # obtained natively from the OAuth2 provider, for example via Google
+        # Credential Manager on Android or Sign in with Apple on iOS. No browser or
+        # redirect is involved: the ID token is verified against the provider's
+        # published signing keys and a session is created in a single request.
+        #
+        # Native sign-in is switched on per provider with its nativeEnabled setting.
+        # It is independent of the browser-based flow's enabled setting, which has no
+        # effect on this endpoint. The token's audience must match the provider's
+        # configured client ID or one of its native client IDs; tokens issued for any
+        # other client ID are rejected. For Sign in with Apple, register your app's
+        # bundle ID as a native client ID. For Google, the web client ID used by
+        # Credential Manager is usually the configured client ID; add your Android
+        # and iOS client IDs as native client IDs if your app requests tokens for
+        # them.
+        #
+        # Pass the raw nonce used when requesting the ID token so it can be validated
+        # against the token's nonce claim. When signing in with Apple, the nonce is
+        # required: hash it with SHA-256 before passing it to the Apple SDK, and send
+        # the raw value here - Apple tokens requested without a nonce are rejected.
+        # For Google the nonce is optional: it is validated whenever the token
+        # carries one, and ignored when the provider issued the token without one.
+        # Apple only returns the user's name on the first authorization, and never
+        # inside the ID token - capture it on the client and pass it via the name
+        # parameter.
+        #
+        # If there is already an active session, the new session will be attached to
+        # the logged-in account. If there are no active sessions, the server will
+        # attempt to look for a user with the same email address as the verified
+        # email received from the provider and attach the new session to the existing
+        # user. If no matching user is found - the server will create a new user.
+        #
+        # This flow does not return provider refresh tokens. You may pass an access
+        # token the provider handed your client, along with its lifetime, to store it
+        # on the session - but Appwrite cannot renew it once it expires. If your app
+        # needs long-lived access to provider APIs, use the browser-based OAuth2 flow
+        # instead.
+        #
+        # 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 [IdTokenProvider] provider OAuth2 provider that issued the ID token. Currently, supported providers are: apple, google.
+        # @param [String] id_token OpenID Connect ID token (JWT) obtained natively from the provider, for example via Google Credential Manager or Sign in with Apple.
+        # @param [String] nonce Raw nonce used when requesting the ID token. Required for Apple, and whenever the token carries a nonce claim, which must match it. Ignored when the provider issued the token without a nonce.
+        # @param [String] access_token Provider access token to store alongside the session for calling provider APIs. Never used for authentication.
+        # @param [Integer] access_token_expiry Seconds until the provider access token expires, as reported by the provider. Stored so clients can tell when the stored token goes stale.
+        # @param [String] name User name. Only used when creating a new user and the ID token has no name claim, such as on the first Sign in with Apple authorization.
+        #
+        # @return [Session]
+        def create_id_token_session(
+            provider:,
+            id_token:,
+            nonce: nil,
+            access_token: nil,
+            access_token_expiry: nil,
+            name: nil
+        )
+            if provider.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "provider"')
+            end
+
+            if id_token.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "idToken"')
+            end
+
+            api_path = '/account/sessions/id-token'
+
+            api_params = {
+                provider: provider,
+                idToken: id_token,
+                nonce: nonce,
+                accessToken: access_token,
+                accessTokenExpiry: access_token_expiry,
+                name: name,
             }
 
             api_headers = {
@@ -2125,6 +2333,94 @@ module Appwrite
             )
         end
 
+        # Use this endpoint to send a 6-digit verification code to the currently
+        # logged in user's email address. Unlike
+        # [createEmailVerification](https://appwrite.io/docs/references/cloud/client-web/account#createEmailVerification),
+        # this method requires no redirect URL, which makes it suitable for mobile
+        # and desktop apps that cannot host a verification page. Learn more about how
+        # to [complete the verification
+        # process](https://appwrite.io/docs/references/cloud/client-web/account#updateEmailVerificationOTP).
+        # The code sent to the user's email address is valid for 15 minutes.
+        #
+        # Enable the **phrase** parameter to include a randomly generated security
+        # phrase in both the email and the response. Showing that phrase in your app
+        # lets the user confirm the email genuinely came from your request, which
+        # helps protect against phishing.
+        #
+        #
+        # @param [] phrase Toggle for security phrase. If enabled, email will be sent 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.
+        #
+        # @return [Token]
+        def create_email_verification_otp(
+            phrase: nil
+        )
+            api_path = '/account/verifications/email/otp'
+
+            api_params = {
+                phrase: phrase,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Token
+            )
+        end
+
+        # Use this endpoint to complete the user email verification process using the
+        # 6-digit code that was emailed by
+        # [createEmailVerificationOTP](https://appwrite.io/docs/references/cloud/client-web/account#createEmailVerificationOTP).
+        # Pass the **userId** of the user being verified along with the **secret**
+        # code from the email. If confirmed, this route will return a 200 status code
+        # and the code is consumed.
+        #
+        #
+        # @param [String] user_id User ID.
+        # @param [String] secret Valid verification OTP code.
+        #
+        # @return [Token]
+        def update_email_verification_otp(
+            user_id:,
+            secret:
+        )
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if secret.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "secret"')
+            end
+
+            api_path = '/account/verifications/email/otp'
+
+            api_params = {
+                userId: user_id,
+                secret: secret,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Token
+            )
+        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

data/lib/appwrite/services/avatars.rb

@@ -346,6 +346,77 @@ module Appwrite
             )
         end
 
+        # Update the profile photo of the currently authenticated user. The uploaded
+        # image takes priority over every other photo source, including OAuth2
+        # identity photos, Gravatar, and Libravatar. Updating an already customized
+        # photo replaces it. The image must be at most 5MB and is sent in a single
+        # request.
+        #
+        # @param [file] file Binary image file of at most 5MB. Allowed file types are png, jpg, jpeg, and webp.
+        #
+        # @return [Account]
+        def update_photo(
+            file:,
+            on_progress: nil
+        )
+            if file.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "file"')
+            end
+
+            api_path = '/avatars/photo'
+
+            api_params = {
+                file: file,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'multipart/form-data',
+                "accept": 'application/json',
+            }
+
+            id_param_name = nil
+            param_name = 'file'
+
+            @client.chunked_upload(
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                param_name: param_name,
+                id_param_name: id_param_name,
+                on_progress: on_progress,
+                method: 'PUT',
+                response_type: Models::Account
+            )
+        end
+
+        # Delete the profile photo of the currently authenticated user and store the
+        # built-in static placeholder in its place. The placeholder is the user's
+        # photo from then on, so it takes priority over every other photo source —
+        # OAuth2 identity photos, Gravatar, Libravatar, and initials — until a new
+        # photo is uploaded with avatars.updatePhoto.
+        #
+        #
+        # @return []
+        def delete_photo()
+            api_path = '/avatars/photo'
+
+            api_params = {}
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        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.
         #

data/lib/appwrite/services/databases.rb

@@ -97,15 +97,18 @@ module Appwrite
         # List transactions across all databases.
         #
         # @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).
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [TransactionList]
         def list_transactions(
-            queries: nil
+            queries: nil,
+            total: nil
         )
             api_path = '/databases/transactions'
 
             api_params = {
                 queries: queries,
+                total: total,
             }
 
             api_headers = {

data/lib/appwrite/services/documents_db.rb

@@ -119,15 +119,18 @@ module Appwrite
         # List transactions across all databases.
         #
         # @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).
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [TransactionList]
         def list_transactions(
-            queries: nil
+            queries: nil,
+            total: nil
         )
             api_path = '/documentsdb/transactions'
 
             api_params = {
                 queries: queries,
+                total: total,
             }
 
             api_headers = {