ev-recharge-sdk 1.0.0 → 1.1.0

data/lib/shell_ev/models/bad_request_err_msg.rb

@@ -0,0 +1,82 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # BadRequestErrMsg Model.
+  class BadRequestErrMsg < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :code
+
+    # Error desctiption in English
+    # @return [String]
+    attr_accessor :message
+
+    # Technical details of the error message, the example which is given in the
+    # sample payload is one of the scenarios. actual response will vary based on
+    # the validation error
+    # @return [String]
+    attr_accessor :description
+
+    # Technical details of the error message, the example which is given in the
+    # sample payload is one of the scenarios. actual response will vary based on
+    # the validation error
+    # @return [Array[String]]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash['description'] = 'description'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        message
+        description
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, message = SKIP, description = SKIP,
+                   details = SKIP)
+      @code = code unless code == SKIP
+      @message = message unless message == SKIP
+      @description = description unless description == SKIP
+      @details = details unless details == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      details = hash.key?('details') ? hash['details'] : SKIP
+
+      # Create object from extracted values.
+      BadRequestErrMsg.new(code,
+                           message,
+                           description,
+                           details)
+    end
+  end
+end

data/lib/shell_ev/models/{stop_charge_session_request_body_json.rb → charge_error.rb}

@@ -4,25 +4,33 @@
 # ( https://apimatic.io ).
 
 module ShellEv
-  # StopChargeSessionRequestBodyJson Model.
-  class StopChargeSessionRequestBodyJson < BaseModel
+  # ChargeError Model.
+  class ChargeError < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # Session Id is to be fetched
+    # Session code e.g InternalError
     # @return [String]
-    attr_accessor :sesssion_id
+    attr_accessor :code
+
+    # Session message
+    # @return [String]
+    attr_accessor :message
 
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['sesssion_id'] = 'SesssionId'
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
-      []
+      %w[
+        code
+        message
+      ]
     end
 
     # An array for nullable fields
@@ -30,8 +38,9 @@ module ShellEv
       []
     end
 
-    def initialize(sesssion_id = nil)
-      @sesssion_id = sesssion_id
+    def initialize(code = SKIP, message = SKIP)
+      @code = code unless code == SKIP
+      @message = message unless message == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -39,10 +48,12 @@ module ShellEv
       return nil unless hash
 
       # Extract variables from the hash.
-      sesssion_id = hash.key?('SesssionId') ? hash['SesssionId'] : nil
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
 
       # Create object from extracted values.
-      StopChargeSessionRequestBodyJson.new(sesssion_id)
+      ChargeError.new(code,
+                      message)
     end
   end
 end

data/lib/shell_ev/models/charge_retrieve_state.rb

@@ -0,0 +1,63 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ChargeRetrieveState Model.
+  class ChargeRetrieveState < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes the session state
+    # started, stopped, start-requested, stop-requested, failed-to-start,
+    # failed-to-stop
+    # @return [String]
+    attr_accessor :status
+
+    # Describes the session state
+    # started, stopped, start-requested, stop-requested, failed-to-start,
+    # failed-to-stop
+    # @return [ChargeError]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP, error = SKIP)
+      @status = status unless status == SKIP
+      @error = error unless error == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      error = ChargeError.from_hash(hash['error']) if hash['error']
+
+      # Create object from extracted values.
+      ChargeRetrieveState.new(status,
+                              error)
+    end
+  end
+end

data/lib/shell_ev/models/chargesession_start_body.rb

@@ -9,20 +9,19 @@ module ShellEv
     SKIP = Object.new
     private_constant :SKIP
 
-    # The EV Charge Number which can be found on the back of the Shell EV Card
+    # Ev charge number
     # @return [String]
     attr_accessor :ev_charge_number
 
-    # Standard EVSE (Electric Vehicle Supply Equipment) Id identifier
-    # (ISO-IEC-15118)
+    # This is the Electric Vehicle EquipmentID
     # @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['ev_charge_number'] = 'evChargeNumber'
+      @_hash['evse_id'] = 'evseId'
       @_hash
     end
 
