appwrite 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ccc9454e05eee3806e9bcb29e95ef8202b0fc617215e837e52a2cff52199bfd
-  data.tar.gz: 739353c7c628f0711f3c466c3d35f6db829bec9362415a735cf9ac3b72273a41
+  metadata.gz: 0ceedf8f740ccc7f74d65b4ad4d12a7ff85095fcc72da4174faacf9da2279541
+  data.tar.gz: 66a9db695a5704b9679f1652d0855385a2790160bbe3126fa4c6df476ebe095d
 SHA512:
-  metadata.gz: 483f458ce6e1b4abdeaeb96e60fabeb4f778fe775e39a1999abf19725f461a2db190b8b2b31f15d32d838436ac8b0e58bf6f1ce4f183e4a019d4fab75f0e8773
-  data.tar.gz: 91b5993ca7e9186e65150daf278751a510155d2d15a0de54169d9b6efdee376b93a99f512f75a649b32e04a389fe9ca8224e144c6905ccca4b11639930995478
+  metadata.gz: 5872cf6c0b6ae680d62d9dcdea77277650cf7d98622616c8963b2bf5c1bb5420b36459d1453bc41a54fa71414255a52dc437492253d9a5dfeffbd6715a67bbd8
+  data.tar.gz: 35888e3e67a0511778cf2248683a298cd208057990edb6f1b40086ef4cc3efd84f9fa37d20ffc52e68de2fa3a1ed7224946d98ef9297586561e07afe2b24ea05

data/lib/appwrite/client.rb

@@ -12,8 +12,8 @@ module Appwrite
             @chunk_size = 5*1024*1024
             @headers = {
                 'user-agent' => RUBY_PLATFORM + ':ruby-' + RUBY_VERSION,
-                'x-sdk-version' => 'appwrite:ruby:4.1.0',                
-                'X-Appwrite-Response-Format' => '0.13.0'
+                'x-sdk-version' => 'appwrite:ruby:5.0.0',                
+                'X-Appwrite-Response-Format' => '0.14.0'
             }
             @endpoint = 'https://HOSTNAME/v1'
         end

data/lib/appwrite/models/execution.rb

@@ -10,7 +10,7 @@ module Appwrite
             attr_reader :trigger
             attr_reader :status
             attr_reader :status_code
-            attr_reader :stdout
+            attr_reader :response
             attr_reader :stderr
             attr_reader :time
 
@@ -22,7 +22,7 @@ module Appwrite
                 trigger:,
                 status:,
                 status_code:,
-                stdout:,
+                response:,
                 stderr:,
                 time:
             )
@@ -33,7 +33,7 @@ module Appwrite
                 @trigger = trigger
                 @status = status
                 @status_code = status_code
-                @stdout = stdout
+                @response = response
                 @stderr = stderr
                 @time = time
             end
@@ -47,7 +47,7 @@ module Appwrite
                     trigger: map["trigger"],
                     status: map["status"],
                     status_code: map["statusCode"],
-                    stdout: map["stdout"],
+                    response: map["response"],
                     stderr: map["stderr"],
                     time: map["time"]
                 )
@@ -62,7 +62,7 @@ module Appwrite
                     "trigger": @trigger,
                     "status": @status,
                     "statusCode": @status_code,
-                    "stdout": @stdout,
+                    "response": @response,
                     "stderr": @stderr,
                     "time": @time
                 }

data/lib/appwrite/models/membership.rb

@@ -5,9 +5,10 @@ module Appwrite
         class Membership
             attr_reader :id
             attr_reader :user_id
+            attr_reader :user_name
+            attr_reader :user_email
             attr_reader :team_id
-            attr_reader :name
-            attr_reader :email
+            attr_reader :team_name
             attr_reader :invited
             attr_reader :joined
             attr_reader :confirm
@@ -16,9 +17,10 @@ module Appwrite
             def initialize(
                 id:,
                 user_id:,
+                user_name:,
+                user_email:,
                 team_id:,
-                name:,
-                email:,
+                team_name:,
                 invited:,
                 joined:,
                 confirm:,
@@ -26,9 +28,10 @@ module Appwrite
             )
                 @id = id
                 @user_id = user_id
+                @user_name = user_name
+                @user_email = user_email
                 @team_id = team_id
-                @name = name
-                @email = email
+                @team_name = team_name
                 @invited = invited
                 @joined = joined
                 @confirm = confirm
