Skip to main content

MandaitorClient

@mandaitor/sdk

@mandaitor/sdk / MandaitorClient

Class: MandaitorClient

Defined in: packages/sdk/src/client.ts:26

Constructors​

Constructor​

new MandaitorClient(config): MandaitorClient

Defined in: packages/sdk/src/client.ts:29

Parameters​

config​

MandaitorClientConfig

Returns​

MandaitorClient

Methods​

createMandate()​

createMandate(req): Promise<Mandate>

Defined in: packages/sdk/src/client.ts:88

Parameters​

req​

CreateMandateRequest

Returns​

Promise<Mandate>

getAuditEvents()​

getAuditEvents(mandateId, options?): Promise<PaginatedResponse<AuditEvent>>

Defined in: packages/sdk/src/client.ts:159

Parameters​

mandateId​

string

options?​
cursor?​

string

limit?​

number

Returns​

Promise<PaginatedResponse<AuditEvent>>

getEvent()​

getEvent(eventId): Promise<AuditEvent>

Defined in: packages/sdk/src/client.ts:187

Parameters​

eventId​

string

Returns​

Promise<AuditEvent>

getMandate()​

getMandate(mandateId): Promise<Mandate>

Defined in: packages/sdk/src/client.ts:92

Parameters​

mandateId​

string

Returns​

Promise<Mandate>

getMandateEvents()​

getMandateEvents(mandateId, params?): Promise<PaginatedResponse<AuditEvent>>

Defined in: packages/sdk/src/client.ts:148

Parameters​

mandateId​

string

params?​
cursor?​

string

limit?​

number

Returns​

Promise<PaginatedResponse<AuditEvent>>

listEvents()​

listEvents(params?): Promise<PaginatedResponse<AuditEvent>>

Defined in: packages/sdk/src/client.ts:174

Parameters​

params?​
cursor?​

string

event_type?​

string

limit?​

number

Returns​

Promise<PaginatedResponse<AuditEvent>>

listMandates()​

listMandates(params?): Promise<PaginatedResponse<Mandate>>

Defined in: packages/sdk/src/client.ts:96

Parameters​

params?​
cursor?​

string

limit?​

number

status?​

string

Returns​

Promise<PaginatedResponse<Mandate>>

reactivateMandate()​

reactivateMandate(mandateId): Promise<Mandate>

Defined in: packages/sdk/src/client.ts:117

Parameters​

mandateId​

string

Returns​

Promise<Mandate>

revokeMandate()​

revokeMandate(mandateId, reason?): Promise<Mandate>

Defined in: packages/sdk/src/client.ts:109

Parameters​

mandateId​

string

reason?​

string

Returns​

Promise<Mandate>

suspendMandate()​

suspendMandate(mandateId, reason?): Promise<Mandate>

Defined in: packages/sdk/src/client.ts:113

Parameters​

mandateId​

string

reason?​

string

Returns​

Promise<Mandate>

verify()​

verify(req): Promise<VerifyResponse>

Defined in: packages/sdk/src/client.ts:122

Parameters​

req​

VerifyRequest

Returns​

Promise<VerifyResponse>

verifyWithPoM()​

verifyWithPoM(req, options): Promise<VerifyResponseWithPoM>

Defined in: packages/sdk/src/client.ts:140

Verify an action and optionally request a Proof-of-Mandate VC.

Parameters​

req​

VerifyRequest

options​

VerifyOptions

Returns​

Promise<VerifyResponseWithPoM>

Example​

const result = await client.verifyWithPoM(
  { delegate_subject_id: "agent:v2", action: "approve", resource: "proj/*" },
  { pom: "sd-jwt-vc" },
);
if (result.proof_of_mandate) {
  console.log(result.proof_of_mandate.compact); // SD-JWT string
}