Class WalletApi

Hierarchy

BaseAPI
- WalletApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

`Protected` request

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

walletDidCreatePost

walletDidCreatePost(requestParameters): Promise<DIDResult>
Create a local DID
Parameters
- requestParameters: WalletDidCreatePostRequest
Returns Promise<DIDResult>
- Defined in client/apis/WalletApi.ts:158

walletDidCreatePostRaw

walletDidCreatePostRaw(requestParameters): Promise<ApiResponse<DIDResult>>
Create a local DID
Parameters
- requestParameters: WalletDidCreatePostRequest
Returns Promise<ApiResponse<DIDResult>>
- Defined in client/apis/WalletApi.ts:133

walletDidGet

walletDidGet(requestParameters): Promise<DIDList>
List wallet DIDs
Parameters
- requestParameters: WalletDidGetRequest
Returns Promise<DIDList>
- Defined in client/apis/WalletApi.ts:210

walletDidGetRaw

walletDidGetRaw(requestParameters): Promise<ApiResponse<DIDList>>
List wallet DIDs
Parameters
- requestParameters: WalletDidGetRequest
Returns Promise<ApiResponse<DIDList>>
- Defined in client/apis/WalletApi.ts:168

walletDidLocalRotateKeypairPatch

walletDidLocalRotateKeypairPatch(requestParameters): Promise<object>
Rotate keypair for a DID not posted to the ledger
Parameters
- requestParameters: WalletDidLocalRotateKeypairPatchRequest
Returns Promise<object>
- Defined in client/apis/WalletApi.ts:249

walletDidLocalRotateKeypairPatchRaw

walletDidLocalRotateKeypairPatchRaw(requestParameters): Promise<ApiResponse<object>>
Rotate keypair for a DID not posted to the ledger
Parameters
- requestParameters: WalletDidLocalRotateKeypairPatchRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/WalletApi.ts:218

walletDidPublicGet

walletDidPublicGet(): Promise<DIDResult>
Fetch the current public DID

Returns Promise<DIDResult>
- Defined in client/apis/WalletApi.ts:281

walletDidPublicGetRaw

walletDidPublicGetRaw(): Promise<ApiResponse<DIDResult>>
Fetch the current public DID

Returns Promise<ApiResponse<DIDResult>>
- Defined in client/apis/WalletApi.ts:261

walletDidPublicPost

walletDidPublicPost(requestParameters): Promise<DIDResult>
Assign the current public DID
Parameters
- requestParameters: WalletDidPublicPostRequest
Returns Promise<DIDResult>
- Defined in client/apis/WalletApi.ts:335

walletDidPublicPostRaw

walletDidPublicPostRaw(requestParameters): Promise<ApiResponse<DIDResult>>
Assign the current public DID
Parameters
- requestParameters: WalletDidPublicPostRequest
Returns Promise<ApiResponse<DIDResult>>
- Defined in client/apis/WalletApi.ts:289

walletGetDidEndpointGet

walletGetDidEndpointGet(requestParameters): Promise<DIDEndpoint>
Query DID endpoint in wallet
Parameters
- requestParameters: WalletGetDidEndpointGetRequest
Returns Promise<DIDEndpoint>
- Defined in client/apis/WalletApi.ts:378

walletGetDidEndpointGetRaw

walletGetDidEndpointGetRaw(requestParameters): Promise<ApiResponse<DIDEndpoint>>
Query DID endpoint in wallet
Parameters
- requestParameters: WalletGetDidEndpointGetRequest
Returns Promise<ApiResponse<DIDEndpoint>>
- Defined in client/apis/WalletApi.ts:345

walletJwtSignPost

walletJwtSignPost(requestParameters): Promise<object>
Create a EdDSA jws using did keys with a given payload
Parameters
- requestParameters: WalletJwtSignPostRequest
Returns Promise<object>
- Defined in client/apis/WalletApi.ts:411

walletJwtSignPostRaw

walletJwtSignPostRaw(requestParameters): Promise<ApiResponse<object>>
Create a EdDSA jws using did keys with a given payload
Parameters
- requestParameters: WalletJwtSignPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/WalletApi.ts:388

walletJwtVerifyPost

walletJwtVerifyPost(requestParameters): Promise<JWSVerifyResponse>
Verify a EdDSA jws using did keys with a given JWS
Parameters
- requestParameters: WalletJwtVerifyPostRequest
Returns Promise<JWSVerifyResponse>
- Defined in client/apis/WalletApi.ts:446

