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

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,65 @@
+# 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.

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,209 @@
+# Interface: IRestRoute\<T, U\>
+
+Interface which defines a REST route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+### 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.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
+
+***
+
+### skipTenant? {#skiptenant}
+
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiredScope? {#requiredscope}
+
+> `optional` **requiredScope?**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+
+***
+
+### 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 scope to use it.
+
+#### 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.

package/docs/reference/interfaces/IRestRouteExample.md

@@ -0,0 +1,24 @@
+# Interface: IRestRouteExample
+
+Interface which defines a REST route example.
+
+## Extended by
+
+- [`IRestRouteRequestExample`](IRestRouteRequestExample.md)
+- [`IRestRouteResponseExample`](IRestRouteResponseExample.md)
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Example objects for the request.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+Description of the example.

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -0,0 +1,191 @@
+# Interface: IRestRouteProcessor
+
+The definition for a processor for handling REST routes.
+
+## Extends
+
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`IRestRoute`](IRestRoute.md)\>
+
+## Methods
+
+### features()? {#features}
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
+### pre()? {#pre}
+
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`pre`](IBaseRouteProcessor.md#pre)
+
+***
+
+### post()? {#post}
+
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`post`](IBaseRouteProcessor.md#post)
+
+***
+
+### process()? {#process}
+
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### processorState
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -0,0 +1,45 @@
+# Interface: IRestRouteRequestExample\<T\>
+
+Interface which defines a REST route request example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### request {#request}
+
+> **request**: `T`
+
+The example request object.

package/docs/reference/interfaces/IRestRouteResponseAttachmentOptions.md

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