@twin.org/identity-models 0.0.1-next.22 → 0.0.1-next.24

package/docs/reference/interfaces/IIdentityProofCreateRequest.md

@@ -0,0 +1,37 @@
+# Interface: IIdentityProofCreateRequest
+
+Request to create a proof.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the proof for.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method id to use.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### bytes
+
+> **bytes**: `string`
+
+The data bytes base64 encoded.

package/docs/reference/interfaces/IIdentityProofCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityProofCreateResponse
+
+Response to creating a proof.
+
+## Properties
+
+### body
+
+> **body**: `IDidProof`
+
+The response payload.

package/docs/reference/interfaces/IIdentityProofVerifyRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProofVerifyRequest
+
+Request to verify a proof.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### bytes
+
+> **bytes**: `string`
+
+The data bytes base64 encoded.
+
+#### proof
+
+> **proof**: `IDidProof`
+
+The proof to verify.

package/docs/reference/interfaces/IIdentityProofVerifyResponse.md

@@ -0,0 +1,15 @@
+# Interface: IIdentityProofVerifyResponse
+
+Response to verifying a proof.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### verified
+
+> **verified**: `boolean`

package/docs/reference/interfaces/IIdentityResolveRequest.md

@@ -10,8 +10,8 @@ Resolve an identity.
 
 The path parameters.
 
-#### id
+#### identity
 
-> **id**: `string`
+> **identity**: `string`
 
 The identity to resolve.

package/docs/reference/interfaces/IIdentityServiceCreateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IIdentityServiceCreateRequest
+
+Request to create a service.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the service for.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### serviceId
+
+> **serviceId**: `string`
+
+The id of the service.
+
+#### type
+
+> **type**: `string` \| `string`[]
+
+The type of the service.
+
+#### endpoint
+
+> **endpoint**: `string` \| `string`[]
+
+The endpoint for the service.

package/docs/reference/interfaces/IIdentityServiceCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityServiceCreateResponse
+
+Response to creating a service.
+
+## Properties
+
+### body
+
+> **body**: `IDidService`
+
+The response payload.

package/docs/reference/interfaces/IIdentityServiceRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityServiceRemoveRequest
+
+Request to remove a service.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove the service from.
+
+#### serviceId
+
+> **serviceId**: `string`
+
+The service to remove.

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -0,0 +1,49 @@
+# Interface: IIdentityVerifiableCredentialCreateRequest
+
+Request to create a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification credential for.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method id to use.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### credentialId?
+
+> `optional` **credentialId**: `string`
+
+The id of the credential.
+
+#### subject
+
+> **subject**: `IJsonLdNodeObject`
+
+The credential subject to store in the verifiable credential.
+
+#### revocationIndex?
+
+> `optional` **revocationIndex**: `number`
+
+The bitmap revocation index of the credential, if undefined will not have revocation status.

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialCreateResponse
+
+Response to creating a verifiable credential.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### verifiableCredential
+
+> **verifiableCredential**: `IDidVerifiableCredential`
+
+The verifiable credential that was created.
+
+#### jwt
+
+> **jwt**: `string`
+
+The JWT token for the verifiable credential.

package/docs/reference/interfaces/IIdentityVerifiableCredentialRevokeRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialRevokeRequest
+
+Request to revoke a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to revoke the verification credential for.
+
+#### revocationIndex
+
+> **revocationIndex**: `number`
+
+The revocation index to revoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialUnrevokeRequest
+
+Request to unrevoke a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to unrevoke the verification credential for.
+
+#### revocationIndex
+
+> **revocationIndex**: `number`
+
+The revocation index to unrevoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityVerifiableCredentialVerifyRequest
+
+Request to verify a verifiable credential.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The path parameters.
+
+#### jwt
+
+> **jwt**: `string`
+
+The jwt to verify.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialVerifyResponse
+
+Response to verifying a verifiable credential.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### revoked
+
+> **revoked**: `boolean`
+
+Has the credential been revoked.
+
+#### verifiableCredential?
+
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`
+
+The verifiable credential that was verified.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateRequest.md

@@ -0,0 +1,61 @@
+# Interface: IIdentityVerifiablePresentationCreateRequest
+
+Request to create a verifiable presentation.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification presentation for.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method id to use.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### presentationId?
+
+> `optional` **presentationId**: `string`
+
+The id of the presentation.
+
+#### contexts?
+
+> `optional` **contexts**: `IJsonLdContextDefinitionRoot`
+
+The context to use for the presentation.
+
+#### types?
+
+> `optional` **types**: `string` \| `string`[]
+
+The types of the presentation.
+
+#### verifiableCredentials
+
+> **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
+
+The verifiable credentials to include in the presentation.
+
+#### expiresInMinutes?
+
+> `optional` **expiresInMinutes**: `number`
+
+The expiration time for the presentation.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiablePresentationCreateResponse
+
+Response to creating a verifiable presentation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### verifiablePresentation
+
+> **verifiablePresentation**: `IDidVerifiablePresentation`
+
+The verifiable presentation that was created.
+
+#### jwt
+
+> **jwt**: `string`
+
+The JWT token for the verifiable presentation.

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityVerifiablePresentationVerifyRequest
+
+Request to verify a verifiable presentation.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The path parameters.
+
+#### jwt
+
+> **jwt**: `string`
+
+The jwt to verify.

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyResponse.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityVerifiablePresentationVerifyResponse
+
+Response to verifying a verifiable presentation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### revoked
+
+> **revoked**: `boolean`
+
+Has the presentation been revoked.
+
+#### verifiablePresentation?
+
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
+
+The verifiable presentation that was verified.
+
+#### issuers?
+
+> `optional` **issuers**: `IDidDocument`[]
+
+The issuers of the presentation.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateRequest.md

@@ -0,0 +1,37 @@
+# Interface: IIdentityVerificationMethodCreateRequest
+
+Request to create a verification method.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification method for.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### verificationMethodType
+
+> **verificationMethodType**: `DidVerificationMethodType`
+
+The type of the verification method to create.
+
+#### verificationMethodId?
+
+> `optional` **verificationMethodId**: `string`
+
+The optional id for the verification method, will be allocated if not supplied.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityVerificationMethodCreateResponse
+
+Response to creating a verification method.
+
+## Properties
+
+### body
+
+> **body**: `IDidDocumentVerificationMethod`
+
+The response payload.

package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerificationMethodRemoveRequest
+
+Request to remove a verification method.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove the verification method from.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method to remove.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.22",
+	"version": "0.0.1-next.24",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",