appwrite 19.2.1 → 20.0.0

data/lib/appwrite/operator.rb

@@ -0,0 +1,145 @@
+require 'json'
+
+module Appwrite
+    module Condition
+        EQUAL = "equal"
+        NOT_EQUAL = "notEqual"
+        GREATER_THAN = "greaterThan"
+        GREATER_THAN_EQUAL = "greaterThanEqual"
+        LESS_THAN = "lessThan"
+        LESS_THAN_EQUAL = "lessThanEqual"
+        CONTAINS = "contains"
+        IS_NULL = "isNull"
+        IS_NOT_NULL = "isNotNull"
+    end
+
+    class Operator
+        def initialize(method, values = nil)
+            @method = method
+
+            if values != nil
+                if values.is_a?(Array)
+                    @values = values
+                else
+                    @values = [values]
+                end
+            end
+        end
+
+        def to_json(*args)
+            result = { method: @method }
+            result[:values] = @values unless @values.nil?
+            result.to_json(*args)
+        end
+
+        def to_s
+            return self.to_json
+        end
+
+        class << Operator
+            def increment(value = 1, max = nil)
+                raise ArgumentError, "Value cannot be NaN or Infinity" if value.respond_to?(:nan?) && (value.nan? || value.infinite?)
+                raise ArgumentError, "Max cannot be NaN or Infinity" if max != nil && max.respond_to?(:nan?) && (max.nan? || max.infinite?)
+                values = [value]
+                values << max if max != nil
+                return Operator.new("increment", values).to_s
+            end
+
+            def decrement(value = 1, min = nil)
+                raise ArgumentError, "Value cannot be NaN or Infinity" if value.respond_to?(:nan?) && (value.nan? || value.infinite?)
+                raise ArgumentError, "Min cannot be NaN or Infinity" if min != nil && min.respond_to?(:nan?) && (min.nan? || min.infinite?)
+                values = [value]
+                values << min if min != nil
+                return Operator.new("decrement", values).to_s
+            end
+
+            def multiply(factor, max = nil)
+                raise ArgumentError, "Factor cannot be NaN or Infinity" if factor.respond_to?(:nan?) && (factor.nan? || factor.infinite?)
+                raise ArgumentError, "Max cannot be NaN or Infinity" if max != nil && max.respond_to?(:nan?) && (max.nan? || max.infinite?)
+                values = [factor]
+                values << max if max != nil
+                return Operator.new("multiply", values).to_s
+            end
+
+            def divide(divisor, min = nil)
+                raise ArgumentError, "Divisor cannot be NaN or Infinity" if divisor.respond_to?(:nan?) && (divisor.nan? || divisor.infinite?)
+                raise ArgumentError, "Min cannot be NaN or Infinity" if min != nil && min.respond_to?(:nan?) && (min.nan? || min.infinite?)
+                raise ArgumentError, "Divisor cannot be zero" if divisor == 0 || divisor == 0.0
+                values = [divisor]
+                values << min if min != nil
+                return Operator.new("divide", values).to_s
+            end
+
+            def modulo(divisor)
+                raise ArgumentError, "Divisor cannot be NaN or Infinity" if divisor.respond_to?(:nan?) && (divisor.nan? || divisor.infinite?)
+                raise ArgumentError, "Divisor cannot be zero" if divisor == 0 || divisor == 0.0
+                return Operator.new("modulo", [divisor]).to_s
+            end
+
+            def power(exponent, max = nil)
+                raise ArgumentError, "Exponent cannot be NaN or Infinity" if exponent.respond_to?(:nan?) && (exponent.nan? || exponent.infinite?)
+                raise ArgumentError, "Max cannot be NaN or Infinity" if max != nil && max.respond_to?(:nan?) && (max.nan? || max.infinite?)
+                values = [exponent]
+                values << max if max != nil
+                return Operator.new("power", values).to_s
+            end
+
+            def array_append(values)
+                return Operator.new("arrayAppend", values).to_s
+            end
+
+            def array_prepend(values)
+                return Operator.new("arrayPrepend", values).to_s
+            end
+
+            def array_insert(index, value)
+                return Operator.new("arrayInsert", [index, value]).to_s
+            end
+
+            def array_remove(value)
+                return Operator.new("arrayRemove", [value]).to_s
+            end
+
+            def array_unique()
+                return Operator.new("arrayUnique", []).to_s
+            end
+
+            def array_intersect(values)
+                return Operator.new("arrayIntersect", values).to_s
+            end
+
+            def array_diff(values)
+                return Operator.new("arrayDiff", values).to_s
+            end
+
+            def array_filter(condition, value = nil)
+                values = [condition, value]
+                return Operator.new("arrayFilter", values).to_s
+            end
+
+            def string_concat(value)
+                return Operator.new("stringConcat", [value]).to_s
+            end
+
+            def string_replace(search, replace)
+                return Operator.new("stringReplace", [search, replace]).to_s
+            end
+
+            def toggle()
+                return Operator.new("toggle", []).to_s
+            end
+
+            def date_add_days(days)
+                return Operator.new("dateAddDays", [days]).to_s
+            end
+
+            def date_sub_days(days)
+                return Operator.new("dateSubDays", [days]).to_s
+            end
+
+            def date_set_now()
+                return Operator.new("dateSetNow", []).to_s
+            end
+        end
+    end
+end

