digital-payments-sdk 1.0.0

data/lib/shell_ev/controllers/shell_api_platform_security_authentication_controller.rb

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ShellAPIPlatformSecurityAuthenticationController
+  class ShellAPIPlatformSecurityAuthenticationController < BaseController
+    # To obtain APIGEE access token
+    # @param [String] grant_type Required parameter: In OAuth 2.0, the term
+    # grant typee refers to the way an application gets an access token. OAuth
+    # 2.0 defines several grant types, including the authorization code flow.
+    # @param [String] client_id Required parameter: After registering your app,
+    # you will receive a client ID and a client secret. The client ID is
+    # considered public information, and is used to build login URLs, or
+    # included in Javascript source code on a page.
+    # @param [String] client_secret Required parameter: After registering your
+    # app, you will receive a client ID and a client secret. The client ID is
+    # considered public information, and is used to build login URLs, or
+    # included in Javascript source code on a page. The client secret must be
+    # kept confidential.
+    # @return [AccessTokenResponse] response from the API call
+    def oauth_token_post(grant_type,
+                         client_id,
+                         client_secret)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/oauth/token',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(grant_type, key: 'grant_type'))
+                   .form_param(new_parameter(client_id, key: 'client_id'))
+                   .form_param(new_parameter(client_secret, key: 'client_secret'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AccessTokenResponse.method(:from_hash))
+                   .local_error('401',
+                                'Unauthorized',
+                                AccessTokenErrorException))
+        .execute
+    end
+  end
+end

data/lib/shell_ev/controllers/station_locator_controller.rb

