Class Oid4vciApi

Hierarchy

BaseAPI
- Oid4vciApi

Index

Constructors

Properties

Methods

Constructors

constructor

new Oid4vciApi(configuration?): Oid4vciApi
Parameters
- configuration: Configuration = ...
Returns Oid4vciApi
Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

oid4vciCredentialOfferByRefGet

oid4vciCredentialOfferByRefGet(requestParameters): Promise<CredOfferResponseSchemaRef>
Get a credential offer by reference
Parameters
- requestParameters: Oid4vciCredentialOfferByRefGetRequest
Returns Promise<CredOfferResponseSchemaRef>
- Defined in client/apis/Oid4vciApi.ts:155

oid4vciCredentialOfferByRefGetRaw

oid4vciCredentialOfferByRefGetRaw(requestParameters): Promise<ApiResponse<CredOfferResponseSchemaRef>>
Get a credential offer by reference
Parameters
- requestParameters: Oid4vciCredentialOfferByRefGetRequest
Returns Promise<ApiResponse<CredOfferResponseSchemaRef>>
- Defined in client/apis/Oid4vciApi.ts:125

oid4vciCredentialOfferGet

oid4vciCredentialOfferGet(requestParameters): Promise<CredOfferResponseSchemaVal>
Get a credential offer by value
Parameters
- requestParameters: Oid4vciCredentialOfferGetRequest
Returns Promise<CredOfferResponseSchemaVal>
- Defined in client/apis/Oid4vciApi.ts:196

oid4vciCredentialOfferGetRaw

oid4vciCredentialOfferGetRaw(requestParameters): Promise<ApiResponse<CredOfferResponseSchemaVal>>
Get a credential offer by value
Parameters
- requestParameters: Oid4vciCredentialOfferGetRequest
Returns Promise<ApiResponse<CredOfferResponseSchemaVal>>
- Defined in client/apis/Oid4vciApi.ts:166

oid4vciCredentialSupportedCreateJwtPost

oid4vciCredentialSupportedCreateJwtPost(requestParameters): Promise<SupportedCredential>
Register a configuration for a supported JWT VC credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreateJwtPostRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:231

oid4vciCredentialSupportedCreateJwtPostRaw

oid4vciCredentialSupportedCreateJwtPostRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Register a configuration for a supported JWT VC credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreateJwtPostRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:206

oid4vciCredentialSupportedCreatePost

oid4vciCredentialSupportedCreatePost(requestParameters): Promise<SupportedCredential>
Register a Oid4vci credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreatePostRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:267

oid4vciCredentialSupportedCreatePostRaw

oid4vciCredentialSupportedCreatePostRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Register a Oid4vci credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreatePostRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:242

oid4vciCredentialSupportedCreateSdJwtPost

oid4vciCredentialSupportedCreateSdJwtPost(requestParameters): Promise<SupportedCredential>
This endpoint feeds into the Credential Issuer Metadata reported by the Issuer to its clients. See the SD-JWT VC profile for more details on these properties: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-ID1.html#name-credential-issuer-metadata-6 Register a configuration for a supported SD-JWT VC credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreateSdJwtPostRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:305

oid4vciCredentialSupportedCreateSdJwtPostRaw

oid4vciCredentialSupportedCreateSdJwtPostRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
This endpoint feeds into the Credential Issuer Metadata reported by the Issuer to its clients. See the SD-JWT VC profile for more details on these properties: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-ID1.html#name-credential-issuer-metadata-6 Register a configuration for a supported SD-JWT VC credential
Parameters
- requestParameters: Oid4vciCredentialSupportedCreateSdJwtPostRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:279

oid4vciCredentialSupportedRecordsGet

oid4vciCredentialSupportedRecordsGet(requestParameters): Promise<SupportedCredentialList>
Fetch all credential supported records
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsGetRequest
Returns Promise<SupportedCredentialList>
- Defined in client/apis/Oid4vciApi.ts:348

oid4vciCredentialSupportedRecordsGetRaw

oid4vciCredentialSupportedRecordsGetRaw(requestParameters): Promise<ApiResponse<SupportedCredentialList>>
Fetch all credential supported records
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsGetRequest
Returns Promise<ApiResponse<SupportedCredentialList>>
- Defined in client/apis/Oid4vciApi.ts:318

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDelete

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDelete(requestParameters): Promise<SupportedCredential>
Remove an existing credential supported record
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:394

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRaw

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Remove an existing credential supported record
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:359

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPut

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPut(requestParameters): Promise<SupportedCredential>
Update a Supported Credential. Expected to be a complete replacement of a JWT Supported Credential record, i.e., optional values that aren't supplied will be None, rather than retaining their original value.
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:445

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRaw

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Update a Supported Credential. Expected to be a complete replacement of a JWT Supported Credential record, i.e., optional values that aren't supplied will be None, rather than retaining their original value.
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:407

oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPut

oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPut(requestParameters): Promise<SupportedCredential>
Update a Supported Credential. Expected to be a complete replacement of an SD JWT Supported Credential record, i.e., optional values that aren't supplied will be None, rather than retaining their original value.
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPutRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:496

oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPutRaw

oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPutRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Update a Supported Credential. Expected to be a complete replacement of an SD JWT Supported Credential record, i.e., optional values that aren't supplied will be None, rather than retaining their original value.
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPutRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:458

oid4vciCredentialSupportedRecordsSupportedCredIdGet

oid4vciCredentialSupportedRecordsSupportedCredIdGet(requestParameters): Promise<SupportedCredential>
Get a credential supported record by ID
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSupportedCredIdGetRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:544

oid4vciCredentialSupportedRecordsSupportedCredIdGetRaw

oid4vciCredentialSupportedRecordsSupportedCredIdGetRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Get a credential supported record by ID
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSupportedCredIdGetRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:509

oid4vciCredentialSupportedRecordsSupportedCredIdHead

oid4vciCredentialSupportedRecordsSupportedCredIdHead(requestParameters): Promise<SupportedCredential>
Get a credential supported record by ID
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSupportedCredIdHeadRequest
Returns Promise<SupportedCredential>
- Defined in client/apis/Oid4vciApi.ts:592

oid4vciCredentialSupportedRecordsSupportedCredIdHeadRaw

oid4vciCredentialSupportedRecordsSupportedCredIdHeadRaw(requestParameters): Promise<ApiResponse<SupportedCredential>>
Get a credential supported record by ID
Parameters
- requestParameters: Oid4vciCredentialSupportedRecordsSupportedCredIdHeadRequest
Returns Promise<ApiResponse<SupportedCredential>>
- Defined in client/apis/Oid4vciApi.ts:557

oid4vciExchangeCreatePost

oid4vciExchangeCreatePost(requestParameters): Promise<OID4VCIExchangeRecord>
Create a credential exchange record
Parameters
- requestParameters: Oid4vciExchangeCreatePostRequest
Returns Promise<OID4VCIExchangeRecord>
- Defined in client/apis/Oid4vciApi.ts:630

oid4vciExchangeCreatePostRaw

oid4vciExchangeCreatePostRaw(requestParameters): Promise<ApiResponse<OID4VCIExchangeRecord>>
Create a credential exchange record
Parameters
- requestParameters: Oid4vciExchangeCreatePostRequest
Returns Promise<ApiResponse<OID4VCIExchangeRecord>>
- Defined in client/apis/Oid4vciApi.ts:605

oid4vciExchangeRecordsExchangeIdDelete

oid4vciExchangeRecordsExchangeIdDelete(requestParameters): Promise<OID4VCIExchangeRecord>
Remove an existing exchange record
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdDeleteRequest
Returns Promise<OID4VCIExchangeRecord>
- Defined in client/apis/Oid4vciApi.ts:675

oid4vciExchangeRecordsExchangeIdDeleteRaw

oid4vciExchangeRecordsExchangeIdDeleteRaw(requestParameters): Promise<ApiResponse<OID4VCIExchangeRecord>>
Remove an existing exchange record
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdDeleteRequest
Returns Promise<ApiResponse<OID4VCIExchangeRecord>>
- Defined in client/apis/Oid4vciApi.ts:640

oid4vciExchangeRecordsExchangeIdGet

oid4vciExchangeRecordsExchangeIdGet(requestParameters): Promise<OID4VCIExchangeRecord>
Retrieve an exchange record by ID
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdGetRequest
Returns Promise<OID4VCIExchangeRecord>
- Defined in client/apis/Oid4vciApi.ts:721

oid4vciExchangeRecordsExchangeIdGetRaw

oid4vciExchangeRecordsExchangeIdGetRaw(requestParameters): Promise<ApiResponse<OID4VCIExchangeRecord>>
Retrieve an exchange record by ID
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdGetRequest
Returns Promise<ApiResponse<OID4VCIExchangeRecord>>
- Defined in client/apis/Oid4vciApi.ts:686

oid4vciExchangeRecordsExchangeIdHead

