@3sixty/api-auth-entity-storage-rest-client 0.0.0-stage → 0.20.0-next.0

package/docs/reference/classes/EntityStorageAuthenticationAuditRestClient.md

@@ -0,0 +1,343 @@
+# Class: EntityStorageAuthenticationAuditRestClient
+
+The client to connect to the authentication audit service.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IAuthenticationAuditComponent`
+
+## Constructors
+
+### Constructor
+
+> **new EntityStorageAuthenticationAuditRestClient**(`config`): `EntityStorageAuthenticationAuditRestClient`
+
+Create a new instance of EntityStorageAuthenticationAuditRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`EntityStorageAuthenticationAuditRestClient`
+
+#### 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
+
+`IAuthenticationAuditComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`entry`): `Promise`\<`string`\>
+
+Create a new audit entry.
+
+#### Parameters
+
+##### entry
+
+`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>
+
+The audit entry to be logged.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The unique identifier of the created audit entry.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.create`
+
+***
+
+### get() {#get}
+
+> **get**(`id`): `Promise`\<`IAuthenticationAuditEntry`\>
+
+Get an audit entry by id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry.
+
+#### Returns
+
+`Promise`\<`IAuthenticationAuditEntry`\>
+
+The audit entry.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.get`
+
+***
+
+### update() {#update}
+
+> **update**(`id`, `entry`): `Promise`\<`void`\>
+
+Update an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to update.
+
+##### entry
+
+`Partial`\<`Omit`\<`IAuthenticationAuditEntry`, `"id"` \| `"dateCreated"`\>\>
+
+The fields to update on the audit entry.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been updated.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.update`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove an audit entry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The unique identifier of the audit entry to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the audit entry has been removed.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.remove`
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
+
+Query the audit entries.
+
+#### Parameters
+
+##### options?
+
+The query options.
+
+###### actorId?
+
+`string`
+
+The actor identifier to filter the audit entries, optional.
+
+###### organizationId?
+
+`string`
+
+The organization identifier to filter the audit entries, optional.
+
+###### tenantId?
+
+`string`
+
+The tenant identifier to filter the audit entries, optional.
+
+###### nodeId?
+
+`string`
+
+The node identifier to filter the audit entries, optional.
+
+###### event?
+
+`string`
+
+The audit event to filter the audit entries, optional.
+
+###### startDate?
+
+`string`
+
+The start date to filter the audit entries, optional.
+
+###### endDate?
+
+`string`
+
+The end date to filter the audit entries, optional.
+
+##### cursor?
+
+`string`
+
+The cursor for pagination.
+
+##### limit?
+
+`number`
+
+The maximum number of entries to return.
+
+#### Returns
+
+`Promise`\<\{ `entries`: `IAuthenticationAuditEntry`[]; `cursor?`: `string`; \}\>
+
+The audit entries.
+
+#### Implementation of
+
+`IAuthenticationAuditComponent.query`
+
+***
+
+### getEndpointWithPrefix() {#getendpointwithprefix}
+
+> **getEndpointWithPrefix**(): `string`
+
+Get the endpoint with the prefix for the namespace.
+
+#### Returns
+
+`string`
+
+The endpoint with namespace prefix attached.
+
+#### Inherited from
+
+`BaseRestClient.getEndpointWithPrefix`
+
+***
+
+### getPathPrefix() {#getpathprefix}
+
+> **getPathPrefix**(): `string`
+
+Get the path prefix as a URL path string provided in the constructor.
+
+#### Returns
+
+`string`
+
+The path prefix.
+
+#### Inherited from
+
+`BaseRestClient.getPathPrefix`
+
+***
+
+### fetch() {#fetch}
+
+> **fetch**\<`T`, `U`\>(`route`, `method`, `request?`, `options?`): `Promise`\<`U`\>
+
+Perform a request in json format.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `IHttpRequest`\<`any`\>
+
+##### U
+
+`U` *extends* `IHttpResponse`\<`any`\>
+
+#### Parameters
+
+##### route
+
+`string`
+
+The route of the request.
+
+##### method
+
+`HttpMethod`
+
+The http method.
+
+##### request?
+
+`T`
+
+Request to send to the endpoint.
+
+##### options?
+
+Optional override options for the request.
+
+###### overridePrefix?
+
+`string`
+
+Optional override prefix to use for this request instead of the default prefix.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+The response.
+
+#### Inherited from
+
+`BaseRestClient.fetch`

package/docs/reference/classes/EntityStorageAuthenticationRestClient.md

@@ -0,0 +1,271 @@
+# Class: EntityStorageAuthenticationRestClient
+
+The client to connect to the authentication service.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IAuthenticationComponent`
+
+## Constructors
+
+### Constructor
+
+> **new EntityStorageAuthenticationRestClient**(`config`): `EntityStorageAuthenticationRestClient`
+
+Create a new instance of EntityStorageAuthenticationRestClient.
+
+#### Parameters
+
+##### config
+
+[`IEntityStorageAuthenticationRestClientConstructorOptions`](../interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md)
+
+The configuration for the client.
+
+#### Returns
+
+`EntityStorageAuthenticationRestClient`
+
+#### 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
+
+`IAuthenticationComponent.className`
+
+***
+
+### login() {#login}
+
+> **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Perform a login for the user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address for the user.
+
+##### password
+
+`string`
+
+The password for the user.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The authentication token for the user, if it uses a mechanism with public access.
+
+#### Implementation of
+
+`IAuthenticationComponent.login`
+
+***
+
+### logout() {#logout}
+
+> **logout**(`token?`): `Promise`\<`void`\>
+
+Logout the current user.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to logout, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the logout request has completed.
+
+#### Implementation of
+
+`IAuthenticationComponent.logout`
+
+***
+
+### refresh() {#refresh}
+
+> **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Refresh the token.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to refresh, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The refreshed token, if it uses a mechanism with public access.
+
+#### Implementation of
+
+`IAuthenticationComponent.refresh`
+
+***
+
+### updatePassword() {#updatepassword}
+
+> **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### currentPassword
+
+`string`
+
+The current password for the user.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the password has been updated on the server.
+
+#### Implementation of
+
+`IAuthenticationComponent.updatePassword`
+
+***
+
+### getEndpointWithPrefix() {#getendpointwithprefix}
+
+> **getEndpointWithPrefix**(): `string`
+
+Get the endpoint with the prefix for the namespace.
+
+#### Returns
+
+`string`
+
+The endpoint with namespace prefix attached.
+
+#### Inherited from
+
+`BaseRestClient.getEndpointWithPrefix`
+
+***
+
+### getPathPrefix() {#getpathprefix}
+
+> **getPathPrefix**(): `string`
+
+Get the path prefix as a URL path string provided in the constructor.
+
+#### Returns
+
+`string`
+
+The path prefix.
+
+#### Inherited from
+
+`BaseRestClient.getPathPrefix`
+
+***
+
+### fetch() {#fetch}
+
+> **fetch**\<`T`, `U`\>(`route`, `method`, `request?`, `options?`): `Promise`\<`U`\>
+
+Perform a request in json format.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `IHttpRequest`\<`any`\>
+
+##### U
+
+`U` *extends* `IHttpResponse`\<`any`\>
+
+#### Parameters
+
+##### route
+
+`string`
+
+The route of the request.
+
+##### method
+
+`HttpMethod`
+
+The http method.
+
+##### request?
+
+`T`
+
+Request to send to the endpoint.
+
+##### options?
+
+Optional override options for the request.
+
+###### overridePrefix?
+
+`string`
+
+Optional override prefix to use for this request instead of the default prefix.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+The response.
+
+#### Inherited from
+
+`BaseRestClient.fetch`

package/docs/reference/index.md

@@ -0,0 +1,11 @@
+# @3sixty/api-auth-entity-storage-rest-client
+
+## Classes
+
+- [EntityStorageAuthenticationAdminRestClient](classes/EntityStorageAuthenticationAdminRestClient.md)
+- [EntityStorageAuthenticationAuditRestClient](classes/EntityStorageAuthenticationAuditRestClient.md)
+- [EntityStorageAuthenticationRestClient](classes/EntityStorageAuthenticationRestClient.md)
+
+## Interfaces
+
+- [IEntityStorageAuthenticationRestClientConstructorOptions](interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md)