@twin.org/api-models 0.0.3-next.21 → 0.0.3-next.23

package/docs/reference/interfaces/IServerRootResponse.md

@@ -4,7 +4,7 @@ The root text for the server.
 
 ## Properties
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -16,7 +16,7 @@ The headers for the response.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `string`
 

package/docs/reference/interfaces/IServerSpecResponse.md

@@ -4,16 +4,16 @@ The OpenAPI spec for the endpoints.
 
 ## Properties
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `unknown`
+> `optional` **body?**: `unknown`
 
 The spec for the server.

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -8,7 +8,7 @@ Context data from the socket request.
 
 ## Properties
 
-### serverRequest
+### serverRequest {#serverrequest}
 
 > **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
 
@@ -20,7 +20,7 @@ The raw HTTP request.
 
 ***
 
-### processorState
+### processorState {#processorstate}
 
 > **processorState**: `object`
 
@@ -36,9 +36,9 @@ The state handed through the processors.
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 Logging component type for the request.
 
@@ -48,9 +48,9 @@ Logging component type for the request.
 
 ***
 
-### hostingComponentType?
+### hostingComponentType? {#hostingcomponenttype}
 
-> `optional` **hostingComponentType**: `string`
+> `optional` **hostingComponentType?**: `string`
 
 Hosting component type for the request.
 
@@ -60,7 +60,7 @@ Hosting component type for the request.
 
 ***
 
-### socketId
+### socketId {#socketid}
 
 > **socketId**: `string`
 

package/docs/reference/interfaces/ISocketRoute.md

@@ -18,7 +18,7 @@ Interface which defines a socket route.
 
 ## Properties
 
-### operationId
+### operationId {#operationid}
 
 > **operationId**: `string`
 
@@ -30,7 +30,7 @@ The id of the operation.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -42,9 +42,9 @@ The path to use for routing.
 
 ***
 
-### skipAuth?
+### skipAuth? {#skipauth}
 
-> `optional` **skipAuth**: `boolean`
+> `optional` **skipAuth?**: `boolean`
 
 Skips the authentication requirement for this route.
 
@@ -54,9 +54,9 @@ Skips the authentication requirement for this route.
 
 ***
 
-### skipTenant?
+### skipTenant? {#skiptenant}
 
-> `optional` **skipTenant**: `boolean`
+> `optional` **skipTenant?**: `boolean`
 
 Skips the tenant requirement for this route.
 
@@ -66,9 +66,9 @@ Skips the tenant requirement for this route.
 
 ***
 
-### requiredScope?
+### requiredScope? {#requiredscope}
 
-> `optional` **requiredScope**: `string`[]
+> `optional` **requiredScope?**: `string`[]
 
 The user must have one of the specified scopes to access the route.
 
@@ -78,9 +78,9 @@ The user must have one of the specified scopes to access the route.
 
 ***
 
-### processorFeatures?
+### processorFeatures? {#processorfeatures}
 
-> `optional` **processorFeatures**: `string`[]
+> `optional` **processorFeatures?**: `string`[]
 
 The features supported by additional processors to run for this route.
 
@@ -90,9 +90,9 @@ The features supported by additional processors to run for this route.
 
 ***
 
-### processorData?
+### processorData? {#processordata}
 
-> `optional` **processorData**: `object`
+> `optional` **processorData?**: `object`
 
 The data for additional processors to run for this route.
 
@@ -106,7 +106,7 @@ The data for additional processors to run for this route.
 
 ***
 
-### handler()
+### handler {#handler}
 
 > **handler**: (`socketRequestContext`, `request`, `emit`) => `void`
 
@@ -138,9 +138,9 @@ The function to emit an event.
 
 ***
 
-### connected()?
+### connected? {#connected}
 
-> `optional` **connected**: (`socketRequestContext`) => `void`
+> `optional` **connected?**: (`socketRequestContext`) => `void`
 
 The connected handler.
 
@@ -158,9 +158,9 @@ The request context.
 
 ***
 
-### disconnected()?
+### disconnected? {#disconnected}
 
-> `optional` **disconnected**: (`socketRequestContext`) => `void`
+> `optional` **disconnected?**: (`socketRequestContext`) => `void`
 
 The disconnected handler.
 

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -8,7 +8,7 @@ The definition for a processor for handling socket routes.
 
 ## Methods
 
-### features()?
+### features()? {#features}
 
 > `optional` **features**(): `string`[]
 
@@ -28,7 +28,7 @@ The features supported by this processor.
 
 ***
 
-### pre()?
+### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -50,9 +50,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -92,7 +92,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### post()?
+### post()? {#post}
 
 > `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -114,9 +114,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -156,7 +156,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### connected()?
+### connected()? {#connected}
 
 > `optional` **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -172,9 +172,9 @@ The server request object containing the socket id and other parameters.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### loggingComponentType?
 
@@ -190,7 +190,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### disconnected()?
+### disconnected()? {#disconnected}
 
 > `optional` **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -206,9 +206,9 @@ The server request object containing the socket id and other parameters.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### loggingComponentType?
 
@@ -224,7 +224,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### process()?
+### process()? {#process}
 
 > `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -246,9 +246,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### processorState
 

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -14,9 +14,9 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
@@ -26,9 +26,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
@@ -38,9 +38,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
@@ -50,9 +50,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.
 
@@ -62,7 +62,7 @@ Data to return send as the body.
 
 ***
 
-### url
+### url {#url}
 
 > **url**: `string`
 
