digital-payments-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85269c005e73dd5a3780e4bf7b5c4cbe4b1740e04b07fe7a032b90ecd90586c3
+  data.tar.gz: 1327313a9dfaf08dec8fdad95552d4310e201b5c57d91285623b40cf3bd06546
+SHA512:
+  metadata.gz: e5a7a8e729813efedc83746a546e425037a0ab8b206e6491c413fff42293d67873a617c233a0514bebbee614275c5838e5c84d51eb5f009b6c3566ea12c99d48
+  data.tar.gz: 6096cd6065c02c13f4d24e076f6aea2d57ad2900f4fc252787e4dd334c0bfe7a6b3cf574e076c0d5ece4ccf925b0eaf982757fa17e1006297ea636046ccdf597

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2024 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,85 @@
+
+# Getting Started with Shell EV
+
+## Introduction
+
+The APIs detailed within this document will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install digital-payments-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'digital-payments-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the digital-payments-sdk gem](https://rubygems.org/gems/digital-payments-sdk/versions/1.0.0).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| `mpp_token_credentials` | [`MppTokenCredentials`](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/custom-header-signature.md) | The credential object for Custom Header Signature |
+| `o_auth_token_post_credentials` | [`OAuthTokenPostCredentials`](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+```ruby
+client = ShellEv::Client.new(
+  mpp_token_credentials: MppTokenCredentials.new(
+    authorization: 'Authorization'
+  ),
+  o_auth_token_post_credentials: OAuthTokenPostCredentials.new(
+    x_apigee_authorization: 'X-Apigee-Authorization'
+  )
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`MppToken (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/custom-header-signature.md)
+* [`oAuthTokenPost (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/custom-header-signature-1.md)
+
+## List of APIs
+
+* [Shell API Platform Security Authentication](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/controllers/shell-api-platform-security-authentication.md)
+* [Digital Payment Enablement](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/controllers/digital-payment-enablement.md)
+* [Station Locator](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/controllers/station-locator.md)
+* [Partner Notification](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/controllers/partner-notification.md)
+* [Fueling](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/controllers/fueling.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/digital-payments-ruby-sdk/tree/1.0.0/doc/http-request.md)
+

data/lib/shell_ev/api_helper.rb

@@ -0,0 +1,10 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/shell_ev/client.rb

@@ -0,0 +1,86 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  #  shell_ev client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to shell_api_platform_security_authentication controller.
+    # @return [ShellAPIPlatformSecurityAuthenticationController] Returns the controller instance.
+    def shell_api_platform_security_authentication
+      @shell_api_platform_security_authentication ||= ShellAPIPlatformSecurityAuthenticationController.new @global_configuration
+    end
+
+    # Access to digital_payment_enablement controller.
+    # @return [DigitalPaymentEnablementController] Returns the controller instance.
+    def digital_payment_enablement
+      @digital_payment_enablement ||= DigitalPaymentEnablementController.new @global_configuration
+    end
+
+    # Access to station_locator controller.
+    # @return [StationLocatorController] Returns the controller instance.
+    def station_locator
+      @station_locator ||= StationLocatorController.new @global_configuration
+    end
+
+    # Access to fueling controller.
+    # @return [FuelingController] Returns the controller instance.
+    def fueling
+      @fueling ||= FuelingController.new @global_configuration
+    end
+
+    # Access to partner_notification controller.
+    # @return [PartnerNotificationController] Returns the controller instance.
+    def partner_notification
+      @partner_notification ||= PartnerNotificationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, mpp_token_credentials: nil,
+      o_auth_token_post_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    environment: environment,
+                    mpp_token_credentials: mpp_token_credentials,
+                    o_auth_token_post_credentials: o_auth_token_post_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[MppToken oAuthTokenPost].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['MppToken'] = MppToken.new(http_client_config.mpp_token_credentials)
+      @auth_managers['oAuthTokenPost'] = OAuthTokenPost.new(
+        http_client_config.o_auth_token_post_credentials
+      )
+    end
+  end
+end

data/lib/shell_ev/configuration.rb

@@ -0,0 +1,104 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Digital Payment APIs
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :mpp_token_credentials,
+                :o_auth_token_post_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, mpp_token_credentials: nil,
+      o_auth_token_post_credentials: nil
+    )
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding Custom Header Signature credentials
+      @mpp_token_credentials = mpp_token_credentials
+
+      # The object holding Custom Header Signature credentials
+      @o_auth_token_post_credentials = o_auth_token_post_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, mpp_token_credentials: nil,
+                   o_auth_token_post_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      mpp_token_credentials ||= self.mpp_token_credentials
+      o_auth_token_post_credentials ||= self.o_auth_token_post_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        environment: environment, mpp_token_credentials: mpp_token_credentials,
+        o_auth_token_post_credentials: o_auth_token_post_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api-test.shell.com/ShellDigitalCommerceServices/Payments/B2B/Partner'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/shell_ev/controllers/base_controller.rb

@@ -0,0 +1,66 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/shell_ev/controllers/digital_payment_enablement_controller.rb

@@ -0,0 +1,56 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # DigitalPaymentEnablementController
+  class DigitalPaymentEnablementController < BaseController
+    # Generates a DPAN and stores the relationship between the Reference ID,
+    # DPAN and the real PAN. This method is called during the customer
+    # registration process, ahead of any payment. The Reference ID is an
+    # identifier chosen by the client system for mobile payment registration. It
+    # must be unique in context of the client system, and is the key to
+    # obtaining and managing the payment details later.
+    # @param [MobilePaymentRegistrationRequest] body Required parameter:
+    # Example:
+    # @return [PaymentEnablementResponse] response from the API call
+    def mpay_v1_tokens_ref_put(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/PaymentEnablement/v1/ref',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuthTokenPost')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(PaymentEnablementResponse.method(:from_hash))
+                   .local_error('400',
+                                'Error Occurred. The server cannot or will not process the'\
+                                 ' request due to an apparent client error (e.g., malformed'\
+                                 ' request syntax, invalid request message).',
+                                PaymentEnablementErrorResponseException)
+                   .local_error('401',
+                                'Unauthorized. The request has not been applied because it lacks'\
+                                 ' valid authentication credentials for the target resource.',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden. The server understood the request but refuses to'\
+                                 ' authorize it.',
+                                APIException)
+                   .local_error('404',
+                                'Not Found. The origin server did not find a current'\
+                                 ' representation for the target resource or is not willing to'\
+                                 ' disclose that one exists.',
+                                APIException)
+                   .local_error('500',
+                                'Internal Server Error. The server encountered an unexpected'\
+                                 ' condition that prevented it from fulfilling the request.',
+                                APIException))
+        .execute
+    end
+  end
+end

data/lib/shell_ev/controllers/fueling_controller.rb

@@ -0,0 +1,126 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FuelingController
+  class FuelingController < BaseController
+    # The Digital Payments Service enables 3rd Parties to trigger the refuel
+    # process which, if successful, will unlock a pump/nozzle ready for
+    # fuelling. Enables a 3rd party to request an access token to start using
+    # fueling.
+    #    APIs
+    # @param [String] grant_type Required parameter: In OAuth 2.0, the term
+    # grant type 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 [MppAccesTokenResponse] response from the API call
+    def mpp_token(grant_type,
+                  client_id,
+                  client_secret)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/Fueling/v1/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'))
+                   .auth(Single.new('oAuthTokenPost')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(MppAccesTokenResponse.method(:from_hash))
+                   .local_error('401',
+                                'Unauthorized. The request has not been applied because it lacks'\
+                                 ' valid authentication credentials for the target resource.',
+                                MppAccesTokenErrorResponseException))
+        .execute
+    end
+
+    # Enables a 3rd party to request to unlock a pump so that they may fill up
+    # to a pre-authorised limit. The fuel types that are unlocked may also be
+    # determined by permitted fuels stored against the user/entity profile
+    # @param [String] site_country Required parameter: Country ISO code
+    # @param [String] currency Required parameter: Currency ISO code
+    # @param [PrepareFuelingRequest] body Required parameter: Example:
+    # @return [PrepareFuelingResponse] response from the API call
+    def mpp_prepare_fueling(site_country,
+                            currency,
+                            body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/Fueling/v1/fueling',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(site_country, key: 'siteCountry'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('oAuthTokenPost', 'MppToken')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(PrepareFuelingResponse.method(:from_hash))
+                   .local_error('400',
+                                'Error Occurred. Request did not include bearer token or token'\
+                                 ' provided and is invalid.',
+                                APIException)
+                   .local_error('401',
+                                'Unauthorized',
+                                APIException)
+                   .local_error('403',
+                                'Forbidden. Requestor is not permitted to call the API',
+                                APIException)
+                   .local_error('404',
+                                'Not Found. Request received by the server but requested URL not'\
+                                 ' found',
+                                APIException))
+        .execute
+    end
+
+    # Enables a partner user to cancel pump reservation from the App
+    # @param [String] mpp_transaction_id Required parameter: The ID of the
+    # transaction that’s being cancelled
+    # @return [void] response from the API call
+    def mpp_cancel_fueling(mpp_transaction_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/Fueling/v1/fueling/{mppTransactionId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(mpp_transaction_id, key: 'mppTransactionId')
+                                    .should_encode(true))
+                   .auth(And.new('oAuthTokenPost', 'MppToken')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('400',
+                                'Error Occurred. The server cannot or will not process the'\
+                                 ' request due to an apparent client error (e.g., malformed'\
+                                 ' request syntax, invalid request message). Please see below for'\
+                                 ' information regarding structure of Response Body vs. all'\
+                                 ' possible errors that could be returned.',
+                                CancelFuelingErrorResponseErrorException)
+                   .local_error('401',
+                                'Unauthorized. Request did not include bearer token or token'\
+                                 ' provided and is invalid.',
+                                CancelFuelingErrorResponseErrorException)
+                   .local_error('403',
+                                'Forbidden. Requestor is not permitted to call the API.',
+                                APIException)
+                   .local_error('404',
+                                'Not Found. Request received by the server but requested URL not'\
+                                 ' found',
+                                APIException))
+        .execute
+    end
+  end
+end

data/lib/shell_ev/controllers/partner_notification_controller.rb

@@ -0,0 +1,95 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PartnerNotificationController
+  class PartnerNotificationController < BaseController
+    # To access the Partner’s endpoints, for sending callback messages, Shell
+    # will need to connect to the Partner API end points. It is recemmended that
+    # the partner offers OAuth 2.0 as a standard for call back APIs and will
+    # require the OAuth 2.0 token for authentication. Note this needs to be
+    # implemented over HTTPS
+    # @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 partner_token(grant_type,
+                      client_id,
+                      client_secret)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/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
+
+    # Enables Shell to inform partner of the successful completion of a
+    # transaction. Note this needs to be implemented over HTTPS
+    # @param [FinaliseFuelingRequest] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def finalise_fueling(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/finaliseFueling',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('401',
+                                'Unauthorized',
+                                APIException))
+        .execute
+    end
+
+    # Enables Shell to inform partner that a Mobile Payment transaction has been
+    # cancelled by Shell as an error/issue occured. Note this needs to be
+    # implemented over HTTPS
+    # @param [CancelFuelingRequest] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def cancel_fueling(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/cancelFueling',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('401',
+                                'Unauthorized',
+                                APIException))
+        .execute
+    end
+  end
+end