ev-recharge-sdk 1.0.0

data/lib/shell_ev/models/multi_location_marker.rb

@@ -0,0 +1,126 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # A Marker is a place on the map that represent multiple Locations at the same
+  # spot
+  class MultiLocationMarker < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifies the marker type. If it's a `MultiLocationMarker`, then the
+    # value is `MultiLocation`
+    # @return [String]
+    attr_accessor :marker_type
+
+    # Uniquely identifies the marker object
+    # @return [String]
+    attr_accessor :unique_key
+
+    # Coordinates of the Shell Recharge Site Location
+    # @return [Coordinates]
+    attr_accessor :coordinates
+
+    # Number of Locations that this Marker represents in the given set of bounds
+    # @return [Float]
+    attr_accessor :location_count
+
+    # Total number of Evses 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
+
+    # GeoHash of marker coordinates
+    # @return [String]
+    attr_accessor :geo_hash
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['marker_type'] = 'markerType'
+      @_hash['unique_key'] = 'uniqueKey'
+      @_hash['coordinates'] = 'coordinates'
+      @_hash['location_count'] = 'locationCount'
+      @_hash['evse_count'] = 'evseCount'
+      @_hash['max_power'] = 'maxPower'
+      @_hash['geo_hash'] = 'geoHash'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unique_key
+        coordinates
+        location_count
+        evse_count
+        max_power
+        geo_hash
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(marker_type = nil,
+                   unique_key = SKIP,
+                   coordinates = SKIP,
+                   location_count = SKIP,
+                   evse_count = SKIP,
+                   max_power = SKIP,
+                   geo_hash = SKIP)
+      @marker_type = marker_type
+      @unique_key = unique_key unless unique_key == SKIP
+      @coordinates = coordinates unless coordinates == SKIP
+      @location_count = location_count unless location_count == SKIP
+      @evse_count = evse_count unless evse_count == SKIP
+      @max_power = max_power unless max_power == SKIP
+      @geo_hash = geo_hash unless geo_hash == 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.
+      marker_type = hash.key?('markerType') ? hash['markerType'] : nil
+      unique_key = hash.key?('uniqueKey') ? hash['uniqueKey'] : SKIP
+      coordinates = Coordinates.from_hash(hash['coordinates']) if hash['coordinates']
+      location_count = hash.key?('locationCount') ? hash['locationCount'] : SKIP
+      evse_count = hash.key?('evseCount') ? hash['evseCount'] : SKIP
+      max_power = hash.key?('maxPower') ? hash['maxPower'] : SKIP
+      geo_hash = hash.key?('geoHash') ? hash['geoHash'] : SKIP
+
+      # Create object from extracted values.
+      MultiLocationMarker.new(marker_type,
+                              unique_key,
+                              coordinates,
+                              location_count,
+                              evse_count,
+                              max_power,
+                              geo_hash)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MultiLocationMarker | 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
+  end
+end

data/lib/shell_ev/models/o_auth_provider_error_enum.rb

@@ -0,0 +1,45 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # OAuth 2 Authorization error codes
+  class OAuthProviderErrorEnum
+    O_AUTH_PROVIDER_ERROR_ENUM = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/o_auth_token.rb

@@ -0,0 +1,100 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil,
+                   token_type = nil,
+                   expires_in = SKIP,
+                   scope = SKIP,
+                   expiry = SKIP,
+                   refresh_token = SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token)
+    end
+  end
+end

data/lib/shell_ev/models/opening_hours_object.rb

@@ -0,0 +1,70 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # OpeningHoursObject Model.
+  class OpeningHoursObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 3 letter day of the week
+    # @return [OpeningHoursObjectWeekDayEnum]
+    attr_accessor :week_day
+
+    # Hour in 24h local time when the location opens.
+    # @return [String]
+    attr_accessor :start_time
+
+    # Hour in 24h local time when the location closes.
+    # @return [String]
+    attr_accessor :end_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['week_day'] = 'weekDay'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        week_day
+        start_time
+        end_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(week_day = SKIP,
+                   start_time = SKIP,
+                   end_time = SKIP)
+      @week_day = week_day unless week_day == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == 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.
+      week_day = hash.key?('weekDay') ? hash['weekDay'] : SKIP
+      start_time = hash.key?('startTime') ? hash['startTime'] : SKIP
+      end_time = hash.key?('endTime') ? hash['endTime'] : SKIP
+
+      # Create object from extracted values.
+      OpeningHoursObject.new(week_day,
+                             start_time,
+                             end_time)
+    end
+  end
+end

