appwrite 2.4.0 → 4.0.0

data/lib/appwrite/services/avatars.rb

@@ -1,6 +1,19 @@
+#frozen_string_literal: true
+
 module Appwrite
     class Avatars < Service
 
+        # You can use this endpoint to show different browser icons to your users.
+        # The code argument receives the browser code as it appears in your user
+        # /account/sessions endpoint. Use width, height and quality arguments to
+        # change the output settings.
+        #
+        # @param [string] code Browser Code.
+        # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        #
+        # @return []
         def get_browser(code:, width: nil, height: nil, quality: nil)
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
@@ -9,25 +22,34 @@ module Appwrite
             path = '/avatars/browsers/{code}'
                 .gsub('{code}', code)
 
-            params = {}
-
-            if !width.nil?
-                params[:width] = width
-            end
-
-            if !height.nil?
-                params[:height] = height
-            end
-
-            if !quality.nil?
-                params[:quality] = quality
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                width: width,
+                height: height,
+                quality: quality,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # The credit card endpoint will return you the icon of the credit card
+        # provider you need. Use width, height and quality arguments to change the
+        # output settings.
+        #
+        # @param [string] code Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
+        # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        #
+        # @return []
         def get_credit_card(code:, width: nil, height: nil, quality: nil)
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
@@ -36,25 +58,31 @@ module Appwrite
             path = '/avatars/credit-cards/{code}'
                 .gsub('{code}', code)
 
-            params = {}
-
-            if !width.nil?
-                params[:width] = width
-            end
-
-            if !height.nil?
-                params[:height] = height
-            end
-
-            if !quality.nil?
-                params[:quality] = quality
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                width: width,
+                height: height,
+                quality: quality,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
+        # website URL.
+        # 
+        #
+        # @param [string] url Website URL which you want to fetch the favicon from.
+        #
+        # @return []
         def get_favicon(url:)
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
@@ -62,17 +90,32 @@ module Appwrite
 
             path = '/avatars/favicon'
 
-            params = {}
+            params = {
+                url: url,
+            }
 
-            if !url.nil?
-                params[:url] = url
-            end
+            headers = {
+                "content-type": 'application/json',
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # You can use this endpoint to show different country flags icons to your
+        # users. The code argument receives the 2 letter country code. Use width,
+        # height and quality arguments to change the output settings.
+        #
+        # @param [string] code Country Code. ISO Alpha-2 country code format.
+        # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+        #
+        # @return []
         def get_flag(code:, width: nil, height: nil, quality: nil)
             if code.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
@@ -81,25 +124,34 @@ module Appwrite
             path = '/avatars/flags/{code}'
                 .gsub('{code}', code)
 
-            params = {}
-
-            if !width.nil?
-                params[:width] = width
-            end
-
-            if !height.nil?
-                params[:height] = height
-            end
-
-            if !quality.nil?
-                params[:quality] = quality
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                width: width,
+                height: height,
+                quality: quality,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Use this endpoint to fetch a remote image URL and crop it to any image size
+        # you want. This endpoint is very useful if you need to crop and display
+        # remote images in your app or in case you want to make sure a 3rd party
+        # image is properly served using a TLS protocol.
+        #
+        # @param [string] url Image URL which you want to crop.
+        # @param [number] width Resize preview image width, Pass an integer between 0 to 2000.
+        # @param [number] height Resize preview image height, Pass an integer between 0 to 2000.
+        #
+        # @return []
         def get_image(url:, width: nil, height: nil)
             if url.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "url"')
@@ -107,55 +159,74 @@ module Appwrite
 
             path = '/avatars/image'
 
-            params = {}
-
-            if !url.nil?
-                params[:url] = url
-            end
-
-            if !width.nil?
-                params[:width] = width
-            end
-
-            if !height.nil?
-                params[:height] = height
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                url: url,
+                width: width,
+                height: height,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
+        # Use this endpoint to show your user initials avatar icon on your website or
+        # app. By default, this route will try to print your logged-in user name or
+        # email initials. You can also overwrite the user name if you pass the 'name'
+        # parameter. If no name is given and no user is logged, an empty avatar will
+        # be returned.
+        # 
+        # You can use the color and background params to change the avatar colors. By
+        # default, a random theme will be selected. The random theme will persist for
+        # the user's initials when reloading the same theme will always return for
+        # the same initials.
+        #
+        # @param [string] name Full Name. When empty, current user name or email will be used. Max length: 128 chars.
+        # @param [number] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [number] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+        # @param [string] color Changes text color. By default a random color will be picked and stay will persistent to the given name.
+        # @param [string] background Changes background color. By default a random color will be picked and stay will persistent to the given name.
+        #
+        # @return []
         def get_initials(name: nil, width: nil, height: nil, color: nil, background: nil)
             path = '/avatars/initials'
 
-            params = {}
-
-            if !name.nil?
-                params[:name] = name
-            end
-
-            if !width.nil?
-                params[:width] = width
-            end
-
-            if !height.nil?
-                params[:height] = height
-            end
-
-            if !color.nil?
-                params[:color] = color
-            end
-
-            if !background.nil?
-                params[:background] = background
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                name: name,
+                width: width,
+                height: height,
+                color: color,
+                background: background,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: 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.
+        #
+        # @param [string] text Plain text to be converted to QR code image.
+        # @param [number] size QR code size. Pass an integer between 0 to 1000. Defaults to 400.
+        # @param [number] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
+        # @param [boolean] download Return resulting image with &#039;Content-Disposition: attachment &#039; headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
+        #
+        # @return []
         def get_qr(text:, size: nil, margin: nil, download: nil)
             if text.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "text"')
@@ -163,32 +234,24 @@ module Appwrite
 
             path = '/avatars/qr'
 
-            params = {}
-
-            if !text.nil?
-                params[:text] = text
-            end
-
-            if !size.nil?
-                params[:size] = size
-            end
-
-            if !margin.nil?
-                params[:margin] = margin
-            end
-
-            if !download.nil?
-                params[:download] = download
-            end
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            params = {
+                text: text,
+                size: size,
+                margin: margin,
+                download: download,
+            }
+
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+            )
         end
 
-
-        protected
-
-        private
     end 
 end