appwrite 8.0.0 → 9.0.1

data/lib/appwrite/services/account.rb

@@ -7,25 +7,25 @@ module Appwrite
             @client = client
         end
 
-        # Get currently logged in user data as JSON object.
+        # Get the currently logged in user.
         #
         #
         # @return [User]
         def get()
-            path = '/account'
+            api_path = '/account'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -45,7 +45,7 @@ module Appwrite
         #
         # @return [User]
         def update_email(email:, password:)
-            path = '/account/email'
+            api_path = '/account/email'
 
             if email.nil?
               raise Appwrite::Exception.new('Missing required parameter: "email"')
@@ -55,47 +55,102 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 email: email,
                 password: password,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
 
         
-        # Get currently logged in user list of latest security activity logs. Each
-        # log returns user IP address, location and date and time of log.
+        # Get the list of identities for the currently logged in user.
+        #
+        # @param [String] 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
+        #
+        # @return [IdentityList]
+        def list_identities(queries: nil)
+            api_path = '/account/identities'
+
+            api_params = {
+                queries: queries,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::IdentityList
+            )
+        end
+
+        
+        # Delete an identity by its unique ID.
+        #
+        # @param [String] identity_id Identity ID.
+        #
+        # @return []
+        def delete_identity(identity_id:)
+            api_path = '/account/identities/{identityId}'
+                .gsub('{identityId}', identity_id)
+
+            if identity_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "identityId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        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.
         #
         # @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
         #
         # @return [LogList]
         def list_logs(queries: nil)
-            path = '/account/logs'
+            api_path = '/account/logs'
 
-            params = {
+            api_params = {
                 queries: queries,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::LogList
             )
         end
@@ -107,25 +162,25 @@ module Appwrite
         #
         # @return [User]
         def update_name(name:)
-            path = '/account/name'
+            api_path = '/account/name'
 
             if name.nil?
               raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
-            params = {
+            api_params = {
                 name: name,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -140,26 +195,26 @@ module Appwrite
         #
         # @return [User]
         def update_password(password:, old_password: nil)
-            path = '/account/password'
+            api_path = '/account/password'
 
             if password.nil?
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 password: password,
                 oldPassword: old_password,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -176,7 +231,7 @@ module Appwrite
         #
         # @return [User]
         def update_phone(phone:, password:)
-            path = '/account/phone'
+            api_path = '/account/phone'
 
             if phone.nil?
               raise Appwrite::Exception.new('Missing required parameter: "phone"')
@@ -186,44 +241,44 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 phone: phone,
                 password: password,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
 
         
-        # Get currently logged in user preferences as a key-value object.
+        # Get the preferences as a key-value object for the currently logged in user.
         #
         #
         # @return [Preferences]
         def get_prefs()
-            path = '/account/prefs'
+            api_path = '/account/prefs'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Preferences
             )
         end
@@ -237,25 +292,25 @@ module Appwrite
         #
         # @return [User]
         def update_prefs(prefs:)
-            path = '/account/prefs'
+            api_path = '/account/prefs'
 
             if prefs.nil?
               raise Appwrite::Exception.new('Missing required parameter: "prefs"')
             end
 
-            params = {
+            api_params = {
                 prefs: prefs,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -275,7 +330,7 @@ module Appwrite
         #
         # @return [Token]
         def create_recovery(email:, url:)
-            path = '/account/recovery'
+            api_path = '/account/recovery'
 
             if email.nil?
               raise Appwrite::Exception.new('Missing required parameter: "email"')
@@ -285,20 +340,20 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
-            params = {
+            api_params = {
                 email: email,
                 url: url,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'POST',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end
@@ -321,7 +376,7 @@ module Appwrite
         #
         # @return [Token]
         def update_recovery(user_id:, secret:, password:, password_again:)
-            path = '/account/recovery'
+            api_path = '/account/recovery'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -339,47 +394,47 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "passwordAgain"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 secret: secret,
                 password: password,
                 passwordAgain: password_again,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PUT',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end
 
         
-        # Get currently logged in user list of active sessions across different
-        # devices.
+        # Get the list of active sessions across different devices for the currently
+        # logged in user.
         #
         #
         # @return [SessionList]
         def list_sessions()
-            path = '/account/sessions'
+            api_path = '/account/sessions'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::SessionList
             )
         end
@@ -391,20 +446,20 @@ module Appwrite
         #
         # @return []
         def delete_sessions()
-            path = '/account/sessions'
+            api_path = '/account/sessions'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'DELETE',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
             )
         end
 
@@ -416,25 +471,25 @@ module Appwrite
         #
         # @return [Session]
         def get_session(session_id:)
-            path = '/account/sessions/{sessionId}'
+            api_path = '/account/sessions/{sessionId}'
                 .gsub('{sessionId}', session_id)
 
             if session_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Session
             )
         end
@@ -448,58 +503,58 @@ module Appwrite
         #
         # @return [Session]
         def update_session(session_id:)
-            path = '/account/sessions/{sessionId}'
+            api_path = '/account/sessions/{sessionId}'
                 .gsub('{sessionId}', session_id)
 
             if session_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Session
             )
         end
 
         
-        # Use this endpoint to log out the currently logged in user from all their
-        # account sessions across all of their different devices. When using the
-        # Session ID argument, only the unique session ID provided is deleted.
-        # 
+        # 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
+        # Sessions](/docs/client/account#accountDeleteSessions) instead.
         #
         # @param [String] session_id Session ID. Use the string 'current' to delete the current device session.
         #
         # @return []
         def delete_session(session_id:)
-            path = '/account/sessions/{sessionId}'
+            api_path = '/account/sessions/{sessionId}'
                 .gsub('{sessionId}', session_id)
 
             if session_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
             end
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'DELETE',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
             )
         end
 
@@ -511,20 +566,20 @@ module Appwrite
         #
         # @return [User]
         def update_status()
-            path = '/account/status'
+            api_path = '/account/status'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PATCH',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -550,25 +605,25 @@ module Appwrite
         #
         # @return [Token]
         def create_verification(url:)
-            path = '/account/verification'
+            api_path = '/account/verification'
 
             if url.nil?
               raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
-            params = {
+            api_params = {
                 url: url,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'POST',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end
@@ -584,7 +639,7 @@ module Appwrite
         #
         # @return [Token]
         def update_verification(user_id:, secret:)
-            path = '/account/verification'
+            api_path = '/account/verification'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -594,20 +649,20 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 secret: secret,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PUT',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end
@@ -623,20 +678,20 @@ module Appwrite
         #
         # @return [Token]
         def create_phone_verification()
-            path = '/account/verification/phone'
+            api_path = '/account/verification/phone'
 
-            params = {
+            api_params = {
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'POST',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end
@@ -652,7 +707,7 @@ module Appwrite
         #
         # @return [Token]
         def update_phone_verification(user_id:, secret:)
-            path = '/account/verification/phone'
+            api_path = '/account/verification/phone'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -662,20 +717,20 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "secret"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 secret: secret,
             }
             
-            headers = {
+            api_headers = {
                 "content-type": 'application/json',
             }
 
             @client.call(
                 method: 'PUT',
-                path: path,
-                headers: headers,
-                params: params,
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::Token
             )
         end