appwrite 8.0.0 → 9.0.1

data/lib/appwrite/services/users.rb

@@ -15,22 +15,22 @@ module Appwrite
         #
         # @return [UserList]
         def list(queries: nil, search: nil)
-            path = '/users'
+            api_path = '/users'
 
-            params = {
+            api_params = {
                 queries: queries,
                 search: search,
             }
             
-            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::UserList
             )
         end
@@ -46,13 +46,13 @@ module Appwrite
         #
         # @return [User]
         def create(user_id:, email: nil, phone: nil, password: nil, name: nil)
-            path = '/users'
+            api_path = '/users'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 phone: phone,
@@ -60,15 +60,15 @@ module Appwrite
                 name: name,
             }
             
-            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::User
             )
         end
@@ -86,7 +86,7 @@ module Appwrite
         #
         # @return [User]
         def create_argon2_user(user_id:, email:, password:, name: nil)
-            path = '/users/argon2'
+            api_path = '/users/argon2'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -100,22 +100,22 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
                 name: name,
             }
             
-            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::User
             )
         end
@@ -133,7 +133,7 @@ module Appwrite
         #
         # @return [User]
         def create_bcrypt_user(user_id:, email:, password:, name: nil)
-            path = '/users/bcrypt'
+            api_path = '/users/bcrypt'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -147,27 +147,84 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
                 name: name,
             }
             
-            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::User
             )
         end
 
         
+        # Get identities for all users.
+        #
+        # @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
+        # @param [String] search Search term to filter your list results. Max length: 256 chars.
+        #
+        # @return [IdentityList]
+        def list_identities(queries: nil, search: nil)
+            api_path = '/users/identities'
+
+            api_params = {
+                queries: queries,
+                search: search,
+            }
+            
+            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 = '/users/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
+
+        
         # Create a new user. Password provided must be hashed with the
         # [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST
         # /users](/docs/server/users#usersCreate) endpoint to create users with a
@@ -180,7 +237,7 @@ module Appwrite
         #
         # @return [User]
         def create_md5_user(user_id:, email:, password:, name: nil)
-            path = '/users/md5'
+            api_path = '/users/md5'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -194,22 +251,22 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
                 name: name,
             }
             
-            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::User
             )
         end
@@ -227,7 +284,7 @@ module Appwrite
         #
         # @return [User]
         def create_ph_pass_user(user_id:, email:, password:, name: nil)
-            path = '/users/phpass'
+            api_path = '/users/phpass'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -241,22 +298,22 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
                 name: name,
             }
             
-            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::User
             )
         end
@@ -279,7 +336,7 @@ module Appwrite
         #
         # @return [User]
         def create_scrypt_user(user_id:, email:, password:, password_salt:, password_cpu:, password_memory:, password_parallel:, password_length:, name: nil)
-            path = '/users/scrypt'
+            api_path = '/users/scrypt'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -313,7 +370,7 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "passwordLength"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
@@ -325,15 +382,15 @@ module Appwrite
                 name: name,
             }
             
-            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::User
             )
         end
@@ -354,7 +411,7 @@ module Appwrite
         #
         # @return [User]
         def create_scrypt_modified_user(user_id:, email:, password:, password_salt:, password_salt_separator:, password_signer_key:, name: nil)
-            path = '/users/scrypt-modified'
+            api_path = '/users/scrypt-modified'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -380,7 +437,7 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "passwordSignerKey"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
@@ -390,15 +447,15 @@ module Appwrite
                 name: name,
             }
             
-            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::User
             )
         end
@@ -417,7 +474,7 @@ module Appwrite
         #
         # @return [User]
         def create_sha_user(user_id:, email:, password:, password_version: nil, name: nil)
-            path = '/users/sha'
+            api_path = '/users/sha'
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -431,7 +488,7 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 userId: user_id,
                 email: email,
                 password: password,
@@ -439,15 +496,15 @@ module Appwrite
                 name: name,
             }
             
-            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::User
             )
         end
@@ -459,25 +516,25 @@ module Appwrite
         #
         # @return [User]
         def get(user_id:)
-            path = '/users/{userId}'
+            api_path = '/users/{userId}'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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::User
             )
         end
@@ -493,25 +550,25 @@ module Appwrite
         #
         # @return []
         def delete(user_id:)
-            path = '/users/{userId}'
+            api_path = '/users/{userId}'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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
 
@@ -523,7 +580,7 @@ module Appwrite
         #
         # @return [User]
         def update_email(user_id:, email:)
-            path = '/users/{userId}/email'
+            api_path = '/users/{userId}/email'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -534,19 +591,60 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
 
