digital-payments-sdk
Version:
The APIs detailed within this SDK will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.
49 lines (48 loc) • 2.83 kB
TypeScript
/**
* Shell SmartPay APILib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { MppAccesTokenResponse } from '../models/mppAccesTokenResponse';
import { PrepareFuelingRequest } from '../models/prepareFuelingRequest';
import { PrepareFuelingResponse } from '../models/prepareFuelingResponse';
import { BaseController } from './baseController';
export declare class FuelingController extends 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 grantType 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 clientId 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 clientSecret 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 Response from the API call
*/
mppToken(grantType: string, clientId: string, clientSecret: string, requestOptions?: RequestOptions): Promise<ApiResponse<MppAccesTokenResponse>>;
/**
* 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 siteCountry Country ISO code
* @param currency Currency ISO code
* @param body
* @return Response from the API call
*/
mppPrepareFueling(siteCountry: string, currency: string, body: PrepareFuelingRequest, requestOptions?: RequestOptions): Promise<ApiResponse<PrepareFuelingResponse>>;
/**
* Enables a partner user to cancel pump reservation from the App
*
* @param mppTransactionId The ID of the transaction that’s being cancelled
* @return Response from the API call
*/
mppCancelFueling(mppTransactionId: string, requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
}