appwrite 2.4.1 → 4.1.0

data/lib/appwrite/services/users.rb

@@ -1,33 +1,57 @@
+#frozen_string_literal: true
+
 module Appwrite
     class Users < Service
 
-        def list(search: nil, limit: nil, offset: nil, order_type: nil)
+        # Get a list of all the project's users. You can use the query params to
+        # filter your results.
+        #
+        # @param [string] search Search term to filter your list results. Max length: 256 chars.
+        # @param [number] limit Maximum number of users to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
+        # @param [number] offset Offset value. The default value is 0. Use this param to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)
+        # @param [string] cursor ID of the user used as the starting point for the query, excluding the user itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)
+        # @param [string] cursor_direction Direction of the cursor.
+        # @param [string] order_type Order result by ASC or DESC order.
+        #
+        # @return [UserList]
+        def list(search: nil, limit: nil, offset: nil, cursor: nil, cursor_direction: nil, order_type: nil)
             path = '/users'
 
-            params = {}
-
-            if !search.nil?
-                params[:search] = search
-            end
-
-            if !limit.nil?
-                params[:limit] = limit
-            end
-
-            if !offset.nil?
-                params[:offset] = offset
-            end
+            params = {
+                search: search,
+                limit: limit,
+                offset: offset,
+                cursor: cursor,
+                cursorDirection: cursor_direction,
+                orderType: order_type,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::UserList
+            )
+        end
 
-            if !order_type.nil?
-                params[:orderType] = order_type
+        # Create a new user.
+        #
+        # @param [string] user_id User ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
+        # @param [string] email User email.
+        # @param [string] password User password. Must be at least 8 chars.
+        # @param [string] name User name. Max length: 128 chars.
+        #
+        # @return [User]
+        def create(user_id:, email:, password:, name: nil)
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
-        end
-
-        def create(email:, password:, name: nil)
             if email.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "email"')
             end
@@ -38,25 +62,31 @@ module Appwrite
 
             path = '/users'
 
