appwrite 11.0.2 → 13.1.0

data/lib/appwrite/services/functions.rb

@@ -52,6 +52,7 @@ module Appwrite
         # @param [] logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
         # @param [String] entrypoint Entrypoint File. This path is relative to the "providerRootDirectory".
         # @param [String] commands Build Commands.
+        # @param [Array] scopes List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
         # @param [String] installation_id Appwrite Installation ID for VCS (Version Control System) deployment.
         # @param [String] provider_repository_id Repository ID of the repo linked to the function.
         # @param [String] provider_branch Production branch for the repo linked to the function.
@@ -60,10 +61,11 @@ module Appwrite
         # @param [String] template_repository Repository name of the template.
         # @param [String] template_owner The name of the owner of the template.
         # @param [String] template_root_directory Path to function code in the template repo.
-        # @param [String] template_branch Production branch for the repo linked to the function template.
+        # @param [String] template_version Version (tag) for the repo linked to the function template.
+        # @param [String] specification Runtime specification for the function and builds.
         #
         # @return [Function]
-        def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, template_repository: nil, template_owner: nil, template_root_directory: nil, template_branch: 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, template_repository: nil, template_owner: nil, template_root_directory: nil, template_version: nil, specification: nil)
             api_path = '/functions'
 
             if function_id.nil?
@@ -90,6 +92,7 @@ module Appwrite
                 logging: logging,
                 entrypoint: entrypoint,
                 commands: commands,
+                scopes: scopes,
                 installationId: installation_id,
                 providerRepositoryId: provider_repository_id,
                 providerBranch: provider_branch,
@@ -98,7 +101,8 @@ module Appwrite
                 templateRepository: template_repository,
                 templateOwner: template_owner,
                 templateRootDirectory: template_root_directory,
-                templateBranch: template_branch,
+                templateVersion: template_version,
+                specification: specification,
             }
             
             api_headers = {
@@ -139,6 +143,31 @@ module Appwrite
         end
 
         
+        # List allowed function specifications for this instance.
+        # 
+        #
+        #
+        # @return [SpecificationList]
+        def list_specifications()
+            api_path = '/functions/specifications'
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::SpecificationList
+            )
+        end
+
+        
         # Get a function by its unique ID.
         #
         # @param [String] function_id Function ID.
@@ -182,14 +211,16 @@ module Appwrite
         # @param [] logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
         # @param [String] entrypoint Entrypoint File. This path is relative to the "providerRootDirectory".
         # @param [String] commands Build Commands.
+        # @param [Array] scopes List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
         # @param [String] installation_id Appwrite Installation ID for VCS (Version Controle System) deployment.
         # @param [String] provider_repository_id Repository ID of the repo linked to the function
         # @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 [String] specification Runtime specification for the function and builds.
         #
         # @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, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: 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, specification: nil)
             api_path = '/functions/{functionId}'
                 .gsub('{functionId}', function_id)
 
@@ -212,11 +243,13 @@ module Appwrite
                 logging: logging,
                 entrypoint: entrypoint,
                 commands: commands,
