test-pack-1 1.0.0

data/lib/test_pack_1/models/data_per_category_item.rb

@@ -0,0 +1,82 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Data for a single aggregate group and contract category combination.
+  class DataPerCategoryItem < BaseModel
+    # 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 ids of the devices in this aggregate group.
+    # @return [String]
+    attr_accessor :contract_title
+
+    # The ids of the devices in this aggregate group.
+    # @return [String]
+    attr_accessor :category_title
+
+    # The aggregated value of the selected data signal.
+    # @return [Float]
+    attr_accessor :value
+
+    # The summed duration in seconds allocated to this contract category and
+    # aggregate group.
+    # @return [Float]
+    attr_accessor :duration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['aggregate_id'] = 'aggregateId'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['contract_title'] = 'contractTitle'
+      @_hash['category_title'] = 'categoryTitle'
+      @_hash['value'] = 'value'
+      @_hash['duration'] = 'duration'
+      @_hash
+    end
+
+    def initialize(aggregate_id = nil,
+                   device_ids = nil,
+                   contract_title = nil,
+                   category_title = nil,
+                   value = nil,
+                   duration = nil)
+      @aggregate_id = aggregate_id
+      @device_ids = device_ids
+      @contract_title = contract_title
+      @category_title = category_title
+      @value = value
+      @duration = duration
+    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_id = hash['aggregateId']
+      device_ids = hash['deviceIds']
+      contract_title = hash['contractTitle']
+      category_title = hash['categoryTitle']
+      value = hash['value']
+      duration = hash['duration']
+
+      # Create object from extracted values.
+      DataPerCategoryItem.new(aggregate_id,
+                              device_ids,
+                              contract_title,
+                              category_title,
+                              value,
+                              duration)
+    end
+  end
+end

data/lib/test_pack_1/models/data_per_category_response.rb

