test-pack-1 1.0.0

data/lib/test_pack_1.rb

@@ -0,0 +1,63 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'test_pack1/api_helper.rb'
+require_relative 'test_pack1/test_pack1_client.rb'
+
+# Http
+require_relative 'test_pack1/http/http_call_back.rb'
+require_relative 'test_pack1/http/http_client.rb'
+require_relative 'test_pack1/http/http_method_enum.rb'
+require_relative 'test_pack1/http/http_request.rb'
+require_relative 'test_pack1/http/http_response.rb'
+require_relative 'test_pack1/http/http_context.rb'
+require_relative 'test_pack1/http/faraday_client.rb'
+require_relative 'test_pack1/http/auth/custom_query_auth.rb'
+
+# Models
+require_relative 'test_pack1/models/base_model.rb'
+require_relative 'test_pack1/models/data_per_category_response.rb'
+require_relative 'test_pack1/models/device_model.rb'
+require_relative 'test_pack1/models/power_curve_value.rb'
+require_relative 'test_pack1/models/device.rb'
+require_relative 'test_pack1/models/data_real_time_item.rb'
+require_relative 'test_pack1/models/data_signal.rb'
+require_relative 'test_pack1/models/data_item.rb'
+require_relative 'test_pack1/models/status_item.rb'
+require_relative 'test_pack1/models/metadata_field.rb'
+require_relative 'test_pack1/models/site.rb'
+require_relative 'test_pack1/models/configuration_item.rb'
+require_relative 'test_pack1/models/turbine_type.rb'
+require_relative 'test_pack1/models/power_curve.rb'
+require_relative 'test_pack1/models/site_with_data.rb'
+require_relative 'test_pack1/models/data_signal_item.rb'
+require_relative 'test_pack1/models/data_signal_configuration.rb'
+require_relative 'test_pack1/models/data_per_category_item.rb'
+require_relative 'test_pack1/models/client_configuration.rb'
+require_relative 'test_pack1/models/time_zone_configuration.rb'
+require_relative 'test_pack1/models/alert_item.rb'
+require_relative 'test_pack1/models/status_category_enum.rb'
+require_relative 'test_pack1/models/calculation_mode_enum.rb'
+require_relative 'test_pack1/models/aggregate_mode_enum.rb'
+require_relative 'test_pack1/models/resolution_enum.rb'
+
+# Exceptions
+require_relative 'test_pack1/exceptions/api_exception.rb'
+
+require_relative 'test_pack1/configuration.rb'
+
+# Controllers
+require_relative 'test_pack1/controllers/base_controller.rb'
+require_relative 'test_pack1/controllers/statuses_controller.rb'
+require_relative 'test_pack1/controllers/data_controller.rb'
+require_relative 'test_pack1/controllers/alerts_controller.rb'
+require_relative 'test_pack1/controllers/configuration_data_controller.rb'
+require_relative 'test_pack1/controllers/assets_controller.rb'

data/lib/test_pack_1/api_helper.rb

@@ -0,0 +1,275 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      # Iterate and append parameters.
+      parameters.each do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    # @param [String] The format of array parameter serialization.
+    def self.append_url_with_query_parameters(query_builder, parameters,
+                                              array_serialization: 'indexed')
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join("\t")}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          Configuration.array_serialization))
+      end
+      encoded
+    end
+
+    def self.custom_merge(a, b)
+      x = {}
+      a.each do |key, value_a|
+        b.each do |k, value_b|
+          next unless key == k
+          x[k] = []
+          if value_a.instance_of? Array
+            value_a.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
+      retval = {}
+
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        if formatting == 'indexed'
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']'))
+          end
+        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+          obj.each do |value|
+            abc = if formatting == 'unindexed'
+                    APIHelper.form_encode(value, instance_name + '[]',
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+            # print retval
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']', formatting: formatting))
+          end
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+            key + ']', formatting: formatting))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+
+    # Safely converts a string into an rfc3339 DateTime object
+    # @param [String] The datetime string
+    # @return [DateTime] A DateTime object of rfc3339 format
+    def self.rfc3339(date_time)
+      # missing timezone information
+      if date_time.end_with?('Z') || date_time.index('+')
+        DateTime.rfc3339(date_time)
+      else
+        DateTime.rfc3339(date_time + 'Z')
+      end
+    end
+  end
+end
+
+# Extend types to support to_bool.
+module ToBoolean
+  def to_bool
+    return true if self == true || to_s.strip =~ /^(true|yes|y|1)$/i
+    false
+  end
+end
+
+# Extend NilClass type to support to_bool.
+class NilClass; include ToBoolean; end
+# Extend TrueClass type to support to_bool.
+class TrueClass; include ToBoolean; end
+# Extend FalseClass type to support to_bool.
+class FalseClass; include ToBoolean; end
+# Extend Numeric type to support to_bool.
+class Numeric; include ToBoolean; end
+# Extend String type to support to_bool.
+class String; include ToBoolean; end

