appwrite 4.0.0 → 6.0.0

data/lib/appwrite/models/membership.rb

@@ -4,10 +4,13 @@ module Appwrite
     module Models
         class Membership
             attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
             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
@@ -15,20 +18,26 @@ module Appwrite
 
             def initialize(
                 id:,
+                created_at:,
+                updated_at:,
                 user_id:,
+                user_name:,
+                user_email:,
                 team_id:,
-                name:,
-                email:,
+                team_name:,
                 invited:,
                 joined:,
                 confirm:,
                 roles:
             )
                 @id = id
+                @created_at = created_at
+                @updated_at = updated_at
                 @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
@@ -38,10 +47,13 @@ module Appwrite
             def self.from(map:)
                 Membership.new(
                     id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
                     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"],
@@ -52,10 +64,13 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
                     "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/models/session.rb

@@ -4,6 +4,7 @@ module Appwrite
     module Models
         class Session
             attr_reader :id
+            attr_reader :created_at
             attr_reader :user_id
             attr_reader :expire
             attr_reader :provider
@@ -30,6 +31,7 @@ module Appwrite
 
             def initialize(
                 id:,
+                created_at:,
                 user_id:,
                 expire:,
                 provider:,
@@ -55,6 +57,7 @@ module Appwrite
                 current:
             )
                 @id = id
+                @created_at = created_at
                 @user_id = user_id
                 @expire = expire
                 @provider = provider
@@ -83,6 +86,7 @@ module Appwrite
             def self.from(map:)
                 Session.new(
                     id: map["$id"],
+                    created_at: map["$createdAt"],
                     user_id: map["userId"],
                     expire: map["expire"],
                     provider: map["provider"],
@@ -112,6 +116,7 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
+                    "$createdAt": @created_at,
                     "userId": @user_id,
                     "expire": @expire,
                     "provider": @provider,

data/lib/appwrite/models/team.rb

@@ -4,27 +4,31 @@ module Appwrite
     module Models
         class Team
             attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
             attr_reader :name
-            attr_reader :date_created
             attr_reader :total
 
             def initialize(
                 id:,
+                created_at:,
+                updated_at:,
                 name:,
-                date_created:,
                 total:
             )
                 @id = id
+                @created_at = created_at
+                @updated_at = updated_at
                 @name = name
-                @date_created = date_created
                 @total = total
             end
 
             def self.from(map:)
                 Team.new(
                     id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
                     name: map["name"],
-                    date_created: map["dateCreated"],
                     total: map["total"]
                 )
             end
@@ -32,8 +36,9 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
                     "name": @name,
-                    "dateCreated": @date_created,
                     "total": @total
                 }
             end

data/lib/appwrite/models/token.rb

@@ -4,17 +4,20 @@ module Appwrite
     module Models
         class Token
             attr_reader :id
+            attr_reader :created_at
             attr_reader :user_id
             attr_reader :secret
             attr_reader :expire
 
             def initialize(
                 id:,
+                created_at:,
                 user_id:,
                 secret:,
                 expire:
             )
                 @id = id
+                @created_at = created_at
                 @user_id = user_id
                 @secret = secret
                 @expire = expire
@@ -23,6 +26,7 @@ module Appwrite
             def self.from(map:)
                 Token.new(
                     id: map["$id"],
+                    created_at: map["$createdAt"],
                     user_id: map["userId"],
                     secret: map["secret"],
                     expire: map["expire"]
@@ -32,6 +36,7 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
+                    "$createdAt": @created_at,
                     "userId": @user_id,
                     "secret": @secret,
                     "expire": @expire

data/lib/appwrite/models/user.rb

@@ -4,43 +4,59 @@ module Appwrite
     module Models
         class User
             attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
             attr_reader :name
             attr_reader :registration
             attr_reader :status
             attr_reader :password_update
             attr_reader :email
+            attr_reader :phone
             attr_reader :email_verification
+            attr_reader :phone_verification
             attr_reader :prefs
 
             def initialize(
                 id:,
+                created_at:,
+                updated_at:,
                 name:,
                 registration:,
                 status:,
                 password_update:,
                 email:,
+                phone:,
                 email_verification:,
+                phone_verification:,
                 prefs:
             )
                 @id = id
+                @created_at = created_at
+                @updated_at = updated_at
                 @name = name
                 @registration = registration
                 @status = status
                 @password_update = password_update
                 @email = email
+                @phone = phone
                 @email_verification = email_verification
+                @phone_verification = phone_verification
                 @prefs = prefs
             end
 
             def self.from(map:)
                 User.new(
                     id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
                     name: map["name"],
                     registration: map["registration"],
                     status: map["status"],
                     password_update: map["passwordUpdate"],
                     email: map["email"],
+                    phone: map["phone"],
                     email_verification: map["emailVerification"],
+                    phone_verification: map["phoneVerification"],
                     prefs: Preferences.from(map: map["prefs"])
                 )
             end
@@ -48,12 +64,16 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
                     "name": @name,
                     "registration": @registration,
                     "status": @status,
                     "passwordUpdate": @password_update,
                     "email": @email,
+                    "phone": @phone,
                     "emailVerification": @email_verification,
+                    "phoneVerification": @phone_verification,
                     "prefs": @prefs.to_map
                 }
             end

data/lib/appwrite/services/account.rb

@@ -3,6 +3,7 @@
 module Appwrite
     class Account < Service
 
+
         # Get currently logged in user data as JSON object.
         #
         #
@@ -26,32 +27,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 +128,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.
@@ -184,6 +159,44 @@ module Appwrite
             )
         end
 
