test-pack-1 1.0.0

data/lib/test_pack_1/http/http_context.rb

@@ -0,0 +1,20 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Represents an Http call in context.
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/test_pack_1/http/http_method_enum.rb

@@ -0,0 +1,13 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/test_pack_1/http/http_request.rb

@@ -0,0 +1,50 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/test_pack_1/http/http_response.rb

@@ -0,0 +1,23 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Http response received.
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end

data/lib/test_pack_1/models/aggregate_mode_enum.rb

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,104 @@
+# 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/base_model.rb

@@ -0,0 +1,36 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/test_pack_1/models/calculation_mode_enum.rb

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,62 @@
+# 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

@@ -0,0 +1,55 @@
+# 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

data/lib/test_pack_1/models/data_item.rb

@@ -0,0 +1,92 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # An object containing time-series data for a specific aggregate, data signal
+  # and interval.
+  class DataItem < BaseModel
+    # How data is aggregated in the asset structure.
+    # @return [AggregateModeEnum]
+    attr_accessor :aggregate
+
+    # The id of this aggregate group: device id, site id, or the constant -1 for
+    # portfolio
+    # @return [Integer]
+    attr_accessor :aggregate_id
+
+    # The ids of the devices in this aggregate group.
+    # @return [List of Integer]
+    attr_accessor :device_ids
+
+    # The resolution for time-series data.
+    # @return [ResolutionEnum]
+    attr_accessor :resolution
+
+    # Which operation to use when aggregating data.
+    # @return [CalculationModeEnum]
+    attr_accessor :calculation
+
+    # A data signal.
+    # @return [DataSignal]
+    attr_accessor :data_signal
+
+    # A data signal.
+    # @return [Array<String, Float>]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['aggregate'] = 'aggregate'
+      @_hash['aggregate_id'] = 'aggregateId'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['resolution'] = 'resolution'
+      @_hash['calculation'] = 'calculation'
+      @_hash['data_signal'] = 'dataSignal'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    def initialize(aggregate = nil,
+                   aggregate_id = nil,
+                   device_ids = nil,
+                   resolution = nil,
+                   calculation = nil,
+                   data_signal = nil,
+                   data = nil)
+      @aggregate = aggregate
+      @aggregate_id = aggregate_id
+      @device_ids = device_ids
+      @resolution = resolution
+      @calculation = calculation
+      @data_signal = data_signal
+      @data = data
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      aggregate = hash['aggregate']
+      aggregate_id = hash['aggregateId']
+      device_ids = hash['deviceIds']
+      resolution = hash['resolution']
+      calculation = hash['calculation']
+      data_signal = DataSignal.from_hash(hash['dataSignal']) if
+        hash['dataSignal']
+      data = hash['data']
+
+      # Create object from extracted values.
+      DataItem.new(aggregate,
+                   aggregate_id,
+                   device_ids,
+                   resolution,
+                   calculation,
+                   data_signal,
+                   data)
+    end
+  end
+end