appwrite 4.0.0 → 6.0.0

data/lib/appwrite/services/functions.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Functions < Service
 
+
         # Get a list of all the project's functions. You can use the query params to
         # filter your results.
         #
@@ -10,7 +11,7 @@ module Appwrite
         # @param [number] limit Maximum number of functions 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)
         # @param [string] cursor ID of the function used as the starting point for the query, excluding the function 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [FunctionList]
@@ -45,10 +46,10 @@ module Appwrite
         #
         # @param [string] function_id Function 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] name Function name. Max length: 128 chars.
-        # @param [array] execute An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
+        # @param [array] execute An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long.
         # @param [string] runtime Execution runtime.
         # @param [object] vars Key-value JSON object that will be passed to the function as environment variables.
-        # @param [array] events Events list.
+        # @param [array] events Events list. Maximum of 100 events are allowed.
         # @param [string] schedule Schedule CRON syntax.
         # @param [number] timeout Function maximum execution time in seconds.
         #
@@ -96,7 +97,7 @@ module Appwrite
             )
         end
 
-        # Get a list of all runtimes that are currently active in your project.
+        # Get a list of all runtimes that are currently active on your instance.
         #
         #
         # @return [RuntimeList]
@@ -152,9 +153,9 @@ module Appwrite
         #
         # @param [string] function_id Function ID.
         # @param [string] name Function name. Max length: 128 chars.
-        # @param [array] execute An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
+        # @param [array] execute An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long.
         # @param [object] vars Key-value JSON object that will be passed to the function as environment variables.
-        # @param [array] events Events list.
+        # @param [array] events Events list. Maximum of 100 events are allowed.
         # @param [string] schedule Schedule CRON syntax.
         # @param [number] timeout Maximum execution time in seconds.
         #
@@ -233,7 +234,7 @@ module Appwrite
         # @param [number] limit Maximum number of deployments 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)
         # @param [string] cursor ID of the deployment used as the starting point for the query, excluding the deployment 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [DeploymentList]
@@ -314,6 +315,7 @@ module Appwrite
                 "content-type": 'multipart/form-data',
             }
 
+            id_param_name = nil
             param_name = 'code'
 
             @client.chunked_upload(
@@ -321,6 +323,7 @@ module Appwrite
                 headers: headers,
                 params: params,
                 param_name: param_name,
+                id_param_name: id_param_name,
                 on_progress: on_progress,
                 response_type: Models::Deployment
             )
@@ -482,7 +485,7 @@ module Appwrite
         # @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)
         # @param [string] search Search term to filter your list results. Max length: 256 chars.
         # @param [string] cursor ID of the execution used as the starting point for the query, excluding the execution 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         #
         # @return [ExecutionList]
         def list_executions(function_id:, limit: nil, offset: nil, search: nil, cursor: nil, cursor_direction: nil)

data/lib/appwrite/services/health.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Health < Service
 
+
         # Check the Appwrite HTTP server is up and responsive.
         #
         #
@@ -168,30 +169,6 @@ module Appwrite
             )
         end
 
-        # Get the number of usage stats that are waiting to be processed in the
-        # Appwrite internal queue server.
-        #
-        #
-        # @return [HealthQueue]
-        def get_queue_usage()
-            path = '/health/queue/usage'
-
-            params = {
-            }
-
-            headers = {
-                "content-type": 'application/json',
-            }
-
-            @client.call(
-                method: 'GET',
-                path: path,
-                headers: headers,
-                params: params,
-                response_type: Models::HealthQueue
-            )
-        end
-
         # Get the number of webhooks that are waiting to be processed in the Appwrite
         # internal queue server.
         #

data/lib/appwrite/services/locale.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Locale < Service
 
+
         # Get the current user location based on IP. Returns an object with user
         # country code, country name, continent name, continent code, ip address and
         # suggested currency. You can use the locale header to get the data in a

data/lib/appwrite/services/storage.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Storage < Service
 
+
         # Get a list of all the storage buckets. You can use the query params to
         # filter your results.
         #
@@ -10,7 +11,7 @@ module Appwrite
         # @param [number] limit Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.
         # @param [number] offset Results offset. The default value is 0. Use this param to manage pagination.
         # @param [string] cursor ID of the bucket used as the starting point for the query, excluding the bucket itself. Should be used for efficient pagination when working with large sets of data.
