appwrite 22.0.0 → 23.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4a3d1bf31ce4e73601bc346a1e2d1607cc7660dab949aa3d7cdac1c5072901
-  data.tar.gz: ce5739e6bdaa5f4a39c0d29153772395ad51dd53fcedea2114eff17f14fe2d67
+  metadata.gz: dd02865d4592c504a324c79a3ccea59c0ba3313fe92900258c345a04111e42be
+  data.tar.gz: c2e32abf40d1d34cbddbfeb2b4d18cafae12078099415b4fb3187ab446ba104e
 SHA512:
-  metadata.gz: 0db71f51932537771194fc8595e4093ab39c694c57e3fe8672c785d8160b1899f94d2b253be40b0e808708edb3c460a6ba023f21fee1c94d181836f2502d80f5
-  data.tar.gz: 22a815abefa4ed7cd85442cf03c01fa5cae995f3e53b91f05bf4f87982bd318f6f18b0b79b24194fd8569858c26bb0455decc79d01121164bd005df0b79cdf4f
+  metadata.gz: 43bc24286c2b16dc259a75ad951582904b362f5b82f78ad4dceaf5f886012dec71dd3f598637bd30dd4be279ada8db43ad9ab0a32731c95c7b9ead639490d099
+  data.tar.gz: 9ca861d212fcdf5471ef71026337e447dd33025111e0693bb0b48b1e17b71a06bc78fd670b4d3fe91fac6d339975a20c289fec4f2c37515c3f23e6359fe8534d

data/lib/appwrite/client.rb

@@ -15,8 +15,8 @@ module Appwrite
                 'x-sdk-name'=> 'Ruby',
                 'x-sdk-platform'=> 'server',
                 'x-sdk-language'=> 'ruby',
-                'x-sdk-version'=> '22.0.0',
-                'X-Appwrite-Response-Format' => '1.9.0'
+                'x-sdk-version'=> '23.1.0',
+                'X-Appwrite-Response-Format' => '1.9.4'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
         end
@@ -97,6 +97,32 @@ module Appwrite
             self
         end
 
+        # Set DevKey
+        #
+        # Your secret dev API key
+        #
+        # @param [String] value The value to set for the DevKey header
+        #
+        # @return [self]
+        def set_dev_key(value)
+            add_header('x-appwrite-dev-key', value)
+
+            self
+        end
+
+        # Set Cookie
+        #
+        # The user cookie to authenticate with. Used by SDKs that forward an incoming Cookie header in server-side runtimes.
+        #
+        # @param [String] value The value to set for the Cookie header
+        #
+        # @return [self]
+        def set_cookie(value)
+            add_header('cookie', value)
+
+            self
+        end
+
         # Set ImpersonateUserId
         #
         # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
@@ -174,6 +200,13 @@ module Appwrite
             self
         end
 
+        # Get request headers
+        #
+        # @return [Hash]
+        def get_headers
+            @headers.dup
+        end
+
         # Send the HTTP request.
         #
         # @param [String] method The HTTP method for the request

data/lib/appwrite/enums/auth_method.rb

@@ -0,0 +1,13 @@
+module Appwrite
+    module Enums
+        module AuthMethod
+            EMAIL_PASSWORD = 'email-password'
+            MAGIC_URL = 'magic-url'
+            EMAIL_OTP = 'email-otp'
+            ANONYMOUS = 'anonymous'
+            INVITES = 'invites'
+            JWT = 'jwt'
+            PHONE = 'phone'
+        end
+    end
+end

data/lib/appwrite/enums/build_runtime.rb

@@ -49,6 +49,7 @@ module Appwrite
             DART_3_8 = 'dart-3.8'
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
+            DART_3_11 = 'dart-3.11'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -80,6 +81,7 @@ module Appwrite
             GO_1_24 = 'go-1.24'
             GO_1_25 = 'go-1.25'
             GO_1_26 = 'go-1.26'
+            RUST_1_83 = 'rust-1.83'
             STATIC_1 = 'static-1'
             FLUTTER_3_24 = 'flutter-3.24'
             FLUTTER_3_27 = 'flutter-3.27'
@@ -87,6 +89,7 @@ module Appwrite
             FLUTTER_3_32 = 'flutter-3.32'
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
+            FLUTTER_3_41 = 'flutter-3.41'
         end
     end
 end

data/lib/appwrite/enums/email_template_locale.rb

