appwrite 30.0.1 → 30.1.0

data/lib/appwrite/services/project.rb

@@ -72,7 +72,7 @@ module Appwrite
             end
 
             api_path = '/project/auth-methods/{methodId}'
-                .gsub('{methodId}', method_id)
+                .gsub('{methodId}', @client.encode_path(method_id))
 
             api_params = {
                 enabled: enabled,
@@ -129,13 +129,23 @@ module Appwrite
         # project in the same organization and region, with its own resources and
         # users. Its usage is billed under the project it belongs to.
         #
+        # Pass `resources` to copy the project into the environment. The environment
+        # is returned at once and the copy runs as a migration of the environment,
+        # listed by its migrations routes and announced on its `migrations.*`
+        # realtime events; a resource whose ID can be chosen keeps it. Users are
+        # copied newest first and at most 90 of them, so the environment keeps room
+        # under its limit of 100 users for test accounts, and the memberships of
+        # users left behind are not copied.
+        #
         # @param [String] environment_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 Environment name. Max length: 128 chars.
+        # @param [Array] resources Resources to copy from the project into the environment, by type. A structural type such as `database`, `table`, `column`, `index`, `bucket`, `team`, `function` or `site` copies the structure and its settings; `row`, `file`, `user`, `membership`, `deployment` and `site-deployment` copy what it holds. A function or site is copied with its active deployment; add `deployment` or `site-deployment` to copy every deployment. Users are copied newest first and at most 90 of them, leaving room under the limit of 100 users of an environment for test accounts; the memberships of users left behind are not copied. Leave empty for an empty environment. Maximum of 100 types.
         #
         # @return [Project]
         def create_environment(
             environment_id:,
-            name:
+            name:,
+            resources: nil
         )
             if environment_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "environmentId"')
@@ -150,6 +160,7 @@ module Appwrite
             api_params = {
                 environmentId: environment_id,
                 name: name,
+                resources: resources,
             }
 
             api_headers = {
@@ -180,7 +191,7 @@ module Appwrite
             end
 
             api_path = '/project/environments/{environmentId}'
-                .gsub('{environmentId}', environment_id)
+                .gsub('{environmentId}', @client.encode_path(environment_id))
 
             api_params = {}
 
@@ -217,7 +228,7 @@ module Appwrite
             end
 
             api_path = '/project/environments/{environmentId}'
-                .gsub('{environmentId}', environment_id)
+                .gsub('{environmentId}', @client.encode_path(environment_id))
 
             api_params = {
                 name: name,
@@ -251,7 +262,7 @@ module Appwrite
             end
 
             api_path = '/project/environments/{environmentId}'
-                .gsub('{environmentId}', environment_id)
+                .gsub('{environmentId}', @client.encode_path(environment_id))
 
             api_params = {}
 
@@ -357,7 +368,7 @@ module Appwrite
             end
 
             api_path = '/project/keys/{keyId}'
-                .gsub('{keyId}', key_id)
+                .gsub('{keyId}', @client.encode_path(key_id))
 
             api_params = {}
 
@@ -405,7 +416,7 @@ module Appwrite
             end
 
             api_path = '/project/keys/{keyId}'
-                .gsub('{keyId}', key_id)
+                .gsub('{keyId}', @client.encode_path(key_id))
 
             api_params = {
                 name: name,
@@ -443,7 +454,7 @@ module Appwrite
             end
 
             api_path = '/project/keys/{keyId}'
-                .gsub('{keyId}', key_id)
+                .gsub('{keyId}', @client.encode_path(key_id))
 
             api_params = {}
 
@@ -582,7 +593,7 @@ module Appwrite
             end
 
             api_path = '/project/mock-phones/{number}'
-                .gsub('{number}', number)
+                .gsub('{number}', @client.encode_path(number))
 
             api_params = {}
 
@@ -620,7 +631,7 @@ module Appwrite
             end
 
             api_path = '/project/mock-phones/{number}'
-                .gsub('{number}', number)
+                .gsub('{number}', @client.encode_path(number))
 
             api_params = {
                 otp: otp,
@@ -655,7 +666,7 @@ module Appwrite
             end
 
             api_path = '/project/mock-phones/{number}'
-                .gsub('{number}', number)
+                .gsub('{number}', @client.encode_path(number))
 
             api_params = {}
 
@@ -2607,7 +2618,7 @@ module Appwrite
             end
 
             api_path = '/project/oauth2/{providerId}'
-                .gsub('{providerId}', provider_id)
+                .gsub('{providerId}', @client.encode_path(provider_id))
 
             api_params = {}
 
@@ -2972,7 +2983,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/android/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {
                 name: name,
@@ -3070,7 +3081,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/apple/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {
                 name: name,
@@ -3167,7 +3178,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/linux/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {
                 name: name,
@@ -3264,7 +3275,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/web/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {
                 name: name,
@@ -3361,7 +3372,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/windows/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {
                 name: name,
@@ -3397,7 +3408,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {}
 
@@ -3459,7 +3470,7 @@ module Appwrite
             end
 
             api_path = '/project/platforms/{platformId}'
-                .gsub('{platformId}', platform_id)
+                .gsub('{platformId}', @client.encode_path(platform_id))
 
             api_params = {}
 
@@ -3644,6 +3655,41 @@ module Appwrite
             )
         end
 
+        # Configures if guests, connections without a signed-in user, may subscribe
+        # to realtime channels. When enabled, a guest can still connect and sign in
+        # over the connection, but cannot subscribe until it does.
+        #
+        # @param [] enabled Set whether or not to stop guests from subscribing to realtime channels.
+        #
+        # @return [Project]
+        def update_deny_realtime_guests_policy(
+            enabled:
+        )
+            if enabled.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "enabled"')
+            end
+
+            api_path = '/project/policies/deny-realtime-guests'
+
+            api_params = {
+                enabled: enabled,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Project
+            )
+        end
+
         # Updating this policy allows you to control if team members can see other
         # members information. When enabled, all team members can see ID, name,
         # email, phone number, and MFA status of other members..
@@ -4201,9 +4247,9 @@ module Appwrite
         # Get a policy by its unique ID. This endpoint returns the current
         # configuration for the requested project policy.
         #
-        # @param [ProjectPolicyId] policy_id Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, password-rotation, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, passkey.
+        # @param [ProjectPolicyId] policy_id Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, password-rotation, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, deny-realtime-guests, passkey.
         #
-        # @return [PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicyPasswordPwned, PolicyPasswordRotation, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyMfaFactors, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail, PolicyDenyCorporateEmail, PolicyPasskey]
+        # @return [PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicyPasswordPwned, PolicyPasswordRotation, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyMfaFactors, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail, PolicyDenyCorporateEmail, PolicyDenyRealtimeGuests, PolicyPasskey]
         def get_policy(
             policy_id:
         )
@@ -4212,7 +4258,7 @@ module Appwrite
             end
 
             api_path = '/project/policies/{policyId}'
-                .gsub('{policyId}', policy_id)
+                .gsub('{policyId}', @client.encode_path(policy_id))
 
             api_params = {}
 
@@ -4317,6 +4363,11 @@ module Appwrite
                 return Models::PolicyDenyCorporateEmail.from(map: response)
             end
 
+            if response['$id'] == 'deny-realtime-guests'
+
+                return Models::PolicyDenyRealtimeGuests.from(map: response)
+            end
+
             if response['$id'] == 'passkey'
 
                 return Models::PolicyPasskey.from(map: response)
@@ -4345,7 +4396,7 @@ module Appwrite
             end
 
             api_path = '/project/protocols/{protocolId}'
-                .gsub('{protocolId}', protocol_id)
+                .gsub('{protocolId}', @client.encode_path(protocol_id))
 
             api_params = {
                 enabled: enabled,
@@ -4386,7 +4437,7 @@ module Appwrite
             end
 
             api_path = '/project/services/{serviceId}'
-                .gsub('{serviceId}', service_id)
+                .gsub('{serviceId}', @client.encode_path(service_id))
 
             api_params = {
                 enabled: enabled,
@@ -4407,6 +4458,32 @@ module Appwrite
             )
         end
 
+        # Delete all sessions in the project. Any session created before this request
+        # will be invalidated immediately: users will be signed out of every active
+        # client (web, mobile, server SDKs, JWTs), and will be able to sign in again
+        # afterwards. API keys are not affected by this action.
+        #
+        #
+        # @return []
+        def delete_sessions()
+            api_path = '/project/sessions'
+
+            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
+
         # Update the SMTP configuration for your project. Use this endpoint to
         # configure your project's SMTP provider with your custom settings for
         # sending transactional emails.
@@ -4602,7 +4679,7 @@ module Appwrite
             end
 
             api_path = '/project/templates/email/{templateId}'
-                .gsub('{templateId}', template_id)
+                .gsub('{templateId}', @client.encode_path(template_id))
 
             api_params = {
                 locale: locale,
@@ -4720,7 +4797,7 @@ module Appwrite
             end
 
             api_path = '/project/variables/{variableId}'
-                .gsub('{variableId}', variable_id)
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}
 
@@ -4759,7 +4836,7 @@ module Appwrite
             end
 
             api_path = '/project/variables/{variableId}'
-                .gsub('{variableId}', variable_id)
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {
                 key: key,
@@ -4796,7 +4873,7 @@ module Appwrite
             end
 
             api_path = '/project/variables/{variableId}'
-                .gsub('{variableId}', variable_id)
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}
 

data/lib/appwrite/services/proxy.rb

@@ -337,7 +337,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 
@@ -368,7 +368,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 
@@ -402,7 +402,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}/status'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 

data/lib/appwrite/services/sites.rb

@@ -65,7 +65,7 @@ module Appwrite
         # @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 site deployments.
         # @param [String] runtime_specification Runtime specification for the SSR executions.
-        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 keeps all deployments unless the server applies a default retention.
         # @param [Array] scopes List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
         # @param [String] description Optional description for the site.
         #
@@ -231,7 +231,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {}
 
@@ -273,7 +273,7 @@ module Appwrite
         # @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 site deployments.
         # @param [String] runtime_specification Runtime specification for the SSR executions.
-        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 keeps all deployments unless the server applies a default retention.
         # @param [Array] scopes List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
         # @param [String] description Optional description for the site.
         #
@@ -318,7 +318,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 name: name,
@@ -375,7 +375,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {}
 
@@ -413,7 +413,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployment'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 deploymentId: deployment_id,
@@ -454,7 +454,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -506,7 +506,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 installCommand: install_command,
@@ -560,7 +560,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/duplicate'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 deploymentId: deployment_id,
@@ -630,7 +630,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/template'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 repository: repository,
@@ -685,7 +685,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/vcs'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 type: type,
@@ -727,8 +727,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -765,8 +765,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -809,8 +809,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}/download'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {
                 type: type,
@@ -853,8 +853,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}/status'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -891,7 +891,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -931,8 +931,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{logId}', @client.encode_path(log_id))
 
             api_params = {}
 
@@ -969,8 +969,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{logId}', @client.encode_path(log_id))
 
             api_params = {}
 
@@ -1005,7 +1005,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -1062,7 +1062,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 variableId: variable_id,
@@ -1106,8 +1106,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}
 
@@ -1152,8 +1152,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {
                 key: key,
@@ -1196,8 +1196,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}