ev-recharge-sdk 1.4.0 → 2.0.0

data/lib/shell_ev/exceptions/v2_charge_session_stop404_error_exception.rb

@@ -0,0 +1,67 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # V2 Charge Session Stop 404 Error class.
+  class V2ChargeSessionStop404ErrorException < APIException
+    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 [String]
+    attr_accessor :request_id
+
+    # Status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Exception details of the error
+    # @return [Array[NotFoundErrMsg]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless 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
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (NotFoundErrMsg.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    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}, errors: #{@errors}>"
+    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}, errors:"\
+      " #{@errors.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/http/auth/o_auth2.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
   # Utility class for OAuth 2 authorization and token management.
@@ -100,7 +100,7 @@ module ShellEv
 
     def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil,
                    o_auth_token_provider: nil, o_auth_on_token_update: nil,
-                   o_auth_clock_skew: nil)
+                   o_auth_clock_skew: 0)
       raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
       raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
 
@@ -112,6 +112,21 @@ module ShellEv
       @o_auth_clock_skew = o_auth_clock_skew
     end
 
+    def self.from_env
+      o_auth_client_id = ENV['O_AUTH_CLIENT_ID']
+      o_auth_client_secret = ENV['O_AUTH_CLIENT_SECRET']
+      o_auth_clock_skew = ENV['O_AUTH_CLOCK_SKEW']
+      all_nil = [
+        o_auth_client_id,
+        o_auth_client_secret
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(o_auth_client_id: o_auth_client_id,
+          o_auth_client_secret: o_auth_client_secret,
+          o_auth_clock_skew: o_auth_clock_skew)
+    end
+
     def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
                    o_auth_token: nil, o_auth_token_provider: nil,
                    o_auth_on_token_update: nil, o_auth_clock_skew: nil)

data/lib/shell_ev/http/http_call_back.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
   # HttpCallBack allows defining callables for pre and post API calls.

data/lib/shell_ev/http/http_method_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
   # HTTP Methods Enumeration.

data/lib/shell_ev/http/http_request.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
   # Represents a single Http Request.

data/lib/shell_ev/http/http_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
   # Http response received.

data/lib/shell_ev/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end

data/lib/shell_ev/models/accessibility_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
   # Accessibility Status
@@ -25,5 +25,20 @@ module ShellEv
 
       ACCESSIBILITY_STATUS_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = FREEPUBLIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'freepublic' then FREEPUBLIC
+      when 'payingpublic' then PAYINGPUBLIC
+      when 'restricted' then RESTRICTED
+      when 'unspecified' then UNSPECIFIED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/shell_ev/models/{accessibility.rb → accessibility_v2.rb}

@@ -1,11 +1,11 @@
 # 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
   # Accessibility of the Location
-  class Accessibility < BaseModel
+  class AccessibilityV2 < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -13,15 +13,10 @@ module ShellEv
     # @return [AccessibilityStatusEnum]
     attr_accessor :status
 
-    # optional Arbitrary text about restrictions of the Location
-    # @return [String]
-    attr_accessor :remark
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['status'] = 'status'
-      @_hash['remark'] = 'remark'
       @_hash
     end
 
@@ -29,7 +24,6 @@ module ShellEv
     def self.optionals
       %w[
         status
-        remark
       ]
     end
 
@@ -38,9 +32,8 @@ module ShellEv
       []
     end
 
-    def initialize(status = SKIP, remark = SKIP)
+    def initialize(status = SKIP)
       @status = status unless status == SKIP
-      @remark = remark unless remark == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,23 +42,21 @@ module ShellEv
 
       # Extract variables from the hash.
       status = hash.key?('status') ? hash['status'] : SKIP
-      remark = hash.key?('remark') ? hash['remark'] : SKIP
 
       # Create object from extracted values.
-      Accessibility.new(status,
-                        remark)
+      AccessibilityV2.new(status)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} status: #{@status}, remark: #{@remark}>"
+      "<#{class_name} status: #{@status}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} status: #{@status.inspect}, remark: #{@remark.inspect}>"
+      "<#{class_name} status: #{@status.inspect}>"
     end
   end
 end

data/lib/shell_ev/models/active_response200_json.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
   # ActiveResponse200Json Model.