data/lib/appwrite/query.rb

@@ -133,27 +133,27 @@ module Appwrite
             end
 
             def created_before(value)
-                return Query.new("createdBefore", nil, value).to_s
+                return less_than("$createdAt", value)
             end
 
             def created_after(value)
-                return Query.new("createdAfter", nil, value).to_s
+                return greater_than("$createdAt", value)
             end
 
             def created_between(start, ending)
-                return Query.new("createdBetween", nil, [start, ending]).to_s
+                return between("$createdAt", start, ending)
             end
 
             def updated_before(value)
-                return Query.new("updatedBefore", nil, value).to_s
+                return less_than("$updatedAt", value)
             end
 
             def updated_after(value)
-                return Query.new("updatedAfter", nil, value).to_s
+                return greater_than("$updatedAt", value)
             end
 
             def updated_between(start, ending)
-                return Query.new("updatedBetween", nil, [start, ending]).to_s
+                return between("$updatedAt", start, ending)
             end
 
             def or(queries)

data/lib/appwrite/services/account.rb

@@ -123,13 +123,15 @@ module Appwrite
         # Get the list of identities for the currently logged in user.
         #
         # @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, provider, providerUid, providerEmail, providerAccessTokenExpiry
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [IdentityList]
-        def list_identities(queries: nil)
+        def list_identities(queries: nil, total: nil)
             api_path = '/account/identities'
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -203,13 +205,15 @@ module Appwrite
         # user. Each log returns user IP address, location and date and time of log.
         #
         # @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). Only supported methods are limit and offset
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [LogList]
-        def list_logs(queries: nil)
+        def list_logs(queries: nil, total: nil)
             api_path = '/account/logs'
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -358,7 +362,7 @@ module Appwrite
         #
         # @return [MfaChallenge]
         def create_mfa_challenge(factor:)
-            api_path = '/account/mfa/challenge'
+            api_path = '/account/mfa/challenges'
 
             if factor.nil?
               raise Appwrite::Exception.new('Missing required parameter: "factor"')
@@ -392,7 +396,7 @@ module Appwrite
         #
         # @return [Session]
         def update_mfa_challenge(challenge_id:, otp:)
-            api_path = '/account/mfa/challenge'
+            api_path = '/account/mfa/challenges'
 
             if challenge_id.nil?
               raise Appwrite::Exception.new('Missing required parameter: "challengeId"')

data/lib/appwrite/services/avatars.rb

@@ -282,5 +282,79 @@ module Appwrite
             )
         end
 
