appwrite 15.1.0.pre.rc.1 → 16.1.0

data/lib/appwrite/models/resource_token_list.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class ResourceTokenList
+            attr_reader :total
+            attr_reader :tokens
+
+            def initialize(
+                total:,
+                tokens:
+            )
+                @total = total
+                @tokens = tokens
+            end
+
+            def self.from(map:)
+                ResourceTokenList.new(
+                    total: map["total"],
+                    tokens: map["tokens"].map { |it| ResourceToken.from(map: it) }
+                )
+            end
+
+            def to_map
+                {
+                    "total": @total,
+                    "tokens": @tokens.map { |it| it.to_map }
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/site.rb

@@ -0,0 +1,167 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Site
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :name
+            attr_reader :enabled
+            attr_reader :live
+            attr_reader :logging
+            attr_reader :framework
+            attr_reader :deployment_id
+            attr_reader :deployment_created_at
+            attr_reader :deployment_screenshot_light
+            attr_reader :deployment_screenshot_dark
+            attr_reader :latest_deployment_id
+            attr_reader :latest_deployment_created_at
+            attr_reader :latest_deployment_status
+            attr_reader :vars
+            attr_reader :timeout
+            attr_reader :install_command
+            attr_reader :build_command
+            attr_reader :output_directory
+            attr_reader :installation_id
+            attr_reader :provider_repository_id
+            attr_reader :provider_branch
+            attr_reader :provider_root_directory
+            attr_reader :provider_silent_mode
+            attr_reader :specification
+            attr_reader :build_runtime
+            attr_reader :adapter
+            attr_reader :fallback_file
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                name:,
+                enabled:,
+                live:,
+                logging:,
+                framework:,
+                deployment_id:,
+                deployment_created_at:,
+                deployment_screenshot_light:,
+                deployment_screenshot_dark:,
+                latest_deployment_id:,
+                latest_deployment_created_at:,
+                latest_deployment_status:,
+                vars:,
+                timeout:,
+                install_command:,
+                build_command:,
+                output_directory:,
+                installation_id:,
+                provider_repository_id:,
+                provider_branch:,
+                provider_root_directory:,
+                provider_silent_mode:,
+                specification:,
+                build_runtime:,
+                adapter:,
+                fallback_file:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @name = name
+                @enabled = enabled
+                @live = live
+                @logging = logging
+                @framework = framework
+                @deployment_id = deployment_id
+                @deployment_created_at = deployment_created_at
+                @deployment_screenshot_light = deployment_screenshot_light
+                @deployment_screenshot_dark = deployment_screenshot_dark
+                @latest_deployment_id = latest_deployment_id
+                @latest_deployment_created_at = latest_deployment_created_at
+                @latest_deployment_status = latest_deployment_status
+                @vars = vars
+                @timeout = timeout
+                @install_command = install_command
+                @build_command = build_command
+                @output_directory = output_directory
+                @installation_id = installation_id
+                @provider_repository_id = provider_repository_id
+                @provider_branch = provider_branch
+                @provider_root_directory = provider_root_directory
+                @provider_silent_mode = provider_silent_mode
+                @specification = specification
+                @build_runtime = build_runtime
+                @adapter = adapter
+                @fallback_file = fallback_file
+            end
+
+            def self.from(map:)
+                Site.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    name: map["name"],
+                    enabled: map["enabled"],
+                    live: map["live"],
+                    logging: map["logging"],
+                    framework: map["framework"],
+                    deployment_id: map["deploymentId"],
+                    deployment_created_at: map["deploymentCreatedAt"],
+                    deployment_screenshot_light: map["deploymentScreenshotLight"],
+                    deployment_screenshot_dark: map["deploymentScreenshotDark"],
+                    latest_deployment_id: map["latestDeploymentId"],
+                    latest_deployment_created_at: map["latestDeploymentCreatedAt"],
+                    latest_deployment_status: map["latestDeploymentStatus"],
+                    vars: map["vars"].map { |it| Variable.from(map: it) },
+                    timeout: map["timeout"],
+                    install_command: map["installCommand"],
+                    build_command: map["buildCommand"],
+                    output_directory: map["outputDirectory"],
+                    installation_id: map["installationId"],
+                    provider_repository_id: map["providerRepositoryId"],
+                    provider_branch: map["providerBranch"],
+                    provider_root_directory: map["providerRootDirectory"],
+                    provider_silent_mode: map["providerSilentMode"],
+                    specification: map["specification"],
+                    build_runtime: map["buildRuntime"],
+                    adapter: map["adapter"],
+                    fallback_file: map["fallbackFile"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "name": @name,
+                    "enabled": @enabled,
+                    "live": @live,
+                    "logging": @logging,
+                    "framework": @framework,
+                    "deploymentId": @deployment_id,
+                    "deploymentCreatedAt": @deployment_created_at,
+                    "deploymentScreenshotLight": @deployment_screenshot_light,
+                    "deploymentScreenshotDark": @deployment_screenshot_dark,
+                    "latestDeploymentId": @latest_deployment_id,
+                    "latestDeploymentCreatedAt": @latest_deployment_created_at,
+                    "latestDeploymentStatus": @latest_deployment_status,
+                    "vars": @vars.map { |it| it.to_map },
+                    "timeout": @timeout,
+                    "installCommand": @install_command,
+                    "buildCommand": @build_command,
+                    "outputDirectory": @output_directory,
+                    "installationId": @installation_id,
+                    "providerRepositoryId": @provider_repository_id,
+                    "providerBranch": @provider_branch,
+                    "providerRootDirectory": @provider_root_directory,
+                    "providerSilentMode": @provider_silent_mode,
+                    "specification": @specification,
+                    "buildRuntime": @build_runtime,
+                    "adapter": @adapter,
+                    "fallbackFile": @fallback_file
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/site_list.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class SiteList
+            attr_reader :total
+            attr_reader :sites
+
+            def initialize(
+                total:,
+                sites:
+            )
+                @total = total
+                @sites = sites
+            end
+
+            def self.from(map:)
+                SiteList.new(
+                    total: map["total"],
+                    sites: map["sites"].map { |it| Site.from(map: it) }
+                )
+            end
+
+            def to_map
+                {
+                    "total": @total,
+                    "sites": @sites.map { |it| it.to_map }
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/variable.rb

@@ -8,6 +8,7 @@ module Appwrite
             attr_reader :updated_at
             attr_reader :key
             attr_reader :value
+            attr_reader :secret
             attr_reader :resource_type
             attr_reader :resource_id
 
@@ -17,6 +18,7 @@ module Appwrite
                 updated_at:,
                 key:,
                 value:,
+                secret:,
                 resource_type:,
                 resource_id:
             )
@@ -25,6 +27,7 @@ module Appwrite
                 @updated_at = updated_at
                 @key = key
                 @value = value
+                @secret = secret
                 @resource_type = resource_type
                 @resource_id = resource_id
             end
@@ -36,6 +39,7 @@ module Appwrite
                     updated_at: map["$updatedAt"],
                     key: map["key"],
                     value: map["value"],
+                    secret: map["secret"],
                     resource_type: map["resourceType"],
                     resource_id: map["resourceId"]
                 )
@@ -48,6 +52,7 @@ module Appwrite
                     "$updatedAt": @updated_at,
                     "key": @key,
                     "value": @value,
+                    "secret": @secret,
                     "resourceType": @resource_type,
                     "resourceId": @resource_id
                 }