data/lib/shell_ev/models/active_response200_json_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
   # Indicates overall status of the request
@@ -19,5 +19,18 @@ module ShellEv
 
       ACTIVE_RESPONSE200_JSON_STATUS_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'success' then SUCCESS
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/shell_ev/models/address.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
   # Address of the Shell Recharge Location

data/lib/shell_ev/models/bad_request_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
   # BadRequestErrMsg Model.

data/lib/shell_ev/models/base_model.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
   # Base model.

data/lib/shell_ev/models/charge_error.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
   # ChargeError Model.

data/lib/shell_ev/models/charge_retrieve_state.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
   # ChargeRetrieveState Model.

data/lib/shell_ev/models/chargesession_start_body.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
   # ChargesessionStartBody Model.

data/lib/shell_ev/models/connector_types_enum.rb

@@ -0,0 +1,100 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ShellEv
+  # connectorTypes.
+  class ConnectorTypesEnum
+    CONNECTOR_TYPES_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_TYPES_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = AVCON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'avcon' then AVCON
+      when 'domestic' then DOMESTIC
+      when 'industrial2pdc' then INDUSTRIAL2PDC
+      when 'industrialpneac' then INDUSTRIALPNEAC
+      when 'industrial3peac' then INDUSTRIAL3PEAC
+      when 'industrial3penac' then INDUSTRIAL3PENAC
+      when 'type1' then TYPE1
+      when 'type1combo' then TYPE1COMBO
+      when 'type2' then TYPE2
+      when 'type2combo' then TYPE2COMBO
+      when 'type3' then TYPE3
+      when 'lpi' then LPI
+      when 'nema520' then NEMA520
+      when 'saej1772' then SAEJ1772
+      when 'spi' then SPI
+      when 'tepcochademo' then TEPCOCHADEMO
+      when 'tesla' then TESLA
+      when 'unspecified' then UNSPECIFIED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/shell_ev/models/connector_v2.rb

@@ -0,0 +1,95 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.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 ConnectorV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Internal identifier used to refer to this Connector
+    # @return [String]
+    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 [ElectricalPropertiesV2]
+    attr_accessor :electrical_properties
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        external_id
+        connector_type
+        electrical_properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, external_id = SKIP, connector_type = SKIP,
+                   electrical_properties = 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
+    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 = ElectricalPropertiesV2.from_hash(hash['electricalProperties']) if
+        hash['electricalProperties']
+
+      # Create object from extracted values.
+      ConnectorV2.new(uid,
+                      external_id,
+                      connector_type,
+                      electrical_properties)
+    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}, connector_type:"\
+      " #{@connector_type}, electrical_properties: #{@electrical_properties}>"
+    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}, connector_type:"\
+      " #{@connector_type.inspect}, electrical_properties: #{@electrical_properties.inspect}>"
+    end
+  end
+end

data/lib/shell_ev/models/connector_vo_connector_type_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
   # Type of the connector in the EVSE unit.
@@ -67,5 +67,34 @@ module ShellEv
 
       CONNECTOR_VO_CONNECTOR_TYPE_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = AVCON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'avcon' then AVCON
+      when 'domestic' then DOMESTIC
+      when 'industrial2pdc' then INDUSTRIAL2PDC
+      when 'industrialpneac' then INDUSTRIALPNEAC
+      when 'industrial3peac' then INDUSTRIAL3PEAC
+      when 'industrial3penac' then INDUSTRIAL3PENAC
+      when 'type1' then TYPE1
+      when 'type1combo' then TYPE1COMBO
+      when 'type2' then TYPE2
+      when 'type2combo' then TYPE2COMBO
+      when 'type3' then TYPE3
+      when 'lpi' then LPI
+      when 'nema520' then NEMA520
+      when 'saej1772' then SAEJ1772
+      when 'spi' then SPI
+      when 'tepcochademo' then TEPCOCHADEMO
+      when 'tesla' then TESLA
+      when 'unspecified' then UNSPECIFIED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/shell_ev/models/connector_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
@@ -25,5 +25,20 @@ module ShellEv
 
       CONNECTOR_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

data/lib/shell_ev/models/coordinates.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
   # Coordinates of the Shell Recharge Site Location