Skip to main content
Version: 22.0.x

Class: Authorizations<Parent>

api/entities/common/namespaces/Authorizations.Authorizations

Handles all Authorization related functionality

Type parameters

NameType
Parentextends Signer

Hierarchy

Methods

getHistoricalAuthorizations

getHistoricalAuthorizations(opts?): Promise<ResultSet<AuthorizationRequest>>

Fetch all historical Authorization Requests for which this Signer is the target

Note

supports pagination

Note

uses the middlewareV2

Parameters

NameTypeDescription
optsObject-
opts.size?BigNumberpage size
opts.start?BigNumberpage offset
opts.status?AuthorizationStatusEnumfetch only authorizations with this status. Fetches all statuses if not passed
opts.type?AuthTypeEnumfetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<ResultSet<AuthorizationRequest>>


getOne

getOne(args): Promise<AuthorizationRequest>

Retrieve a single Authorization Request targeting this Signer by its ID

Throws

if there is no Authorization Request with the passed ID targeting this Signer

Parameters

NameType
argsObject
args.idBigNumber

Returns

Promise<AuthorizationRequest>


getReceived

getReceived(opts?): Promise<AuthorizationRequest[]>

Fetch all pending Authorization Requests for which this Signer is the target

Parameters

NameTypeDescription
opts?Object-
opts.includeExpired?booleanwhether to include expired authorizations. Defaults to true
opts.type?AuthorizationTypefetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<AuthorizationRequest[]>