@@ -0,0 +1,137 @@
+module Appwrite
+    module Enums
+        module EmailTemplateLocale
+            AF = 'af'
+            AR_AE = 'ar-ae'
+            AR_BH = 'ar-bh'
+            AR_DZ = 'ar-dz'
+            AR_EG = 'ar-eg'
+            AR_IQ = 'ar-iq'
+            AR_JO = 'ar-jo'
+            AR_KW = 'ar-kw'
+            AR_LB = 'ar-lb'
+            AR_LY = 'ar-ly'
+            AR_MA = 'ar-ma'
+            AR_OM = 'ar-om'
+            AR_QA = 'ar-qa'
+            AR_SA = 'ar-sa'
+            AR_SY = 'ar-sy'
+            AR_TN = 'ar-tn'
+            AR_YE = 'ar-ye'
+            AS = 'as'
+            AZ = 'az'
+            BE = 'be'
+            BG = 'bg'
+            BH = 'bh'
+            BN = 'bn'
+            BS = 'bs'
+            CA = 'ca'
+            CS = 'cs'
+            CY = 'cy'
+            DA = 'da'
+            DE = 'de'
+            DE_AT = 'de-at'
+            DE_CH = 'de-ch'
+            DE_LI = 'de-li'
+            DE_LU = 'de-lu'
+            EL = 'el'
+            EN = 'en'
+            EN_AU = 'en-au'
+            EN_BZ = 'en-bz'
+            EN_CA = 'en-ca'
+            EN_GB = 'en-gb'
+            EN_IE = 'en-ie'
+            EN_JM = 'en-jm'
+            EN_NZ = 'en-nz'
+            EN_TT = 'en-tt'
+            EN_US = 'en-us'
+            EN_ZA = 'en-za'
+            EO = 'eo'
+            ES = 'es'
+            ES_AR = 'es-ar'
+            ES_BO = 'es-bo'
+            ES_CL = 'es-cl'
+            ES_CO = 'es-co'
+            ES_CR = 'es-cr'
+            ES_DO = 'es-do'
+            ES_EC = 'es-ec'
+            ES_GT = 'es-gt'
+            ES_HN = 'es-hn'
+            ES_MX = 'es-mx'
+            ES_NI = 'es-ni'
+            ES_PA = 'es-pa'
+            ES_PE = 'es-pe'
+            ES_PR = 'es-pr'
+            ES_PY = 'es-py'
+            ES_SV = 'es-sv'
+            ES_UY = 'es-uy'
+            ES_VE = 'es-ve'
+            ET = 'et'
+            EU = 'eu'
+            FA = 'fa'
+            FI = 'fi'
+            FO = 'fo'
+            FR = 'fr'
+            FR_BE = 'fr-be'
+            FR_CA = 'fr-ca'
+            FR_CH = 'fr-ch'
+            FR_LU = 'fr-lu'
+            GA = 'ga'
+            GD = 'gd'
+            HE = 'he'
+            HI = 'hi'
+            HR = 'hr'
+            HU = 'hu'
+            ID = 'id'
+            IS = 'is'
+            IT = 'it'
+            IT_CH = 'it-ch'
+            JA = 'ja'
+            JI = 'ji'
+            KO = 'ko'
+            KU = 'ku'
+            LT = 'lt'
+            LV = 'lv'
+            MK = 'mk'
+            ML = 'ml'
+            MS = 'ms'
+            MT = 'mt'
+            NB = 'nb'
+            NE = 'ne'
+            NL = 'nl'
+            NL_BE = 'nl-be'
+            NN = 'nn'
+            NO = 'no'
+            PA = 'pa'
+            PL = 'pl'
+            PT = 'pt'
+            PT_BR = 'pt-br'
+            RM = 'rm'
+            RO = 'ro'
+            RO_MD = 'ro-md'
+            RU = 'ru'
+            RU_MD = 'ru-md'
+            SB = 'sb'
+            SK = 'sk'
+            SL = 'sl'
+            SQ = 'sq'
+            SR = 'sr'
+            SV = 'sv'
+            SV_FI = 'sv-fi'
+            TH = 'th'
+            TN = 'tn'
+            TR = 'tr'
+            TS = 'ts'
+            UA = 'ua'
+            UR = 'ur'
+            VE = 've'
+            VI = 'vi'
+            XH = 'xh'
+            ZH_CN = 'zh-cn'
+            ZH_HK = 'zh-hk'
+            ZH_SG = 'zh-sg'
+            ZH_TW = 'zh-tw'
+            ZU = 'zu'
+        end
+    end
+end

data/lib/appwrite/enums/email_template_type.rb

