appwrite 4.1.0 → 7.0.0.pre.RC1

data/lib/appwrite/services/avatars.rb

@@ -3,34 +3,44 @@
 module Appwrite
     class Avatars < Service
 
+        def initialize(client)
+            @client = client
+        end
+
         # 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.
+        # The code argument receives the browser code as it appears in your user [GET
+        # /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+        # width, height and quality arguments to change the output settings.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
         #
-        # @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.
+        # @param [String] 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.
         #
         # @return []
         def get_browser(code:, width: nil, height: nil, quality: nil)
-            if code.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "code"')
-            end
 
             path = '/avatars/browsers/{code}'
-                .gsub('{code}', code)
 
             params = {
                 width: width,
                 height: height,
                 quality: quality,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if code.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "code"')
+            end
+
+                .gsub('{code}', code)
 
             @client.call(
                 method: 'GET',
@@ -40,33 +50,41 @@ module Appwrite
             )
         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.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
-        # @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.
+        # @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 [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.
         #
         # @return []
         def get_credit_card(code:, width: nil, height: nil, quality: nil)
-            if code.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "code"')
-            end
 
             path = '/avatars/credit-cards/{code}'
-                .gsub('{code}', code)
 
             params = {
                 width: width,
                 height: height,
                 quality: quality,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if code.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "code"')
+            end
+
+                .gsub('{code}', code)
 
             @client.call(
                 method: 'GET',
@@ -76,27 +94,29 @@ module Appwrite
             )
         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.
+        # @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"')
-            end
 
             path = '/avatars/favicon'
 
             params = {
                 url: url,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if url.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "url"')
+            end
+
 
             @client.call(
                 method: 'GET',
@@ -106,33 +126,42 @@ module Appwrite
             )
         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.
+        # height and quality arguments to change the output settings. Country codes
+        # follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
-        # @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.
+        # @param [String] 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.
         #
         # @return []
         def get_flag(code:, width: nil, height: nil, quality: nil)
-            if code.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "code"')
-            end
 
             path = '/avatars/flags/{code}'
-                .gsub('{code}', code)
 
             params = {
                 width: width,
                 height: height,
                 quality: quality,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if code.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "code"')
+            end
+
+                .gsub('{code}', code)
 
             @client.call(
                 method: 'GET',
@@ -142,20 +171,24 @@ module Appwrite
             )
         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.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 400x400px.
+        # 
         #
-        # @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.
+        # @param [String] url Image URL which you want to crop.
+        # @param [Integer] width Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
+        # @param [Integer] height Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
         #
         # @return []
         def get_image(url:, width: nil, height: nil)
-            if url.nil?
-                raise Appwrite::Exception.new('Missing required parameter: "url"')
-            end
 
             path = '/avatars/image'
 
@@ -164,10 +197,14 @@ module Appwrite
                 width: width,
                 height: height,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if url.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "url"')
+            end
+
 
             @client.call(
                 method: 'GET',
@@ -177,6 +214,7 @@ module Appwrite
             )
         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'
@@ -187,25 +225,30 @@ module Appwrite
         # 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.
+        # 
+        # When one dimension is specified and the other is 0, the image is scaled
+        # with preserved aspect ratio. If both dimensions are 0, the API provides an
+        # image at source quality. If dimensions are not specified, the default size
+        # of image returned is 100x100px.
+        # 
         #
-        # @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.
+        # @param [String] name Full Name. When empty, current user name or email will be used. Max length: 128 chars.
+        # @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 [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)
+        def get_initials(name: nil, width: nil, height: nil, background: nil)
+
             path = '/avatars/initials'
 
             params = {
                 name: name,
                 width: width,
                 height: height,
-                color: color,
                 background: background,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
@@ -218,19 +261,18 @@ module Appwrite
             )
         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.
+        # @param [String] text Plain text to be converted to QR code image.
+        # @param [Integer] size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
+        # @param [Integer] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
+        # @param [] 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"')
-            end
 
             path = '/avatars/qr'
 
@@ -240,10 +282,14 @@ module Appwrite
                 margin: margin,
                 download: download,
             }
-
+            
             headers = {
                 "content-type": 'application/json',
             }
+            if text.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "text"')
+            end
+
 
             @client.call(
                 method: 'GET',
@@ -253,5 +299,6 @@ module Appwrite
             )
         end
 
+        
     end 
 end