appwrite 11.0.0.pre.rc.4 → 11.0.1

data/lib/appwrite/services/account.rb

@@ -234,7 +234,7 @@ module Appwrite
         end
 
         
-        # 
+        # Enable or disable MFA on an account.
         #
         # @param [] mfa Enable or disable MFA.
         #
@@ -264,12 +264,121 @@ 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#verifyAuthenticator)
+        # method.
+        #
+        # @param [AuthenticatorType] type Type of authenticator. Must be `totp`
+        #
+        # @return [MfaType]
+        def create_mfa_authenticator(type:)
+            api_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
+            if type.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "type"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::MfaType
+            )
+        end
+
+        
+        # Verify an authenticator app after adding it using the [add
+        # authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+        # method.
+        #
+        # @param [AuthenticatorType] type Type of authenticator.
+        # @param [String] otp Valid verification token.
+        #
+        # @return [User]
+        def update_mfa_authenticator(type:, otp:)
+            api_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
+            if type.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "type"')
+            end
+
+            if otp.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "otp"')
+            end
+
+            api_params = {
+                otp: otp,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::User
+            )
+        end
+
+        
+        # Delete an authenticator for a user by ID.
         #
-        # @param [AuthenticationFactor] factor Factor used for verification.
+        # @param [AuthenticatorType] type Type of authenticator.
+        # @param [String] otp Valid verification token.
+        #
+        # @return [User]
+        def delete_mfa_authenticator(type:, otp:)
+            api_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
+            if type.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "type"')
+            end
+
+            if otp.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "otp"')
+            end
+
+            api_params = {
+                otp: otp,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::User
+            )
+        end
+
+        
+        # Begin the process of MFA verification after sign-in. Finish the flow with
+        # [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
+        # method.
+        #
+        # @param [AuthenticationFactor] factor Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.
         #
         # @return [MfaChallenge]
-        def create2_fa_challenge(factor:)
+        def create_mfa_challenge(factor:)
             api_path = '/account/mfa/challenge'
 
             if factor.nil?
@@ -294,13 +403,17 @@ 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
+        # [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+        # method.
         #
         # @param [String] challenge_id ID of the challenge.
         # @param [String] otp Valid verification token.
         #
         # @return []
-        def update_challenge(challenge_id:, otp:)
+        def update_mfa_challenge(challenge_id:, otp:)
             api_path = '/account/mfa/challenge'
 
             if challenge_id.nil?
@@ -329,11 +442,11 @@ module Appwrite
         end
 
         
-        # 
+        # List the factors available on the account to be used as a MFA challange.
         #
         #
         # @return [MfaFactors]
-        def list_factors()
+        def list_mfa_factors()
             api_path = '/account/mfa/factors'
 
             api_params = {
@@ -353,18 +466,15 @@ 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)
+        # method. An OTP challenge is required to read recovery codes.
         #
-        # @param [AuthenticatorType] type Type of authenticator.
         #
-        # @return [MfaType]
-        def add_authenticator(type:)
-            api_path = '/account/mfa/{type}'
-                .gsub('{type}', type)
-
-            if type.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "type"')
-            end
+        # @return [MfaRecoveryCodes]
+        def get_mfa_recovery_codes()
+            api_path = '/account/mfa/recovery-codes'
 
             api_params = {
             }
@@ -374,35 +484,27 @@ module Appwrite
             }
 
             @client.call(
-                method: 'POST',
+                method: 'GET',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::MfaType
+                response_type: Models::MfaRecoveryCodes
             )
         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
+        # [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+        # method.
         #
-        # @param [AuthenticatorType] type Type of authenticator.
-        # @param [String] otp Valid verification token.
         #
-        # @return [User]
-        def verify_authenticator(type:, otp:)
-            api_path = '/account/mfa/{type}'
-                .gsub('{type}', type)
-
-            if type.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "type"')
-            end
-
-            if otp.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "otp"')
-            end
+        # @return [MfaRecoveryCodes]
+        def create_mfa_recovery_codes()
+            api_path = '/account/mfa/recovery-codes'
 
             api_params = {
-                otp: otp,
             }
             
             api_headers = {
@@ -410,35 +512,26 @@ module Appwrite
             }
 
             @client.call(
-                method: 'PUT',
+                method: 'POST',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::User
+                response_type: Models::MfaRecoveryCodes
             )
         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)
+        # method. An OTP challenge is required to regenreate recovery codes.
         #
-        # @param [AuthenticatorType] type Type of authenticator.
-        # @param [String] otp Valid verification token.
         #
-        # @return [User]
-        def delete_authenticator(type:, otp:)
-            api_path = '/account/mfa/{type}'
-                .gsub('{type}', type)
-
-            if type.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "type"')
-            end
-
-            if otp.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "otp"')
-            end
+        # @return [MfaRecoveryCodes]
+        def update_mfa_recovery_codes()
+            api_path = '/account/mfa/recovery-codes'
 
             api_params = {
-                otp: otp,
             }
             
             api_headers = {
@@ -446,11 +539,11 @@ module Appwrite
             }
 
             @client.call(
-                method: 'DELETE',
+                method: 'PATCH',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::User
+                response_type: Models::MfaRecoveryCodes
             )
         end
 
@@ -867,43 +960,28 @@ 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
-        # back to your app when login is completed.
-        # 
-        # 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 email
-        # received from the OAuth2 provider and attach the new session to the
-        # existing user. If no matching user is found - the server will create a new
-        # user.
-        # 
-        # 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).
-        # 
+        # 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.
         #
