@twin.org/identity-service 0.0.1-next.8 → 0.0.1

package/docs/reference/functions/identityCreate.md

@@ -0,0 +1,31 @@
+# Function: identityCreate()
+
+> **identityCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityCreateResponse`\>
+
+Create an identity.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityGet.md

@@ -6,15 +6,21 @@ Get the identity profile.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityProfileGetRequest`
+### request
+
+`IIdentityProfileGetRequest`
 
 The request.
 

package/docs/reference/functions/identityGetPublic.md

@@ -6,15 +6,21 @@ Get the identity public profile.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityProfileGetPublicRequest`
+### request
+
+`IIdentityProfileGetPublicRequest`
 
 The request.
 

package/docs/reference/functions/identityProfileCreate.md

@@ -6,15 +6,21 @@ Create an identity profile.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityProfileCreateRequest`
+### request
+
+`IIdentityProfileCreateRequest`
 
 The request.
 

package/docs/reference/functions/identityProfileRemove.md

@@ -6,15 +6,21 @@ Remove an identity profile.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `INoContentRequest`
+### request
+
+`INoContentRequest`
 
 The request.
 

package/docs/reference/functions/identityProfileUpdate.md

@@ -6,15 +6,21 @@ Update an identity profile.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityProfileUpdateRequest`
+### request
+
+`IIdentityProfileUpdateRequest`
 
 The request.
 

package/docs/reference/functions/identityProofCreate.md

@@ -0,0 +1,31 @@
+# Function: identityProofCreate()
+
+> **identityProofCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProofCreateResponse`\>
+
+Create an identity proof.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProofCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProofCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProofVerify.md

@@ -0,0 +1,31 @@
+# Function: identityProofVerify()
+
+> **identityProofVerify**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProofVerifyResponse`\>
+
+Verify an identity proof.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProofVerifyRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProofVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityRemove.md

@@ -0,0 +1,31 @@
+# Function: identityRemove()
+
+> **identityRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove an identity.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityResolve.md

@@ -6,15 +6,21 @@ Resolve an identity.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
-• **request**: `IIdentityResolveRequest`
+### request
+
+`IIdentityResolveRequest`
 
 The request.
 

package/docs/reference/functions/identityServiceCreate.md

@@ -0,0 +1,31 @@
+# Function: identityServiceCreate()
+
+> **identityServiceCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityServiceCreateResponse`\>
+
+Create an identity service.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityServiceCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityServiceCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityServiceRemove.md

@@ -0,0 +1,31 @@
+# Function: identityServiceRemove()
+
+> **identityServiceRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove an identity service.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityServiceRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiableCredentialCreate.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiableCredentialCreate()
+
+> **identityVerifiableCredentialCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiableCredentialCreateResponse`\>
+
+Create a verifiable credential.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiableCredentialCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiableCredentialCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiableCredentialRevoke.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiableCredentialRevoke()
+
+> **identityVerifiableCredentialRevoke**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Revoke a verifiable credential.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiableCredentialRevokeRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiableCredentialUnrevoke.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiableCredentialUnrevoke()
+
+> **identityVerifiableCredentialUnrevoke**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Unrevoke a verifiable credential.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiableCredentialUnrevokeRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiableCredentialVerify.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiableCredentialVerify()
+
+> **identityVerifiableCredentialVerify**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiableCredentialVerifyResponse`\>
+
+Verify a verifiable credential.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiableCredentialVerifyRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiableCredentialVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiablePresentationCreate.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiablePresentationCreate()
+
+> **identityVerifiablePresentationCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiablePresentationCreateResponse`\>
+
+Create a verifiable presentation.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiablePresentationCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiablePresentationCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerifiablePresentationVerify.md

@@ -0,0 +1,31 @@
+# Function: identityVerifiablePresentationVerify()
+
+> **identityVerifiablePresentationVerify**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerifiablePresentationVerifyResponse`\>
+
+Verify a verifiable presentation.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerifiablePresentationVerifyRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerifiablePresentationVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerificationMethodCreate.md

