BaseProduct | mtn-pay

Base class for all products including account, paymentRequests, remittances and disbursements

property: { 'Content-Type': string, 'Ocp-Apim-Subscription-Key': string, 'Authorization': string, 'X-Target-Environment': string,} commonHeaders
property: {IApiToken | undefined} apiToken
method: authenticate()
method: shouldAuthenticate()
method: secondsSince()

Hierarchy

BaseProduct
- Account
- Transaction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseProduct(__namedParameters: object): BaseProduct

- Defined in core/index.ts:27
Parameters
- __namedParameters: object
  - apiKey: string
  - apiuserId: string
  - authBaseURL: string
  - authUrl: string
  - subscriptionKey: string
  - targetEnvironment: string
Returns BaseProduct

Properties

Protected apiToken

apiToken: IApiToken | undefined

Private authResource

authResource: IResource

commonHeaders

commonHeaders: object

Type declaration

Authorization: string
Content-Type: string
Ocp-Apim-Subscription-Key: string
X-Target-Environment: string

Methods

Protected authenticate

authenticate(): Promise<void>

- Defined in core/index.ts:57
Authenticates with remote api if the apiToken is expired or non-existent

Returns Promise<void>

Protected secondsSince

secondsSince(startingTime: Date): number

- Defined in core/index.ts:86
Returns the number of seconds between now and the given startingTime

Parameters
- startingTime: Date
Returns number

Protected shouldAuthenticate

shouldAuthenticate(): boolean

- Defined in core/index.ts:74
Checks whether the apiToken has expired or not; or whether it is exists or not

Returns boolean

Generated using TypeDoc