data/lib/test_pack_1/configuration.rb

@@ -0,0 +1,63 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+# CohesityManagementSdk
+module TestPack1
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration
+    # Set the array parameter serialization method.
+    # (allowed: indexed, unindexed, plain, csv, tsv, psv)
+    @array_serialization = 'indexed'
+
+    # An enum for SDK environments.
+    class Environment
+      #PRODUCTION: The Greenbyte API for a specific customer
+      ENVIRONMENT = [PRODUCTION = 0].freeze
+    end
+
+    # An enum for API servers.
+    class Server
+      SERVER = [DEFAULT = 0].freeze
+    end
+
+    # The environment in which the SDK is running.
+    @environment = Environment::PRODUCTION
+
+    # TODO: Set an appropriate value.
+    @customer = 'intro'
+
+    @api_token = 'TODO: Replace'
+
+    # All the environments the SDK can run in.
+    @environments = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://{customer}.greenbyte.cloud/api/2.0'
+      }
+    }
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def self.get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'customer' => customer
+      }
+      APIHelper.append_url_with_template_parameters(
+        environments[environment][server], parameters
+      )
+    end
+
+    # The attribute accessors for public properties.
+    class << self
+      attr_accessor :array_serialization
+      attr_accessor :environment
+      attr_accessor :environments
+      attr_accessor :customer
+      attr_accessor :api_token
+    end
+  end
+end

data/lib/test_pack_1/controllers/alerts_controller.rb

@@ -0,0 +1,381 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # AlertsController
+  class AlertsController < BaseController
+    @instance = AlertsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # _This endpoint is deprecated. Please use the new endpoint
+    # `/activealerts.json` instead._
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get alerts for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `AlertItem` schema.
+    # By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of AlertItem response from the API call
+    def get_active_alarms(device_ids,
+                          fields = nil,
+                          sort_by = nil,
+                          sort_asc = false,
+                          page_size = 50,
+                          page = 1)
+      # Prepare query url.
+      _path_url = '/activealarms.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| AlertItem.from_hash(element) }
+    end
+
+    # Gets active alerts for multiple devices.
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get alerts for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `AlertItem` schema.
+    # By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of AlertItem response from the API call
+    def get_active_alerts(device_ids,
+                          fields = nil,
+                          sort_by = nil,
+                          sort_asc = false,
+                          page_size = 50,
+                          page = 1)
+      # Prepare query url.
+      _path_url = '/activealerts.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| AlertItem.from_hash(element) }
+    end
+
+    # Gets alerts for multiple devices and the given time period.
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get alerts for.
+    # @param [DateTime] timestamp_start Required parameter: The first timestamp
+    # to get data for.
+    # @param [DateTime] timestamp_end Required parameter: The last timestamp to
+    # get data for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `AlertItem` schema.
+    # By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of AlertItem response from the API call
+    def get_alerts(device_ids,
+                   timestamp_start,
+                   timestamp_end,
+                   fields = nil,
+                   sort_by = nil,
+                   sort_asc = false,
+                   page_size = 50,
+                   page = 1)
+      # Prepare query url.
+      _path_url = '/alerts.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'timestampStart' => timestamp_start,
+          'timestampEnd' => timestamp_end,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| AlertItem.from_hash(element) }
+    end
+
+    # _This endpoint is deprecated. Please use the new endpoint `/alerts.json`
+    # instead._
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get alerts for.
+    # @param [DateTime] timestamp_start Required parameter: The first timestamp
+    # to get data for.
+    # @param [DateTime] timestamp_end Required parameter: The last timestamp to
+    # get data for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `AlertItem` schema.
+    # By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of AlertItem response from the API call
+    def get_alarms(device_ids,
+                   timestamp_start,
+                   timestamp_end,
+                   fields = nil,
+                   sort_by = nil,
+                   sort_asc = false,
+                   page_size = 50,
+                   page = 1)
+      # Prepare query url.
+      _path_url = '/alarms.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'timestampStart' => timestamp_start,
+          'timestampEnd' => timestamp_end,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| AlertItem.from_hash(element) }
+    end
+  end
+end