@@ -0,0 +1,31 @@
+# Function: identityVerificationMethodCreate()
+
+> **identityVerificationMethodCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityVerificationMethodCreateResponse`\>
+
+Create an identity verification method.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerificationMethodCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityVerificationMethodCreateResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityVerificationMethodRemove.md

@@ -0,0 +1,31 @@
+# Function: identityVerificationMethodRemove()
+
+> **identityVerificationMethodRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove an identity verification method.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityVerificationMethodRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -3,15 +3,21 @@
 ## Classes
 
 - [IdentityProfileService](classes/IdentityProfileService.md)
+- [IdentityResolverService](classes/IdentityResolverService.md)
 - [IdentityService](classes/IdentityService.md)
 
 ## Interfaces
 
+- [IIdentityProfileServiceConstructorOptions](interfaces/IIdentityProfileServiceConstructorOptions.md)
+- [IIdentityResolverServiceConfig](interfaces/IIdentityResolverServiceConfig.md)
+- [IIdentityResolverServiceConstructorOptions](interfaces/IIdentityResolverServiceConstructorOptions.md)
 - [IIdentityServiceConfig](interfaces/IIdentityServiceConfig.md)
+- [IIdentityServiceConstructorOptions](interfaces/IIdentityServiceConstructorOptions.md)
 
 ## Variables
 
 - [tagsIdentityProfile](variables/tagsIdentityProfile.md)
+- [tagsIdentityResolver](variables/tagsIdentityResolver.md)
 - [tagsIdentity](variables/tagsIdentity.md)
 - [restEntryPoints](variables/restEntryPoints.md)
 
@@ -24,5 +30,20 @@
 - [identityProfileUpdate](functions/identityProfileUpdate.md)
 - [identityProfileRemove](functions/identityProfileRemove.md)
 - [identitiesList](functions/identitiesList.md)
-- [generateRestRoutesIdentity](functions/generateRestRoutesIdentity.md)
+- [generateRestRoutesIdentityResolver](functions/generateRestRoutesIdentityResolver.md)
 - [identityResolve](functions/identityResolve.md)
+- [generateRestRoutesIdentity](functions/generateRestRoutesIdentity.md)
+- [identityCreate](functions/identityCreate.md)
+- [identityRemove](functions/identityRemove.md)
+- [identityVerificationMethodCreate](functions/identityVerificationMethodCreate.md)
+- [identityVerificationMethodRemove](functions/identityVerificationMethodRemove.md)
+- [identityServiceCreate](functions/identityServiceCreate.md)
+- [identityServiceRemove](functions/identityServiceRemove.md)
+- [identityVerifiableCredentialCreate](functions/identityVerifiableCredentialCreate.md)
+- [identityVerifiableCredentialVerify](functions/identityVerifiableCredentialVerify.md)
+- [identityVerifiableCredentialRevoke](functions/identityVerifiableCredentialRevoke.md)
+- [identityVerifiableCredentialUnrevoke](functions/identityVerifiableCredentialUnrevoke.md)
+- [identityVerifiablePresentationCreate](functions/identityVerifiablePresentationCreate.md)
+- [identityVerifiablePresentationVerify](functions/identityVerifiablePresentationVerify.md)
+- [identityProofCreate](functions/identityProofCreate.md)
+- [identityProofVerify](functions/identityProofVerify.md)

package/docs/reference/interfaces/IIdentityProfileServiceConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityProfileServiceConstructorOptions
+
+Options for the identity profile service constructor.
+
+## Properties
+
+### profileEntityConnectorType?
+
+> `optional` **profileEntityConnectorType**: `string`
+
+The storage connector for the profiles.
+
+#### Default
+
+```ts
+identity-profile
+```

package/docs/reference/interfaces/IIdentityResolverServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityResolverServiceConfig
+
+Configuration for the Identity Resolver Service.
+
+## Properties
+
+### defaultNamespace?
+
+> `optional` **defaultNamespace**: `string`
+
+What is the default connector to use for Identity. If not provided the first connector from the factory will be used.