ev-recharge-sdk 1.0.0

data/lib/shell_ev/models/single_location_marker_authorization_methods_items_enum.rb

@@ -0,0 +1,26 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # SingleLocationMarkerAuthorizationMethodsItems.
+  class SingleLocationMarkerAuthorizationMethodsItemsEnum
+    SINGLE_LOCATION_MARKER_AUTHORIZATION_METHODS_ITEMS_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?
+
+      SINGLE_LOCATION_MARKER_AUTHORIZATION_METHODS_ITEMS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/single_location_marker_status_enum.rb

@@ -0,0 +1,30 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # 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
+  class SingleLocationMarkerStatusEnum
+    SINGLE_LOCATION_MARKER_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?
+
+      SINGLE_LOCATION_MARKER_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/stop_charge_session_request_body_json.rb

@@ -0,0 +1,48 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StopChargeSessionRequestBodyJson Model.
+  class StopChargeSessionRequestBodyJson < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Session Id is to be fetched
+    # @return [String]
+    attr_accessor :sesssion_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sesssion_id'] = 'SesssionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sesssion_id = nil)
+      @sesssion_id = sesssion_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sesssion_id = hash.key?('SesssionId') ? hash['SesssionId'] : nil
+
+      # Create object from extracted values.
+      StopChargeSessionRequestBodyJson.new(sesssion_id)
+    end
+  end
+end

data/lib/shell_ev/models/success_response.rb

@@ -0,0 +1,58 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # SuccessResponse Model.
+  class SuccessResponse < 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 [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [ResponseBaseStatusEnum]
+    attr_accessor :status
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = nil,
+                   status = nil)
+      @request_id = request_id
+      @status = status
+    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
+
+      # Create object from extracted values.
+      SuccessResponse.new(request_id,
+                          status)
+    end
+  end
+end

data/lib/shell_ev/models/tariff_vo.rb

