test-pack-1 1.0.0 → 1.0.2

data/lib/test_pack_1/controllers/statuses_controller.rb

@@ -1,215 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # StatusesController
-  class StatusesController < BaseController
-    @instance = StatusesController.new
-
-    class << self
-      attr_accessor :instance
-    end
-
-    def instance
-      self.class.instance
-    end
-
-    # Gets active statuses for multiple 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: Which devices to
-    # get statuses for.
-    # @param [List of StatusCategoryEnum] category Optional parameter: Which
-    # status categories to get statuses for.
-    # @param [List of String] fields Optional parameter: Which fields to include
-    # in the response. Valid fields are those defined in the `StatusItem`
-    # 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 StatusItem response from the API call
-    def get_active_statuses(device_ids,
-                            category = nil,
-                            fields = nil,
-                            sort_by = nil,
-                            sort_asc = false,
-                            page_size = 50,
-                            page = 1)
-      # Prepare query url.
-      _path_url = '/activestatus.json'
-      _query_builder = Configuration.get_base_uri
-      _query_builder << _path_url
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        {
-          'deviceIds' => device_ids,
-          'category' => category,
-          '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| StatusItem.from_hash(element) }
-    end
-
-    # Gets statuses for multiple devices during the given time period. 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 statuses 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 [List of StatusCategoryEnum] category Optional parameter: Which
-    # status categories to get statuses for.
-    # @param [List of String] fields Optional parameter: Which fields to include
-    # in the response. Valid fields are those defined in the `StatusItem`
-    # 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 StatusItem response from the API call
-    def get_statuses(device_ids,
-                     timestamp_start,
-                     timestamp_end,
-                     category = nil,
-                     fields = nil,
-                     sort_by = nil,
-                     sort_asc = false,
-                     page_size = 50,
-                     page = 1)
-      # Prepare query url.
-      _path_url = '/status.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,
-          'category' => category,
-          '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| StatusItem.from_hash(element) }
-    end
-  end
-end

data/lib/test_pack_1/http/auth/custom_query_auth.rb

@@ -1,16 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # Utility class for custom query_parameter authorization.
-  class CustomQueryAuth
-    # Add custom authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(http_request)
-      http_request.add_query_parameter('apiToken', Configuration.api_token)
-    end
-  end
-end

data/lib/test_pack_1/models/aggregate_mode_enum.rb

@@ -1,23 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # How data is aggregated in the asset structure.
-  class AggregateModeEnum
-    AGGREGATE_MODE_ENUM = [
-      # TODO: Write general description for DEVICE
-      DEVICE = 'device'.freeze,
-
-      # TODO: Write general description for DEVICELEVEL
-      DEVICELEVEL = 'deviceLevel'.freeze,
-
-      # TODO: Write general description for SITE
-      SITE = 'site'.freeze,
-
-      # TODO: Write general description for PORTFOLIO
-      PORTFOLIO = 'portfolio'.freeze
-    ].freeze
-  end
-end

data/lib/test_pack_1/models/alert_item.rb

@@ -1,104 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-require 'date'
-module TestPack1
-  # An alert generated for a device based on a rule.
-  class AlertItem < BaseModel
-    # The id of the device the alert was generated for.
-    # @return [Integer]
-    attr_accessor :device_id
-
-    # The id of the rule the alert is based on.
-    # @return [Integer]
-    attr_accessor :rule_id
-
-    # The timestamp when the alert began. The timestamp is in your
-    # system-configured time zone without UTC offset.
-    # @return [DateTime]
-    attr_accessor :timestamp_start
-
-    # The timestamp when the alert ended. The timestamp is in your
-    # system-configured time zone without UTC offset.
-    # @return [DateTime]
-    attr_accessor :timestamp_end
-
-    # The title of the rule the alert is based on.
-    # @return [String]
-    attr_accessor :message
-
-    # A user comment associated with the alert.
-    # @return [String]
-    attr_accessor :comment
-
-    # A description explaning the rule the alert is based on.
-    # @return [String]
-    attr_accessor :description
-
-    # Additional details for the alert. Note that the structure of this data is
-    # subject to change.
-    # @return [String]
-    attr_accessor :details
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['device_id'] = 'deviceId'
-      @_hash['rule_id'] = 'ruleId'
-      @_hash['timestamp_start'] = 'timestampStart'
-      @_hash['timestamp_end'] = 'timestampEnd'
-      @_hash['message'] = 'message'
-      @_hash['comment'] = 'comment'
-      @_hash['description'] = 'description'
-      @_hash['details'] = 'details'
-      @_hash
-    end
-
-    def initialize(device_id = nil,
-                   rule_id = nil,
-                   timestamp_start = nil,
-                   timestamp_end = nil,
-                   message = nil,
-                   comment = nil,
-                   description = nil,
-                   details = nil)
-      @device_id = device_id
-      @rule_id = rule_id
-      @timestamp_start = timestamp_start
-      @timestamp_end = timestamp_end
-      @message = message
-      @comment = comment
-      @description = description
-      @details = details
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      device_id = hash['deviceId']
-      rule_id = hash['ruleId']
-      timestamp_start = APIHelper.rfc3339(hash['timestampStart']) if
-        hash['timestampStart']
-      timestamp_end = APIHelper.rfc3339(hash['timestampEnd']) if
-        hash['timestampEnd']
-      message = hash['message']
-      comment = hash['comment']
-      description = hash['description']
-      details = hash['details']
-
-      # Create object from extracted values.
-      AlertItem.new(device_id,
-                    rule_id,
-                    timestamp_start,
-                    timestamp_end,
-                    message,
-                    comment,
-                    description,
-                    details)
-    end
-  end
-end

data/lib/test_pack_1/models/calculation_mode_enum.rb

@@ -1,20 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # Which operation to use when aggregating data.
-  class CalculationModeEnum
-    CALCULATION_MODE_ENUM = [
-      # TODO: Write general description for AVERAGE
-      AVERAGE = 'average'.freeze,
-
-      # TODO: Write general description for SUM
-      SUM = 'sum'.freeze,
-
-      # TODO: Write general description for COUNTER
-      COUNTER = 'counter'.freeze
-    ].freeze
-  end
-end

data/lib/test_pack_1/models/client_configuration.rb

@@ -1,62 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # General configuration data.
-  class ClientConfiguration < BaseModel
-    # The title of your Greenbyte Platform website.
-    # @return [String]
-    attr_accessor :title
-
-    # Your internal customer tag.
-    # @return [String]
-    attr_accessor :tag
-
-    # Your URL to access the Greenbyte Platform website.
-    # @return [String]
-    attr_accessor :url_web
-
-    # Your URL to access the Greenbyte Platform API.
-    # @return [String]
-    attr_accessor :url_api
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['title'] = 'title'
-      @_hash['tag'] = 'tag'
-      @_hash['url_web'] = 'urlWeb'
-      @_hash['url_api'] = 'urlApi'
-      @_hash
-    end
-
-    def initialize(title = nil,
-                   tag = nil,
-                   url_web = nil,
-                   url_api = nil)
-      @title = title
-      @tag = tag
-      @url_web = url_web
-      @url_api = url_api
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      title = hash['title']
-      tag = hash['tag']
-      url_web = hash['urlWeb']
-      url_api = hash['urlApi']
-
-      # Create object from extracted values.
-      ClientConfiguration.new(title,
-                              tag,
-                              url_web,
-                              url_api)
-    end
-  end
-end

data/lib/test_pack_1/models/configuration_item.rb

@@ -1,55 +0,0 @@
-# test_pack_1
-#
-# This file was automatically generated by APIMATIC v2.0 (
-# https://apimatic.io ).
-
-module TestPack1
-  # Your configuration data.
-  class ConfigurationItem < BaseModel
-    # General configuration data.
-    # @return [ClientConfiguration]
-    attr_accessor :client
-
-    # your system-configured time zone configuration.
-    # @return [TimeZoneConfiguration]
-    attr_accessor :time_zone
-
-    # Your data signal configuration. These only apply to wind devices.
-    # @return [DataSignalConfiguration]
-    attr_accessor :data_signals
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['client'] = 'client'
-      @_hash['time_zone'] = 'timeZone'
-      @_hash['data_signals'] = 'dataSignals'
-      @_hash
-    end
-
-    def initialize(client = nil,
-                   time_zone = nil,
-                   data_signals = nil)
-      @client = client
-      @time_zone = time_zone
-      @data_signals = data_signals
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      client = ClientConfiguration.from_hash(hash['client']) if hash['client']
-      time_zone = TimeZoneConfiguration.from_hash(hash['timeZone']) if
-        hash['timeZone']
-      data_signals = DataSignalConfiguration.from_hash(hash['dataSignals']) if
-        hash['dataSignals']
-
-      # Create object from extracted values.
-      ConfigurationItem.new(client,
-                            time_zone,
-                            data_signals)
-    end
-  end
-end