Class VcApi

Hierarchy

BaseAPI
- VcApi

Index

Constructors

Properties

Methods

request vcDiAddProofPost vcDiAddProofPostRaw vcDiVerifyPost vcDiVerifyPostRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new VcApi(configuration?): VcApi
Parameters
- configuration: Configuration = ...
Returns VcApi
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

vcDiAddProofPost

vcDiAddProofPost(requestParameters): Promise<AddProofResponse>
Add a DataIntegrityProof to a document.
Parameters
- requestParameters: VcDiAddProofPostRequest
Returns Promise<AddProofResponse>
- Defined in client/apis/VcApi.ts:69

vcDiAddProofPostRaw

vcDiAddProofPostRaw(requestParameters): Promise<ApiResponse<AddProofResponse>>
Add a DataIntegrityProof to a document.
Parameters
- requestParameters: VcDiAddProofPostRequest
Returns Promise<ApiResponse<AddProofResponse>>
- Defined in client/apis/VcApi.ts:44

vcDiVerifyPost

vcDiVerifyPost(requestParameters): Promise<VerifyDiResponse>
Verify a document secured with a data integrity proof.
Parameters
- requestParameters: VcDiVerifyPostRequest
Returns Promise<VerifyDiResponse>
- Defined in client/apis/VcApi.ts:104

vcDiVerifyPostRaw

vcDiVerifyPostRaw(requestParameters): Promise<ApiResponse<VerifyDiResponse>>
Verify a document secured with a data integrity proof.
Parameters
- requestParameters: VcDiVerifyPostRequest
Returns Promise<ApiResponse<VerifyDiResponse>>
- Defined in client/apis/VcApi.ts:79

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