@@ -39,9 +42,10 @@ module Appwrite
                 Membership.new(
                     id: map["$id"],
                     user_id: map["userId"],
+                    user_name: map["userName"],
+                    user_email: map["userEmail"],
                     team_id: map["teamId"],
-                    name: map["name"],
-                    email: map["email"],
+                    team_name: map["teamName"],
                     invited: map["invited"],
                     joined: map["joined"],
                     confirm: map["confirm"],
@@ -53,9 +57,10 @@ module Appwrite
                 {
                     "$id": @id,
                     "userId": @user_id,
+                    "userName": @user_name,
+                    "userEmail": @user_email,
                     "teamId": @team_id,
-                    "name": @name,
-                    "email": @email,
+                    "teamName": @team_name,
                     "invited": @invited,
                     "joined": @joined,
                     "confirm": @confirm,

data/lib/appwrite/services/account.rb

@@ -26,32 +26,6 @@ module Appwrite
             )
         end
 
-        # Delete a currently logged in user account. Behind the scene, the user
-        # record is not deleted but permanently blocked from any access. This is done
-        # to avoid deleted accounts being overtaken by new users with the same email
-        # address. Any user-related resources like documents or storage files should
-        # be deleted separately.
-        #
-        #
-        # @return []
-        def delete()
-            path = '/account'
-
-            params = {
-            }
-
-            headers = {
-                "content-type": 'application/json',
-            }
-
-            @client.call(
-                method: 'DELETE',
-                path: path,
-                headers: headers,
-                params: params,
-            )
-        end
-
         # Update currently logged in user account email address. After changing user
         # address, the user confirmation status will get reset. A new confirmation
         # email is not sent automatically however you can use the send confirmation
@@ -153,7 +127,7 @@ module Appwrite
 
         # Update currently logged in user password. For validation, user is required
         # to pass in the new password, and the old password. For users created with
-        # OAuth and Team Invites, oldPassword is optional.
+        # OAuth, Team Invites and Magic URL, oldPassword is optional.
         #
         # @param [string] password New user password. Must be at least 8 chars.
         # @param [string] old_password Current user password. Must be at least 8 chars.
@@ -412,7 +386,9 @@ module Appwrite
             )
         end
 
-        # 
+        # Access tokens have limited lifespan and expire to mitigate security risks.
+        # If session was created using an OAuth provider, this route can be used to
+        # "refresh" the access token.
         #
         # @param [string] session_id Session ID. Use the string 'current' to update the current device session.
         #
@@ -472,6 +448,31 @@ module Appwrite
             )
         end
 
+        # Block the currently logged in user account. Behind the scene, the user
+        # record is not deleted but permanently blocked from any access. To
+        # completely delete a user, use the Users API instead.
+        #
+        #
+        # @return [User]
+        def update_status()
+            path = '/account/status'
+
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
+        end
+
         # Use this endpoint to send a verification message to your user email address
         # to confirm they are the valid owners of that address. Both the **userId**
         # and **secret** arguments will be passed as query parameters to the URL you

data/lib/appwrite/services/avatars.rb

@@ -4,9 +4,14 @@ module Appwrite
     class Avatars < Service
 
         # You can use this endpoint to show different browser icons to your users.
-        # The code argument receives the browser code as it appears in your user
-        # /account/sessions endpoint. Use width, height and quality arguments to
-        # change the output settings.
+        # The code argument receives the browser code as it appears in your user [GET
+        # /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+        # width, height and quality arguments to change the output settings.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
         #
         # @param [string] code Browser Code.
         # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -43,6 +48,12 @@ module Appwrite
         # The credit card endpoint will return you the icon of the credit card
         # provider you need. Use width, height and quality arguments to change the
         # output settings.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
         # @param [string] code Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
         # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -109,6 +120,12 @@ module Appwrite
         # You can use this endpoint to show different country flags icons to your
         # users. The code argument receives the 2 letter country code. Use width,
         # height and quality arguments to change the output settings.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
         # @param [string] code Country Code. ISO Alpha-2 country code format.
         # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -146,10 +163,16 @@ module Appwrite
         # you want. This endpoint is very useful if you need to crop and display
         # remote images in your app or in case you want to make sure a 3rd party
         # image is properly served using a TLS protocol.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 400x400px.
+        # 
         #
         # @param [string] url Image URL which you want to crop.
-        # @param [number] width Resize preview image width, Pass an integer between 0 to 2000.
-        # @param [number] height Resize preview image height, Pass an integer between 0 to 2000.
+        # @param [number] width Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
+        # @param [number] height Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
         #
         # @return []
         def get_image(url:, width: nil, height: nil)