-            params = {
+            api_params = {
                 email: email,
             }
             
-            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
+
+        
+        # Update the user labels by its unique ID. 
+        # 
+        # Labels can be used to grant access to resources. While teams are a way for
+        # user's to share access to a resource, labels can be defined by the
+        # developer to grant access without an invitation. See the [Permissions
+        # docs](/docs/permissions) for more info.
+        #
+        # @param [String] user_id User ID.
+        # @param [Array] labels Array of user labels. Replaces the previous labels. Maximum of 5 labels are allowed, each up to 36 alphanumeric characters long.
+        #
+        # @return [User]
+        def update_labels(user_id:, labels:)
+            api_path = '/users/{userId}/labels'
+                .gsub('{userId}', user_id)
+
+            if user_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if labels.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "labels"')
+            end
+
+            api_params = {
+                labels: labels,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
                 response_type: Models::User
             )
         end
@@ -559,26 +657,26 @@ module Appwrite
         #
         # @return [LogList]
         def list_logs(user_id:, queries: nil)
-            path = '/users/{userId}/logs'
+            api_path = '/users/{userId}/logs'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
 
-            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
@@ -590,25 +688,25 @@ module Appwrite
         #
         # @return [MembershipList]
         def list_memberships(user_id:)
-            path = '/users/{userId}/memberships'
+            api_path = '/users/{userId}/memberships'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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::MembershipList
             )
         end
@@ -621,7 +719,7 @@ module Appwrite
         #
         # @return [User]
         def update_name(user_id:, name:)
-            path = '/users/{userId}/name'
+            api_path = '/users/{userId}/name'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -632,19 +730,19 @@ module Appwrite
               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
@@ -657,7 +755,7 @@ module Appwrite
         #
         # @return [User]
         def update_password(user_id:, password:)
-            path = '/users/{userId}/password'
+            api_path = '/users/{userId}/password'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -668,19 +766,19 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "password"')
             end
 
-            params = {
+            api_params = {
                 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
@@ -693,7 +791,7 @@ module Appwrite
         #
         # @return [User]
         def update_phone(user_id:, number:)
-            path = '/users/{userId}/phone'
+            api_path = '/users/{userId}/phone'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -704,19 +802,19 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "number"')
             end
 
-            params = {
+            api_params = {
                 number: number,
             }
             
-            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
@@ -728,25 +826,25 @@ module Appwrite
         #
         # @return [Preferences]
         def get_prefs(user_id:)
-            path = '/users/{userId}/prefs'
+            api_path = '/users/{userId}/prefs'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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::Preferences
             )
         end
@@ -761,7 +859,7 @@ module Appwrite
         #
         # @return [Preferences]
         def update_prefs(user_id:, prefs:)
-            path = '/users/{userId}/prefs'
+            api_path = '/users/{userId}/prefs'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -772,19 +870,19 @@ module Appwrite
               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::Preferences
             )
         end
@@ -796,25 +894,25 @@ module Appwrite
         #
         # @return [SessionList]
         def list_sessions(user_id:)
-            path = '/users/{userId}/sessions'
+            api_path = '/users/{userId}/sessions'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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::SessionList
             )
         end
@@ -826,25 +924,25 @@ module Appwrite
         #
         # @return []
         def delete_sessions(user_id:)
-            path = '/users/{userId}/sessions'
+            api_path = '/users/{userId}/sessions'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "userId"')
             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
 
@@ -856,7 +954,7 @@ module Appwrite
         #
         # @return []
         def delete_session(user_id:, session_id:)
-            path = '/users/{userId}/sessions/{sessionId}'
+            api_path = '/users/{userId}/sessions/{sessionId}'
                 .gsub('{userId}', user_id)
                 .gsub('{sessionId}', session_id)
 
@@ -868,18 +966,18 @@ module Appwrite
               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
 
@@ -892,7 +990,7 @@ module Appwrite
         #
         # @return [User]
         def update_status(user_id:, status:)
-            path = '/users/{userId}/status'
+            api_path = '/users/{userId}/status'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -903,19 +1001,19 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "status"')
             end
 
-            params = {
+            api_params = {
                 status: status,
             }
             
-            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
@@ -928,7 +1026,7 @@ module Appwrite
         #
         # @return [User]
         def update_email_verification(user_id:, email_verification:)
-            path = '/users/{userId}/verification'
+            api_path = '/users/{userId}/verification'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -939,19 +1037,19 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "emailVerification"')
             end
 
-            params = {
+            api_params = {
                 emailVerification: email_verification,
             }
             
-            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
@@ -964,7 +1062,7 @@ module Appwrite
         #
         # @return [User]
         def update_phone_verification(user_id:, phone_verification:)
-            path = '/users/{userId}/verification/phone'
+            api_path = '/users/{userId}/verification/phone'
                 .gsub('{userId}', user_id)
 
             if user_id.nil?
@@ -975,19 +1073,19 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "phoneVerification"')
             end
 
-            params = {
+            api_params = {
                 phoneVerification: phone_verification,
             }
             
-            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