ev-recharge-sdk 1.0.0

data/lib/shell_ev/exceptions/m405_error_response_error1_exception.rb

@@ -0,0 +1,52 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Method Not Allowed
+  class M405ErrorResponseError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[M405ErrorResponseError]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
+      @status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['Errors'].nil?
+        @errors = []
+        hash['Errors'].each do |structure|
+          @errors << (M405ErrorResponseError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('Errors')
+    end
+  end
+end

data/lib/shell_ev/exceptions/m429_error_response_error1_exception.rb

@@ -0,0 +1,52 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Too Many Requests
+  class M429ErrorResponseError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[M429ErrorResponseError]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
+      @status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['Errors'].nil?
+        @errors = []
+        hash['Errors'].each do |structure|
+          @errors << (M429ErrorResponseError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('Errors')
+    end
+  end
+end

data/lib/shell_ev/exceptions/m500_error_response_error1_exception.rb

@@ -0,0 +1,52 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # 500ErrorResponse_Error1 class.
+  class M500ErrorResponseError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[M500ErrorResponseError]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
+      @status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['Errors'].nil?
+        @errors = []
+        hash['Errors'].each do |structure|
+          @errors << (M500ErrorResponseError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('Errors')
+    end
+  end
+end

data/lib/shell_ev/exceptions/m503_error_response_error1_exception.rb

@@ -0,0 +1,52 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # 503ErrorResponse_Error1 class.
+  class M503ErrorResponseError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[M503ErrorResponseError]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
+      @status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['Errors'].nil?
+        @errors = []
+        hash['Errors'].each do |structure|
+          @errors << (M503ErrorResponseError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('Errors')
+    end
+  end
+end

data/lib/shell_ev/exceptions/not_found_exception.rb

@@ -0,0 +1,37 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # NotFound class.
+  class NotFoundException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :code
+
+    # Error desctiption in English
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @code = hash.key?('code') ? hash['code'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,48 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/unauthorized_exception.rb

@@ -0,0 +1,37 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Unauthorized class.
+  class UnauthorizedException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :code
+
+    # Error desctiption in English
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] 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] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @code = hash.key?('code') ? hash['code'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/http/auth/o_auth2.rb

@@ -0,0 +1,90 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ClientCredentialsAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(client_credentials_auth_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = client_credentials_auth_credentials.o_auth_client_id unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = client_credentials_auth_credentials.o_auth_client_secret unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = client_credentials_auth_credentials.o_auth_token unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.o_auth_token.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token(
+        build_basic_auth_header,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for ClientCredentialsAuthCredentials.
+  class ClientCredentialsAuthCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil)
+      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?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_token = o_auth_token
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_token ||= self.o_auth_token
+
+      ClientCredentialsAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token
+      )
+    end
+  end
+end

data/lib/shell_ev/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/shell_ev/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/shell_ev/http/http_request.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/shell_ev/http/http_response.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/shell_ev/models/accessibility.rb

@@ -0,0 +1,60 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Accessibility of the Location
+  class Accessibility < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Accessibility Status
+    # @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
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        remark
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP,
+                   remark = SKIP)
+      @status = status unless status == SKIP
+      @remark = remark unless remark == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      remark = hash.key?('remark') ? hash['remark'] : SKIP
+
+      # Create object from extracted values.
+      Accessibility.new(status,
+                        remark)
+    end
+  end
+end

data/lib/shell_ev/models/accessibility_status_enum.rb

@@ -0,0 +1,29 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Accessibility Status
+  class AccessibilityStatusEnum
+    ACCESSIBILITY_STATUS_ENUM = [
+      # TODO: Write general description for FREEPUBLIC
+      FREEPUBLIC = 'FreePublic'.freeze,
+
+      # TODO: Write general description for PAYINGPUBLIC
+      PAYINGPUBLIC = 'PayingPublic'.freeze,
+
+      # TODO: Write general description for RESTRICTED
+      RESTRICTED = 'Restricted'.freeze,
+
+      # TODO: Write general description for UNSPECIFIED
+      UNSPECIFIED = 'Unspecified'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCESSIBILITY_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_ev/models/active_response200_json.rb

@@ -0,0 +1,78 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ActiveResponse200Json Model.
+  class ActiveResponse200Json < 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 [UUID | String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [ActiveResponse200JsonStatusEnum]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[DataActive]]
+    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[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = nil,
+                   status = nil,
+                   data = SKIP)
+      @request_id = request_id
+      @status = status
+      @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'] : nil
+      status = hash.key?('Status') ? hash['Status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (DataActive.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      ActiveResponse200Json.new(request_id,
+                                status,
+                                data)
+    end
+  end
+end

data/lib/shell_ev/models/active_response200_json_status_enum.rb

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