+                scopes: scopes,
                 installationId: installation_id,
                 providerRepositoryId: provider_repository_id,
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
+                specification: specification,
             }
             
             api_headers = {
@@ -266,7 +299,7 @@ module Appwrite
         # params to filter your results.
         #
         # @param [String] function_id Function 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: size, buildId, activate, entrypoint, commands
+        # @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: size, buildId, activate, entrypoint, commands, type, size
         # @param [String] search Search term to filter your list results. Max length: 256 chars.
         #
         # @return [DeploymentList]
@@ -466,19 +499,17 @@ module Appwrite
         end
 
         
-        # Create a new build for an Appwrite Function deployment. This endpoint can
-        # be used to retry a failed build.
+        # 
         #
         # @param [String] function_id Function ID.
         # @param [String] deployment_id Deployment ID.
         # @param [String] build_id Build unique ID.
         #
         # @return []
-        def create_build(function_id:, deployment_id:, build_id:)
-            api_path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'
+        def create_build(function_id:, deployment_id:, build_id: nil)
+            api_path = '/functions/{functionId}/deployments/{deploymentId}/build'
                 .gsub('{functionId}', function_id)
                 .gsub('{deploymentId}', deployment_id)
-                .gsub('{buildId}', build_id)
 
             if function_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "functionId"')
@@ -488,8 +519,40 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
-            if build_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "buildId"')
+            api_params = {
+                buildId: build_id,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        end
+
+        
+        # 
+        #
+        # @param [String] function_id Function ID.
+        # @param [String] deployment_id Deployment ID.
+        #
+        # @return [Build]
+        def update_deployment_build(function_id:, deployment_id:)
+            api_path = '/functions/{functionId}/deployments/{deploymentId}/build'
+                .gsub('{functionId}', function_id)
+                .gsub('{deploymentId}', deployment_id)
+
+            if function_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "functionId"')
+            end
+
+            if deployment_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
             api_params = {
@@ -500,10 +563,11 @@ module Appwrite
             }
 
             @client.call(
-                method: 'POST',
+                method: 'PATCH',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
+                response_type: Models::Build
             )
         end
 
@@ -515,7 +579,7 @@ module Appwrite
         # @param [String] deployment_id Deployment ID.
         #
         # @return []
-        def download_deployment(function_id:, deployment_id:)
+        def get_deployment_download(function_id:, deployment_id:)
             api_path = '/functions/{functionId}/deployments/{deploymentId}/download'
                 .gsub('{functionId}', function_id)
                 .gsub('{deploymentId}', deployment_id)
@@ -548,7 +612,7 @@ module Appwrite
         # query params to filter your results.
         #
         # @param [String] function_id Function 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: trigger, status, responseStatusCode, duration
+        # @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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
         # @param [String] search Search term to filter your list results. Max length: 256 chars.
         #
         # @return [ExecutionList]
@@ -590,9 +654,10 @@ module Appwrite
         # @param [String] xpath HTTP path of execution. Path can include query params. Default value is /
         # @param [ExecutionMethod] method HTTP method of execution. Default value is GET.
         # @param [Hash] headers HTTP headers of execution. Defaults to empty.
+        # @param [String] scheduled_at Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
         #
         # @return [Execution]
-        def create_execution(function_id:, body: nil, async: nil, xpath: nil, method: nil, headers: nil)
+        def create_execution(function_id:, body: nil, async: nil, xpath: nil, method: nil, headers: nil, scheduled_at: nil)
             api_path = '/functions/{functionId}/executions'
                 .gsub('{functionId}', function_id)
 
@@ -606,6 +671,7 @@ module Appwrite
                 path: xpath,
                 method: method,
                 headers: headers,
+                scheduledAt: scheduled_at,
             }
             
             api_headers = {
@@ -658,6 +724,42 @@ module Appwrite
         end
 
         
+        # Delete a function execution by its unique ID.
+        # 
+        #
+        # @param [String] function_id Function ID.
+        # @param [String] execution_id Execution ID.
+        #
+        # @return []
+        def delete_execution(function_id:, execution_id:)
+            api_path = '/functions/{functionId}/executions/{executionId}'
+                .gsub('{functionId}', function_id)
+                .gsub('{executionId}', execution_id)
+
+            if function_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "functionId"')
+            end
+
+            if execution_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "executionId"')
+            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 variables of a specific function.
         #
         # @param [String] function_id Function unique ID.

data/lib/appwrite/services/messaging.rb

@@ -156,33 +156,28 @@ module Appwrite
         # @param [Array] topics List of Topic IDs.
         # @param [Array] users List of User IDs.
         # @param [Array] targets List of Targets IDs.
-        # @param [Hash] data Additional Data for push notification.
+        # @param [Hash] data Additional key-value pair data for push notification.
         # @param [String] action Action for push notification.
         # @param [String] image Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
         # @param [String] icon Icon for push notification. Available only for Android and Web Platform.
-        # @param [String] sound Sound for push notification. Available only for Android and IOS Platform.
+        # @param [String] sound Sound for push notification. Available only for Android and iOS Platform.
         # @param [String] color Color for push notification. Available only for Android Platform.
         # @param [String] tag Tag for push notification. Available only for Android Platform.
-        # @param [String] badge Badge for push notification. Available only for IOS Platform.
+        # @param [Integer] badge Badge for push notification. Available only for iOS Platform.
         # @param [] draft Is message a draft
         # @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
+        # @param [] content_available If set to true, the notification will be delivered in the background. Available only for iOS Platform.
+        # @param [] critical If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
+        # @param [MessagePriority] priority Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
         #
         # @return [Message]
-        def create_push(message_id:, title:, body:, topics: nil, users: nil, targets: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil)
+        def create_push(message_id:, title: nil, body: nil, topics: nil, users: nil, targets: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil, content_available: nil, critical: nil, priority: nil)
             api_path = '/messaging/messages/push'
 
             if message_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "messageId"')
             end
 
-            if title.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "title"')
-            end
-
-            if body.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "body"')
-            end
-
             api_params = {
                 messageId: message_id,
                 title: title,
@@ -200,6 +195,9 @@ module Appwrite
                 badge: badge,
                 draft: draft,
                 scheduledAt: scheduled_at,
+                contentAvailable: content_available,
+                critical: critical,
+                priority: priority,
             }
             
             api_headers = {
@@ -235,9 +233,12 @@ module Appwrite
         # @param [Integer] badge Badge for push notification. Available only for iOS platforms.
         # @param [] draft Is message a draft
         # @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
+        # @param [] content_available If set to true, the notification will be delivered in the background. Available only for iOS Platform.
+        # @param [] critical If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
+        # @param [MessagePriority] priority Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
         #
         # @return [Message]
-        def update_push(message_id:, topics: nil, users: nil, targets: nil, title: nil, body: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil)
+        def update_push(message_id:, topics: nil, users: nil, targets: nil, title: nil, body: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil, content_available: nil, critical: nil, priority: nil)
             api_path = '/messaging/messages/push/{messageId}'
                 .gsub('{messageId}', message_id)
 
@@ -261,6 +262,9 @@ module Appwrite
                 badge: badge,
                 draft: draft,
                 scheduledAt: scheduled_at,
+                contentAvailable: content_available,
+                critical: critical,
+                priority: priority,
             }
             
             api_headers = {

data/lib/appwrite/services/storage.rb

@@ -256,7 +256,7 @@ module Appwrite
         #
         # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
         # @param [String] file_id File 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 [file] file Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/storage#file-input).
+        # @param [file] file Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
         # @param [Array] permissions An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
         #
         # @return [File]

data/lib/appwrite/services/teams.rb

@@ -173,7 +173,8 @@ module Appwrite
 
         
         # Use this endpoint to list a team's members using the team's ID. All team
-        # members have read access to this endpoint.
+        # members have read access to this endpoint. Hide sensitive attributes from
+        # the response by toggling membership privacy in the Console.
         #
         # @param [String] team_id Team 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: userId, teamId, invited, joined, confirm
@@ -234,7 +235,7 @@ module Appwrite
         # @param [String] email Email of the new team member.
         # @param [String] user_id ID of the user to be added to a team.
         # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
-        # @param [String] url URL to redirect the user back to your app from the invitation email.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+        # @param [String] url URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
         # @param [String] name Name of the new team member. Max length: 128 chars.
         #
         # @return [Membership]
@@ -274,7 +275,8 @@ module Appwrite
 
         
         # Get a team member by the membership unique id. All team members have read
-        # access for this resource.
+        # access for this resource. Hide sensitive attributes from the response by
+        # toggling membership privacy in the Console.
         #
         # @param [String] team_id Team ID.
         # @param [String] membership_id Membership ID.

data/lib/appwrite/services/users.rb

@@ -611,6 +611,42 @@ module Appwrite
         end
 
         
+        # Use this endpoint to create a JSON Web Token for user by its unique ID. You
+        # can use the resulting JWT to authenticate on behalf of the user. The JWT
+        # secret will become invalid if the session it uses gets deleted.
+        #
+        # @param [String] user_id User ID.
+        # @param [String] session_id Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.
+        # @param [Integer] duration Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
+        #
+        # @return [Jwt]
+        def create_jwt(user_id:, session_id: nil, duration: nil)
+            api_path = '/users/{userId}/jwts'
+                .gsub('{userId}', user_id)
+
+            if user_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            api_params = {
+                sessionId: session_id,
+                duration: duration,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Jwt
+            )
+        end
+
+        
         # Update the user labels by its unique ID. 
         # 
         # Labels can be used to grant access to resources. While teams are a way for

data/lib/appwrite.rb

@@ -40,6 +40,7 @@ require_relative 'appwrite/models/message_list'
 require_relative 'appwrite/models/topic_list'
 require_relative 'appwrite/models/subscriber_list'
 require_relative 'appwrite/models/target_list'
+require_relative 'appwrite/models/specification_list'
 require_relative 'appwrite/models/database'
 require_relative 'appwrite/models/collection'
 require_relative 'appwrite/models/attribute_list'
@@ -79,6 +80,7 @@ require_relative 'appwrite/models/function'
 require_relative 'appwrite/models/runtime'
 require_relative 'appwrite/models/deployment'
 require_relative 'appwrite/models/execution'
+require_relative 'appwrite/models/build'
 require_relative 'appwrite/models/variable'
 require_relative 'appwrite/models/country'
 require_relative 'appwrite/models/continent'
@@ -91,6 +93,7 @@ require_relative 'appwrite/models/health_status'
 require_relative 'appwrite/models/health_certificate'
 require_relative 'appwrite/models/health_time'
 require_relative 'appwrite/models/headers'
+require_relative 'appwrite/models/specification'
 require_relative 'appwrite/models/mfa_challenge'
 require_relative 'appwrite/models/mfa_recovery_codes'
 require_relative 'appwrite/models/mfa_type'
@@ -113,6 +116,7 @@ require_relative 'appwrite/enums/index_type'
 require_relative 'appwrite/enums/runtime'
 require_relative 'appwrite/enums/execution_method'
 require_relative 'appwrite/enums/name'
+require_relative 'appwrite/enums/message_priority'
 require_relative 'appwrite/enums/smtp_encryption'
 require_relative 'appwrite/enums/compression'
 require_relative 'appwrite/enums/image_gravity'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appwrite
 version: !ruby/object:Gem::Version
-  version: 11.0.2
+  version: 13.1.0
 platform: ruby
 authors:
 - Appwrite Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.1
-description: 
+description:
 email: team@appwrite.io
 executables: []
 extensions: []
@@ -42,6 +42,7 @@ files:
 - lib/appwrite/enums/image_format.rb
 - lib/appwrite/enums/image_gravity.rb
 - lib/appwrite/enums/index_type.rb
+- lib/appwrite/enums/message_priority.rb
 - lib/appwrite/enums/messaging_provider_type.rb
 - lib/appwrite/enums/name.rb
 - lib/appwrite/enums/o_auth_provider.rb
@@ -73,6 +74,7 @@ files:
 - lib/appwrite/models/attribute_url.rb
 - lib/appwrite/models/bucket.rb
 - lib/appwrite/models/bucket_list.rb
+- lib/appwrite/models/build.rb
 - lib/appwrite/models/collection.rb
 - lib/appwrite/models/collection_list.rb
 - lib/appwrite/models/continent.rb
@@ -128,6 +130,8 @@ files:
 - lib/appwrite/models/runtime_list.rb
 - lib/appwrite/models/session.rb
 - lib/appwrite/models/session_list.rb
+- lib/appwrite/models/specification.rb
+- lib/appwrite/models/specification_list.rb
 - lib/appwrite/models/subscriber.rb
 - lib/appwrite/models/subscriber_list.rb
 - lib/appwrite/models/target.rb
@@ -160,7 +164,7 @@ homepage: https://appwrite.io/support
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Appwrite is an open-source self-hosted backend server that abstract and simplify
   complex and repetitive development tasks behind a very simple REST API