@@ -0,0 +1,111 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Tariff details for charging on this Connector
+  class TariffVO < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Tariff to start a charging session
+    # @return [Float]
+    attr_accessor :start_fee
+
+    # Tariff per minute of charging time
+    # @return [Float]
+    attr_accessor :per_minute
+
+    # Tariff per kWh of energy consumed
+    # @return [Float]
+    attr_accessor :per_k_wh
+
+    # ISO 4217 Curreny Code of the local currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # ISO8601-compliant UTC datetime of the last update of the Tariff
+    # @return [String]
+    attr_accessor :updated
+
+    # Source of the last update of the tariff details
+    # @return [TariffVOUpdatedByEnum]
+    attr_accessor :updated_by
+
+    # Tariff structure that this tariff belongs to, typically Default unless
+    # specific tariff is defined for provider
+    # @return [String]
+    attr_accessor :structure
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_fee'] = 'startFee'
+      @_hash['per_minute'] = 'perMinute'
+      @_hash['per_k_wh'] = 'perKWh'
+      @_hash['currency'] = 'currency'
+      @_hash['updated'] = 'updated'
+      @_hash['updated_by'] = 'updatedBy'
+      @_hash['structure'] = 'structure'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_fee
+        per_minute
+        per_k_wh
+        currency
+        updated
+        updated_by
+        structure
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_fee = SKIP,
+                   per_minute = SKIP,
+                   per_k_wh = SKIP,
+                   currency = SKIP,
+                   updated = SKIP,
+                   updated_by = SKIP,
+                   structure = SKIP)
+      @start_fee = start_fee unless start_fee == SKIP
+      @per_minute = per_minute unless per_minute == SKIP
+      @per_k_wh = per_k_wh unless per_k_wh == SKIP
+      @currency = currency unless currency == SKIP
+      @updated = updated unless updated == SKIP
+      @updated_by = updated_by unless updated_by == SKIP
+      @structure = structure unless structure == 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.
+      start_fee = hash.key?('startFee') ? hash['startFee'] : SKIP
+      per_minute = hash.key?('perMinute') ? hash['perMinute'] : SKIP
+      per_k_wh = hash.key?('perKWh') ? hash['perKWh'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      updated = hash.key?('updated') ? hash['updated'] : SKIP
+      updated_by = hash.key?('updatedBy') ? hash['updatedBy'] : SKIP
+      structure = hash.key?('structure') ? hash['structure'] : SKIP
+
+      # Create object from extracted values.
+      TariffVO.new(start_fee,
+                   per_minute,
+                   per_k_wh,
+                   currency,
+                   updated,
+                   updated_by,
+                   structure)
+    end
+  end
+end

data/lib/shell_ev/models/tariff_vo_updated_by_enum.rb

@@ -0,0 +1,29 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Source of the last update of the tariff details
+  class TariffVOUpdatedByEnum
+    TARIFF_VO_UPDATED_BY_ENUM = [
+      # TODO: Write general description for FEED
+      FEED = 'Feed'.freeze,
+
+      # TODO: Write general description for ADMIN
+      ADMIN = 'Admin'.freeze,
+
+      # TODO: Write general description for TARIFFSERVICE
+      TARIFFSERVICE = 'TariffService'.freeze,
+
+      # TODO: Write general description for DEFAULTS
+      DEFAULTS = 'Defaults'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TARIFF_VO_UPDATED_BY_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellEv
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/shell_ev/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end

data/lib/shell_ev/utilities/union_type_lookup.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :MarkersResponse => OneOf.new(
+          [
+            LeafType.new(SingleLocationMarker, UnionTypeContext.new(
+              discriminator_value: 'SingleLocation',
+              discriminator: 'markerType'
+            )),
+            LeafType.new(MultiLocationMarker, UnionTypeContext.new(
+              discriminator_value: 'MultiLocation',
+              discriminator: 'markerType'
+            ))
+          ],
+          UnionTypeContext.new(
+            is_array: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end

data/lib/shell_ev.rb

@@ -0,0 +1,125 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'shell_ev/api_helper'
+require_relative 'shell_ev/client'
+
+# Utilities
+require_relative 'shell_ev/utilities/file_wrapper'
+require_relative 'shell_ev/utilities/date_time_helper'
+require_relative 'shell_ev/utilities/union_type_lookup'
+
+# Http
+require_relative 'shell_ev/http/http_call_back'
+require_relative 'shell_ev/http/http_method_enum'
+require_relative 'shell_ev/http/http_request'
+require_relative 'shell_ev/http/http_response'
+
+# Logger
+require_relative 'shell_ev/http/auth/o_auth2'
+
+# Models
+require_relative 'shell_ev/models/base_model'
+require_relative 'shell_ev/models/data_retrieve'
+require_relative 'shell_ev/models/data_active'
+require_relative 'shell_ev/models/m400_error_response'
+require_relative 'shell_ev/models/m401_error_response'
+require_relative 'shell_ev/models/m404_error_response'
+require_relative 'shell_ev/models/m405_error_response'
+require_relative 'shell_ev/models/m429_error_response'
+require_relative 'shell_ev/models/m500_error_response'
+require_relative 'shell_ev/models/m503_error_response'
+require_relative 'shell_ev/models/m400_error_response_error'
+require_relative 'shell_ev/models/m401_error_response_error'
+require_relative 'shell_ev/models/m404_error_response_error'
+require_relative 'shell_ev/models/m405_error_response_error'
+require_relative 'shell_ev/models/m429_error_response_error'
+require_relative 'shell_ev/models/m500_error_response_error'
+require_relative 'shell_ev/models/m503_error_response_error'
+require_relative 'shell_ev/models/chargesession_start_body'
+require_relative 'shell_ev/models/inline_response202'
+require_relative 'shell_ev/models/inline_response2021'
+require_relative 'shell_ev/models/inline_response202_data'
+require_relative 'shell_ev/models/success_response'
+require_relative 'shell_ev/models/stop_charge_session_request_body_json'
+require_relative 'shell_ev/models/get_charge_session_retrieve_response200_json'
+require_relative 'shell_ev/models/active_response200_json'
+require_relative 'shell_ev/models/response_error401_all_of1'
+require_relative 'shell_ev/models/response_error401_all_of1_errors_items'
+require_relative 'shell_ev/models/location_respone_object'
+require_relative 'shell_ev/models/coordinates'
+require_relative 'shell_ev/models/address'
+require_relative 'shell_ev/models/accessibility'
+require_relative 'shell_ev/models/opening_hours_object'
+require_relative 'shell_ev/models/evse_vo'
+require_relative 'shell_ev/models/connector_vo'
+require_relative 'shell_ev/models/tariff_vo'
+require_relative 'shell_ev/models/electrical_properties'
+require_relative 'shell_ev/models/single_location_marker'
+require_relative 'shell_ev/models/multi_location_marker'
+require_relative 'shell_ev/models/o_auth_token'
+require_relative 'shell_ev/models/' \
+                 'get_charge_session_retrieve_response200_json_status_enum'
+require_relative 'shell_ev/models/active_response200_json_status_enum'
+require_relative 'shell_ev/models/data_retrieve_session_state_enum'
+require_relative 'shell_ev/models/data_retrieve_session_code_enum'
+require_relative 'shell_ev/models/data_active_session_state_enum'
+require_relative 'shell_ev/models/data_active_session_code_enum'
+require_relative 'shell_ev/models/inline_response202_status_enum'
+require_relative 'shell_ev/models/inline_response2021_status_enum'
+require_relative 'shell_ev/models/response_base_status_enum'
+require_relative 'shell_ev/models/env_enum'
+require_relative 'shell_ev/models/' \
+                 'single_location_marker_authorization_methods_items_enum'
+require_relative 'shell_ev/models/get_locations_list_evse_status_enum'
+require_relative 'shell_ev/models/get_locations_list_connector_types_enum'
+require_relative 'shell_ev/models/get_locations_list_authorization_methods_enum'
+require_relative 'shell_ev/models/get_nearby_locations_evse_status_enum'
+require_relative 'shell_ev/models/get_nearby_locations_connector_types_enum'
+require_relative 'shell_ev/models/' \
+                 'get_nearby_locations_authorization_methods_enum'
+require_relative 'shell_ev/models/get_markers_list_evse_status_enum'
+require_relative 'shell_ev/models/get_markers_list_connector_types_enum'
+require_relative 'shell_ev/models/get_markers_list_authorization_methods_enum'
+require_relative 'shell_ev/models/accessibility_status_enum'
+require_relative 'shell_ev/models/evse_vo_status_enum'
+require_relative 'shell_ev/models/evse_vo_authorization_methods_enum'
+require_relative 'shell_ev/models/connector_vo_connector_type_enum'
+require_relative 'shell_ev/models/connector_vo_updated_by_enum'
+require_relative 'shell_ev/models/tariff_vo_updated_by_enum'
+require_relative 'shell_ev/models/electrical_properties_power_type_enum'
+require_relative 'shell_ev/models/single_location_marker_status_enum'
+require_relative 'shell_ev/models/opening_hours_object_week_day_enum'
+require_relative 'shell_ev/models/o_auth_provider_error_enum'
+
+# Exceptions
+require_relative 'shell_ev/exceptions/api_exception'
+require_relative 'shell_ev/exceptions/http401_error_response_exception'
+require_relative 'shell_ev/exceptions/m400_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m404_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m405_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m429_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m500_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m503_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/m401_error_response_error1_exception'
+require_relative 'shell_ev/exceptions/unauthorized_exception'
+require_relative 'shell_ev/exceptions/bad_request_exception'
+require_relative 'shell_ev/exceptions/not_found_exception'
+require_relative 'shell_ev/exceptions/o_auth_provider_exception'
+
+require_relative 'shell_ev/configuration'
+
+# Controllers
+require_relative 'shell_ev/controllers/base_controller'
+require_relative 'shell_ev/controllers/charging_controller'
+require_relative 'shell_ev/controllers/locations_controller'
+require_relative 'shell_ev/controllers/o_auth_authorization_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,34 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'shell_ev'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ShellEv
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+
+    bearer_auth_token = @client.bearer_auth.fetch_token()
+    client_credentials_auth_credentials = _config.client_credentials_auth_credentials.clone_with(o_auth_token: bearer_auth_token)
+    _config = _config.clone_with(client_credentials_auth_credentials: client_credentials_auth_credentials)
+    @client = Client.new(config: _config)
+  end
+end

data/test/controllers/test_charging_controller.rb

@@ -0,0 +1,78 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class ChargingControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.charging
+    @response_catcher = @controller.http_call_back
+  end
+
+  # This API initiates to start a session on a EVSE (Electric Vehicle Supply Equipement). When the EV Charge Card number and the unique EVSE ID on the location is provided, the session is initiated. 
+  #
+  #Please note that this is an asynchronous request, the request will be passed on to the operator/platform to be processed further. 
+  #
+  def test_start_charge_session
+    # Parameters for the API call
+    request_id = 'eb621f45-a543-4d9a-a934-2f223b263c42'
+    body = nil
+
+    # Perform the API call through the SDK function
+    result = @controller.start_charge_session(request_id, body: body)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"RequestId":"9d2dee33-7803-485a-a2b1-2c7538e597ee","Status":"SUCCESS",'\
+      '"Data":[{"SessionId":"c3e332f0-1bb2-4f50-a96b-e075bbb71e68"}]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # This API retrieves the list of active sessions for a given set of EMAIds
+  def test_active
+    # Parameters for the API call
+    ema_id = 'NL-TNM-C0216599X-A'
+    request_id = 'eb621f45-a543-4d9a-a934-2f223b263c42'
+
+    # Perform the API call through the SDK function
+    result = @controller.active(ema_id, request_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"RequestId":"9d2dee33-7803-485a-a2b1-2c7538e597ee","Status":"SUCCESS",'\
+      '"Data":[{"EmaId":"NL-TNM-C0216599X-A","EvseId":"NL*TNM*EVIRTUALCP0002*0'\
+      '","Id":"260f17a9-52d4-4b40-ae74-83832b538975","StartedAt":"2022-10-21T0'\
+      '9:11:23.455Z","SessionState":"started","SessionCode":null,"SessionMessa'\
+      'ge":null,"UserId":"96f69b3b-8ad4-487a-baaa-f1d3db741e88"}]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < ShellEv::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+