test-pack-1 1.0.0

data/lib/test_pack_1/controllers/assets_controller.rb

@@ -0,0 +1,227 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # AssetsController
+  class AssetsController < BaseController
+    @instance = AssetsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Gets a list of devices that the API key has permissions for. This request
+    # can also be made using the POST method, with a JSON request body instead
+    # of query parameters.
+    # @param [List of Integer] device_type_ids Optional parameter: Which device
+    # types to get. Examples: * 1 - Wind turbine * 2 - Production meter * 3 -
+    # Met mast * 4 - Inverter * 10 - Device group * 11 - Grid meter * 12 -
+    # Combiner box * 23 - String
+    # @param [List of Integer] site_ids Optional parameter: Only include devices
+    # at these sites.
+    # @param [List of Integer] parent_ids Optional parameter: Only include
+    # devices with these parent devices.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `Device` schema. By
+    # default all fields are included.
+    # @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 Device response from the API call
+    def get_devices(device_type_ids = nil,
+                    site_ids = nil,
+                    parent_ids = nil,
+                    fields = nil,
+                    page_size = 50,
+                    page = 1)
+      # Prepare query url.
+      _path_url = '/devices.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceTypeIds' => device_type_ids,
+          'siteIds' => site_ids,
+          'parentIds' => parent_ids,
+          'fields' => fields,
+          '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| Device.from_hash(element) }
+    end
+
+    # Gets a list of sites that the API key has permissions for. This request
+    # can also be made using the POST method, with a JSON request body instead
+    # of query parameters.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `SiteWithData`
+    # schema. By default all fields are included.
+    # @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 SiteWithData response from the API call
+    def get_sites(fields = nil,
+                  page_size = 50,
+                  page = 1)
+      # Prepare query url.
+      _path_url = '/sites.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'fields' => fields,
+          '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(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| SiteWithData.from_hash(element) }
+    end
+
+    # Gets the default or learned power curves for wind turbines. Other device
+    # types are not supported. This request can also be made using the POST
+    # method, with a JSON request body instead of query parameters.
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get power curves for. Only wind turbines are supported.
+    # @param [Date] timestamp Optional parameter: The date for which to get
+    # power curves. The default is the current date.
+    # @param [Boolean] learned Optional parameter: Whether to get learned power
+    # curves instead of default power curves.
+    # @return List of PowerCurve response from the API call
+    def get_power_curves(device_ids,
+                         timestamp = nil,
+                         learned = false)
+      # Prepare query url.
+      _path_url = '/powercurves.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'timestamp' => timestamp,
+          'learned' => learned
+        },
+        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| PowerCurve.from_hash(element) }
+    end
+  end
+end

data/lib/test_pack_1/controllers/base_controller.rb

@@ -0,0 +1,51 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Base controller.
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client || FaradayClient.new
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'APIMATIC 2.0'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers = @global_headers.clone.merge(request.headers)
+
+      response = if binary
+                   @http_client.execute_as_binary(request)
+                 else
+                   @http_client.execute_as_string(request)
+                 end
+      context = HttpContext.new(request, response)
+
+      @http_call_back.on_after_response(context) if @http_call_back
+
+      context
+    end
+
+    def validate_response(context)
+      raise APIException.new 'HTTP Response Not OK', context unless
+        context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/test_pack_1/controllers/configuration_data_controller.rb

@@ -0,0 +1,76 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # ConfigurationDataController
+  class ConfigurationDataController < BaseController
+    @instance = ConfigurationDataController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Gets your system-wide configuration data. This request can also be made
+    # using the POST method, with a JSON request body instead of query
+    # parameters.
+    # @return List of ConfigurationItem response from the API call
+    def get_configuration
+      # Prepare query url.
+      _path_url = '/configuration.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _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| ConfigurationItem.from_hash(element) }
+    end
+  end
+end

data/lib/test_pack_1/controllers/data_controller.rb