+        # Update currently logged in user account phone number. After changing phone
+        # number, the user confirmation status will get reset. A new confirmation SMS
+        # is not sent automatically however you can use the phone confirmation
+        # endpoint again to send the confirmation SMS.
+        #
+        # @param [string] number Phone number. Format this number with a leading &#039;+&#039; and a country code, e.g., +16175551212.
+        # @param [string] password User password. Must be at least 8 chars.
+        #
+        # @return [User]
+        def update_phone(number:, password:)
+            if number.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "number"')
+            end
+
+            if password.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "password"')
+            end
+
+            path = '/account/phone'
+
+            params = {
+                number: number,
+                password: password,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::User
+            )
+        end
+
         # Get currently logged in user preferences as a key-value object.
         #
         #
@@ -412,7 +425,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 &#039;current&#039; to update the current device session.
         #
@@ -472,6 +487,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
@@ -479,8 +519,8 @@ module Appwrite
         # should redirect the user back to your app and allow you to complete the
         # verification process by verifying both the **userId** and **secret**
         # parameters. Learn more about how to [complete the verification
-        # process](/docs/client/account#accountUpdateVerification). The verification
-        # link sent to the user's email address is valid for 7 days.
+        # process](/docs/client/account#accountUpdateEmailVerification). The
+        # verification link sent to the user's email address is valid for 7 days.
         # 
         # Please note that in order to avoid a [Redirect
         # Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
@@ -553,5 +593,72 @@ module Appwrite
             )
         end
 
+        # Use this endpoint to send a verification message to your user's phone
+        # number to confirm they are the valid owners of that address. The provided
+        # secret should allow you to complete the verification process by verifying
+        # both the **userId** and **secret** parameters. Learn more about how to
+        # [complete the verification
+        # process](/docs/client/account#accountUpdatePhoneVerification). The
+        # verification link sent to the user's phone number is valid for 15 minutes.
+        #
+        #
+        # @return [Token]
+        def create_phone_verification()
+            path = '/account/verification/phone'
+
+            params = {
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::Token
+            )
+        end
+
+        # Use this endpoint to complete the user phone verification process. Use the
+        # **userId** and **secret** that were sent to your user's phone number to
+        # verify the user email ownership. If confirmed this route will return a 200
+        # status code.
+        #
+        # @param [string] user_id User ID.
+        # @param [string] secret Valid verification token.
+        #
+        # @return [Token]
+        def update_phone_verification(user_id:, secret:)
+            if user_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if secret.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "secret"')
+            end
+
+            path = '/account/verification/phone'
+
+            params = {
+                userId: user_id,
+                secret: secret,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::Token
+            )
+        end
+
     end 
 end

data/lib/appwrite/services/avatars.rb

@@ -3,10 +3,16 @@
 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 +49,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 +121,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 +164,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 +211,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 +250,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.
         #