walletJwtVerifyPostRaw

walletJwtVerifyPostRaw(requestParameters): Promise<ApiResponse<JWSVerifyResponse>>
Verify a EdDSA jws using did keys with a given JWS
Parameters
- requestParameters: WalletJwtVerifyPostRequest
Returns Promise<ApiResponse<JWSVerifyResponse>>
- Defined in client/apis/WalletApi.ts:421

walletKeysMultikeyGet

walletKeysMultikeyGet(requestParameters): Promise<FetchKeyResponse>
Fetch key info.
Parameters
- requestParameters: WalletKeysMultikeyGetRequest
Returns Promise<FetchKeyResponse>
- Defined in client/apis/WalletApi.ts:491

walletKeysMultikeyGetRaw

walletKeysMultikeyGetRaw(requestParameters): Promise<ApiResponse<FetchKeyResponse>>
Fetch key info.
Parameters
- requestParameters: WalletKeysMultikeyGetRequest
Returns Promise<ApiResponse<FetchKeyResponse>>
- Defined in client/apis/WalletApi.ts:456

walletKeysPost

walletKeysPost(requestParameters): Promise<CreateKeyResponse>
Create a key pair
Parameters
- requestParameters: WalletKeysPostRequest
Returns Promise<CreateKeyResponse>
- Defined in client/apis/WalletApi.ts:526

walletKeysPostRaw

walletKeysPostRaw(requestParameters): Promise<ApiResponse<CreateKeyResponse>>
Create a key pair
Parameters
- requestParameters: WalletKeysPostRequest
Returns Promise<ApiResponse<CreateKeyResponse>>
- Defined in client/apis/WalletApi.ts:501

walletKeysPut

walletKeysPut(requestParameters): Promise<UpdateKeyResponse>
Update a key pair's kid
Parameters
- requestParameters: WalletKeysPutRequest
Returns Promise<UpdateKeyResponse>
- Defined in client/apis/WalletApi.ts:561

walletKeysPutRaw

walletKeysPutRaw(requestParameters): Promise<ApiResponse<UpdateKeyResponse>>
Update a key pair's kid
Parameters
- requestParameters: WalletKeysPutRequest
Returns Promise<ApiResponse<UpdateKeyResponse>>
- Defined in client/apis/WalletApi.ts:536

walletSdJwtSignPost

walletSdJwtSignPost(requestParameters): Promise<object>
Create a EdDSA sd-jws using did keys with a given payload
Parameters
- requestParameters: WalletSdJwtSignPostRequest
Returns Promise<object>
- Defined in client/apis/WalletApi.ts:594

walletSdJwtSignPostRaw

walletSdJwtSignPostRaw(requestParameters): Promise<ApiResponse<object>>
Create a EdDSA sd-jws using did keys with a given payload
Parameters
- requestParameters: WalletSdJwtSignPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/WalletApi.ts:571

walletSdJwtVerifyPost

walletSdJwtVerifyPost(requestParameters): Promise<SDJWSVerifyResponse>
Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding
Parameters
- requestParameters: WalletSdJwtVerifyPostRequest
Returns Promise<SDJWSVerifyResponse>
- Defined in client/apis/WalletApi.ts:629

walletSdJwtVerifyPostRaw

walletSdJwtVerifyPostRaw(requestParameters): Promise<ApiResponse<SDJWSVerifyResponse>>
Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding
Parameters
- requestParameters: WalletSdJwtVerifyPostRequest
Returns Promise<ApiResponse<SDJWSVerifyResponse>>
- Defined in client/apis/WalletApi.ts:604

walletSetDidEndpointPost

walletSetDidEndpointPost(requestParameters): Promise<object>
Update endpoint in wallet and on ledger if posted to it
Parameters
- requestParameters: WalletSetDidEndpointPostRequest
Returns Promise<object>
- Defined in client/apis/WalletApi.ts:671

walletSetDidEndpointPostRaw

walletSetDidEndpointPostRaw(requestParameters): Promise<ApiResponse<object>>
Update endpoint in wallet and on ledger if posted to it
Parameters
- requestParameters: WalletSetDidEndpointPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/WalletApi.ts:639

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

Generated using TypeDoc