@@ -0,0 +1,349 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # DataController
+  class DataController < BaseController
+    @instance = DataController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Gets authorized data signals for one or more devices. This request can
+    # also be made using the POST method, with a JSON request body instead of
+    # query parameters.
+    # @param [List of Integer] device_ids Required parameter: What devices to
+    # get data signals for.
+    # @return List of DataSignalItem response from the API call
+    def get_data_signals(device_ids)
+      # Prepare query url.
+      _path_url = '/datasignals.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids
+        },
+        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| DataSignalItem.from_hash(element) }
+    end
+
+    # Gets data for multiple devices and data signals in the given resolution.
+    # This request can also be made using the POST method, with a JSON request
+    # body instead of query parameters.
+    # @param [List of Integer] device_ids Required parameter: Which devices to
+    # get data for.
+    # @param [List of Integer] data_signal_ids Required parameter: Which data
+    # signals to get data for.
+    # @param [DateTime] timestamp_start Required parameter: The first timestamp
+    # to get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [DateTime] timestamp_end Required parameter: The last timestamp to
+    # get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [ResolutionEnum] resolution Optional parameter: The desired data
+    # resolution.
+    # @param [AggregateModeEnum] aggregate Optional parameter: How the data
+    # should be aggregated with regards to device(s) or site(s).
+    # @param [CalculationModeEnum] calculation Optional parameter: The
+    # calculation used when aggregating data, both over time and across devices.
+    # The default is the data signal default.
+    # @return List of DataItem response from the API call
+    def get_data(device_ids,
+                 data_signal_ids,
+                 timestamp_start,
+                 timestamp_end,
+                 resolution = nil,
+                 aggregate = nil,
+                 calculation = nil)
+      # Prepare query url.
+      _path_url = '/data.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'dataSignalIds' => data_signal_ids,
+          'timestampStart' => timestamp_start,
+          'timestampEnd' => timestamp_end,
+          'resolution' => resolution,
+          'aggregate' => aggregate,
+          'calculation' => calculation
+        },
+        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| DataItem.from_hash(element) }
+    end
+
+    # Gets the most recent high-resolution data point for each specified device
+    # and data signal. This request can also be made using the POST method, with
+    # a JSON request body instead of query parameters.
+    # @param [List of Integer] device_ids Required parameter: Which devices to
+    # get data for.
+    # @param [List of Integer] data_signal_ids Required parameter: Which data
+    # signals to get data for.
+    # @param [AggregateModeEnum] aggregate Optional parameter: How the data
+    # should be aggregated with regards to device(s) or site(s).
+    # @param [CalculationModeEnum] calculation Optional parameter: The
+    # calculation used when aggregating data, both over time and across devices.
+    # The default is the data signal default.
+    # @return List of DataRealTimeItem response from the API call
+    def get_real_time_data(device_ids,
+                           data_signal_ids,
+                           aggregate = nil,
+                           calculation = nil)
+      # Prepare query url.
+      _path_url = '/realtimedata.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'dataSignalIds' => data_signal_ids,
+          'aggregate' => aggregate,
+          'calculation' => calculation
+        },
+        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| DataRealTimeItem.from_hash(element) }
+    end
+
+    # Gets signal data aggregated per availability contract category. This
+    # request can also be made using the POST method, with a JSON request body
+    # instead of query parameters.
+    # @param [List of Integer] device_ids Required parameter: Which devices to
+    # get data for.
+    # @param [Integer] data_signal_id Required parameter: Which signal to get
+    # data for; only Lost Production signals are supported at the moment.
+    # @param [DateTime] timestamp_start Required parameter: The first timestamp
+    # to get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [DateTime] timestamp_end Required parameter: The last timestamp to
+    # get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [AggregateModeEnum] aggregate Optional parameter: How the data
+    # should be aggregated with regards to device(s) or site(s).
+    # @param [List of StatusCategoryEnum] category Optional parameter: Which
+    # status categories to include. By default all categories are included.
+    # @return DataPerCategoryResponse response from the API call
+    def get_data_per_category(device_ids,
+                              data_signal_id,
+                              timestamp_start,
+                              timestamp_end,
+                              aggregate = nil,
+                              category = nil)
+      # Prepare query url.
+      _path_url = '/datapercategory.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'dataSignalId' => data_signal_id,
+          'timestampStart' => timestamp_start,
+          'timestampEnd' => timestamp_end,
+          'aggregate' => aggregate,
+          'category' => category
+        },
+        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)
+      DataPerCategoryResponse.from_hash(decoded)
+    end
+  end
+end