• management
• SDK
• TemplatesClient

Class TemplatesClient

Index

Constructors

constructor

Methods

listcreategetdeleteupdate

Properties

_options

Constructors

constructor

new TemplatesClient(options: BaseClientOptions): TemplatesClient

Parameters

• options: BaseClientOptions

Returns TemplatesClient

Methods

list

list(
request?: ListVerifiableCredentialTemplatesRequestParameters,
requestOptions?: TemplatesClient.RequestOptions,
): Promise<
Page<
VerifiableCredentialTemplateResponse,
ListVerifiableCredentialTemplatesPaginatedResponseContent,
>,
>

List verifiable credential templates.

Parameters

• request: ListVerifiableCredentialTemplatesRequestParameters = {}
• OptionalrequestOptions: TemplatesClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< VerifiableCredentialTemplateResponse, ListVerifiableCredentialTemplatesPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.verifiableCredentials.verification.templates.list({ from: "from", take: 1 })Copy

create

create(
request: CreateVerifiableCredentialTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<CreateVerifiableCredentialTemplateResponseContent>

Create a verifiable credential template.

Parameters

• request: CreateVerifiableCredentialTemplateRequestContent
• OptionalrequestOptions: TemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateVerifiableCredentialTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.verifiableCredentials.verification.templates.create({ name: "name", type: "type", dialect: "dialect", presentation: { "org.iso.18013.5.1.mDL": { "org.iso.18013.5.1": {} } }, well_known_trusted_issuers: "well_known_trusted_issuers" })Copy

get

get(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<GetVerifiableCredentialTemplateResponseContent>

Get a verifiable credential template.

Parameters

• id: string

ID of the template to retrieve.

• OptionalrequestOptions: TemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetVerifiableCredentialTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.verifiableCredentials.verification.templates.get("id")Copy

delete

delete(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<void>

Delete a verifiable credential template.

Parameters

• id: string

ID of the template to retrieve.

• OptionalrequestOptions: TemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.verifiableCredentials.verification.templates.delete("id")Copy

update

update(
id: string,
request?: UpdateVerifiableCredentialTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<UpdateVerifiableCredentialTemplateResponseContent>

Update a verifiable credential template.

Parameters

• id: string

ID of the template to retrieve.

• request: UpdateVerifiableCredentialTemplateRequestContent = {}
• OptionalrequestOptions: TemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateVerifiableCredentialTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.verifiableCredentials.verification.templates.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetdeleteupdate Properties _options