# Reference ## api-keys

client.apiKeys.apiKeyCreate({ ...params }) -> Truvity.ResourceApiKeyFull

#### 📝 Description

Create a new API key resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyCreate(); ```

#### ⚙️ Parameters

**request:** `Truvity.ApiKeyCreateRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeySearch({ ...params }) -> Truvity.ListApiKey

#### 📝 Description

Search for API Keys with extended filters capabilities.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeySearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.ApiKeySearchRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyLatest(id, { ...params }) -> Truvity.ResourceApiKey

#### 📝 Description

Get the latest version of API Key.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.ApiKeyLatestRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyDelete(id, { ...params }) -> void

#### 📝 Description

Delete API Key's resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.ApiKeyDeleteRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyUpdateAnnotations(id, { ...params }) -> Truvity.ResourceApiKey

#### 📝 Description

Update annotations of API Key's resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.ApiKeyUpdateAnnotationsRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyUpdateLabels(id, { ...params }) -> Truvity.ResourceApiKey

#### 📝 Description

Update labels of API Key's resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.ApiKeyUpdateLabelsRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyRestore(id, { ...params }) -> Truvity.ResourceApiKey

#### 📝 Description

Restore API Key's resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.ApiKeyRestoreRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyHistory(id, { ...params }) -> Truvity.ListApiKey

#### 📝 Description

History of the API Key's resources.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.ApiKeyHistoryRequest`

**requestOptions:** `ApiKeys.RequestOptions`

client.apiKeys.apiKeyRevision(id, revision, { ...params }) -> Truvity.ResourceApiKey

#### 📝 Description

Read the specific version of the API Key's resource.

#### 🔌 Usage

```typescript await client.apiKeys.apiKeyRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.ApiKeyRevisionRequest`

**requestOptions:** `ApiKeys.RequestOptions`

## credentials