-        # @param [string] cursor_direction Direction of the cursor.
+        # @param [string] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [BucketList]
@@ -48,7 +49,7 @@ module Appwrite
         # @param [array] write An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
         # @param [boolean] enabled Is bucket enabled?
         # @param [number] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the `_APP_STORAGE_LIMIT` environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
-        # @param [array] allowed_file_extensions Allowed file extensions
+        # @param [array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
         # @param [boolean] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
         # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
         #
@@ -133,7 +134,7 @@ module Appwrite
         # @param [array] write An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
         # @param [boolean] enabled Is bucket enabled?
         # @param [number] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
-        # @param [array] allowed_file_extensions Allowed file extensions
+        # @param [array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
         # @param [boolean] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
         # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
         #
@@ -216,7 +217,7 @@ module Appwrite
         # @param [number] limit Maximum number of files 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 file used as the starting point for the query, excluding the file 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [FileList]
@@ -303,6 +304,7 @@ module Appwrite
                 "content-type": 'multipart/form-data',
             }
 
+            id_param_name = "fileId"
             param_name = 'file'
 
             @client.chunked_upload(
@@ -310,6 +312,7 @@ module Appwrite
                 headers: headers,
                 params: params,
                 param_name: param_name,
+                id_param_name: id_param_name,
                 on_progress: on_progress,
                 response_type: Models::File
             )

data/lib/appwrite/services/teams.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Teams < Service
 
+
         # Get a list of all the teams in which the current user is a member. You can
         # use the parameters to filter your results.
         # 
@@ -13,7 +14,7 @@ module Appwrite
         # @param [number] limit Maximum number of teams 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 team used as the starting point for the query, excluding the team 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [TeamList]
@@ -48,7 +49,7 @@ module Appwrite
         #
         # @param [string] team_id Team 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] name Team name. Max length: 128 chars.
-        # @param [array] roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.
+        # @param [array] roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
         #
         # @return [Team]
         def create(team_id:, name:, roles: nil)
@@ -183,7 +184,7 @@ module Appwrite
         # @param [number] limit Maximum number of memberships 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)
         # @param [string] cursor ID of the membership used as the starting point for the query, excluding the membership 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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [MembershipList]
@@ -235,7 +236,7 @@ module Appwrite
         #
         # @param [string] team_id Team ID.
         # @param [string] email Email of the new team member.
-        # @param [array] roles Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.
+        # @param [array] roles Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
         # @param [string] url URL to redirect the user back to your app from the invitation email.  Only URLs from hostnames in your project 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] name Name of the new team member. Max length: 128 chars.
         #
@@ -322,7 +323,7 @@ module Appwrite
         #
         # @param [string] team_id Team ID.
         # @param [string] membership_id Membership ID.
-        # @param [array] roles An array of strings. Use this param to set the user&#039;s roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Max length for each role is 32 chars.
+        # @param [array] roles An array of strings. Use this param to set the user&#039;s roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
         #
         # @return [Membership]
         def update_membership_roles(team_id:, membership_id:, roles:)

data/lib/appwrite/services/users.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Users < Service
 
+
         # Get a list of all the project's users. You can use the query params to
         # filter your results.
         #
@@ -10,7 +11,7 @@ module Appwrite
         # @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] cursor_direction Direction of the cursor, can be either &#039;before&#039; or &#039;after&#039;.
         # @param [string] order_type Order result by ASC or DESC order.
         #
         # @return [UserList]
@@ -111,7 +112,11 @@ module Appwrite
             )
         end
 
-        # Delete a user by its unique ID.
+        # Delete a user by its unique ID, thereby releasing it's ID. Since ID is
+        # released and can be reused, all user-related resources like documents or
+        # storage files should be deleted before user deletion. If you want to keep
+        # ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus)
+        # endpoint instead.
         #
         # @param [string] user_id User ID.
         #
@@ -207,6 +212,35 @@ module Appwrite
             )
         end
 
+        # Get the user membership list by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        #
+        # @return [MembershipList]
+        def get_memberships(user_id:)
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            path = '/users/{userId}/memberships'
+                .gsub('{userId}', user_id)
+
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::MembershipList
+            )
+        end
+
         # Update the user name by its unique ID.
         #
         # @param [string] user_id User ID.
@@ -277,6 +311,41 @@ module Appwrite
             )
         end
 
