@3sixty/identity-rest-client 0.0.0-stage → 0.20.0-next.0

package/docs/reference/classes/IdentityProfileRestClient.md

@@ -0,0 +1,337 @@
+# Class: IdentityProfileRestClient\<T, U\>
+
+Client for performing identity profile operations through REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+### U
+
+`U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+## Implements
+
+- `IIdentityProfileComponent`\<`T`, `U`\>
+
+## Constructors
+
+### Constructor
+
+> **new IdentityProfileRestClient**\<`T`, `U`\>(`config`): `IdentityProfileRestClient`\<`T`, `U`\>
+
+Create a new instance of IdentityProfileRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`IdentityProfileRestClient`\<`T`, `U`\>
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IIdentityProfileComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
+
+Create the profile properties for an identity.
+
+#### Parameters
+
+##### publicProfile?
+
+`T`
+
+The public profile data as JSON-LD.
+
+##### privateProfile?
+
+`U`
+
+The private profile data as JSON-LD.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the profile has been created.
+
+#### Implementation of
+
+`IIdentityProfileComponent.create`
+
+***
+
+### get() {#get}
+
+> **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
+
+Get the profile properties for an identity.
+
+#### Parameters
+
+##### publicPropertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+##### privatePropertyNames?
+
+keyof `U`[]
+
+The private properties to get for the profile, defaults to all.
+
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
+#### Returns
+
+`Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
+
+The identity and the items properties.
+
+#### Implementation of
+
+`IIdentityProfileComponent.get`
+
+***
+
+### getPublic() {#getpublic}
+
+> **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
+
+Get the public profile properties for an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The identity to perform the profile operation on.
+
+##### propertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+#### Returns
+
+`Promise`\<`Partial`\<`T`\>\>
+
+The items properties.
+
+#### Implementation of
+
+`IIdentityProfileComponent.getPublic`
+
+***
+
+### update() {#update}
+
+> **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
+
+Update the profile properties of an identity.
+
+#### Parameters
+
+##### publicProfile?
+
+`T`
+
+The public profile data as JSON-LD.
+
+##### privateProfile?
+
+`U`
+
+The private profile data as JSON-LD.
+
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the profile has been updated.
+
+#### Implementation of
+
+`IIdentityProfileComponent.update`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`identity?`): `Promise`\<`void`\>
+
+Delete the profile for an identity.
+
+#### Parameters
+
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the profile has been removed.
+
+#### Implementation of
+
+`IIdentityProfileComponent.remove`
+
+***
+
+### list() {#list}
+
+> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+Get a list of the requested identities.
+
+#### Parameters
+
+##### publicFilters?
+
+`object`[]
+
+The filters to apply to the identities public profiles.
+
+##### publicPropertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+##### cursor?
+
+`string`
+
+The cursor for paged requests.
+
+##### limit?
+
+`number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+The list of items and cursor for paging.
+
+#### Implementation of
+
+`IIdentityProfileComponent.list`
+
+***
+
+### listAdmin() {#listadmin}
+
+> **listAdmin**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+Get the list of identity profiles including private properties.
+
+#### Parameters
+
+##### publicFilters?
+
+`object`[]
+
+The filters to apply to the identities public profiles.
+
+##### privateFilters?
+
+`object`[]
+
+The filters to apply to the identities private profiles.
+
+##### publicPropertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+##### privatePropertyNames?
+
+keyof `U`[]
+
+The private properties to get for the profile, defaults to none.
+
+##### cursor?
+
+`string`
+
+The cursor for paged requests.
+
+##### limit?
+
+`number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+The list of items and cursor for paging.
+
+#### Implementation of
+
+`IIdentityProfileComponent.listAdmin`

package/docs/reference/classes/IdentityResolverRestClient.md

@@ -0,0 +1,87 @@
+# Class: IdentityResolverRestClient
+
+Client for performing identity resolution through REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IIdentityResolverComponent`
+
+## Constructors
+
+### Constructor
+
+> **new IdentityResolverRestClient**(`config`): `IdentityResolverRestClient`
+
+Create a new instance of IdentityResolverRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`IdentityResolverRestClient`
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IIdentityResolverComponent.className`
+
+***
+
+### identityResolve() {#identityresolve}
+
+> **identityResolve**(`documentId`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.
+
+#### Implementation of
+
+`IIdentityResolverComponent.identityResolve`