ev-recharge-sdk 1.0.0

data/lib/shell_ev/models/address.rb

@@ -0,0 +1,81 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Address of the Shell Recharge Location
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Street Name and Number of the Shell Recharge Location
+    # @return [String]
+    attr_accessor :street_and_number
+
+    # Postal Code of the Shell Recharge Location
+    # @return [String]
+    attr_accessor :postal_code
+
+    # City name of the Shell Recharge Location
+    # @return [String]
+    attr_accessor :city
+
+    # ISO 3166 Alpha-2 Country Code of the Shell Recharge Location
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street_and_number'] = 'streetAndNumber'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street_and_number
+        postal_code
+        city
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(street_and_number = SKIP,
+                   postal_code = SKIP,
+                   city = SKIP,
+                   country = SKIP)
+      @street_and_number = street_and_number unless street_and_number == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      street_and_number =
+        hash.key?('streetAndNumber') ? hash['streetAndNumber'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(street_and_number,
+                  postal_code,
+                  city,
+                  country)
+    end
+  end
+end

data/lib/shell_ev/models/base_model.rb

@@ -0,0 +1,62 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif 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
+      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/shell_ev/models/chargesession_start_body.rb

@@ -0,0 +1,59 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ChargesessionStartBody Model.
+  class ChargesessionStartBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The EV Charge Number which can be found on the back of the Shell EV Card
+    # @return [String]
+    attr_accessor :ev_charge_number
+
+    # Standard EVSE (Electric Vehicle Supply Equipment) Id identifier
+    # (ISO-IEC-15118)
+    # @return [String]
+    attr_accessor :evse_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ev_charge_number'] = 'EvChargeNumber'
+      @_hash['evse_id'] = 'EvseId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ev_charge_number = nil,
+                   evse_id = nil)
+      @ev_charge_number = ev_charge_number
+      @evse_id = evse_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.
+      ev_charge_number =
+        hash.key?('EvChargeNumber') ? hash['EvChargeNumber'] : nil
+      evse_id = hash.key?('EvseId') ? hash['EvseId'] : nil
+
+      # Create object from extracted values.
+      ChargesessionStartBody.new(ev_charge_number,
+                                 evse_id)
+    end
+  end
+end

data/lib/shell_ev/models/connector_vo.rb

@@ -0,0 +1,134 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # An EVSE can have one or many Connectors. Each Connector will normally have a
+  # different socket / cable and only one can be used to charge at a time.
+  class ConnectorVO < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Internal identifier used to refer to this Connector
+    # @return [Integer]
+    attr_accessor :uid
+
+    # Identifier of the Evse as given by the Operator, unique for the containing
+    # EVSE'
+    # @return [String]
+    attr_accessor :external_id
+
+    # Type of the connector in the EVSE unit.
+    # @return [ConnectorVOConnectorTypeEnum]
+    attr_accessor :connector_type
+
+    # Electrical Properties of the Connector
+    # @return [ElectricalProperties]
+    attr_accessor :electrical_properties
+
+    # Indicates whether Connector has a fixed cable attached. False by default
+    # (not sent in this case)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fixed_cable
+
+    # Tariff details for charging on this Connector
+    # @return [TariffVO]
+    attr_accessor :tariff
+
+    # ISO8601-compliant UTC datetime of the last update of the Connectors's data
+    # @return [String]
+    attr_accessor :updated
+
+    # Source of the last update
+    # @return [ConnectorVOUpdatedByEnum]
+    attr_accessor :updated_by
+
+    # optional  ISO8601-compliant UTC deletion timestamp of the connector
+    # @return [String]
+    attr_accessor :deleted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['external_id'] = 'externalId'
+      @_hash['connector_type'] = 'connectorType'
+      @_hash['electrical_properties'] = 'electricalProperties'
+      @_hash['fixed_cable'] = 'fixedCable'
+      @_hash['tariff'] = 'tariff'
+      @_hash['updated'] = 'updated'
+      @_hash['updated_by'] = 'updatedBy'
+      @_hash['deleted'] = 'deleted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        external_id
+        connector_type
+        electrical_properties
+        fixed_cable
+        tariff
+        updated
+        updated_by
+        deleted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   external_id = SKIP,
+                   connector_type = SKIP,
+                   electrical_properties = SKIP,
+                   fixed_cable = SKIP,
+                   tariff = SKIP,
+                   updated = SKIP,
+                   updated_by = SKIP,
+                   deleted = SKIP)
+      @uid = uid unless uid == SKIP
+      @external_id = external_id unless external_id == SKIP
+      @connector_type = connector_type unless connector_type == SKIP
+      @electrical_properties = electrical_properties unless electrical_properties == SKIP
+      @fixed_cable = fixed_cable unless fixed_cable == SKIP
+      @tariff = tariff unless tariff == SKIP
+      @updated = updated unless updated == SKIP
+      @updated_by = updated_by unless updated_by == SKIP
+      @deleted = deleted unless deleted == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      external_id = hash.key?('externalId') ? hash['externalId'] : SKIP
+      connector_type = hash.key?('connectorType') ? hash['connectorType'] : SKIP
+      electrical_properties = ElectricalProperties.from_hash(hash['electricalProperties']) if
+        hash['electricalProperties']
+      fixed_cable = hash.key?('fixedCable') ? hash['fixedCable'] : SKIP
+      tariff = TariffVO.from_hash(hash['tariff']) if hash['tariff']
+      updated = hash.key?('updated') ? hash['updated'] : SKIP
+      updated_by = hash.key?('updatedBy') ? hash['updatedBy'] : SKIP
+      deleted = hash.key?('deleted') ? hash['deleted'] : SKIP
+
+      # Create object from extracted values.
+      ConnectorVO.new(uid,
+                      external_id,
+                      connector_type,
+                      electrical_properties,
+                      fixed_cable,
+                      tariff,
+                      updated,
+                      updated_by,
+                      deleted)
+    end
+  end
+end