-        # @param [OAuthProvider] provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
-        # @param [String] success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's 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 [String] failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's 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 [] token Include token credentials in the final redirect, useful for server-side integrations, or when cookies are not available.
-        # @param [Array] scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
+        # @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] secret Valid verification token.
         #
-        # @return []
-        def create_o_auth2_session(provider:, success: nil, failure: nil, token: nil, scopes: nil)
-            api_path = '/account/sessions/oauth2/{provider}'
-                .gsub('{provider}', provider)
+        # @return [Session]
+        def update_phone_session(user_id:, secret:)
+            api_path = '/account/sessions/phone'
 
-            if provider.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "provider"')
+            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_params = {
-                success: success,
-                failure: failure,
-                token: token,
-                scopes: scopes,
+                userId: user_id,
+                secret: secret,
             }
             
             api_headers = {
@@ -911,10 +989,11 @@ module Appwrite
             }
 
             @client.call(
-                method: 'GET',
+                method: 'PUT',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
+                response_type: Models::Session
             )
         end
 
@@ -988,8 +1067,9 @@ module Appwrite
         end
 
         
-        # Extend session's expiry to increase it's lifespan. Extending a session is
-        # useful when session length is short such as 5 minutes.
+        # 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.
         #
         # @param [String] session_id Session ID. Use the string 'current' to update the current device session.
         #
@@ -1180,6 +1260,55 @@ 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
+        # back to your app when login is completed. 
+        # 
+        # If authentication succeeds, `userId` and `secret` of a token will be
+        # appended to the success URL as query parameters. These can be used to
+        # create a new session using the [Create
+        # session](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+        # endpoint.
+        # 
+        # 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 [OAuthProvider] provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+        # @param [String] success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's 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 [String] failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's 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 [Array] scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
+        #
+        # @return []
+        def create_o_auth2_token(provider:, success: nil, failure: nil, scopes: nil)
+            api_path = '/account/tokens/oauth2/{provider}'
+                .gsub('{provider}', provider)
+
+            if provider.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "provider"')
+            end
+
+            api_params = {
+                success: success,
+                failure: failure,
+                scopes: scopes,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: "location"
+            )
+        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

data/lib/appwrite/services/databases.rb

@@ -381,7 +381,7 @@ module Appwrite
         end
 
         
-        # 
+        # List attributes in the collection.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -472,7 +472,8 @@ module Appwrite
         end
 
         
-        # 
+        # Update a boolean attribute. Changing the `default` value will not update
+        # already existing documents.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -526,7 +527,7 @@ module Appwrite
         end
 
         
-        # 
+        # Create a date time attribute according to the ISO 8601 standard.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -578,7 +579,8 @@ module Appwrite
         end
 
         
-        # 
+        # Update a date time attribute. Changing the `default` value will not update
+        # already existing documents.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -741,6 +743,8 @@ module Appwrite
         end
 
         
+        # Create an enumeration attribute. The `elements` param acts as a white-list
+        # of accepted values for this attribute. 
         # 
         #
         # @param [String] database_id Database ID.
@@ -1506,7 +1510,7 @@ module Appwrite
         end
 
         
-        # 
+        # Get attribute by ID.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -1547,7 +1551,7 @@ module Appwrite
         end
 
         
-        # 
+        # Deletes an attribute.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -1859,7 +1863,7 @@ module Appwrite
         end
 
         
-        # 
+        # List indexes in the collection.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -1897,7 +1901,9 @@ module Appwrite
         end
 
         
-        # 
+        # Creates an index on the attributes listed. Your index should include all
+        # the attributes you will query in a single request.
+        # Attributes can be `key`, `fulltext`, and `unique`.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -1953,7 +1959,7 @@ module Appwrite
         end
 
         
-        # 
+        # Get index by ID.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
@@ -1995,7 +2001,7 @@ module Appwrite
         end
 
         
-        # 
+        # Delete an index.
         #
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).

data/lib/appwrite/services/health.rb

@@ -323,7 +323,8 @@ module Appwrite
         end
 
         
-        # 
+        # Get the number of function executions that are waiting to be processed in
+        # the Appwrite internal queue server.
         #
         # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
         #
@@ -457,6 +458,60 @@ module Appwrite
         end
 
         
+        # Get the number of metrics that are waiting to be processed in the Appwrite
+        # internal queue server.
+        #
+        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+        #
+        # @return [HealthQueue]
+        def get_queue_usage(threshold: nil)
+            api_path = '/health/queue/usage'
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
+            )
+        end
+
+        
+        # Get the number of projects containing metrics that are waiting to be
+        # processed in the Appwrite internal queue server.
+        #
+        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+        #
+        # @return [HealthQueue]
+        def get_queue_usage_dump(threshold: nil)
+            api_path = '/health/queue/usage-dump'
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
+            )
+        end
+
+        
         # Get the number of webhooks that are waiting to be processed in the Appwrite
         # internal queue server.
         #
@@ -484,6 +539,30 @@ module Appwrite
         end
 
         
+        # Check the Appwrite storage device is up and connection is successful.
+        #
+        #
+        # @return [HealthStatus]
+        def get_storage()
+            api_path = '/health/storage'
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthStatus
+            )
+        end
+
+        
         # Check the Appwrite local storage device is up and connection is successful.
         #
         #