@twin.org/identity-models 0.0.1-next.4 → 0.0.1-next.40

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -22,15 +22,21 @@ Create the profile properties for an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -44,42 +50,36 @@ Nothing.
 
 ### get()
 
-> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<`object`\>
+> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 The items identity and the properties.
 
-##### identity
-
-> **identity**: `string`
-
-##### publicProfile?
-
-> `optional` **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile?
-
-> `optional` **privateProfile**: `Partial`\<`U`\>
-
 ***
 
 ### getPublic()
@@ -90,11 +90,15 @@ Get the public profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to perform the profile operation on.
 
-• **propertyNames?**: keyof `T`[]
+##### propertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
@@ -114,15 +118,21 @@ Update the profile properties of an identity.
 
 #### Parameters
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -142,7 +152,9 @@ Delete the profile for an identity.
 
 #### Parameters
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the profile operation on.
 
@@ -156,42 +168,38 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 
 #### Parameters
 
-• **publicFilters?**: `object`[]
+##### publicFilters?
+
+`object`[]
 
 The filters to apply to the identities public profiles.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor for paged requests.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of items in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 The list of items and cursor for paging.
-
-##### items
-
-> **items**: `object`[]
-
-The identities.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -22,15 +22,21 @@ Create the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the profile to create.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
@@ -44,38 +50,36 @@ Nothing.
 
 ### get()
 
-> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<`object`\>
+> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the item to get.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 The identity profile, will only return private data if you have correct permissions.
 
-##### publicProfile
-
-> **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile
-
-> **privateProfile**: `Partial`\<`U`\>
-
 ***
 
 ### update()
@@ -86,15 +90,21 @@ Update the profile properties of an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to update.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
@@ -114,7 +124,9 @@ Delete the profile for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to delete.
 
@@ -128,50 +140,50 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 
 #### Parameters
 
-• **publicFilters?**: `object`[]
+##### publicFilters?
+
+`object`[]
 
 The filters to apply to the identities public profiles.
 
-• **privateFilters?**: `object`[]
+##### privateFilters?
+
+`object`[]
 
 The filters to apply to the identities private profiles.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor for paged requests.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of items in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 The list of items and cursor for paging.
-
-##### items
-
-> **items**: `object`[]
-
-The identity profiles.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileGetPublicResponse.md

@@ -10,9 +10,9 @@ Response to get an identity public profile.
 
 The response headers.
 
-#### Content-Type
+#### content-type
 
-> **Content-Type**: `"application/ld+json"`
+> **content-type**: `"application/ld+json"`
 
 ***
 

package/docs/reference/interfaces/IIdentityProofCreateRequest.md

@@ -0,0 +1,43 @@
+# 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.
+
+#### proofType
+
+> **proofType**: `ProofTypes`
+
+The type of proof to create.
+
+#### document
+
+> **document**: `IJsonLdNodeObject`
+
+The document to create the proof for.

package/docs/reference/interfaces/IIdentityProofCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityProofCreateResponse
+
+Response to creating a proof.
+
+## Properties
+
+### body
+
+> **body**: `IProof`
+
+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.
+
+#### document
+
+> **document**: `IJsonLdNodeObject`
+
+The document to verify the proof for.
+
+#### proof
+
+> **proof**: `IProof`
+
+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 get the document for.
+The identity to resolve.

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityResolverComponent
+
+Interface describing a contract which provides identity operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### identityResolve()
+
+> **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -0,0 +1,33 @@
+# Interface: IIdentityResolverConnector
+
+Interface describing an identity connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### resolveDocument()
+
+> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
+
+Resolve a document from its id.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.

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.