+        # Update the user phone by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] number User phone number.
+        #
+        # @return [User]
+        def update_phone(user_id:, number:)
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if number.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "number"')
+            end
+
+            path = '/users/{userId}/phone'
+                .gsub('{userId}', user_id)
+
+            params = {
+                number: number,
+            }
+
+            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.
@@ -434,7 +503,8 @@ module Appwrite
             )
         end
 
-        # Update the user status by its unique ID.
+        # Update the user status by its unique ID. Use this endpoint as an
+        # alternative to deleting a user if you want to keep user's ID reserved.
         #
         # @param [string] user_id User ID.
         # @param [boolean] status User Status. To activate the user pass `true` and to block the user pass `false`.
@@ -475,7 +545,7 @@ module Appwrite
         # @param [boolean] email_verification User email verification status.
         #
         # @return [User]
-        def update_verification(user_id:, email_verification:)
+        def update_email_verification(user_id:, email_verification:)
             if user_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "userId"')
             end
@@ -504,5 +574,40 @@ module Appwrite
             )
         end
 
+        # Update the user phone verification status by its unique ID.
+        #
+        # @param [string] user_id User ID.
+        # @param [boolean] phone_verification User phone verification status.
+        #
+        # @return [User]
+        def update_phone_verification(user_id:, phone_verification:)
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if phone_verification.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "phoneVerification"')
+            end
+
+            path = '/users/{userId}/verification/phone'
+                .gsub('{userId}', user_id)
+
+            params = {
+                phoneVerification: phone_verification,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
+        end
+
     end 
 end

data/lib/appwrite.rb

@@ -6,10 +6,11 @@ require 'mime/types'
 require_relative 'appwrite/client'
 require_relative 'appwrite/service'
 require_relative 'appwrite/exception'
-require_relative 'appwrite/file'
+require_relative 'appwrite/input_file'
 
 require_relative 'appwrite/models/document_list'
 require_relative 'appwrite/models/collection_list'
+require_relative 'appwrite/models/database_list'
 require_relative 'appwrite/models/index_list'
 require_relative 'appwrite/models/user_list'
 require_relative 'appwrite/models/session_list'
@@ -27,6 +28,7 @@ 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/database'
 require_relative 'appwrite/models/collection'
 require_relative 'appwrite/models/attribute_list'
 require_relative 'appwrite/models/attribute_string'
@@ -65,7 +67,7 @@ require_relative 'appwrite/models/health_time'
 
 require_relative 'appwrite/services/account'
 require_relative 'appwrite/services/avatars'
-require_relative 'appwrite/services/database'
+require_relative 'appwrite/services/databases'
 require_relative 'appwrite/services/functions'
 require_relative 'appwrite/services/health'
 require_relative 'appwrite/services/locale'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appwrite
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Appwrite Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -33,7 +33,7 @@ files:
 - lib/appwrite.rb
 - lib/appwrite/client.rb
 - lib/appwrite/exception.rb
-- lib/appwrite/file.rb
+- lib/appwrite/input_file.rb
 - lib/appwrite/models/attribute_boolean.rb
 - lib/appwrite/models/attribute_email.rb
 - lib/appwrite/models/attribute_enum.rb
@@ -53,6 +53,8 @@ files:
 - lib/appwrite/models/country_list.rb
 - lib/appwrite/models/currency.rb
 - lib/appwrite/models/currency_list.rb
+- lib/appwrite/models/database.rb
+- lib/appwrite/models/database_list.rb
 - lib/appwrite/models/deployment.rb
 - lib/appwrite/models/deployment_list.rb
 - lib/appwrite/models/document.rb
@@ -92,7 +94,7 @@ files:
 - lib/appwrite/service.rb
 - lib/appwrite/services/account.rb
 - lib/appwrite/services/avatars.rb
-- lib/appwrite/services/database.rb
+- lib/appwrite/services/databases.rb
 - lib/appwrite/services/functions.rb
 - lib/appwrite/services/health.rb
 - lib/appwrite/services/locale.rb

data/lib/appwrite/file.rb

@@ -1,17 +0,0 @@
-require 'mime/types'
-
-module Appwrite
-    class File
-        attr_reader :path
-        attr_reader :name
-        attr_reader :content
-        attr_reader :mime_type
-
-        def initialize(path, content)
-            @path = path
-            @content = content
-            @name = ::File.basename(path)
-            @mime_type = MIME::Types.type_for(path)
-        end
-    end
-end