@twin.org/identity-models 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/interfaces/IIdentityCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating an identity.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidDocument`
 

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -18,7 +18,7 @@ Interface describing a contract which provides profile operations.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
@@ -52,7 +52,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
@@ -86,7 +86,7 @@ The items identity and the properties.
 
 ***
 
-### getPublic()
+### getPublic() {#getpublic}
 
 > **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
 
@@ -114,7 +114,7 @@ The items properties.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
@@ -148,7 +148,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`identity?`): `Promise`\<`void`\>
 
@@ -170,7 +170,7 @@ Nothing.
 
 ***
 
-### list()
+### list() {#list}
 
 > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -18,7 +18,7 @@ Interface describing a contract which provides profile operations.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
@@ -52,7 +52,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`identity`, `publicPropertyNames?`, `privatePropertyNames?`): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
@@ -86,7 +86,7 @@ The identity profile, will only return private data if you have correct permissi
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
@@ -120,7 +120,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`identity`): `Promise`\<`void`\>
 
@@ -142,7 +142,7 @@ Nothing.
 
 ***
 
-### list()
+### list() {#list}
 
 > **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IIdentityProfileCreateRequest.md

@@ -4,7 +4,7 @@ Request to create an identity profile.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -12,12 +12,12 @@ The data for the request.
 
 #### publicProfile?
 
-> `optional` **publicProfile**: `IJsonLdDocument`
+> `optional` **publicProfile?**: `IJsonLdDocument`
 
 The public profile data.
 
 #### privateProfile?
 
-> `optional` **privateProfile**: `IJsonLdDocument`
+> `optional` **privateProfile?**: `IJsonLdDocument`
 
 The private profile data.

package/docs/reference/interfaces/IIdentityProfileGetPublicRequest.md

@@ -4,7 +4,7 @@ Get the public profile for an identity.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,14 +18,14 @@ The identity to get the profile for.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### propertyNames?
 
-> `optional` **propertyNames**: `string`
+> `optional` **propertyNames?**: `string`
 
 The properties to get for the public profile, defaults to all, should be a comma separated list.

package/docs/reference/interfaces/IIdentityProfileGetPublicResponse.md

@@ -4,7 +4,7 @@ Response to get an identity public profile.
 
 ## Properties
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -16,7 +16,7 @@ The response headers.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `Partial`\<`IJsonLdDocument`\>
 

package/docs/reference/interfaces/IIdentityProfileGetRequest.md

@@ -4,20 +4,20 @@ Get the profile for an identity.
 
 ## Properties
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### publicPropertyNames?
 
-> `optional` **publicPropertyNames**: `string`
+> `optional` **publicPropertyNames?**: `string`
 
 The public properties to get for the profile, defaults to all, should be a comma separated list.
 
 #### privatePropertyNames?
 
-> `optional` **privatePropertyNames**: `string`
+> `optional` **privatePropertyNames?**: `string`
 
 The private properties to get for the profile, defaults to all, should be a comma separated list.

package/docs/reference/interfaces/IIdentityProfileGetResponse.md

@@ -4,7 +4,7 @@ Response to get an identity details.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,12 +18,12 @@ The identity of the profile, this is the authenticated user identity.
 
 #### publicProfile?
 
-> `optional` **publicProfile**: `Partial`\<`IJsonLdDocument`\>
+> `optional` **publicProfile?**: `Partial`\<`IJsonLdDocument`\>
 
 The public profile data.
 
 #### privateProfile?
 
-> `optional` **privateProfile**: `Partial`\<`IJsonLdDocument`\>
+> `optional` **privateProfile?**: `Partial`\<`IJsonLdDocument`\>
 
 The private profile data.

package/docs/reference/interfaces/IIdentityProfileListRequest.md

@@ -4,32 +4,32 @@ Request to get a list of identities.
 
 ## Properties
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### publicFilters?
 
-> `optional` **publicFilters**: `string`
+> `optional` **publicFilters?**: `string`
 
 The public filters to apply to the list, comma separated list with color between key and value for each pair e.g. prop1:value1,prop2:value2.
 
 #### publicPropertyNames?
 
-> `optional` **publicPropertyNames**: `string`
+> `optional` **publicPropertyNames?**: `string`
 
 The public properties to get for the profile, defaults to all, should be a comma separated list.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor for paged requests.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Number of items to return.

package/docs/reference/interfaces/IIdentityProfileListResponse.md

@@ -4,7 +4,7 @@ Response to get a list of identities.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,6 +18,6 @@ The identities.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileUpdateRequest.md

@@ -4,7 +4,7 @@ Request to update an identity profile.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -12,12 +12,12 @@ The data for the request.
 
 #### publicProfile?
 
-> `optional` **publicProfile**: `IJsonLdDocument`
+> `optional` **publicProfile?**: `IJsonLdDocument`
 
 The public profile data.
 
 #### privateProfile?
 
-> `optional` **privateProfile**: `IJsonLdDocument`
+> `optional` **privateProfile?**: `IJsonLdDocument`
 
 The private profile data.

package/docs/reference/interfaces/IIdentityProofCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a proof.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityProofCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IProof`
 