oid4vciExchangeRecordsExchangeIdHead(requestParameters): Promise<OID4VCIExchangeRecord>
Retrieve an exchange record by ID
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdHeadRequest
Returns Promise<OID4VCIExchangeRecord>
- Defined in client/apis/Oid4vciApi.ts:767

oid4vciExchangeRecordsExchangeIdHeadRaw

oid4vciExchangeRecordsExchangeIdHeadRaw(requestParameters): Promise<ApiResponse<OID4VCIExchangeRecord>>
Retrieve an exchange record by ID
Parameters
- requestParameters: Oid4vciExchangeRecordsExchangeIdHeadRequest
Returns Promise<ApiResponse<OID4VCIExchangeRecord>>
- Defined in client/apis/Oid4vciApi.ts:732

oid4vciExchangeRecordsGet

oid4vciExchangeRecordsGet(requestParameters): Promise<ExchangeRecordList>
Fetch all credential exchange records
Parameters
- requestParameters: Oid4vciExchangeRecordsGetRequest
Returns Promise<ExchangeRecordList>
- Defined in client/apis/Oid4vciApi.ts:812

oid4vciExchangeRecordsGetRaw

oid4vciExchangeRecordsGetRaw(requestParameters): Promise<ApiResponse<ExchangeRecordList>>
Fetch all credential exchange records
Parameters
- requestParameters: Oid4vciExchangeRecordsGetRequest
Returns Promise<ApiResponse<ExchangeRecordList>>
- Defined in client/apis/Oid4vciApi.ts:778

`Protected` request

request(context): Promise<Response>
Parameters
- context: RequestOpts
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in client/runtime.ts:50

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34

Class Oid4vciApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns Oid4vciApi

Properties

Protected configuration

Methods

oid4vciCredentialOfferByRefGet

Parameters

requestParameters: Oid4vciCredentialOfferByRefGetRequest

Returns Promise<CredOfferResponseSchemaRef>

oid4vciCredentialOfferByRefGetRaw

Parameters

requestParameters: Oid4vciCredentialOfferByRefGetRequest

Returns Promise<ApiResponse<CredOfferResponseSchemaRef>>

oid4vciCredentialOfferGet

Parameters

requestParameters: Oid4vciCredentialOfferGetRequest

Returns Promise<CredOfferResponseSchemaVal>

oid4vciCredentialOfferGetRaw

Parameters

requestParameters: Oid4vciCredentialOfferGetRequest

Returns Promise<ApiResponse<CredOfferResponseSchemaVal>>

oid4vciCredentialSupportedCreateJwtPost

Parameters

requestParameters: Oid4vciCredentialSupportedCreateJwtPostRequest

Returns Promise<SupportedCredential>

oid4vciCredentialSupportedCreateJwtPostRaw

Parameters

requestParameters: Oid4vciCredentialSupportedCreateJwtPostRequest

Returns Promise<ApiResponse<SupportedCredential>>

oid4vciCredentialSupportedCreatePost

Parameters

requestParameters: Oid4vciCredentialSupportedCreatePostRequest

Returns Promise<SupportedCredential>

oid4vciCredentialSupportedCreatePostRaw

Parameters

requestParameters: Oid4vciCredentialSupportedCreatePostRequest

Returns Promise<ApiResponse<SupportedCredential>>

oid4vciCredentialSupportedCreateSdJwtPost

Parameters

requestParameters: Oid4vciCredentialSupportedCreateSdJwtPostRequest

Returns Promise<SupportedCredential>

oid4vciCredentialSupportedCreateSdJwtPostRaw

Parameters

requestParameters: Oid4vciCredentialSupportedCreateSdJwtPostRequest

Returns Promise<ApiResponse<SupportedCredential>>

oid4vciCredentialSupportedRecordsGet

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsGetRequest

Returns Promise<SupportedCredentialList>

oid4vciCredentialSupportedRecordsGetRaw

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsGetRequest

Returns Promise<ApiResponse<SupportedCredentialList>>

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDelete

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRequest

Returns Promise<SupportedCredential>

oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRaw

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdDeleteRequest

Returns Promise<ApiResponse<SupportedCredential>>

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPut

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRequest

Returns Promise<SupportedCredential>

oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRaw

Parameters

requestParameters: Oid4vciCredentialSupportedRecordsJwtSupportedCredIdPutRequest

Returns Promise<ApiResponse<SupportedCredential>>

oid4vciCredentialSupportedRecordsSdJwtSupportedCredIdPut

Parameters

`Protected` configuration

`Protected` request