Class RevocationApi

Hierarchy

BaseAPI
- RevocationApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new RevocationApi(configuration?: Configuration): RevocationApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns RevocationApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

Protected request

request(context: RequestOpts): Promise<Response>

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

revocationActiveRegistryCredDefIdGet

revocationActiveRegistryCredDefIdGet(requestParameters: RevocationActiveRegistryCredDefIdGetRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:183
Get current active revocation registry by credential definition id

Parameters
- requestParameters: RevocationActiveRegistryCredDefIdGetRequest
Returns Promise<RevRegResult>

revocationActiveRegistryCredDefIdGetRaw

revocationActiveRegistryCredDefIdGetRaw(requestParameters: RevocationActiveRegistryCredDefIdGetRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:148
Get current active revocation registry by credential definition id

Parameters
- requestParameters: RevocationActiveRegistryCredDefIdGetRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationClearPendingRevocationsPost

revocationClearPendingRevocationsPost(requestParameters: RevocationClearPendingRevocationsPostRequest): Promise<PublishRevocations>

- Defined in client/apis/RevocationApi.ts:220
Clear pending revocations

Parameters
- requestParameters: RevocationClearPendingRevocationsPostRequest
Returns Promise<PublishRevocations>

revocationClearPendingRevocationsPostRaw

revocationClearPendingRevocationsPostRaw(requestParameters: RevocationClearPendingRevocationsPostRequest): Promise<ApiResponse<PublishRevocations>>

- Defined in client/apis/RevocationApi.ts:195
Clear pending revocations

Parameters
- requestParameters: RevocationClearPendingRevocationsPostRequest
Returns Promise<ApiResponse<PublishRevocations>>

revocationCreateRegistryPost

revocationCreateRegistryPost(requestParameters: RevocationCreateRegistryPostRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:257
Creates a new revocation registry

Parameters
- requestParameters: RevocationCreateRegistryPostRequest
Returns Promise<RevRegResult>

revocationCreateRegistryPostRaw

revocationCreateRegistryPostRaw(requestParameters: RevocationCreateRegistryPostRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:232
Creates a new revocation registry

Parameters
- requestParameters: RevocationCreateRegistryPostRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationCredentialRecordGet

revocationCredentialRecordGet(requestParameters: RevocationCredentialRecordGetRequest): Promise<CredRevRecordResult>

- Defined in client/apis/RevocationApi.ts:303
Get credential revocation status

Parameters
- requestParameters: RevocationCredentialRecordGetRequest
Returns Promise<CredRevRecordResult>

revocationCredentialRecordGetRaw

revocationCredentialRecordGetRaw(requestParameters: RevocationCredentialRecordGetRequest): Promise<ApiResponse<CredRevRecordResult>>

- Defined in client/apis/RevocationApi.ts:269
Get credential revocation status

Parameters
- requestParameters: RevocationCredentialRecordGetRequest
Returns Promise<ApiResponse<CredRevRecordResult>>

revocationPublishRevocationsPost

revocationPublishRevocationsPost(requestParameters: RevocationPublishRevocationsPostRequest): Promise<TxnOrPublishRevocationsResult>

- Defined in client/apis/RevocationApi.ts:340
Publish pending revocations to ledger

Parameters
- requestParameters: RevocationPublishRevocationsPostRequest
Returns Promise<TxnOrPublishRevocationsResult>

revocationPublishRevocationsPostRaw

revocationPublishRevocationsPostRaw(requestParameters: RevocationPublishRevocationsPostRequest): Promise<ApiResponse<TxnOrPublishRevocationsResult>>

- Defined in client/apis/RevocationApi.ts:315
Publish pending revocations to ledger

Parameters
- requestParameters: RevocationPublishRevocationsPostRequest
Returns Promise<ApiResponse<TxnOrPublishRevocationsResult>>

revocationRegistriesCreatedGet

revocationRegistriesCreatedGet(requestParameters: RevocationRegistriesCreatedGetRequest): Promise<RevRegsCreated>

- Defined in client/apis/RevocationApi.ts:382
Search for matching revocation registries that current agent created

Parameters
- requestParameters: RevocationRegistriesCreatedGetRequest
Returns Promise<RevRegsCreated>

revocationRegistriesCreatedGetRaw

revocationRegistriesCreatedGetRaw(requestParameters: RevocationRegistriesCreatedGetRequest): Promise<ApiResponse<RevRegsCreated>>

- Defined in client/apis/RevocationApi.ts:352
Search for matching revocation registries that current agent created

Parameters
- requestParameters: RevocationRegistriesCreatedGetRequest
Returns Promise<ApiResponse<RevRegsCreated>>

revocationRegistryRevRegIdDefinitionPost

revocationRegistryRevRegIdDefinitionPost(requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest): Promise<TxnOrRevRegResult>

- Defined in client/apis/RevocationApi.ts:438
Send revocation registry definition to ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest
Returns Promise<TxnOrRevRegResult>

revocationRegistryRevRegIdDefinitionPostRaw

revocationRegistryRevRegIdDefinitionPostRaw(requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest): Promise<ApiResponse<TxnOrRevRegResult>>

- Defined in client/apis/RevocationApi.ts:394
Send revocation registry definition to ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest
Returns Promise<ApiResponse<TxnOrRevRegResult>>

revocationRegistryRevRegIdEntryPost

revocationRegistryRevRegIdEntryPost(requestParameters: RevocationRegistryRevRegIdEntryPostRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:494
Send revocation registry entry to ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdEntryPostRequest
Returns Promise<RevRegResult>

revocationRegistryRevRegIdEntryPostRaw

revocationRegistryRevRegIdEntryPostRaw(requestParameters: RevocationRegistryRevRegIdEntryPostRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:450
Send revocation registry entry to ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdEntryPostRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationRegistryRevRegIdFixRevocationEntryStatePut

revocationRegistryRevRegIdFixRevocationEntryStatePut(requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest): Promise<RevRegWalletUpdatedResult>

- Defined in client/apis/RevocationApi.ts:556
Fix revocation state in wallet and return number of updated entries

Parameters
- requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest
Returns Promise<RevRegWalletUpdatedResult>

revocationRegistryRevRegIdFixRevocationEntryStatePutRaw

revocationRegistryRevRegIdFixRevocationEntryStatePutRaw(requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest): Promise<ApiResponse<RevRegWalletUpdatedResult>>

- Defined in client/apis/RevocationApi.ts:506
Fix revocation state in wallet and return number of updated entries

Parameters
- requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest
Returns Promise<ApiResponse<RevRegWalletUpdatedResult>>

revocationRegistryRevRegIdGet

revocationRegistryRevRegIdGet(requestParameters: RevocationRegistryRevRegIdGetRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:604
Get revocation registry by revocation registry id

Parameters
- requestParameters: RevocationRegistryRevRegIdGetRequest
Returns Promise<RevRegResult>

revocationRegistryRevRegIdGetRaw

revocationRegistryRevRegIdGetRaw(requestParameters: RevocationRegistryRevRegIdGetRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:569
Get revocation registry by revocation registry id

Parameters
- requestParameters: RevocationRegistryRevRegIdGetRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationRegistryRevRegIdIssuedDetailsGet

revocationRegistryRevRegIdIssuedDetailsGet(requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest): Promise<CredRevRecordDetailsResult>

- Defined in client/apis/RevocationApi.ts:651
Get details of credentials issued against revocation registry

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest
Returns Promise<CredRevRecordDetailsResult>

revocationRegistryRevRegIdIssuedDetailsGetRaw

revocationRegistryRevRegIdIssuedDetailsGetRaw(requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest): Promise<ApiResponse<CredRevRecordDetailsResult>>

- Defined in client/apis/RevocationApi.ts:616
Get details of credentials issued against revocation registry

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest
Returns Promise<ApiResponse<CredRevRecordDetailsResult>>

revocationRegistryRevRegIdIssuedGet

revocationRegistryRevRegIdIssuedGet(requestParameters: RevocationRegistryRevRegIdIssuedGetRequest): Promise<RevRegIssuedResult>

- Defined in client/apis/RevocationApi.ts:698
Get number of credentials issued against revocation registry

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedGetRequest
Returns Promise<RevRegIssuedResult>

revocationRegistryRevRegIdIssuedGetRaw

revocationRegistryRevRegIdIssuedGetRaw(requestParameters: RevocationRegistryRevRegIdIssuedGetRequest): Promise<ApiResponse<RevRegIssuedResult>>

- Defined in client/apis/RevocationApi.ts:663
Get number of credentials issued against revocation registry

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedGetRequest
Returns Promise<ApiResponse<RevRegIssuedResult>>

revocationRegistryRevRegIdIssuedIndyRecsGet

revocationRegistryRevRegIdIssuedIndyRecsGet(requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest): Promise<CredRevIndyRecordsResult>

- Defined in client/apis/RevocationApi.ts:745
Get details of revoked credentials from ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest
Returns Promise<CredRevIndyRecordsResult>

revocationRegistryRevRegIdIssuedIndyRecsGetRaw

revocationRegistryRevRegIdIssuedIndyRecsGetRaw(requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest): Promise<ApiResponse<CredRevIndyRecordsResult>>

- Defined in client/apis/RevocationApi.ts:710
Get details of revoked credentials from ledger

Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest
Returns Promise<ApiResponse<CredRevIndyRecordsResult>>

revocationRegistryRevRegIdPatch

revocationRegistryRevRegIdPatch(requestParameters: RevocationRegistryRevRegIdPatchRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:795
Update revocation registry with new public URI to its tails file

Parameters
- requestParameters: RevocationRegistryRevRegIdPatchRequest
Returns Promise<RevRegResult>

revocationRegistryRevRegIdPatchRaw

revocationRegistryRevRegIdPatchRaw(requestParameters: RevocationRegistryRevRegIdPatchRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:757
Update revocation registry with new public URI to its tails file

Parameters
- requestParameters: RevocationRegistryRevRegIdPatchRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationRegistryRevRegIdSetStatePatch

revocationRegistryRevRegIdSetStatePatch(requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest): Promise<RevRegResult>

- Defined in client/apis/RevocationApi.ts:856
Set revocation registry state manually

Parameters
- requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest
Returns Promise<RevRegResult>

revocationRegistryRevRegIdSetStatePatchRaw

revocationRegistryRevRegIdSetStatePatchRaw(requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest): Promise<ApiResponse<RevRegResult>>

- Defined in client/apis/RevocationApi.ts:807
Set revocation registry state manually

Parameters
- requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest
Returns Promise<ApiResponse<RevRegResult>>

revocationRegistryRevRegIdTailsFileGet

revocationRegistryRevRegIdTailsFileGet(requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest): Promise<Blob>

- Defined in client/apis/RevocationApi.ts:901
Download tails file

Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest
Returns Promise<Blob>

revocationRegistryRevRegIdTailsFileGetRaw

revocationRegistryRevRegIdTailsFileGetRaw(requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest): Promise<ApiResponse<Blob>>

- Defined in client/apis/RevocationApi.ts:868
Download tails file

Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest
Returns Promise<ApiResponse<Blob>>

revocationRegistryRevRegIdTailsFilePut

revocationRegistryRevRegIdTailsFilePut(requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest): Promise<object>

- Defined in client/apis/RevocationApi.ts:946
Upload local tails file to server

Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest
Returns Promise<object>

revocationRegistryRevRegIdTailsFilePutRaw

revocationRegistryRevRegIdTailsFilePutRaw(requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest): Promise<ApiResponse<object>>

- Defined in client/apis/RevocationApi.ts:913
Upload local tails file to server

Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest
Returns Promise<ApiResponse<object>>

revocationRevokePost

revocationRevokePost(requestParameters: RevocationRevokePostRequest): Promise<object>

- Defined in client/apis/RevocationApi.ts:981
Revoke an issued credential

Parameters
- requestParameters: RevocationRevokePostRequest
Returns Promise<object>

revocationRevokePostRaw

revocationRevokePostRaw(requestParameters: RevocationRevokePostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/RevocationApi.ts:958
Revoke an issued credential

Parameters
- requestParameters: RevocationRevokePostRequest
Returns Promise<ApiResponse<object>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

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

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

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

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

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

Generated using TypeDoc