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

package/docs/reference/interfaces/IBaseRoute.md

@@ -9,7 +9,7 @@ Interface which defines a route.
 
 ## Properties
 
-### operationId
+### operationId {#operationid}
 
 > **operationId**: `string`
 
@@ -17,7 +17,7 @@ The id of the operation.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -25,41 +25,41 @@ The path to use for routing.
 
 ***
 
-### skipAuth?
+### skipAuth? {#skipauth}
 
-> `optional` **skipAuth**: `boolean`
+> `optional` **skipAuth?**: `boolean`
 
 Skips the authentication requirement for this route.
 
 ***
 
-### skipTenant?
+### skipTenant? {#skiptenant}
 
-> `optional` **skipTenant**: `boolean`
+> `optional` **skipTenant?**: `boolean`
 
 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.
 
 ***
 
-### processorFeatures?
+### processorFeatures? {#processorfeatures}
 
-> `optional` **processorFeatures**: `string`[]
+> `optional` **processorFeatures?**: `string`[]
 
 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.
 

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

@@ -10,7 +10,7 @@ Route entry points are used for exposing the routes from a package.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -18,7 +18,7 @@ The name of the routes.
 
 ***
 
-### defaultBaseRoute
+### defaultBaseRoute {#defaultbaseroute}
 
 > **defaultBaseRoute**: `string`
 
@@ -26,7 +26,7 @@ The default base route name for the routes.
 
 ***
 
-### tags
+### tags {#tags}
 
 > **tags**: [`ITag`](ITag.md)[]
 
@@ -34,7 +34,7 @@ The tags for the routes.
 
 ***
 
-### generateRoutes()
+### generateRoutes {#generateroutes}
 
 > **generateRoutes**: (`baseRouteName`, `componentName`) => `T`[]
 

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -23,7 +23,7 @@ The definition for a base processor for handling REST routes.
 
 ## Methods
 
-### features()?
+### features()? {#features}
 
 > `optional` **features**(): `string`[]
 
@@ -39,7 +39,7 @@ The features supported by this processor.
 
 ***
 
-### pre()?
+### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -61,9 +61,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+`T` \| `undefined`
 
