appwrite 28.4.0 → 30.0.0

data/lib/appwrite/services/account.rb

@@ -49,8 +49,6 @@ module Appwrite
             password:,
             name: nil
         )
-            api_path = '/account'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -63,6 +61,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account'
+
             api_params = {
                 userId: user_id,
                 email: email,
@@ -126,13 +126,13 @@ module Appwrite
         def get_consent(
             consent_id:
         )
-            api_path = '/account/consents/{consentId}'
-                .gsub('{consentId}', consent_id)
-
-            if consent_id.nil?
+            if consent_id.nil? || consent_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "consentId"')
             end
 
+            api_path = '/account/consents/{consentId}'
+                .gsub('{consentId}', consent_id)
+
             api_params = {}
 
             api_headers = {
@@ -159,13 +159,13 @@ module Appwrite
         def delete_consent(
             consent_id:
         )
-            api_path = '/account/consents/{consentId}'
-                .gsub('{consentId}', consent_id)
-
-            if consent_id.nil?
+            if consent_id.nil? || consent_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "consentId"')
             end
 
+            api_path = '/account/consents/{consentId}'
+                .gsub('{consentId}', consent_id)
+
             api_params = {}
 
             api_headers = {
@@ -196,13 +196,13 @@ module Appwrite
             queries: nil,
             total: nil
         )
-            api_path = '/account/consents/{consentId}/tokens'
-                .gsub('{consentId}', consent_id)
-
-            if consent_id.nil?
+            if consent_id.nil? || consent_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "consentId"')
             end
 
+            api_path = '/account/consents/{consentId}/tokens'
+                .gsub('{consentId}', consent_id)
+
             api_params = {
                 queries: queries,
                 total: total,
@@ -233,18 +233,18 @@ module Appwrite
             consent_id:,
             token_id:
         )
-            api_path = '/account/consents/{consentId}/tokens/{tokenId}'
-                .gsub('{consentId}', consent_id)
-                .gsub('{tokenId}', token_id)
-
-            if consent_id.nil?
+            if consent_id.nil? || consent_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "consentId"')
             end
 
-            if token_id.nil?
+            if token_id.nil? || token_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "tokenId"')
             end
 
+            api_path = '/account/consents/{consentId}/tokens/{tokenId}'
+                .gsub('{consentId}', consent_id)
+                .gsub('{tokenId}', token_id)
+
             api_params = {}
 
             api_headers = {
@@ -273,18 +273,18 @@ module Appwrite
             consent_id:,
             token_id:
         )
-            api_path = '/account/consents/{consentId}/tokens/{tokenId}'
-                .gsub('{consentId}', consent_id)
-                .gsub('{tokenId}', token_id)
-
-            if consent_id.nil?
+            if consent_id.nil? || consent_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "consentId"')
             end
 
-            if token_id.nil?
+            if token_id.nil? || token_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "tokenId"')
             end
 
+            api_path = '/account/consents/{consentId}/tokens/{tokenId}'
+                .gsub('{consentId}', consent_id)
+                .gsub('{tokenId}', token_id)
+
             api_params = {}
 
             api_headers = {
@@ -318,8 +318,6 @@ module Appwrite
             email:,
             password:
         )
-            api_path = '/account/email'
-
             if email.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
@@ -328,6 +326,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account/email'
+
             api_params = {
                 email: email,
                 password: password,
@@ -387,18 +387,19 @@ module Appwrite
         def delete_identity(
             identity_id:
         )
-            api_path = '/account/identities/{identityId}'
-                .gsub('{identityId}', identity_id)
-
-            if identity_id.nil?
+            if identity_id.nil? || identity_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "identityId"')
             end
 
+            api_path = '/account/identities/{identityId}'
+                .gsub('{identityId}', identity_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -409,18 +410,17 @@ 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.
+        # Get the team memberships of 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). Only supported methods are limit and offset
+        # @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, teamId, invited, joined, confirm, roles
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
-        # @return [LogList]
-        def list_logs(
+        # @return [MembershipList]
+        def list_memberships(
             queries: nil,
             total: nil
         )
-            api_path = '/account/logs'
+            api_path = '/account/memberships'
 
             api_params = {
                 queries: queries,
@@ -437,7 +437,7 @@ module Appwrite
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::LogList
+                response_type: Models::MembershipList
             )
         end
 
@@ -449,12 +449,12 @@ module Appwrite
         def update_mfa(
             mfa:
         )
-            api_path = '/account/mfa'
-
             if mfa.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "mfa"')
             end
 
+            api_path = '/account/mfa'
+
             api_params = {
                 mfa: mfa,
             }
@@ -485,13 +485,13 @@ module Appwrite
         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_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
             api_params = {}
 
             api_headers = {
@@ -521,9 +521,6 @@ module Appwrite
             type:,
             otp:
         )
-            api_path = '/account/mfa/authenticators/{type}'
-                .gsub('{type}', type)
-
             if type.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "type"')
             end
@@ -532,6 +529,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "otp"')
             end
 
+            api_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
             api_params = {
                 otp: otp,
             }
@@ -559,18 +559,19 @@ module Appwrite
         def delete_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_path = '/account/mfa/authenticators/{type}'
+                .gsub('{type}', type)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -591,12 +592,12 @@ module Appwrite
         def create_mfa_challenge(
             factor:
         )
-            api_path = '/account/mfa/challenges'
-
             if factor.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "factor"')
             end
 
+            api_path = '/account/mfa/challenges'
+
             api_params = {
                 factor: factor,
             }
@@ -630,8 +631,6 @@ module Appwrite
             challenge_id:,
             otp:
         )
-            api_path = '/account/mfa/challenges'
-
             if challenge_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "challengeId"')
             end
@@ -640,6 +639,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "otp"')
             end
 
+            api_path = '/account/mfa/challenges'
+
             api_params = {
                 challengeId: challenge_id,
                 otp: otp,
@@ -772,12 +773,12 @@ module Appwrite
         def update_name(
             name:
         )
-            api_path = '/account/name'
-
             if name.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/account/name'
+
             api_params = {
                 name: name,
             }
@@ -1029,12 +1030,12 @@ module Appwrite
             password:,
             old_password: nil
         )
-            api_path = '/account/password'
-
             if password.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account/password'
+
             api_params = {
                 password: password,
                 oldPassword: old_password,
@@ -1069,8 +1070,6 @@ module Appwrite
             phone:,
             password:
         )
-            api_path = '/account/phone'
-
             if phone.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "phone"')
             end
@@ -1079,6 +1078,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account/phone'
+
             api_params = {
                 phone: phone,
                 password: password,
@@ -1132,12 +1133,12 @@ module Appwrite
         def update_prefs(
             prefs:
         )
-            api_path = '/account/prefs'
-
             if prefs.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "prefs"')
             end
 
+            api_path = '/account/prefs'
+
             api_params = {
                 prefs: prefs,
             }
@@ -1174,8 +1175,6 @@ module Appwrite
             email:,
             url:
         )
-            api_path = '/account/recovery'
-
             if email.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
@@ -1184,6 +1183,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/account/recovery'
+
             api_params = {
                 email: email,
                 url: url,
@@ -1215,6 +1216,15 @@ module Appwrite
         # the only valid redirect URLs are the ones from domains you have set when
         # adding your platforms in the console interface.
         #
+        # The new password must satisfy the project's enabled password policies,
+        # including custom deny lists. Dictionary entries match the entire password
+        # case-sensitively; personal-data terms match substrings case-insensitively.
+        # Personal-data validation runs after token verification against the
+        # recovered user's ID, name, email, and phone, closing the previous recovery
+        # gap for profile-based checks. A rejected password leaves the existing
+        # credentials unchanged and the recovery token usable.
+        #
+        #
         # @param [String] user_id User ID.
         # @param [String] secret Valid reset token.
         # @param [String] password New user password. Must be between 8 and 256 chars.
@@ -1225,8 +1235,6 @@ module Appwrite
             secret:,
             password:
         )
-            api_path = '/account/recovery'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1239,6 +1247,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account/recovery'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -1316,6 +1326,14 @@ module Appwrite
         # 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.
         #
+        # The new password must satisfy the project's enabled password policies,
+        # including custom deny lists. Dictionary entries match the entire password
+        # case-sensitively; personal-data terms match substrings case-insensitively.
+        # Personal-data validation runs after token verification against the
+        # recovered user's ID, name, email, and phone, closing the previous recovery
+        # gap for profile-based checks. A rejected password leaves the existing
+        # credentials unchanged and the recovery token usable.
+        #
         #
         # @param [String] user_id User ID.
         # @param [String] secret Valid recovery OTP code.
@@ -1392,7 +1410,8 @@ module Appwrite
         end
 
         # Delete all sessions from the user account and remove any sessions cookies
-        # from the end client.
+        # from the end client. Pass `current` as false to keep the session making the
+        # request and sign out of every other session.
         #
         # @param [] current Delete the current session too. Use false to sign out of every other session while staying signed in on this one.
         #
@@ -1409,6 +1428,7 @@ module Appwrite
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -1451,6 +1471,9 @@ module Appwrite
 
         # 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.
+        # Use the optional `duration` parameter to create a shorter session, for
+        # example when the user doesn't choose "remember me". It must be at least 60
+        # seconds and cannot exceed the project maximum session length.
         #
         # A user is limited to 10 active sessions at a time by default. [Learn more
         # about session
@@ -1466,8 +1489,6 @@ module Appwrite
             password:,
             duration: nil
         )
-            api_path = '/account/sessions/email'
-
             if email.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
@@ -1476,6 +1497,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
+            api_path = '/account/sessions/email'
+
             api_params = {
                 email: email,
                 password: password,
@@ -1605,8 +1628,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/sessions/magic-url'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1615,6 +1636,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/sessions/magic-url'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -1650,8 +1673,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/sessions/phone'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1660,6 +1681,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/sessions/phone'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -1692,8 +1715,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/sessions/token'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1702,6 +1723,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/sessions/token'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -1731,13 +1754,13 @@ module Appwrite
         def get_session(
             session_id:
         )
-            api_path = '/account/sessions/{sessionId}'
-                .gsub('{sessionId}', session_id)
-
-            if session_id.nil?
+            if session_id.nil? || session_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
+            api_path = '/account/sessions/{sessionId}'
+                .gsub('{sessionId}', session_id)
+
             api_params = {}
 
             api_headers = {
@@ -1764,13 +1787,13 @@ module Appwrite
         def update_session(
             session_id:
         )
-            api_path = '/account/sessions/{sessionId}'
-                .gsub('{sessionId}', session_id)
-
-            if session_id.nil?
+            if session_id.nil? || session_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
+            api_path = '/account/sessions/{sessionId}'
+                .gsub('{sessionId}', session_id)
+
             api_params = {}
 
             api_headers = {
@@ -1800,18 +1823,19 @@ module Appwrite
         def delete_session(
             session_id:
         )
-            api_path = '/account/sessions/{sessionId}'
-                .gsub('{sessionId}', session_id)
-
-            if session_id.nil?
+            if session_id.nil? || session_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
+            api_path = '/account/sessions/{sessionId}'
+                .gsub('{sessionId}', session_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -1873,8 +1897,6 @@ module Appwrite
             email:,
             phrase: nil
         )
-            api_path = '/account/tokens/email'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1883,6 +1905,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
 
+            api_path = '/account/tokens/email'
+
             api_params = {
                 userId: user_id,
                 email: email,
@@ -1931,8 +1955,6 @@ module Appwrite
             url: nil,
             phrase: nil
         )
-            api_path = '/account/tokens/magic-url'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -1941,6 +1963,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
 
+            api_path = '/account/tokens/magic-url'
+
             api_params = {
                 userId: user_id,
                 email: email,
@@ -1974,11 +1998,15 @@ module Appwrite
         # session](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
         # endpoint.
         #
+        # If there is already an active session, the OAuth2 identity is attached to
+        # the logged-in account and that session stays active until the token is
+        # exchanged for a new one.
+        #
         # 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, appwrite, auth0, authentik, autodesk, bitbucket, bitly, box, cloudflare, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, huggingface, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, resend, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
+        # @param [OAuthProvider] provider OAuth2 Provider. Currently, supported providers are: amazon, apple, appwrite, auth0, authentik, autodesk, bitbucket, bitly, box, cloudflare, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, huggingface, kakao, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, resend, salesforce, slack, spotify, stripe, tiktok, tradeshift, tradeshiftBox, twitch, webflow, wordpress, x, 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.
@@ -1992,13 +2020,13 @@ module Appwrite
             scopes: nil,
             state: nil
         )
-            api_path = '/account/tokens/oauth2/{provider}'
-                .gsub('{provider}', provider)
-
             if provider.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "provider"')
             end
 
+            api_path = '/account/tokens/oauth2/{provider}'
+                .gsub('{provider}', provider)
+
             api_params = {
                 success: success,
                 failure: failure,
@@ -2117,8 +2145,6 @@ module Appwrite
             user_id:,
             phone:
         )
-            api_path = '/account/tokens/phone'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -2127,6 +2153,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "phone"')
             end
 
+            api_path = '/account/tokens/phone'
+
             api_params = {
                 userId: user_id,
                 phone: phone,
@@ -2169,12 +2197,12 @@ module Appwrite
         def create_email_verification(
             url:
         )
-            api_path = '/account/verifications/email'
-
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/account/verifications/email'
+
             api_params = {
                 url: url,
             }
@@ -2219,12 +2247,12 @@ module Appwrite
         def create_verification(
             url:
         )
-            api_path = '/account/verifications/email'
-
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/account/verifications/email'
+
             api_params = {
                 url: url,
             }
@@ -2257,8 +2285,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/verifications/email'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -2267,6 +2293,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/verifications/email'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -2303,8 +2331,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/verifications/email'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -2313,6 +2339,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/verifications/email'
+
             api_params = {
                 userId: user_id,
                 secret: secret,
@@ -2465,8 +2493,6 @@ module Appwrite
             user_id:,
             secret:
         )
-            api_path = '/account/verifications/phone'
-
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -2475,6 +2501,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
+            api_path = '/account/verifications/phone'
+
             api_params = {
                 userId: user_id,
                 secret: secret,