-            params = {}
-
-            if !email.nil?
-                params[:email] = email
-            end
-
-            if !password.nil?
-                params[:password] = password
-            end
-
-            if !name.nil?
-                params[:name] = name
-            end
-
-            return @client.call('post', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                userId: user_id,
+                email: email,
+                password: password,
+                name: name,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
+        # Get a user by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return [User]
         def get(user_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -65,13 +95,27 @@ module Appwrite
             path = '/users/{userId}'
                 .gsub('{userId}', user_id)
 
-            params = {}
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
+        # Delete a user by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return []
         def delete(user_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -80,13 +124,27 @@ module Appwrite
             path = '/users/{userId}'
                 .gsub('{userId}', user_id)
 
-            params = {}
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('delete', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'DELETE',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Update the user email by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] email User email.
+        #
+        # @return [User]
         def update_email(user_id:, email:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -99,18 +157,31 @@ module Appwrite
             path = '/users/{userId}/email'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !email.nil?
-                params[:email] = email
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                email: email,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
-        def get_logs(user_id:)
+        # Get the user activity logs list by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [number] limit Maximum number of logs to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
+        # @param [number] offset Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)
+        #
+        # @return [LogList]
+        def get_logs(user_id:, limit: nil, offset: nil)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -118,13 +189,30 @@ module Appwrite
             path = '/users/{userId}/logs'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                limit: limit,
+                offset: offset,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::LogList
+            )
         end
 
+        # Update the user name by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] name User name. Max length: 128 chars.
+        #
+        # @return [User]
         def update_name(user_id:, name:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -137,17 +225,29 @@ module Appwrite
             path = '/users/{userId}/name'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !name.nil?
-                params[:name] = name
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                name: name,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
+        # Update the user password by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] password New user password. Must be at least 8 chars.
+        #
+        # @return [User]
         def update_password(user_id:, password:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -160,17 +260,28 @@ module Appwrite
             path = '/users/{userId}/password'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !password.nil?
-                params[:password] = password
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                password: password,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
+        # Get the user preferences by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return [Preferences]
         def get_prefs(user_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -179,13 +290,30 @@ module Appwrite
             path = '/users/{userId}/prefs'
                 .gsub('{userId}', user_id)
 
-            params = {}
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::Preferences
+            )
         end
 
+        # Update the user preferences by its unique ID. The object you pass is stored
+        # as is, and replaces any previous value. The maximum allowed prefs size is
+        # 64kB and throws error if exceeded.
+        #
+        # @param [string] user_id User ID.
+        # @param [object] prefs Prefs key-value JSON object.
+        #
+        # @return [Preferences]
         def update_prefs(user_id:, prefs:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -198,17 +326,28 @@ module Appwrite
             path = '/users/{userId}/prefs'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !prefs.nil?
-                params[:prefs] = prefs
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                prefs: prefs,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::Preferences
+            )
         end
 
+        # Get the user sessions list by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return [SessionList]
         def get_sessions(user_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -217,13 +356,27 @@ module Appwrite
             path = '/users/{userId}/sessions'
                 .gsub('{userId}', user_id)
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::SessionList
+            )
         end
 
+        # Delete all user's sessions by using the user's unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return []
         def delete_sessions(user_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -232,13 +385,27 @@ module Appwrite
             path = '/users/{userId}/sessions'
                 .gsub('{userId}', user_id)
 
-            params = {}
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('delete', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'DELETE',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Delete a user sessions by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] session_id Session ID.
+        #
+        # @return []
         def delete_session(user_id:, session_id:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -252,13 +419,27 @@ module Appwrite
                 .gsub('{userId}', user_id)
                 .gsub('{sessionId}', session_id)
 
-            params = {}
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('delete', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'DELETE',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Update the user status by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [boolean] status User Status. To activate the user pass `true` and to block the user pass `false`.
+        #
+        # @return [User]
         def update_status(user_id:, status:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -271,17 +452,29 @@ module Appwrite
             path = '/users/{userId}/status'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !status.nil?
-                params[:status] = status
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                status: status,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
+        # Update the user email verification status by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [boolean] email_verification User email verification status.
+        #
+        # @return [User]
         def update_verification(user_id:, email_verification:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
@@ -294,20 +487,22 @@ module Appwrite
             path = '/users/{userId}/verification'
                 .gsub('{userId}', user_id)
 
-            params = {}
-
-            if !email_verification.nil?
-                params[:emailVerification] = email_verification
-            end
-
-            return @client.call('patch', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                emailVerification: email_verification,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
         end
 
-
-        protected
-
-        private
     end 
 end

data/lib/appwrite.rb

@@ -2,10 +2,67 @@ require 'net/http'
 require 'uri'
 require 'json'
 require 'mime/types'
+
 require_relative 'appwrite/client'
 require_relative 'appwrite/service'
 require_relative 'appwrite/exception'
 require_relative 'appwrite/file'
+
+require_relative 'appwrite/models/document_list'
+require_relative 'appwrite/models/collection_list'
+require_relative 'appwrite/models/index_list'
+require_relative 'appwrite/models/user_list'
+require_relative 'appwrite/models/session_list'
+require_relative 'appwrite/models/log_list'
+require_relative 'appwrite/models/file_list'
+require_relative 'appwrite/models/bucket_list'
+require_relative 'appwrite/models/team_list'
+require_relative 'appwrite/models/membership_list'
+require_relative 'appwrite/models/function_list'
+require_relative 'appwrite/models/runtime_list'
+require_relative 'appwrite/models/deployment_list'
+require_relative 'appwrite/models/execution_list'
+require_relative 'appwrite/models/country_list'
+require_relative 'appwrite/models/continent_list'
+require_relative 'appwrite/models/language_list'
+require_relative 'appwrite/models/currency_list'
+require_relative 'appwrite/models/phone_list'
+require_relative 'appwrite/models/collection'
+require_relative 'appwrite/models/attribute_list'
+require_relative 'appwrite/models/attribute_string'
+require_relative 'appwrite/models/attribute_integer'
+require_relative 'appwrite/models/attribute_float'
+require_relative 'appwrite/models/attribute_boolean'
+require_relative 'appwrite/models/attribute_email'
+require_relative 'appwrite/models/attribute_enum'
+require_relative 'appwrite/models/attribute_ip'
+require_relative 'appwrite/models/attribute_url'
+require_relative 'appwrite/models/index'
+require_relative 'appwrite/models/document'
+require_relative 'appwrite/models/log'
+require_relative 'appwrite/models/user'
+require_relative 'appwrite/models/preferences'
+require_relative 'appwrite/models/session'
+require_relative 'appwrite/models/token'
+require_relative 'appwrite/models/locale'
+require_relative 'appwrite/models/file'
+require_relative 'appwrite/models/bucket'
+require_relative 'appwrite/models/team'
+require_relative 'appwrite/models/membership'
+require_relative 'appwrite/models/function'
+require_relative 'appwrite/models/runtime'
+require_relative 'appwrite/models/deployment'
+require_relative 'appwrite/models/execution'
+require_relative 'appwrite/models/country'
+require_relative 'appwrite/models/continent'
+require_relative 'appwrite/models/language'
+require_relative 'appwrite/models/currency'
+require_relative 'appwrite/models/phone'
+require_relative 'appwrite/models/health_antivirus'
+require_relative 'appwrite/models/health_queue'
+require_relative 'appwrite/models/health_status'
+require_relative 'appwrite/models/health_time'
+
 require_relative 'appwrite/services/account'
 require_relative 'appwrite/services/avatars'
 require_relative 'appwrite/services/database'