package/docs/reference/interfaces/IIdentityProofVerifyRequest.md

@@ -4,7 +4,7 @@ Request to verify a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityProofVerifyResponse.md

@@ -4,7 +4,7 @@ Response to verifying a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove an identity.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityResolveRequest.md

@@ -4,7 +4,7 @@ Resolve an identity.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityResolveResponse.md

@@ -4,7 +4,7 @@ Response to resolving an identity.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidDocument`
 

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -8,7 +8,7 @@ Interface describing a contract which provides identity operations.
 
 ## Methods
 
-### identityResolve()
+### identityResolve() {#identityresolve}
 
 > **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -8,7 +8,7 @@ Interface describing an identity connector.
 
 ## Methods
 
-### resolveDocument()
+### resolveDocument() {#resolvedocument}
 
 > **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/interfaces/IIdentityServiceCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a service.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The identity to create the service for.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityServiceCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a service.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidService`
 

package/docs/reference/interfaces/IIdentityServiceRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove a service.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -32,7 +32,7 @@ The data for the request.
 
 #### credentialId?
 
-> `optional` **credentialId**: `string`
+> `optional` **credentialId?**: `string`
 
 The id of the credential.
 
@@ -44,12 +44,32 @@ The credential subject to store in the verifiable credential.
 
 #### revocationIndex?
 
-> `optional` **revocationIndex**: `number`
+> `optional` **revocationIndex?**: `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
 #### expirationDate?
 
-> `optional` **expirationDate**: `string`
+> `optional` **expirationDate?**: `string`
 
 The date the verifiable credential is valid until.
+
+#### jwtHeaderFields?
+
+> `optional` **jwtHeaderFields?**: `object`
+
+Additional fields to include in the JWT when creating the verifiable credential in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`
+
+#### jwtPayloadFields?
+
+> `optional` **jwtPayloadFields?**: `object`
+
+Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a verifiable credential.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialRevokeRequest.md

@@ -4,7 +4,7 @@ Request to revoke a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,6 +18,6 @@ The identity to revoke the verification credential for.
 
 #### revocationIndex
 
-> **revocationIndex**: `number`
+> **revocationIndex**: `string`
 
 The revocation index to revoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md

@@ -4,7 +4,7 @@ Request to unrevoke a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,6 +18,6 @@ The identity to unrevoke the verification credential for.
 
 #### revocationIndex
 
-> **revocationIndex**: `number`
+> **revocationIndex**: `string`
 
 The revocation index to unrevoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyDocumentRequest.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityVerifiableCredentialVerifyDocumentRequest
+
+Request to verify a verifiable credential.
+
+## Properties
+
+### body {#body}
+
+> **body**: `IDidVerifiableCredential`
+
+The body parameters.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyRequest.md

@@ -4,7 +4,7 @@ Request to verify a verifiable credential.
 
 ## Properties
 
-### query
+### query {#query}
 
 > **query**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyResponse.md

@@ -4,7 +4,7 @@ Response to verifying a verifiable credential.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,6 +18,6 @@ Has the credential been revoked.
 
 #### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`
+> `optional` **verifiableCredential?**: `IDidVerifiableCredential`
 
 The verifiable credential that was verified.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a verifiable presentation.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -32,19 +32,19 @@ The data for the request.
 
 #### presentationId?
 
-> `optional` **presentationId**: `string`
+> `optional` **presentationId?**: `string`
 
 The id of the presentation.
 
 #### contexts?
 
-> `optional` **contexts**: `IJsonLdContextDefinitionRoot`
+> `optional` **contexts?**: `IJsonLdContextDefinitionRoot`
 
 The context to use for the presentation.
 
 #### types?
 
-> `optional` **types**: `string` \| `string`[]
+> `optional` **types?**: `string` \| `string`[]
 
 The types of the presentation.
 
@@ -54,8 +54,28 @@ The types of the presentation.
 
 The verifiable credentials to include in the presentation.
 
-#### expiresInMinutes?
+#### expirationDate?
 
-> `optional` **expiresInMinutes**: `number`
+> `optional` **expirationDate?**: `string`
 
-The expiration time for the presentation.
+The expiration date/time for the presentation.
+
+#### jwtHeaderFields?
+
+> `optional` **jwtHeaderFields?**: `object`
+
+Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`
+
+#### jwtPayloadFields?
+
+> `optional` **jwtPayloadFields?**: `object`
+
+Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a verifiable presentation.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`