appwrite 24.1.0 → 25.0.0

data/lib/appwrite/models/site.rb

@@ -30,6 +30,8 @@ module Appwrite
             attr_reader :provider_branch
             attr_reader :provider_root_directory
             attr_reader :provider_silent_mode
+            attr_reader :provider_branches
+            attr_reader :provider_paths
             attr_reader :build_specification
             attr_reader :runtime_specification
             attr_reader :build_runtime
@@ -64,6 +66,8 @@ module Appwrite
                 provider_branch:,
                 provider_root_directory:,
                 provider_silent_mode:,
+                provider_branches:,
+                provider_paths:,
                 build_specification:,
                 runtime_specification:,
                 build_runtime:,
@@ -97,6 +101,8 @@ module Appwrite
                 @provider_branch = provider_branch
                 @provider_root_directory = provider_root_directory
                 @provider_silent_mode = provider_silent_mode
+                @provider_branches = provider_branches
+                @provider_paths = provider_paths
                 @build_specification = build_specification
                 @runtime_specification = runtime_specification
                 @build_runtime = build_runtime
@@ -133,6 +139,8 @@ module Appwrite
                     provider_branch: map["providerBranch"],
                     provider_root_directory: map["providerRootDirectory"],
                     provider_silent_mode: map["providerSilentMode"],
+                    provider_branches: map["providerBranches"],
+                    provider_paths: map["providerPaths"],
                     build_specification: map["buildSpecification"],
                     runtime_specification: map["runtimeSpecification"],
                     build_runtime: map["buildRuntime"],
@@ -170,6 +178,8 @@ module Appwrite
                     "providerBranch": @provider_branch,
                     "providerRootDirectory": @provider_root_directory,
                     "providerSilentMode": @provider_silent_mode,
+                    "providerBranches": @provider_branches,
+                    "providerPaths": @provider_paths,
                     "buildSpecification": @build_specification,
                     "runtimeSpecification": @runtime_specification,
                     "buildRuntime": @build_runtime,

data/lib/appwrite/models/usage_gauge.rb

@@ -6,22 +6,30 @@ module Appwrite
             attr_reader :metric
             attr_reader :value
             attr_reader :time
+            attr_reader :resource_type
+            attr_reader :resource_id
 
             def initialize(
                 metric:,
                 value:,
-                time:
+                time:,
+                resource_type:,
+                resource_id:
             )
                 @metric = metric
                 @value = value
                 @time = time
+                @resource_type = resource_type
+                @resource_id = resource_id
             end
 
             def self.from(map:)
                 UsageGauge.new(
                     metric: map["metric"],
                     value: map["value"],
-                    time: map["time"]
+                    time: map["time"],
+                    resource_type: map["resourceType"],
+                    resource_id: map["resourceId"]
                 )
             end
 
@@ -29,7 +37,9 @@ module Appwrite
                 {
                     "metric": @metric,
                     "value": @value,
-                    "time": @time
+                    "time": @time,
+                    "resourceType": @resource_type,
+                    "resourceId": @resource_id
                 }
             end
         end

data/lib/appwrite/services/avatars.rb

@@ -305,7 +305,7 @@ module Appwrite
         # @param [Integer] viewport_width Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
         # @param [Integer] viewport_height Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
         # @param [Float] scale Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
-        # @param [Theme] theme Browser theme. Pass "light" or "dark". Defaults to "light".
+        # @param [BrowserTheme] theme Browser theme. Pass "light" or "dark". Defaults to "light".
         # @param [String] user_agent Custom user agent string. Defaults to browser default.
         # @param [] fullpage Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
         # @param [String] locale Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.

data/lib/appwrite/services/functions.rb

@@ -59,12 +59,14 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the function.
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to function code in the linked repo.
+        # @param [Array] provider_branches List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.
+        # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @param [String] build_specification Build specification for the function deployments.
         # @param [String] runtime_specification Runtime specification for the function executions.
         # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Function]
