@twin.org/api-models 0.0.2-next.1 → 0.0.2-next.11

package/docs/reference/interfaces/ISocketServerRequest.md

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

package/docs/reference/variables/AuthenticationGeneratorFactory.md

@@ -0,0 +1,5 @@
+# Variable: AuthenticationGeneratorFactory
+
+> `const` **AuthenticationGeneratorFactory**: `Factory`\<[`IAuthenticationGenerator`](../interfaces/IAuthenticationGenerator.md)\>
+
+Factory for creating implementation of authentication generator types.

package/docs/reference/variables/HealthStatus.md

@@ -4,7 +4,7 @@
 
 The health status of the component.
 
-## Type declaration
+## Type Declaration
 
 ### Ok
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.11",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",