@@ -0,0 +1,76 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorController
+  class StationLocatorController < BaseController
+    # Returns all sites within specified radius of specified GPS location. Sites
+    # of all Types are returned. This call must be used when attempting to
+    # establish the station the user is located at as part of fuelling journey
+    # (i.e. user has to be within 300m of station to be considered located at
+    # the station). This API could also be used as a general query to find
+    # nearby Shell locations
+    # @param [String] m Required parameter: API Method to be executed
+    # @param [Float] lon Required parameter: The user’s current longitude
+    # @param [Float] lat Required parameter: The user’s current latitude
+    # @param [Float] radius Required parameter: The search radius in
+    # kilometers
+    # @param [String] offer_code Optional parameter: This enables requestor to
+    # specify locations that will honour the specified (advanced) offer code
+    # @param [Integer] n Optional parameter: This enables requestor to limit the
+    # number of locations that are returned and defaulted to a maximum of 250
+    # locations. Locations returned based on distance to User’s location
+    # as-the-crow-flies.
+    # @param [Array[String]] amenities Optional parameter: This enables
+    # requestor to filter locations based on one or more amenities (e.g. Filter
+    # locations so that only those with a Toilet are returned).
+    # @param [Array[String]] countries Optional parameter: This enables
+    # requestor to filter locations based on one or more Countries (i.e. by
+    # country codes).
+    # @return [AroundLocationArray] response from the API call
+    def stationlocator_v1_stations_get_around_location(m,
+                                                       lon,
+                                                       lat,
+                                                       radius,
+                                                       offer_code: nil,
+                                                       n: nil,
+                                                       amenities: nil,
+                                                       countries: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/SiteData/v1/stations/',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(m, key: 'm'))
+                   .query_param(new_parameter(lon, key: 'lon'))
+                   .query_param(new_parameter(lat, key: 'lat'))
+                   .query_param(new_parameter(radius, key: 'radius'))
+                   .query_param(new_parameter(offer_code, key: 'offer_code'))
+                   .query_param(new_parameter(n, key: 'n'))
+                   .query_param(new_parameter(amenities, key: 'amenities'))
+                   .query_param(new_parameter(countries, key: 'countries'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuthTokenPost')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AroundLocationArray.method(:from_hash))
+                   .local_error('400',
+                                'Bad request',
+                                StationLocatorBadRequestException)
+                   .local_error('401',
+                                'Unauthorized',
+                                StationLocatorUnauthorizedException)
+                   .local_error('403',
+                                'Forbbiden',
+                                StationLocatorForbiddenException)
+                   .local_error('404',
+                                'Not Found',
+                                StationLocatorNotFoundException)
+                   .local_error('500',
+                                'Internal Server Error',
+                                StationLocatorInternalServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/shell_ev/exceptions/access_token_error_exception.rb

@@ -0,0 +1,37 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # AccessTokenError class.
+  class AccessTokenErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error = hash.key?('error') ? hash['error'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+  end
+end

data/lib/shell_ev/exceptions/cancel_fueling_error_response_error_exception.rb

@@ -0,0 +1,64 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # # Digital Payments – Errors  This section details the structure of the
+  # response Body vs. the different types of errors that could be returned when
+  # Digital Payments system responds with a 400 Response Code.   | Error Code
+  # | Error Description   | Suggested message to end user   |  |-  |-  |-  |  |
+  # 9342   | Transaction not cancelled, Txn number unknown   | Oops sorry! We
+  # are unable to cancel the transaction. Please wait for the site to cancel the
+  # transaction before you retry   |  | 50004   | Transaction not cancelled,
+  # dispensing is already in progress   | Transaction cannot be cancelled,
+  # fueling already in progress   |  | 50059   | Transaction not cancelable (not
+  # in a 'Processing state')   | Transaction cannot be cancelled, fuel has
+  # already been dispensed   |
+  class CancelFuelingErrorResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The high level error code (e.g. missing data)
+    # @return [String]
+    attr_accessor :error_code
+
+    # The high level error message (e.g. mandatory fields have not been
+    # specified.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Array of error objects. Majority of the time the errorCode and
+    # errorDescription will suffice
+    # @return [Array[MppError]]
+    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)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : 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 << (MppError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+  end
+end

data/lib/shell_ev/exceptions/mpp_acces_token_error_response_exception.rb

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # MppAccesTokenErrorResponse class.
+  class MppAccesTokenErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # error code or short description
+    # @return [String]
+    attr_accessor :error
+
+    # error code or short description due to invalid request or invalid client
+    # ID
+    # @return [String]
+    attr_accessor :error_code
+
+    # Description of the error
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('error_code') ? hash['error_code'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/payment_enablement_error_response_exception.rb

@@ -0,0 +1,37 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PaymentEnablementErrorResponse class.
+  class PaymentEnablementErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @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/station_locator_bad_request_exception.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorBadRequest class.
+  class StationLocatorBadRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/station_locator_forbidden_exception.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorForbidden class.
+  class StationLocatorForbiddenException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/station_locator_internal_server_error_exception.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorInternalServerError class.
+  class StationLocatorInternalServerErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/station_locator_not_found_exception.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorNotFound class.
+  class StationLocatorNotFoundException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+    end
+  end
+end

data/lib/shell_ev/exceptions/station_locator_unauthorized_exception.rb

@@ -0,0 +1,38 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # StationLocatorUnauthorized class.
+  class StationLocatorUnauthorizedException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # 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_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Utility class for custom header authorization.
+  class MppToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'MppToken: authorization is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(mpp_token_credentials)
+      auth_params = {}
+      auth_params['Authorization'] = mpp_token_credentials.authorization unless
+        mpp_token_credentials.nil? || mpp_token_credentials.authorization.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for MppTokenCredentials.
+  # Data class for MppTokenCredentials.
+  class MppTokenCredentials
+    attr_reader :authorization
+
+    def initialize(authorization:)
+      raise ArgumentError, 'authorization cannot be nil' if authorization.nil?
+
+      @authorization = authorization
+    end
+
+    def clone_with(authorization: nil)
+      authorization ||= self.authorization
+
+      MppTokenCredentials.new(authorization: authorization)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Utility class for custom header authorization.
+  class OAuthTokenPost < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuthTokenPost: x_apigee_authorization is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(o_auth_token_post_credentials)
+      auth_params = {}
+      auth_params['X-Apigee-Authorization'] = o_auth_token_post_credentials.x_apigee_authorization unless
+        o_auth_token_post_credentials.nil? || o_auth_token_post_credentials.x_apigee_authorization.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for OAuthTokenPostCredentials.
+  # Data class for OAuthTokenPostCredentials.
+  class OAuthTokenPostCredentials
+    attr_reader :x_apigee_authorization
+
+    def initialize(x_apigee_authorization:)
+      raise ArgumentError, 'x_apigee_authorization cannot be nil' if x_apigee_authorization.nil?
+
+      @x_apigee_authorization = x_apigee_authorization
+    end
+
+    def clone_with(x_apigee_authorization: nil)
+      x_apigee_authorization ||= self.x_apigee_authorization
+
+      OAuthTokenPostCredentials.new(
+        x_apigee_authorization: x_apigee_authorization
+      )
+    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