data/lib/appwrite/services/avatars.rb

@@ -21,7 +21,7 @@ module Appwrite
         # @param [Browser] code Browser Code.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
-        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
         #
         # @return []
         def get_browser(code:, width: nil, height: nil, quality: nil)
@@ -63,7 +63,7 @@ module Appwrite
         # @param [CreditCard] code Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
-        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
         #
         # @return []
         def get_credit_card(code:, width: nil, height: nil, quality: nil)
@@ -137,7 +137,7 @@ module Appwrite
         # @param [Flag] code Country Code. ISO Alpha-2 country code format.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
-        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
         #
         # @return []
         def get_flag(code:, width: nil, height: nil, quality: nil)

data/lib/appwrite/services/databases.rb

@@ -1729,11 +1729,14 @@ module Appwrite
         end
 
         
+        # **WARNING: Experimental Feature** - This endpoint is experimental and not
+        # yet officially supported. It may be subject to breaking changes or removal
+        # in future versions.
+        # 
         # Create new Documents. Before using this route, you should create a new
         # collection resource using either a [server
         # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
         # API or directly from your database console.
-        # 
         #
         # @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). Make sure to define attributes before creating documents.
@@ -1775,6 +1778,10 @@ module Appwrite
         end
 
         
+        # **WARNING: Experimental Feature** - This endpoint is experimental and not
+        # yet officially supported. It may be subject to breaking changes or removal
+        # in future versions.
+        # 
         # Create or update Documents. Before using this route, you should create a
         # new collection resource using either a [server
         # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
