Merge pull request #541 from energywebfoundation/task/ICL-274-did-reg…

…istry-module-docs-grooming

docs(did-registry): improve DID registry service documentation

docs/api/interfaces/modules_did_registry.CreatePublicClaimOptions.md

@@ -0,0 +1,22 @@
+# Interface: CreatePublicClaimOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).CreatePublicClaimOptions
+
+## Table of contents
+
+### Properties
+
+- [data](modules_did_registry.CreatePublicClaimOptions.md#data)
+- [subject](modules_did_registry.CreatePublicClaimOptions.md#subject)
+
+## Properties
+
+### data
+
+• **data**: [`ClaimData`](modules_did_registry.ClaimData.md)
+
+___
+
+### subject
+
+• `Optional` **subject**: `string`

docs/api/interfaces/modules_did_registry.DecodeJWTTokenOptions.md

@@ -0,0 +1,15 @@
+# Interface: DecodeJWTTokenOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).DecodeJWTTokenOptions
+
+## Table of contents
+
+### Properties
+
+- [token](modules_did_registry.DecodeJWTTokenOptions.md#token)
+
+## Properties
+
+### token
+
+• **token**: `string`

docs/api/interfaces/modules_did_registry.DownloadClaimsOptions.md

@@ -0,0 +1,15 @@
+# Interface: DownloadClaimsOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).DownloadClaimsOptions
+
+## Table of contents
+
+### Properties
+
+- [services](modules_did_registry.DownloadClaimsOptions.md#services)
+
+## Properties
+
+### services
+
+• **services**: `IServiceEndpoint`[]

docs/api/interfaces/modules_did_registry.GetDIDDocumentOptions.md

@@ -0,0 +1,22 @@
+# Interface: GetDIDDocumentOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).GetDIDDocumentOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_did_registry.GetDIDDocumentOptions.md#did)
+- [includeClaims](modules_did_registry.GetDIDDocumentOptions.md#includeclaims)
+
+## Properties
+
+### did
+
+• **did**: `string`
+
+___
+
+### includeClaims
+
+• `Optional` **includeClaims**: `boolean`

docs/api/interfaces/modules_did_registry.GetDidDelegatesOptions.md

@@ -0,0 +1,15 @@
+# Interface: GetDidDelegatesOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).GetDidDelegatesOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_did_registry.GetDidDelegatesOptions.md#did)
+
+## Properties
+
+### did
+
+• **did**: `string`

docs/api/interfaces/modules_did_registry.GetDidPublicKeysOptions.md

@@ -0,0 +1,15 @@
+# Interface: GetDidPublicKeysOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).GetDidPublicKeysOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_did_registry.GetDidPublicKeysOptions.md#did)
+
+## Properties
+
+### did
+
+• **did**: `string`

docs/api/interfaces/modules_did_registry.GetServicesOptions.md

@@ -0,0 +1,15 @@
+# Interface: GetServicesOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).GetServicesOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_did_registry.GetServicesOptions.md#did)
+
+## Properties
+
+### did
+
+• **did**: `string`

docs/api/interfaces/modules_did_registry.IssuePublicClaimOptions.md

@@ -0,0 +1,22 @@
+# Interface: IssuePublicClaimOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).IssuePublicClaimOptions
+
+## Table of contents
+
+### Properties
+
+- [publicClaim](modules_did_registry.IssuePublicClaimOptions.md#publicclaim)
+- [token](modules_did_registry.IssuePublicClaimOptions.md#token)
+
+## Properties
+
+### publicClaim
+
+• `Optional` **publicClaim**: `IPublicClaim`
+
+___
+
+### token
+
+• `Optional` **token**: `string`

docs/api/interfaces/modules_did_registry.UpdateDocumentOptions.md

@@ -0,0 +1,36 @@
+# Interface: UpdateDocumentOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).UpdateDocumentOptions
+
+## Table of contents
+
+### Properties
+
+- [data](modules_did_registry.UpdateDocumentOptions.md#data)
+- [did](modules_did_registry.UpdateDocumentOptions.md#did)
+- [didAttribute](modules_did_registry.UpdateDocumentOptions.md#didattribute)
+- [validity](modules_did_registry.UpdateDocumentOptions.md#validity)
+
+## Properties
+
+### data
+
+• **data**: `IUpdateData`
+
+___
+
+### did
+
+• `Optional` **did**: `string`
+
+___
+
+### didAttribute
+
+• **didAttribute**: `DIDAttribute`
+
+___
+
+### validity
+
+• `Optional` **validity**: `number`

docs/api/interfaces/modules_did_registry.UpdateSignedDidDelegateOptions.md

@@ -0,0 +1,43 @@
+# Interface: UpdateSignedDidDelegateOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).UpdateSignedDidDelegateOptions
+
+## Table of contents
+
+### Properties
+
+- [algo](modules_did_registry.UpdateSignedDidDelegateOptions.md#algo)
+- [delegatePublicKey](modules_did_registry.UpdateSignedDidDelegateOptions.md#delegatepublickey)
+- [did](modules_did_registry.UpdateSignedDidDelegateOptions.md#did)
+- [type](modules_did_registry.UpdateSignedDidDelegateOptions.md#type)
+- [validity](modules_did_registry.UpdateSignedDidDelegateOptions.md#validity)
+
+## Properties
+
+### algo
+
+• **algo**: `KeyType`
+
+___
+
+### delegatePublicKey
+
+• **delegatePublicKey**: `string`
+
+___
+
+### did
+
+• **did**: `string`
+
+___
+
+### type
+
+• **type**: `PubKeyType`
+
+___
+
+### validity
+
+• `Optional` **validity**: `number`

docs/api/interfaces/modules_did_registry.UpdateSignedDidPublicKeyOptions.md

@@ -0,0 +1,50 @@
+# Interface: UpdateSignedDidPublicKeyOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).UpdateSignedDidPublicKeyOptions
+
+## Table of contents
+
+### Properties
+
+- [algo](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#algo)
+- [did](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#did)
+- [publicKey](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#publickey)
+- [tag](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#tag)
+- [type](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#type)
+- [validity](modules_did_registry.UpdateSignedDidPublicKeyOptions.md#validity)
+
+## Properties
+
+### algo
+
+• **algo**: `KeyType`
+
+___
+
+### did
+
+• **did**: `string`
+
+___
+
+### publicKey
+
+• **publicKey**: `string`
+
+___
+
+### tag
+
+• **tag**: `string`
+
+___
+
+### type
+
+• **type**: `PubKeyType`
+
+___
+
+### validity
+
+• `Optional` **validity**: `number`

docs/api/interfaces/modules_did_registry.ValidDateUpdateDocumentRequestOptions.md

@@ -0,0 +1,29 @@
+# Interface: ValidDateUpdateDocumentRequestOptions
+
+[modules/did-registry](../modules/modules_did_registry.md).ValidDateUpdateDocumentRequestOptions
+
+## Table of contents
+
+### Properties
+
+- [data](modules_did_registry.ValidDateUpdateDocumentRequestOptions.md#data)
+- [did](modules_did_registry.ValidDateUpdateDocumentRequestOptions.md#did)
+- [didAttribute](modules_did_registry.ValidDateUpdateDocumentRequestOptions.md#didattribute)
+
+## Properties
+
+### data
+
+• **data**: `IUpdateData`
+
+___
+
+### did
+
+• **did**: `string`
+
+___
+
+### didAttribute
+
+• **didAttribute**: `DIDAttribute`

docs/api/modules/modules_claims.md

@@ -124,7 +124,7 @@ ___
 
 ### readyToBeRegisteredOnchain
 
-▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required<Pick<Claim, "claimTypeVersion" \| "claimType" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>
+▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required<Pick<Claim, "claimType" \| "claimTypeVersion" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>
 
 #### Parameters
 
@@ -134,4 +134,4 @@ ___
 
 #### Returns
 
-claim is Required<Pick<Claim, "claimTypeVersion" \| "claimType" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>
+claim is Required<Pick<Claim, "claimType" \| "claimTypeVersion" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>

docs/api/modules/modules_did_registry.md

@@ -11,4 +11,16 @@
 - [AssetProfile](../interfaces/modules_did_registry.AssetProfile.md)
 - [AssetProfiles](../interfaces/modules_did_registry.AssetProfiles.md)
 - [ClaimData](../interfaces/modules_did_registry.ClaimData.md)
+- [CreatePublicClaimOptions](../interfaces/modules_did_registry.CreatePublicClaimOptions.md)
+- [DecodeJWTTokenOptions](../interfaces/modules_did_registry.DecodeJWTTokenOptions.md)
+- [DownloadClaimsOptions](../interfaces/modules_did_registry.DownloadClaimsOptions.md)
+- [GetDIDDocumentOptions](../interfaces/modules_did_registry.GetDIDDocumentOptions.md)
+- [GetDidDelegatesOptions](../interfaces/modules_did_registry.GetDidDelegatesOptions.md)
+- [GetDidPublicKeysOptions](../interfaces/modules_did_registry.GetDidPublicKeysOptions.md)
+- [GetServicesOptions](../interfaces/modules_did_registry.GetServicesOptions.md)
+- [IssuePublicClaimOptions](../interfaces/modules_did_registry.IssuePublicClaimOptions.md)
 - [Profile](../interfaces/modules_did_registry.Profile.md)
+- [UpdateDocumentOptions](../interfaces/modules_did_registry.UpdateDocumentOptions.md)
+- [UpdateSignedDidDelegateOptions](../interfaces/modules_did_registry.UpdateSignedDidDelegateOptions.md)
+- [UpdateSignedDidPublicKeyOptions](../interfaces/modules_did_registry.UpdateSignedDidPublicKeyOptions.md)
+- [ValidDateUpdateDocumentRequestOptions](../interfaces/modules_did_registry.ValidDateUpdateDocumentRequestOptions.md)