@@ -187,6 +210,12 @@ module Appwrite
         # default, a random theme will be selected. The random theme will persist for
         # the user's initials when reloading the same theme will always return for
         # the same initials.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
         # @param [string] name Full Name. When empty, current user name or email will be used. Max length: 128 chars.
         # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -220,9 +249,10 @@ module Appwrite
 
         # Converts a given plain text to a QR code image. You can use the query
         # parameters to change the size and style of the resulting image.
+        # 
         #
         # @param [string] text Plain text to be converted to QR code image.
-        # @param [number] size QR code size. Pass an integer between 0 to 1000. Defaults to 400.
+        # @param [number] size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
         # @param [number] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
         # @param [boolean] download Return resulting image with &#039;Content-Disposition: attachment &#039; headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
         #

data/lib/appwrite/services/database.rb

@@ -45,7 +45,7 @@ module Appwrite
         #
         # @param [string] collection_id Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
         # @param [string] name Collection name. Max length: 128 chars.
-        # @param [string] permission Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the `read` and `write` params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
+        # @param [string] permission Specifies the permissions model used in this collection, which accepts either 'collection' or 'document'. For 'collection' level permission, the permissions specified in read and write params are applied to all documents in the collection. For 'document' level permissions, read and write permissions are specified in each document. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
         # @param [array] read An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
         # @param [array] write An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
         #
@@ -325,7 +325,7 @@ module Appwrite
         #
         # @param [string] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).
         # @param [string] key Attribute Key.
-        # @param [array] elements Array of elements in enumerated type. Uses length of longest element to determine size.
+        # @param [array] elements Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 1024 characters long.
         # @param [boolean] required Is attribute required?
         # @param [string] default Default value for attribute when not provided. Cannot be set when attribute is required.
         # @param [boolean] array Is attribute an array?
@@ -692,13 +692,13 @@ module Appwrite
         # modes](/docs/admin).
         #
         # @param [string] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).
-        # @param [array] queries Array of query strings.
+        # @param [array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/database#querying-documents). Maximum of 100 queries are allowed, each 128 characters long.
         # @param [number] limit Maximum number of documents 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 document used as the starting point for the query, excluding the document 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 [array] order_attributes Array of attributes used to sort results.
-        # @param [array] order_types Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order.
+        # @param [array] order_attributes Array of attributes used to sort results. Maximum of 100 order attributes are allowed, each 128 characters long.
+        # @param [array] order_types Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order. Maximum of 100 order types are allowed.
         #
         # @return [DocumentList]
         def list_documents(collection_id:, queries: nil, limit: nil, offset: nil, cursor: nil, cursor_direction: nil, order_attributes: nil, order_types: nil)
@@ -821,7 +821,7 @@ module Appwrite
         #
         # @param [string] collection_id Collection ID.
         # @param [string] document_id Document ID.
-        # @param [object] data Document data as JSON object.
+        # @param [object] data Document data as JSON object. Include only attribute and value pairs to be updated.
         # @param [array] read An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
         # @param [array] write An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
         #
@@ -862,9 +862,7 @@ module Appwrite
             )
         end
 
-        # Delete a document by its unique ID. This endpoint deletes only the parent
-        # documents, its attributes and relations to other documents. Child documents
-        # **will not** be deleted.
+        # Delete a document by its unique ID.
         #
         # @param [string] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).
         # @param [string] document_id Document ID.
@@ -932,8 +930,8 @@ module Appwrite
         # @param [string] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).
         # @param [string] key Index Key.
         # @param [string] type Index type.
-        # @param [array] attributes Array of attributes to index.
-        # @param [array] orders Array of index orders.
+        # @param [array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
+        # @param [array] orders Array of index orders. Maximum of 100 orders are allowed.
         #
         # @return [Index]
         def create_index(collection_id:, key:, type:, attributes:, orders: nil)

data/lib/appwrite/services/functions.rb

@@ -45,10 +45,10 @@ module Appwrite
         #
         # @param [string] function_id Function ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can'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.
         #
@@ -152,9 +152,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.
         #

data/lib/appwrite/services/health.rb

@@ -168,30 +168,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/storage.rb

@@ -48,7 +48,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's enabled
         # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         #
@@ -133,7 +133,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's enabled
         # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         #

data/lib/appwrite/services/teams.rb

@@ -48,7 +48,7 @@ module Appwrite
         #
         # @param [string] team_id Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can'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)
@@ -235,7 +235,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 +322,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'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'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

@@ -111,7 +111,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 +211,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.
@@ -434,7 +467,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`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appwrite
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Appwrite Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types