ev-recharge-sdk 1.3.0 → 2.0.0

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

data/lib/shell_ev/models/single_location_marker_v2.rb

@@ -0,0 +1,157 @@
+# shell_ev
+#
+# 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
+  class SingleLocationMarkerV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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]
+    attr_accessor :coordinates
+
+    # Total number of Evse units in Locations that this Marker represents
+    # @return [Float]
+    attr_accessor :evse_count
+
+    # Maximum power in kW across all locations grouped in this marker
+    # (disregarding availability)
+    # @return [Float]
+    attr_accessor :max_power
+
+    # Number of Locations that this Marker represents in the given set of bounds
+    # @return [Float]
+    attr_accessor :location_count
+
+    # Unique ID of the Location this Marker represents
+    # @return [String]
+    attr_accessor :location_uid
+
+    # Methods that can be used to Authorize sessions on this EVSE
+    # @return [Array[SingleLocationMarkerAuthorizationMethodsItemsEnum]]
+    attr_accessor :authorization_methods
+
+    # Operator of this Shell Recharge Location
+    # @return [String]
+    attr_accessor :operator_name
+
+    # Type of the Marker, in this case it will always be SingleLocation
+    # @return [String]
+    attr_reader :marker_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['coordinates'] = 'coordinates'
+      @_hash['evse_count'] = 'evseCount'
+      @_hash['max_power'] = 'maxPower'
+      @_hash['location_count'] = 'locationCount'
+      @_hash['location_uid'] = 'locationUid'
+      @_hash['authorization_methods'] = 'authorizationMethods'
+      @_hash['operator_name'] = 'operatorName'
+      @_hash['marker_type'] = 'markerType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        coordinates
+        evse_count
+        max_power
+        location_count
+        location_uid
+        authorization_methods
+        operator_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP, coordinates = SKIP, evse_count = SKIP,
+                   max_power = SKIP, location_count = SKIP, location_uid = SKIP,
+                   authorization_methods = SKIP, operator_name = SKIP)
+      @status = status unless status == SKIP
+      @coordinates = coordinates unless coordinates == SKIP
+      @evse_count = evse_count unless evse_count == SKIP
+      @max_power = max_power unless max_power == SKIP
+      @location_count = location_count unless location_count == SKIP
+      @location_uid = location_uid unless location_uid == SKIP
+      @authorization_methods = authorization_methods unless authorization_methods == SKIP
+      @operator_name = operator_name unless operator_name == SKIP
+      @marker_type = 'SingleLocation'
+    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
+      coordinates = Coordinates.from_hash(hash['coordinates']) if hash['coordinates']
+      evse_count = hash.key?('evseCount') ? hash['evseCount'] : SKIP
+      max_power = hash.key?('maxPower') ? hash['maxPower'] : SKIP
+      location_count = hash.key?('locationCount') ? hash['locationCount'] : SKIP
+      location_uid = hash.key?('locationUid') ? hash['locationUid'] : SKIP
+      authorization_methods =
+        hash.key?('authorizationMethods') ? hash['authorizationMethods'] : SKIP
+      operator_name = hash.key?('operatorName') ? hash['operatorName'] : SKIP
+
+      # Create object from extracted values.
+      SingleLocationMarkerV2.new(status,
+                                 coordinates,
+                                 evse_count,
+                                 max_power,
+                                 location_count,
+                                 location_uid,
+                                 authorization_methods,
+                                 operator_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SingleLocationMarkerV2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.marker_type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['markerType'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, coordinates: #{@coordinates}, evse_count:"\
+      " #{@evse_count}, max_power: #{@max_power}, location_count: #{@location_count},"\
+      " location_uid: #{@location_uid}, authorization_methods: #{@authorization_methods},"\
+      " operator_name: #{@operator_name}, marker_type: #{@marker_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, coordinates: #{@coordinates.inspect},"\
+      " evse_count: #{@evse_count.inspect}, max_power: #{@max_power.inspect}, location_count:"\
+      " #{@location_count.inspect}, location_uid: #{@location_uid.inspect}, authorization_methods:"\
+      " #{@authorization_methods.inspect}, operator_name: #{@operator_name.inspect}, marker_type:"\
+      " #{@marker_type.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/tariff.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
   # Tariff Model.
@@ -29,7 +29,7 @@ module ShellEv
     # @return [String]
     attr_accessor :updated
 
-    # ISO8601-compliant UTC datetime of the last update of the Tariff
+    # Source of the last update of the tariff details
     # @return [TariffVOUpdatedByEnum]
     attr_accessor :updated_by
 
@@ -103,5 +103,22 @@ module ShellEv
                  updated_by,
                  structure)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_fee: #{@start_fee}, per_minute: #{@per_minute}, per_k_wh:"\
+      " #{@per_k_wh}, currency: #{@currency}, updated: #{@updated}, updated_by: #{@updated_by},"\
+      " structure: #{@structure}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_fee: #{@start_fee.inspect}, per_minute: #{@per_minute.inspect},"\
+      " per_k_wh: #{@per_k_wh.inspect}, currency: #{@currency.inspect}, updated:"\
+      " #{@updated.inspect}, updated_by: #{@updated_by.inspect}, structure:"\
+      " #{@structure.inspect}>"
+    end
   end
 end

data/lib/shell_ev/models/tariff_alt_text.rb

@@ -0,0 +1,68 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # TariffAltText Model.
+  class TariffAltText < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO language code
+    # @return [String]
+    attr_accessor :language
+
+    # Human readable tariff description
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['language'] = 'language'
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(language = nil, text = nil)
+      @language = language
+      @text = text
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      language = hash.key?('language') ? hash['language'] : nil
+      text = hash.key?('text') ? hash['text'] : nil
+
+      # Create object from extracted values.
+      TariffAltText.new(language,
+                        text)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} language: #{@language}, text: #{@text}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} language: #{@language.inspect}, text: #{@text.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/tariff_element.rb