@@ -0,0 +1,63 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # An object containing data grouped by contract category and aggregate.
+  class DataPerCategoryResponse < BaseModel
+    # A data signal.
+    # @return [DataSignal]
+    attr_accessor :data_signal
+
+    # Which operation to use when aggregating data.
+    # @return [CalculationModeEnum]
+    attr_accessor :calculation
+
+    # A list of objects: one per combination of
+    # * aggregate
+    # * contract category
+    # @return [List of DataPerCategoryItem]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_signal'] = 'dataSignal'
+      @_hash['calculation'] = 'calculation'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    def initialize(data_signal = nil,
+                   calculation = nil,
+                   data = nil)
+      @data_signal = data_signal
+      @calculation = calculation
+      @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.
+      data_signal = DataSignal.from_hash(hash['dataSignal']) if
+        hash['dataSignal']
+      calculation = hash['calculation']
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (DataPerCategoryItem.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      DataPerCategoryResponse.new(data_signal,
+                                  calculation,
+                                  data)
+    end
+  end
+end

data/lib/test_pack_1/models/data_real_time_item.rb

@@ -0,0 +1,83 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # An object containing a single data point for a specific aggregate, data
+  # signal and interval.
+  class DataRealTimeItem < 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
+
+    # 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['calculation'] = 'calculation'
+      @_hash['data_signal'] = 'dataSignal'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    def initialize(aggregate = nil,
+                   aggregate_id = nil,
+                   device_ids = nil,
+                   calculation = nil,
+                   data_signal = nil,
+                   data = nil)
+      @aggregate = aggregate
+      @aggregate_id = aggregate_id
+      @device_ids = device_ids
+      @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']
+      calculation = hash['calculation']
+      data_signal = DataSignal.from_hash(hash['dataSignal']) if
+        hash['dataSignal']
+      data = hash['data']
+
+      # Create object from extracted values.
+      DataRealTimeItem.new(aggregate,
+                           aggregate_id,
+                           device_ids,
+                           calculation,
+                           data_signal,
+                           data)
+    end
+  end
+end

data/lib/test_pack_1/models/data_signal.rb

@@ -0,0 +1,53 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # A data signal.
+  class DataSignal < BaseModel
+    # The unique id of a data signal.
+    # @return [Integer]
+    attr_accessor :data_signal_id
+
+    # The unique id of a data signal.
+    # @return [String]
+    attr_accessor :title
+
+    # The unique id of a data signal.
+    # @return [String]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_signal_id'] = 'dataSignalId'
+      @_hash['title'] = 'title'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    def initialize(data_signal_id = nil,
+                   title = nil,
+                   unit = nil)
+      @data_signal_id = data_signal_id
+      @title = title
+      @unit = unit
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data_signal_id = hash['dataSignalId']
+      title = hash['title']
+      unit = hash['unit']
+
+      # Create object from extracted values.
+      DataSignal.new(data_signal_id,
+                     title,
+                     unit)
+    end
+  end
+end

data/lib/test_pack_1/models/data_signal_configuration.rb

@@ -0,0 +1,66 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Your data signal configuration. These only apply to wind devices.
+  class DataSignalConfiguration < BaseModel
+    # The id of the data signal used for time-based availability data.
+    # @return [Integer]
+    attr_accessor :availability_time_data_signal_id
+
+    # The id of the data signal used for production-based availability data.
+    # @return [Integer]
+    attr_accessor :availability_production_data_signal_id
+
+    # The id of the data signal used for lost production data.
+    # @return [Integer]
+    attr_accessor :lost_production_data_signal_id
+
+    # The id of the data signal used for performance data.
+    # @return [Integer]
+    attr_accessor :performance_data_signal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['availability_time_data_signal_id'] =
+        'availabilityTimeDataSignalId'
+      @_hash['availability_production_data_signal_id'] =
+        'availabilityProductionDataSignalId'
+      @_hash['lost_production_data_signal_id'] = 'lostProductionDataSignalId'
+      @_hash['performance_data_signal_id'] = 'performanceDataSignalId'
+      @_hash
+    end
+
+    def initialize(availability_time_data_signal_id = nil,
+                   availability_production_data_signal_id = nil,
+                   lost_production_data_signal_id = nil,
+                   performance_data_signal_id = nil)
+      @availability_time_data_signal_id = availability_time_data_signal_id
+      @availability_production_data_signal_id =
+        availability_production_data_signal_id
+      @lost_production_data_signal_id = lost_production_data_signal_id
+      @performance_data_signal_id = performance_data_signal_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      availability_time_data_signal_id = hash['availabilityTimeDataSignalId']
+      availability_production_data_signal_id =
+        hash['availabilityProductionDataSignalId']
+      lost_production_data_signal_id = hash['lostProductionDataSignalId']
+      performance_data_signal_id = hash['performanceDataSignalId']
+
+      # Create object from extracted values.
+      DataSignalConfiguration.new(availability_time_data_signal_id,
+                                  availability_production_data_signal_id,
+                                  lost_production_data_signal_id,
+                                  performance_data_signal_id)
+    end
+  end
+end

data/lib/test_pack_1/models/data_signal_item.rb

@@ -0,0 +1,62 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # A data signal, including type.
+  class DataSignalItem < BaseModel
+    # The unique id of a data signal.
+    # @return [Integer]
+    attr_accessor :data_signal_id
+
+    # The unique id of a data signal.
+    # @return [String]
+    attr_accessor :title
+
+    # The unique id of a data signal.
+    # @return [String]
+    attr_accessor :type
+
+    # The unique id of a data signal.
+    # @return [String]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_signal_id'] = 'dataSignalId'
+      @_hash['title'] = 'title'
+      @_hash['type'] = 'type'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    def initialize(data_signal_id = nil,
+                   title = nil,
+                   type = nil,
+                   unit = nil)
+      @data_signal_id = data_signal_id
+      @title = title
+      @type = type
+      @unit = unit
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data_signal_id = hash['dataSignalId']
+      title = hash['title']
+      type = hash['type']
+      unit = hash['unit']
+
+      # Create object from extracted values.
+      DataSignalItem.new(data_signal_id,
+                         title,
+                         type,
+                         unit)
+    end
+  end
+end

data/lib/test_pack_1/models/device.rb

@@ -0,0 +1,208 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+require 'date'
+module TestPack1
+  # Device Model.
+  class Device < BaseModel
+    # The id of a device.
+    # @return [Integer]
+    attr_accessor :device_id
+
+    # The id of a device.
+    # @return [String]
+    attr_accessor :title
+
+    # An alternative title.
+    # @return [String]
+    attr_accessor :alt_title
+
+    # Device identification number.
+    # @return [String]
+    attr_accessor :identity
+
+    # Device identification number.
+    # @return [Site]
+    attr_accessor :site
+
+    # The string representation of the device type.
+    # @return [String]
+    attr_accessor :device_type
+
+    # The id of a device type.
+    # @return [Integer]
+    attr_accessor :device_type_id
+
+    # The id of the parent device, if any.
+    # @return [Integer]
+    attr_accessor :parent_id
+
+    # Ids of child devices, if any.
+    # @return [List of Integer]
+    attr_accessor :child_ids
+
+    # General device model information.
+    # @return [DeviceModel]
+    attr_accessor :device_model
+
+    # Turbine-specific type information.
+    # @return [TurbineType]
+    attr_accessor :turbine_type
+
+    # The maximum power for a device.
+    # @return [Integer]
+    attr_accessor :max_power
+
+    # Only applies to Nordic countries and the UK.
+    # @return [String]
+    attr_accessor :bidding_area
+
+    # The earliest timestamp device data is available for.
+    # @return [DateTime]
+    attr_accessor :timestamp_start
+
+    # The latitude of the device in the WGS84 system.
+    # @return [String]
+    attr_accessor :latitude
+
+    # The longitude of the device in the WGS84 system.
+    # @return [String]
+    attr_accessor :longitude
+
+    # The elevation of the device in meters above sea level.
+    # @return [String]
+    attr_accessor :elevation
+
+    # The target availability for the device.
+    # @return [Float]
+    attr_accessor :target_availability
+
+    # A list of metadata fields and their values.
+    # @return [List of MetadataField]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['title'] = 'title'
+      @_hash['alt_title'] = 'altTitle'
+      @_hash['identity'] = 'identity'
+      @_hash['site'] = 'site'
+      @_hash['device_type'] = 'deviceType'
+      @_hash['device_type_id'] = 'deviceTypeId'
+      @_hash['parent_id'] = 'parentId'
+      @_hash['child_ids'] = 'childIds'
+      @_hash['device_model'] = 'deviceModel'
+      @_hash['turbine_type'] = 'turbineType'
+      @_hash['max_power'] = 'maxPower'
+      @_hash['bidding_area'] = 'biddingArea'
+      @_hash['timestamp_start'] = 'timestampStart'
+      @_hash['latitude'] = 'latitude'
+      @_hash['longitude'] = 'longitude'
+      @_hash['elevation'] = 'elevation'
+      @_hash['target_availability'] = 'targetAvailability'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    def initialize(device_id = nil,
+                   title = nil,
+                   alt_title = nil,
+                   identity = nil,
+                   site = nil,
+                   device_type = nil,
+                   device_type_id = nil,
+                   parent_id = nil,
+                   child_ids = nil,
+                   device_model = nil,
+                   turbine_type = nil,
+                   max_power = nil,
+                   bidding_area = nil,
+                   timestamp_start = nil,
+                   latitude = nil,
+                   longitude = nil,
+                   elevation = nil,
+                   target_availability = nil,
+                   metadata = nil)
+      @device_id = device_id
+      @title = title
+      @alt_title = alt_title
+      @identity = identity
+      @site = site
+      @device_type = device_type
+      @device_type_id = device_type_id
+      @parent_id = parent_id
+      @child_ids = child_ids
+      @device_model = device_model
+      @turbine_type = turbine_type
+      @max_power = max_power
+      @bidding_area = bidding_area
+      @timestamp_start = timestamp_start
+      @latitude = latitude
+      @longitude = longitude
+      @elevation = elevation
+      @target_availability = target_availability
+      @metadata = metadata
+    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']
+      title = hash['title']
+      alt_title = hash['altTitle']
+      identity = hash['identity']
+      site = Site.from_hash(hash['site']) if hash['site']
+      device_type = hash['deviceType']
+      device_type_id = hash['deviceTypeId']
+      parent_id = hash['parentId']
+      child_ids = hash['childIds']
+      device_model = DeviceModel.from_hash(hash['deviceModel']) if
+        hash['deviceModel']
+      turbine_type = TurbineType.from_hash(hash['turbineType']) if
+        hash['turbineType']
+      max_power = hash['maxPower']
+      bidding_area = hash['biddingArea']
+      timestamp_start = APIHelper.rfc3339(hash['timestampStart']) if
+        hash['timestampStart']
+      latitude = hash['latitude']
+      longitude = hash['longitude']
+      elevation = hash['elevation']
+      target_availability = hash['targetAvailability']
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (MetadataField.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      Device.new(device_id,
+                 title,
+                 alt_title,
+                 identity,
+                 site,
+                 device_type,
+                 device_type_id,
+                 parent_id,
+                 child_ids,
+                 device_model,
+                 turbine_type,
+                 max_power,
+                 bidding_area,
+                 timestamp_start,
+                 latitude,
+                 longitude,
+                 elevation,
+                 target_availability,
+                 metadata)
+    end
+  end
+end