ev-recharge-sdk 1.4.0 → 2.1.0

data/lib/shell_ev/models/search_by_id_evse.rb

@@ -0,0 +1,145 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.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 SearchByIdEvse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Internal identifier used to refer to single individual  EVSE unit.
+    # @return [String]
+    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
+
+    # ISO8601-compliant UTC datetime of the last update of the EVSE
+    # @return [String]
+    attr_accessor :updated
+
+    # An optional number/string printed on the outside of the EVSE for visual
+    # identification
+    # @return [String]
+    attr_accessor :physical_reference
+
+    # List of all connectors available on this EVSE unit.
+    # @return [Array[SearchByIdConnector]]
+    attr_accessor :connectors
+
+    # Methods that can be used to Authorize sessions on this EVSE
+    # @return [Array[SingleLocationMarkerAuthorizationMethodsItemsEnum]]
+    attr_accessor :authorization_methods
+
+    # 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['updated'] = 'updated'
+      @_hash['physical_reference'] = 'physicalReference'
+      @_hash['connectors'] = 'connectors'
+      @_hash['authorization_methods'] = 'authorizationMethods'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        external_id
+        evse_id
+        status
+        updated
+        physical_reference
+        connectors
+        authorization_methods
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, external_id = SKIP, evse_id = SKIP,
+                   status = SKIP, updated = SKIP, physical_reference = SKIP,
+                   connectors = SKIP, authorization_methods = 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
+      @updated = updated unless updated == SKIP
+      @physical_reference = physical_reference unless physical_reference == SKIP
+      @connectors = connectors unless connectors == SKIP
+      @authorization_methods = authorization_methods unless authorization_methods == 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
+      updated = hash.key?('updated') ? hash['updated'] : SKIP
+      physical_reference =
+        hash.key?('physicalReference') ? hash['physicalReference'] : 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 << (SearchByIdConnector.from_hash(structure) if structure)
+        end
+      end
+
+      connectors = SKIP unless hash.key?('connectors')
+      authorization_methods =
+        hash.key?('authorizationMethods') ? hash['authorizationMethods'] : SKIP
+
+      # Create object from extracted values.
+      SearchByIdEvse.new(uid,
+                         external_id,
+                         evse_id,
+                         status,
+                         updated,
+                         physical_reference,
+                         connectors,
+                         authorization_methods)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uid: #{@uid}, external_id: #{@external_id}, evse_id: #{@evse_id}, status:"\
+      " #{@status}, updated: #{@updated}, physical_reference: #{@physical_reference}, connectors:"\
+      " #{@connectors}, authorization_methods: #{@authorization_methods}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uid: #{@uid.inspect}, external_id: #{@external_id.inspect}, evse_id:"\
+      " #{@evse_id.inspect}, status: #{@status.inspect}, updated: #{@updated.inspect},"\
+      " physical_reference: #{@physical_reference.inspect}, connectors: #{@connectors.inspect},"\
+      " authorization_methods: #{@authorization_methods.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/search_by_id_location_respone.rb

