appwrite 28.3.1 → 28.4.0

data/lib/appwrite/services/organization.rb

@@ -818,5 +818,230 @@ module Appwrite
                 params: api_params,
             )
         end
+
+        # Get a list of all API keys of a project in your organization.
+        #
+        # @param [String] project_id Project unique ID.
+        # @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_project_keys(
+            project_id:,
+            queries: nil,
+            total: nil
+        )
+            if project_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            api_path = '/organization/projects/{projectId}/keys'
+                .gsub('{projectId}', project_id)
+
+            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 ephemeral API key for a project in your organization. It's
+        # recommended to have multiple API keys with strict scopes for separate
+        # functions within your project.
+        #
+        # You can also create a standard API key if you need a longer-lived key
+        # instead.
+        #
+        # @param [String] project_id Project unique ID.
+        # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
+        # @param [Integer] duration Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
+        #
+        # @return [EphemeralKey]
+        def create_ephemeral_project_key(
+            project_id:,
+            scopes:,
+            duration:
+        )
+            if project_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            if scopes.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "scopes"')
+            end
+
+            if duration.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "duration"')
+            end
+
+            api_path = '/organization/projects/{projectId}/keys/ephemeral'
+                .gsub('{projectId}', project_id)
+
+            api_params = {
+                scopes: scopes,
+                duration: duration,
+            }
+
+            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::EphemeralKey
+            )
+        end
+
+        # Get a project key by its unique ID.
+        #
+        # @param [String] project_id Project unique ID.
+        # @param [String] key_id Key ID.
+        #
+        # @return [Key]
+        def get_project_key(
+            project_id:,
+            key_id:
+        )
+            if project_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            if key_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+            end
+
+            api_path = '/organization/projects/{projectId}/keys/{keyId}'
+                .gsub('{projectId}', project_id)
+                .gsub('{keyId}', key_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 project key by its unique ID. Use this endpoint to update the
+        # name, scopes, or expiration time of an API key.
+        #
+        # @param [String] project_id Project unique ID.
+        # @param [String] key_id Key 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_project_key(
+            project_id:,
+            key_id:,
+            name:,
+            scopes:,
+            expire: nil
+        )
+            if project_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            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_path = '/organization/projects/{projectId}/keys/{keyId}'
+                .gsub('{projectId}', project_id)
+                .gsub('{keyId}', key_id)
+
+            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 project key by its unique ID. Once deleted, the key can no longer
+        # be used to authenticate API calls.
+        #
+        # @param [String] project_id Project unique ID.
+        # @param [String] key_id Key ID.
+        #
+        # @return []
+        def delete_project_key(
+            project_id:,
+            key_id:
+        )
+            if project_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            if key_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+            end
+
+            api_path = '/organization/projects/{projectId}/keys/{keyId}'
+                .gsub('{projectId}', project_id)
+                .gsub('{keyId}', key_id)
+
+            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
     end
 end