Class IssueCredentialV10Api

Hierarchy

BaseAPI
- IssueCredentialV10Api

Index

Constructors

Properties

Methods

issueCredentialCreateOfferPost issueCredentialCreateOfferPostRaw issueCredentialCreatePost issueCredentialCreatePostRaw issueCredentialRecordsCredExIdDelete issueCredentialRecordsCredExIdDeleteRaw issueCredentialRecordsCredExIdGet issueCredentialRecordsCredExIdGetRaw issueCredentialRecordsCredExIdIssuePost issueCredentialRecordsCredExIdIssuePostRaw issueCredentialRecordsCredExIdProblemReportPost issueCredentialRecordsCredExIdProblemReportPostRaw issueCredentialRecordsCredExIdSendOfferPost issueCredentialRecordsCredExIdSendOfferPostRaw issueCredentialRecordsCredExIdSendRequestPost issueCredentialRecordsCredExIdSendRequestPostRaw issueCredentialRecordsCredExIdStorePost issueCredentialRecordsCredExIdStorePostRaw issueCredentialRecordsGet issueCredentialRecordsGetRaw issueCredentialSendOfferPost issueCredentialSendOfferPostRaw issueCredentialSendPost issueCredentialSendPostRaw issueCredentialSendProposalPost issueCredentialSendProposalPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

issueCredentialCreateOfferPost

issueCredentialCreateOfferPost(requestParameters): Promise<V10CredentialExchange>
Create a credential offer, independent of any proposal or connection
Parameters
- requestParameters: IssueCredentialCreateOfferPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:147

issueCredentialCreateOfferPostRaw

issueCredentialCreateOfferPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Create a credential offer, independent of any proposal or connection
Parameters
- requestParameters: IssueCredentialCreateOfferPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:122

issueCredentialCreatePost

issueCredentialCreatePost(requestParameters): Promise<V10CredentialExchange>
Create a credential record without sending (generally for use with Out-Of-Band)
Parameters
- requestParameters: IssueCredentialCreatePostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:184

issueCredentialCreatePostRaw

issueCredentialCreatePostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Create a credential record without sending (generally for use with Out-Of-Band)
Parameters
- requestParameters: IssueCredentialCreatePostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:159

issueCredentialRecordsCredExIdDelete

issueCredentialRecordsCredExIdDelete(requestParameters): Promise<object>
Remove an existing credential exchange record
Parameters
- requestParameters: IssueCredentialRecordsCredExIdDeleteRequest
Returns Promise<object>
- Defined in client/apis/IssueCredentialV10Api.ts:227

issueCredentialRecordsCredExIdDeleteRaw

issueCredentialRecordsCredExIdDeleteRaw(requestParameters): Promise<ApiResponse<object>>
Remove an existing credential exchange record
Parameters
- requestParameters: IssueCredentialRecordsCredExIdDeleteRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/IssueCredentialV10Api.ts:194

issueCredentialRecordsCredExIdGet

issueCredentialRecordsCredExIdGet(requestParameters): Promise<V10CredentialExchange>
Fetch a single credential exchange record
Parameters
- requestParameters: IssueCredentialRecordsCredExIdGetRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:274

issueCredentialRecordsCredExIdGetRaw

issueCredentialRecordsCredExIdGetRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Fetch a single credential exchange record
Parameters
- requestParameters: IssueCredentialRecordsCredExIdGetRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:239

issueCredentialRecordsCredExIdIssuePost

issueCredentialRecordsCredExIdIssuePost(requestParameters): Promise<V10CredentialExchange>
Send holder a credential
Parameters
- requestParameters: IssueCredentialRecordsCredExIdIssuePostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:324

issueCredentialRecordsCredExIdIssuePostRaw

issueCredentialRecordsCredExIdIssuePostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send holder a credential
Parameters
- requestParameters: IssueCredentialRecordsCredExIdIssuePostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:286

issueCredentialRecordsCredExIdProblemReportPost

issueCredentialRecordsCredExIdProblemReportPost(requestParameters): Promise<object>
Send a problem report for credential exchange
Parameters
- requestParameters: IssueCredentialRecordsCredExIdProblemReportPostRequest
Returns Promise<object>
- Defined in client/apis/IssueCredentialV10Api.ts:372

