appwrite 8.0.0 → 9.0.1

data/lib/appwrite/role.rb

@@ -1,9 +1,26 @@
 module Appwrite
+
+    # Helper class to generate role strings for `Permission`.
     class Role
+
+        # Grants access to anyone.
+        # 
+        # This includes authenticated and unauthenticated users.
+        #
+        # @return [String]
         def self.any
             'any'
         end
 
+        # Grants access to a specific user by user ID.
+        # 
+        # You can optionally pass verified or unverified for
+        # `status` to target specific types of users.
+        #
+        # @param [String] id
+        # @param [String] status
+        # 
+        # @return [String]
         def self.user(id, status = "")
             if(status.empty?)
                 "user:#{id}"
@@ -12,6 +29,14 @@ module Appwrite
             end
         end
         
+        # Grants access to any authenticated or anonymous user.
+        # 
+        # You can optionally pass verified or unverified for
+        # `status` to target specific types of users.
+        #
+        # @param [String] status
+        #
+        # @return [String]
         def self.users(status = "")
             if(status.empty?)
                 'users'
@@ -20,10 +45,24 @@ module Appwrite
             end
         end
         
+        # Grants access to any guest user without a session.
+        #
+        # Authenticated users don't have access to this role.
+        #
+        # @return [String]
         def self.guests
             'guests'
         end
         
+        # Grants access to a team by team ID.
+        #
+        # You can optionally pass a role for `role` to target
+        # team members with the specified role.
+        #
+        # @param [String] id
+        # @param [String] role
+        #
+        # @return [String]
         def self.team(id, role = "")
             if(role.empty?)
                 "team:#{id}"
@@ -32,8 +71,25 @@ module Appwrite
             end
         end
 
+        # Grants access to a specific member of a team.
+        # 
+        # When the member is removed from the team, they will
+        # no longer have access.
+        #
+        # @param [String] id
+        #
+        # @return [String]
         def self.member(id)
             "member:#{id}"
         end
+
+        # Grants access to a user with the specified label.
+        #
+        # @param [String] name
+        #
+        # @return [String]
+        def self.label(name)
+            "label:#{name}"
+        end
     end
 end