client.credentials.credentialImport({ ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Import a Verifiable Credential's resource with a **blob_id**. To get **blob_id** call [Upload](#tag/credentials/operation/CredentialUpload) first.

#### 🔌 Usage

```typescript await client.credentials.credentialImport({ blobId: "blob_id" }); ```

#### ⚙️ Parameters

**request:** `Truvity.CredentialImportRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialSearch({ ...params }) -> Truvity.ListCredential

#### 📝 Description

Search for Credentials with extended filters capabilities.

#### 🔌 Usage

```typescript await client.credentials.credentialSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.CredentialSearchRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialUpload({ ...params }) -> Truvity.UploadResponse

#### 📝 Description

Initiates a Credential blob upload, returning a pre-signed S3 URL. Response contains: - **blob_id** (required for Credential creation) - **upload_uri** (pre-signed URL for upload) - **timeout** (expiration in seconds).

#### 🔌 Usage

```typescript await client.credentials.credentialUpload(); ```

#### ⚙️ Parameters

**request:** `Truvity.CredentialUploadRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialLatest(id, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Get the latest version of Credential.

#### 🔌 Usage

```typescript await client.credentials.credentialLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.CredentialLatestRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialDelete(id, { ...params }) -> void

#### 📝 Description

Delete Credential's resource.

#### 🔌 Usage

```typescript await client.credentials.credentialDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.CredentialDeleteRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialUpdateAnnotations(id, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Update annotations of Credential's resource.

#### 🔌 Usage

```typescript await client.credentials.credentialUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.CredentialUpdateAnnotationsRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialUpdateLabels(id, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Update labels of Credential's resource.

#### 🔌 Usage

```typescript await client.credentials.credentialUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.CredentialUpdateLabelsRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialRestore(id, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Restore Credential's resource.

#### 🔌 Usage

```typescript await client.credentials.credentialRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.CredentialRestoreRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialHistory(id, { ...params }) -> Truvity.ListCredential

#### 📝 Description

History of the Credential's resources.

#### 🔌 Usage

```typescript await client.credentials.credentialHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.CredentialHistoryRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialRevision(id, revision, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

Read the specific version of the Credential's resource.

#### 🔌 Usage

```typescript await client.credentials.credentialRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.CredentialRevisionRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialDownload(id, revision, { ...params }) -> core.BinaryResponse

#### 📝 Description

Download of Credential's blob.

#### 🔌 Usage

```typescript await client.credentials.credentialDownload("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.CredentialDownloadRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.getCredentialClaimValues(id, { ...params }) -> Truvity.CredentialClaimValues

#### 📝 Description

Retrieve the claim values of a Verifiable Credential.

#### 🔌 Usage

```typescript await client.credentials.getCredentialClaimValues("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the credential resource.

**request:** `Truvity.GetCredentialClaimValuesRequest`

**requestOptions:** `Credentials.RequestOptions`

client.credentials.credentialVerify(id, { ...params }) -> Truvity.CredentialVerify

#### 📝 Description

Verify a Verifiable Credential.

#### 🔌 Usage

```typescript await client.credentials.credentialVerify("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.CredentialVerifyRequest`

**requestOptions:** `Credentials.RequestOptions`

## didcomm-messages

client.didcommMessages.didcommMessageSearch({ ...params }) -> Truvity.ListDidCommMessage

#### 📝 Description

Search for DIDComm Messages with extended filters capabilities.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.DidcommMessageSearchRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didCommMessageSend({ ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Send a DIDComm Message to a recipient.

#### 🔌 Usage

```typescript await client.didcommMessages.didCommMessageSend({ data: { keyId: "key_id", to: "to" } }); ```

#### ⚙️ Parameters

**request:** `Truvity.DidCommMessageSendRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageLatest(id, { ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Get the latest version of DIDComm Message.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.DidcommMessageLatestRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageDelete(id, { ...params }) -> void

#### 📝 Description

Delete DIDComm Message's resource.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DidcommMessageDeleteRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageUpdateAnnotations(id, { ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Update annotations of DIDComm Message's resource.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DidcommMessageUpdateAnnotationsRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageUpdateLabels(id, { ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Update labels of DIDComm Message's resource.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DidcommMessageUpdateLabelsRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageRestore(id, { ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Restore DIDComm Message's resource.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DidcommMessageRestoreRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageHistory(id, { ...params }) -> Truvity.ListDidCommMessage

#### 📝 Description

History of the DIDComm Message's resources.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.DidcommMessageHistoryRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

client.didcommMessages.didcommMessageRevision(id, revision, { ...params }) -> Truvity.ResourceDidCommMessage

#### 📝 Description

Read the specific version of the DIDComm Message's resource.

#### 🔌 Usage

```typescript await client.didcommMessages.didcommMessageRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.DidcommMessageRevisionRequest`

**requestOptions:** `DidcommMessages.RequestOptions`

## dids

client.dids.didDocumentSelfGet({ ...params }) -> Truvity.DidDocument

#### 📝 Description

Return the tenant's DID(did:web) document. Comparing to [DIDDocumentGet](#tag/desk/operation/DIDDocumentGet) endpoint, this one returns the tenant's DID(did:web) document for the authenticated tenant only.

#### 🔌 Usage

```typescript await client.dids.didDocumentSelfGet(); ```

#### ⚙️ Parameters

**request:** `Truvity.DidDocumentSelfGetRequest`

**requestOptions:** `Dids.RequestOptions`

## drafts

client.drafts.draftCreate({ ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Creates Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftCreate({ data: { metaSchema: { schema: { fields: [{ kind: "BOOLEAN", name: "name" }] } } } }); ```

#### ⚙️ Parameters

**request:** `Truvity.DraftCreateRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftSearch({ ...params }) -> Truvity.ListDraft

#### 📝 Description

Search for Drafts with extended filters capabilities.

#### 🔌 Usage

```typescript await client.drafts.draftSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.DraftSearchRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftLatest(id, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Get the latest version of Draft.

#### 🔌 Usage

```typescript await client.drafts.draftLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.DraftLatestRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftDelete(id, { ...params }) -> void

#### 📝 Description

Delete Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DraftDeleteRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftUpdate(id, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Update Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftUpdate("id", { ifMatch: "If-Match", data: {} }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DraftUpdateRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftUpdateAnnotations(id, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Update annotations of Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DraftUpdateAnnotationsRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftLatestIssue(id, { ...params }) -> Truvity.ResourceCredential

#### 📝 Description

This operation issues a Verifiable Credential from a Draft resource. Operational Lifecycle: 1) [Exporting](#tag/drafts/operation/DraftExport) Draft. 2) [Signing](#tag/keys/operation/CredentialSign) the exported Draft. 3) [Importing](#tag/credentials/operation/CredentialImport) the signed Credential. Cascade Issuance: If the Draft references other drafts the system automatically builds a dependency graph and issues all required drafts in the correct order. The correct order is a topological order of the dependency graph, where each draft is issued only after all its prerequisite drafts have been issued. Strict Mode: - The `strict_mode` option allows clients to control how prerequisite drafts are handled during cascade issuance. - Use `strict_mode` to enforce that only the explicitly specified drafts in `prerequisite_drafts` (with matching ETags) are accepted as prerequisites. - When disabled (default), the system will automatically discover and include all linked drafts as prerequisites, building the full dependency graph for cascade issuance. Performance Considerations: - The process may take longer than typical API calls due to: - Building and traversing the dependency graph for cascade issuance, which determines the correct issuance order for all linked drafts. - Fetching and resolving external resources required for generating cryptographic proofs, which may involve network requests. - Generating cryptographic proofs for each credential in the dependency graph. Concurrency and Consistency: - If the `If-Match` header is provided, strict version control is enforced. The operation will fail if the ETag does not match the current Draft version. - The endpoint is idempotent with respect to the Draft resource and ETag. Recovery: - If the issuance process fails at any stage, the operation can be safely retried. The endpoint is idempotent with respect to the Draft resource and ETag, so repeated calls will not result in duplicate credentials or inconsistent state.

#### 🔌 Usage

```typescript await client.drafts.draftLatestIssue("id", { keyId: "key_id" }); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.DraftLatestIssueRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftUpdateLabels(id, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Update labels of Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DraftUpdateLabelsRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftRestore(id, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Restore Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DraftRestoreRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftHistory(id, { ...params }) -> Truvity.ListDraft

#### 📝 Description

History of the Draft's resources.

#### 🔌 Usage

```typescript await client.drafts.draftHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.DraftHistoryRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftRevision(id, revision, { ...params }) -> Truvity.ResourceDraft

#### 📝 Description

Read the specific version of the Draft's resource.

#### 🔌 Usage

```typescript await client.drafts.draftRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.DraftRevisionRequest`

**requestOptions:** `Drafts.RequestOptions`

client.drafts.draftExport(id, revision, { ...params }) -> core.BinaryResponse

#### 📝 Description

Generate an unsigned Verifiable Credential in JSON-LD format from a Draft.

#### 🔌 Usage

```typescript await client.drafts.draftExport("id", 1, { issuer: "issuer", validFrom: undefined, validUntil: undefined }); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.DraftExportRequest`

**requestOptions:** `Drafts.RequestOptions`

## files

client.files.fileCreate({ ...params }) -> Truvity.ResourceFile

#### 📝 Description

Creates File's resource with **blob_id**. To get **blob_id** call [Upload](#tag/files/operation/FileUpload) first.

#### 🔌 Usage

```typescript await client.files.fileCreate({ blobId: "blob_id" }); ```

#### ⚙️ Parameters

**request:** `Truvity.FileCreateRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileSearch({ ...params }) -> Truvity.ListFile

#### 📝 Description

Search for Files with extended filters capabilities.

#### 🔌 Usage

```typescript await client.files.fileSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.FileSearchRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileUpload({ ...params }) -> Truvity.UploadResponse

#### 📝 Description

Initiates a File blob upload, returning a pre-signed S3 URL. Response contains: - **blob_id** (required for File creation) - **upload_uri** (pre-signed URL for upload) - **timeout** (expiration in seconds).

#### 🔌 Usage

```typescript await client.files.fileUpload(); ```

#### ⚙️ Parameters

**request:** `Truvity.FileUploadRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileLatest(id, { ...params }) -> Truvity.ResourceFile

#### 📝 Description

Get the latest version of File.

#### 🔌 Usage

```typescript await client.files.fileLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.FileLatestRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileDelete(id, { ...params }) -> void

#### 📝 Description

Delete File's resource.

#### 🔌 Usage

```typescript await client.files.fileDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.FileDeleteRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileUpdateAnnotations(id, { ...params }) -> Truvity.ResourceFile

#### 📝 Description

Update annotations of File's resource.

#### 🔌 Usage

```typescript await client.files.fileUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.FileUpdateAnnotationsRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileUpdateLabels(id, { ...params }) -> Truvity.ResourceFile

#### 📝 Description

Update labels of File's resource.

#### 🔌 Usage

```typescript await client.files.fileUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.FileUpdateLabelsRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileRestore(id, { ...params }) -> Truvity.ResourceFile

#### 📝 Description

Restore File's resource.

#### 🔌 Usage

```typescript await client.files.fileRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.FileRestoreRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileHistory(id, { ...params }) -> Truvity.ListFile

#### 📝 Description

History of the File's resources.

#### 🔌 Usage

```typescript await client.files.fileHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.FileHistoryRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileRevision(id, revision, { ...params }) -> Truvity.ResourceFile

#### 📝 Description

Read the specific version of the File's resource.

#### 🔌 Usage

```typescript await client.files.fileRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.FileRevisionRequest`

**requestOptions:** `Files.RequestOptions`

client.files.fileDownload(id, revision, { ...params }) -> core.BinaryResponse

#### 📝 Description

Download of File's blob.

#### 🔌 Usage

```typescript await client.files.fileDownload("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.FileDownloadRequest`

**requestOptions:** `Files.RequestOptions`

## keys

client.keys.keyGenerate({ ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Generate a new cryptographic key pair.

#### 🔌 Usage

```typescript await client.keys.keyGenerate({ data: { type: "ED25519" } }); ```

#### ⚙️ Parameters

**request:** `Truvity.KeyGenerateRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyImport({ ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

You could use KeyGenerate, if you want to rely to generated by Truvity key-pairs for CredentialIssue and PresentationIssue. Remember, that you do not have any option to get private key by Truvity API, you could only use it If you prefer to keep private key, then you need to generate it manually. To use manually generated key CredentialIssue and PresentationIssue you need to import it. To generate key-pair you have two options 1. OpenSSL - [OpenSSL commands](https://www.openssl.org/docs/man1.1.1/man1/index.html) 2. JWX tool - [https://github.com/lestrrat-go/jwx/blob/main/cmd/jwx/README.md](https://github.com/lestrrat-go/jwx/blob/main/cmd/jwx/README.md) How to install JWX 1. Download & Install Golang - [https://go.dev/doc/install](https://go.dev/doc/install) 2. Clone & Build & Install [github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx) ```bash git clone https://github.com/lestrrat-go/jwx cd jwx/cmd/jwx go install -tags=jwx_es256k,jwx_secp256k1_pem . ``` 3. Verify that you correctly install everything ```bash ➜ jwx --help NAME: jwx - Tools for various JWE/JWK/JWS/JWT operations USAGE: jwx [global options] command [command options] [arguments...] COMMANDS: jwa List available algorithms and types jwe Work with JWE messages jwk Work with JWK and JWK sets jws Work with JWS messages help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --help, -h show help ``` How generate private key by `jwx` (output format JWK) ```bash # ED25519 jwx jwx generate --type OKP --curve Ed25519 # P256 jwx jwx generate --type EC --curve P-256 # P384 jwx jwx generate --type EC --curve P-384 ``` How to generate public key from private key by `jwx` (input format - JWK, output format - JWK) ```bash jwx jwk format -I json -O json - <(pathfile with private key in JWK format) ``` How to generate private key by OpenSSL (output format PEM - PKCS#8) ```bash # ED25519 openssl genpkey -algorithm ed25519 | openssl pkcs8 -nocrypt -topk8 # P256 openssl ecparam -name prime256v1 -noout -genkey | openssl pkcs8 -nocrypt -topk8 # P384 openssl ecparam -name secp384r1 -noout -genkey | openssl pkcs8 -nocrypt -topk8 ``` How to transform existing private key to PKCS8 format by OpenSSL (input format PEM, output format - PEM PCKS#8) ```bash openssl pkcs8 -nocrypt -topk8 <(pathfile with private key in PEM format) ``` How to transform private key to public key by OpenSSL (input format PEM, output format - PEM PKIX) ```bash openssl pkey -pubout <(pathfile with private key in PKCS8 format) ``` Useful third-party documentation: - [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/manmaster/man1/openssl-genpkey.html). - [openssl-ec, ec - EC key processing](https://www.openssl.org/docs/man1.0.2/man1/ec.html) - [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/man3.0/man1/openssl-genrsa.html) - [openssl-pkcs8 - PKCS#8 format private key conversion command](https://www.openssl.org/docs/manmaster/man1/openssl-pkcs8.html) - [JWX - github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx/blob/main/cmd/jwx/README.md) - [FIPS 186-4](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf). - [SEC2](https://www.secg.org/sec2-v2.pdf). - [AWS KMS - Asymmetric key specs](https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html) .

#### 🔌 Usage

```typescript await client.keys.keyImport({ data: "data" }); ```

#### ⚙️ Parameters

**request:** `Truvity.KeyImportRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keySearch({ ...params }) -> Truvity.ListKeyPublic

#### 📝 Description

Search for Keys with extended filters capabilities.

#### 🔌 Usage

```typescript await client.keys.keySearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.KeySearchRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyLatest(id, { ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Get the latest version of Key.

#### 🔌 Usage

```typescript await client.keys.keyLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.KeyLatestRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyDelete(id, { ...params }) -> void

#### 📝 Description

Delete Key's resource.

#### 🔌 Usage

```typescript await client.keys.keyDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.KeyDeleteRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyUpdateAnnotations(id, { ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Update annotations of Key's resource.

#### 🔌 Usage

```typescript await client.keys.keyUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.KeyUpdateAnnotationsRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.credentialSign(id, { ...params }) -> core.BinaryResponse

#### 📝 Description

Sign a JSON-LD representation of an unsigned Credential.

#### 🔌 Usage

```typescript await client.keys.credentialSign("id", { body: "string" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.CredentialSignRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.didCommMessageSign(id, { ...params }) -> core.BinaryResponse

#### 📝 Description

Sign DIDComm Message Plaintext.

#### 🔌 Usage

```typescript await client.keys.didCommMessageSign("id", { body: "string" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.DidCommMessageSignRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyUpdateLabels(id, { ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Update labels of Key's resource.

#### 🔌 Usage

```typescript await client.keys.keyUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.KeyUpdateLabelsRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.presentationSign(id, { ...params }) -> core.BinaryResponse

#### 📝 Description

Sign a JSON-LD representation of an unsigned Presentation.

#### 🔌 Usage

```typescript await client.keys.presentationSign("id", { body: "string" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PresentationSignRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyRestore(id, { ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Restore Key's resource.

#### 🔌 Usage

```typescript await client.keys.keyRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.KeyRestoreRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyHistory(id, { ...params }) -> Truvity.ListKeyPublic

#### 📝 Description

History of the Key's resources.

#### 🔌 Usage

```typescript await client.keys.keyHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.KeyHistoryRequest`

**requestOptions:** `Keys.RequestOptions`

client.keys.keyRevision(id, revision, { ...params }) -> Truvity.ResourceKeyPublic

#### 📝 Description

Read the specific version of the Key's resource.

#### 🔌 Usage

```typescript await client.keys.keyRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.KeyRevisionRequest`

**requestOptions:** `Keys.RequestOptions`

## presentations

client.presentations.presentationExport({ ...params }) -> core.BinaryResponse

#### 📝 Description

Generate an unsigned Verifiable Presentation in JSON-LD format from a list of Credentials.

#### 🔌 Usage

```typescript await client.presentations.presentationExport({ compositionType: "EMBED", credentialIds: ["credential_ids", "credential_ids"], holder: "holder" }); ```

#### ⚙️ Parameters

**request:** `Truvity.PresentationExportRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationImport({ ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Import a Verifiable Presentation's resource with **blob_id**. To get **blob_id** call [Upload](#tag/presentations/operation/PresentationUpload) first.

#### 🔌 Usage

```typescript await client.presentations.presentationImport({ blobId: "blob_id" }); ```

#### ⚙️ Parameters

**request:** `Truvity.PresentationImportRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationIssue({ ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

It's a handy call that wraps the following: 1) [Exporting](#tag/presentations/operation/PresentationExport) an unsigned JSON-LD representation of a Verifiable Presentation. 2) [Signing](#tag/keys/operation/PresentationSign) the created unsigned Presentation. 3) [Importing](#tag/presentations/operation/PresentationImport) the signed Presentation.

#### 🔌 Usage

```typescript await client.presentations.presentationIssue({ compositionType: "EMBED", credentialIds: ["credential_ids"], keyId: "key_id" }); ```

#### ⚙️ Parameters

**request:** `Truvity.PresentationIssueRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationSearch({ ...params }) -> Truvity.ListPresentation

#### 📝 Description

Search for Presentations with extended filters capabilities.

#### 🔌 Usage

```typescript await client.presentations.presentationSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.PresentationSearchRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationUpload({ ...params }) -> Truvity.UploadResponse

#### 📝 Description

Initiates a Presentation blob upload, returning a pre-signed S3 URL. Response contains: - **blob_id** (required for Presentation creation) - **upload_uri** (pre-signed URL for upload) - **timeout** (expiration in seconds).

#### 🔌 Usage

```typescript await client.presentations.presentationUpload(); ```

#### ⚙️ Parameters

**request:** `Truvity.PresentationUploadRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationLatest(id, { ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Get the latest version of Presentation.

#### 🔌 Usage

```typescript await client.presentations.presentationLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.PresentationLatestRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationDelete(id, { ...params }) -> void

#### 📝 Description

Delete Presentation's resource.

#### 🔌 Usage

```typescript await client.presentations.presentationDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PresentationDeleteRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationUpdateAnnotations(id, { ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Update annotations of Presentation's resource.

#### 🔌 Usage

```typescript await client.presentations.presentationUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PresentationUpdateAnnotationsRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationUpdateLabels(id, { ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Update labels of Presentation's resource.

#### 🔌 Usage

```typescript await client.presentations.presentationUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PresentationUpdateLabelsRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationRestore(id, { ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Restore Presentation's resource.

#### 🔌 Usage

```typescript await client.presentations.presentationRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PresentationRestoreRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationHistory(id, { ...params }) -> Truvity.ListPresentation

#### 📝 Description

History of the Presentation's resources.

#### 🔌 Usage

```typescript await client.presentations.presentationHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.PresentationHistoryRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationRevision(id, revision, { ...params }) -> Truvity.ResourcePresentation

#### 📝 Description

Read the specific version of the Presentation's resource.

#### 🔌 Usage

```typescript await client.presentations.presentationRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.PresentationRevisionRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationDownload(id, revision, { ...params }) -> core.BinaryResponse

#### 📝 Description

Download of Presentation's blob.

#### 🔌 Usage

```typescript await client.presentations.presentationDownload("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.PresentationDownloadRequest`

**requestOptions:** `Presentations.RequestOptions`

client.presentations.presentationVerify(id, { ...params }) -> Truvity.PresentationVerify

#### 📝 Description

Verify a Verifiable Presentation.

#### 🔌 Usage

```typescript await client.presentations.presentationVerify("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.PresentationVerifyRequest`

**requestOptions:** `Presentations.RequestOptions`

## published-schemas

client.publishedSchemas.publishedSchemaSearch({ ...params }) -> Truvity.ListPublishedCredentialSchema

#### 📝 Description

Search for PublishedSchemas with extended filters capabilities.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.PublishedSchemaSearchRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaLatest(id, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Get the latest version of PublishedSchema.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.PublishedSchemaLatestRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaDelete(id, { ...params }) -> void

#### 📝 Description

Delete PublishedSchema's resource.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PublishedSchemaDeleteRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaUpdateAnnotations(id, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Update annotations of PublishedSchema's resource.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PublishedSchemaUpdateAnnotationsRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaUpdateLabels(id, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Update labels of PublishedSchema's resource.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PublishedSchemaUpdateLabelsRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaRestore(id, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Restore PublishedSchema's resource.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.PublishedSchemaRestoreRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

client.publishedSchemas.publishedSchemaRevision(id, revision, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Read the specific version of the PublishedSchema's resource.

#### 🔌 Usage

```typescript await client.publishedSchemas.publishedSchemaRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.PublishedSchemaRevisionRequest`

**requestOptions:** `PublishedSchemas.RequestOptions`

## schemas

client.schemas.schemaCreate({ ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Creates Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaCreate({ data: {} }); ```

#### ⚙️ Parameters

**request:** `Truvity.SchemaCreateRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaImport({ ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Import a Credential Schema. This operation accepts a schema definition and checks if a published schema with this definition already exists. If it exists, the operation returns the published meta-schema resource. If not, it creates and publishes a new temporary schema, using the schema definition hash as its slug.

#### 🔌 Usage

```typescript await client.schemas.schemaImport({ data: { schema: { fields: [{ kind: "BOOLEAN", name: "name" }] } } }); ```

#### ⚙️ Parameters

**request:** `Truvity.SchemaImportRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaSearch({ ...params }) -> Truvity.ListCredentialSchema

#### 📝 Description

Search for Schemas with extended filters capabilities.

#### 🔌 Usage

```typescript await client.schemas.schemaSearch(); ```

#### ⚙️ Parameters

**request:** `Truvity.SchemaSearchRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaLatest(id, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Get the latest version of Schema.

#### 🔌 Usage

```typescript await client.schemas.schemaLatest("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.SchemaLatestRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaDelete(id, { ...params }) -> void

#### 📝 Description

Delete Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaDelete("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.SchemaDeleteRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaUpdate(id, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Update Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaUpdate("id", { ifMatch: "If-Match", data: { schema: {} } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.SchemaUpdateRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaUpdateAnnotations(id, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Update annotations of Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaUpdateAnnotations("id", { ifMatch: "If-Match", annotations: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.SchemaUpdateAnnotationsRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaUpdateLabels(id, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Update labels of Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaUpdateLabels("id", { ifMatch: "If-Match", labels: { "key": "value" } }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.SchemaUpdateLabelsRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaPublish(id, { ...params }) -> Truvity.ResourcePublishedCredentialSchema

#### 📝 Description

Publish a Credential Schema. This operation publishes a Credential Schema, making it available for use. If no slug is provided, the schema will be published as a temporary schema using the schema definition hash as its slug. If version is not passed, a default version will be equal 1.

#### 🔌 Usage

```typescript await client.schemas.schemaPublish("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.SchemaPublishRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaRestore(id, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Restore Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaRestore("id", { ifMatch: "If-Match" }); ```

#### ⚙️ Parameters

**id:** `string` The primary and unique identifier of the resource (inside tenant) according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).

**request:** `Truvity.SchemaRestoreRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaHistory(id, { ...params }) -> Truvity.ListCredentialSchema

#### 📝 Description

History of the Schema's resources.

#### 🔌 Usage

```typescript await client.schemas.schemaHistory("id"); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**request:** `Truvity.SchemaHistoryRequest`

**requestOptions:** `Schemas.RequestOptions`

client.schemas.schemaRevision(id, revision, { ...params }) -> Truvity.ResourceCredentialSchema

#### 📝 Description

Read the specific version of the Schema's resource.

#### 🔌 Usage

```typescript await client.schemas.schemaRevision("id", 1); ```

#### ⚙️ Parameters

**id:** `string` — The ID of the resource.

**revision:** `number` — The revision of the resource.

**request:** `Truvity.SchemaRevisionRequest`

**requestOptions:** `Schemas.RequestOptions`

## gdpr

client.gdpr.supportRequestCreate({ ...params }) -> void

#### 📝 Description

Create a request to support.

#### 🔌 Usage

```typescript await client.gdpr.supportRequestCreate({ message: "message", type: "DATA_DUMP" }); ```

#### ⚙️ Parameters

**request:** `Truvity.SupportRequestCreateRequest`

**requestOptions:** `Gdpr.RequestOptions`

## desk

client.desk.publishedJsonSchemaFetch(tenantId, slug, version, { ...params }) -> Record<string, unknown>

#### 📝 Description

Get the published JSON Schema for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema.

#### 🔌 Usage

```typescript await client.desk.publishedJsonSchemaFetch("tenant_id", "slug", 1000000); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**slug:** `string` — Slug of a CredentialSchema.

**version:** `number` — The version of the resource.

**request:** `Truvity.PublishedJsonSchemaFetchRequest`

**requestOptions:** `Desk.RequestOptions`

client.desk.publishedMetaSchemaFetch(tenantId, slug, version, { ...params }) -> Truvity.PublishedCredentialSchema

#### 📝 Description

Get the published Meta Schema for a given slug and version. The slug is the unique identifier for the schema.

#### 🔌 Usage

```typescript await client.desk.publishedMetaSchemaFetch("tenant_id", "slug", 1000000); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**slug:** `string` — Slug of a CredentialSchema.

**version:** `number` — The version of the resource.

**request:** `Truvity.PublishedMetaSchemaFetchRequest`

**requestOptions:** `Desk.RequestOptions`

client.desk.publishedVcdmJsonSchemaFetch(tenantId, slug, version, { ...params }) -> Record<string, unknown>

#### 📝 Description

Get the published VCDM JSON Schema for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema.

#### 🔌 Usage

```typescript await client.desk.publishedVcdmJsonSchemaFetch("tenant_id", "slug", 1000000); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**slug:** `string` — Slug of a CredentialSchema.

**version:** `number` — The version of the resource.

**request:** `Truvity.PublishedVcdmJsonSchemaFetchRequest`

**requestOptions:** `Desk.RequestOptions`

client.desk.publishedJsonLdVocabFetch(tenantId, slug, version, { ...params }) -> Record<string, unknown>

#### 📝 Description

Get the published JSON-LD Vocab for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema.

#### 🔌 Usage

```typescript await client.desk.publishedJsonLdVocabFetch("tenant_id", "slug", 1000000); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**slug:** `string` — Slug of a CredentialSchema.

**version:** `number` — The version of the resource.

**request:** `Truvity.PublishedJsonLdVocabFetchRequest`

**requestOptions:** `Desk.RequestOptions`

client.desk.didDocumentGet(tenantId, { ...params }) -> Truvity.DidDocument

#### 📝 Description

Get DID-Document for [did:web Method Specification](https://w3c-ccg.github.io/did-method-web/).

#### 🔌 Usage

```typescript await client.desk.didDocumentGet("tenant_id"); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**request:** `Truvity.DidDocumentGetRequest`

**requestOptions:** `Desk.RequestOptions`

client.desk.didCommMessageRecv(tenantId, { ...params }) -> void

#### 📝 Description

Receive DIDComm Message.

#### 🔌 Usage

```typescript await client.desk.didCommMessageRecv("tenant_id", { body: "string" }); ```

#### ⚙️ Parameters

**tenantId:** `string` — The ID of the tenant.

**request:** `Truvity.DidCommMessageRecvRequest`

**requestOptions:** `Desk.RequestOptions`