@twin.org/api-models 0.0.1-next.1

package/docs/reference/interfaces/IHttpServerRequest.md

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

package/docs/reference/interfaces/IInformationComponent.md

@@ -0,0 +1,97 @@
+# Interface: IInformationComponent
+
+The information component for the server.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### info()
+
+> **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
+
+Get the server information.
+
+#### Returns
+
+`Promise`\<[`IServerInfo`](IServerInfo.md)\>
+
+The service information.
+
+***
+
+### spec()
+
+> **spec**(): `Promise`\<`unknown`\>
+
+Get the OpenAPI spec.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The OpenAPI spec.
+
+***
+
+### health()
+
+> **health**(): `Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+
+Get the server health.
+
+#### Returns
+
+`Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+
+The service health.
+
+***
+
+### setComponentHealth()
+
+> **setComponentHealth**(`name`, `status`, `details`?): `Promise`\<`void`\>
+
+Set the status of a component.
+
+#### Parameters
+
+• **name**: `string`
+
+The component name.
+
+• **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The status of the component.
+
+• **details?**: `string`
+
+The details for the status.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### removeComponentHealth()
+
+> **removeComponentHealth**(`name`): `Promise`\<`void`\>
+
+Remove the status of a component.
+
+#### Parameters
+
+• **name**: `string`
+
+The component name.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IInternalServerErrorResponse.md

@@ -0,0 +1,19 @@
+# Interface: IInternalServerErrorResponse
+
+The server has encountered a situation it does not know how to handle, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `500`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/INoContentRequest.md