data/lib/shell_ev/models/connector_vo_connector_type_enum.rb

@@ -0,0 +1,71 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Type of the connector in the EVSE unit.
+  class ConnectorVOConnectorTypeEnum
+    CONNECTOR_VO_CONNECTOR_TYPE_ENUM = [
+      # TODO: Write general description for AVCON
+      AVCON = 'Avcon'.freeze,
+
+      # TODO: Write general description for DOMESTIC
+      DOMESTIC = 'Domestic'.freeze,
+
+      # TODO: Write general description for INDUSTRIAL2PDC
+      INDUSTRIAL2PDC = 'Industrial2PDc'.freeze,
+
+      # TODO: Write general description for INDUSTRIALPNEAC
+      INDUSTRIALPNEAC = 'IndustrialPneAc'.freeze,
+
+      # TODO: Write general description for INDUSTRIAL3PEAC
+      INDUSTRIAL3PEAC = 'Industrial3PEAc'.freeze,
+
+      # TODO: Write general description for INDUSTRIAL3PENAC
+      INDUSTRIAL3PENAC = 'Industrial3PENAc'.freeze,
+
+      # TODO: Write general description for TYPE1
+      TYPE1 = 'Type1'.freeze,
+
+      # TODO: Write general description for TYPE1COMBO
+      TYPE1COMBO = 'Type1Combo'.freeze,
+
+      # TODO: Write general description for TYPE2
+      TYPE2 = 'Type2'.freeze,
+
+      # TODO: Write general description for TYPE2COMBO
+      TYPE2COMBO = 'Type2Combo'.freeze,
+
+      # TODO: Write general description for TYPE3
+      TYPE3 = 'Type3'.freeze,
+
+      # TODO: Write general description for LPI
+      LPI = 'LPI'.freeze,
+
+      # TODO: Write general description for NEMA520
+      NEMA520 = 'Nema520'.freeze,
+
+      # TODO: Write general description for SAEJ1772
+      SAEJ1772 = 'SAEJ1772'.freeze,
+
+      # TODO: Write general description for SPI
+      SPI = 'SPI'.freeze,
+
+      # TODO: Write general description for TEPCOCHADEMO
+      TEPCOCHADEMO = 'TepcoCHAdeMO'.freeze,
+
+      # TODO: Write general description for TESLA
+      TESLA = 'Tesla'.freeze,
+
+      # TODO: Write general description for UNSPECIFIED
+      UNSPECIFIED = 'Unspecified'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONNECTOR_VO_CONNECTOR_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/connector_vo_updated_by_enum.rb

@@ -0,0 +1,29 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Source of the last update
+  class ConnectorVOUpdatedByEnum
+    CONNECTOR_VO_UPDATED_BY_ENUM = [
+      # TODO: Write general description for FEED
+      FEED = 'Feed'.freeze,
+
+      # TODO: Write general description for ADMIN
+      ADMIN = 'Admin'.freeze,
+
+      # TODO: Write general description for TARIFFSERVICE
+      TARIFFSERVICE = 'TariffService'.freeze,
+
+      # TODO: Write general description for DEFAULTS
+      DEFAULTS = 'Defaults'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONNECTOR_VO_UPDATED_BY_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/coordinates.rb

@@ -0,0 +1,70 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Coordinates of the Shell Recharge Site Location
+  class Coordinates < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Latitude of the Coordinate
+    # @return [Float]
+    attr_accessor :latitude
+
+    # Longitude of the Coordinate
+    # @return [Float]
+    attr_accessor :longitude
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['latitude'] = 'latitude'
+      @_hash['longitude'] = 'longitude'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        latitude
+        longitude
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(latitude = SKIP,
+                   longitude = SKIP)
+      @latitude = latitude unless latitude == SKIP
+      @longitude = longitude unless longitude == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      latitude = hash.key?('latitude') ? hash['latitude'] : SKIP
+      longitude = hash.key?('longitude') ? hash['longitude'] : SKIP
+
+      # Create object from extracted values.
+      Coordinates.new(latitude,
+                      longitude)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Coordinates | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/shell_ev/models/data_active.rb

@@ -0,0 +1,153 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellEv
+  # DataActive Model.
+  class DataActive < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Id of the session
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Id of the user that started the session
+    # @return [String]
+    attr_accessor :user_id
+
+    # Id of the evse that the user is charging
+    # @return [String]
+    attr_accessor :ema_id
+
+    # Electric Vehicle Supply Equipment Identifier. An EVSEID identifies a
+    # Charging Point.
+    # @return [String]
+    attr_accessor :evse_id
+
+    # When the session is started
+    # @return [DateTime]
+    attr_accessor :started_at
+
+    # When the session is stopped
+    # @return [DateTime]
+    attr_accessor :stopped_at
+
+    # Describes the session state
+    # @return [DataActiveSessionStateEnum]
+    attr_accessor :session_state
+
+    # Session code e.g InternalError
+    # @return [DataActiveSessionCodeEnum]
+    attr_accessor :session_code
+
+    # Session message
+    # @return [String]
+    attr_accessor :session_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['user_id'] = 'UserId'
+      @_hash['ema_id'] = 'EmaId'
+      @_hash['evse_id'] = 'EvseId'
+      @_hash['started_at'] = 'StartedAt'
+      @_hash['stopped_at'] = 'StoppedAt'
+      @_hash['session_state'] = 'SessionState'
+      @_hash['session_code'] = 'SessionCode'
+      @_hash['session_message'] = 'SessionMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        user_id
+        ema_id
+        evse_id
+        started_at
+        stopped_at
+        session_state
+        session_code
+        session_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        stopped_at
+        session_code
+        session_message
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   user_id = SKIP,
+                   ema_id = SKIP,
+                   evse_id = SKIP,
+                   started_at = SKIP,
+                   stopped_at = SKIP,
+                   session_state = SKIP,
+                   session_code = SKIP,
+                   session_message = SKIP)
+      @id = id unless id == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @ema_id = ema_id unless ema_id == SKIP
+      @evse_id = evse_id unless evse_id == SKIP
+      @started_at = started_at unless started_at == SKIP
+      @stopped_at = stopped_at unless stopped_at == SKIP
+      @session_state = session_state unless session_state == SKIP
+      @session_code = session_code unless session_code == SKIP
+      @session_message = session_message unless session_message == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      user_id = hash.key?('UserId') ? hash['UserId'] : SKIP
+      ema_id = hash.key?('EmaId') ? hash['EmaId'] : SKIP
+      evse_id = hash.key?('EvseId') ? hash['EvseId'] : SKIP
+      started_at = if hash.key?('StartedAt')
+                     (DateTimeHelper.from_rfc3339(hash['StartedAt']) if hash['StartedAt'])
+                   else
+                     SKIP
+                   end
+      stopped_at = if hash.key?('StoppedAt')
+                     (DateTimeHelper.from_rfc3339(hash['StoppedAt']) if hash['StoppedAt'])
+                   else
+                     SKIP
+                   end
+      session_state = hash.key?('SessionState') ? hash['SessionState'] : SKIP
+      session_code = hash.key?('SessionCode') ? hash['SessionCode'] : SKIP
+      session_message =
+        hash.key?('SessionMessage') ? hash['SessionMessage'] : SKIP
+
+      # Create object from extracted values.
+      DataActive.new(id,
+                     user_id,
+                     ema_id,
+                     evse_id,
+                     started_at,
+                     stopped_at,
+                     session_state,
+                     session_code,
+                     session_message)
+    end
+
+    def to_custom_started_at
+      DateTimeHelper.to_rfc3339(started_at)
+    end
+
+    def to_custom_stopped_at
+      DateTimeHelper.to_rfc3339(stopped_at)
+    end
+  end
+end

data/lib/shell_ev/models/data_active_session_code_enum.rb

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Session code e.g InternalError
+  class DataActiveSessionCodeEnum
+    DATA_ACTIVE_SESSION_CODE_ENUM = [
+      # TODO: Write general description for INTERNALERROR
+      INTERNALERROR = 'InternalError'.freeze,
+
+      # TODO: Write general description for SERVICEUNAVAILABLE
+      SERVICEUNAVAILABLE = 'ServiceUnavailable'.freeze,
+
+      # TODO: Write general description for CHARGETOKENNOTSUPPORTED
+      CHARGETOKENNOTSUPPORTED = 'ChargeTokenNotSupported'.freeze,
+
+      # TODO: Write general description for SESSIONINVALID
+      SESSIONINVALID = 'SessionInvalid'.freeze,
+
+      # TODO: Write general description for EVNOTCONNECTEDTOEVSE
+      EVNOTCONNECTEDTOEVSE = 'EvNotConnectedToEvse'.freeze,
+
+      # TODO: Write general description for EVSEINUSE
+      EVSEINUSE = 'EvseInUse'.freeze,
+
+      # TODO: Write general description for EVSEOUTOFSERVICE
+      EVSEOUTOFSERVICE = 'EvseOutOfService'.freeze,
+
+      # TODO: Write general description for EVSENOTFOUND
+      EVSENOTFOUND = 'EvseNotFound'.freeze,
+
+      # TODO: Write general description for EVSENOTSUPPORTED
+      EVSENOTSUPPORTED = 'EvseNotSupported'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DATA_ACTIVE_SESSION_CODE_ENUM.include?(value)
+    end
+  end
+end