@@ -0,0 +1,196 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # SearchByIdLocationRespone Model.
+  class SearchByIdLocationRespone < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Internal identifier used to refer to this Location by Shell
+    # Recharge
+    # @return [String]
+    attr_accessor :uid
+
+    # Identifier as given by the Shell Recharge Operator, unique for that
+    # Operator
+    # @return [String]
+    attr_accessor :external_id
+
+    # Coordinates of the Shell Recharge Site Location
+    # @return [Coordinates]
+    attr_accessor :coordinates
+
+    # Operator of this Shell Recharge Location
+    # @return [String]
+    attr_accessor :operator_name
+
+    # Address of the Shell Recharge Location
+    # @return [Address]
+    attr_accessor :address
+
+    # Accessibility of the Location
+    # @return [AccessibilityV2]
+    attr_accessor :accessibility
+
+    # Accessibility of the Location
+    # @return [Array[SearchByIdEvse]]
+    attr_accessor :evses
+
+    # Optional Opening Hours of the Location. Please note that it is not
+    # available for all sites.
+    # @return [Array[OpeningHoursObject]]
+    attr_accessor :opening_hours
+
+    # ISO8601-compliant UTC datetime of the last update of the location
+    # @return [String]
+    attr_accessor :updated
+
+    # the type of the location. Could be "UNKNOWN".
+    # @return [String]
+    attr_accessor :location_type
+
+    # Unique Id of the operator
+    # @return [String]
+    attr_accessor :operator_id
+
+    # Whether the location is open 24/7
+    # @return [TrueClass | FalseClass]
+    attr_accessor :open_twenty_four_seven
+
+    # 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['coordinates'] = 'coordinates'
+      @_hash['operator_name'] = 'operatorName'
+      @_hash['address'] = 'address'
+      @_hash['accessibility'] = 'accessibility'
+      @_hash['evses'] = 'evses'
+      @_hash['opening_hours'] = 'openingHours'
+      @_hash['updated'] = 'updated'
+      @_hash['location_type'] = 'locationType'
+      @_hash['operator_id'] = 'operatorId'
+      @_hash['open_twenty_four_seven'] = 'openTwentyFourSeven'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        external_id
+        coordinates
+        operator_name
+        address
+        accessibility
+        evses
+        opening_hours
+        updated
+        location_type
+        operator_id
+        open_twenty_four_seven
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, external_id = SKIP, coordinates = SKIP,
+                   operator_name = SKIP, address = SKIP, accessibility = SKIP,
+                   evses = SKIP, opening_hours = SKIP, updated = SKIP,
+                   location_type = SKIP, operator_id = SKIP,
+                   open_twenty_four_seven = SKIP)
+      @uid = uid unless uid == SKIP
+      @external_id = external_id unless external_id == SKIP
+      @coordinates = coordinates unless coordinates == SKIP
+      @operator_name = operator_name unless operator_name == SKIP
+      @address = address unless address == SKIP
+      @accessibility = accessibility unless accessibility == SKIP
+      @evses = evses unless evses == SKIP
+      @opening_hours = opening_hours unless opening_hours == SKIP
+      @updated = updated unless updated == SKIP
+      @location_type = location_type unless location_type == SKIP
+      @operator_id = operator_id unless operator_id == SKIP
+      @open_twenty_four_seven = open_twenty_four_seven unless open_twenty_four_seven == 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
+      coordinates = Coordinates.from_hash(hash['coordinates']) if hash['coordinates']
+      operator_name = hash.key?('operatorName') ? hash['operatorName'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      accessibility = AccessibilityV2.from_hash(hash['accessibility']) if hash['accessibility']
+      # Parameter is an array, so we need to iterate through it
+      evses = nil
+      unless hash['evses'].nil?
+        evses = []
+        hash['evses'].each do |structure|
+          evses << (SearchByIdEvse.from_hash(structure) if structure)
+        end
+      end
+
+      evses = SKIP unless hash.key?('evses')
+      # Parameter is an array, so we need to iterate through it
+      opening_hours = nil
+      unless hash['openingHours'].nil?
+        opening_hours = []
+        hash['openingHours'].each do |structure|
+          opening_hours << (OpeningHoursObject.from_hash(structure) if structure)
+        end
+      end
+
+      opening_hours = SKIP unless hash.key?('openingHours')
+      updated = hash.key?('updated') ? hash['updated'] : SKIP
+      location_type = hash.key?('locationType') ? hash['locationType'] : SKIP
+      operator_id = hash.key?('operatorId') ? hash['operatorId'] : SKIP
+      open_twenty_four_seven =
+        hash.key?('openTwentyFourSeven') ? hash['openTwentyFourSeven'] : SKIP
+
+      # Create object from extracted values.
+      SearchByIdLocationRespone.new(uid,
+                                    external_id,
+                                    coordinates,
+                                    operator_name,
+                                    address,
+                                    accessibility,
+                                    evses,
+                                    opening_hours,
+                                    updated,
+                                    location_type,
+                                    operator_id,
+                                    open_twenty_four_seven)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uid: #{@uid}, external_id: #{@external_id}, coordinates: #{@coordinates},"\
+      " operator_name: #{@operator_name}, address: #{@address}, accessibility: #{@accessibility},"\
+      " evses: #{@evses}, opening_hours: #{@opening_hours}, updated: #{@updated}, location_type:"\
+      " #{@location_type}, operator_id: #{@operator_id}, open_twenty_four_seven:"\
+      " #{@open_twenty_four_seven}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uid: #{@uid.inspect}, external_id: #{@external_id.inspect}, coordinates:"\
+      " #{@coordinates.inspect}, operator_name: #{@operator_name.inspect}, address:"\
+      " #{@address.inspect}, accessibility: #{@accessibility.inspect}, evses: #{@evses.inspect},"\
+      " opening_hours: #{@opening_hours.inspect}, updated: #{@updated.inspect}, location_type:"\
+      " #{@location_type.inspect}, operator_id: #{@operator_id.inspect}, open_twenty_four_seven:"\
+      " #{@open_twenty_four_seven.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/search_by_id_response.rb

@@ -0,0 +1,91 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # SearchByIdResponse Model.
+  class SearchByIdResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # requestId is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
+    # @return [UUID | String]
+    attr_accessor :request_id
+
+    # status of the API call
+    # @return [String]
+    attr_accessor :status
+
+    # API Response
+    # @return [Array[SearchByIdLocationRespone]]
+    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[
+        request_id
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @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'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (SearchByIdLocationRespone.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # Create object from extracted values.
+      SearchByIdResponse.new(request_id,
+                             status,
+                             data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/serviceunavailable_err_msg.rb

@@ -1,7 +1,7 @@
 # shell_ev
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
 
 module ShellEv
   # ServiceunavailableErrMsg Model.

data/lib/shell_ev/models/single_location_marker.rb

@@ -1,7 +1,7 @@
 # shell_ev
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
 
 module ShellEv
   # A Marker is a place on the map that represent a single Location
@@ -18,12 +18,14 @@ module ShellEv
     # @return [String]
     attr_accessor :unique_key
 
-    # Uniquely identifies the marker object
+    # Minimum of all status values in the Marker, e.g. if at least one Evse in
+    # the Marker is available, the value will be available
     # @return [SingleLocationMarkerStatusEnum]
     attr_accessor :status
 
-    # Coordinates of the Shell Recharge Site Location
-    # @return [Coordinates]
+    # Minimum of all status values in the Marker, e.g. if at least one Evse in
+    # the Marker is available, the value will be available
+    # @return [Coordinates1]
     attr_accessor :coordinates
 
     # Total number of Evse units in Locations that this Marker represents
@@ -111,7 +113,7 @@ module ShellEv
       marker_type = hash.key?('markerType') ? hash['markerType'] : nil
       unique_key = hash.key?('uniqueKey') ? hash['uniqueKey'] : SKIP
       status = hash.key?('status') ? hash['status'] : SKIP
-      coordinates = Coordinates.from_hash(hash['coordinates']) if hash['coordinates']
+      coordinates = Coordinates1.from_hash(hash['coordinates']) if hash['coordinates']
       evse_count = hash.key?('evseCount') ? hash['evseCount'] : SKIP
       max_power = hash.key?('maxPower') ? hash['maxPower'] : SKIP
       geo_hash = hash.key?('geoHash') ? hash['geoHash'] : SKIP

data/lib/shell_ev/models/single_location_marker_authorization_methods_items_enum.rb

@@ -1,7 +1,7 @@
 # shell_ev
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
 
 module ShellEv
   # singleLocationMarkerAuthorizationMethodsItems.
@@ -22,5 +22,19 @@ module ShellEv
 
       SINGLE_LOCATION_MARKER_AUTHORIZATION_METHODS_ITEMS_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = NEWMOTIONAPP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'newmotionapp' then NEWMOTIONAPP
+      when 'rfidtoken' then RFIDTOKEN
+      when 'pnc' then PNC
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/shell_ev/models/single_location_marker_response.rb

@@ -1,7 +1,7 @@
 # shell_ev
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
 
 module ShellEv
   # SingleLocationMarkerResponse Model.

data/lib/shell_ev/models/single_location_marker_response_v2.rb

@@ -0,0 +1,94 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # SingleLocationMarkerResponseV2 Model.
+  class SingleLocationMarkerResponseV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # requestId is unique identifier value that is attached to requests and
+    # messages that allow reference to a particular transaction or event chain.
+    # @return [UUID | String]
+    attr_accessor :request_id
+
+    # status of the API call
+    # @return [String]
+    attr_accessor :status
+
+    # status of the API call
+    # @return [Array[Object]]
+    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[
+        request_id
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @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'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      data = hash.key?('data') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:LocationMarkerV2), hash['data']
+      ) : SKIP
+
+      # Create object from extracted values.
+      SingleLocationMarkerResponseV2.new(request_id,
+                                         status,
+                                         data)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SingleLocationMarkerResponseV2 | 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/single_location_marker_status_enum.rb

@@ -1,7 +1,7 @@
 # shell_ev
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
 
 module ShellEv
   # Minimum of all status values in the Marker, e.g. if at least one Evse in the
@@ -26,5 +26,20 @@ module ShellEv
 
       SINGLE_LOCATION_MARKER_STATUS_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = AVAILABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'available' then AVAILABLE
+      when 'occupied' then OCCUPIED
+      when 'unavailable' then UNAVAILABLE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
   end
 end