-        def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
+        def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions'
 
             if function_id.nil?
@@ -97,6 +99,8 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
+                providerBranches: provider_branches,
+                providerPaths: provider_paths,
                 buildSpecification: build_specification,
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,
@@ -210,12 +214,14 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the function
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to function code in the linked repo.
+        # @param [Array] provider_branches List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.
+        # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @param [String] build_specification Build specification for the function deployments.
         # @param [String] runtime_specification Runtime specification for the function executions.
         # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Function]
-        def update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
+        def update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions/{functionId}'
                 .gsub('{functionId}', function_id)
 
@@ -244,6 +250,8 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
+                providerBranches: provider_branches,
+                providerPaths: provider_paths,
                 buildSpecification: build_specification,
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,

data/lib/appwrite/services/health.rb

@@ -314,7 +314,7 @@ module Appwrite
         # Returns the amount of failed jobs in a given queue.
         # 
         #
-        # @param [Name] name The name of the queue
+        # @param [HealthQueueName] name The name of the queue
         # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
         #
         # @return [HealthQueue]

data/lib/appwrite/services/organization.rb

@@ -0,0 +1,349 @@
+#frozen_string_literal: true
+
+module Appwrite
+    class Organization < Service
+
+        def initialize(client)
+            @client = client
+        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 = {
+            }
+
+            @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 100 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 = {
+                "content-type": '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_params = {
+            }
+            
+            api_headers = {
+            }
+
+            @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 100 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 = {
+                "content-type": '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 = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+
+        end
+
+        # Get a list of all projects. You can use the query params to filter your
+        # results.
+        #
+        # @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: name, teamId, labels, search
+        # @param [String] search Search term to filter your list results. Max length: 256 chars.
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
+        #
+        # @return [ProjectList]
+        def list_projects(queries: nil, search: nil, total: nil)
+            api_path = '/organization/projects'
+
+            api_params = {
+                queries: queries,
+                search: search,
+                total: total,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProjectList
+            )
+
+        end
+
+        # Create a new project.
+        #
+        # @param [String] project_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
+        # @param [String] name Project name. Max length: 128 chars.
+        # @param [Region] region Project Region.
+        #
+        # @return [Project]
+        def create_project(project_id:, name:, region: nil)
+            api_path = '/organization/projects'
+
+            if project_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            if name.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "name"')
+            end
+
+            api_params = {
+                projectId: project_id,
+                name: name,
+                region: region,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Project
+            )
+
+        end
+
+        # Get a project.
+        #
+        # @param [String] project_id Project unique ID.
+        #
+        # @return [Project]
+        def get_project(project_id:)
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
+            if project_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Project
+            )
+
+        end
+
+        # Update a project by its unique ID.
+        #
+        # @param [String] project_id Project unique ID.
+        # @param [String] name Project name. Max length: 128 chars.
+        #
+        # @return [Project]
+        def update_project(project_id:, name:)
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
+            if project_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            if name.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "name"')
+            end
+
+            api_params = {
+                name: name,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Project
+            )
+
+        end
+
+        # Delete a project by its unique ID.
+        #
+        # @param [String] project_id Project unique ID.
+        #
+        # @return []
+        def delete_project(project_id:)
+            api_path = '/organization/projects/{projectId}'
+                .gsub('{projectId}', project_id)
+
+            if project_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+
+        end
+
+    end 
+end

data/lib/appwrite/services/presences.rb

@@ -130,7 +130,7 @@ module Appwrite
         # @param [] purge When true, purge cached responses used by list presences endpoint.
         #
         # @return [Presence]
-        def update_presence(presence_id:, user_id:, status: nil, expires_at: nil, metadata: nil, permissions: nil, purge: nil)
+        def update(presence_id:, user_id:, status: nil, expires_at: nil, metadata: nil, permissions: nil, purge: nil)
             api_path = '/presences/{presenceId}'
                 .gsub('{presenceId}', presence_id)