@@ -74,9 +74,9 @@ The request url.
 
 ***
 
-### method?
+### method? {#method}
 
-> `optional` **method**: `HttpMethod`
+> `optional` **method?**: `HttpMethod`
 
 The request method.
 
@@ -86,7 +86,7 @@ The request method.
 
 ***
 
-### socketId
+### socketId {#socketid}
 
 > **socketId**: `string`
 

package/docs/reference/interfaces/ITag.md

@@ -4,7 +4,7 @@ Tag for routes used to generate OpenAPI information.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -12,7 +12,7 @@ The name of the tag.
 
 ***
 
-### description
+### description {#description}
 
 > **description**: `string`
 

package/docs/reference/interfaces/ITenant.md

@@ -4,7 +4,7 @@ Model defining the tenant.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -12,7 +12,7 @@ The unique identifier for the tenant.
 
 ***
 
-### apiKey
+### apiKey {#apikey}
 
 > **apiKey**: `string`
 
@@ -20,7 +20,7 @@ The api key for the tenant.
 
 ***
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -28,7 +28,7 @@ The label of the tenant.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -36,7 +36,7 @@ The date the tenant was created.
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
@@ -44,15 +44,15 @@ The date the tenant was modified.
 
 ***
 
-### publicOrigin?
+### publicOrigin? {#publicorigin}
 
-> `optional` **publicOrigin**: `string`
+> `optional` **publicOrigin?**: `string`
 
 The public origin available to the public for accessing the API.
 
 ***
 
-### isNodeTenant
+### isNodeTenant {#isnodetenant}
 
 > **isNodeTenant**: `boolean`
 

package/docs/reference/interfaces/ITenantAdminComponent.md

@@ -8,7 +8,7 @@ Configuration for the tenant admin component
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`tenant`): `Promise`\<`string`\>
 
@@ -30,7 +30,7 @@ The tenant id.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`tenant`): `Promise`\<`void`\>
 
@@ -52,7 +52,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md)\>
 
@@ -78,7 +78,7 @@ Error if the tenant is not found.
 
 ***
 
-### getByApiKey()
+### getByApiKey() {#getbyapikey}
 
 > **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md)\>
 
@@ -104,7 +104,7 @@ Error if the tenant is not found.
 
 ***
 
-### getByPublicOrigin()
+### getByPublicOrigin() {#getbypublicorigin}
 
 > **getByPublicOrigin**(`publicOrigin`): `Promise`\<[`ITenant`](ITenant.md)\>
 
@@ -130,7 +130,7 @@ Error if the tenant is not found.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`tenantId`): `Promise`\<`void`\>
 
@@ -156,7 +156,7 @@ Error if the tenant is not found.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/ITooManyRequestsResponse.md

@@ -0,0 +1,19 @@
+# Interface: ITooManyRequestsResponse
+
+The request resulted in too many requests, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `429`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IUnauthorizedResponse.md

@@ -4,7 +4,7 @@ You are not authorized to use the API or no credentials were supplied, see the c
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `401`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IUnprocessableEntityResponse.md

@@ -4,7 +4,7 @@ The server cannot process the request, see the content for more details.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `422`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IWebServer.md

@@ -10,7 +10,7 @@ Interface describing a web server.
 
 ## Methods
 
-### getInstance()
+### getInstance() {#getinstance}
 
 > **getInstance**(): `T`
 
@@ -24,7 +24,7 @@ The web server instance.
 
 ***
 
-### build()
+### build() {#build}
 
 > **build**(`restRouteProcessors?`, `restRoutes?`, `socketRouteProcessors?`, `socketRoutes?`, `options?`): `Promise`\<`void`\>
 
@@ -70,7 +70,7 @@ Nothing.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -84,7 +84,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IWebServerOptions.md

@@ -4,48 +4,72 @@ Options for the web server.
 
 ## Properties
 
-### port?
+### port? {#port}
 
-> `optional` **port**: `number`
+> `optional` **port?**: `number`
 
 The port to bind the web server to.
 
+#### Default
+
+```ts
+3000
+```
+
 ***
 
-### host?
+### host? {#host}
 
-> `optional` **host**: `string`
+> `optional` **host?**: `string`
 
 The address to bind the web server to.
 
+#### Default
+
+```ts
+localhost
+```
+
 ***
 
-### methods?
+### methods? {#methods}
 
-> `optional` **methods**: `HttpMethod`[]
+> `optional` **methods?**: `HttpMethod`[]
 
 The methods that the server accepts.
 
+#### Default
+
+```ts
+["GET", "PUT", "POST", "DELETE", "OPTIONS"]
+```
+
 ***
 
-### allowedHeaders?
+### allowedHeaders? {#allowedheaders}
 
-> `optional` **allowedHeaders**: `string`[]
+> `optional` **allowedHeaders?**: `string`[]
 
 Any additional allowed headers.
 
 ***
 
-### exposedHeaders?
+### exposedHeaders? {#exposedheaders}
 
-> `optional` **exposedHeaders**: `string`[]
+> `optional` **exposedHeaders?**: `string`[]
 
 And additional exposed headers.
 
 ***
 
-### corsOrigins?
+### corsOrigins? {#corsorigins}
 
-> `optional` **corsOrigins**: `string` \| `string`[]
+> `optional` **corsOrigins?**: `string` \| `string`[]
 
 The allowed CORS domains.
+
+#### Default
+
+```ts
+["*"]
+```