@@ -0,0 +1,80 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # TariffElement Model.
+  class TariffElement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PriceComponent]]
+    attr_accessor :price_components
+
+    # TODO: Write general description for this method
+    # @return [Restrictions]
+    attr_accessor :restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_components'] = 'priceComponents'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_components = nil, restrictions = SKIP)
+      @price_components = price_components
+      @restrictions = restrictions unless restrictions == 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.
+      # Parameter is an array, so we need to iterate through it
+      price_components = nil
+      unless hash['priceComponents'].nil?
+        price_components = []
+        hash['priceComponents'].each do |structure|
+          price_components << (PriceComponent.from_hash(structure) if structure)
+        end
+      end
+
+      price_components = nil unless hash.key?('priceComponents')
+      restrictions = Restrictions.from_hash(hash['restrictions']) if hash['restrictions']
+
+      # Create object from extracted values.
+      TariffElement.new(price_components,
+                        restrictions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_components: #{@price_components}, restrictions: #{@restrictions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_components: #{@price_components.inspect}, restrictions:"\
+      " #{@restrictions.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/tariff_type_enum.rb

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # Tariff type classification
+  class TariffTypeEnum
+    TARIFF_TYPE_ENUM = [
+      # TODO: Write general description for DRIVER
+      DRIVER = 'DRIVER'.freeze,
+
+      # TODO: Write general description for ROAMING
+      ROAMING = 'ROAMING'.freeze,
+
+      # TODO: Write general description for REIMBURSEMENT
+      REIMBURSEMENT = 'REIMBURSEMENT'.freeze,
+
+      # TODO: Write general description for VMSP
+      VMSP = 'VMSP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TARIFF_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DRIVER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'driver' then DRIVER
+      when 'roaming' then ROAMING
+      when 'reimbursement' then REIMBURSEMENT
+      when 'vmsp' then VMSP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/shell_ev/models/tariff_v2.rb

@@ -0,0 +1,226 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ShellEv
+  # Tariff metadata aligned with TariffV2 GraphQL schema
+  class TariffV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the tariff
+    # @return [String]
+    attr_accessor :tariff_id
+
+    # Tariff type classification
+    # @return [TariffTypeEnum]
+    attr_accessor :tariff_type
+
+    # Tariff type classification
+    # @return [PowerRange]
+    attr_accessor :power_range
+
+    # Internal identifier used by the platform
+    # @return [String]
+    attr_accessor :internal_id
+
+    # Unique identifier of the operator
+    # @return [String]
+    attr_accessor :operator_id
+
+    # Unique identifier of the provider
+    # @return [String]
+    attr_accessor :provider_id
+
+    # ISO 4217 Currency Code
+    # @return [String]
+    attr_accessor :currency
+
+    # ISO 4217 Currency Code
+    # @return [Array[TariffAltText]]
+    attr_accessor :tariff_alt_text
+
+    # ISO 4217 Currency Code
+    # @return [Float]
+    attr_accessor :min_price
+
+    # ISO 4217 Currency Code
+    # @return [Float]
+    attr_accessor :max_price
+
+    # ISO 4217 Currency Code
+    # @return [Array[TariffElement]]
+    attr_accessor :elements
+
+    # ISO 4217 Currency Code
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # ISO 4217 Currency Code
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # ISO 4217 Currency Code
+    # @return [DateTime]
+    attr_accessor :last_updated
+
+    # Identifier of the actor who created the tariff
+    # @return [String]
+    attr_accessor :created_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tariff_id'] = 'tariffId'
+      @_hash['tariff_type'] = 'tariffType'
+      @_hash['power_range'] = 'powerRange'
+      @_hash['internal_id'] = 'internalId'
+      @_hash['operator_id'] = 'operatorId'
+      @_hash['provider_id'] = 'providerId'
+      @_hash['currency'] = 'currency'
+      @_hash['tariff_alt_text'] = 'tariffAltText'
+      @_hash['min_price'] = 'minPrice'
+      @_hash['max_price'] = 'maxPrice'
+      @_hash['elements'] = 'elements'
+      @_hash['start_date_time'] = 'startDateTime'
+      @_hash['end_date_time'] = 'endDateTime'
+      @_hash['last_updated'] = 'lastUpdated'
+      @_hash['created_by'] = 'createdBy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tariff_alt_text
+      ]
+    end
+
+    def initialize(tariff_id = nil, tariff_type = nil, power_range = nil,
+                   internal_id = nil, operator_id = nil, provider_id = nil,
+                   currency = nil, tariff_alt_text = nil, min_price = nil,
+                   max_price = nil, elements = nil, start_date_time = nil,
+                   end_date_time = nil, last_updated = nil, created_by = nil)
+      @tariff_id = tariff_id
+      @tariff_type = tariff_type
+      @power_range = power_range
+      @internal_id = internal_id
+      @operator_id = operator_id
+      @provider_id = provider_id
+      @currency = currency
+      @tariff_alt_text = tariff_alt_text
+      @min_price = min_price
+      @max_price = max_price
+      @elements = elements
+      @start_date_time = start_date_time
+      @end_date_time = end_date_time
+      @last_updated = last_updated
+      @created_by = created_by
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tariff_id = hash.key?('tariffId') ? hash['tariffId'] : nil
+      tariff_type = hash.key?('tariffType') ? hash['tariffType'] : nil
+      power_range = PowerRange.from_hash(hash['powerRange']) if hash['powerRange']
+      internal_id = hash.key?('internalId') ? hash['internalId'] : nil
+      operator_id = hash.key?('operatorId') ? hash['operatorId'] : nil
+      provider_id = hash.key?('providerId') ? hash['providerId'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      # Parameter is an array, so we need to iterate through it
+      tariff_alt_text = nil
+      unless hash['tariffAltText'].nil?
+        tariff_alt_text = []
+        hash['tariffAltText'].each do |structure|
+          tariff_alt_text << (TariffAltText.from_hash(structure) if structure)
+        end
+      end
+
+      tariff_alt_text = nil unless hash.key?('tariffAltText')
+      min_price = hash.key?('minPrice') ? hash['minPrice'] : nil
+      max_price = hash.key?('maxPrice') ? hash['maxPrice'] : nil
+      # Parameter is an array, so we need to iterate through it
+      elements = nil
+      unless hash['elements'].nil?
+        elements = []
+        hash['elements'].each do |structure|
+          elements << (TariffElement.from_hash(structure) if structure)
+        end
+      end
+
+      elements = nil unless hash.key?('elements')
+      start_date_time = if hash.key?('startDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['startDateTime']) if hash['startDateTime'])
+                        end
+      end_date_time = if hash.key?('endDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['endDateTime']) if hash['endDateTime'])
+                      end
+      last_updated = if hash.key?('lastUpdated')
+                       (DateTimeHelper.from_rfc3339(hash['lastUpdated']) if hash['lastUpdated'])
+                     end
+      created_by = hash.key?('createdBy') ? hash['createdBy'] : nil
+
+      # Create object from extracted values.
+      TariffV2.new(tariff_id,
+                   tariff_type,
+                   power_range,
+                   internal_id,
+                   operator_id,
+                   provider_id,
+                   currency,
+                   tariff_alt_text,
+                   min_price,
+                   max_price,
+                   elements,
+                   start_date_time,
+                   end_date_time,
+                   last_updated,
+                   created_by)
+    end
+
+    def to_custom_start_date_time
+      DateTimeHelper.to_rfc3339(start_date_time)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_date_time)
+    end
+
+    def to_custom_last_updated
+      DateTimeHelper.to_rfc3339(last_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tariff_id: #{@tariff_id}, tariff_type: #{@tariff_type}, power_range:"\
+      " #{@power_range}, internal_id: #{@internal_id}, operator_id: #{@operator_id}, provider_id:"\
+      " #{@provider_id}, currency: #{@currency}, tariff_alt_text: #{@tariff_alt_text}, min_price:"\
+      " #{@min_price}, max_price: #{@max_price}, elements: #{@elements}, start_date_time:"\
+      " #{@start_date_time}, end_date_time: #{@end_date_time}, last_updated: #{@last_updated},"\
+      " created_by: #{@created_by}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tariff_id: #{@tariff_id.inspect}, tariff_type: #{@tariff_type.inspect},"\
+      " power_range: #{@power_range.inspect}, internal_id: #{@internal_id.inspect}, operator_id:"\
+      " #{@operator_id.inspect}, provider_id: #{@provider_id.inspect}, currency:"\
+      " #{@currency.inspect}, tariff_alt_text: #{@tariff_alt_text.inspect}, min_price:"\
+      " #{@min_price.inspect}, max_price: #{@max_price.inspect}, elements: #{@elements.inspect},"\
+      " start_date_time: #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect},"\
+      " last_updated: #{@last_updated.inspect}, created_by: #{@created_by.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/tariff_vo_updated_by_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
   # Source of the last update of the tariff details
@@ -25,5 +25,20 @@ module ShellEv
 
       TARIFF_VO_UPDATED_BY_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = FEED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'feed' then FEED
+      when 'admin' then ADMIN
+      when 'tariffservice' then TARIFFSERVICE
+      when 'defaults' then DEFAULTS
+      else
+        default_value
+      end
+    end
   end
 end