ev-recharge-sdk 1.0.0

data/lib/shell_ev/models/data_active_session_state_enum.rb

@@ -0,0 +1,35 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Describes the session state
+  class DataActiveSessionStateEnum
+    DATA_ACTIVE_SESSION_STATE_ENUM = [
+      # TODO: Write general description for STARTED
+      STARTED = 'started'.freeze,
+
+      # TODO: Write general description for STOPPED
+      STOPPED = 'stopped'.freeze,
+
+      # TODO: Write general description for STARTREQUESTED
+      STARTREQUESTED = 'start-requested'.freeze,
+
+      # TODO: Write general description for STOPREQUESTED
+      STOPREQUESTED = 'stop-requested'.freeze,
+
+      # TODO: Write general description for FAILEDTOSTART
+      FAILEDTOSTART = 'failed-to-start'.freeze,
+
+      # TODO: Write general description for FAILEDTOSTOP
+      FAILEDTOSTOP = 'failed-to-stop'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DATA_ACTIVE_SESSION_STATE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/data_retrieve.rb

@@ -0,0 +1,152 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellEv
+  # DataRetrieve Model.
+  class DataRetrieve < 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
+
+    # Ema-id of the charge token that is used
+    # @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 [DataRetrieveSessionStateEnum]
+    attr_accessor :session_state
+
+    # Session code e.g InternalError
+    # @return [DataRetrieveSessionCodeEnum]
+    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.
+      DataRetrieve.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_retrieve_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 DataRetrieveSessionCodeEnum
+    DATA_RETRIEVE_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_RETRIEVE_SESSION_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/data_retrieve_session_state_enum.rb

@@ -0,0 +1,35 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Describes the session state
+  class DataRetrieveSessionStateEnum
+    DATA_RETRIEVE_SESSION_STATE_ENUM = [
+      # TODO: Write general description for STARTED
+      STARTED = 'started'.freeze,
+
+      # TODO: Write general description for STOPPED
+      STOPPED = 'stopped'.freeze,
+
+      # TODO: Write general description for STARTREQUESTED
+      STARTREQUESTED = 'start-requested'.freeze,
+
+      # TODO: Write general description for STOPREQUESTED
+      STOPREQUESTED = 'stop-requested'.freeze,
+
+      # TODO: Write general description for FAILEDTOSTART
+      FAILEDTOSTART = 'failed-to-start'.freeze,
+
+      # TODO: Write general description for FAILEDTOSTOP
+      FAILEDTOSTOP = 'failed-to-stop'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DATA_RETRIEVE_SESSION_STATE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/electrical_properties.rb

@@ -0,0 +1,81 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Electrical Properties of the Connector
+  class ElectricalProperties < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Power Type used in this connector.
+    # @return [ElectricalPropertiesPowerTypeEnum]
+    attr_accessor :power_type
+
+    # Voltage in Volts for this connector
+    # @return [Float]
+    attr_accessor :voltage
+
+    # Electric Current in Amperes for this connector
+    # @return [Float]
+    attr_accessor :amperage
+
+    # Power in Kilowatts for this connector
+    # @return [Float]
+    attr_accessor :max_electric_power
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['power_type'] = 'powerType'
+      @_hash['voltage'] = 'voltage'
+      @_hash['amperage'] = 'amperage'
+      @_hash['max_electric_power'] = 'maxElectricPower'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        power_type
+        voltage
+        amperage
+        max_electric_power
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(power_type = SKIP,
+                   voltage = SKIP,
+                   amperage = SKIP,
+                   max_electric_power = SKIP)
+      @power_type = power_type unless power_type == SKIP
+      @voltage = voltage unless voltage == SKIP
+      @amperage = amperage unless amperage == SKIP
+      @max_electric_power = max_electric_power unless max_electric_power == 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.
+      power_type = hash.key?('powerType') ? hash['powerType'] : SKIP
+      voltage = hash.key?('voltage') ? hash['voltage'] : SKIP
+      amperage = hash.key?('amperage') ? hash['amperage'] : SKIP
+      max_electric_power =
+        hash.key?('maxElectricPower') ? hash['maxElectricPower'] : SKIP
+
+      # Create object from extracted values.
+      ElectricalProperties.new(power_type,
+                               voltage,
+                               amperage,
+                               max_electric_power)
+    end
+  end
+end

data/lib/shell_ev/models/electrical_properties_power_type_enum.rb

@@ -0,0 +1,26 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Power Type used in this connector.
+  class ElectricalPropertiesPowerTypeEnum
+    ELECTRICAL_PROPERTIES_POWER_TYPE_ENUM = [
+      # TODO: Write general description for AC1PHASE
+      AC1PHASE = 'AC1Phase'.freeze,
+
+      # TODO: Write general description for AC3PHASE
+      AC3PHASE = 'AC3Phase'.freeze,
+
+      # TODO: Write general description for DC
+      DC = 'DC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ELECTRICAL_PROPERTIES_POWER_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/env_enum.rb

@@ -0,0 +1,23 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # env.
+  class EnvEnum
+    ENV_ENUM = [
+      # TODO: Write general description for ENUM_APITESTSHELLCOM
+      ENUM_APITESTSHELLCOM = 'api-test.shell.com'.freeze,
+
+      # TODO: Write general description for ENUM_APISHELLCOM
+      ENUM_APISHELLCOM = 'api.shell.com'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENV_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/evse_vo.rb

@@ -0,0 +1,143 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Each Location will contain one or more EVSEs (Electric Vehicle Supply
+  # Equipment). Each EVSE is capable of charging one car at a time.
+  class EvseVO < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Internal identifier used to refer to single individual  EVSE unit.
+    # @return [Integer]
+    attr_accessor :uid
+
+    # Identifier of the Evse as given by the Operator, unique for that Operator
+    # @return [String]
+    attr_accessor :external_id
+
+    # Standard EVSEId identifier (ISO-IEC-15118)
+    # @return [String]
+    attr_accessor :evse_id
+
+    # The current status of the EVSE units availability
+    # @return [EvseVOStatusEnum]
+    attr_accessor :status
+
+    # List of all connectors available on this EVSE unit.
+    # @return [Array[ConnectorVO]]
+    attr_accessor :connectors
+
+    # Methods that can be used to Authorize sessions on this EVSE
+    # @return [EvseVOAuthorizationMethodsEnum]
+    attr_accessor :authorization_methods
+
+    # ISO8601-compliant UTC datetime of the last update of the EVSE
+    # @return [String]
+    attr_accessor :updated
+
+    # optional  ISO8601-compliant UTC deletion timestamp of the Evse
+    # @return [String]
+    attr_accessor :deleted
+
+    # An optional number/string printed on the outside of the EVSE for visual
+    # identification
+    # @return [String]
+    attr_accessor :physical_reference
+
+    # 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['evse_id'] = 'evseId'
+      @_hash['status'] = 'status'
+      @_hash['connectors'] = 'connectors'
+      @_hash['authorization_methods'] = 'authorizationMethods'
+      @_hash['updated'] = 'updated'
+      @_hash['deleted'] = 'deleted'
+      @_hash['physical_reference'] = 'physicalReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        external_id
+        evse_id
+        status
+        connectors
+        authorization_methods
+        updated
+        deleted
+        physical_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   external_id = SKIP,
+                   evse_id = SKIP,
+                   status = SKIP,
+                   connectors = SKIP,
+                   authorization_methods = SKIP,
+                   updated = SKIP,
+                   deleted = SKIP,
+                   physical_reference = SKIP)
+      @uid = uid unless uid == SKIP
+      @external_id = external_id unless external_id == SKIP
+      @evse_id = evse_id unless evse_id == SKIP
+      @status = status unless status == SKIP
+      @connectors = connectors unless connectors == SKIP
+      @authorization_methods = authorization_methods unless authorization_methods == SKIP
+      @updated = updated unless updated == SKIP
+      @deleted = deleted unless deleted == SKIP
+      @physical_reference = physical_reference unless physical_reference == 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
+      evse_id = hash.key?('evseId') ? hash['evseId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      connectors = nil
+      unless hash['connectors'].nil?
+        connectors = []
+        hash['connectors'].each do |structure|
+          connectors << (ConnectorVO.from_hash(structure) if structure)
+        end
+      end
+
+      connectors = SKIP unless hash.key?('connectors')
+      authorization_methods =
+        hash.key?('authorizationMethods') ? hash['authorizationMethods'] : SKIP
+      updated = hash.key?('updated') ? hash['updated'] : SKIP
+      deleted = hash.key?('deleted') ? hash['deleted'] : SKIP
+      physical_reference =
+        hash.key?('physicalReference') ? hash['physicalReference'] : SKIP
+
+      # Create object from extracted values.
+      EvseVO.new(uid,
+                 external_id,
+                 evse_id,
+                 status,
+                 connectors,
+                 authorization_methods,
+                 updated,
+                 deleted,
+                 physical_reference)
+    end
+  end
+end

data/lib/shell_ev/models/evse_vo_authorization_methods_enum.rb

@@ -0,0 +1,26 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Methods that can be used to Authorize sessions on this EVSE
+  class EvseVOAuthorizationMethodsEnum
+    EVSE_VO_AUTHORIZATION_METHODS_ENUM = [
+      # TODO: Write general description for NEWMOTIONAPP
+      NEWMOTIONAPP = 'NewMotionApp'.freeze,
+
+      # TODO: Write general description for RFIDTOKEN
+      RFIDTOKEN = 'RFIDToken'.freeze,
+
+      # TODO: Write general description for PNC
+      PNC = 'PnC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVSE_VO_AUTHORIZATION_METHODS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/evse_vo_status_enum.rb

@@ -0,0 +1,29 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # The current status of the EVSE units availability
+  class EvseVOStatusEnum
+    EVSE_VO_STATUS_ENUM = [
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'Available'.freeze,
+
+      # TODO: Write general description for OCCUPIED
+      OCCUPIED = 'Occupied'.freeze,
+
+      # TODO: Write general description for UNAVAILABLE
+      UNAVAILABLE = 'Unavailable'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'Unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVSE_VO_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/get_charge_session_retrieve_response200_json.rb

@@ -0,0 +1,78 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # GetChargeSessionRetrieveResponse200Json Model.
+  class GetChargeSessionRetrieveResponse200Json < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique request id in GUID format. The value is written to the Shell API
+    # Platform audit log for end to end traceability of a request.
+    # @return [UUID | String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [GetChargeSessionRetrieveResponse200JsonStatusEnum]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[DataRetrieve]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash['data'] = 'Data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = nil,
+                   status = nil,
+                   data = SKIP)
+      @request_id = request_id
+      @status = status
+      @data = data unless data == 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.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
+      status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (DataRetrieve.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      GetChargeSessionRetrieveResponse200Json.new(request_id,
+                                                  status,
+                                                  data)
+    end
+  end
+end