appwrite 28.3.2 → 29.0.0

data/lib/appwrite/services/avatars.rb

@@ -29,13 +29,13 @@ module Appwrite
             height: nil,
             quality: nil
         )
-            api_path = '/avatars/browsers/{code}'
-                .gsub('{code}', code)
-
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
             end
 
+            api_path = '/avatars/browsers/{code}'
+                .gsub('{code}', code)
+
             api_params = {
                 width: width,
                 height: height,
@@ -77,13 +77,13 @@ module Appwrite
             height: nil,
             quality: nil
         )
-            api_path = '/avatars/credit-cards/{code}'
-                .gsub('{code}', code)
-
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
             end
 
+            api_path = '/avatars/credit-cards/{code}'
+                .gsub('{code}', code)
+
             api_params = {
                 width: width,
                 height: height,
@@ -114,12 +114,12 @@ module Appwrite
         def get_favicon(
             url:
         )
-            api_path = '/avatars/favicon'
-
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/avatars/favicon'
+
             api_params = {
                 url: url,
             }
@@ -160,13 +160,13 @@ module Appwrite
             height: nil,
             quality: nil
         )
-            api_path = '/avatars/flags/{code}'
-                .gsub('{code}', code)
-
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
             end
 
+            api_path = '/avatars/flags/{code}'
+                .gsub('{code}', code)
+
             api_params = {
                 width: width,
                 height: height,
@@ -208,12 +208,12 @@ module Appwrite
             width: nil,
             height: nil
         )
-            api_path = '/avatars/image'
-
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/avatars/image'
+
             api_params = {
                 url: url,
                 width: width,
@@ -285,9 +285,9 @@ module Appwrite
         end
 
         # Returns the best available profile photo for a user. The endpoint tries
-        # each source in priority order and returns the first successful result:
-        # OAuth2 identity photo, Gravatar, Libravatar, Appwrite Initials, built-in
-        # static fallback.
+        # each source in priority order and returns the first successful result: a
+        # custom uploaded photo (see avatars.updatePhoto), OAuth2 identity photo,
+        # Gravatar, Libravatar, Appwrite Initials, built-in static fallback.
         #
         # Passing `userId` — `current()` for the authenticated user — resolves
         # the photo from everything known about that user: identity photos, email,
@@ -346,6 +346,77 @@ module Appwrite
             )
         end
 
+        # Update the profile photo of the currently authenticated user. The uploaded
+        # image takes priority over every other photo source, including OAuth2
+        # identity photos, Gravatar, and Libravatar. Updating an already customized
+        # photo replaces it. The image must be at most 5MB and is sent in a single
+        # request.
+        #
+        # @param [file] file Binary image file of at most 5MB. Allowed file types are png, jpg, jpeg, and webp.
+        #
+        # @return [Account]
+        def update_photo(
+            file:,
+            on_progress: nil
+        )
+            if file.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "file"')
+            end
+
+            api_path = '/avatars/photo'
+
+            api_params = {
+                file: file,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'multipart/form-data',
+                "accept": 'application/json',
+            }
+
+            id_param_name = nil
+            param_name = 'file'
+
+            @client.chunked_upload(
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                param_name: param_name,
+                id_param_name: id_param_name,
+                on_progress: on_progress,
+                method: 'PUT',
+                response_type: Models::Account
+            )
+        end
+
+        # Delete the profile photo of the currently authenticated user and store the
+        # built-in static placeholder in its place. The placeholder is the user's
+        # photo from then on, so it takes priority over every other photo source —
+        # OAuth2 identity photos, Gravatar, Libravatar, and initials — until a new
+        # photo is uploaded with avatars.updatePhoto.
+        #
+        #
+        # @return []
+        def delete_photo()
+            api_path = '/avatars/photo'
+
+            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
+
         # Converts a given plain text to a QR code image. You can use the query
         # parameters to change the size and style of the resulting image.
         #
@@ -362,12 +433,12 @@ module Appwrite
             margin: nil,
             download: nil
         )
-            api_path = '/avatars/qr'
-
             if text.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "text"')
             end
 
+            api_path = '/avatars/qr'
+
             api_params = {
                 text: text,
                 size: size,
@@ -400,7 +471,7 @@ module Appwrite
         # 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 [Hash] headers HTTP headers to send with the browser request. Only Accept and Accept-Language are allowed. 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.
@@ -443,12 +514,12 @@ module Appwrite
             quality: nil,
             output: nil
         )
-            api_path = '/avatars/screenshots'
-
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
             end
 
+            api_path = '/avatars/screenshots'
+
             api_params = {
                 url: url,
                 headers: headers,

data/lib/appwrite/services/backups.rb

@@ -44,12 +44,12 @@ module Appwrite
             services:,
             resource_id: nil
         )
-            api_path = '/backups/archives'
-
             if services.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "services"')
             end
 
+            api_path = '/backups/archives'
+
             api_params = {
                 services: services,
                 resourceId: resource_id,
@@ -78,13 +78,13 @@ module Appwrite
         def get_archive(
             archive_id:
         )
-            api_path = '/backups/archives/{archiveId}'
-                .gsub('{archiveId}', archive_id)
-
-            if archive_id.nil?
+            if archive_id.nil? || archive_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "archiveId"')
             end
 
+            api_path = '/backups/archives/{archiveId}'
+                .gsub('{archiveId}', archive_id)
+
             api_params = {}
 
             api_headers = {
@@ -109,13 +109,13 @@ module Appwrite
         def delete_archive(
             archive_id:
         )
-            api_path = '/backups/archives/{archiveId}'
-                .gsub('{archiveId}', archive_id)
-
-            if archive_id.nil?
+            if archive_id.nil? || archive_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "archiveId"')
             end
 
+            api_path = '/backups/archives/{archiveId}'
+                .gsub('{archiveId}', archive_id)
+
             api_params = {}
 
             api_headers = {
@@ -180,8 +180,6 @@ module Appwrite
             resource_id: nil,
             enabled: nil
         )
-            api_path = '/backups/policies'
-
             if policy_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "policyId"')
             end
@@ -198,6 +196,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "schedule"')
             end
 
+            api_path = '/backups/policies'
+
             api_params = {
                 policyId: policy_id,
                 name: name,
@@ -231,13 +231,13 @@ module Appwrite
         def get_policy(
             policy_id:
         )
-            api_path = '/backups/policies/{policyId}'
-                .gsub('{policyId}', policy_id)
-
-            if policy_id.nil?
+            if policy_id.nil? || policy_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "policyId"')
             end
 
+            api_path = '/backups/policies/{policyId}'
+                .gsub('{policyId}', policy_id)
+
             api_params = {}
 
             api_headers = {
@@ -270,13 +270,13 @@ module Appwrite
             schedule: nil,
             enabled: nil
         )
-            api_path = '/backups/policies/{policyId}'
-                .gsub('{policyId}', policy_id)
-
-            if policy_id.nil?
+            if policy_id.nil? || policy_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "policyId"')
             end
 
+            api_path = '/backups/policies/{policyId}'
+                .gsub('{policyId}', policy_id)
+
             api_params = {
                 name: name,
                 retention: retention,
@@ -307,13 +307,13 @@ module Appwrite
         def delete_policy(
             policy_id:
         )
-            api_path = '/backups/policies/{policyId}'
-                .gsub('{policyId}', policy_id)
-
-            if policy_id.nil?
+            if policy_id.nil? || policy_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "policyId"')
             end
 
+            api_path = '/backups/policies/{policyId}'
+                .gsub('{policyId}', policy_id)
+
             api_params = {}
 
             api_headers = {
@@ -375,8 +375,6 @@ module Appwrite
             new_resource_id: nil,
             new_resource_name: nil
         )
-            api_path = '/backups/restoration'
-
             if archive_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "archiveId"')
             end
@@ -385,6 +383,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "services"')
             end
 
+            api_path = '/backups/restoration'
+
             api_params = {
                 archiveId: archive_id,
                 services: services,
@@ -443,13 +443,13 @@ module Appwrite
         def get_restoration(
             restoration_id:
         )
-            api_path = '/backups/restorations/{restorationId}'
-                .gsub('{restorationId}', restoration_id)
-
-            if restoration_id.nil?
+            if restoration_id.nil? || restoration_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "restorationId"')
             end
 
+            api_path = '/backups/restorations/{restorationId}'
+                .gsub('{restorationId}', restoration_id)
+
             api_params = {}
 
             api_headers = {