@twin.org/identity-models 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IIdentityConnector.md

@@ -8,7 +8,7 @@ Interface describing an identity connector.
 
 ## Methods
 
-### createDocument()
+### createDocument() {#createdocument}
 
 > **createDocument**(`controller`): `Promise`\<`IDidDocument`\>
 
@@ -30,7 +30,7 @@ The created document.
 
 ***
 
-### removeDocument()
+### removeDocument() {#removedocument}
 
 > **removeDocument**(`controller`, `documentId`): `Promise`\<`void`\>
 
@@ -54,11 +54,11 @@ The id of the document to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the document has been removed.
 
 ***
 
-### addVerificationMethod()
+### addVerificationMethod() {#addverificationmethod}
 
 > **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
@@ -106,7 +106,7 @@ NotSupportedError if the platform does not support multiple keys.
 
 ***
 
-### removeVerificationMethod()
+### removeVerificationMethod() {#removeverificationmethod}
 
 > **removeVerificationMethod**(`controller`, `verificationMethodId`): `Promise`\<`void`\>
 
@@ -130,7 +130,7 @@ The id of the verification method.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the verification method has been removed.
 
 #### Throws
 
@@ -142,7 +142,7 @@ NotSupportedError if the platform does not support multiple revocable keys.
 
 ***
 
-### addService()
+### addService() {#addservice}
 
 > **addService**(`controller`, `documentId`, `serviceId`, `serviceType`, `serviceEndpoint`): `Promise`\<`IDidService`\>
 
@@ -170,15 +170,15 @@ The id of the service.
 
 ##### serviceType
 
-The type of the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The type of the service.
 
 ##### serviceEndpoint
 
-The endpoint for the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The endpoint for the service.
 
 #### Returns
 
@@ -192,7 +192,7 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### removeService()
+### removeService() {#removeservice}
 
 > **removeService**(`controller`, `serviceId`): `Promise`\<`void`\>
 
@@ -216,7 +216,93 @@ The id of the service.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the service has been removed.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### addAlsoKnownAs() {#addalsoknownas}
+
+> **addAlsoKnownAs**(`controller`, `documentId`, `alias`): `Promise`\<`void`\>
+
+Add an alias to the alsoKnownAs property on the document.
+If the alias is already present the operation is a no-op.
+
+#### Parameters
+
+##### controller
+
+`string`
+
+The controller of the identity who can make changes.
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to add. Must be a Url or Urn (typically another DID).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the alias has been added.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+***
+
+### removeAlsoKnownAs() {#removealsoknownas}
+
+> **removeAlsoKnownAs**(`controller`, `documentId`, `alias`): `Promise`\<`void`\>
+
+Remove an alias from the alsoKnownAs property on the document.
+If the alias is not present the operation is a no-op.
+
+#### Parameters
+
+##### controller
+
+`string`
+
+The controller of the identity who can make changes.
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to remove. Must be a Url or Urn.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the alias has been removed.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
 
 #### Throws
 
@@ -224,7 +310,7 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### createVerifiableCredential()
+### createVerifiableCredential() {#createverifiablecredential}
 
 > **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `options?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
@@ -246,9 +332,9 @@ The verification method id to use.
 
 ##### id
 
-The id of the credential.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the credential.
 
 ##### subject
 
@@ -272,6 +358,18 @@ The bitmap revocation index of the credential, if undefined will not have revoca
 
 The date the verifiable credential is valid until.
 
+###### jwtHeaderFields?
+
+\{\[`id`: `string`\]: `string`; \}
+
+Additional fields to include in the JWT header when creating the verifiable credential in jwt format.
+
+###### jwtPayloadFields?
+
+\{\[`id`: `string`\]: `string`; \}
+
+Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
+
 #### Returns
 
 `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
@@ -284,17 +382,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### checkVerifiableCredential()
+### checkVerifiableCredential() {#checkverifiablecredential}
 
-> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
+> **checkVerifiableCredential**(`credential`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
 
 Check a verifiable credential is valid.
 
 #### Parameters
 
-##### credentialJwt
+##### credential
 
-`string`
+`string` \| `IDidVerifiableCredential`
 
 The credential to verify.
 
@@ -306,7 +404,7 @@ The credential stored in the jwt and the revocation status.
 
 ***
 
-### revokeVerifiableCredentials()
+### revokeVerifiableCredentials() {#revokeverifiablecredentials}
 
 > **revokeVerifiableCredentials**(`controller`, `issuerDocumentId`, `credentialIndices`): `Promise`\<`void`\>
 
@@ -336,11 +434,11 @@ The revocation bitmap index or indices to revoke.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the credentials have been revoked.
 
 ***
 
-### unrevokeVerifiableCredentials()
+### unrevokeVerifiableCredentials() {#unrevokeverifiablecredentials}
 
 > **unrevokeVerifiableCredentials**(`controller`, `issuerDocumentId`, `credentialIndices`): `Promise`\<`void`\>
 
@@ -364,19 +462,19 @@ The id of the document to update the revocation list for.
 
 `number`[]
 
-The revocation bitmap index or indices to un revoke.
+The revocation bitmap index or indices to unrevoke.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the credentials have been unrevoked.
 
 ***
 
-### createVerifiablePresentation()
+### createVerifiablePresentation() {#createverifiablepresentation}
 
-> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `options?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -396,21 +494,21 @@ The method to associate with the presentation.
 
 ##### presentationId
 
-The id of the presentation.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the presentation.
 
 ##### contexts
 
-The contexts for the data stored in the verifiable credential.
+`IJsonLdContextDefinitionRoot` \| `undefined`
 
-`IJsonLdContextDefinitionRoot` | `undefined`
+The contexts for the data stored in the verifiable credential.
 
 ##### types
 
-The types for the data stored in the verifiable credential.
+`string` \| `string`[] \| `undefined`
 
-`string` | `string`[] | `undefined`
+The types for the data stored in the verifiable credential.
 
 ##### verifiableCredentials
 
@@ -418,11 +516,27 @@ The types for the data stored in the verifiable credential.
 
 The credentials to use for creating the presentation in jwt format.
 
-##### expiresInMinutes?
+##### options?
 
-`number`
+Additional options for creating the verifiable presentation.
+
+###### expirationDate?
+
+`Date`
+
+The date the verifiable presentation is valid until.
 
-The time in minutes for the presentation to expire.
+###### jwtHeaderFields?
+
+\{\[`id`: `string`\]: `string`; \}
+
+Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+
+###### jwtPayloadFields?
+
+\{\[`id`: `string`\]: `string`; \}
+
+Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
 
 #### Returns
 
@@ -436,17 +550,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### checkVerifiablePresentation()
+### checkVerifiablePresentation() {#checkverifiablepresentation}
 
-> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
+> **checkVerifiablePresentation**(`presentation`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
 
 Check a verifiable presentation is valid.
 
 #### Parameters
 
-##### presentationJwt
+##### presentation
 
-`string`
+`string` \| `IDidVerifiablePresentation`
 
 The presentation to verify.
 
@@ -458,7 +572,7 @@ The presentation stored in the jwt and the revocation status.
 
 ***
 
-### createProof()
+### createProof() {#createproof}
 
 > **createProof**(`controller`, `verificationMethodId`, `proofType`, `unsecureDocument`): `Promise`\<`IProof`\>
 
@@ -498,7 +612,7 @@ The proof.
 
 ***
 
-### verifyProof()
+### verifyProof() {#verifyproof}
 
 > **verifyProof**(`document`, `proof`): `Promise`\<`boolean`\>
 

package/docs/reference/interfaces/IIdentityCreateRequest.md

@@ -4,14 +4,14 @@ Request to create an identity.
 
 ## Properties
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `object`
+> `optional` **body?**: `object`
 
 The data for the request.
 
 #### namespace?
 
-> `optional` **namespace**: `string`
+> `optional` **namespace?**: `string`
 
 The optional namespace to create the identity in.

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`\>
 
@@ -48,11 +48,11 @@ The identity to perform the profile operation on.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been created.
 
 ***
 
-### 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`\>
 
@@ -144,11 +144,11 @@ The identity to perform the profile operation on.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been updated.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`identity?`): `Promise`\<`void`\>
 
@@ -166,11 +166,11 @@ The identity to perform the profile operation on.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been removed.
 
 ***
 
-### 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`\>
 
@@ -48,11 +48,11 @@ The private profile data as JSON-LD.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been created.
 
 ***
 
-### 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`\>
 
@@ -116,11 +116,11 @@ The private profile data as JSON-LD.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been updated.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`identity`): `Promise`\<`void`\>
 
@@ -138,11 +138,11 @@ The identity to delete.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been removed.
 
 ***
 
-### 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.