@@ -36,8 +35,7 @@ module ShellEv
       []
     end
 
-    def initialize(ev_charge_number = nil,
-                   evse_id = nil)
+    def initialize(ev_charge_number = nil, evse_id = nil)
       @ev_charge_number = ev_charge_number
       @evse_id = evse_id
     end
@@ -48,8 +46,8 @@ module ShellEv
 
       # Extract variables from the hash.
       ev_charge_number =
-        hash.key?('EvChargeNumber') ? hash['EvChargeNumber'] : nil
-      evse_id = hash.key?('EvseId') ? hash['EvseId'] : nil
+        hash.key?('evChargeNumber') ? hash['evChargeNumber'] : nil
+      evse_id = hash.key?('evseId') ? hash['evseId'] : nil
 
       # Create object from extracted values.
       ChargesessionStartBody.new(ev_charge_number,

data/lib/shell_ev/models/connector_vo.rb

@@ -36,7 +36,7 @@ module ShellEv
     # @return [TariffVO]
     attr_accessor :tariff
 
-    # ISO8601-compliant UTC datetime of the last update of the Connectors's data
+    # ISO8601-compliant UTC datetime of the last update of the Connector’s data
     # @return [String]
     attr_accessor :updated
 
@@ -83,14 +83,9 @@ module ShellEv
       []
     end
 
-    def initialize(uid = SKIP,
-                   external_id = SKIP,
-                   connector_type = SKIP,
-                   electrical_properties = SKIP,
-                   fixed_cable = SKIP,
-                   tariff = SKIP,
-                   updated = SKIP,
-                   updated_by = SKIP,
+    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

data/lib/shell_ev/models/coordinates.rb

@@ -38,8 +38,7 @@ module ShellEv
       []
     end
 
-    def initialize(latitude = SKIP,
-                   longitude = SKIP)
+    def initialize(latitude = SKIP, longitude = SKIP)
       @latitude = latitude unless latitude == SKIP
       @longitude = longitude unless longitude == SKIP
     end

data/lib/shell_ev/models/data_active.rb

@@ -35,30 +35,25 @@ module ShellEv
     # @return [DateTime]
     attr_accessor :stopped_at
 
-    # Describes the session state
-    # @return [DataActiveSessionStateEnum]
+    # When the session is stopped
+    # @return [ChargeRetrieveState]
     attr_accessor :session_state
 
-    # Session code e.g InternalError
-    # @return [DataActiveSessionCodeEnum]
-    attr_accessor :session_code
-
-    # Session message
+    # When the session is stopped
     # @return [String]
-    attr_accessor :session_message
+    attr_accessor :last_updated
 
     # 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['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['last_updated'] = 'lastUpdated'
       @_hash
     end
 
@@ -72,8 +67,7 @@ module ShellEv
         started_at
         stopped_at
         session_state
-        session_code
-        session_message
+        last_updated
       ]
     end
 
@@ -81,20 +75,12 @@ module ShellEv
     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)
+    def initialize(id = SKIP, user_id = SKIP, ema_id = SKIP, evse_id = SKIP,
+                   started_at = SKIP, stopped_at = SKIP, session_state = SKIP,
+                   last_updated = SKIP)
       @id = id unless id == SKIP
       @user_id = user_id unless user_id == SKIP
       @ema_id = ema_id unless ema_id == SKIP
@@ -102,8 +88,7 @@ module ShellEv
       @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
+      @last_updated = last_updated unless last_updated == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -111,24 +96,22 @@ module ShellEv
       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'])
+      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'])
+      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
+      session_state = ChargeRetrieveState.from_hash(hash['SessionState']) if hash['SessionState']
+      last_updated = hash.key?('lastUpdated') ? hash['lastUpdated'] : SKIP
 
       # Create object from extracted values.
       DataActive.new(id,
@@ -138,8 +121,7 @@ module ShellEv
                      started_at,
                      stopped_at,
                      session_state,
-                     session_code,
-                     session_message)
+                     last_updated)
     end
 
     def to_custom_started_at

data/lib/shell_ev/models/data_retrieve.rb