data/lib/shell_ev/models/opening_hours_object_week_day_enum.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # 3 letter day of the week
+  class OpeningHoursObjectWeekDayEnum
+    OPENING_HOURS_OBJECT_WEEK_DAY_ENUM = [
+      # TODO: Write general description for SUN
+      SUN = 'Sun'.freeze,
+
+      # TODO: Write general description for MON
+      MON = 'Mon'.freeze,
+
+      # TODO: Write general description for TUE
+      TUE = 'Tue'.freeze,
+
+      # TODO: Write general description for WED
+      WED = 'Wed'.freeze,
+
+      # TODO: Write general description for THU
+      THU = 'Thu'.freeze,
+
+      # TODO: Write general description for FRI
+      FRI = 'Fri'.freeze,
+
+      # TODO: Write general description for SAT
+      SAT = 'Sat'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPENING_HOURS_OBJECT_WEEK_DAY_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/response_base_status_enum.rb

@@ -0,0 +1,26 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Indicates overall status of the request
+  class ResponseBaseStatusEnum
+    RESPONSE_BASE_STATUS_ENUM = [
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for PARTIAL_SUCCESS
+      PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'.freeze,
+
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'SUCCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESPONSE_BASE_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/response_error401_all_of1.rb

@@ -0,0 +1,57 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ResponseError401AllOf1 Model.
+  class ResponseError401AllOf1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Details of error(s) encountered
+    # @return [Array[ResponseError401AllOf1ErrorsItems]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errors'] = 'Errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errors = nil)
+      @errors = errors
+    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
+      errors = nil
+      unless hash['Errors'].nil?
+        errors = []
+        hash['Errors'].each do |structure|
+          errors << (ResponseError401AllOf1ErrorsItems.from_hash(structure) if structure)
+        end
+      end
+
+      errors = nil unless hash.key?('Errors')
+
+      # Create object from extracted values.
+      ResponseError401AllOf1.new(errors)
+    end
+  end
+end

data/lib/shell_ev/models/response_error401_all_of1_errors_items.rb

@@ -0,0 +1,80 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ResponseError401AllOf1ErrorsItems Model.
+  class ResponseError401AllOf1ErrorsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code that logically best represents the error encountered
+    # @return [String]
+    attr_accessor :code
+
+    # Description of the error type
+    # @return [String]
+    attr_accessor :title
+
+    # Details of the error that can help under the cause of the error
+    # @return [String]
+    attr_accessor :detail
+
+    # Details of the error that can help under the cause of the error
+    # @return [Hash[String, String]]
+    attr_accessor :additional_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['title'] = 'Title'
+      @_hash['detail'] = 'Detail'
+      @_hash['additional_info'] = 'AdditionalInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        additional_info
+      ]
+    end
+
+    def initialize(code = nil,
+                   title = nil,
+                   detail = nil,
+                   additional_info = SKIP)
+      @code = code
+      @title = title
+      @detail = detail
+      @additional_info = additional_info unless additional_info == 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'] : nil
+      title = hash.key?('Title') ? hash['Title'] : nil
+      detail = hash.key?('Detail') ? hash['Detail'] : nil
+      additional_info =
+        hash.key?('AdditionalInfo') ? hash['AdditionalInfo'] : SKIP
+
+      # Create object from extracted values.
+      ResponseError401AllOf1ErrorsItems.new(code,
+                                            title,
+                                            detail,
+                                            additional_info)
+    end
+  end
+end

data/lib/shell_ev/models/single_location_marker.rb

@@ -0,0 +1,157 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # A Marker is a place on the map that represent a single Location
+  class SingleLocationMarker < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifies the marker type. If it''s a `SingleLocationMarker`, then the
+    # value is `SingleLocation`
+    # @return [String]
+    attr_accessor :marker_type
+
+    # Uniquely identifies the marker object
+    # @return [String]
+    attr_accessor :unique_key
+
+    # 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
+
+    # GeoHash of marker coordinates
+    # @return [String]
+    attr_accessor :geo_hash
+
+    # Unique ID of the Location this Marker represents
+    # @return [Float]
+    attr_accessor :location_uid
+
+    # Methods that can be used to Authorize sessions on this EVSE
+    # @return [Array[SingleLocationMarkerAuthorizationMethodsItemsEnum]]
+    attr_accessor :authorization_methods
+
+    # Unique Id of the operator
+    # @return [String]
+    attr_accessor :operator_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['marker_type'] = 'markerType'
+      @_hash['unique_key'] = 'uniqueKey'
+      @_hash['status'] = 'status'
+      @_hash['coordinates'] = 'coordinates'
+      @_hash['evse_count'] = 'evseCount'
+      @_hash['max_power'] = 'maxPower'
+      @_hash['geo_hash'] = 'geoHash'
+      @_hash['location_uid'] = 'locationUid'
+      @_hash['authorization_methods'] = 'authorizationMethods'
+      @_hash['operator_id'] = 'operatorId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unique_key
+        status
+        coordinates
+        evse_count
+        max_power
+        geo_hash
+        location_uid
+        authorization_methods
+        operator_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(marker_type = nil,
+                   unique_key = SKIP,
+                   status = SKIP,
+                   coordinates = SKIP,
+                   evse_count = SKIP,
+                   max_power = SKIP,
+                   geo_hash = SKIP,
+                   location_uid = SKIP,
+                   authorization_methods = SKIP,
+                   operator_id = SKIP)
+      @marker_type = marker_type
+      @unique_key = unique_key unless unique_key == 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
+      @geo_hash = geo_hash unless geo_hash == SKIP
+      @location_uid = location_uid unless location_uid == SKIP
+      @authorization_methods = authorization_methods unless authorization_methods == SKIP
+      @operator_id = operator_id unless operator_id == 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.
+      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']
+      evse_count = hash.key?('evseCount') ? hash['evseCount'] : SKIP
+      max_power = hash.key?('maxPower') ? hash['maxPower'] : SKIP
+      geo_hash = hash.key?('geoHash') ? hash['geoHash'] : SKIP
+      location_uid = hash.key?('locationUid') ? hash['locationUid'] : SKIP
+      authorization_methods =
+        hash.key?('authorizationMethods') ? hash['authorizationMethods'] : SKIP
+      operator_id = hash.key?('operatorId') ? hash['operatorId'] : SKIP
+
+      # Create object from extracted values.
+      SingleLocationMarker.new(marker_type,
+                               unique_key,
+                               status,
+                               coordinates,
+                               evse_count,
+                               max_power,
+                               geo_hash,
+                               location_uid,
+                               authorization_methods,
+                               operator_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SingleLocationMarker | 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
+  end
+end