@@ -0,0 +1,55 @@
+# Interface: INoContentRequest
+
+A REST request with no input parameters.
+
+## Extends
+
+- [`IHttpRequest`](IHttpRequest.md)
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `undefined`
+
+Incoming Http Headers.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`headers`](IHttpRequest.md#headers)
+
+***
+
+### pathParams?
+
+> `optional` **pathParams**: `undefined`
+
+The path parameters.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`pathParams`](IHttpRequest.md#pathparams)
+
+***
+
+### query?
+
+> `optional` **query**: `undefined`
+
+The query parameters.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`query`](IHttpRequest.md#query)
+
+***
+
+### body?
+
+> `optional` **body**: `undefined`
+
+Data to return send as the body.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`body`](IHttpRequest.md#body)

package/docs/reference/interfaces/INoContentResponse.md

@@ -0,0 +1,11 @@
+# Interface: INoContentResponse
+
+The rest request ended in success with no data.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `204`
+
+Response status code.

package/docs/reference/interfaces/INotFoundResponse.md

@@ -0,0 +1,27 @@
+# Interface: INotFoundResponse
+
+The resource you tried to access does not exist, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `404`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError` & `object`
+
+The body which contains the error.
+
+#### Type declaration
+
+##### notFoundId?
+
+> `optional` **notFoundId**: `string`
+
+The id if the item that was not found.

package/docs/reference/interfaces/IOkResponse.md

@@ -0,0 +1,11 @@
+# Interface: IOkResponse
+
+The rest request ended in success with no data.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `200`
+
+Response status code.

package/docs/reference/interfaces/IRestRoute.md

@@ -0,0 +1,137 @@
+# Interface: IRestRoute\<T, U\>
+
+Interface which defines a REST route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Type Parameters
+
+• **T** *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+• **U** *extends* [`IHttpResponse`](IHttpResponse.md) & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.md) = `any`
+
+## Properties
+
+### operationId
+
+> **operationId**: `string`
+
+The id of the operation.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`operationId`](IBaseRoute.md#operationid)
+
+***
+
+### path
+
+> **path**: `string`
+
+The path to use for routing.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`path`](IBaseRoute.md#path)
+
+***
+
+### skipAuth?
+
+> `optional` **skipAuth**: `boolean`
+
+Skips the authentication for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
+
+***
+
+### summary
+
+> **summary**: `string`
+
+Summary of what task the operation performs.
+
+***
+
+### tag
+
+> **tag**: `string`
+
+Tag for the operation.
+
+***
+
+### method
+
+> **method**: `HttpMethod`
+
+The http method.
+
+***
+
+### handler()
+
+> **handler**: (`httpRequestContext`, `request`) => `Promise`\<`U`\>
+
+The handler module.
+
+#### Parameters
+
+• **httpRequestContext**: [`IHttpRequestContext`](IHttpRequestContext.md)
+
+The http request context.
+
+• **request**: `T`
+
+The request object, combined query param, path params and body.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+***
+
+### requestType?
+
+> `optional` **requestType**: `object`
+
+The type of the request object.
+
+#### type
+
+> **type**: `string`
+
+The object type for the request.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the request, defaults to "application/json" if there is a body.
+
+#### examples?
+
+> `optional` **examples**: `object`[]
+
+Example objects for the request.
+
+***
+
+### responseType?
+
+> `optional` **responseType**: `object`[]
+
+The type of the response object.
+
+***
+
+### excludeFromSpec?
+
+> `optional` **excludeFromSpec**: `boolean`
+
+Exclude the route from being included in the spec file.

package/docs/reference/interfaces/IRestRouteEntryPoint.md

@@ -0,0 +1,45 @@
+# Interface: IRestRouteEntryPoint
+
+Route entry points are used for exposing the REST routes from a package.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The name of the REST routes.
+
+***
+
+### defaultBaseRoute
+
+> **defaultBaseRoute**: `string`
+
+The default base route name for the REST routes.
+
+***
+
+### tags
+
+> **tags**: [`ITag`](ITag.md)[]
+
+The tags for the REST routes.
+
+***
+
+### generateRoutes()
+
+> **generateRoutes**: (`baseRouteName`, `componentName`) => [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
+
+The method to generate the REST routes.
+
+#### Parameters
+
+• **baseRouteName**: `string`
+
+• **componentName**: `string`
+
+#### Returns
+
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]

package/docs/reference/interfaces/IRestRouteResponseAttachmentOptions.md

@@ -0,0 +1,27 @@
+# Interface: IRestRouteResponseAttachmentOptions
+
+Interface which defines a REST route response for attachments.
+
+## Properties
+
+### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The content type to use in the response.
+
+***
+
+### filename?
+
+> `optional` **filename**: `string`
+
+The filename to use in content disposition.
+
+***
+
+### inline?
+
+> `optional` **inline**: `boolean`
+
+Whether to inline the content.

package/docs/reference/interfaces/IRestRouteResponseOptions.md

@@ -0,0 +1,11 @@
+# Interface: IRestRouteResponseOptions
+
+Interface which defines a REST route response.
+
+## Properties
+
+### attachment?
+
+> `optional` **attachment**: [`IRestRouteResponseAttachmentOptions`](IRestRouteResponseAttachmentOptions.md)
+
+Additional options that can be used to control the response.

package/docs/reference/interfaces/IServerHealthResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServerHealthResponse
+
+The health of the server.
+
+## Properties
+
+### body
+
+> **body**: [`IHealthInfo`](IHealthInfo.md)
+
+The information for the server.

package/docs/reference/interfaces/IServerInfo.md

@@ -0,0 +1,19 @@
+# Interface: IServerInfo
+
+The information about the server.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The application name.
+
+***
+
+### version
+
+> **version**: `string`
+
+The version of the server.

package/docs/reference/interfaces/IServerInfoResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServerInfoResponse
+
+The information about the server.
+
+## Properties
+
+### body
+
+> **body**: [`IServerInfo`](IServerInfo.md)
+
+The information for the server.

package/docs/reference/interfaces/IServerSpecResponse.md

@@ -0,0 +1,19 @@
+# Interface: IServerSpecResponse
+
+The OpenAPI spec for the endpoints.
+
+## Properties
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body?
+
+> `optional` **body**: `unknown`
+
+The spec for the server.

package/docs/reference/interfaces/ISocketRoute.md

@@ -0,0 +1,73 @@
+# Interface: ISocketRoute
+
+Interface which defines a socket route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Properties
+
+### operationId
+
+> **operationId**: `string`
+
+The id of the operation.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`operationId`](IBaseRoute.md#operationid)
+
+***
+
+### path
+
+> **path**: `string`
+
+The path to use for routing.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`path`](IBaseRoute.md#path)
+
+***
+
+### skipAuth?
+
+> `optional` **skipAuth**: `boolean`
+
+Skips the authentication for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
+
+***
+
+### handler()
+
+> **handler**: (`httpRequestContext`, `socketId`, `request`, `emitter`) => `Promise`\<`void`\>
+
+The handler module.
+
+#### Parameters
+
+• **httpRequestContext**: [`IHttpRequestContext`](IHttpRequestContext.md)
+
+The request context.
+
+• **socketId**: `string`
+
+The id of the socket the request is arriving on.
+
+• **request**: `unknown`
+
+The request object.
+
+• **emitter**
+
+Method to emit data on the socket.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/interfaces/ITag.md

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

package/docs/reference/interfaces/IUnauthorizedResponse.md

@@ -0,0 +1,19 @@
+# Interface: IUnauthorizedResponse
+
+You are not authorized to use the API or no credentials were supplied, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `401`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError`
+
+The body which contains the error.