@@ -0,0 +1,13 @@
+module Appwrite
+    module Enums
+        module EmailTemplateType
+            VERIFICATION = 'verification'
+            MAGICSESSION = 'magicSession'
+            RECOVERY = 'recovery'
+            INVITATION = 'invitation'
+            MFACHALLENGE = 'mfaChallenge'
+            SESSIONALERT = 'sessionAlert'
+            OTPSESSION = 'otpSession'
+        end
+    end
+end

data/lib/appwrite/enums/o_auth_provider.rb

@@ -16,9 +16,12 @@ module Appwrite
             ETSY = 'etsy'
             FACEBOOK = 'facebook'
             FIGMA = 'figma'
+            FUSIONAUTH = 'fusionauth'
             GITHUB = 'github'
             GITLAB = 'gitlab'
             GOOGLE = 'google'
+            KEYCLOAK = 'keycloak'
+            KICK = 'kick'
             LINKEDIN = 'linkedin'
             MICROSOFT = 'microsoft'
             NOTION = 'notion'
@@ -35,11 +38,14 @@ module Appwrite
             TRADESHIFTBOX = 'tradeshiftBox'
             TWITCH = 'twitch'
             WORDPRESS = 'wordpress'
+            X = 'x'
             YAHOO = 'yahoo'
             YAMMER = 'yammer'
             YANDEX = 'yandex'
             ZOHO = 'zoho'
             ZOOM = 'zoom'
+            GITHUBIMAGINE = 'githubImagine'
+            GOOGLEIMAGINE = 'googleImagine'
         end
     end
 end

data/lib/appwrite/enums/platform_type.rb

@@ -0,0 +1,11 @@
+module Appwrite
+    module Enums
+        module PlatformType
+            WINDOWS = 'windows'
+            APPLE = 'apple'
+            ANDROID = 'android'
+            LINUX = 'linux'
+            WEB = 'web'
+        end
+    end
+end

data/lib/appwrite/enums/project_policy.rb

@@ -0,0 +1,15 @@
+module Appwrite
+    module Enums
+        module ProjectPolicy
+            PASSWORD_DICTIONARY = 'password-dictionary'
+            PASSWORD_HISTORY = 'password-history'
+            PASSWORD_PERSONAL_DATA = 'password-personal-data'
+            SESSION_ALERT = 'session-alert'
+            SESSION_DURATION = 'session-duration'
+            SESSION_INVALIDATION = 'session-invalidation'
+            SESSION_LIMIT = 'session-limit'
+            USER_LIMIT = 'user-limit'
+            MEMBERSHIP_PRIVACY = 'membership-privacy'
+        end
+    end
+end

data/lib/appwrite/enums/protocol_id.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module ProtocolId
+            REST = 'rest'
+            GRAPHQL = 'graphql'
+            WEBSOCKET = 'websocket'
+        end
+    end
+end

data/lib/appwrite/enums/proxy_resource_type.rb

@@ -0,0 +1,8 @@
+module Appwrite
+    module Enums
+        module ProxyResourceType
+            SITE = 'site'
+            FUNCTION = 'function'
+        end
+    end
+end

data/lib/appwrite/enums/proxy_rule_deployment_resource_type.rb

@@ -0,0 +1,8 @@
+module Appwrite
+    module Enums
+        module ProxyRuleDeploymentResourceType
+            FUNCTION = 'function'
+            SITE = 'site'
+        end
+    end
+end

data/lib/appwrite/enums/proxy_rule_status.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module ProxyRuleStatus
+            UNVERIFIED = 'unverified'
+            VERIFYING = 'verifying'
+            VERIFIED = 'verified'
+        end
+    end
+end

data/lib/appwrite/enums/runtime.rb

@@ -49,6 +49,7 @@ module Appwrite
             DART_3_8 = 'dart-3.8'
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
+            DART_3_11 = 'dart-3.11'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -80,6 +81,7 @@ module Appwrite
             GO_1_24 = 'go-1.24'
             GO_1_25 = 'go-1.25'
             GO_1_26 = 'go-1.26'
+            RUST_1_83 = 'rust-1.83'
             STATIC_1 = 'static-1'
             FLUTTER_3_24 = 'flutter-3.24'
             FLUTTER_3_27 = 'flutter-3.27'
@@ -87,6 +89,7 @@ module Appwrite
             FLUTTER_3_32 = 'flutter-3.32'
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
+            FLUTTER_3_41 = 'flutter-3.41'
         end
     end
 end

data/lib/appwrite/enums/scopes.rb

@@ -1,69 +1,86 @@
 module Appwrite
     module Enums
         module Scopes
