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

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}
+
+> **statusCode**: `500`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -0,0 +1,43 @@
+# Interface: IMimeTypeProcessor
+
+The definition for a handler for a specific MIME type.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### getTypes() {#gettypes}
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+***
+
+### handle() {#handle}
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+##### body
+
+`Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.

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? {#headers}
+
+> `optional` **headers?**: `undefined`
+
+Incoming Http Headers.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`headers`](IHttpRequest.md#headers)
+
+***
+
+### pathParams? {#pathparams}
+
+> `optional` **pathParams?**: `undefined`
+
+The path parameters.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`pathParams`](IHttpRequest.md#pathparams)
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `undefined`
+
+The query parameters.
+
+#### Overrides
+
+[`IHttpRequest`](IHttpRequest.md).[`query`](IHttpRequest.md#query)
+
+***
+
+### body? {#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}
+
+> **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}
+
+> **statusCode**: `404`
+
+Response status code.
+
+***
+
+### body {#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/INotImplementedResponse.md

@@ -0,0 +1,19 @@
+# Interface: INotImplementedResponse
+
+The operation that you tried to perform is not implemented, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `501`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IOkResponse.md

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

package/docs/reference/interfaces/IPlatformComponent.md

@@ -0,0 +1,139 @@
+# Interface: IPlatformComponent
+
+Interface for the platform component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### isMultiTenant() {#ismultitenant}
+
+> **isMultiTenant**(): `boolean`
+
+Indicates whether the component is running in a multi-tenant environment.
+
+#### Returns
+
+`boolean`
+
+True if the component is running in a multi-tenant environment, false otherwise.
+
+***
+
+### execute() {#execute}
+
+> **execute**(`method`): `Promise`\<`void`\>
+
+Execute a method, if single tenant will run once, if multi-tenant will run for each tenant.
+
+#### Parameters
+
+##### method
+
+() => `Promise`\<`void`\> \| `Promise`\<`boolean` \| `undefined`\>
+
+The method to run for each tenant, returning false will stop any further iterations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the method has been executed for all applicable tenants.
+
+***
+
+### getLocalOriginContext() {#getlocalorigincontext}
+
+> **getLocalOriginContext**(`url`): `Promise`\<`IContextIds` \| `undefined`\>
+
+Get the local origin context IDs for the given URL.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to check.
+
+#### Returns
+
+`Promise`\<`IContextIds` \| `undefined`\>
+
+A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.
+
+***
+
+### registerTenantEventCallback() {#registertenanteventcallback}
+
+> **registerTenantEventCallback**(`callbackId`, `callback`): `void`
+
+Registers a callback to be invoked when a tenant event occurs.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+A unique identifier for the callback.
+
+##### callback
+
+[`TenantEventCallback`](../type-aliases/TenantEventCallback.md)
+
+The callback to invoke when a tenant event occurs.
+
+#### Returns
+
+`void`
+
+***
+
+### unregisterTenantEventCallback() {#unregistertenanteventcallback}
+
+> **unregisterTenantEventCallback**(`callbackId`): `void`
+
+Unregisters a previously registered tenant event callback.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+The identifier of the callback to unregister.
+
+#### Returns
+
+`void`
+
+***
+
+### fireTenantEvent() {#firetenantevent}
+
+> **fireTenantEvent**(`tenantId`, `eventType`): `Promise`\<`void`\>
+
+Fires all registered tenant event callbacks.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The ID of the tenant for which the event occurred.
+
+##### eventType
+
+[`TenantEventType`](../type-aliases/TenantEventType.md)
+
+The type of event that occurred.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all callbacks have been invoked.

package/docs/reference/interfaces/IRestClientProcessor.md

@@ -0,0 +1,69 @@
+# Interface: IRestClientProcessor
+
+A processor that participates in an outbound REST request.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### pre()? {#pre}
+
+> `optional` **pre**(`context`, `next`): `Promise`\<`Response`\>
+
+Run the processor before the fetch takes place.
+
+#### Parameters
+
+##### context
+
+[`IRestClientProcessorContext`](IRestClientProcessorContext.md)
+
+The details of the request being made.
+
+##### next
+
+() => `Promise`\<`Response`\>
+
+Performs the request, or calls the next processor in the chain.
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+The result of next.
+
+***
+
+### post()? {#post}
+
+> `optional` **post**(`context`, `response`, `next`): `Promise`\<`Response`\>
+
+Run the processor after the fetch completes.
+
+#### Parameters
+
+##### context
+
+[`IRestClientProcessorContext`](IRestClientProcessorContext.md)
+
+The details of the request that was made.
+
+##### response
+
+`Response`
+
+The response from the request.
+
+##### next
+
+() => `Promise`\<`Response`\>
+
+Performs the post processing, or calls the next processor in the chain.
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+The result of next.

package/docs/reference/interfaces/IRestClientProcessorContext.md

@@ -0,0 +1,75 @@
+# Interface: IRestClientProcessorContext
+
+The context of a rest client processor.
+
+## Properties
+
+### restClientClassName {#restclientclassname}
+
+> **restClientClassName**: `string`
+
+The name of the REST client making the request.
+
+***
+
+### baseUrl {#baseurl}
+
+> **baseUrl**: `string`
+
+The base URL of the request.
+
+***
+
+### routeTemplate {#routetemplate}
+
+> **routeTemplate**: `string`
+
+The route template before path parameter substitution.
+
+***
+
+### route {#route}
+
+> **route**: `string`
+
+The route being requested.
+
+***
+
+### method {#method}
+
+> **method**: `HttpMethod`
+
+The HTTP method of the request.
+
+***
+
+### headers {#headers}
+
+> **headers**: `IHttpHeaders`
+
+The headers being sent with the request.
+
+***
+
+### timeout? {#timeout}
+
+> `optional` **timeout?**: `number`
+
+The timeout for the request in milliseconds.
+
+***
+
+### includeCredentials? {#includecredentials}
+
+> `optional` **includeCredentials?**: `boolean`
+
+Whether to include credentials in the request.
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `string`
+
+The request being made.

package/docs/reference/interfaces/IRestRoute.md

@@ -0,0 +1,245 @@
+# Interface: IRestRoute\<T, U\>
+
+Interface which defines a REST route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Type Parameters
+
+### T {#t}
+
+`T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+### U {#u}
+
+`U` *extends* [`IHttpResponse`](IHttpResponse.md) & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.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)
+
+***
+
+### summary {#summary}
+
+> **summary**: `string`
+
+Summary of what task the operation performs.
+
+***
+
+### tag {#tag}
+
+> **tag**: `string`
+
+Tag for the operation.
+
+***
+
+### method {#method}
+
+> **method**: `HttpMethod`
+
+The http method.
+
+***
+
+### handler {#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? {#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?**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
+
+Example objects for the request.
+
+***
+
+### responseType? {#responsetype}
+
+> `optional` **responseType?**: `object`[]
+
+The type of the response object.
+
+#### type
+
+> **type**: `string`
+
+The object type of the response.
+
+#### mimeType?
+
+> `optional` **mimeType?**: `string`
+
+The mime type of the response, defaults to "application/json" if there is a body.
+
+#### examples?
+
+> `optional` **examples?**: [`IRestRouteResponseExample`](IRestRouteResponseExample.md)\<`U`\>[]
+
+Example objects of the response.
+
+***
+
+### excludeFromSpec? {#excludefromspec}
+
+> `optional` **excludeFromSpec?**: `boolean`
+
+Exclude the route from being included in the spec file.
+
+***
+
+### bodyLimit? {#bodylimit}
+
+> `optional` **bodyLimit?**: `string`
+
+The name of the body size limit to apply to the route, only used by methods that carry a body.
+If not provided, the default body size limit will be used. The body size limits are defined in the web server options.