Class IssueCredentialV20Api

Hierarchy

BaseAPI
- IssueCredentialV20Api

Index

Constructors

Properties

Methods

issueCredential20CreateOfferPost issueCredential20CreateOfferPostRaw issueCredential20CreatePost issueCredential20CreatePostRaw issueCredential20RecordsCredExIdDelete issueCredential20RecordsCredExIdDeleteRaw issueCredential20RecordsCredExIdGet issueCredential20RecordsCredExIdGetRaw issueCredential20RecordsCredExIdIssuePost issueCredential20RecordsCredExIdIssuePostRaw issueCredential20RecordsCredExIdProblemReportPost issueCredential20RecordsCredExIdProblemReportPostRaw issueCredential20RecordsCredExIdSendOfferPost issueCredential20RecordsCredExIdSendOfferPostRaw issueCredential20RecordsCredExIdSendRequestPost issueCredential20RecordsCredExIdSendRequestPostRaw issueCredential20RecordsCredExIdStorePost issueCredential20RecordsCredExIdStorePostRaw issueCredential20RecordsGet issueCredential20RecordsGetRaw issueCredential20SendOfferPost issueCredential20SendOfferPostRaw issueCredential20SendPost issueCredential20SendPostRaw issueCredential20SendProposalPost issueCredential20SendProposalPostRaw issueCredential20SendRequestPost issueCredential20SendRequestPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

issueCredential20CreateOfferPost

issueCredential20CreateOfferPost(requestParameters): Promise<V20CredExRecord>
Create a credential offer, independent of any proposal or connection
Parameters
- requestParameters: IssueCredential20CreateOfferPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:152

issueCredential20CreateOfferPostRaw

issueCredential20CreateOfferPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Create a credential offer, independent of any proposal or connection
Parameters
- requestParameters: IssueCredential20CreateOfferPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:127

issueCredential20CreatePost

issueCredential20CreatePost(requestParameters): Promise<V20CredExRecord>
Create a credential record without sending (generally for use with Out-Of-Band)
Parameters
- requestParameters: IssueCredential20CreatePostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:189

issueCredential20CreatePostRaw

issueCredential20CreatePostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Create a credential record without sending (generally for use with Out-Of-Band)
Parameters
- requestParameters: IssueCredential20CreatePostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:164

issueCredential20RecordsCredExIdDelete

issueCredential20RecordsCredExIdDelete(requestParameters): Promise<object>
Remove an existing credential exchange record
Parameters
- requestParameters: IssueCredential20RecordsCredExIdDeleteRequest
Returns Promise<object>
- Defined in client/apis/IssueCredentialV20Api.ts:234

issueCredential20RecordsCredExIdDeleteRaw

issueCredential20RecordsCredExIdDeleteRaw(requestParameters): Promise<ApiResponse<object>>
Remove an existing credential exchange record
Parameters
- requestParameters: IssueCredential20RecordsCredExIdDeleteRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/IssueCredentialV20Api.ts:201

issueCredential20RecordsCredExIdGet

issueCredential20RecordsCredExIdGet(requestParameters): Promise<V20CredExRecordDetail>
Fetch a single credential exchange record
Parameters
- requestParameters: IssueCredential20RecordsCredExIdGetRequest
Returns Promise<V20CredExRecordDetail>
- Defined in client/apis/IssueCredentialV20Api.ts:281

issueCredential20RecordsCredExIdGetRaw

issueCredential20RecordsCredExIdGetRaw(requestParameters): Promise<ApiResponse<V20CredExRecordDetail>>
Fetch a single credential exchange record
Parameters
- requestParameters: IssueCredential20RecordsCredExIdGetRequest
Returns Promise<ApiResponse<V20CredExRecordDetail>>
- Defined in client/apis/IssueCredentialV20Api.ts:246

issueCredential20RecordsCredExIdIssuePost

issueCredential20RecordsCredExIdIssuePost(requestParameters): Promise<V20CredExRecordDetail>
Send holder a credential
Parameters
- requestParameters: IssueCredential20RecordsCredExIdIssuePostRequest
Returns Promise<V20CredExRecordDetail>
- Defined in client/apis/IssueCredentialV20Api.ts:331

issueCredential20RecordsCredExIdIssuePostRaw

issueCredential20RecordsCredExIdIssuePostRaw(requestParameters): Promise<ApiResponse<V20CredExRecordDetail>>
Send holder a credential
Parameters
- requestParameters: IssueCredential20RecordsCredExIdIssuePostRequest
Returns Promise<ApiResponse<V20CredExRecordDetail>>
- Defined in client/apis/IssueCredentialV20Api.ts:293

issueCredential20RecordsCredExIdProblemReportPost

issueCredential20RecordsCredExIdProblemReportPost(requestParameters): Promise<object>
Send a problem report for credential exchange
Parameters
- requestParameters: IssueCredential20RecordsCredExIdProblemReportPostRequest
Returns Promise<object>
- Defined in client/apis/IssueCredentialV20Api.ts:379