-            SESSIONS_WRITE = 'sessions.write'
+            PROJECT_READ = 'project.read'
+            PROJECT_WRITE = 'project.write'
+            KEYS_READ = 'keys.read'
+            KEYS_WRITE = 'keys.write'
+            PLATFORMS_READ = 'platforms.read'
+            PLATFORMS_WRITE = 'platforms.write'
+            MOCKS_READ = 'mocks.read'
+            MOCKS_WRITE = 'mocks.write'
+            POLICIES_READ = 'policies.read'
+            POLICIES_WRITE = 'policies.write'
+            PROJECT_POLICIES_READ = 'project.policies.read'
+            PROJECT_POLICIES_WRITE = 'project.policies.write'
+            TEMPLATES_READ = 'templates.read'
+            TEMPLATES_WRITE = 'templates.write'
+            OAUTH2_READ = 'oauth2.read'
+            OAUTH2_WRITE = 'oauth2.write'
             USERS_READ = 'users.read'
             USERS_WRITE = 'users.write'
+            SESSIONS_READ = 'sessions.read'
+            SESSIONS_WRITE = 'sessions.write'
             TEAMS_READ = 'teams.read'
             TEAMS_WRITE = 'teams.write'
             DATABASES_READ = 'databases.read'
             DATABASES_WRITE = 'databases.write'
-            COLLECTIONS_READ = 'collections.read'
-            COLLECTIONS_WRITE = 'collections.write'
             TABLES_READ = 'tables.read'
             TABLES_WRITE = 'tables.write'
-            ATTRIBUTES_READ = 'attributes.read'
-            ATTRIBUTES_WRITE = 'attributes.write'
             COLUMNS_READ = 'columns.read'
             COLUMNS_WRITE = 'columns.write'
             INDEXES_READ = 'indexes.read'
             INDEXES_WRITE = 'indexes.write'
-            DOCUMENTS_READ = 'documents.read'
-            DOCUMENTS_WRITE = 'documents.write'
             ROWS_READ = 'rows.read'
             ROWS_WRITE = 'rows.write'
-            FILES_READ = 'files.read'
-            FILES_WRITE = 'files.write'
+            COLLECTIONS_READ = 'collections.read'
+            COLLECTIONS_WRITE = 'collections.write'
+            ATTRIBUTES_READ = 'attributes.read'
+            ATTRIBUTES_WRITE = 'attributes.write'
+            DOCUMENTS_READ = 'documents.read'
+            DOCUMENTS_WRITE = 'documents.write'
             BUCKETS_READ = 'buckets.read'
             BUCKETS_WRITE = 'buckets.write'
+            FILES_READ = 'files.read'
+            FILES_WRITE = 'files.write'
+            TOKENS_READ = 'tokens.read'
+            TOKENS_WRITE = 'tokens.write'
             FUNCTIONS_READ = 'functions.read'
             FUNCTIONS_WRITE = 'functions.write'
+            EXECUTIONS_READ = 'executions.read'
+            EXECUTIONS_WRITE = 'executions.write'
+            EXECUTION_READ = 'execution.read'
+            EXECUTION_WRITE = 'execution.write'
             SITES_READ = 'sites.read'
             SITES_WRITE = 'sites.write'
             LOG_READ = 'log.read'
             LOG_WRITE = 'log.write'
-            EXECUTION_READ = 'execution.read'
-            EXECUTION_WRITE = 'execution.write'
-            LOCALE_READ = 'locale.read'
-            AVATARS_READ = 'avatars.read'
-            HEALTH_READ = 'health.read'
             PROVIDERS_READ = 'providers.read'
             PROVIDERS_WRITE = 'providers.write'
-            MESSAGES_READ = 'messages.read'
-            MESSAGES_WRITE = 'messages.write'
             TOPICS_READ = 'topics.read'
             TOPICS_WRITE = 'topics.write'
             SUBSCRIBERS_READ = 'subscribers.read'
             SUBSCRIBERS_WRITE = 'subscribers.write'
             TARGETS_READ = 'targets.read'
             TARGETS_WRITE = 'targets.write'
+            MESSAGES_READ = 'messages.read'
+            MESSAGES_WRITE = 'messages.write'
             RULES_READ = 'rules.read'
             RULES_WRITE = 'rules.write'
-            SCHEDULES_READ = 'schedules.read'
-            SCHEDULES_WRITE = 'schedules.write'
+            WEBHOOKS_READ = 'webhooks.read'
+            WEBHOOKS_WRITE = 'webhooks.write'
+            LOCALE_READ = 'locale.read'
+            AVATARS_READ = 'avatars.read'
+            HEALTH_READ = 'health.read'
+            ASSISTANT_READ = 'assistant.read'
             MIGRATIONS_READ = 'migrations.read'
             MIGRATIONS_WRITE = 'migrations.write'
