@3sixty/api-models 0.0.0-stage → 0.20.0-next.1

package/docs/reference/interfaces/ISocketRoute.md

@@ -0,0 +1,198 @@
+# Interface: ISocketRoute\<T, U\>
+
+Interface which defines a socket route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Type Parameters
+
+### T {#t}
+
+`T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+### U {#u}
+
+`U` *extends* [`IHttpResponse`](IHttpResponse.md) = `any`
+
+## Properties
+
+### operationId {#operationid}
+
+> **operationId**: `string`
+
+The id of the operation.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`operationId`](IBaseRoute.md#operationid)
+
+***
+
+### path {#path}
+
+> **path**: `string`
+
+The path to use for routing.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`path`](IBaseRoute.md#path)
+
+***
+
+### skipAuth? {#skipauth}
+
+> `optional` **skipAuth?**: `boolean`
+
+Skips the authentication requirement for this route.
+
+#### Default
+
+```ts
+false
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
+
+***
+
+### skipTenant? {#skiptenant}
+
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Default
+
+```ts
+false
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiresAuthorization? {#requiresauthorization}
+
+> `optional` **requiresAuthorization?**: `boolean`
+
+Requires authorization for this route.
+
+#### Default
+
+```ts
+true
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiresAuthorization`](IBaseRoute.md#requiresauthorization)
+
+***
+
+### defaultAuthorization? {#defaultauthorization}
+
+> `optional` **defaultAuthorization?**: [`IRouteAuthorization`](IRouteAuthorization.md)
+
+The default authorization which can access this route, used to seed the RBAC rules.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`defaultAuthorization`](IBaseRoute.md#defaultauthorization)
+
+***
+
+### disableTenantOverride? {#disabletenantoverride}
+
+> `optional` **disableTenantOverride?**: `boolean`
+
+Set to true to prevent callers from using the overrideTenant query parameter on this route.
+Tenant override is allowed by default, but you must hold the escalated privilege role to use it.
+
+#### Default
+
+```ts
+false
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`disableTenantOverride`](IBaseRoute.md#disabletenantoverride)
+
+***
+
+### handler {#handler}
+
+> **handler**: (`socketRequestContext`, `request`, `emit`) => `Promise`\<`void`\>
+
+The handler module.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+##### request
+
+`T`
+
+The request object.
+
+##### emit
+
+(`event`, `response`) => `Promise`\<`void`\>
+
+The function to emit an event.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### connected? {#connected}
+
+> `optional` **connected?**: (`socketRequestContext`) => `Promise`\<`void`\>
+
+The connected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### disconnected? {#disconnected}
+
+> `optional` **disconnected?**: (`socketRequestContext`) => `Promise`\<`void`\>
+
+The disconnected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -0,0 +1,247 @@
+# Interface: ISocketRouteProcessor
+
+The definition for a processor for handling socket routes.
+
+## Extends
+
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md), [`ISocketServerRequest`](ISocketServerRequest.md)\>
+
+## Methods
+
+### pre()? {#pre}
+
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`pre`](IBaseRouteProcessor.md#pre)
+
+***
+
+### post()? {#post}
+
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`post`](IBaseRouteProcessor.md#post)
+
+***
+
+### connected()? {#connected}
+
+> `optional` **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the connected event.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### disconnected()? {#disconnected}
+
+> `optional` **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the disconnected event.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### process()? {#process}
+
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -0,0 +1,93 @@
+# Interface: ISocketServerRequest\<T\>
+
+Model for the standard parameters for an http request.
+
+## Extends
+
+- [`IHttpServerRequest`](IHttpServerRequest.md)\<`T`\>
+
+## Type Parameters
+
+### T {#t}
+
+`T` = `any`
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+Incoming Http Headers.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`headers`](IHttpServerRequest.md#headers)
+
+***
+
+### pathParams? {#pathparams}
+
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+
+The path parameters.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`pathParams`](IHttpServerRequest.md#pathparams)
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+
+The query parameters.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`query`](IHttpServerRequest.md#query)
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `T`
+
+Data to return send as the body.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`body`](IHttpServerRequest.md#body)
+
+***
+
+### url {#url}
+
+> **url**: `string`
+
+The request url.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
+
+***
+
+### method? {#method}
+
+> `optional` **method?**: `HttpMethod`
+
+The request method.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
+
+***
+
+### socketId {#socketid}
+
+> **socketId**: `string`
+
+The socket id.

package/docs/reference/interfaces/ITag.md

@@ -0,0 +1,19 @@
+# Interface: ITag
+
+Tag for routes used to generate OpenAPI information.
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the tag.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+Description for the tag.

package/docs/reference/interfaces/ITenant.md

@@ -0,0 +1,67 @@
+# Interface: ITenant
+
+Model defining the tenant.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the tenant.
+
+***
+
+### apiKey {#apikey}
+
+> **apiKey**: `string`
+
+The api key for the tenant.
+
+***
+
+### label {#label}
+
+> **label**: `string`
+
+The label of the tenant.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date the tenant was created.
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+The date the tenant was modified.
+
+***
+
+### publicOrigin? {#publicorigin}
+
+> `optional` **publicOrigin?**: `string`
+
+The public origin available to the public for accessing the API.
+
+***
+
+### organizationId {#organizationid}
+
+> **organizationId**: `string`
+
+The organization id for the tenant.
+
+***
+
+### organizationIdLegacy? {#organizationidlegacy}
+
+> `optional` **organizationIdLegacy?**: `string`[]
+
+Optional list of organization aliases that can are used for legacy lookups.