issueCredential20RecordsCredExIdProblemReportPostRaw

issueCredential20RecordsCredExIdProblemReportPostRaw(requestParameters): Promise<ApiResponse<object>>
Send a problem report for credential exchange
Parameters
- requestParameters: IssueCredential20RecordsCredExIdProblemReportPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/IssueCredentialV20Api.ts:343

issueCredential20RecordsCredExIdSendOfferPost

issueCredential20RecordsCredExIdSendOfferPost(requestParameters): Promise<V20CredExRecord>
Send holder a credential offer in reference to a proposal with preview
Parameters
- requestParameters: IssueCredential20RecordsCredExIdSendOfferPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:430

issueCredential20RecordsCredExIdSendOfferPostRaw

issueCredential20RecordsCredExIdSendOfferPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send holder a credential offer in reference to a proposal with preview
Parameters
- requestParameters: IssueCredential20RecordsCredExIdSendOfferPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:392

issueCredential20RecordsCredExIdSendRequestPost

issueCredential20RecordsCredExIdSendRequestPost(requestParameters): Promise<V20CredExRecord>
Send issuer a credential request
Parameters
- requestParameters: IssueCredential20RecordsCredExIdSendRequestPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:481

issueCredential20RecordsCredExIdSendRequestPostRaw

issueCredential20RecordsCredExIdSendRequestPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send issuer a credential request
Parameters
- requestParameters: IssueCredential20RecordsCredExIdSendRequestPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:443

issueCredential20RecordsCredExIdStorePost

issueCredential20RecordsCredExIdStorePost(requestParameters): Promise<V20CredExRecordDetail>
Store a received credential
Parameters
- requestParameters: IssueCredential20RecordsCredExIdStorePostRequest
Returns Promise<V20CredExRecordDetail>
- Defined in client/apis/IssueCredentialV20Api.ts:532

issueCredential20RecordsCredExIdStorePostRaw

issueCredential20RecordsCredExIdStorePostRaw(requestParameters): Promise<ApiResponse<V20CredExRecordDetail>>
Store a received credential
Parameters
- requestParameters: IssueCredential20RecordsCredExIdStorePostRequest
Returns Promise<ApiResponse<V20CredExRecordDetail>>
- Defined in client/apis/IssueCredentialV20Api.ts:494

issueCredential20RecordsGet

issueCredential20RecordsGet(requestParameters): Promise<V20CredExRecordListResult>
Fetch all credential exchange records
Parameters
- requestParameters: IssueCredential20RecordsGetRequest
Returns Promise<V20CredExRecordListResult>
- Defined in client/apis/IssueCredentialV20Api.ts:582

issueCredential20RecordsGetRaw

issueCredential20RecordsGetRaw(requestParameters): Promise<ApiResponse<V20CredExRecordListResult>>
Fetch all credential exchange records
Parameters
- requestParameters: IssueCredential20RecordsGetRequest
Returns Promise<ApiResponse<V20CredExRecordListResult>>
- Defined in client/apis/IssueCredentialV20Api.ts:544

issueCredential20SendOfferPost

issueCredential20SendOfferPost(requestParameters): Promise<V20CredExRecord>
Send holder a credential offer, independent of any proposal
Parameters
- requestParameters: IssueCredential20SendOfferPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:619

issueCredential20SendOfferPostRaw

issueCredential20SendOfferPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send holder a credential offer, independent of any proposal
Parameters
- requestParameters: IssueCredential20SendOfferPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:594

issueCredential20SendPost

issueCredential20SendPost(requestParameters): Promise<V20CredExRecord>
Send holder a credential, automating entire flow
Parameters
- requestParameters: IssueCredential20SendPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:656

issueCredential20SendPostRaw

issueCredential20SendPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send holder a credential, automating entire flow
Parameters
- requestParameters: IssueCredential20SendPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:631

issueCredential20SendProposalPost

issueCredential20SendProposalPost(requestParameters): Promise<V20CredExRecord>
Send issuer a credential proposal
Parameters
- requestParameters: IssueCredential20SendProposalPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:691

issueCredential20SendProposalPostRaw

issueCredential20SendProposalPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send issuer a credential proposal
Parameters
- requestParameters: IssueCredential20SendProposalPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:666

issueCredential20SendRequestPost

issueCredential20SendRequestPost(requestParameters): Promise<V20CredExRecord>
Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request
Parameters
- requestParameters: IssueCredential20SendRequestPostRequest
Returns Promise<V20CredExRecord>
- Defined in client/apis/IssueCredentialV20Api.ts:728

issueCredential20SendRequestPostRaw

issueCredential20SendRequestPostRaw(requestParameters): Promise<ApiResponse<V20CredExRecord>>
Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request
Parameters
- requestParameters: IssueCredential20SendRequestPostRequest
Returns Promise<ApiResponse<V20CredExRecord>>
- Defined in client/apis/IssueCredentialV20Api.ts:703

`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