@@ -1786,7 +1793,7 @@ module Appwrite
         # @param [Array] documents Array of document data as JSON objects. May contain partial documents.
         #
         # @return [DocumentList]
-        def upsert_documents(database_id:, collection_id:, documents: nil)
+        def upsert_documents(database_id:, collection_id:, documents:)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -1799,6 +1806,10 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
             end
 
+            if documents.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "documents"')
+            end
+
             api_params = {
                 documents: documents,
             }
@@ -1817,6 +1828,10 @@ module Appwrite
         end
 
         
+        # **WARNING: Experimental Feature** - This endpoint is experimental and not
+        # yet officially supported. It may be subject to breaking changes or removal
+        # in future versions.
+        # 
         # Update all documents that match your queries, if no queries are submitted
         # then all documents are updated. You can pass only specific fields to be
         # updated.
@@ -1859,6 +1874,10 @@ module Appwrite
         end
 
         
+        # **WARNING: Experimental Feature** - This endpoint is experimental and not
+        # yet officially supported. It may be subject to breaking changes or removal
+        # in future versions.
+        # 
         # Bulk delete documents using queries, if no queries are passed then all
         # documents are deleted.
         #
@@ -1942,6 +1961,63 @@ module Appwrite
         end
 
         
+        # **WARNING: Experimental Feature** - This endpoint is experimental and not
+        # yet officially supported. It may be subject to breaking changes or removal
+        # in future versions.
+        # 
+        # Create or update a Document. Before using this route, you should create a
+        # new collection resource using either a [server
+        # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+        # API or directly from your database console.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] document_id Document ID.
+        # @param [Hash] data Document data as JSON object. Include all required attributes of the document to be created or updated.
+        # @param [Array] permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        #
+        # @return [Document]
+        def upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+                .gsub('{documentId}', document_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if collection_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
+            end
+
+            if document_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "documentId"')
+            end
+
+            if data.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "data"')
+            end
+
+            api_params = {
+                data: data,
+                permissions: permissions,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Document
+            )
+        end
+
+        
         # Update a document by its unique ID. Using the patch method you can pass
         # only specific fields that will get updated.
         #
@@ -2030,6 +2106,110 @@ module Appwrite
         end
 
         
+        # Decrement a specific attribute of a document by a given value.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] document_id Document ID.
+        # @param [String] attribute Attribute key.
+        # @param [Float] value Value to decrement the attribute by. The value must be a number.
+        # @param [Float] min Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.
+        #
+        # @return [Document]
+        def decrement_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, min: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+                .gsub('{documentId}', document_id)
+                .gsub('{attribute}', attribute)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if collection_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
+            end
+
+            if document_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "documentId"')
+            end
+
+            if attribute.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "attribute"')
+            end
+
+            api_params = {
+                value: value,
+                min: min,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Document
+            )
+        end
+
+        
+        # Increment a specific attribute of a document by a given value.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] document_id Document ID.
+        # @param [String] attribute Attribute key.
+        # @param [Float] value Value to increment the attribute by. The value must be a number.
+        # @param [Float] max Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.
+        #
+        # @return [Document]
+        def increment_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, max: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+                .gsub('{documentId}', document_id)
+                .gsub('{attribute}', attribute)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if collection_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
+            end
+
+            if document_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "documentId"')
+            end
+
+            if attribute.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "attribute"')
+            end
+
+            api_params = {
+                value: value,
+                max: max,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Document
+            )
+        end
+
+        
         # List indexes in the collection.
         #
         # @param [String] database_id Database ID.
@@ -2077,9 +2257,10 @@ module Appwrite
         # @param [IndexType] type Index type.
         # @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
         # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
+        # @param [Array] lengths Length of index. Maximum of 100
         #
         # @return [Index]
-        def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil)
+        def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil, lengths: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/indexes'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2109,6 +2290,7 @@ module Appwrite
                 type: type,
                 attributes: attributes,
                 orders: orders,
+                lengths: lengths,
             }
             
             api_headers = {