Account | mtn-pay

class: Account() Details about the account
property: {Date} lastModified

Hierarchy

BaseProduct
- Account

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Account(accountType: string, config: IAccountConfig): Account

Overrides BaseProduct.constructor
- Defined in account/index.ts:18
Parameters
- accountType: string
- config: IAccountConfig
Returns Account

Properties

Private accountResource

accountResource: IResource

Protected apiToken

apiToken: IApiToken | undefined

commonHeaders

commonHeaders: object

Type declaration

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

Private details

details: IAccountDetails | undefined

lastModified

lastModified: Date | undefined

Methods

Protected authenticate

authenticate(): Promise<void>

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

Returns Promise<void>

getDetails

getDetails(forceRefresh?: boolean): Promise<undefined | IAccountDetails>

- Defined in account/index.ts:31
Parameters
- Default value forceRefresh: boolean = false
Returns Promise<undefined | IAccountDetails>

Protected secondsSince

secondsSince(startingTime: Date): number

Inherited from BaseProduct.secondsSince
- 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

Inherited from BaseProduct.shouldAuthenticate
- 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