appwrite 2.4.0 → 4.0.0

data/lib/appwrite/services/health.rb

@@ -1,129 +1,272 @@
+#frozen_string_literal: true
+
 module Appwrite
     class Health < Service
 
+        # Check the Appwrite HTTP server is up and responsive.
+        #
+        #
+        # @return [HealthStatus]
         def get()
             path = '/health'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::HealthStatus
+            )
         end
 
-        def get_anti_virus()
+        # Check the Appwrite Antivirus server is up and connection is successful.
+        #
+        #
+        # @return [HealthAntivirus]
+        def get_antivirus()
             path = '/health/anti-virus'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthAntivirus
+            )
         end
 
+        # Check the Appwrite in-memory cache server is up and connection is
+        # successful.
+        #
+        #
+        # @return [HealthStatus]
         def get_cache()
             path = '/health/cache'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::HealthStatus
+            )
         end
 
+        # Check the Appwrite database server is up and connection is successful.
+        #
+        #
+        # @return [HealthStatus]
         def get_db()
             path = '/health/db'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthStatus
+            )
         end
 
+        # Get the number of certificates that are waiting to be issued against
+        # [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
+        # server.
+        #
+        #
+        # @return [HealthQueue]
         def get_queue_certificates()
             path = '/health/queue/certificates'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::HealthQueue
+            )
         end
 
+        # 
+        #
+        #
+        # @return [HealthQueue]
         def get_queue_functions()
             path = '/health/queue/functions'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthQueue
+            )
         end
 
+        # Get the number of logs that are waiting to be processed in the Appwrite
+        # internal queue server.
+        #
+        #
+        # @return [HealthQueue]
         def get_queue_logs()
             path = '/health/queue/logs'
 
-            params = {}
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
-        end
-
-        def get_queue_tasks()
-            path = '/health/queue/tasks'
+            params = {
+            }
 
-            params = {}
+            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,
+                response_type: Models::HealthQueue
+            )
         end
 
+        # Get the number of usage stats that are waiting to be processed in the
+        # Appwrite internal queue server.
+        #
+        #
+        # @return [HealthQueue]
         def get_queue_usage()
             path = '/health/queue/usage'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthQueue
+            )
         end
 
+        # Get the number of webhooks that are waiting to be processed in the Appwrite
+        # internal queue server.
+        #
+        #
+        # @return [HealthQueue]
         def get_queue_webhooks()
             path = '/health/queue/webhooks'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::HealthQueue
+            )
         end
 
+        # Check the Appwrite local storage device is up and connection is successful.
+        #
+        #
+        # @return [HealthStatus]
         def get_storage_local()
             path = '/health/storage/local'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthStatus
+            )
         end
 
+        # Check the Appwrite server time is synced with Google remote NTP server. We
+        # use this technology to smoothly handle leap seconds with no disruptive
+        # events. The [Network Time
+        # Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is
+        # used by hundreds of millions of computers and devices to synchronize their
+        # clocks over the Internet. If your computer sets its own clock, it likely
+        # uses NTP.
+        #
+        #
+        # @return [HealthTime]
         def get_time()
             path = '/health/time'
 
-            params = {}
-
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
-        end
+            params = {
+            }
 
+            headers = {
+                "content-type": 'application/json',
+            }
 
-        protected
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::HealthTime
+            )
+        end
 
-        private
     end 
 end

data/lib/appwrite/services/locale.rb

@@ -1,79 +1,180 @@
+#frozen_string_literal: true
+
 module Appwrite
     class Locale < Service
 
+        # Get the current user location based on IP. Returns an object with user
+        # country code, country name, continent name, continent code, ip address and
+        # suggested currency. You can use the locale header to get the data in a
+        # supported language.
+        # 
+        # ([IP Geolocation by DB-IP](https://db-ip.com))
+        #
+        #
+        # @return [Locale]
         def get()
             path = '/locale'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::Locale
+            )
         end
 
+        # List of all continents. You can use the locale header to get the data in a
+        # supported language.
+        #
+        #
+        # @return [ContinentList]
         def get_continents()
             path = '/locale/continents'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::ContinentList
+            )
         end
 
+        # List of all countries. You can use the locale header to get the data in a
+        # supported language.
+        #
+        #
+        # @return [CountryList]
         def get_countries()
             path = '/locale/countries'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::CountryList
+            )
         end
 
+        # List of all countries that are currently members of the EU. You can use the
+        # locale header to get the data in a supported language.
+        #
+        #
+        # @return [CountryList]
         def get_countries_eu()
             path = '/locale/countries/eu'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::CountryList
+            )
         end
 
+        # List of all countries phone codes. You can use the locale header to get the
+        # data in a supported language.
+        #
+        #
+        # @return [PhoneList]
         def get_countries_phones()
             path = '/locale/countries/phones'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
+            headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::PhoneList
+            )
         end
 
+        # List of all currencies, including currency symbol, name, plural, and
+        # decimal digits for all major and minor currencies. You can use the locale
+        # header to get the data in a supported language.
+        #
+        #
+        # @return [CurrencyList]
         def get_currencies()
             path = '/locale/currencies'
 
-            params = {}
+            params = {
+            }
+
+            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,
+                response_type: Models::CurrencyList
+            )
         end
 
+        # List of all languages classified by ISO 639-1 including 2-letter code, name
+        # in English, and name in the respective language.
+        #
+        #
+        # @return [LanguageList]
         def get_languages()
             path = '/locale/languages'
 
-            params = {}
+            params = {
+            }
 
-            return @client.call('get', path, {
-                'content-type' => 'application/json',
-            }, params);
-        end
+            headers = {
+                "content-type": 'application/json',
+            }
 
+            @client.call(
+                method: 'GET',
+                path: path,
+                headers: headers,
+                params: params,
+                response_type: Models::LanguageList
+            )
+        end
 
-        protected
-
-        private
     end 
 end