Class: Authorizations<Parent>

Defined in: src/api/entities/common/namespaces/Authorizations.ts:35

Handles all Authorization related functionality

Extends

• Namespace<Parent>

Extended by

• IdentityAuthorizations

Type Parameters

Type Parameter
Parent extends Signer

Methods

getHistoricalAuthorizations()

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

Defined in: src/api/entities/common/namespaces/Authorizations.ts:159

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

Parameters

Parameter	Type	Description
opts	{ size?: BigNumber; start?: BigNumber; status?: AuthorizationStatusEnum; type?: AuthTypeEnum; }	‐
opts.size?	BigNumber	page size
opts.start?	BigNumber	page offset
opts.status?	AuthorizationStatusEnum	fetch only authorizations with this status. Fetches all statuses if not passed
opts.type?	AuthTypeEnum	fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<ResultSet<AuthorizationRequest>>

Note

supports pagination

Note

uses the middlewareV2

---

getOne()

getOne(args: object): Promise<AuthorizationRequest>

Defined in: src/api/entities/common/namespaces/Authorizations.ts:89

Retrieve a single Authorization Request targeting this Signer by its ID

Parameters

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Returns

Promise<AuthorizationRequest>

Throws

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

---

getReceived()

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

Defined in: src/api/entities/common/namespaces/Authorizations.ts:42

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

Parameters

Parameter	Type	Description
opts?	{ includeExpired?: boolean; type?: AuthorizationType; }	‐
opts.includeExpired?	boolean	whether to include expired authorizations. Defaults to true
opts.type?	AuthorizationType	fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<AuthorizationRequest[]>