appwrite 28.4.0 → 30.0.0

data/lib/appwrite/services/organization.rb

@@ -37,12 +37,12 @@ module Appwrite
         def update(
             name:
         )
-            api_path = '/organization'
-
             if name.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/organization'
+
             api_params = {
                 name: name,
             }
@@ -75,6 +75,7 @@ module Appwrite
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -129,12 +130,12 @@ module Appwrite
             app_id:,
             authorization_details: nil
         )
-            api_path = '/organization/installations'
-
             if app_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "appId"')
             end
 
+            api_path = '/organization/installations'
+
             api_params = {
                 appId: app_id,
                 authorizationDetails: authorization_details,
@@ -164,13 +165,13 @@ module Appwrite
         def get_installation(
             installation_id:
         )
-            api_path = '/organization/installations/{installationId}'
-                .gsub('{installationId}', installation_id)
-
-            if installation_id.nil?
+            if installation_id.nil? || installation_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
+
             api_params = {}
 
             api_headers = {
@@ -200,13 +201,13 @@ module Appwrite
             installation_id:,
             authorization_details: nil
         )
-            api_path = '/organization/installations/{installationId}'
-                .gsub('{installationId}', installation_id)
-
-            if installation_id.nil?
+            if installation_id.nil? || installation_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
+
             api_params = {
                 authorizationDetails: authorization_details,
             }
@@ -236,216 +237,21 @@ module Appwrite
         def delete_installation(
             installation_id:
         )
-            api_path = '/organization/installations/{installationId}'
-                .gsub('{installationId}', installation_id)
-
-            if installation_id.nil?
+            if installation_id.nil? || installation_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
-            api_params = {}
-
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "content-type": 'application/json',
-                "accept": 'application/json',
-            }
-
-            @client.call(
-                method: 'DELETE',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-            )
-        end
-
-        # Get a list of all API keys from the current organization.
-        #
-        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes
-        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
-        #
-        # @return [KeyList]
-        def list_keys(
-            queries: nil,
-            total: nil
-        )
-            api_path = '/organization/keys'
-
-            api_params = {
-                queries: queries,
-                total: total,
-            }
-
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "accept": 'application/json',
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::KeyList
-            )
-        end
-
-        # Create a new organization API key.
-        #
-        # @param [String] key_id Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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 Key name. Max length: 128 chars.
-        # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
-        # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
-        #
-        # @return [Key]
-        def create_key(
-            key_id:,
-            name:,
-            scopes:,
-            expire: nil
-        )
-            api_path = '/organization/keys'
-
-            if key_id.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
-            end
-
-            if name.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "name"')
-            end
-
-            if scopes.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "scopes"')
-            end
-
-            api_params = {
-                keyId: key_id,
-                name: name,
-                scopes: scopes,
-                expire: expire,
-            }
-
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "content-type": 'application/json',
-                "accept": 'application/json',
-            }
-
-            @client.call(
-                method: 'POST',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::Key
-            )
-        end
-
-        # Get a key by its unique ID. This endpoint returns details about a specific
-        # API key in your organization including its scopes.
-        #
-        # @param [String] key_id Key unique ID.
-        #
-        # @return [Key]
-        def get_key(
-            key_id:
-        )
-            api_path = '/organization/keys/{keyId}'
-                .gsub('{keyId}', key_id)
-
-            if key_id.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
-            end
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
 
             api_params = {}
 
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "accept": 'application/json',
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::Key
-            )
-        end
-
-        # Update a key by its unique ID. Use this endpoint to update the name,
-        # scopes, or expiration time of an API key.
-        #
-        # @param [String] key_id Key unique ID.
-        # @param [String] name Key name. Max length: 128 chars.
-        # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
-        # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
-        #
-        # @return [Key]
-        def update_key(
-            key_id:,
-            name:,
-            scopes:,
-            expire: nil
-        )
-            api_path = '/organization/keys/{keyId}'
-                .gsub('{keyId}', key_id)
-
-            if key_id.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
-            end
-
-            if name.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "name"')
-            end
-
-            if scopes.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "scopes"')
-            end
-
-            api_params = {
-                name: name,
-                scopes: scopes,
-                expire: expire,
-            }
-
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
                 "accept": 'application/json',
             }
 
