Class CredentialRequests

Class providing methods for working with credential requests

Index

Constructors

Methods

create createAction declineCredential delete deleteCredential get getCredential getDetail list

Constructors

constructor

new CredentialRequests(fetch: FetchFunction): CredentialRequests
Parameters
- fetch: FetchFunction
Returns CredentialRequests
- Defined in src/endpoints/credential-requests.ts:147

Methods

create

create(body: CreateCredentialRequestBody): Promise<CredentialRequest>
Create a new credential request
Parameters
- body: CreateCredentialRequestBody
Returns Promise<CredentialRequest>
- Defined in src/endpoints/credential-requests.ts:167

createAction

createAction(
body: CreateCredentialActionBody,
): Promise<{ publicUri: string; request: CredentialRequest }>
Create a new action for credential creation (connection or key)
Parameters
- body: CreateCredentialActionBody
Returns Promise<{ publicUri: string; request: CredentialRequest }>
- Defined in src/endpoints/credential-requests.ts:254

declineCredential

declineCredential(credentialId: string, reason?: string): Promise<Credential>
Decline a credential by ID
Parameters
- credentialId: string
- Optionalreason: string
Returns Promise<Credential>
- Defined in src/endpoints/credential-requests.ts:229

delete

delete(requestId: string): Promise<void>
Delete a credential request and all associated credentials (connections and keys) by ID
Parameters
- requestId: string
  The ID of the credential request to delete
Returns Promise<void>
- Defined in src/endpoints/credential-requests.ts:203

deleteCredential

deleteCredential(credentialId: string): Promise<Credential>
Delete a credential and reset its state to pending
Parameters
- credentialId: string
Returns Promise<Credential>
- Defined in src/endpoints/credential-requests.ts:243

get

get<C extends keyof CredentialRequest = never>(
requestId: string,
options?: GetCredentialRequestOptions<C>,
): Promise<PickColumns<CredentialRequest, C>>
Get a credential request by ID
Type Parameters
- C extends keyof CredentialRequest = never
Parameters
- requestId: string
- options: GetCredentialRequestOptions<C> = {}
Returns Promise<PickColumns<CredentialRequest, C>>
- Defined in src/endpoints/credential-requests.ts:178

getCredential

getCredential<C extends keyof Credential = never>(
credentialId: string,
options?: { cols?: ["*"] | C[] },
): Promise<PickColumns<Credential, C>>
Get a credential detail by credential ID
Type Parameters
- C extends keyof Credential = never
Parameters
- credentialId: string
- options: { cols?: ["*"] | C[] } = {}
Returns Promise<PickColumns<Credential, C>>
- Defined in src/endpoints/credential-requests.ts:215

getDetail

getDetail(requestId: string): Promise<CredentialRequestDetail>
Get full detail of a credential request including associated credentials
Parameters
- requestId: string
Returns Promise<CredentialRequestDetail>
- Defined in src/endpoints/credential-requests.ts:192

list

list<C extends keyof CredentialRequest = never>(
options?: ListCredentialRequestsOptions<C>,
): Promise<PickColumns<CredentialRequest, C>[]>
List credential requests with optional filtering and pagination
Type Parameters
- C extends keyof CredentialRequest = never
Parameters
- options: ListCredentialRequestsOptions<C> = {}
Returns Promise<PickColumns<CredentialRequest, C>[]>
- Defined in src/endpoints/credential-requests.ts:154