@@ -26,6 +26,10 @@ module ShellEv
     # @return [String]
     attr_accessor :evse_id
 
+    # Last updated date
+    # @return [String]
+    attr_accessor :last_updated
+
     # When the session is started
     # @return [DateTime]
     attr_accessor :started_at
@@ -34,30 +38,21 @@ module ShellEv
     # @return [DateTime]
     attr_accessor :stopped_at
 
-    # Describes the session state
-    # @return [DataRetrieveSessionStateEnum]
+    # When the session is stopped
+    # @return [ChargeRetrieveState]
     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['id'] = 'id'
+      @_hash['user_id'] = 'userId'
+      @_hash['ema_id'] = 'emaId'
+      @_hash['evse_id'] = 'evseId'
+      @_hash['last_updated'] = 'lastUpdated'
+      @_hash['started_at'] = 'startedAt'
+      @_hash['stopped_at'] = 'stoppedAt'
+      @_hash['session_state'] = 'sessionState'
       @_hash
     end
 
@@ -68,11 +63,10 @@ module ShellEv
         user_id
         ema_id
         evse_id
+        last_updated
         started_at
         stopped_at
         session_state
-        session_code
-        session_message
       ]
     end
 
@@ -80,29 +74,20 @@ module ShellEv
     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)
+    def initialize(id = SKIP, user_id = SKIP, ema_id = SKIP, evse_id = SKIP,
+                   last_updated = SKIP, started_at = SKIP, stopped_at = SKIP,
+                   session_state = 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
+      @last_updated = last_updated unless last_updated == 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.
@@ -110,35 +95,32 @@ module ShellEv
       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'])
+      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
+      last_updated = hash.key?('lastUpdated') ? hash['lastUpdated'] : 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'])
+      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
+      session_state = ChargeRetrieveState.from_hash(hash['sessionState']) if hash['sessionState']
 
       # Create object from extracted values.
       DataRetrieve.new(id,
                        user_id,
                        ema_id,
                        evse_id,
+                       last_updated,
                        started_at,
                        stopped_at,
-                       session_state,
-                       session_code,
-                       session_message)
+                       session_state)
     end
 
     def to_custom_started_at

data/lib/shell_ev/models/electrical_properties.rb

@@ -50,9 +50,7 @@ module ShellEv
       []
     end
 
-    def initialize(power_type = SKIP,
-                   voltage = SKIP,
-                   amperage = SKIP,
+    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

data/lib/shell_ev/models/evse_vo.rb

@@ -82,14 +82,9 @@ module ShellEv
       []
     end
 
-    def initialize(uid = SKIP,
-                   external_id = SKIP,
-                   evse_id = SKIP,
-                   status = SKIP,
-                   connectors = SKIP,
-                   authorization_methods = SKIP,
-                   updated = SKIP,
-                   deleted = SKIP,
+    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

data/lib/shell_ev/models/get_charge_session_retrieve_response200_json.rb

@@ -9,8 +9,8 @@ module ShellEv
     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.
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
     # @return [UUID | String]
     attr_accessor :request_id
 
@@ -25,9 +25,9 @@ module ShellEv
     # 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['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash['data'] = 'data'
       @_hash
     end
 
@@ -43,9 +43,7 @@ module ShellEv
       []
     end
 
-    def initialize(request_id = nil,
-                   status = nil,
-                   data = SKIP)
+    def initialize(request_id = nil, status = nil, data = SKIP)
       @request_id = request_id
       @status = status
       @data = data unless data == SKIP
@@ -56,18 +54,18 @@ module ShellEv
       return nil unless hash
 
       # Extract variables from the hash.
-      request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
-      status = hash.key?('Status') ? hash['Status'] : nil
+      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?
+      unless hash['data'].nil?
         data = []
-        hash['Data'].each do |structure|
+        hash['data'].each do |structure|
           data << (DataRetrieve.from_hash(structure) if structure)
         end
       end
 
-      data = SKIP unless hash.key?('Data')
+      data = SKIP unless hash.key?('data')
 
       # Create object from extracted values.
       GetChargeSessionRetrieveResponse200Json.new(request_id,