issueCredentialRecordsCredExIdProblemReportPostRaw

issueCredentialRecordsCredExIdProblemReportPostRaw(requestParameters): Promise<ApiResponse<object>>
Send a problem report for credential exchange
Parameters
- requestParameters: IssueCredentialRecordsCredExIdProblemReportPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/IssueCredentialV10Api.ts:336

issueCredentialRecordsCredExIdSendOfferPost

issueCredentialRecordsCredExIdSendOfferPost(requestParameters): Promise<V10CredentialExchange>
Send holder a credential offer in reference to a proposal with preview
Parameters
- requestParameters: IssueCredentialRecordsCredExIdSendOfferPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:423

issueCredentialRecordsCredExIdSendOfferPostRaw

issueCredentialRecordsCredExIdSendOfferPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send holder a credential offer in reference to a proposal with preview
Parameters
- requestParameters: IssueCredentialRecordsCredExIdSendOfferPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:385

issueCredentialRecordsCredExIdSendRequestPost

issueCredentialRecordsCredExIdSendRequestPost(requestParameters): Promise<V10CredentialExchange>
Send issuer a credential request
Parameters
- requestParameters: IssueCredentialRecordsCredExIdSendRequestPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:475

issueCredentialRecordsCredExIdSendRequestPostRaw

issueCredentialRecordsCredExIdSendRequestPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send issuer a credential request
Parameters
- requestParameters: IssueCredentialRecordsCredExIdSendRequestPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:435

issueCredentialRecordsCredExIdStorePost

issueCredentialRecordsCredExIdStorePost(requestParameters): Promise<V10CredentialExchange>
Store a received credential
Parameters
- requestParameters: IssueCredentialRecordsCredExIdStorePostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:526

issueCredentialRecordsCredExIdStorePostRaw

issueCredentialRecordsCredExIdStorePostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Store a received credential
Parameters
- requestParameters: IssueCredentialRecordsCredExIdStorePostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:488

issueCredentialRecordsGet

issueCredentialRecordsGet(requestParameters): Promise<V10CredentialExchangeListResult>
Fetch all credential exchange records
Parameters
- requestParameters: IssueCredentialRecordsGetRequest
Returns Promise<V10CredentialExchangeListResult>
- Defined in client/apis/IssueCredentialV10Api.ts:584

issueCredentialRecordsGetRaw

issueCredentialRecordsGetRaw(requestParameters): Promise<ApiResponse<V10CredentialExchangeListResult>>
Fetch all credential exchange records
Parameters
- requestParameters: IssueCredentialRecordsGetRequest
Returns Promise<ApiResponse<V10CredentialExchangeListResult>>
- Defined in client/apis/IssueCredentialV10Api.ts:538

issueCredentialSendOfferPost

issueCredentialSendOfferPost(requestParameters): Promise<V10CredentialExchange>
Send holder a credential offer, independent of any proposal
Parameters
- requestParameters: IssueCredentialSendOfferPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:619

issueCredentialSendOfferPostRaw

issueCredentialSendOfferPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send holder a credential offer, independent of any proposal
Parameters
- requestParameters: IssueCredentialSendOfferPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:594

issueCredentialSendPost

issueCredentialSendPost(requestParameters): Promise<V10CredentialExchange>
Send holder a credential, automating entire flow
Parameters
- requestParameters: IssueCredentialSendPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:656

issueCredentialSendPostRaw

issueCredentialSendPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send holder a credential, automating entire flow
Parameters
- requestParameters: IssueCredentialSendPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:631

issueCredentialSendProposalPost

issueCredentialSendProposalPost(requestParameters): Promise<V10CredentialExchange>
Send issuer a credential proposal
Parameters
- requestParameters: IssueCredentialSendProposalPostRequest
Returns Promise<V10CredentialExchange>
- Defined in client/apis/IssueCredentialV10Api.ts:691

issueCredentialSendProposalPostRaw

issueCredentialSendProposalPostRaw(requestParameters): Promise<ApiResponse<V10CredentialExchange>>
Send issuer a credential proposal
Parameters
- requestParameters: IssueCredentialSendProposalPostRequest
Returns Promise<ApiResponse<V10CredentialExchange>>
- Defined in client/apis/IssueCredentialV10Api.ts:666

`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

Generated using TypeDoc