@truvity/sdk 0.28.4 → 0.28.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +2 -0
- package/Client.d.ts.map +1 -1
- package/Client.js.map +1 -1
- package/ExtendedClient.d.ts.map +1 -1
- package/ExtendedClient.js +3 -6
- package/ExtendedClient.js.map +1 -1
- package/api/resources/apiKeys/client/Client.d.ts +39 -10
- package/api/resources/apiKeys/client/Client.d.ts.map +1 -1
- package/api/resources/apiKeys/client/Client.js +183 -30
- package/api/resources/apiKeys/client/Client.js.map +1 -1
- package/api/resources/{drafts/client/requests/DraftCreateRequest.d.ts → apiKeys/client/requests/ApiKeyInput.d.ts} +7 -9
- package/api/resources/apiKeys/client/requests/ApiKeyInput.d.ts.map +1 -0
- package/api/resources/apiKeys/client/requests/ApiKeyInput.js.map +1 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.js +6 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.d.ts +55 -0
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/{drafts/client/requests/DraftUpdateRequest.js → apiKeys/client/requests/ApiKeyUpdateLabelsInput.js} +1 -1
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.js.map +1 -0
- package/api/resources/apiKeys/client/requests/index.d.ts +3 -2
- package/api/resources/apiKeys/client/requests/index.d.ts.map +1 -1
- package/api/resources/apiKeys/client/requests/index.js.map +1 -1
- package/api/resources/credentials/client/Client.d.ts +61 -17
- package/api/resources/credentials/client/Client.d.ts.map +1 -1
- package/api/resources/credentials/client/Client.js +303 -37
- package/api/resources/credentials/client/Client.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialDownloadRequest.d.ts +0 -6
- package/api/resources/credentials/client/requests/CredentialDownloadRequest.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/CredentialDownloadRequest.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialInput.d.ts +1 -8
- package/api/resources/credentials/client/requests/CredentialInput.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/CredentialInput.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialLatestRequest.d.ts +1 -3
- package/api/resources/credentials/client/requests/CredentialLatestRequest.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/CredentialLatestRequest.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialRestoreRequest.d.ts +1 -2
- package/api/resources/credentials/client/requests/CredentialRestoreRequest.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/CredentialRestoreRequest.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialRevisionRequest.d.ts +1 -3
- package/api/resources/credentials/client/requests/CredentialRevisionRequest.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/CredentialRevisionRequest.js.map +1 -1
- package/api/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.js +6 -0
- package/api/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/credentials/client/requests/CredentialUpdateLabelsInput.d.ts +55 -0
- package/api/resources/credentials/client/requests/CredentialUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/credentials/client/requests/CredentialUpdateLabelsInput.js +6 -0
- package/api/resources/credentials/client/requests/CredentialUpdateLabelsInput.js.map +1 -0
- package/api/resources/credentials/client/requests/index.d.ts +2 -0
- package/api/resources/credentials/client/requests/index.d.ts.map +1 -1
- package/api/resources/credentials/client/requests/index.js.map +1 -1
- package/api/resources/desk/client/Client.d.ts +2 -0
- package/api/resources/desk/client/Client.d.ts.map +1 -1
- package/api/resources/desk/client/Client.js +5 -5
- package/api/resources/desk/client/Client.js.map +1 -1
- package/api/resources/didcommMessages/client/Client.d.ts +56 -0
- package/api/resources/didcommMessages/client/Client.d.ts.map +1 -1
- package/api/resources/didcommMessages/client/Client.js +292 -14
- package/api/resources/didcommMessages/client/Client.js.map +1 -1
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.js +6 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.d.ts +55 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.js +6 -0
- package/api/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.js.map +1 -0
- package/api/resources/didcommMessages/client/requests/index.d.ts +2 -0
- package/api/resources/didcommMessages/client/requests/index.d.ts.map +1 -1
- package/api/resources/didcommMessages/client/requests/index.js.map +1 -1
- package/api/resources/dids/client/Client.d.ts +2 -0
- package/api/resources/dids/client/Client.d.ts.map +1 -1
- package/api/resources/dids/client/Client.js +2 -2
- package/api/resources/dids/client/Client.js.map +1 -1
- package/api/resources/drafts/client/Client.d.ts +63 -15
- package/api/resources/drafts/client/Client.d.ts.map +1 -1
- package/api/resources/drafts/client/Client.js +321 -37
- package/api/resources/drafts/client/Client.js.map +1 -1
- package/api/resources/drafts/client/requests/DraftExport.d.ts +0 -8
- package/api/resources/drafts/client/requests/DraftExport.d.ts.map +1 -1
- package/api/resources/drafts/client/requests/DraftExport.js.map +1 -1
- package/api/resources/{apiKeys/client/requests/ApiKeyCreateRequest.d.ts → drafts/client/requests/DraftInput.d.ts} +8 -7
- package/api/resources/drafts/client/requests/DraftInput.d.ts.map +1 -0
- package/api/resources/drafts/client/requests/DraftInput.js.map +1 -0
- package/api/resources/drafts/client/requests/DraftIssue.d.ts +1 -5
- package/api/resources/drafts/client/requests/DraftIssue.d.ts.map +1 -1
- package/api/resources/drafts/client/requests/DraftIssue.js.map +1 -1
- package/api/resources/drafts/client/requests/DraftUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/drafts/client/requests/DraftUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/drafts/client/requests/DraftUpdateAnnotationsInput.js +6 -0
- package/api/resources/drafts/client/requests/DraftUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/{apiKeys/client/requests/ApiKeyUpdateRequest.d.ts → drafts/client/requests/DraftUpdateInput.d.ts} +5 -4
- package/api/resources/drafts/client/requests/DraftUpdateInput.d.ts.map +1 -0
- package/api/resources/drafts/client/requests/DraftUpdateInput.js +6 -0
- package/api/resources/drafts/client/requests/DraftUpdateInput.js.map +1 -0
- package/api/resources/drafts/client/requests/DraftUpdateLabelsInput.d.ts +55 -0
- package/api/resources/drafts/client/requests/DraftUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/{apiKeys/client/requests/ApiKeyCreateRequest.js → drafts/client/requests/DraftUpdateLabelsInput.js} +1 -1
- package/api/resources/drafts/client/requests/DraftUpdateLabelsInput.js.map +1 -0
- package/api/resources/drafts/client/requests/index.d.ts +4 -2
- package/api/resources/drafts/client/requests/index.d.ts.map +1 -1
- package/api/resources/drafts/client/requests/index.js.map +1 -1
- package/api/resources/files/client/Client.d.ts +62 -9
- package/api/resources/files/client/Client.d.ts.map +1 -1
- package/api/resources/files/client/Client.js +327 -31
- package/api/resources/files/client/Client.js.map +1 -1
- package/api/resources/files/client/requests/FileDownloadRequest.d.ts +0 -6
- package/api/resources/files/client/requests/FileDownloadRequest.d.ts.map +1 -1
- package/api/resources/files/client/requests/FileDownloadRequest.js.map +1 -1
- package/api/resources/files/client/requests/{FileCreateRequest.d.ts → FileInput.d.ts} +8 -6
- package/api/resources/files/client/requests/FileInput.d.ts.map +1 -0
- package/api/resources/files/client/requests/FileInput.js.map +1 -0
- package/api/resources/files/client/requests/FileUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/files/client/requests/FileUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/files/client/requests/FileUpdateAnnotationsInput.js +6 -0
- package/api/resources/files/client/requests/FileUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/files/client/requests/{FileUpdateRequest.d.ts → FileUpdateInput.d.ts} +5 -6
- package/api/resources/files/client/requests/FileUpdateInput.d.ts.map +1 -0
- package/api/resources/{keys/client/requests/KeyInput.js → files/client/requests/FileUpdateInput.js} +1 -1
- package/api/resources/files/client/requests/FileUpdateInput.js.map +1 -0
- package/api/resources/{keys/client/requests/KeyInput.d.ts → files/client/requests/FileUpdateLabelsInput.d.ts} +7 -6
- package/api/resources/files/client/requests/FileUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/{drafts/client/requests/DraftCreateRequest.js → files/client/requests/FileUpdateLabelsInput.js} +1 -1
- package/api/resources/files/client/requests/FileUpdateLabelsInput.js.map +1 -0
- package/api/resources/files/client/requests/index.d.ts +4 -2
- package/api/resources/files/client/requests/index.d.ts.map +1 -1
- package/api/resources/files/client/requests/index.js.map +1 -1
- package/api/resources/gdpr/client/Client.d.ts +3 -1
- package/api/resources/gdpr/client/Client.d.ts.map +1 -1
- package/api/resources/gdpr/client/Client.js +3 -3
- package/api/resources/gdpr/client/Client.js.map +1 -1
- package/api/resources/gdpr/client/requests/SupportRequest.d.ts +1 -1
- package/api/resources/gdpr/client/requests/SupportRequest.js.map +1 -1
- package/api/resources/keys/client/Client.d.ts +37 -5
- package/api/resources/keys/client/Client.d.ts.map +1 -1
- package/api/resources/keys/client/Client.js +176 -31
- package/api/resources/keys/client/Client.js.map +1 -1
- package/api/resources/keys/client/requests/CredentialSignRequest.d.ts +0 -7
- package/api/resources/keys/client/requests/CredentialSignRequest.d.ts.map +1 -1
- package/api/resources/keys/client/requests/CredentialSignRequest.js.map +1 -1
- package/api/resources/keys/client/requests/DidCommMessageSignRequest.d.ts +0 -7
- package/api/resources/keys/client/requests/DidCommMessageSignRequest.d.ts.map +1 -1
- package/api/resources/keys/client/requests/DidCommMessageSignRequest.js.map +1 -1
- package/api/resources/keys/client/requests/KeyUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/keys/client/requests/KeyUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/keys/client/requests/KeyUpdateAnnotationsInput.js +6 -0
- package/api/resources/keys/client/requests/{KeyInput.js.map → KeyUpdateAnnotationsInput.js.map} +1 -1
- package/api/resources/{drafts/client/requests/DraftUpdateRequest.d.ts → keys/client/requests/KeyUpdateLabelsInput.d.ts} +6 -6
- package/api/resources/keys/client/requests/KeyUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/{apiKeys/client/requests/ApiKeyUpdateRequest.js → keys/client/requests/KeyUpdateLabelsInput.js} +1 -1
- package/api/resources/keys/client/requests/KeyUpdateLabelsInput.js.map +1 -0
- package/api/resources/keys/client/requests/PresentationSignRequest.d.ts +0 -7
- package/api/resources/keys/client/requests/PresentationSignRequest.d.ts.map +1 -1
- package/api/resources/keys/client/requests/PresentationSignRequest.js.map +1 -1
- package/api/resources/keys/client/requests/index.d.ts +2 -1
- package/api/resources/keys/client/requests/index.d.ts.map +1 -1
- package/api/resources/keys/client/requests/index.js.map +1 -1
- package/api/resources/presentations/client/Client.d.ts +56 -0
- package/api/resources/presentations/client/Client.d.ts.map +1 -1
- package/api/resources/presentations/client/Client.js +302 -24
- package/api/resources/presentations/client/Client.js.map +1 -1
- package/api/resources/presentations/client/requests/PresentationDownloadRequest.d.ts +0 -6
- package/api/resources/presentations/client/requests/PresentationDownloadRequest.d.ts.map +1 -1
- package/api/resources/presentations/client/requests/PresentationDownloadRequest.js.map +1 -1
- package/api/resources/presentations/client/requests/PresentationExport.d.ts +1 -21
- package/api/resources/presentations/client/requests/PresentationExport.d.ts.map +1 -1
- package/api/resources/presentations/client/requests/PresentationExport.js.map +1 -1
- package/api/resources/presentations/client/requests/PresentationIssue.d.ts +1 -14
- package/api/resources/presentations/client/requests/PresentationIssue.d.ts.map +1 -1
- package/api/resources/presentations/client/requests/PresentationIssue.js.map +1 -1
- package/api/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.d.ts +55 -0
- package/api/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.d.ts.map +1 -0
- package/api/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.js +6 -0
- package/api/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.js.map +1 -0
- package/api/resources/presentations/client/requests/PresentationUpdateLabelsInput.d.ts +55 -0
- package/api/resources/presentations/client/requests/PresentationUpdateLabelsInput.d.ts.map +1 -0
- package/api/resources/presentations/client/requests/PresentationUpdateLabelsInput.js +6 -0
- package/api/resources/presentations/client/requests/PresentationUpdateLabelsInput.js.map +1 -0
- package/api/resources/presentations/client/requests/index.d.ts +2 -0
- package/api/resources/presentations/client/requests/index.d.ts.map +1 -1
- package/api/resources/presentations/client/requests/index.js.map +1 -1
- package/api/types/Credential.d.ts +1 -8
- package/api/types/Credential.d.ts.map +1 -1
- package/api/types/Credential.js.map +1 -1
- package/api/types/Credential11.d.ts +1 -8
- package/api/types/Credential11.d.ts.map +1 -1
- package/api/types/Credential11.js.map +1 -1
- package/api/types/FileData.d.ts +2 -0
- package/api/types/FileData.d.ts.map +1 -1
- package/api/types/FileData.js.map +1 -1
- package/api/types/FileFilterData.d.ts +1 -0
- package/api/types/FileFilterData.d.ts.map +1 -1
- package/api/types/FileFilterData.js.map +1 -1
- package/api/types/FileFilterDataContentType.d.ts +1 -7
- package/api/types/FileFilterDataContentType.d.ts.map +1 -1
- package/api/types/FileFilterDataContentType.js.map +1 -1
- package/api/types/FileFilterDataFilename.d.ts +1 -7
- package/api/types/FileFilterDataFilename.d.ts.map +1 -1
- package/api/types/FileFilterDataFilename.js.map +1 -1
- package/api/types/FileFilterDataFilesize.d.ts +1 -7
- package/api/types/FileFilterDataFilesize.d.ts.map +1 -1
- package/api/types/FileFilterDataFilesize.js.map +1 -1
- package/api/types/FileFilterDataId.d.ts +20 -0
- package/api/types/FileFilterDataId.d.ts.map +1 -0
- package/api/types/FileFilterDataId.js +6 -0
- package/api/types/FileFilterDataId.js.map +1 -0
- package/api/types/FileFilterDataMultihash.d.ts +1 -7
- package/api/types/FileFilterDataMultihash.d.ts.map +1 -1
- package/api/types/FileFilterDataMultihash.js.map +1 -1
- package/api/types/FileSortField.d.ts +2 -1
- package/api/types/FileSortField.d.ts.map +1 -1
- package/api/types/FileSortField.js +1 -0
- package/api/types/FileSortField.js.map +1 -1
- package/api/types/File_.d.ts +7 -5
- package/api/types/File_.d.ts.map +1 -1
- package/api/types/File_.js.map +1 -1
- package/api/types/Presentation.d.ts +1 -8
- package/api/types/Presentation.d.ts.map +1 -1
- package/api/types/Presentation.js.map +1 -1
- package/api/types/ProblemPreconditionFailedResource.d.ts +1 -1
- package/api/types/ProblemPreconditionFailedResource.js.map +1 -1
- package/api/types/index.d.ts +1 -7
- package/api/types/index.d.ts.map +1 -1
- package/api/types/index.js +1 -7
- package/api/types/index.js.map +1 -1
- package/core/fetcher/Fetcher.d.ts +1 -1
- package/core/fetcher/Fetcher.d.ts.map +1 -1
- package/core/fetcher/Fetcher.js.map +1 -1
- package/core/fetcher/getResponseBody.d.ts.map +1 -1
- package/core/fetcher/getResponseBody.js +3 -0
- package/core/fetcher/getResponseBody.js.map +1 -1
- package/core/fetcher/requestWithRetries.d.ts.map +1 -1
- package/core/fetcher/requestWithRetries.js +13 -4
- package/core/fetcher/requestWithRetries.js.map +1 -1
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +1 -2
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts.map +1 -1
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +4 -2
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js.map +1 -1
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +1 -1
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts.map +1 -1
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js.map +1 -1
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +1 -1
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts.map +1 -1
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +4 -2
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js.map +1 -1
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +1 -1
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js.map +1 -1
- package/core/schemas/Schema.d.ts +1 -0
- package/core/schemas/Schema.d.ts.map +1 -1
- package/core/schemas/Schema.js +1 -0
- package/core/schemas/Schema.js.map +1 -1
- package/core/schemas/builders/bigint/bigint.d.ts +3 -0
- package/core/schemas/builders/bigint/bigint.d.ts.map +1 -0
- package/core/schemas/builders/bigint/bigint.js +51 -0
- package/core/schemas/builders/bigint/bigint.js.map +1 -0
- package/core/schemas/builders/bigint/index.d.ts +2 -0
- package/core/schemas/builders/bigint/index.d.ts.map +1 -0
- package/core/schemas/builders/bigint/index.js +6 -0
- package/core/schemas/builders/bigint/index.js.map +1 -0
- package/core/schemas/builders/index.d.ts +1 -0
- package/core/schemas/builders/index.d.ts.map +1 -1
- package/core/schemas/builders/index.js +1 -0
- package/core/schemas/builders/index.js.map +1 -1
- package/core/schemas/builders/object/object.d.ts.map +1 -1
- package/core/schemas/builders/object/object.js +28 -0
- package/core/schemas/builders/object/object.js.map +1 -1
- package/core/schemas/builders/object/types.d.ts +5 -0
- package/core/schemas/builders/object/types.d.ts.map +1 -1
- package/core/schemas/builders/object/types.js.map +1 -1
- package/core/schemas/utils/getErrorMessageForIncorrectType.js +4 -0
- package/core/schemas/utils/getErrorMessageForIncorrectType.js.map +1 -1
- package/documents/credential/baseVerifiableCredential.d.ts +3 -1
- package/documents/credential/baseVerifiableCredential.d.ts.map +1 -1
- package/documents/credential/baseVerifiableCredential.js +32 -4
- package/documents/credential/baseVerifiableCredential.js.map +1 -1
- package/documents/credential/document.d.ts +1 -1
- package/documents/credential/document.d.ts.map +1 -1
- package/documents/credential/document.js +2 -2
- package/documents/credential/document.js.map +1 -1
- package/documents/credential/document.spec.d.ts +1 -1
- package/documents/credential/document.spec.d.ts.map +1 -1
- package/documents/credential/document.spec.js +4 -3
- package/documents/credential/document.spec.js.map +1 -1
- package/documents/credential/draft.d.ts +4 -2
- package/documents/credential/draft.d.ts.map +1 -1
- package/documents/credential/draft.js +42 -10
- package/documents/credential/draft.js.map +1 -1
- package/documents/credential/flavor.spec.js +3 -3
- package/documents/credential/flavor.spec.js.map +1 -1
- package/documents/credential/issued.d.ts +4 -2
- package/documents/credential/issued.d.ts.map +1 -1
- package/documents/credential/issued.js +28 -4
- package/documents/credential/issued.js.map +1 -1
- package/documents/credential/unknown.d.ts +2 -1
- package/documents/credential/unknown.d.ts.map +1 -1
- package/documents/credential/unknown.js +2 -2
- package/documents/credential/unknown.js.map +1 -1
- package/documents/credential.d.ts +4 -2
- package/documents/credential.d.ts.map +1 -1
- package/documents/credential.js +20 -17
- package/documents/credential.js.map +1 -1
- package/documents/models.d.ts +3 -1
- package/documents/models.d.ts.map +1 -1
- package/documents/models.js +86 -39
- package/documents/models.js.map +1 -1
- package/documents/presentation/issued.d.ts +1 -1
- package/documents/presentation/issued.d.ts.map +1 -1
- package/documents/presentation/issued.js +2 -2
- package/documents/presentation/issued.js.map +1 -1
- package/documents/presentation.d.ts +3 -1
- package/documents/presentation.d.ts.map +1 -1
- package/documents/presentation.js +2 -2
- package/documents/presentation.js.map +1 -1
- package/documents/types.d.ts +3 -0
- package/documents/types.d.ts.map +1 -1
- package/documents/types.js +3 -0
- package/documents/types.js.map +1 -1
- package/errors/TruvityTimeoutError.d.ts +1 -1
- package/errors/TruvityTimeoutError.d.ts.map +1 -1
- package/errors/TruvityTimeoutError.js +2 -2
- package/errors/TruvityTimeoutError.js.map +1 -1
- package/package.json +8 -4
- package/reference.md +740 -436
- package/serialization/resources/{keys/client/requests/KeyInput.d.ts → apiKeys/client/requests/ApiKeyInput.d.ts} +3 -3
- package/serialization/resources/apiKeys/client/requests/ApiKeyInput.d.ts.map +1 -0
- package/serialization/{types → resources/apiKeys/client/requests}/ApiKeyInput.js +1 -1
- package/serialization/resources/apiKeys/client/requests/ApiKeyInput.js.map +1 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/{keys/client/requests/KeyInput.js → apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.js} +4 -5
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.js +34 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/apiKeys/client/requests/index.d.ts +3 -0
- package/serialization/resources/apiKeys/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/apiKeys/client/requests/index.js +7 -1
- package/serialization/resources/apiKeys/client/requests/index.js.map +1 -1
- package/serialization/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateLabelsInput.js +34 -0
- package/serialization/resources/credentials/client/requests/CredentialUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/credentials/client/requests/index.d.ts +2 -0
- package/serialization/resources/credentials/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/credentials/client/requests/index.js +5 -1
- package/serialization/resources/credentials/client/requests/index.js.map +1 -1
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.js +34 -0
- package/serialization/resources/didcommMessages/client/requests/DidcommMessageUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/didcommMessages/client/requests/index.d.ts +2 -0
- package/serialization/resources/didcommMessages/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/didcommMessages/client/requests/index.js +5 -1
- package/serialization/resources/didcommMessages/client/requests/index.js.map +1 -1
- package/serialization/resources/drafts/client/requests/DraftInput.d.ts +16 -0
- package/serialization/resources/drafts/client/requests/DraftInput.d.ts.map +1 -0
- package/serialization/{types → resources/drafts/client/requests}/DraftInput.js +2 -2
- package/serialization/resources/drafts/client/requests/DraftInput.js.map +1 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateInput.d.ts +14 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateInput.d.ts.map +1 -0
- package/serialization/{types/IsNotNullFilesize.js → resources/drafts/client/requests/DraftUpdateInput.js} +7 -4
- package/serialization/resources/drafts/client/requests/DraftUpdateInput.js.map +1 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateLabelsInput.js +34 -0
- package/serialization/resources/drafts/client/requests/DraftUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/drafts/client/requests/index.d.ts +4 -0
- package/serialization/resources/drafts/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/drafts/client/requests/index.js +9 -1
- package/serialization/resources/drafts/client/requests/index.js.map +1 -1
- package/serialization/resources/files/client/requests/FileInput.d.ts +16 -0
- package/serialization/resources/files/client/requests/FileInput.d.ts.map +1 -0
- package/serialization/{types → resources/files/client/requests}/FileInput.js +2 -2
- package/serialization/resources/files/client/requests/FileInput.js.map +1 -0
- package/serialization/resources/files/client/requests/FileUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/files/client/requests/FileUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/files/client/requests/FileUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/files/client/requests/FileUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/files/client/requests/FileUpdateInput.d.ts +14 -0
- package/serialization/resources/files/client/requests/FileUpdateInput.d.ts.map +1 -0
- package/serialization/{types/IsNullFilesize.js → resources/files/client/requests/FileUpdateInput.js} +7 -4
- package/serialization/resources/files/client/requests/FileUpdateInput.js.map +1 -0
- package/serialization/resources/files/client/requests/FileUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/files/client/requests/FileUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/files/client/requests/FileUpdateLabelsInput.js +34 -0
- package/serialization/resources/files/client/requests/FileUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/files/client/requests/index.d.ts +4 -0
- package/serialization/resources/files/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/files/client/requests/index.js +9 -1
- package/serialization/resources/files/client/requests/index.js.map +1 -1
- package/serialization/resources/keys/client/requests/KeyUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/keys/client/requests/KeyUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/keys/client/requests/KeyUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/keys/client/requests/KeyUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/keys/client/requests/KeyUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/keys/client/requests/KeyUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/keys/client/requests/KeyUpdateLabelsInput.js +34 -0
- package/serialization/resources/keys/client/requests/KeyUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/keys/client/requests/index.d.ts +2 -1
- package/serialization/resources/keys/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/keys/client/requests/index.js +5 -3
- package/serialization/resources/keys/client/requests/index.js.map +1 -1
- package/serialization/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.d.ts +13 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.d.ts.map +1 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.js +34 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateAnnotationsInput.js.map +1 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateLabelsInput.d.ts +13 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateLabelsInput.d.ts.map +1 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateLabelsInput.js +34 -0
- package/serialization/resources/presentations/client/requests/PresentationUpdateLabelsInput.js.map +1 -0
- package/serialization/resources/presentations/client/requests/index.d.ts +2 -0
- package/serialization/resources/presentations/client/requests/index.d.ts.map +1 -1
- package/serialization/resources/presentations/client/requests/index.js +5 -1
- package/serialization/resources/presentations/client/requests/index.js.map +1 -1
- package/serialization/types/FileData.d.ts +1 -0
- package/serialization/types/FileData.d.ts.map +1 -1
- package/serialization/types/FileData.js +1 -0
- package/serialization/types/FileData.js.map +1 -1
- package/serialization/types/FileFilterData.d.ts +2 -0
- package/serialization/types/FileFilterData.d.ts.map +1 -1
- package/serialization/types/FileFilterData.js +2 -0
- package/serialization/types/FileFilterData.js.map +1 -1
- package/serialization/types/FileFilterDataContentType.d.ts +1 -9
- package/serialization/types/FileFilterDataContentType.d.ts.map +1 -1
- package/serialization/types/FileFilterDataContentType.js +0 -4
- package/serialization/types/FileFilterDataContentType.js.map +1 -1
- package/serialization/types/FileFilterDataFilename.d.ts +1 -9
- package/serialization/types/FileFilterDataFilename.d.ts.map +1 -1
- package/serialization/types/FileFilterDataFilename.js +0 -4
- package/serialization/types/FileFilterDataFilename.js.map +1 -1
- package/serialization/types/FileFilterDataFilesize.d.ts +1 -9
- package/serialization/types/FileFilterDataFilesize.d.ts.map +1 -1
- package/serialization/types/FileFilterDataFilesize.js +0 -4
- package/serialization/types/FileFilterDataFilesize.js.map +1 -1
- package/serialization/types/FileFilterDataId.d.ts +27 -0
- package/serialization/types/FileFilterDataId.d.ts.map +1 -0
- package/serialization/types/{NotModifiedProblems.js → FileFilterDataId.js} +12 -6
- package/serialization/types/FileFilterDataId.js.map +1 -0
- package/serialization/types/FileFilterDataMultihash.d.ts +1 -9
- package/serialization/types/FileFilterDataMultihash.d.ts.map +1 -1
- package/serialization/types/FileFilterDataMultihash.js +0 -4
- package/serialization/types/FileFilterDataMultihash.js.map +1 -1
- package/serialization/types/FileSortField.d.ts +1 -1
- package/serialization/types/FileSortField.d.ts.map +1 -1
- package/serialization/types/FileSortField.js +1 -0
- package/serialization/types/FileSortField.js.map +1 -1
- package/serialization/types/File_.d.ts +5 -4
- package/serialization/types/File_.d.ts.map +1 -1
- package/serialization/types/File_.js +5 -4
- package/serialization/types/File_.js.map +1 -1
- package/serialization/types/index.d.ts +1 -7
- package/serialization/types/index.d.ts.map +1 -1
- package/serialization/types/index.js +1 -7
- package/serialization/types/index.js.map +1 -1
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/api/resources/apiKeys/client/requests/ApiKeyCreateRequest.d.ts.map +0 -1
- package/api/resources/apiKeys/client/requests/ApiKeyCreateRequest.js.map +0 -1
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateRequest.d.ts.map +0 -1
- package/api/resources/apiKeys/client/requests/ApiKeyUpdateRequest.js.map +0 -1
- package/api/resources/drafts/client/requests/DraftCreateRequest.d.ts.map +0 -1
- package/api/resources/drafts/client/requests/DraftCreateRequest.js.map +0 -1
- package/api/resources/drafts/client/requests/DraftUpdateRequest.d.ts.map +0 -1
- package/api/resources/drafts/client/requests/DraftUpdateRequest.js.map +0 -1
- package/api/resources/files/client/requests/FileCreateRequest.d.ts.map +0 -1
- package/api/resources/files/client/requests/FileCreateRequest.js +0 -6
- package/api/resources/files/client/requests/FileCreateRequest.js.map +0 -1
- package/api/resources/files/client/requests/FileUpdateRequest.d.ts.map +0 -1
- package/api/resources/files/client/requests/FileUpdateRequest.js +0 -6
- package/api/resources/files/client/requests/FileUpdateRequest.js.map +0 -1
- package/api/resources/keys/client/requests/KeyInput.d.ts.map +0 -1
- package/api/types/ApiKeyInput.d.ts +0 -13
- package/api/types/ApiKeyInput.d.ts.map +0 -1
- package/api/types/ApiKeyInput.js.map +0 -1
- package/api/types/DraftInput.d.ts +0 -15
- package/api/types/DraftInput.d.ts.map +0 -1
- package/api/types/DraftInput.js.map +0 -1
- package/api/types/FileInput.d.ts +0 -15
- package/api/types/FileInput.d.ts.map +0 -1
- package/api/types/FileInput.js.map +0 -1
- package/api/types/IsNotNullFilesize.d.ts +0 -9
- package/api/types/IsNotNullFilesize.d.ts.map +0 -1
- package/api/types/IsNotNullFilesize.js +0 -6
- package/api/types/IsNotNullFilesize.js.map +0 -1
- package/api/types/IsNullFilesize.d.ts +0 -9
- package/api/types/IsNullFilesize.d.ts.map +0 -1
- package/api/types/IsNullFilesize.js +0 -6
- package/api/types/IsNullFilesize.js.map +0 -1
- package/api/types/NotModifiedProblems.d.ts +0 -14
- package/api/types/NotModifiedProblems.d.ts.map +0 -1
- package/api/types/NotModifiedProblems.js +0 -6
- package/api/types/NotModifiedProblems.js.map +0 -1
- package/api/types/ProblemNotModified.d.ts +0 -20
- package/api/types/ProblemNotModified.d.ts.map +0 -1
- package/api/types/ProblemNotModified.js +0 -6
- package/api/types/ProblemNotModified.js.map +0 -1
- package/documents/credential/index.d.ts +0 -7
- package/documents/credential/index.d.ts.map +0 -1
- package/documents/credential/index.js +0 -23
- package/documents/credential/index.js.map +0 -1
- package/serialization/resources/keys/client/requests/KeyInput.d.ts.map +0 -1
- package/serialization/resources/keys/client/requests/KeyInput.js.map +0 -1
- package/serialization/types/ApiKeyInput.d.ts +0 -14
- package/serialization/types/ApiKeyInput.d.ts.map +0 -1
- package/serialization/types/ApiKeyInput.js.map +0 -1
- package/serialization/types/DraftInput.d.ts +0 -16
- package/serialization/types/DraftInput.d.ts.map +0 -1
- package/serialization/types/DraftInput.js.map +0 -1
- package/serialization/types/FileInput.d.ts +0 -16
- package/serialization/types/FileInput.d.ts.map +0 -1
- package/serialization/types/FileInput.js.map +0 -1
- package/serialization/types/IsNotNullFilesize.d.ts +0 -12
- package/serialization/types/IsNotNullFilesize.d.ts.map +0 -1
- package/serialization/types/IsNotNullFilesize.js.map +0 -1
- package/serialization/types/IsNullFilesize.d.ts +0 -12
- package/serialization/types/IsNullFilesize.d.ts.map +0 -1
- package/serialization/types/IsNullFilesize.js.map +0 -1
- package/serialization/types/NotModifiedProblems.d.ts +0 -15
- package/serialization/types/NotModifiedProblems.d.ts.map +0 -1
- package/serialization/types/NotModifiedProblems.js.map +0 -1
- package/serialization/types/ProblemNotModified.d.ts +0 -18
- package/serialization/types/ProblemNotModified.d.ts.map +0 -1
- package/serialization/types/ProblemNotModified.js +0 -39
- package/serialization/types/ProblemNotModified.js.map +0 -1
- /package/api/{types → resources/apiKeys/client/requests}/ApiKeyInput.js +0 -0
- /package/api/{types → resources/drafts/client/requests}/DraftInput.js +0 -0
- /package/api/{types → resources/files/client/requests}/FileInput.js +0 -0
package/reference.md
CHANGED
|
@@ -27,9 +27,7 @@ Create a new API key resource.
|
|
|
27
27
|
<dd>
|
|
28
28
|
|
|
29
29
|
```typescript
|
|
30
|
-
await client.apiKeys.apiKeyCreate(
|
|
31
|
-
body: {}
|
|
32
|
-
});
|
|
30
|
+
await client.apiKeys.apiKeyCreate();
|
|
33
31
|
|
|
34
32
|
```
|
|
35
33
|
</dd>
|
|
@@ -45,7 +43,7 @@ await client.apiKeys.apiKeyCreate({
|
|
|
45
43
|
<dl>
|
|
46
44
|
<dd>
|
|
47
45
|
|
|
48
|
-
**request:** `Truvity.
|
|
46
|
+
**request:** `Truvity.ApiKeyInput`
|
|
49
47
|
|
|
50
48
|
</dd>
|
|
51
49
|
</dl>
|
|
@@ -275,7 +273,86 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
275
273
|
</dl>
|
|
276
274
|
</details>
|
|
277
275
|
|
|
278
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
276
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">apiKeyUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceApiKey</code></summary>
|
|
277
|
+
<dl>
|
|
278
|
+
<dd>
|
|
279
|
+
|
|
280
|
+
#### 📝 Description
|
|
281
|
+
|
|
282
|
+
<dl>
|
|
283
|
+
<dd>
|
|
284
|
+
|
|
285
|
+
<dl>
|
|
286
|
+
<dd>
|
|
287
|
+
|
|
288
|
+
Update annotations of API Key's resource.
|
|
289
|
+
</dd>
|
|
290
|
+
</dl>
|
|
291
|
+
</dd>
|
|
292
|
+
</dl>
|
|
293
|
+
|
|
294
|
+
#### 🔌 Usage
|
|
295
|
+
|
|
296
|
+
<dl>
|
|
297
|
+
<dd>
|
|
298
|
+
|
|
299
|
+
<dl>
|
|
300
|
+
<dd>
|
|
301
|
+
|
|
302
|
+
```typescript
|
|
303
|
+
await client.apiKeys.apiKeyUpdateAnnotations("id", {
|
|
304
|
+
ifMatch: "If-Match",
|
|
305
|
+
annotations: {
|
|
306
|
+
"key": "value"
|
|
307
|
+
}
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
```
|
|
311
|
+
</dd>
|
|
312
|
+
</dl>
|
|
313
|
+
</dd>
|
|
314
|
+
</dl>
|
|
315
|
+
|
|
316
|
+
#### ⚙️ Parameters
|
|
317
|
+
|
|
318
|
+
<dl>
|
|
319
|
+
<dd>
|
|
320
|
+
|
|
321
|
+
<dl>
|
|
322
|
+
<dd>
|
|
323
|
+
|
|
324
|
+
**id:** `string`
|
|
325
|
+
|
|
326
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
327
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
328
|
+
|
|
329
|
+
</dd>
|
|
330
|
+
</dl>
|
|
331
|
+
|
|
332
|
+
<dl>
|
|
333
|
+
<dd>
|
|
334
|
+
|
|
335
|
+
**request:** `Truvity.ApiKeyUpdateAnnotationsInput`
|
|
336
|
+
|
|
337
|
+
</dd>
|
|
338
|
+
</dl>
|
|
339
|
+
|
|
340
|
+
<dl>
|
|
341
|
+
<dd>
|
|
342
|
+
|
|
343
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
344
|
+
|
|
345
|
+
</dd>
|
|
346
|
+
</dl>
|
|
347
|
+
</dd>
|
|
348
|
+
</dl>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</dd>
|
|
352
|
+
</dl>
|
|
353
|
+
</details>
|
|
354
|
+
|
|
355
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">apiKeyUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceApiKey</code></summary>
|
|
279
356
|
<dl>
|
|
280
357
|
<dd>
|
|
281
358
|
|
|
@@ -287,7 +364,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
287
364
|
<dl>
|
|
288
365
|
<dd>
|
|
289
366
|
|
|
290
|
-
Update API Key's resource.
|
|
367
|
+
Update labels of API Key's resource.
|
|
291
368
|
</dd>
|
|
292
369
|
</dl>
|
|
293
370
|
</dd>
|
|
@@ -302,9 +379,11 @@ Update API Key's resource.
|
|
|
302
379
|
<dd>
|
|
303
380
|
|
|
304
381
|
```typescript
|
|
305
|
-
await client.apiKeys.
|
|
382
|
+
await client.apiKeys.apiKeyUpdateLabels("id", {
|
|
306
383
|
ifMatch: "If-Match",
|
|
307
|
-
|
|
384
|
+
labels: {
|
|
385
|
+
"key": "value"
|
|
386
|
+
}
|
|
308
387
|
});
|
|
309
388
|
|
|
310
389
|
```
|
|
@@ -332,7 +411,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
332
411
|
<dl>
|
|
333
412
|
<dd>
|
|
334
413
|
|
|
335
|
-
**request:** `Truvity.
|
|
414
|
+
**request:** `Truvity.ApiKeyUpdateLabelsInput`
|
|
336
415
|
|
|
337
416
|
</dd>
|
|
338
417
|
</dl>
|
|
@@ -607,14 +686,7 @@ Import a Verifiable Credential.
|
|
|
607
686
|
|
|
608
687
|
```typescript
|
|
609
688
|
await client.credentials.credentialImport({
|
|
610
|
-
|
|
611
|
-
blobId: "string",
|
|
612
|
-
annotations: {
|
|
613
|
-
"string": "string"
|
|
614
|
-
},
|
|
615
|
-
labels: {
|
|
616
|
-
"string": "string"
|
|
617
|
-
}
|
|
689
|
+
blobId: "blob_id"
|
|
618
690
|
});
|
|
619
691
|
|
|
620
692
|
```
|
|
@@ -804,9 +876,7 @@ Get the latest version of Credential.
|
|
|
804
876
|
<dd>
|
|
805
877
|
|
|
806
878
|
```typescript
|
|
807
|
-
await client.credentials.credentialLatest("
|
|
808
|
-
ifNoneMatch: "string"
|
|
809
|
-
});
|
|
879
|
+
await client.credentials.credentialLatest("id");
|
|
810
880
|
|
|
811
881
|
```
|
|
812
882
|
</dd>
|
|
@@ -926,7 +996,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
926
996
|
</dl>
|
|
927
997
|
</details>
|
|
928
998
|
|
|
929
|
-
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">
|
|
999
|
+
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">credentialUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceCredential</code></summary>
|
|
930
1000
|
<dl>
|
|
931
1001
|
<dd>
|
|
932
1002
|
|
|
@@ -938,7 +1008,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
938
1008
|
<dl>
|
|
939
1009
|
<dd>
|
|
940
1010
|
|
|
941
|
-
|
|
1011
|
+
Update annotations of Credential's resource.
|
|
942
1012
|
</dd>
|
|
943
1013
|
</dl>
|
|
944
1014
|
</dd>
|
|
@@ -953,9 +1023,11 @@ Restore Credential's resource.
|
|
|
953
1023
|
<dd>
|
|
954
1024
|
|
|
955
1025
|
```typescript
|
|
956
|
-
await client.credentials.
|
|
957
|
-
|
|
958
|
-
|
|
1026
|
+
await client.credentials.credentialUpdateAnnotations("id", {
|
|
1027
|
+
ifMatch: "If-Match",
|
|
1028
|
+
annotations: {
|
|
1029
|
+
"key": "value"
|
|
1030
|
+
}
|
|
959
1031
|
});
|
|
960
1032
|
|
|
961
1033
|
```
|
|
@@ -983,7 +1055,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
983
1055
|
<dl>
|
|
984
1056
|
<dd>
|
|
985
1057
|
|
|
986
|
-
**request:** `Truvity.
|
|
1058
|
+
**request:** `Truvity.CredentialUpdateAnnotationsInput`
|
|
987
1059
|
|
|
988
1060
|
</dd>
|
|
989
1061
|
</dl>
|
|
@@ -1003,7 +1075,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1003
1075
|
</dl>
|
|
1004
1076
|
</details>
|
|
1005
1077
|
|
|
1006
|
-
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">
|
|
1078
|
+
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">credentialUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceCredential</code></summary>
|
|
1007
1079
|
<dl>
|
|
1008
1080
|
<dd>
|
|
1009
1081
|
|
|
@@ -1015,7 +1087,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1015
1087
|
<dl>
|
|
1016
1088
|
<dd>
|
|
1017
1089
|
|
|
1018
|
-
|
|
1090
|
+
Update labels of Credential's resource.
|
|
1019
1091
|
</dd>
|
|
1020
1092
|
</dl>
|
|
1021
1093
|
</dd>
|
|
@@ -1030,7 +1102,12 @@ History of the Credential's resources.
|
|
|
1030
1102
|
<dd>
|
|
1031
1103
|
|
|
1032
1104
|
```typescript
|
|
1033
|
-
await client.credentials.
|
|
1105
|
+
await client.credentials.credentialUpdateLabels("id", {
|
|
1106
|
+
ifMatch: "If-Match",
|
|
1107
|
+
labels: {
|
|
1108
|
+
"key": "value"
|
|
1109
|
+
}
|
|
1110
|
+
});
|
|
1034
1111
|
|
|
1035
1112
|
```
|
|
1036
1113
|
</dd>
|
|
@@ -1046,7 +1123,10 @@ await client.credentials.credentialHistory("id");
|
|
|
1046
1123
|
<dl>
|
|
1047
1124
|
<dd>
|
|
1048
1125
|
|
|
1049
|
-
**id:** `string`
|
|
1126
|
+
**id:** `string`
|
|
1127
|
+
|
|
1128
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
1129
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
1050
1130
|
|
|
1051
1131
|
</dd>
|
|
1052
1132
|
</dl>
|
|
@@ -1054,7 +1134,7 @@ await client.credentials.credentialHistory("id");
|
|
|
1054
1134
|
<dl>
|
|
1055
1135
|
<dd>
|
|
1056
1136
|
|
|
1057
|
-
**request:** `Truvity.
|
|
1137
|
+
**request:** `Truvity.CredentialUpdateLabelsInput`
|
|
1058
1138
|
|
|
1059
1139
|
</dd>
|
|
1060
1140
|
</dl>
|
|
@@ -1074,7 +1154,7 @@ await client.credentials.credentialHistory("id");
|
|
|
1074
1154
|
</dl>
|
|
1075
1155
|
</details>
|
|
1076
1156
|
|
|
1077
|
-
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">
|
|
1157
|
+
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">credentialRestore</a>(id, { ...params }) -> Truvity.ResourceCredential</code></summary>
|
|
1078
1158
|
<dl>
|
|
1079
1159
|
<dd>
|
|
1080
1160
|
|
|
@@ -1086,7 +1166,7 @@ await client.credentials.credentialHistory("id");
|
|
|
1086
1166
|
<dl>
|
|
1087
1167
|
<dd>
|
|
1088
1168
|
|
|
1089
|
-
|
|
1169
|
+
Restore Credential's resource.
|
|
1090
1170
|
</dd>
|
|
1091
1171
|
</dl>
|
|
1092
1172
|
</dd>
|
|
@@ -1101,8 +1181,8 @@ Read the specific version of the Credential's resource.
|
|
|
1101
1181
|
<dd>
|
|
1102
1182
|
|
|
1103
1183
|
```typescript
|
|
1104
|
-
await client.credentials.
|
|
1105
|
-
|
|
1184
|
+
await client.credentials.credentialRestore("id", {
|
|
1185
|
+
ifMatch: "If-Match"
|
|
1106
1186
|
});
|
|
1107
1187
|
|
|
1108
1188
|
```
|
|
@@ -1119,7 +1199,10 @@ await client.credentials.credentialRevision("string", 1, {
|
|
|
1119
1199
|
<dl>
|
|
1120
1200
|
<dd>
|
|
1121
1201
|
|
|
1122
|
-
**id:** `string`
|
|
1202
|
+
**id:** `string`
|
|
1203
|
+
|
|
1204
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
1205
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
1123
1206
|
|
|
1124
1207
|
</dd>
|
|
1125
1208
|
</dl>
|
|
@@ -1127,7 +1210,7 @@ await client.credentials.credentialRevision("string", 1, {
|
|
|
1127
1210
|
<dl>
|
|
1128
1211
|
<dd>
|
|
1129
1212
|
|
|
1130
|
-
**
|
|
1213
|
+
**request:** `Truvity.CredentialRestoreRequest`
|
|
1131
1214
|
|
|
1132
1215
|
</dd>
|
|
1133
1216
|
</dl>
|
|
@@ -1135,7 +1218,70 @@ await client.credentials.credentialRevision("string", 1, {
|
|
|
1135
1218
|
<dl>
|
|
1136
1219
|
<dd>
|
|
1137
1220
|
|
|
1138
|
-
**
|
|
1221
|
+
**requestOptions:** `Credentials.RequestOptions`
|
|
1222
|
+
|
|
1223
|
+
</dd>
|
|
1224
|
+
</dl>
|
|
1225
|
+
</dd>
|
|
1226
|
+
</dl>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
</dd>
|
|
1230
|
+
</dl>
|
|
1231
|
+
</details>
|
|
1232
|
+
|
|
1233
|
+
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">credentialHistory</a>(id, { ...params }) -> Truvity.ListCredential</code></summary>
|
|
1234
|
+
<dl>
|
|
1235
|
+
<dd>
|
|
1236
|
+
|
|
1237
|
+
#### 📝 Description
|
|
1238
|
+
|
|
1239
|
+
<dl>
|
|
1240
|
+
<dd>
|
|
1241
|
+
|
|
1242
|
+
<dl>
|
|
1243
|
+
<dd>
|
|
1244
|
+
|
|
1245
|
+
History of the Credential's resources.
|
|
1246
|
+
</dd>
|
|
1247
|
+
</dl>
|
|
1248
|
+
</dd>
|
|
1249
|
+
</dl>
|
|
1250
|
+
|
|
1251
|
+
#### 🔌 Usage
|
|
1252
|
+
|
|
1253
|
+
<dl>
|
|
1254
|
+
<dd>
|
|
1255
|
+
|
|
1256
|
+
<dl>
|
|
1257
|
+
<dd>
|
|
1258
|
+
|
|
1259
|
+
```typescript
|
|
1260
|
+
await client.credentials.credentialHistory("id");
|
|
1261
|
+
|
|
1262
|
+
```
|
|
1263
|
+
</dd>
|
|
1264
|
+
</dl>
|
|
1265
|
+
</dd>
|
|
1266
|
+
</dl>
|
|
1267
|
+
|
|
1268
|
+
#### ⚙️ Parameters
|
|
1269
|
+
|
|
1270
|
+
<dl>
|
|
1271
|
+
<dd>
|
|
1272
|
+
|
|
1273
|
+
<dl>
|
|
1274
|
+
<dd>
|
|
1275
|
+
|
|
1276
|
+
**id:** `string` — The ID of the resource.
|
|
1277
|
+
|
|
1278
|
+
</dd>
|
|
1279
|
+
</dl>
|
|
1280
|
+
|
|
1281
|
+
<dl>
|
|
1282
|
+
<dd>
|
|
1283
|
+
|
|
1284
|
+
**request:** `Truvity.CredentialHistoryRequest`
|
|
1139
1285
|
|
|
1140
1286
|
</dd>
|
|
1141
1287
|
</dl>
|
|
@@ -1155,7 +1301,7 @@ await client.credentials.credentialRevision("string", 1, {
|
|
|
1155
1301
|
</dl>
|
|
1156
1302
|
</details>
|
|
1157
1303
|
|
|
1158
|
-
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">
|
|
1304
|
+
<details><summary><code>client.credentials.<a href="/src/api/resources/credentials/client/Client.ts">credentialRevision</a>(id, revision, { ...params }) -> Truvity.ResourceCredential</code></summary>
|
|
1159
1305
|
<dl>
|
|
1160
1306
|
<dd>
|
|
1161
1307
|
|
|
@@ -1167,7 +1313,7 @@ await client.credentials.credentialRevision("string", 1, {
|
|
|
1167
1313
|
<dl>
|
|
1168
1314
|
<dd>
|
|
1169
1315
|
|
|
1170
|
-
|
|
1316
|
+
Read the specific version of the Credential's resource.
|
|
1171
1317
|
</dd>
|
|
1172
1318
|
</dl>
|
|
1173
1319
|
</dd>
|
|
@@ -1182,9 +1328,7 @@ Download of Credential's blob.
|
|
|
1182
1328
|
<dd>
|
|
1183
1329
|
|
|
1184
1330
|
```typescript
|
|
1185
|
-
await client.credentials.
|
|
1186
|
-
ifNoneMatch: "string"
|
|
1187
|
-
});
|
|
1331
|
+
await client.credentials.credentialRevision("id", 1);
|
|
1188
1332
|
|
|
1189
1333
|
```
|
|
1190
1334
|
</dd>
|
|
@@ -1216,7 +1360,7 @@ await client.credentials.credentialDownload("string", 1, {
|
|
|
1216
1360
|
<dl>
|
|
1217
1361
|
<dd>
|
|
1218
1362
|
|
|
1219
|
-
**request:** `Truvity.
|
|
1363
|
+
**request:** `Truvity.CredentialRevisionRequest`
|
|
1220
1364
|
|
|
1221
1365
|
</dd>
|
|
1222
1366
|
</dl>
|
|
@@ -1578,7 +1722,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1578
1722
|
</dl>
|
|
1579
1723
|
</details>
|
|
1580
1724
|
|
|
1581
|
-
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">
|
|
1725
|
+
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">didcommMessageUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceDidCommMessage</code></summary>
|
|
1582
1726
|
<dl>
|
|
1583
1727
|
<dd>
|
|
1584
1728
|
|
|
@@ -1590,7 +1734,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1590
1734
|
<dl>
|
|
1591
1735
|
<dd>
|
|
1592
1736
|
|
|
1593
|
-
|
|
1737
|
+
Update annotations of DIDComm Message's resource.
|
|
1594
1738
|
</dd>
|
|
1595
1739
|
</dl>
|
|
1596
1740
|
</dd>
|
|
@@ -1605,8 +1749,11 @@ Restore DIDComm Message's resource.
|
|
|
1605
1749
|
<dd>
|
|
1606
1750
|
|
|
1607
1751
|
```typescript
|
|
1608
|
-
await client.didcommMessages.
|
|
1609
|
-
ifMatch: "If-Match"
|
|
1752
|
+
await client.didcommMessages.didcommMessageUpdateAnnotations("id", {
|
|
1753
|
+
ifMatch: "If-Match",
|
|
1754
|
+
annotations: {
|
|
1755
|
+
"key": "value"
|
|
1756
|
+
}
|
|
1610
1757
|
});
|
|
1611
1758
|
|
|
1612
1759
|
```
|
|
@@ -1634,7 +1781,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1634
1781
|
<dl>
|
|
1635
1782
|
<dd>
|
|
1636
1783
|
|
|
1637
|
-
**request:** `Truvity.
|
|
1784
|
+
**request:** `Truvity.DidcommMessageUpdateAnnotationsInput`
|
|
1638
1785
|
|
|
1639
1786
|
</dd>
|
|
1640
1787
|
</dl>
|
|
@@ -1654,7 +1801,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1654
1801
|
</dl>
|
|
1655
1802
|
</details>
|
|
1656
1803
|
|
|
1657
|
-
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">
|
|
1804
|
+
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">didcommMessageUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceDidCommMessage</code></summary>
|
|
1658
1805
|
<dl>
|
|
1659
1806
|
<dd>
|
|
1660
1807
|
|
|
@@ -1666,7 +1813,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
1666
1813
|
<dl>
|
|
1667
1814
|
<dd>
|
|
1668
1815
|
|
|
1669
|
-
|
|
1816
|
+
Update labels of DIDComm Message's resource.
|
|
1670
1817
|
</dd>
|
|
1671
1818
|
</dl>
|
|
1672
1819
|
</dd>
|
|
@@ -1681,7 +1828,12 @@ History of the DIDComm Message's resources.
|
|
|
1681
1828
|
<dd>
|
|
1682
1829
|
|
|
1683
1830
|
```typescript
|
|
1684
|
-
await client.didcommMessages.
|
|
1831
|
+
await client.didcommMessages.didcommMessageUpdateLabels("id", {
|
|
1832
|
+
ifMatch: "If-Match",
|
|
1833
|
+
labels: {
|
|
1834
|
+
"key": "value"
|
|
1835
|
+
}
|
|
1836
|
+
});
|
|
1685
1837
|
|
|
1686
1838
|
```
|
|
1687
1839
|
</dd>
|
|
@@ -1697,7 +1849,10 @@ await client.didcommMessages.didcommMessageHistory("id");
|
|
|
1697
1849
|
<dl>
|
|
1698
1850
|
<dd>
|
|
1699
1851
|
|
|
1700
|
-
**id:** `string`
|
|
1852
|
+
**id:** `string`
|
|
1853
|
+
|
|
1854
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
1855
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
1701
1856
|
|
|
1702
1857
|
</dd>
|
|
1703
1858
|
</dl>
|
|
@@ -1705,7 +1860,7 @@ await client.didcommMessages.didcommMessageHistory("id");
|
|
|
1705
1860
|
<dl>
|
|
1706
1861
|
<dd>
|
|
1707
1862
|
|
|
1708
|
-
**request:** `Truvity.
|
|
1863
|
+
**request:** `Truvity.DidcommMessageUpdateLabelsInput`
|
|
1709
1864
|
|
|
1710
1865
|
</dd>
|
|
1711
1866
|
</dl>
|
|
@@ -1725,7 +1880,7 @@ await client.didcommMessages.didcommMessageHistory("id");
|
|
|
1725
1880
|
</dl>
|
|
1726
1881
|
</details>
|
|
1727
1882
|
|
|
1728
|
-
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">
|
|
1883
|
+
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">didcommMessageRestore</a>(id, { ...params }) -> Truvity.ResourceDidCommMessage</code></summary>
|
|
1729
1884
|
<dl>
|
|
1730
1885
|
<dd>
|
|
1731
1886
|
|
|
@@ -1737,7 +1892,7 @@ await client.didcommMessages.didcommMessageHistory("id");
|
|
|
1737
1892
|
<dl>
|
|
1738
1893
|
<dd>
|
|
1739
1894
|
|
|
1740
|
-
|
|
1895
|
+
Restore DIDComm Message's resource.
|
|
1741
1896
|
</dd>
|
|
1742
1897
|
</dl>
|
|
1743
1898
|
</dd>
|
|
@@ -1752,7 +1907,9 @@ Read the specific version of the DIDComm Message's resource.
|
|
|
1752
1907
|
<dd>
|
|
1753
1908
|
|
|
1754
1909
|
```typescript
|
|
1755
|
-
await client.didcommMessages.
|
|
1910
|
+
await client.didcommMessages.didcommMessageRestore("id", {
|
|
1911
|
+
ifMatch: "If-Match"
|
|
1912
|
+
});
|
|
1756
1913
|
|
|
1757
1914
|
```
|
|
1758
1915
|
</dd>
|
|
@@ -1768,15 +1925,10 @@ await client.didcommMessages.didcommMessageRevision("id", 1);
|
|
|
1768
1925
|
<dl>
|
|
1769
1926
|
<dd>
|
|
1770
1927
|
|
|
1771
|
-
**id:** `string`
|
|
1772
|
-
|
|
1773
|
-
</dd>
|
|
1774
|
-
</dl>
|
|
1775
|
-
|
|
1776
|
-
<dl>
|
|
1777
|
-
<dd>
|
|
1928
|
+
**id:** `string`
|
|
1778
1929
|
|
|
1779
|
-
|
|
1930
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
1931
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
1780
1932
|
|
|
1781
1933
|
</dd>
|
|
1782
1934
|
</dl>
|
|
@@ -1784,7 +1936,7 @@ await client.didcommMessages.didcommMessageRevision("id", 1);
|
|
|
1784
1936
|
<dl>
|
|
1785
1937
|
<dd>
|
|
1786
1938
|
|
|
1787
|
-
**request:** `Truvity.
|
|
1939
|
+
**request:** `Truvity.DidcommMessageRestoreRequest`
|
|
1788
1940
|
|
|
1789
1941
|
</dd>
|
|
1790
1942
|
</dl>
|
|
@@ -1804,8 +1956,7 @@ await client.didcommMessages.didcommMessageRevision("id", 1);
|
|
|
1804
1956
|
</dl>
|
|
1805
1957
|
</details>
|
|
1806
1958
|
|
|
1807
|
-
|
|
1808
|
-
<details><summary><code>client.dids.<a href="/src/api/resources/dids/client/Client.ts">didDocumentSelfGet</a>({ ...params }) -> Truvity.DidDocument</code></summary>
|
|
1959
|
+
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">didcommMessageHistory</a>(id, { ...params }) -> Truvity.ListDidCommMessage</code></summary>
|
|
1809
1960
|
<dl>
|
|
1810
1961
|
<dd>
|
|
1811
1962
|
|
|
@@ -1817,8 +1968,7 @@ await client.didcommMessages.didcommMessageRevision("id", 1);
|
|
|
1817
1968
|
<dl>
|
|
1818
1969
|
<dd>
|
|
1819
1970
|
|
|
1820
|
-
|
|
1821
|
-
Comparing to [DIDDocumentGet](#tag/desk/operation/DIDDocumentGet) endpoint, this one returns the tenant's DID(did:web) document for the authenticated tenant only.
|
|
1971
|
+
History of the DIDComm Message's resources.
|
|
1822
1972
|
</dd>
|
|
1823
1973
|
</dl>
|
|
1824
1974
|
</dd>
|
|
@@ -1833,7 +1983,7 @@ Comparing to [DIDDocumentGet](#tag/desk/operation/DIDDocumentGet) endpoint, this
|
|
|
1833
1983
|
<dd>
|
|
1834
1984
|
|
|
1835
1985
|
```typescript
|
|
1836
|
-
await client.
|
|
1986
|
+
await client.didcommMessages.didcommMessageHistory("id");
|
|
1837
1987
|
|
|
1838
1988
|
```
|
|
1839
1989
|
</dd>
|
|
@@ -1849,7 +1999,7 @@ await client.dids.didDocumentSelfGet();
|
|
|
1849
1999
|
<dl>
|
|
1850
2000
|
<dd>
|
|
1851
2001
|
|
|
1852
|
-
**
|
|
2002
|
+
**id:** `string` — The ID of the resource.
|
|
1853
2003
|
|
|
1854
2004
|
</dd>
|
|
1855
2005
|
</dl>
|
|
@@ -1857,7 +2007,15 @@ await client.dids.didDocumentSelfGet();
|
|
|
1857
2007
|
<dl>
|
|
1858
2008
|
<dd>
|
|
1859
2009
|
|
|
1860
|
-
**
|
|
2010
|
+
**request:** `Truvity.DidcommMessageHistoryRequest`
|
|
2011
|
+
|
|
2012
|
+
</dd>
|
|
2013
|
+
</dl>
|
|
2014
|
+
|
|
2015
|
+
<dl>
|
|
2016
|
+
<dd>
|
|
2017
|
+
|
|
2018
|
+
**requestOptions:** `DidcommMessages.RequestOptions`
|
|
1861
2019
|
|
|
1862
2020
|
</dd>
|
|
1863
2021
|
</dl>
|
|
@@ -1869,8 +2027,7 @@ await client.dids.didDocumentSelfGet();
|
|
|
1869
2027
|
</dl>
|
|
1870
2028
|
</details>
|
|
1871
2029
|
|
|
1872
|
-
|
|
1873
|
-
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftCreate</a>({ ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2030
|
+
<details><summary><code>client.didcommMessages.<a href="/src/api/resources/didcommMessages/client/Client.ts">didcommMessageRevision</a>(id, revision, { ...params }) -> Truvity.ResourceDidCommMessage</code></summary>
|
|
1874
2031
|
<dl>
|
|
1875
2032
|
<dd>
|
|
1876
2033
|
|
|
@@ -1882,7 +2039,7 @@ await client.dids.didDocumentSelfGet();
|
|
|
1882
2039
|
<dl>
|
|
1883
2040
|
<dd>
|
|
1884
2041
|
|
|
1885
|
-
|
|
2042
|
+
Read the specific version of the DIDComm Message's resource.
|
|
1886
2043
|
</dd>
|
|
1887
2044
|
</dl>
|
|
1888
2045
|
</dd>
|
|
@@ -1897,11 +2054,7 @@ Create Draft's resource.
|
|
|
1897
2054
|
<dd>
|
|
1898
2055
|
|
|
1899
2056
|
```typescript
|
|
1900
|
-
await client.
|
|
1901
|
-
body: {
|
|
1902
|
-
data: {}
|
|
1903
|
-
}
|
|
1904
|
-
});
|
|
2057
|
+
await client.didcommMessages.didcommMessageRevision("id", 1);
|
|
1905
2058
|
|
|
1906
2059
|
```
|
|
1907
2060
|
</dd>
|
|
@@ -1917,7 +2070,7 @@ await client.drafts.draftCreate({
|
|
|
1917
2070
|
<dl>
|
|
1918
2071
|
<dd>
|
|
1919
2072
|
|
|
1920
|
-
**
|
|
2073
|
+
**id:** `string` — The ID of the resource.
|
|
1921
2074
|
|
|
1922
2075
|
</dd>
|
|
1923
2076
|
</dl>
|
|
@@ -1925,7 +2078,154 @@ await client.drafts.draftCreate({
|
|
|
1925
2078
|
<dl>
|
|
1926
2079
|
<dd>
|
|
1927
2080
|
|
|
1928
|
-
**
|
|
2081
|
+
**revision:** `number` — The revision of the resource.
|
|
2082
|
+
|
|
2083
|
+
</dd>
|
|
2084
|
+
</dl>
|
|
2085
|
+
|
|
2086
|
+
<dl>
|
|
2087
|
+
<dd>
|
|
2088
|
+
|
|
2089
|
+
**request:** `Truvity.DidcommMessageRevisionRequest`
|
|
2090
|
+
|
|
2091
|
+
</dd>
|
|
2092
|
+
</dl>
|
|
2093
|
+
|
|
2094
|
+
<dl>
|
|
2095
|
+
<dd>
|
|
2096
|
+
|
|
2097
|
+
**requestOptions:** `DidcommMessages.RequestOptions`
|
|
2098
|
+
|
|
2099
|
+
</dd>
|
|
2100
|
+
</dl>
|
|
2101
|
+
</dd>
|
|
2102
|
+
</dl>
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
</dd>
|
|
2106
|
+
</dl>
|
|
2107
|
+
</details>
|
|
2108
|
+
|
|
2109
|
+
## dids
|
|
2110
|
+
<details><summary><code>client.dids.<a href="/src/api/resources/dids/client/Client.ts">didDocumentSelfGet</a>({ ...params }) -> Truvity.DidDocument</code></summary>
|
|
2111
|
+
<dl>
|
|
2112
|
+
<dd>
|
|
2113
|
+
|
|
2114
|
+
#### 📝 Description
|
|
2115
|
+
|
|
2116
|
+
<dl>
|
|
2117
|
+
<dd>
|
|
2118
|
+
|
|
2119
|
+
<dl>
|
|
2120
|
+
<dd>
|
|
2121
|
+
|
|
2122
|
+
Return the tenant's DID(did:web) document.
|
|
2123
|
+
Comparing to [DIDDocumentGet](#tag/desk/operation/DIDDocumentGet) endpoint, this one returns the tenant's DID(did:web) document for the authenticated tenant only.
|
|
2124
|
+
</dd>
|
|
2125
|
+
</dl>
|
|
2126
|
+
</dd>
|
|
2127
|
+
</dl>
|
|
2128
|
+
|
|
2129
|
+
#### 🔌 Usage
|
|
2130
|
+
|
|
2131
|
+
<dl>
|
|
2132
|
+
<dd>
|
|
2133
|
+
|
|
2134
|
+
<dl>
|
|
2135
|
+
<dd>
|
|
2136
|
+
|
|
2137
|
+
```typescript
|
|
2138
|
+
await client.dids.didDocumentSelfGet();
|
|
2139
|
+
|
|
2140
|
+
```
|
|
2141
|
+
</dd>
|
|
2142
|
+
</dl>
|
|
2143
|
+
</dd>
|
|
2144
|
+
</dl>
|
|
2145
|
+
|
|
2146
|
+
#### ⚙️ Parameters
|
|
2147
|
+
|
|
2148
|
+
<dl>
|
|
2149
|
+
<dd>
|
|
2150
|
+
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2154
|
+
**request:** `Truvity.DidDocumentSelfGetRequest`
|
|
2155
|
+
|
|
2156
|
+
</dd>
|
|
2157
|
+
</dl>
|
|
2158
|
+
|
|
2159
|
+
<dl>
|
|
2160
|
+
<dd>
|
|
2161
|
+
|
|
2162
|
+
**requestOptions:** `Dids.RequestOptions`
|
|
2163
|
+
|
|
2164
|
+
</dd>
|
|
2165
|
+
</dl>
|
|
2166
|
+
</dd>
|
|
2167
|
+
</dl>
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
</dd>
|
|
2171
|
+
</dl>
|
|
2172
|
+
</details>
|
|
2173
|
+
|
|
2174
|
+
## drafts
|
|
2175
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftCreate</a>({ ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2176
|
+
<dl>
|
|
2177
|
+
<dd>
|
|
2178
|
+
|
|
2179
|
+
#### 📝 Description
|
|
2180
|
+
|
|
2181
|
+
<dl>
|
|
2182
|
+
<dd>
|
|
2183
|
+
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2187
|
+
Create Draft's resource.
|
|
2188
|
+
</dd>
|
|
2189
|
+
</dl>
|
|
2190
|
+
</dd>
|
|
2191
|
+
</dl>
|
|
2192
|
+
|
|
2193
|
+
#### 🔌 Usage
|
|
2194
|
+
|
|
2195
|
+
<dl>
|
|
2196
|
+
<dd>
|
|
2197
|
+
|
|
2198
|
+
<dl>
|
|
2199
|
+
<dd>
|
|
2200
|
+
|
|
2201
|
+
```typescript
|
|
2202
|
+
await client.drafts.draftCreate({
|
|
2203
|
+
data: {}
|
|
2204
|
+
});
|
|
2205
|
+
|
|
2206
|
+
```
|
|
2207
|
+
</dd>
|
|
2208
|
+
</dl>
|
|
2209
|
+
</dd>
|
|
2210
|
+
</dl>
|
|
2211
|
+
|
|
2212
|
+
#### ⚙️ Parameters
|
|
2213
|
+
|
|
2214
|
+
<dl>
|
|
2215
|
+
<dd>
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
**request:** `Truvity.DraftInput`
|
|
2221
|
+
|
|
2222
|
+
</dd>
|
|
2223
|
+
</dl>
|
|
2224
|
+
|
|
2225
|
+
<dl>
|
|
2226
|
+
<dd>
|
|
2227
|
+
|
|
2228
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
1929
2229
|
|
|
1930
2230
|
</dd>
|
|
1931
2231
|
</dl>
|
|
@@ -2176,9 +2476,7 @@ Update Draft's resource.
|
|
|
2176
2476
|
```typescript
|
|
2177
2477
|
await client.drafts.draftUpdate("id", {
|
|
2178
2478
|
ifMatch: "If-Match",
|
|
2179
|
-
|
|
2180
|
-
data: {}
|
|
2181
|
-
}
|
|
2479
|
+
data: {}
|
|
2182
2480
|
});
|
|
2183
2481
|
|
|
2184
2482
|
```
|
|
@@ -2206,7 +2504,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2206
2504
|
<dl>
|
|
2207
2505
|
<dd>
|
|
2208
2506
|
|
|
2209
|
-
**request:** `Truvity.
|
|
2507
|
+
**request:** `Truvity.DraftUpdateInput`
|
|
2210
2508
|
|
|
2211
2509
|
</dd>
|
|
2212
2510
|
</dl>
|
|
@@ -2226,7 +2524,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2226
2524
|
</dl>
|
|
2227
2525
|
</details>
|
|
2228
2526
|
|
|
2229
|
-
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">
|
|
2527
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2230
2528
|
<dl>
|
|
2231
2529
|
<dd>
|
|
2232
2530
|
|
|
@@ -2238,7 +2536,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2238
2536
|
<dl>
|
|
2239
2537
|
<dd>
|
|
2240
2538
|
|
|
2241
|
-
|
|
2539
|
+
Update annotations of Draft's resource.
|
|
2242
2540
|
</dd>
|
|
2243
2541
|
</dl>
|
|
2244
2542
|
</dd>
|
|
@@ -2253,8 +2551,11 @@ Restore Draft's resource.
|
|
|
2253
2551
|
<dd>
|
|
2254
2552
|
|
|
2255
2553
|
```typescript
|
|
2256
|
-
await client.drafts.
|
|
2257
|
-
ifMatch: "If-Match"
|
|
2554
|
+
await client.drafts.draftUpdateAnnotations("id", {
|
|
2555
|
+
ifMatch: "If-Match",
|
|
2556
|
+
annotations: {
|
|
2557
|
+
"key": "value"
|
|
2558
|
+
}
|
|
2258
2559
|
});
|
|
2259
2560
|
|
|
2260
2561
|
```
|
|
@@ -2282,7 +2583,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2282
2583
|
<dl>
|
|
2283
2584
|
<dd>
|
|
2284
2585
|
|
|
2285
|
-
**request:** `Truvity.
|
|
2586
|
+
**request:** `Truvity.DraftUpdateAnnotationsInput`
|
|
2286
2587
|
|
|
2287
2588
|
</dd>
|
|
2288
2589
|
</dl>
|
|
@@ -2302,7 +2603,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2302
2603
|
</dl>
|
|
2303
2604
|
</details>
|
|
2304
2605
|
|
|
2305
|
-
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">
|
|
2606
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2306
2607
|
<dl>
|
|
2307
2608
|
<dd>
|
|
2308
2609
|
|
|
@@ -2314,7 +2615,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
2314
2615
|
<dl>
|
|
2315
2616
|
<dd>
|
|
2316
2617
|
|
|
2317
|
-
|
|
2618
|
+
Update labels of Draft's resource.
|
|
2318
2619
|
</dd>
|
|
2319
2620
|
</dl>
|
|
2320
2621
|
</dd>
|
|
@@ -2329,7 +2630,12 @@ History of the Draft's resources.
|
|
|
2329
2630
|
<dd>
|
|
2330
2631
|
|
|
2331
2632
|
```typescript
|
|
2332
|
-
await client.drafts.
|
|
2633
|
+
await client.drafts.draftUpdateLabels("id", {
|
|
2634
|
+
ifMatch: "If-Match",
|
|
2635
|
+
labels: {
|
|
2636
|
+
"key": "value"
|
|
2637
|
+
}
|
|
2638
|
+
});
|
|
2333
2639
|
|
|
2334
2640
|
```
|
|
2335
2641
|
</dd>
|
|
@@ -2345,7 +2651,10 @@ await client.drafts.draftHistory("id");
|
|
|
2345
2651
|
<dl>
|
|
2346
2652
|
<dd>
|
|
2347
2653
|
|
|
2348
|
-
**id:** `string`
|
|
2654
|
+
**id:** `string`
|
|
2655
|
+
|
|
2656
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
2657
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
2349
2658
|
|
|
2350
2659
|
</dd>
|
|
2351
2660
|
</dl>
|
|
@@ -2353,7 +2662,7 @@ await client.drafts.draftHistory("id");
|
|
|
2353
2662
|
<dl>
|
|
2354
2663
|
<dd>
|
|
2355
2664
|
|
|
2356
|
-
**request:** `Truvity.
|
|
2665
|
+
**request:** `Truvity.DraftUpdateLabelsInput`
|
|
2357
2666
|
|
|
2358
2667
|
</dd>
|
|
2359
2668
|
</dl>
|
|
@@ -2373,7 +2682,7 @@ await client.drafts.draftHistory("id");
|
|
|
2373
2682
|
</dl>
|
|
2374
2683
|
</details>
|
|
2375
2684
|
|
|
2376
|
-
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">
|
|
2685
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftRestore</a>(id, { ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2377
2686
|
<dl>
|
|
2378
2687
|
<dd>
|
|
2379
2688
|
|
|
@@ -2385,7 +2694,7 @@ await client.drafts.draftHistory("id");
|
|
|
2385
2694
|
<dl>
|
|
2386
2695
|
<dd>
|
|
2387
2696
|
|
|
2388
|
-
|
|
2697
|
+
Restore Draft's resource.
|
|
2389
2698
|
</dd>
|
|
2390
2699
|
</dl>
|
|
2391
2700
|
</dd>
|
|
@@ -2400,7 +2709,9 @@ Read the specific version of the Draft's resource.
|
|
|
2400
2709
|
<dd>
|
|
2401
2710
|
|
|
2402
2711
|
```typescript
|
|
2403
|
-
await client.drafts.
|
|
2712
|
+
await client.drafts.draftRestore("id", {
|
|
2713
|
+
ifMatch: "If-Match"
|
|
2714
|
+
});
|
|
2404
2715
|
|
|
2405
2716
|
```
|
|
2406
2717
|
</dd>
|
|
@@ -2416,7 +2727,10 @@ await client.drafts.draftRevision("id", 1);
|
|
|
2416
2727
|
<dl>
|
|
2417
2728
|
<dd>
|
|
2418
2729
|
|
|
2419
|
-
**id:** `string`
|
|
2730
|
+
**id:** `string`
|
|
2731
|
+
|
|
2732
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
2733
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
2420
2734
|
|
|
2421
2735
|
</dd>
|
|
2422
2736
|
</dl>
|
|
@@ -2424,7 +2738,7 @@ await client.drafts.draftRevision("id", 1);
|
|
|
2424
2738
|
<dl>
|
|
2425
2739
|
<dd>
|
|
2426
2740
|
|
|
2427
|
-
**
|
|
2741
|
+
**request:** `Truvity.DraftRestoreRequest`
|
|
2428
2742
|
|
|
2429
2743
|
</dd>
|
|
2430
2744
|
</dl>
|
|
@@ -2432,7 +2746,70 @@ await client.drafts.draftRevision("id", 1);
|
|
|
2432
2746
|
<dl>
|
|
2433
2747
|
<dd>
|
|
2434
2748
|
|
|
2435
|
-
**
|
|
2749
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
2750
|
+
|
|
2751
|
+
</dd>
|
|
2752
|
+
</dl>
|
|
2753
|
+
</dd>
|
|
2754
|
+
</dl>
|
|
2755
|
+
|
|
2756
|
+
|
|
2757
|
+
</dd>
|
|
2758
|
+
</dl>
|
|
2759
|
+
</details>
|
|
2760
|
+
|
|
2761
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftHistory</a>(id, { ...params }) -> Truvity.ListDraft</code></summary>
|
|
2762
|
+
<dl>
|
|
2763
|
+
<dd>
|
|
2764
|
+
|
|
2765
|
+
#### 📝 Description
|
|
2766
|
+
|
|
2767
|
+
<dl>
|
|
2768
|
+
<dd>
|
|
2769
|
+
|
|
2770
|
+
<dl>
|
|
2771
|
+
<dd>
|
|
2772
|
+
|
|
2773
|
+
History of the Draft's resources.
|
|
2774
|
+
</dd>
|
|
2775
|
+
</dl>
|
|
2776
|
+
</dd>
|
|
2777
|
+
</dl>
|
|
2778
|
+
|
|
2779
|
+
#### 🔌 Usage
|
|
2780
|
+
|
|
2781
|
+
<dl>
|
|
2782
|
+
<dd>
|
|
2783
|
+
|
|
2784
|
+
<dl>
|
|
2785
|
+
<dd>
|
|
2786
|
+
|
|
2787
|
+
```typescript
|
|
2788
|
+
await client.drafts.draftHistory("id");
|
|
2789
|
+
|
|
2790
|
+
```
|
|
2791
|
+
</dd>
|
|
2792
|
+
</dl>
|
|
2793
|
+
</dd>
|
|
2794
|
+
</dl>
|
|
2795
|
+
|
|
2796
|
+
#### ⚙️ Parameters
|
|
2797
|
+
|
|
2798
|
+
<dl>
|
|
2799
|
+
<dd>
|
|
2800
|
+
|
|
2801
|
+
<dl>
|
|
2802
|
+
<dd>
|
|
2803
|
+
|
|
2804
|
+
**id:** `string` — The ID of the resource.
|
|
2805
|
+
|
|
2806
|
+
</dd>
|
|
2807
|
+
</dl>
|
|
2808
|
+
|
|
2809
|
+
<dl>
|
|
2810
|
+
<dd>
|
|
2811
|
+
|
|
2812
|
+
**request:** `Truvity.DraftHistoryRequest`
|
|
2436
2813
|
|
|
2437
2814
|
</dd>
|
|
2438
2815
|
</dl>
|
|
@@ -2452,7 +2829,7 @@ await client.drafts.draftRevision("id", 1);
|
|
|
2452
2829
|
</dl>
|
|
2453
2830
|
</details>
|
|
2454
2831
|
|
|
2455
|
-
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">
|
|
2832
|
+
<details><summary><code>client.drafts.<a href="/src/api/resources/drafts/client/Client.ts">draftRevision</a>(id, revision, { ...params }) -> Truvity.ResourceDraft</code></summary>
|
|
2456
2833
|
<dl>
|
|
2457
2834
|
<dd>
|
|
2458
2835
|
|
|
@@ -2464,7 +2841,7 @@ await client.drafts.draftRevision("id", 1);
|
|
|
2464
2841
|
<dl>
|
|
2465
2842
|
<dd>
|
|
2466
2843
|
|
|
2467
|
-
|
|
2844
|
+
Read the specific version of the Draft's resource.
|
|
2468
2845
|
</dd>
|
|
2469
2846
|
</dl>
|
|
2470
2847
|
</dd>
|
|
@@ -2479,11 +2856,7 @@ Generate an unsigned Verifiable Credential in JSON-LD format from a Draft.
|
|
|
2479
2856
|
<dd>
|
|
2480
2857
|
|
|
2481
2858
|
```typescript
|
|
2482
|
-
await client.drafts.
|
|
2483
|
-
issuer: "string",
|
|
2484
|
-
validFrom: new Date("2024-01-15T09:30:00.000Z"),
|
|
2485
|
-
validUntil: new Date("2024-01-15T09:30:00.000Z")
|
|
2486
|
-
});
|
|
2859
|
+
await client.drafts.draftRevision("id", 1);
|
|
2487
2860
|
|
|
2488
2861
|
```
|
|
2489
2862
|
</dd>
|
|
@@ -2515,7 +2888,7 @@ await client.drafts.draftExport("string", 1, {
|
|
|
2515
2888
|
<dl>
|
|
2516
2889
|
<dd>
|
|
2517
2890
|
|
|
2518
|
-
**request:** `Truvity.
|
|
2891
|
+
**request:** `Truvity.DraftRevisionRequest`
|
|
2519
2892
|
|
|
2520
2893
|
</dd>
|
|
2521
2894
|
</dl>
|
|
@@ -2566,12 +2939,8 @@ It's a handy call that wraps the following:
|
|
|
2566
2939
|
<dd>
|
|
2567
2940
|
|
|
2568
2941
|
```typescript
|
|
2569
|
-
await client.drafts.draftIssue("
|
|
2570
|
-
keyId: "
|
|
2571
|
-
didMethod: Truvity.DraftIssueDidMethod.Key,
|
|
2572
|
-
issuer: "string",
|
|
2573
|
-
validFrom: new Date("2024-01-15T09:30:00.000Z"),
|
|
2574
|
-
validUntil: new Date("2024-01-15T09:30:00.000Z")
|
|
2942
|
+
await client.drafts.draftIssue("id", 1, {
|
|
2943
|
+
keyId: "key_id"
|
|
2575
2944
|
});
|
|
2576
2945
|
|
|
2577
2946
|
```
|
|
@@ -2654,9 +3023,7 @@ Create File's resource.
|
|
|
2654
3023
|
```typescript
|
|
2655
3024
|
await client.files.fileCreate({
|
|
2656
3025
|
blobId: "blob_id",
|
|
2657
|
-
|
|
2658
|
-
data: {}
|
|
2659
|
-
}
|
|
3026
|
+
data: {}
|
|
2660
3027
|
});
|
|
2661
3028
|
|
|
2662
3029
|
```
|
|
@@ -2673,7 +3040,7 @@ await client.files.fileCreate({
|
|
|
2673
3040
|
<dl>
|
|
2674
3041
|
<dd>
|
|
2675
3042
|
|
|
2676
|
-
**request:** `Truvity.
|
|
3043
|
+
**request:** `Truvity.FileInput`
|
|
2677
3044
|
|
|
2678
3045
|
</dd>
|
|
2679
3046
|
</dl>
|
|
@@ -2995,9 +3362,7 @@ Update File's resource.
|
|
|
2995
3362
|
```typescript
|
|
2996
3363
|
await client.files.fileUpdate("id", {
|
|
2997
3364
|
ifMatch: "If-Match",
|
|
2998
|
-
|
|
2999
|
-
data: {}
|
|
3000
|
-
}
|
|
3365
|
+
data: {}
|
|
3001
3366
|
});
|
|
3002
3367
|
|
|
3003
3368
|
```
|
|
@@ -3025,7 +3390,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3025
3390
|
<dl>
|
|
3026
3391
|
<dd>
|
|
3027
3392
|
|
|
3028
|
-
**request:** `Truvity.
|
|
3393
|
+
**request:** `Truvity.FileUpdateInput`
|
|
3029
3394
|
|
|
3030
3395
|
</dd>
|
|
3031
3396
|
</dl>
|
|
@@ -3045,7 +3410,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3045
3410
|
</dl>
|
|
3046
3411
|
</details>
|
|
3047
3412
|
|
|
3048
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">
|
|
3413
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">fileUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceFile</code></summary>
|
|
3049
3414
|
<dl>
|
|
3050
3415
|
<dd>
|
|
3051
3416
|
|
|
@@ -3057,7 +3422,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3057
3422
|
<dl>
|
|
3058
3423
|
<dd>
|
|
3059
3424
|
|
|
3060
|
-
|
|
3425
|
+
Update annotations of File's resource.
|
|
3061
3426
|
</dd>
|
|
3062
3427
|
</dl>
|
|
3063
3428
|
</dd>
|
|
@@ -3072,8 +3437,11 @@ Restore File's resource.
|
|
|
3072
3437
|
<dd>
|
|
3073
3438
|
|
|
3074
3439
|
```typescript
|
|
3075
|
-
await client.files.
|
|
3076
|
-
ifMatch: "If-Match"
|
|
3440
|
+
await client.files.fileUpdateAnnotations("id", {
|
|
3441
|
+
ifMatch: "If-Match",
|
|
3442
|
+
annotations: {
|
|
3443
|
+
"key": "value"
|
|
3444
|
+
}
|
|
3077
3445
|
});
|
|
3078
3446
|
|
|
3079
3447
|
```
|
|
@@ -3101,7 +3469,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3101
3469
|
<dl>
|
|
3102
3470
|
<dd>
|
|
3103
3471
|
|
|
3104
|
-
**request:** `Truvity.
|
|
3472
|
+
**request:** `Truvity.FileUpdateAnnotationsInput`
|
|
3105
3473
|
|
|
3106
3474
|
</dd>
|
|
3107
3475
|
</dl>
|
|
@@ -3121,7 +3489,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3121
3489
|
</dl>
|
|
3122
3490
|
</details>
|
|
3123
3491
|
|
|
3124
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">
|
|
3492
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">fileUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceFile</code></summary>
|
|
3125
3493
|
<dl>
|
|
3126
3494
|
<dd>
|
|
3127
3495
|
|
|
@@ -3133,7 +3501,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3133
3501
|
<dl>
|
|
3134
3502
|
<dd>
|
|
3135
3503
|
|
|
3136
|
-
|
|
3504
|
+
Update labels of File's resource.
|
|
3137
3505
|
</dd>
|
|
3138
3506
|
</dl>
|
|
3139
3507
|
</dd>
|
|
@@ -3148,7 +3516,12 @@ History of the File's resources.
|
|
|
3148
3516
|
<dd>
|
|
3149
3517
|
|
|
3150
3518
|
```typescript
|
|
3151
|
-
await client.files.
|
|
3519
|
+
await client.files.fileUpdateLabels("id", {
|
|
3520
|
+
ifMatch: "If-Match",
|
|
3521
|
+
labels: {
|
|
3522
|
+
"key": "value"
|
|
3523
|
+
}
|
|
3524
|
+
});
|
|
3152
3525
|
|
|
3153
3526
|
```
|
|
3154
3527
|
</dd>
|
|
@@ -3164,7 +3537,10 @@ await client.files.fileHistory("id");
|
|
|
3164
3537
|
<dl>
|
|
3165
3538
|
<dd>
|
|
3166
3539
|
|
|
3167
|
-
**id:** `string`
|
|
3540
|
+
**id:** `string`
|
|
3541
|
+
|
|
3542
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
3543
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
3168
3544
|
|
|
3169
3545
|
</dd>
|
|
3170
3546
|
</dl>
|
|
@@ -3172,7 +3548,7 @@ await client.files.fileHistory("id");
|
|
|
3172
3548
|
<dl>
|
|
3173
3549
|
<dd>
|
|
3174
3550
|
|
|
3175
|
-
**request:** `Truvity.
|
|
3551
|
+
**request:** `Truvity.FileUpdateLabelsInput`
|
|
3176
3552
|
|
|
3177
3553
|
</dd>
|
|
3178
3554
|
</dl>
|
|
@@ -3192,7 +3568,7 @@ await client.files.fileHistory("id");
|
|
|
3192
3568
|
</dl>
|
|
3193
3569
|
</details>
|
|
3194
3570
|
|
|
3195
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">
|
|
3571
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">fileRestore</a>(id, { ...params }) -> Truvity.ResourceFile</code></summary>
|
|
3196
3572
|
<dl>
|
|
3197
3573
|
<dd>
|
|
3198
3574
|
|
|
@@ -3204,7 +3580,7 @@ await client.files.fileHistory("id");
|
|
|
3204
3580
|
<dl>
|
|
3205
3581
|
<dd>
|
|
3206
3582
|
|
|
3207
|
-
|
|
3583
|
+
Restore File's resource.
|
|
3208
3584
|
</dd>
|
|
3209
3585
|
</dl>
|
|
3210
3586
|
</dd>
|
|
@@ -3219,7 +3595,9 @@ Read the specific version of the File's resource.
|
|
|
3219
3595
|
<dd>
|
|
3220
3596
|
|
|
3221
3597
|
```typescript
|
|
3222
|
-
await client.files.
|
|
3598
|
+
await client.files.fileRestore("id", {
|
|
3599
|
+
ifMatch: "If-Match"
|
|
3600
|
+
});
|
|
3223
3601
|
|
|
3224
3602
|
```
|
|
3225
3603
|
</dd>
|
|
@@ -3235,15 +3613,10 @@ await client.files.fileRevision("id", 1);
|
|
|
3235
3613
|
<dl>
|
|
3236
3614
|
<dd>
|
|
3237
3615
|
|
|
3238
|
-
**id:** `string`
|
|
3239
|
-
|
|
3240
|
-
</dd>
|
|
3241
|
-
</dl>
|
|
3242
|
-
|
|
3243
|
-
<dl>
|
|
3244
|
-
<dd>
|
|
3616
|
+
**id:** `string`
|
|
3245
3617
|
|
|
3246
|
-
|
|
3618
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
3619
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
3247
3620
|
|
|
3248
3621
|
</dd>
|
|
3249
3622
|
</dl>
|
|
@@ -3251,7 +3624,7 @@ await client.files.fileRevision("id", 1);
|
|
|
3251
3624
|
<dl>
|
|
3252
3625
|
<dd>
|
|
3253
3626
|
|
|
3254
|
-
**request:** `Truvity.
|
|
3627
|
+
**request:** `Truvity.FileRestoreRequest`
|
|
3255
3628
|
|
|
3256
3629
|
</dd>
|
|
3257
3630
|
</dl>
|
|
@@ -3271,7 +3644,7 @@ await client.files.fileRevision("id", 1);
|
|
|
3271
3644
|
</dl>
|
|
3272
3645
|
</details>
|
|
3273
3646
|
|
|
3274
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">
|
|
3647
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">fileHistory</a>(id, { ...params }) -> Truvity.ListFile</code></summary>
|
|
3275
3648
|
<dl>
|
|
3276
3649
|
<dd>
|
|
3277
3650
|
|
|
@@ -3283,7 +3656,7 @@ await client.files.fileRevision("id", 1);
|
|
|
3283
3656
|
<dl>
|
|
3284
3657
|
<dd>
|
|
3285
3658
|
|
|
3286
|
-
|
|
3659
|
+
History of the File's resources.
|
|
3287
3660
|
</dd>
|
|
3288
3661
|
</dl>
|
|
3289
3662
|
</dd>
|
|
@@ -3298,9 +3671,7 @@ Download of File's blob.
|
|
|
3298
3671
|
<dd>
|
|
3299
3672
|
|
|
3300
3673
|
```typescript
|
|
3301
|
-
await client.files.
|
|
3302
|
-
ifNoneMatch: "string"
|
|
3303
|
-
});
|
|
3674
|
+
await client.files.fileHistory("id");
|
|
3304
3675
|
|
|
3305
3676
|
```
|
|
3306
3677
|
</dd>
|
|
@@ -3324,15 +3695,7 @@ await client.files.fileDownload("string", 1, {
|
|
|
3324
3695
|
<dl>
|
|
3325
3696
|
<dd>
|
|
3326
3697
|
|
|
3327
|
-
**
|
|
3328
|
-
|
|
3329
|
-
</dd>
|
|
3330
|
-
</dl>
|
|
3331
|
-
|
|
3332
|
-
<dl>
|
|
3333
|
-
<dd>
|
|
3334
|
-
|
|
3335
|
-
**request:** `Truvity.FileDownloadRequest`
|
|
3698
|
+
**request:** `Truvity.FileHistoryRequest`
|
|
3336
3699
|
|
|
3337
3700
|
</dd>
|
|
3338
3701
|
</dl>
|
|
@@ -3352,8 +3715,7 @@ await client.files.fileDownload("string", 1, {
|
|
|
3352
3715
|
</dl>
|
|
3353
3716
|
</details>
|
|
3354
3717
|
|
|
3355
|
-
|
|
3356
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyGenerate</a>({ ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
3718
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">fileRevision</a>(id, revision, { ...params }) -> Truvity.ResourceFile</code></summary>
|
|
3357
3719
|
<dl>
|
|
3358
3720
|
<dd>
|
|
3359
3721
|
|
|
@@ -3365,7 +3727,7 @@ await client.files.fileDownload("string", 1, {
|
|
|
3365
3727
|
<dl>
|
|
3366
3728
|
<dd>
|
|
3367
3729
|
|
|
3368
|
-
|
|
3730
|
+
Read the specific version of the File's resource.
|
|
3369
3731
|
</dd>
|
|
3370
3732
|
</dl>
|
|
3371
3733
|
</dd>
|
|
@@ -3380,9 +3742,7 @@ Generate a new cryptographic key pair.
|
|
|
3380
3742
|
<dd>
|
|
3381
3743
|
|
|
3382
3744
|
```typescript
|
|
3383
|
-
await client.
|
|
3384
|
-
data: {}
|
|
3385
|
-
});
|
|
3745
|
+
await client.files.fileRevision("id", 1);
|
|
3386
3746
|
|
|
3387
3747
|
```
|
|
3388
3748
|
</dd>
|
|
@@ -3398,7 +3758,7 @@ await client.keys.keyGenerate({
|
|
|
3398
3758
|
<dl>
|
|
3399
3759
|
<dd>
|
|
3400
3760
|
|
|
3401
|
-
**
|
|
3761
|
+
**id:** `string` — The ID of the resource.
|
|
3402
3762
|
|
|
3403
3763
|
</dd>
|
|
3404
3764
|
</dl>
|
|
@@ -3406,7 +3766,23 @@ await client.keys.keyGenerate({
|
|
|
3406
3766
|
<dl>
|
|
3407
3767
|
<dd>
|
|
3408
3768
|
|
|
3409
|
-
**
|
|
3769
|
+
**revision:** `number` — The revision of the resource.
|
|
3770
|
+
|
|
3771
|
+
</dd>
|
|
3772
|
+
</dl>
|
|
3773
|
+
|
|
3774
|
+
<dl>
|
|
3775
|
+
<dd>
|
|
3776
|
+
|
|
3777
|
+
**request:** `Truvity.FileRevisionRequest`
|
|
3778
|
+
|
|
3779
|
+
</dd>
|
|
3780
|
+
</dl>
|
|
3781
|
+
|
|
3782
|
+
<dl>
|
|
3783
|
+
<dd>
|
|
3784
|
+
|
|
3785
|
+
**requestOptions:** `Files.RequestOptions`
|
|
3410
3786
|
|
|
3411
3787
|
</dd>
|
|
3412
3788
|
</dl>
|
|
@@ -3418,7 +3794,8 @@ await client.keys.keyGenerate({
|
|
|
3418
3794
|
</dl>
|
|
3419
3795
|
</details>
|
|
3420
3796
|
|
|
3421
|
-
|
|
3797
|
+
## keys
|
|
3798
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyGenerate</a>({ ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
3422
3799
|
<dl>
|
|
3423
3800
|
<dd>
|
|
3424
3801
|
|
|
@@ -3430,98 +3807,7 @@ await client.keys.keyGenerate({
|
|
|
3430
3807
|
<dl>
|
|
3431
3808
|
<dd>
|
|
3432
3809
|
|
|
3433
|
-
|
|
3434
|
-
Remember, that you do not have any option to get private key by Truvity API, you could only use it
|
|
3435
|
-
|
|
3436
|
-
If you prefer to keep private key, then you need to generate it manually.
|
|
3437
|
-
To use manually generated key CredentialIssue and PresentationIssue you need to import it.
|
|
3438
|
-
|
|
3439
|
-
To generate key-pair you have two options
|
|
3440
|
-
|
|
3441
|
-
1. OpenSSL - [OpenSSL commands](https://www.openssl.org/docs/man1.1.1/man1/index.html)
|
|
3442
|
-
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)
|
|
3443
|
-
|
|
3444
|
-
How to install JWX
|
|
3445
|
-
|
|
3446
|
-
1. Download & Install Golang - [https://go.dev/doc/install](https://go.dev/doc/install)
|
|
3447
|
-
2. Clone & Build & Install [github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx)
|
|
3448
|
-
```bash
|
|
3449
|
-
git clone https://github.com/lestrrat-go/jwx
|
|
3450
|
-
cd jwx/cmd/jwx
|
|
3451
|
-
go install -tags=jwx_es256k,jwx_secp256k1_pem .
|
|
3452
|
-
```
|
|
3453
|
-
3. Verify that you correctly install everything
|
|
3454
|
-
|
|
3455
|
-
```bash
|
|
3456
|
-
➜ jwx --help
|
|
3457
|
-
NAME:
|
|
3458
|
-
jwx - Tools for various JWE/JWK/JWS/JWT operations
|
|
3459
|
-
|
|
3460
|
-
USAGE:
|
|
3461
|
-
jwx [global options] command [command options] [arguments...]
|
|
3462
|
-
|
|
3463
|
-
COMMANDS:
|
|
3464
|
-
jwa List available algorithms and types
|
|
3465
|
-
jwe Work with JWE messages
|
|
3466
|
-
jwk Work with JWK and JWK sets
|
|
3467
|
-
jws Work with JWS messages
|
|
3468
|
-
help, h Shows a list of commands or help for one command
|
|
3469
|
-
|
|
3470
|
-
GLOBAL OPTIONS:
|
|
3471
|
-
--help, -h show help
|
|
3472
|
-
```
|
|
3473
|
-
|
|
3474
|
-
How generate private key by `jwx` (output format JWK)
|
|
3475
|
-
|
|
3476
|
-
```bash
|
|
3477
|
-
# ED25519
|
|
3478
|
-
jwx jwx generate --type OKP --curve Ed25519
|
|
3479
|
-
# P256
|
|
3480
|
-
jwx jwx generate --type EC --curve P-256
|
|
3481
|
-
# P384
|
|
3482
|
-
jwx jwx generate --type EC --curve P-384
|
|
3483
|
-
```
|
|
3484
|
-
|
|
3485
|
-
How to generate public key from private key by `jwx` (input format - JWK, output format - JWK)
|
|
3486
|
-
|
|
3487
|
-
```bash
|
|
3488
|
-
jwx jwk format -I json -O json - <(pathfile with private key in JWK format)
|
|
3489
|
-
```
|
|
3490
|
-
|
|
3491
|
-
How to generate private key by OpenSSL (output format PEM - PKCS#8)
|
|
3492
|
-
|
|
3493
|
-
```bash
|
|
3494
|
-
# ED25519
|
|
3495
|
-
openssl genpkey -algorithm ed25519 | openssl pkcs8 -nocrypt -topk8
|
|
3496
|
-
# P256
|
|
3497
|
-
openssl ecparam -name prime256v1 -noout -genkey | openssl pkcs8 -nocrypt -topk8
|
|
3498
|
-
# P384
|
|
3499
|
-
openssl ecparam -name secp384r1 -noout -genkey | openssl pkcs8 -nocrypt -topk8
|
|
3500
|
-
```
|
|
3501
|
-
|
|
3502
|
-
How to transform existing private key to PKCS8 format by OpenSSL (input format PEM, output format - PEM PCKS#8)
|
|
3503
|
-
|
|
3504
|
-
```bash
|
|
3505
|
-
openssl pkcs8 -nocrypt -topk8 <(pathfile with private key in PEM format)
|
|
3506
|
-
```
|
|
3507
|
-
|
|
3508
|
-
How to transform private key to public key by OpenSSL (input format PEM, output format - PEM PKIX)
|
|
3509
|
-
|
|
3510
|
-
```bash
|
|
3511
|
-
openssl pkey -pubout <(pathfile with private key in PKCS8 format)
|
|
3512
|
-
```
|
|
3513
|
-
|
|
3514
|
-
Useful third-party documentation:
|
|
3515
|
-
|
|
3516
|
-
- [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/manmaster/man1/openssl-genpkey.html).
|
|
3517
|
-
- [openssl-ec, ec - EC key processing](https://www.openssl.org/docs/man1.0.2/man1/ec.html)
|
|
3518
|
-
- [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/man3.0/man1/openssl-genrsa.html)
|
|
3519
|
-
- [openssl-pkcs8 - PKCS#8 format private key conversion command](https://www.openssl.org/docs/manmaster/man1/openssl-pkcs8.html)
|
|
3520
|
-
- [JWX - github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx/blob/main/cmd/jwx/README.md)
|
|
3521
|
-
- [FIPS 186-4](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf).
|
|
3522
|
-
- [SEC2](https://www.secg.org/sec2-v2.pdf).
|
|
3523
|
-
- [AWS KMS - Asymmetric key specs](https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html)
|
|
3524
|
-
.
|
|
3810
|
+
Generate a new cryptographic key pair.
|
|
3525
3811
|
</dd>
|
|
3526
3812
|
</dl>
|
|
3527
3813
|
</dd>
|
|
@@ -3536,8 +3822,8 @@ Useful third-party documentation:
|
|
|
3536
3822
|
<dd>
|
|
3537
3823
|
|
|
3538
3824
|
```typescript
|
|
3539
|
-
await client.keys.
|
|
3540
|
-
data:
|
|
3825
|
+
await client.keys.keyGenerate({
|
|
3826
|
+
data: {}
|
|
3541
3827
|
});
|
|
3542
3828
|
|
|
3543
3829
|
```
|
|
@@ -3554,7 +3840,7 @@ await client.keys.keyImport({
|
|
|
3554
3840
|
<dl>
|
|
3555
3841
|
<dd>
|
|
3556
3842
|
|
|
3557
|
-
**request:** `Truvity.
|
|
3843
|
+
**request:** `Truvity.KeyGenerateInput`
|
|
3558
3844
|
|
|
3559
3845
|
</dd>
|
|
3560
3846
|
</dl>
|
|
@@ -3574,7 +3860,7 @@ await client.keys.keyImport({
|
|
|
3574
3860
|
</dl>
|
|
3575
3861
|
</details>
|
|
3576
3862
|
|
|
3577
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
3863
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyImport</a>({ ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
3578
3864
|
<dl>
|
|
3579
3865
|
<dd>
|
|
3580
3866
|
|
|
@@ -3586,70 +3872,98 @@ await client.keys.keyImport({
|
|
|
3586
3872
|
<dl>
|
|
3587
3873
|
<dd>
|
|
3588
3874
|
|
|
3589
|
-
|
|
3590
|
-
|
|
3591
|
-
</dl>
|
|
3592
|
-
</dd>
|
|
3593
|
-
</dl>
|
|
3875
|
+
You could use KeyGenerate, if you want to rely to generated by Truvity key-pairs for CredentialIssue and PresentationIssue.
|
|
3876
|
+
Remember, that you do not have any option to get private key by Truvity API, you could only use it
|
|
3594
3877
|
|
|
3595
|
-
|
|
3878
|
+
If you prefer to keep private key, then you need to generate it manually.
|
|
3879
|
+
To use manually generated key CredentialIssue and PresentationIssue you need to import it.
|
|
3596
3880
|
|
|
3597
|
-
|
|
3598
|
-
<dd>
|
|
3881
|
+
To generate key-pair you have two options
|
|
3599
3882
|
|
|
3600
|
-
|
|
3601
|
-
|
|
3883
|
+
1. OpenSSL - [OpenSSL commands](https://www.openssl.org/docs/man1.1.1/man1/index.html)
|
|
3884
|
+
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)
|
|
3602
3885
|
|
|
3603
|
-
|
|
3604
|
-
await client.keys.keySearch();
|
|
3886
|
+
How to install JWX
|
|
3605
3887
|
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3888
|
+
1. Download & Install Golang - [https://go.dev/doc/install](https://go.dev/doc/install)
|
|
3889
|
+
2. Clone & Build & Install [github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx)
|
|
3890
|
+
```bash
|
|
3891
|
+
git clone https://github.com/lestrrat-go/jwx
|
|
3892
|
+
cd jwx/cmd/jwx
|
|
3893
|
+
go install -tags=jwx_es256k,jwx_secp256k1_pem .
|
|
3894
|
+
```
|
|
3895
|
+
3. Verify that you correctly install everything
|
|
3896
|
+
|
|
3897
|
+
```bash
|
|
3898
|
+
➜ jwx --help
|
|
3899
|
+
NAME:
|
|
3900
|
+
jwx - Tools for various JWE/JWK/JWS/JWT operations
|
|
3901
|
+
|
|
3902
|
+
USAGE:
|
|
3903
|
+
jwx [global options] command [command options] [arguments...]
|
|
3904
|
+
|
|
3905
|
+
COMMANDS:
|
|
3906
|
+
jwa List available algorithms and types
|
|
3907
|
+
jwe Work with JWE messages
|
|
3908
|
+
jwk Work with JWK and JWK sets
|
|
3909
|
+
jws Work with JWS messages
|
|
3910
|
+
help, h Shows a list of commands or help for one command
|
|
3611
3911
|
|
|
3612
|
-
|
|
3912
|
+
GLOBAL OPTIONS:
|
|
3913
|
+
--help, -h show help
|
|
3914
|
+
```
|
|
3613
3915
|
|
|
3614
|
-
|
|
3615
|
-
<dd>
|
|
3916
|
+
How generate private key by `jwx` (output format JWK)
|
|
3616
3917
|
|
|
3617
|
-
|
|
3618
|
-
|
|
3918
|
+
```bash
|
|
3919
|
+
# ED25519
|
|
3920
|
+
jwx jwx generate --type OKP --curve Ed25519
|
|
3921
|
+
# P256
|
|
3922
|
+
jwx jwx generate --type EC --curve P-256
|
|
3923
|
+
# P384
|
|
3924
|
+
jwx jwx generate --type EC --curve P-384
|
|
3925
|
+
```
|
|
3619
3926
|
|
|
3620
|
-
|
|
3621
|
-
|
|
3622
|
-
</dd>
|
|
3623
|
-
</dl>
|
|
3927
|
+
How to generate public key from private key by `jwx` (input format - JWK, output format - JWK)
|
|
3624
3928
|
|
|
3625
|
-
|
|
3626
|
-
<
|
|
3929
|
+
```bash
|
|
3930
|
+
jwx jwk format -I json -O json - <(pathfile with private key in JWK format)
|
|
3931
|
+
```
|
|
3627
3932
|
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
</dd>
|
|
3631
|
-
</dl>
|
|
3632
|
-
</dd>
|
|
3633
|
-
</dl>
|
|
3933
|
+
How to generate private key by OpenSSL (output format PEM - PKCS#8)
|
|
3634
3934
|
|
|
3935
|
+
```bash
|
|
3936
|
+
# ED25519
|
|
3937
|
+
openssl genpkey -algorithm ed25519 | openssl pkcs8 -nocrypt -topk8
|
|
3938
|
+
# P256
|
|
3939
|
+
openssl ecparam -name prime256v1 -noout -genkey | openssl pkcs8 -nocrypt -topk8
|
|
3940
|
+
# P384
|
|
3941
|
+
openssl ecparam -name secp384r1 -noout -genkey | openssl pkcs8 -nocrypt -topk8
|
|
3942
|
+
```
|
|
3635
3943
|
|
|
3636
|
-
|
|
3637
|
-
</dl>
|
|
3638
|
-
</details>
|
|
3944
|
+
How to transform existing private key to PKCS8 format by OpenSSL (input format PEM, output format - PEM PCKS#8)
|
|
3639
3945
|
|
|
3640
|
-
|
|
3641
|
-
<
|
|
3642
|
-
|
|
3946
|
+
```bash
|
|
3947
|
+
openssl pkcs8 -nocrypt -topk8 <(pathfile with private key in PEM format)
|
|
3948
|
+
```
|
|
3643
3949
|
|
|
3644
|
-
|
|
3950
|
+
How to transform private key to public key by OpenSSL (input format PEM, output format - PEM PKIX)
|
|
3645
3951
|
|
|
3646
|
-
|
|
3647
|
-
<
|
|
3952
|
+
```bash
|
|
3953
|
+
openssl pkey -pubout <(pathfile with private key in PKCS8 format)
|
|
3954
|
+
```
|
|
3648
3955
|
|
|
3649
|
-
|
|
3650
|
-
<dd>
|
|
3956
|
+
Useful third-party documentation:
|
|
3651
3957
|
|
|
3652
|
-
|
|
3958
|
+
- [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/manmaster/man1/openssl-genpkey.html).
|
|
3959
|
+
- [openssl-ec, ec - EC key processing](https://www.openssl.org/docs/man1.0.2/man1/ec.html)
|
|
3960
|
+
- [openssl-genrsa - generate an RSA private key](https://www.openssl.org/docs/man3.0/man1/openssl-genrsa.html)
|
|
3961
|
+
- [openssl-pkcs8 - PKCS#8 format private key conversion command](https://www.openssl.org/docs/manmaster/man1/openssl-pkcs8.html)
|
|
3962
|
+
- [JWX - github.com/lestrrat-go/jwx](https://github.com/lestrrat-go/jwx/blob/main/cmd/jwx/README.md)
|
|
3963
|
+
- [FIPS 186-4](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf).
|
|
3964
|
+
- [SEC2](https://www.secg.org/sec2-v2.pdf).
|
|
3965
|
+
- [AWS KMS - Asymmetric key specs](https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html)
|
|
3966
|
+
.
|
|
3653
3967
|
</dd>
|
|
3654
3968
|
</dl>
|
|
3655
3969
|
</dd>
|
|
@@ -3664,7 +3978,9 @@ Get the latest version of Key.
|
|
|
3664
3978
|
<dd>
|
|
3665
3979
|
|
|
3666
3980
|
```typescript
|
|
3667
|
-
await client.keys.
|
|
3981
|
+
await client.keys.keyImport({
|
|
3982
|
+
data: "data"
|
|
3983
|
+
});
|
|
3668
3984
|
|
|
3669
3985
|
```
|
|
3670
3986
|
</dd>
|
|
@@ -3680,15 +3996,7 @@ await client.keys.keyLatest("id");
|
|
|
3680
3996
|
<dl>
|
|
3681
3997
|
<dd>
|
|
3682
3998
|
|
|
3683
|
-
**
|
|
3684
|
-
|
|
3685
|
-
</dd>
|
|
3686
|
-
</dl>
|
|
3687
|
-
|
|
3688
|
-
<dl>
|
|
3689
|
-
<dd>
|
|
3690
|
-
|
|
3691
|
-
**request:** `Truvity.KeyLatestRequest`
|
|
3999
|
+
**request:** `Truvity.KeyImportSecretInput`
|
|
3692
4000
|
|
|
3693
4001
|
</dd>
|
|
3694
4002
|
</dl>
|
|
@@ -3708,7 +4016,7 @@ await client.keys.keyLatest("id");
|
|
|
3708
4016
|
</dl>
|
|
3709
4017
|
</details>
|
|
3710
4018
|
|
|
3711
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
4019
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keySearch</a>({ ...params }) -> Truvity.ListKeyPublic</code></summary>
|
|
3712
4020
|
<dl>
|
|
3713
4021
|
<dd>
|
|
3714
4022
|
|
|
@@ -3720,7 +4028,7 @@ await client.keys.keyLatest("id");
|
|
|
3720
4028
|
<dl>
|
|
3721
4029
|
<dd>
|
|
3722
4030
|
|
|
3723
|
-
|
|
4031
|
+
Search for Keys with extended filters capabilities.
|
|
3724
4032
|
</dd>
|
|
3725
4033
|
</dl>
|
|
3726
4034
|
</dd>
|
|
@@ -3735,9 +4043,7 @@ Delete Key's resource.
|
|
|
3735
4043
|
<dd>
|
|
3736
4044
|
|
|
3737
4045
|
```typescript
|
|
3738
|
-
await client.keys.
|
|
3739
|
-
ifMatch: "If-Match"
|
|
3740
|
-
});
|
|
4046
|
+
await client.keys.keySearch();
|
|
3741
4047
|
|
|
3742
4048
|
```
|
|
3743
4049
|
</dd>
|
|
@@ -3753,18 +4059,7 @@ await client.keys.keyDelete("id", {
|
|
|
3753
4059
|
<dl>
|
|
3754
4060
|
<dd>
|
|
3755
4061
|
|
|
3756
|
-
**
|
|
3757
|
-
|
|
3758
|
-
The primary and unique identifier of the resource (inside tenant)
|
|
3759
|
-
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
3760
|
-
|
|
3761
|
-
</dd>
|
|
3762
|
-
</dl>
|
|
3763
|
-
|
|
3764
|
-
<dl>
|
|
3765
|
-
<dd>
|
|
3766
|
-
|
|
3767
|
-
**request:** `Truvity.KeyDeleteRequest`
|
|
4062
|
+
**request:** `Truvity.KeySearchRequest`
|
|
3768
4063
|
|
|
3769
4064
|
</dd>
|
|
3770
4065
|
</dl>
|
|
@@ -3784,7 +4079,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3784
4079
|
</dl>
|
|
3785
4080
|
</details>
|
|
3786
4081
|
|
|
3787
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
4082
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyLatest</a>(id, { ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
3788
4083
|
<dl>
|
|
3789
4084
|
<dd>
|
|
3790
4085
|
|
|
@@ -3796,7 +4091,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3796
4091
|
<dl>
|
|
3797
4092
|
<dd>
|
|
3798
4093
|
|
|
3799
|
-
|
|
4094
|
+
Get the latest version of Key.
|
|
3800
4095
|
</dd>
|
|
3801
4096
|
</dl>
|
|
3802
4097
|
</dd>
|
|
@@ -3811,9 +4106,7 @@ Update Key's resource.
|
|
|
3811
4106
|
<dd>
|
|
3812
4107
|
|
|
3813
4108
|
```typescript
|
|
3814
|
-
await client.keys.
|
|
3815
|
-
ifMatch: "If-Match"
|
|
3816
|
-
});
|
|
4109
|
+
await client.keys.keyLatest("id");
|
|
3817
4110
|
|
|
3818
4111
|
```
|
|
3819
4112
|
</dd>
|
|
@@ -3829,10 +4122,7 @@ await client.keys.keyUpdate("id", {
|
|
|
3829
4122
|
<dl>
|
|
3830
4123
|
<dd>
|
|
3831
4124
|
|
|
3832
|
-
**id:** `string`
|
|
3833
|
-
|
|
3834
|
-
The primary and unique identifier of the resource (inside tenant)
|
|
3835
|
-
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
4125
|
+
**id:** `string` — The ID of the resource.
|
|
3836
4126
|
|
|
3837
4127
|
</dd>
|
|
3838
4128
|
</dl>
|
|
@@ -3840,7 +4130,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3840
4130
|
<dl>
|
|
3841
4131
|
<dd>
|
|
3842
4132
|
|
|
3843
|
-
**request:** `Truvity.
|
|
4133
|
+
**request:** `Truvity.KeyLatestRequest`
|
|
3844
4134
|
|
|
3845
4135
|
</dd>
|
|
3846
4136
|
</dl>
|
|
@@ -3860,7 +4150,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3860
4150
|
</dl>
|
|
3861
4151
|
</details>
|
|
3862
4152
|
|
|
3863
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
4153
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyDelete</a>(id, { ...params }) -> void</code></summary>
|
|
3864
4154
|
<dl>
|
|
3865
4155
|
<dd>
|
|
3866
4156
|
|
|
@@ -3872,7 +4162,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3872
4162
|
<dl>
|
|
3873
4163
|
<dd>
|
|
3874
4164
|
|
|
3875
|
-
|
|
4165
|
+
Delete Key's resource.
|
|
3876
4166
|
</dd>
|
|
3877
4167
|
</dl>
|
|
3878
4168
|
</dd>
|
|
@@ -3887,9 +4177,8 @@ Sign a JSON-LD representation of an unsigned Credential.
|
|
|
3887
4177
|
<dd>
|
|
3888
4178
|
|
|
3889
4179
|
```typescript
|
|
3890
|
-
await client.keys.
|
|
3891
|
-
|
|
3892
|
-
body: "string"
|
|
4180
|
+
await client.keys.keyDelete("id", {
|
|
4181
|
+
ifMatch: "If-Match"
|
|
3893
4182
|
});
|
|
3894
4183
|
|
|
3895
4184
|
```
|
|
@@ -3917,7 +4206,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3917
4206
|
<dl>
|
|
3918
4207
|
<dd>
|
|
3919
4208
|
|
|
3920
|
-
**request:** `Truvity.
|
|
4209
|
+
**request:** `Truvity.KeyDeleteRequest`
|
|
3921
4210
|
|
|
3922
4211
|
</dd>
|
|
3923
4212
|
</dl>
|
|
@@ -3937,7 +4226,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3937
4226
|
</dl>
|
|
3938
4227
|
</details>
|
|
3939
4228
|
|
|
3940
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
4229
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
3941
4230
|
<dl>
|
|
3942
4231
|
<dd>
|
|
3943
4232
|
|
|
@@ -3949,7 +4238,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3949
4238
|
<dl>
|
|
3950
4239
|
<dd>
|
|
3951
4240
|
|
|
3952
|
-
|
|
4241
|
+
Update annotations of Key's resource.
|
|
3953
4242
|
</dd>
|
|
3954
4243
|
</dl>
|
|
3955
4244
|
</dd>
|
|
@@ -3964,9 +4253,11 @@ Sign DIDComm Message Plaintext.
|
|
|
3964
4253
|
<dd>
|
|
3965
4254
|
|
|
3966
4255
|
```typescript
|
|
3967
|
-
await client.keys.
|
|
3968
|
-
|
|
3969
|
-
|
|
4256
|
+
await client.keys.keyUpdateAnnotations("id", {
|
|
4257
|
+
ifMatch: "If-Match",
|
|
4258
|
+
annotations: {
|
|
4259
|
+
"key": "value"
|
|
4260
|
+
}
|
|
3970
4261
|
});
|
|
3971
4262
|
|
|
3972
4263
|
```
|
|
@@ -3994,7 +4285,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
3994
4285
|
<dl>
|
|
3995
4286
|
<dd>
|
|
3996
4287
|
|
|
3997
|
-
**request:** `Truvity.
|
|
4288
|
+
**request:** `Truvity.KeyUpdateAnnotationsInput`
|
|
3998
4289
|
|
|
3999
4290
|
</dd>
|
|
4000
4291
|
</dl>
|
|
@@ -4014,7 +4305,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4014
4305
|
</dl>
|
|
4015
4306
|
</details>
|
|
4016
4307
|
|
|
4017
|
-
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">
|
|
4308
|
+
<details><summary><code>client.keys.<a href="/src/api/resources/keys/client/Client.ts">keyUpdateLabels</a>(id, { ...params }) -> Truvity.ResourceKeyPublic</code></summary>
|
|
4018
4309
|
<dl>
|
|
4019
4310
|
<dd>
|
|
4020
4311
|
|
|
@@ -4026,7 +4317,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4026
4317
|
<dl>
|
|
4027
4318
|
<dd>
|
|
4028
4319
|
|
|
4029
|
-
|
|
4320
|
+
Update labels of Key's resource.
|
|
4030
4321
|
</dd>
|
|
4031
4322
|
</dl>
|
|
4032
4323
|
</dd>
|
|
@@ -4041,9 +4332,11 @@ Sign a JSON-LD representation of an unsigned Presentation.
|
|
|
4041
4332
|
<dd>
|
|
4042
4333
|
|
|
4043
4334
|
```typescript
|
|
4044
|
-
await client.keys.
|
|
4045
|
-
|
|
4046
|
-
|
|
4335
|
+
await client.keys.keyUpdateLabels("id", {
|
|
4336
|
+
ifMatch: "If-Match",
|
|
4337
|
+
labels: {
|
|
4338
|
+
"key": "value"
|
|
4339
|
+
}
|
|
4047
4340
|
});
|
|
4048
4341
|
|
|
4049
4342
|
```
|
|
@@ -4071,7 +4364,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4071
4364
|
<dl>
|
|
4072
4365
|
<dd>
|
|
4073
4366
|
|
|
4074
|
-
**request:** `Truvity.
|
|
4367
|
+
**request:** `Truvity.KeyUpdateLabelsInput`
|
|
4075
4368
|
|
|
4076
4369
|
</dd>
|
|
4077
4370
|
</dl>
|
|
@@ -4318,7 +4611,7 @@ await client.keys.keyRevision("id", 1);
|
|
|
4318
4611
|
</details>
|
|
4319
4612
|
|
|
4320
4613
|
## presentations
|
|
4321
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4614
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationImport</a>({ ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4322
4615
|
<dl>
|
|
4323
4616
|
<dd>
|
|
4324
4617
|
|
|
@@ -4330,7 +4623,7 @@ await client.keys.keyRevision("id", 1);
|
|
|
4330
4623
|
<dl>
|
|
4331
4624
|
<dd>
|
|
4332
4625
|
|
|
4333
|
-
|
|
4626
|
+
Import a Verifiable Presentation.
|
|
4334
4627
|
</dd>
|
|
4335
4628
|
</dl>
|
|
4336
4629
|
</dd>
|
|
@@ -4345,9 +4638,8 @@ Generate an unsigned Verifiable Presentation in JSON-LD format from a list of Cr
|
|
|
4345
4638
|
<dd>
|
|
4346
4639
|
|
|
4347
4640
|
```typescript
|
|
4348
|
-
await client.presentations.
|
|
4349
|
-
|
|
4350
|
-
credentialIds: ["string"]
|
|
4641
|
+
await client.presentations.presentationImport({
|
|
4642
|
+
blobId: "blob_id"
|
|
4351
4643
|
});
|
|
4352
4644
|
|
|
4353
4645
|
```
|
|
@@ -4364,7 +4656,7 @@ await client.presentations.presentationExport({
|
|
|
4364
4656
|
<dl>
|
|
4365
4657
|
<dd>
|
|
4366
4658
|
|
|
4367
|
-
**request:** `Truvity.
|
|
4659
|
+
**request:** `Truvity.PresentationInput`
|
|
4368
4660
|
|
|
4369
4661
|
</dd>
|
|
4370
4662
|
</dl>
|
|
@@ -4384,7 +4676,7 @@ await client.presentations.presentationExport({
|
|
|
4384
4676
|
</dl>
|
|
4385
4677
|
</details>
|
|
4386
4678
|
|
|
4387
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4679
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationIssue</a>({ ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4388
4680
|
<dl>
|
|
4389
4681
|
<dd>
|
|
4390
4682
|
|
|
@@ -4396,7 +4688,11 @@ await client.presentations.presentationExport({
|
|
|
4396
4688
|
<dl>
|
|
4397
4689
|
<dd>
|
|
4398
4690
|
|
|
4399
|
-
|
|
4691
|
+
It's a handy call that wraps the following:
|
|
4692
|
+
|
|
4693
|
+
1. [Exporting](#tag/presentations/operation/PresentationExport) an unsigned JSON-LD representation of a Verifiable Presentation.
|
|
4694
|
+
2. [Signing](#tag/keys/operation/PresentationSign) the created unsigned Presentation.
|
|
4695
|
+
3. [Importing](#tag/presentations/operation/PresentationImport) the signed Presentation.
|
|
4400
4696
|
</dd>
|
|
4401
4697
|
</dl>
|
|
4402
4698
|
</dd>
|
|
@@ -4411,8 +4707,9 @@ Import a Verifiable Presentation.
|
|
|
4411
4707
|
<dd>
|
|
4412
4708
|
|
|
4413
4709
|
```typescript
|
|
4414
|
-
await client.presentations.
|
|
4415
|
-
|
|
4710
|
+
await client.presentations.presentationIssue({
|
|
4711
|
+
keyId: "key_id",
|
|
4712
|
+
credentialIds: ["credential_ids"]
|
|
4416
4713
|
});
|
|
4417
4714
|
|
|
4418
4715
|
```
|
|
@@ -4429,7 +4726,7 @@ await client.presentations.presentationImport({
|
|
|
4429
4726
|
<dl>
|
|
4430
4727
|
<dd>
|
|
4431
4728
|
|
|
4432
|
-
**request:** `Truvity.
|
|
4729
|
+
**request:** `Truvity.PresentationIssue`
|
|
4433
4730
|
|
|
4434
4731
|
</dd>
|
|
4435
4732
|
</dl>
|
|
@@ -4449,7 +4746,7 @@ await client.presentations.presentationImport({
|
|
|
4449
4746
|
</dl>
|
|
4450
4747
|
</details>
|
|
4451
4748
|
|
|
4452
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4749
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationSearch</a>({ ...params }) -> Truvity.ListPresentation</code></summary>
|
|
4453
4750
|
<dl>
|
|
4454
4751
|
<dd>
|
|
4455
4752
|
|
|
@@ -4461,11 +4758,7 @@ await client.presentations.presentationImport({
|
|
|
4461
4758
|
<dl>
|
|
4462
4759
|
<dd>
|
|
4463
4760
|
|
|
4464
|
-
|
|
4465
|
-
|
|
4466
|
-
1. [Exporting](#tag/presentations/operation/PresentationExport) an unsigned JSON-LD representation of a Verifiable Presentation.
|
|
4467
|
-
2. [Signing](#tag/keys/operation/PresentationSign) the created unsigned Presentation.
|
|
4468
|
-
3. [Importing](#tag/presentations/operation/PresentationImport) the signed Presentation.
|
|
4761
|
+
Search for Presentations with extended filters capabilities.
|
|
4469
4762
|
</dd>
|
|
4470
4763
|
</dl>
|
|
4471
4764
|
</dd>
|
|
@@ -4480,10 +4773,7 @@ It's a handy call that wraps the following:
|
|
|
4480
4773
|
<dd>
|
|
4481
4774
|
|
|
4482
4775
|
```typescript
|
|
4483
|
-
await client.presentations.
|
|
4484
|
-
keyId: "key_id",
|
|
4485
|
-
credentialIds: ["credential_ids"]
|
|
4486
|
-
});
|
|
4776
|
+
await client.presentations.presentationSearch();
|
|
4487
4777
|
|
|
4488
4778
|
```
|
|
4489
4779
|
</dd>
|
|
@@ -4499,7 +4789,7 @@ await client.presentations.presentationIssue({
|
|
|
4499
4789
|
<dl>
|
|
4500
4790
|
<dd>
|
|
4501
4791
|
|
|
4502
|
-
**request:** `Truvity.
|
|
4792
|
+
**request:** `Truvity.PresentationSearchRequest`
|
|
4503
4793
|
|
|
4504
4794
|
</dd>
|
|
4505
4795
|
</dl>
|
|
@@ -4519,7 +4809,7 @@ await client.presentations.presentationIssue({
|
|
|
4519
4809
|
</dl>
|
|
4520
4810
|
</details>
|
|
4521
4811
|
|
|
4522
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4812
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationUpload</a>({ ...params }) -> Truvity.UploadResponse</code></summary>
|
|
4523
4813
|
<dl>
|
|
4524
4814
|
<dd>
|
|
4525
4815
|
|
|
@@ -4531,7 +4821,7 @@ await client.presentations.presentationIssue({
|
|
|
4531
4821
|
<dl>
|
|
4532
4822
|
<dd>
|
|
4533
4823
|
|
|
4534
|
-
|
|
4824
|
+
The upload Presentation's blob operation.
|
|
4535
4825
|
</dd>
|
|
4536
4826
|
</dl>
|
|
4537
4827
|
</dd>
|
|
@@ -4546,7 +4836,7 @@ Search for Presentations with extended filters capabilities.
|
|
|
4546
4836
|
<dd>
|
|
4547
4837
|
|
|
4548
4838
|
```typescript
|
|
4549
|
-
await client.presentations.
|
|
4839
|
+
await client.presentations.presentationUpload();
|
|
4550
4840
|
|
|
4551
4841
|
```
|
|
4552
4842
|
</dd>
|
|
@@ -4562,7 +4852,7 @@ await client.presentations.presentationSearch();
|
|
|
4562
4852
|
<dl>
|
|
4563
4853
|
<dd>
|
|
4564
4854
|
|
|
4565
|
-
**request:** `Truvity.
|
|
4855
|
+
**request:** `Truvity.PresentationUploadRequest`
|
|
4566
4856
|
|
|
4567
4857
|
</dd>
|
|
4568
4858
|
</dl>
|
|
@@ -4582,7 +4872,7 @@ await client.presentations.presentationSearch();
|
|
|
4582
4872
|
</dl>
|
|
4583
4873
|
</details>
|
|
4584
4874
|
|
|
4585
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4875
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationLatest</a>(id, { ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4586
4876
|
<dl>
|
|
4587
4877
|
<dd>
|
|
4588
4878
|
|
|
@@ -4594,7 +4884,7 @@ await client.presentations.presentationSearch();
|
|
|
4594
4884
|
<dl>
|
|
4595
4885
|
<dd>
|
|
4596
4886
|
|
|
4597
|
-
|
|
4887
|
+
Get the latest version of Presentation.
|
|
4598
4888
|
</dd>
|
|
4599
4889
|
</dl>
|
|
4600
4890
|
</dd>
|
|
@@ -4609,7 +4899,7 @@ The upload Presentation's blob operation.
|
|
|
4609
4899
|
<dd>
|
|
4610
4900
|
|
|
4611
4901
|
```typescript
|
|
4612
|
-
await client.presentations.
|
|
4902
|
+
await client.presentations.presentationLatest("id");
|
|
4613
4903
|
|
|
4614
4904
|
```
|
|
4615
4905
|
</dd>
|
|
@@ -4625,7 +4915,15 @@ await client.presentations.presentationUpload();
|
|
|
4625
4915
|
<dl>
|
|
4626
4916
|
<dd>
|
|
4627
4917
|
|
|
4628
|
-
**
|
|
4918
|
+
**id:** `string` — The ID of the resource.
|
|
4919
|
+
|
|
4920
|
+
</dd>
|
|
4921
|
+
</dl>
|
|
4922
|
+
|
|
4923
|
+
<dl>
|
|
4924
|
+
<dd>
|
|
4925
|
+
|
|
4926
|
+
**request:** `Truvity.PresentationLatestRequest`
|
|
4629
4927
|
|
|
4630
4928
|
</dd>
|
|
4631
4929
|
</dl>
|
|
@@ -4645,7 +4943,7 @@ await client.presentations.presentationUpload();
|
|
|
4645
4943
|
</dl>
|
|
4646
4944
|
</details>
|
|
4647
4945
|
|
|
4648
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
4946
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationDelete</a>(id, { ...params }) -> void</code></summary>
|
|
4649
4947
|
<dl>
|
|
4650
4948
|
<dd>
|
|
4651
4949
|
|
|
@@ -4657,7 +4955,7 @@ await client.presentations.presentationUpload();
|
|
|
4657
4955
|
<dl>
|
|
4658
4956
|
<dd>
|
|
4659
4957
|
|
|
4660
|
-
|
|
4958
|
+
Delete Presentation's resource.
|
|
4661
4959
|
</dd>
|
|
4662
4960
|
</dl>
|
|
4663
4961
|
</dd>
|
|
@@ -4672,7 +4970,9 @@ Get the latest version of Presentation.
|
|
|
4672
4970
|
<dd>
|
|
4673
4971
|
|
|
4674
4972
|
```typescript
|
|
4675
|
-
await client.presentations.
|
|
4973
|
+
await client.presentations.presentationDelete("id", {
|
|
4974
|
+
ifMatch: "If-Match"
|
|
4975
|
+
});
|
|
4676
4976
|
|
|
4677
4977
|
```
|
|
4678
4978
|
</dd>
|
|
@@ -4688,7 +4988,10 @@ await client.presentations.presentationLatest("id");
|
|
|
4688
4988
|
<dl>
|
|
4689
4989
|
<dd>
|
|
4690
4990
|
|
|
4691
|
-
**id:** `string`
|
|
4991
|
+
**id:** `string`
|
|
4992
|
+
|
|
4993
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
4994
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
4692
4995
|
|
|
4693
4996
|
</dd>
|
|
4694
4997
|
</dl>
|
|
@@ -4696,7 +4999,7 @@ await client.presentations.presentationLatest("id");
|
|
|
4696
4999
|
<dl>
|
|
4697
5000
|
<dd>
|
|
4698
5001
|
|
|
4699
|
-
**request:** `Truvity.
|
|
5002
|
+
**request:** `Truvity.PresentationDeleteRequest`
|
|
4700
5003
|
|
|
4701
5004
|
</dd>
|
|
4702
5005
|
</dl>
|
|
@@ -4716,7 +5019,7 @@ await client.presentations.presentationLatest("id");
|
|
|
4716
5019
|
</dl>
|
|
4717
5020
|
</details>
|
|
4718
5021
|
|
|
4719
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
5022
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationUpdateAnnotations</a>(id, { ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4720
5023
|
<dl>
|
|
4721
5024
|
<dd>
|
|
4722
5025
|
|
|
@@ -4728,7 +5031,7 @@ await client.presentations.presentationLatest("id");
|
|
|
4728
5031
|
<dl>
|
|
4729
5032
|
<dd>
|
|
4730
5033
|
|
|
4731
|
-
|
|
5034
|
+
Update annotations of Presentation's resource.
|
|
4732
5035
|
</dd>
|
|
4733
5036
|
</dl>
|
|
4734
5037
|
</dd>
|
|
@@ -4743,8 +5046,11 @@ Delete Presentation's resource.
|
|
|
4743
5046
|
<dd>
|
|
4744
5047
|
|
|
4745
5048
|
```typescript
|
|
4746
|
-
await client.presentations.
|
|
4747
|
-
ifMatch: "If-Match"
|
|
5049
|
+
await client.presentations.presentationUpdateAnnotations("id", {
|
|
5050
|
+
ifMatch: "If-Match",
|
|
5051
|
+
annotations: {
|
|
5052
|
+
"key": "value"
|
|
5053
|
+
}
|
|
4748
5054
|
});
|
|
4749
5055
|
|
|
4750
5056
|
```
|
|
@@ -4772,7 +5078,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4772
5078
|
<dl>
|
|
4773
5079
|
<dd>
|
|
4774
5080
|
|
|
4775
|
-
**request:** `Truvity.
|
|
5081
|
+
**request:** `Truvity.PresentationUpdateAnnotationsInput`
|
|
4776
5082
|
|
|
4777
5083
|
</dd>
|
|
4778
5084
|
</dl>
|
|
@@ -4792,7 +5098,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4792
5098
|
</dl>
|
|
4793
5099
|
</details>
|
|
4794
5100
|
|
|
4795
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
5101
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationUpdateLabels</a>(id, { ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4796
5102
|
<dl>
|
|
4797
5103
|
<dd>
|
|
4798
5104
|
|
|
@@ -4804,7 +5110,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4804
5110
|
<dl>
|
|
4805
5111
|
<dd>
|
|
4806
5112
|
|
|
4807
|
-
|
|
5113
|
+
Update labels of Presentation's resource.
|
|
4808
5114
|
</dd>
|
|
4809
5115
|
</dl>
|
|
4810
5116
|
</dd>
|
|
@@ -4819,8 +5125,11 @@ Restore Presentation's resource.
|
|
|
4819
5125
|
<dd>
|
|
4820
5126
|
|
|
4821
5127
|
```typescript
|
|
4822
|
-
await client.presentations.
|
|
4823
|
-
ifMatch: "If-Match"
|
|
5128
|
+
await client.presentations.presentationUpdateLabels("id", {
|
|
5129
|
+
ifMatch: "If-Match",
|
|
5130
|
+
labels: {
|
|
5131
|
+
"key": "value"
|
|
5132
|
+
}
|
|
4824
5133
|
});
|
|
4825
5134
|
|
|
4826
5135
|
```
|
|
@@ -4848,7 +5157,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4848
5157
|
<dl>
|
|
4849
5158
|
<dd>
|
|
4850
5159
|
|
|
4851
|
-
**request:** `Truvity.
|
|
5160
|
+
**request:** `Truvity.PresentationUpdateLabelsInput`
|
|
4852
5161
|
|
|
4853
5162
|
</dd>
|
|
4854
5163
|
</dl>
|
|
@@ -4868,7 +5177,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4868
5177
|
</dl>
|
|
4869
5178
|
</details>
|
|
4870
5179
|
|
|
4871
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
5180
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationRestore</a>(id, { ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
4872
5181
|
<dl>
|
|
4873
5182
|
<dd>
|
|
4874
5183
|
|
|
@@ -4880,7 +5189,7 @@ according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
|
4880
5189
|
<dl>
|
|
4881
5190
|
<dd>
|
|
4882
5191
|
|
|
4883
|
-
|
|
5192
|
+
Restore Presentation's resource.
|
|
4884
5193
|
</dd>
|
|
4885
5194
|
</dl>
|
|
4886
5195
|
</dd>
|
|
@@ -4895,7 +5204,9 @@ History of the Presentation's resources.
|
|
|
4895
5204
|
<dd>
|
|
4896
5205
|
|
|
4897
5206
|
```typescript
|
|
4898
|
-
await client.presentations.
|
|
5207
|
+
await client.presentations.presentationRestore("id", {
|
|
5208
|
+
ifMatch: "If-Match"
|
|
5209
|
+
});
|
|
4899
5210
|
|
|
4900
5211
|
```
|
|
4901
5212
|
</dd>
|
|
@@ -4911,7 +5222,10 @@ await client.presentations.presentationHistory("id");
|
|
|
4911
5222
|
<dl>
|
|
4912
5223
|
<dd>
|
|
4913
5224
|
|
|
4914
|
-
**id:** `string`
|
|
5225
|
+
**id:** `string`
|
|
5226
|
+
|
|
5227
|
+
The primary and unique identifier of the resource (inside tenant)
|
|
5228
|
+
according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
|
|
4915
5229
|
|
|
4916
5230
|
</dd>
|
|
4917
5231
|
</dl>
|
|
@@ -4919,7 +5233,7 @@ await client.presentations.presentationHistory("id");
|
|
|
4919
5233
|
<dl>
|
|
4920
5234
|
<dd>
|
|
4921
5235
|
|
|
4922
|
-
**request:** `Truvity.
|
|
5236
|
+
**request:** `Truvity.PresentationRestoreRequest`
|
|
4923
5237
|
|
|
4924
5238
|
</dd>
|
|
4925
5239
|
</dl>
|
|
@@ -4939,7 +5253,7 @@ await client.presentations.presentationHistory("id");
|
|
|
4939
5253
|
</dl>
|
|
4940
5254
|
</details>
|
|
4941
5255
|
|
|
4942
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
5256
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationHistory</a>(id, { ...params }) -> Truvity.ListPresentation</code></summary>
|
|
4943
5257
|
<dl>
|
|
4944
5258
|
<dd>
|
|
4945
5259
|
|
|
@@ -4951,7 +5265,7 @@ await client.presentations.presentationHistory("id");
|
|
|
4951
5265
|
<dl>
|
|
4952
5266
|
<dd>
|
|
4953
5267
|
|
|
4954
|
-
|
|
5268
|
+
History of the Presentation's resources.
|
|
4955
5269
|
</dd>
|
|
4956
5270
|
</dl>
|
|
4957
5271
|
</dd>
|
|
@@ -4966,7 +5280,7 @@ Read the specific version of the Presentation's resource.
|
|
|
4966
5280
|
<dd>
|
|
4967
5281
|
|
|
4968
5282
|
```typescript
|
|
4969
|
-
await client.presentations.
|
|
5283
|
+
await client.presentations.presentationHistory("id");
|
|
4970
5284
|
|
|
4971
5285
|
```
|
|
4972
5286
|
</dd>
|
|
@@ -4990,15 +5304,7 @@ await client.presentations.presentationRevision("id", 1);
|
|
|
4990
5304
|
<dl>
|
|
4991
5305
|
<dd>
|
|
4992
5306
|
|
|
4993
|
-
**
|
|
4994
|
-
|
|
4995
|
-
</dd>
|
|
4996
|
-
</dl>
|
|
4997
|
-
|
|
4998
|
-
<dl>
|
|
4999
|
-
<dd>
|
|
5000
|
-
|
|
5001
|
-
**request:** `Truvity.PresentationRevisionRequest`
|
|
5307
|
+
**request:** `Truvity.PresentationHistoryRequest`
|
|
5002
5308
|
|
|
5003
5309
|
</dd>
|
|
5004
5310
|
</dl>
|
|
@@ -5018,7 +5324,7 @@ await client.presentations.presentationRevision("id", 1);
|
|
|
5018
5324
|
</dl>
|
|
5019
5325
|
</details>
|
|
5020
5326
|
|
|
5021
|
-
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">
|
|
5327
|
+
<details><summary><code>client.presentations.<a href="/src/api/resources/presentations/client/Client.ts">presentationRevision</a>(id, revision, { ...params }) -> Truvity.ResourcePresentation</code></summary>
|
|
5022
5328
|
<dl>
|
|
5023
5329
|
<dd>
|
|
5024
5330
|
|
|
@@ -5030,7 +5336,7 @@ await client.presentations.presentationRevision("id", 1);
|
|
|
5030
5336
|
<dl>
|
|
5031
5337
|
<dd>
|
|
5032
5338
|
|
|
5033
|
-
|
|
5339
|
+
Read the specific version of the Presentation's resource.
|
|
5034
5340
|
</dd>
|
|
5035
5341
|
</dl>
|
|
5036
5342
|
</dd>
|
|
@@ -5045,9 +5351,7 @@ Download of Presentation's blob.
|
|
|
5045
5351
|
<dd>
|
|
5046
5352
|
|
|
5047
5353
|
```typescript
|
|
5048
|
-
await client.presentations.
|
|
5049
|
-
ifNoneMatch: "string"
|
|
5050
|
-
});
|
|
5354
|
+
await client.presentations.presentationRevision("id", 1);
|
|
5051
5355
|
|
|
5052
5356
|
```
|
|
5053
5357
|
</dd>
|
|
@@ -5079,7 +5383,7 @@ await client.presentations.presentationDownload("string", 1, {
|
|
|
5079
5383
|
<dl>
|
|
5080
5384
|
<dd>
|
|
5081
5385
|
|
|
5082
|
-
**request:** `Truvity.
|
|
5386
|
+
**request:** `Truvity.PresentationRevisionRequest`
|
|
5083
5387
|
|
|
5084
5388
|
</dd>
|
|
5085
5389
|
</dl>
|
|
@@ -5192,7 +5496,7 @@ Create a request to support.
|
|
|
5192
5496
|
```typescript
|
|
5193
5497
|
await client.gdpr.supportRequestCreate({
|
|
5194
5498
|
message: "message",
|
|
5195
|
-
type:
|
|
5499
|
+
type: "DATA_DUMP"
|
|
5196
5500
|
});
|
|
5197
5501
|
|
|
5198
5502
|
```
|