+            SCHEDULES_READ = 'schedules.read'
+            SCHEDULES_WRITE = 'schedules.write'
             VCS_READ = 'vcs.read'
             VCS_WRITE = 'vcs.write'
-            ASSISTANT_READ = 'assistant.read'
-            TOKENS_READ = 'tokens.read'
-            TOKENS_WRITE = 'tokens.write'
-            WEBHOOKS_READ = 'webhooks.read'
-            WEBHOOKS_WRITE = 'webhooks.write'
-            PROJECT_READ = 'project.read'
-            PROJECT_WRITE = 'project.write'
-            POLICIES_WRITE = 'policies.write'
-            POLICIES_READ = 'policies.read'
+            BACKUPS_POLICIES_READ = 'backups.policies.read'
+            BACKUPS_POLICIES_WRITE = 'backups.policies.write'
             ARCHIVES_READ = 'archives.read'
             ARCHIVES_WRITE = 'archives.write'
             RESTORATIONS_READ = 'restorations.read'

data/lib/appwrite/enums/secure.rb

@@ -0,0 +1,8 @@
+module Appwrite
+    module Enums
+        module Secure
+            TLS = 'tls'
+            SSL = 'ssl'
+        end
+    end
+end

data/lib/appwrite/enums/service_id.rb

@@ -0,0 +1,23 @@
+module Appwrite
+    module Enums
+        module ServiceId
+            ACCOUNT = 'account'
+            AVATARS = 'avatars'
+            DATABASES = 'databases'
+            TABLESDB = 'tablesdb'
+            LOCALE = 'locale'
+            HEALTH = 'health'
+            PROJECT = 'project'
+            STORAGE = 'storage'
+            TEAMS = 'teams'
+            USERS = 'users'
+            VCS = 'vcs'
+            SITES = 'sites'
+            FUNCTIONS = 'functions'
+            PROXY = 'proxy'
+            GRAPHQL = 'graphql'
+            MIGRATIONS = 'migrations'
+            MESSAGING = 'messaging'
+        end
+    end
+end

data/lib/appwrite/enums/status_code.rb

@@ -0,0 +1,10 @@
+module Appwrite
+    module Enums
+        module StatusCode
+            MOVED_PERMANENTLY_301 = '301'
+            FOUND_302 = '302'
+            TEMPORARY_REDIRECT_307 = '307'
+            PERMANENT_REDIRECT_308 = '308'
+        end
+    end
+end

data/lib/appwrite/models/attribute_bigint.rb

@@ -0,0 +1,96 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class AttributeBigint
+            attr_reader :key
+            attr_reader :type
+            attr_reader :status
+            attr_reader :error
+            attr_reader :required
+            attr_reader :array
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :min
+            attr_reader :max
+            attr_reader :default
+
+            def initialize(
+                key:,
+                type:,
+                status:,
+                error:,
+                required:,
+                array: ,
+                created_at:,
+                updated_at:,
+                min: ,
+                max: ,
+                default: 
+            )
+                @key = key
+                @type = type
+                @status = validate_status(status)
+                @error = error
+                @required = required
+                @array = array
+                @created_at = created_at
+                @updated_at = updated_at
+                @min = min
+                @max = max
+                @default = default
+            end
+
+            def self.from(map:)
+                AttributeBigint.new(
+                    key: map["key"],
+                    type: map["type"],
+                    status: map["status"],
+                    error: map["error"],
+                    required: map["required"],
+                    array: map["array"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    min: map["min"],
+                    max: map["max"],
+                    default: map["default"]
+                )
+            end
+
+            def to_map
+                {
+                    "key": @key,
+                    "type": @type,
+                    "status": @status,
+                    "error": @error,
+                    "required": @required,
+                    "array": @array,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "min": @min,
+                    "max": @max,
+                    "default": @default
+                }
+            end
+
+            private
+
+            def validate_status(status)
+                valid_status = [
+                    Appwrite::Enums::AttributeStatus::AVAILABLE,
+                    Appwrite::Enums::AttributeStatus::PROCESSING,
+                    Appwrite::Enums::AttributeStatus::DELETING,
+                    Appwrite::Enums::AttributeStatus::STUCK,
+                    Appwrite::Enums::AttributeStatus::FAILED,
+                ]
+
+                unless valid_status.include?(status)
+                    raise ArgumentError, "Invalid " + status + ". Must be one of: " + valid_status.join(', ')
+                end
+
+                status
+            end
+
+        end
+    end
+end