-            @client.call(
-                method: 'PUT',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::Key
-            )
-        end
-
-        # Delete a key by its unique ID. Once deleted, the key can no longer be used
-        # to authenticate API calls.
-        #
-        # @param [String] key_id Key unique ID.
-        #
-        # @return []
-        def delete_key(
-            key_id:
-        )
-            api_path = '/organization/keys/{keyId}'
-                .gsub('{keyId}', key_id)
-
-            if key_id.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
-            end
-
-            api_params = {}
-
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "content-type": 'application/json',
-            }
-
             @client.call(
                 method: 'DELETE',
                 path: api_path,
@@ -508,12 +314,12 @@ module Appwrite
             url: nil,
             name: nil
         )
-            api_path = '/organization/memberships'
-
             if roles.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "roles"')
             end
 
+            api_path = '/organization/memberships'
+
             api_params = {
                 email: email,
                 userId: user_id,
@@ -546,13 +352,13 @@ module Appwrite
         def get_membership(
             membership_id:
         )
-            api_path = '/organization/memberships/{membershipId}'
-                .gsub('{membershipId}', membership_id)
-
-            if membership_id.nil?
+            if membership_id.nil? || membership_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
+            api_path = '/organization/memberships/{membershipId}'
+                .gsub('{membershipId}', membership_id)
+
             api_params = {}
 
             api_headers = {
@@ -579,10 +385,7 @@ module Appwrite
             membership_id:,
             roles:
         )
-            api_path = '/organization/memberships/{membershipId}'
-                .gsub('{membershipId}', membership_id)
-
-            if membership_id.nil?
+            if membership_id.nil? || membership_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
@@ -590,6 +393,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "roles"')
             end
 
+            api_path = '/organization/memberships/{membershipId}'
+                .gsub('{membershipId}', membership_id)
+
             api_params = {
                 roles: roles,
             }
@@ -619,18 +425,19 @@ module Appwrite
         def delete_membership(
             membership_id:
         )
-            api_path = '/organization/memberships/{membershipId}'
-                .gsub('{membershipId}', membership_id)
-
-            if membership_id.nil?
+            if membership_id.nil? || membership_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
+            api_path = '/organization/memberships/{membershipId}'
+                .gsub('{membershipId}', membership_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -688,8 +495,6 @@ module Appwrite
             name:,
             region: nil
         )
-            api_path = '/organization/projects'
-
             if project_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
@@ -698,6 +503,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/organization/projects'
+
             api_params = {
                 projectId: project_id,
                 name: name,
@@ -727,17 +534,18 @@ module Appwrite
         def get_project(
             project_id:
         )
-            api_path = '/organization/projects/{projectId}'
-                .gsub('{projectId}', project_id)
-
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -759,10 +567,7 @@ module Appwrite
             project_id:,
             name:
         )
-            api_path = '/organization/projects/{projectId}'
-                .gsub('{projectId}', project_id)
-
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
@@ -770,6 +575,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
             api_params = {
                 name: name,
             }
@@ -797,18 +605,19 @@ module Appwrite
         def delete_project(
             project_id:
         )
-            api_path = '/organization/projects/{projectId}'
-                .gsub('{projectId}', project_id)
-
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -831,7 +640,7 @@ module Appwrite
             queries: nil,
             total: nil
         )
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
@@ -874,7 +683,7 @@ module Appwrite
             scopes:,
             duration:
         )
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
@@ -919,11 +728,11 @@ module Appwrite
             project_id:,
             key_id:
         )
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
-            if key_id.nil?
+            if key_id.nil? || key_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
@@ -955,6 +764,7 @@ module Appwrite
         # @param [String] name Key name. Max length: 128 chars.
         # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
         # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+        # @param [String] description Optional description for the key.
         #
         # @return [Key]
         def update_project_key(
@@ -962,13 +772,14 @@ module Appwrite
             key_id:,
             name:,
             scopes:,
-            expire: nil
+            expire: nil,
+            description: nil
         )
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
-            if key_id.nil?
+            if key_id.nil? || key_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
@@ -988,6 +799,7 @@ module Appwrite
                 name: name,
                 scopes: scopes,
                 expire: expire,
+                description: description,
             }
 
             api_headers = {
@@ -1016,11 +828,11 @@ module Appwrite
             project_id:,
             key_id:
         )
-            if project_id.nil?
+            if project_id.nil? || project_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
-            if key_id.nil?
+            if key_id.nil? || key_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end