docs(claim): improve claim service documentation

docs/api/interfaces/modules_claims.ApproveRolePublishingOptions.md

@@ -0,0 +1,35 @@
+# Interface: ApproveRolePublishingOptions
+
+[modules/claims](../modules/modules_claims.md).ApproveRolePublishingOptions
+
+## Table of contents
+
+### Properties
+
+- [role](modules_claims.ApproveRolePublishingOptions.md#role)
+- [subject](modules_claims.ApproveRolePublishingOptions.md#subject)
+- [version](modules_claims.ApproveRolePublishingOptions.md#version)
+
+## Properties
+
+### role
+
+• **role**: `string`
+
+Role claim type
+
+___
+
+### subject
+
+• **subject**: `string`
+
+DID of the subject
+
+___
+
+### version
+
+• **version**: `number`
+
+Role version

docs/api/interfaces/modules_claims.CreateClaimRequestOptions.md

@@ -0,0 +1,43 @@
+# Interface: CreateClaimRequestOptions
+
+[modules/claims](../modules/modules_claims.md).CreateClaimRequestOptions
+
+## Table of contents
+
+### Properties
+
+- [claim](modules_claims.CreateClaimRequestOptions.md#claim)
+- [registrationTypes](modules_claims.CreateClaimRequestOptions.md#registrationtypes)
+- [subject](modules_claims.CreateClaimRequestOptions.md#subject)
+
+## Properties
+
+### claim
+
+• **claim**: `Object`
+
+Claim request params
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `claimType` | `string` | Role namespace |
+| `claimTypeVersion` | `number` | Version of the role |
+| `requestorFields?` | { `key`: `string` ; `value`: `string` \| `number`  }[] | Requestor fields that role is requiring |
+
+___
+
+### registrationTypes
+
+• `Optional` **registrationTypes**: [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[]
+
+Indicates what type of claim registration you are requesting: on-chain and/or off-chain
+
+___
+
+### subject
+
+• `Optional` **subject**: `string`
+
+DID of the subject

docs/api/interfaces/modules_claims.CreateSelfSignedClaimOptions.md

@@ -0,0 +1,26 @@
+# Interface: CreateSelfSignedClaimOptions
+
+[modules/claims](../modules/modules_claims.md).CreateSelfSignedClaimOptions
+
+## Table of contents
+
+### Properties
+
+- [data](modules_claims.CreateSelfSignedClaimOptions.md#data)
+- [subject](modules_claims.CreateSelfSignedClaimOptions.md#subject)
+
+## Properties
+
+### data
+
+• **data**: [`ClaimData`](modules_did_registry.ClaimData.md)
+
+Claim data
+
+___
+
+### subject
+
+• `Optional` **subject**: `string`
+
+DID of the claim subject

docs/api/interfaces/modules_claims.DeleteClaimOptions.md

@@ -0,0 +1,17 @@
+# Interface: DeleteClaimOptions
+
+[modules/claims](../modules/modules_claims.md).DeleteClaimOptions
+
+## Table of contents
+
+### Properties
+
+- [id](modules_claims.DeleteClaimOptions.md#id)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Claim id

docs/api/interfaces/modules_claims.GetClaimsByIssuerOptions.md

@@ -0,0 +1,35 @@
+# Interface: GetClaimsByIssuerOptions
+
+[modules/claims](../modules/modules_claims.md).GetClaimsByIssuerOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_claims.GetClaimsByIssuerOptions.md#did)
+- [isAccepted](modules_claims.GetClaimsByIssuerOptions.md#isaccepted)
+- [namespace](modules_claims.GetClaimsByIssuerOptions.md#namespace)
+
+## Properties
+
+### did
+
+• **did**: `string`
+
+DID of the issuer
+
+___
+
+### isAccepted
+
+• `Optional` **isAccepted**: `boolean`
+
+Indicates whether to show only accepted `Claims`
+
+___
+
+### namespace
+
+• `Optional` **namespace**: `string`
+
+Indicates what namespace `Claims` should be in

docs/api/interfaces/modules_claims.GetClaimsByRequesterOptions.md

@@ -0,0 +1,35 @@
+# Interface: GetClaimsByRequesterOptions
+
+[modules/claims](../modules/modules_claims.md).GetClaimsByRequesterOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_claims.GetClaimsByRequesterOptions.md#did)
+- [isAccepted](modules_claims.GetClaimsByRequesterOptions.md#isaccepted)
+- [namespace](modules_claims.GetClaimsByRequesterOptions.md#namespace)
+
+## Properties
+
+### did
+
+• **did**: `string`
+
+DID of the requestor
+
+___
+
+### isAccepted
+
+• `Optional` **isAccepted**: `boolean`
+
+Indicates whether to show only accepted `Claims`
+
+___
+
+### namespace
+
+• `Optional` **namespace**: `string`
+
+Indicates what namespace `Claims` should be in

docs/api/interfaces/modules_claims.GetClaimsBySubjectOptions.md

@@ -0,0 +1,35 @@
+# Interface: GetClaimsBySubjectOptions
+
+[modules/claims](../modules/modules_claims.md).GetClaimsBySubjectOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_claims.GetClaimsBySubjectOptions.md#did)
+- [isAccepted](modules_claims.GetClaimsBySubjectOptions.md#isaccepted)
+- [namespace](modules_claims.GetClaimsBySubjectOptions.md#namespace)
+
+## Properties
+
+### did
+
+• **did**: `string`
+
+DID of the subject
+
+___
+
+### isAccepted
+
+• `Optional` **isAccepted**: `boolean`
+
+Indicates whether to show only accepted `Claims`
+
+___
+
+### namespace
+
+• `Optional` **namespace**: `string`
+
+Indicates what namespace `Claims` should be in

docs/api/interfaces/modules_claims.GetUserClaimsOptions.md

@@ -0,0 +1,17 @@
+# Interface: GetUserClaimsOptions
+
+[modules/claims](../modules/modules_claims.md).GetUserClaimsOptions
+
+## Table of contents
+
+### Properties
+
+- [did](modules_claims.GetUserClaimsOptions.md#did)
+
+## Properties
+
+### did
+
+• `Optional` **did**: `string`
+
+DID of the subject

docs/api/interfaces/modules_claims.IssueClaimOptions.md

@@ -0,0 +1,43 @@
+# Interface: IssueClaimOptions
+
+[modules/claims](../modules/modules_claims.md).IssueClaimOptions
+
+## Table of contents
+
+### Properties
+
+- [claim](modules_claims.IssueClaimOptions.md#claim)
+- [registrationTypes](modules_claims.IssueClaimOptions.md#registrationtypes)
+- [subject](modules_claims.IssueClaimOptions.md#subject)
+
+## Properties
+
+### claim
+
+• **claim**: `Object`
+
+Claim params
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `claimType` | `string` | Role namespace |
+| `claimTypeVersion` | `number` | Version of the role |
+| `issuerFields?` | { `key`: `string` ; `value`: `string` \| `number`  }[] | Issuers fields that role is requiring |
+
+___
+
+### registrationTypes
+
+• `Optional` **registrationTypes**: [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[]
+
+Registration types
+
+___
+
+### subject
+
+• **subject**: `string`
+
+DID of the claim subject

docs/api/interfaces/modules_claims.IssueClaimRequestOptions.md

@@ -0,0 +1,71 @@
+# Interface: IssueClaimRequestOptions
+
+[modules/claims](../modules/modules_claims.md).IssueClaimRequestOptions
+
+## Table of contents
+
+### Properties
+
+- [id](modules_claims.IssueClaimRequestOptions.md#id)
+- [issuerFields](modules_claims.IssueClaimRequestOptions.md#issuerfields)
+- [publishOnChain](modules_claims.IssueClaimRequestOptions.md#publishonchain)
+- [registrationTypes](modules_claims.IssueClaimRequestOptions.md#registrationtypes)
+- [requester](modules_claims.IssueClaimRequestOptions.md#requester)
+- [subjectAgreement](modules_claims.IssueClaimRequestOptions.md#subjectagreement)
+- [token](modules_claims.IssueClaimRequestOptions.md#token)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Claim id
+
+___
+
+### issuerFields
+
+• `Optional` **issuerFields**: { `key`: `string` ; `value`: `string` \| `number`  }[]
+
+Issuer fields that role is requiring
+
+___
+
+### publishOnChain
+
+• `Optional` **publishOnChain**: `boolean`
+
+Indicates whether to publish role on-chain or not (default: false)
+
+___
+
+### registrationTypes
+
+• **registrationTypes**: [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[]
+
+Registration types
+
+___
+
+### requester
+
+• **requester**: `string`
+
+DID of the claim requestor
+
+___
+
+### subjectAgreement
+
+• **subjectAgreement**: `string`
+
+Subject agreement signature
+
+___
+
+### token
+
+• **token**: `string`
+
+JWT token generated by requestor during claim request