+        # Use this endpoint to capture a screenshot of any website URL. This endpoint
+        # uses a headless browser to render the webpage and capture it as an image.
+        # 
+        # You can configure the browser viewport size, theme, user agent,
+        # geolocation, permissions, and more. Capture either just the viewport or the
+        # full page scroll.
+        # 
+        # When width and height are specified, the image is resized accordingly. If
+        # both dimensions are 0, the API provides an image at original size. If
+        # dimensions are not specified, the default viewport size is 1280x720px.
+        #
+        # @param [String] url Website URL which you want to capture.
+        # @param [Hash] headers HTTP headers to send with the browser request. Defaults to empty.
+        # @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 [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.
+        # @param [Timezone] timezone IANA timezone identifier (e.g., "America/New_York", "Europe/London"). Defaults to browser default.
+        # @param [Float] latitude Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
+        # @param [Float] longitude Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
+        # @param [Float] accuracy Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
+        # @param [] touch Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
+        # @param [Array] permissions Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
+        # @param [Integer] sleep Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
+        # @param [Integer] width Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
+        # @param [Integer] height Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
+        # @param [Integer] quality Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+        # @param [Output] output Output format type (jpeg, jpg, png, gif and webp).
+        #
+        # @return []
+        def get_screenshot(url:, headers: nil, viewport_width: nil, viewport_height: nil, scale: nil, theme: nil, user_agent: nil, fullpage: nil, locale: nil, timezone: nil, latitude: nil, longitude: nil, accuracy: nil, touch: nil, permissions: nil, sleep: nil, width: nil, height: nil, quality: nil, output: nil)
+            api_path = '/avatars/screenshots'
+
+            if url.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "url"')
+            end
+
+            api_params = {
+                url: url,
+                headers: headers,
+                viewportWidth: viewport_width,
+                viewportHeight: viewport_height,
+                scale: scale,
+                theme: theme,
+                userAgent: user_agent,
+                fullpage: fullpage,
+                locale: locale,
+                timezone: timezone,
+                latitude: latitude,
+                longitude: longitude,
+                accuracy: accuracy,
+                touch: touch,
+                permissions: permissions,
+                sleep: sleep,
+                width: width,
+                height: height,
+                quality: quality,
+                output: output,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        end
+
     end 
 end

data/lib/appwrite/services/databases.rb

@@ -15,14 +15,16 @@ module Appwrite
         #
         # @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
         # @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 [DatabaseList]
-        def list(queries: nil, search: nil)
+        def list(queries: nil, search: nil, total: nil)
             api_path = '/databases'
 
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -360,9 +362,10 @@ module Appwrite
         # @param [String] database_id Database 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: name, enabled, documentSecurity
         # @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 [CollectionList]
-        def list_collections(database_id:, queries: nil, search: nil)
+        def list_collections(database_id:, queries: nil, search: nil, total: nil)
             api_path = '/databases/{databaseId}/collections'
                 .gsub('{databaseId}', database_id)
 
@@ -373,6 +376,7 @@ module Appwrite
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -574,9 +578,10 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection 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: key, type, size, required, array, status, error
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [AttributeList]
-        def list_attributes(database_id:, collection_id:, queries: nil)
+        def list_attributes(database_id:, collection_id:, queries: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/attributes'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -591,6 +596,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -2204,9 +2210,10 @@ module Appwrite
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
         # @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.
         # @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [DocumentList]
-        def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil)
+        def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2222,6 +2229,7 @@ module Appwrite
             api_params = {
                 queries: queries,
                 transactionId: transaction_id,
+                total: total,
             }
             
             api_headers = {
@@ -2802,9 +2810,10 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
         # @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: key, type, status, attributes, error
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [IndexList]
-        def list_indexes(database_id:, collection_id:, queries: nil)
+        def list_indexes(database_id:, collection_id:, queries: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/indexes'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2819,6 +2828,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {

data/lib/appwrite/services/functions.rb

@@ -12,14 +12,16 @@ module Appwrite
         #
         # @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, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
         # @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 [FunctionList]
-        def list(queries: nil, search: nil)
+        def list(queries: nil, search: nil, total: nil)
             api_path = '/functions'
 
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -317,9 +319,10 @@ module Appwrite
         # @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: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
         # @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 [DeploymentList]
-        def list_deployments(function_id:, queries: nil, search: nil)
+        def list_deployments(function_id:, queries: nil, search: nil, total: nil)
             api_path = '/functions/{functionId}/deployments'
                 .gsub('{functionId}', function_id)
 
@@ -330,6 +333,7 @@ module Appwrite
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -454,11 +458,12 @@ module Appwrite
         # @param [String] repository Repository name of the template.
         # @param [String] owner The name of the owner of the template.
         # @param [String] root_directory Path to function code in the template repo.
-        # @param [String] version Version (tag) for the repo linked to the function template.
+        # @param [TemplateReferenceType] type Type for the reference provided. Can be commit, branch, or tag
+        # @param [String] reference Reference value, can be a commit hash, branch name, or release tag
         # @param [] activate Automatically activate the deployment when it is finished building.
         #
         # @return [Deployment]
-        def create_template_deployment(function_id:, repository:, owner:, root_directory:, version:, activate: nil)
+        def create_template_deployment(function_id:, repository:, owner:, root_directory:, type:, reference:, activate: nil)
             api_path = '/functions/{functionId}/deployments/template'
                 .gsub('{functionId}', function_id)
 
@@ -478,15 +483,20 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "rootDirectory"')
             end
 
-            if version.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "version"')
+            if type.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "type"')
+            end
+
+            if reference.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "reference"')
             end
 
             api_params = {
                 repository: repository,
                 owner: owner,
                 rootDirectory: root_directory,
-                version: version,
+                type: type,
+                reference: reference,
                 activate: activate,
             }
             
@@ -508,7 +518,7 @@ module Appwrite
         # This endpoint lets you create deployment from a branch, commit, or a tag.
         #
         # @param [String] function_id Function ID.
-        # @param [VCSDeploymentType] type Type of reference passed. Allowed values are: branch, commit
+        # @param [VCSReferenceType] type Type of reference passed. Allowed values are: branch, commit
         # @param [String] reference VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
         # @param [] activate Automatically activate the deployment when it is finished building.
         #
@@ -697,9 +707,10 @@ module Appwrite
         #
         # @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, requestMethod, requestPath, deploymentId
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [ExecutionList]
-        def list_executions(function_id:, queries: nil)
+        def list_executions(function_id:, queries: nil, total: nil)
             api_path = '/functions/{functionId}/executions'
                 .gsub('{functionId}', function_id)
 
@@ -709,6 +720,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {