appwrite 28.4.0 → 30.0.0

data/lib/appwrite/services/storage.rb

@@ -9,7 +9,7 @@ module Appwrite
         # Get a list of all the storage buckets. You can use the query params to
         # filter your results.
         #
-        # @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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
+        # @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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations, stripMetadata
         # @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.
         #
@@ -54,6 +54,8 @@ module Appwrite
         # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
+        # @param [String] description Optional description for the bucket.
+        # @param [] strip_metadata Remove metadata such as location, device and capture time from uploaded images. The color profile and orientation are kept. For file size above 20MB metadata is not removed even if it's enabled.
         #
         # @return [Bucket]
         def create_bucket(
@@ -67,10 +69,10 @@ module Appwrite
             compression: nil,
             encryption: nil,
             antivirus: nil,
-            transformations: nil
+            transformations: nil,
+            description: nil,
+            strip_metadata: nil
         )
-            api_path = '/storage/buckets'
-
             if bucket_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
@@ -79,6 +81,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/storage/buckets'
+
             api_params = {
                 bucketId: bucket_id,
                 name: name,
@@ -91,6 +95,8 @@ module Appwrite
                 encryption: encryption,
                 antivirus: antivirus,
                 transformations: transformations,
+                description: description,
+                stripMetadata: strip_metadata,
             }
 
             api_headers = {
@@ -117,13 +123,13 @@ module Appwrite
         def get_bucket(
             bucket_id:
         )
-            api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}'
+                .gsub('{bucketId}', bucket_id)
+
             api_params = {}
 
             api_headers = {
@@ -153,6 +159,8 @@ module Appwrite
         # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
+        # @param [String] description Optional description for the bucket.
+        # @param [] strip_metadata Remove metadata such as location, device and capture time from uploaded images. The color profile and orientation are kept. For file size above 20MB metadata is not removed even if it's enabled. By default, the current setting is kept.
         #
         # @return [Bucket]
         def update_bucket(
@@ -166,12 +174,11 @@ module Appwrite
             compression: nil,
             encryption: nil,
             antivirus: nil,
-            transformations: nil
+            transformations: nil,
+            description: nil,
+            strip_metadata: nil
         )
-            api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
@@ -179,6 +186,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
+            api_path = '/storage/buckets/{bucketId}'
+                .gsub('{bucketId}', bucket_id)
+
             api_params = {
                 name: name,
                 permissions: permissions,
@@ -190,6 +200,8 @@ module Appwrite
                 encryption: encryption,
                 antivirus: antivirus,
                 transformations: transformations,
+                description: description,
+                stripMetadata: strip_metadata,
             }
 
             api_headers = {
@@ -215,18 +227,19 @@ module Appwrite
         def delete_bucket(
             bucket_id:
         )
-            api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}'
+                .gsub('{bucketId}', bucket_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -252,13 +265,13 @@ module Appwrite
             search: nil,
             total: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files'
-                .gsub('{bucketId}', bucket_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files'
+                .gsub('{bucketId}', bucket_id)
+
             api_params = {
                 queries: queries,
                 search: search,
@@ -313,10 +326,7 @@ module Appwrite
             folder: nil,
             on_progress: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files'
-                .gsub('{bucketId}', bucket_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
@@ -328,6 +338,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "file"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files'
+                .gsub('{bucketId}', bucket_id)
+
             api_params = {
                 fileId: file_id,
                 file: file,
@@ -351,6 +364,7 @@ module Appwrite
                 param_name: param_name,
                 id_param_name: id_param_name,
                 on_progress: on_progress,
+                method: 'POST',
                 response_type: Models::File
             )
         end
@@ -366,18 +380,18 @@ module Appwrite
             bucket_id:,
             file_id:
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {}
 
             api_headers = {
@@ -409,18 +423,18 @@ module Appwrite
             name: nil,
             permissions: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {
                 name: name,
                 permissions: permissions,
@@ -452,23 +466,24 @@ module Appwrite
             bucket_id:,
             file_id:
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -493,18 +508,18 @@ module Appwrite
             file_id:,
             token: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}/download'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}/download'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {
                 token: token,
             }
@@ -532,7 +547,7 @@ module Appwrite
         # @param [String] file_id File ID
         # @param [Integer] width Resize preview image width, Pass an integer between 0 to 4000.
         # @param [Integer] height Resize preview image height, Pass an integer between 0 to 4000.
-        # @param [ImageGravity] gravity Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
+        # @param [ImageGravity] gravity Image crop gravity. Can be one of auto,center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
         # @param [Integer] quality Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
         # @param [Integer] border_width Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
         # @param [String] border_color Preview image border color. Use a valid HEX color, no # is needed for prefix.
@@ -560,18 +575,18 @@ module Appwrite
             output: nil,
             token: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {
                 width: width,
                 height: height,
@@ -614,18 +629,18 @@ module Appwrite
             file_id:,
             token: nil
         )
-            api_path = '/storage/buckets/{bucketId}/files/{fileId}/view'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
-
-            if bucket_id.nil?
+            if bucket_id.nil? || bucket_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
             end
 
-            if file_id.nil?
+            if file_id.nil? || file_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "fileId"')
             end
 
+            api_path = '/storage/buckets/{bucketId}/files/{fileId}/view'
+                .gsub('{bucketId}', bucket_id)
+                .gsub('{fileId}', file_id)
+
             api_params = {
                 token: token,
             }