-`T` | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -99,7 +99,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### post()?
+### post()? {#post}
 
 > `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -121,9 +121,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+`T` \| `undefined`
 
-`T` | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -4,15 +4,15 @@ Definition for the configuration of a socket service.
 
 ## Properties
 
-### basePath?
+### basePath? {#basepath}
 
-> `optional` **basePath**: `string`
+> `optional` **basePath?**: `string`
 
 Base path for the socket service, defaults to /socket.
 
 ***
 
-### endpoint
+### endpoint {#endpoint}
 
 > **endpoint**: `string`
 
@@ -20,16 +20,16 @@ The endpoint where the api is hosted.
 
 ***
 
-### pathPrefix?
+### pathPrefix? {#pathprefix}
 
-> `optional` **pathPrefix**: `string`
+> `optional` **pathPrefix?**: `string`
 
 The prefix to the routes.
 
 ***
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 The headers to include in requests.

package/docs/reference/interfaces/IConflictResponse.md

@@ -4,7 +4,7 @@ The request resulted in a conflicting operation, see the content for more detail
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `409`
 
@@ -12,16 +12,8 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
-> **body**: `IError` & `object`
+> **body**: `IError`
 
 The body which contains the error.
-
-#### Type Declaration
-
-##### conflicts
-
-> **conflicts**: `string`[]
-
-The conflicting items.

package/docs/reference/interfaces/ICreatedResponse.md

@@ -4,7 +4,7 @@ The rest request ended in created response.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `201`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 

package/docs/reference/interfaces/IForbiddenResponse.md

@@ -4,7 +4,7 @@ The operation that you tried to perform is not possible, see the content for mor
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `403`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IHealthComponentInfo.md

@@ -4,7 +4,7 @@ The health component information.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -12,7 +12,7 @@ The name of the component.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
 
@@ -20,8 +20,8 @@ The status of the component.
 
 ***
 
-### details?
+### details? {#details}
 
-> `optional` **details**: `string`
+> `optional` **details?**: `string`
 
 The details for the status.

package/docs/reference/interfaces/IHealthInfo.md

@@ -4,7 +4,7 @@ The status of the server.
 
 ## Properties
 
-### status
+### status {#status}
 
 > **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
 
@@ -12,8 +12,8 @@ The status.
 
 ***
 
-### components?
+### components? {#components}
 
-> `optional` **components**: [`IHealthComponentInfo`](IHealthComponentInfo.md)[]
+> `optional` **components?**: [`IHealthComponentInfo`](IHealthComponentInfo.md)[]
 
 The status of the components.

package/docs/reference/interfaces/IHostingComponent.md

@@ -8,7 +8,7 @@ The information about the hosting of the API.
 
 ## Methods
 
-### getPublicOrigin()
+### getPublicOrigin() {#getpublicorigin}
 
 > **getPublicOrigin**(`serverRequestUrl?`): `Promise`\<`string`\>
 
@@ -30,7 +30,7 @@ The public origin.
 
 ***
 
-### getTenantOrigin()
+### getTenantOrigin() {#gettenantorigin}
 
 > **getTenantOrigin**(`tenantId`): `Promise`\<`string` \| `undefined`\>
 
@@ -52,7 +52,7 @@ The public origin for the tenant.
 
 ***
 
-### buildPublicUrl()
+### buildPublicUrl() {#buildpublicurl}
 
 > **buildPublicUrl**(`url`): `Promise`\<`string`\>
 

package/docs/reference/interfaces/IHttpRequest.md

@@ -15,32 +15,32 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.

package/docs/reference/interfaces/IHttpRequestContext.md

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

package/docs/reference/interfaces/IHttpRequestPathParams.md

@@ -4,4 +4,4 @@ Model for the standard parameters for an http request.
 
 ## Indexable
 
-\[`id`: `string`\]: `string`
+> \[`id`: `string`\]: `string`

package/docs/reference/interfaces/IHttpRequestQuery.md

@@ -4,4 +4,4 @@ Model used for Http request query parameters.
 
 ## Indexable
 
-\[`id`: `string`\]: `string`
+> \[`id`: `string`\]: `string`

package/docs/reference/interfaces/IHttpResponse.md

@@ -10,24 +10,24 @@ Model for the standard parameters for an http response.
 
 ## Properties
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Response headers.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return as the main payload.

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -18,9 +18,9 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
@@ -30,9 +30,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
@@ -42,9 +42,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
@@ -54,9 +54,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.
 
@@ -66,7 +66,7 @@ Data to return send as the body.
 
 ***
 
-### url
+### url {#url}
 
 > **url**: `string`
 
@@ -74,8 +74,8 @@ The request url.
 
 ***
 
-### method?
+### method? {#method}
 
-> `optional` **method**: `HttpMethod`
+> `optional` **method?**: `HttpMethod`
 
 The request method.

package/docs/reference/interfaces/IInformationComponent.md

@@ -8,7 +8,7 @@ The information component for the server.
 
 ## Methods
 
-### root()
+### root() {#root}
 
 > **root**(): `Promise`\<`string`\>
 
@@ -22,7 +22,7 @@ The root information.
 
 ***
 
-### info()
+### info() {#info}
 
 > **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
 
@@ -36,7 +36,7 @@ The service information.
 
 ***
 
-### favicon()
+### favicon() {#favicon}
 
 > **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
@@ -50,7 +50,7 @@ The favicon.
 
 ***
 
-### spec()
+### spec() {#spec}
 
 > **spec**(): `Promise`\<`unknown`\>
 
@@ -64,7 +64,7 @@ The OpenAPI spec.
 
 ***
 
-### livez()
+### livez() {#livez}
 
 > **livez**(): `Promise`\<`boolean`\>
 
@@ -78,7 +78,7 @@ True if the server is live.
 
 ***
 
-### health()
+### health() {#health}
 
 > **health**(): `Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
 
@@ -92,7 +92,7 @@ The service health.
 
 ***
 
-### setComponentHealth()
+### setComponentHealth() {#setcomponenthealth}
 
 > **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
 
@@ -132,7 +132,7 @@ Nothing.
 
 ***
 
-### removeComponentHealth()
+### removeComponentHealth() {#removecomponenthealth}
 
 > **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IInternalServerErrorResponse.md

@@ -4,7 +4,7 @@ The server has encountered a situation it does not know how to handle, see the c
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `500`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -8,7 +8,7 @@ The definition for a handler for a specific MIME type.
 
 ## Methods
 
-### getTypes()
+### getTypes() {#gettypes}
 
 > **getTypes**(): `string`[]
 
@@ -22,7 +22,7 @@ The MIME types that this handler can handle.
 
 ***
 
-### handle()
+### handle() {#handle}
 
 > **handle**(`body`): `Promise`\<`unknown`\>
 

package/docs/reference/interfaces/INoContentRequest.md

@@ -8,9 +8,9 @@ A REST request with no input parameters.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `undefined`
+> `optional` **headers?**: `undefined`
 
 Incoming Http Headers.
 
@@ -20,9 +20,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: `undefined`
+> `optional` **pathParams?**: `undefined`
 
 The path parameters.
 
@@ -32,9 +32,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `undefined`
+> `optional` **query?**: `undefined`
 
 The query parameters.
 
@@ -44,9 +44,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `undefined`
+> `optional` **body?**: `undefined`
 
 Data to return send as the body.
 

package/docs/reference/interfaces/INoContentResponse.md

@@ -4,7 +4,7 @@ The rest request ended in success with no data.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `204`