@twin.org/api-tenant-processor 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/TenantAdminService.md

@@ -4,7 +4,7 @@ Service for performing email messaging operations to a connector.
 
 ## Implements
 
-- [`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md)
+- `ITenantAdminComponent`
 
 ## Constructors
 
@@ -56,7 +56,7 @@ The class name of the component.
 
 ### get()
 
-> **get**(`tenantId`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+> **get**(`tenantId`): `Promise`\<`ITenant`\>
 
 Get a tenant by its id.
 
@@ -70,19 +70,23 @@ The id of the tenant.
 
 #### Returns
 
-`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+`Promise`\<`ITenant`\>
 
-The tenant or undefined if not found.
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`get`](../interfaces/ITenantAdminComponent.md#get)
+`ITenantAdminComponent.get`
 
 ***
 
 ### getByApiKey()
 
-> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+> **getByApiKey**(`apiKey`): `Promise`\<`ITenant`\>
 
 Get a tenant by its api key.
 
@@ -96,39 +100,99 @@ The api key of the tenant.
 
 #### Returns
 
-`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+`Promise`\<`ITenant`\>
+
+The tenant.
+
+#### Throws
 
-The tenant or undefined if not found.
+Error if the tenant is not found.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`getByApiKey`](../interfaces/ITenantAdminComponent.md#getbyapikey)
+`ITenantAdminComponent.getByApiKey`
 
 ***
 
-### set()
+### getByPublicOrigin()
 
-> **set**(`tenant`): `Promise`\<`void`\>
+> **getByPublicOrigin**(`publicOrigin`): `Promise`\<`ITenant`\>
 
-Set a tenant.
+Get a tenant by its public origin.
+
+#### Parameters
+
+##### publicOrigin
+
+`string`
+
+The origin of the tenant.
+
+#### Returns
+
+`Promise`\<`ITenant`\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+#### Implementation of
+
+`ITenantAdminComponent.getByPublicOrigin`
+
+***
+
+### create()
+
+> **create**(`tenant`): `Promise`\<`string`\>
+
+Create a tenant.
 
 #### Parameters
 
 ##### tenant
 
-[`ITenant`](../interfaces/ITenant.md)
+`Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
 
 The tenant to store.
 
 #### Returns
 
+`Promise`\<`string`\>
+
+The tenant id.
+
+#### Implementation of
+
+`ITenantAdminComponent.create`
+
+***
+
+### update()
+
+> **update**(`tenant`): `Promise`\<`void`\>
+
+Update a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Partial`\<`Omit`\<`ITenant`, `"dateCreated"` \| `"dateModified"`\>\>
+
+The tenant to update.
+
+#### Returns
+
 `Promise`\<`void`\>
 
-Nothing.
+The nothing.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`set`](../interfaces/ITenantAdminComponent.md#set)
+`ITenantAdminComponent.update`
 
 ***
 
@@ -154,18 +218,28 @@ Nothing.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`remove`](../interfaces/ITenantAdminComponent.md#remove)
+`ITenantAdminComponent.remove`
 
 ***
 
 ### query()
 
-> **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
 
 Query tenants with pagination.
 
 #### Parameters
 
+##### options?
+
+Optional query options.
+
+###### isNodeTenant?
+
+`boolean`
+
+Whether to filter for node admin tenants.
+
 ##### cursor?
 
 `string`
@@ -180,10 +254,10 @@ The maximum number of tenants to return.
 
 #### Returns
 
-`Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+`Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
 
 The tenants and the next cursor if more tenants are available.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`query`](../interfaces/ITenantAdminComponent.md#query)
+`ITenantAdminComponent.query`

package/docs/reference/classes/TenantIdContextIdHandler.md

@@ -26,6 +26,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+The class name of the component.
+
+#### Returns
+
+`string`
+
+The class name.
+
+#### Implementation of
+
+`IContextIdHandler.className`
+
+***
+
 ### short()
 
 > **short**(`value`): `string`

package/docs/reference/functions/generateRestRoutesTenants.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesTenants()
+
+> **generateRestRoutesTenants**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for tenant management.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/tenantByApiKey.md

@@ -0,0 +1,31 @@
+# Function: tenantByApiKey()
+
+> **tenantByApiKey**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by api key.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByApiKeyRequest`](../interfaces/ITenantGetByApiKeyRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantById.md

@@ -0,0 +1,31 @@
+# Function: tenantById()
+
+> **tenantById**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by id.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByIdRequest`](../interfaces/ITenantGetByIdRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantByPublicOrigin.md

@@ -0,0 +1,31 @@
+# Function: tenantByPublicOrigin()
+
+> **tenantByPublicOrigin**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by public origin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByPublicOriginRequest`](../interfaces/ITenantGetByPublicOriginRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantCreate.md

@@ -0,0 +1,31 @@
+# Function: tenantCreate()
+
+> **tenantCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Create the tenant.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantCreateRequest`](../interfaces/ITenantCreateRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantList.md

@@ -0,0 +1,31 @@
+# Function: tenantList()
+
+> **tenantList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantListResponse`](../interfaces/ITenantListResponse.md)\>
+
+Get the list of tenants.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantListRequest`](../interfaces/ITenantListRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantListResponse`](../interfaces/ITenantListResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantRemove.md

@@ -0,0 +1,31 @@
+# Function: tenantRemove()
+
+> **tenantRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the tenant by id.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantRemoveRequest`](../interfaces/ITenantRemoveRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantUpdate.md

@@ -0,0 +1,31 @@
+# Function: tenantUpdate()
+
+> **tenantUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the tenant.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantUpdateRequest`](../interfaces/ITenantUpdateRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -10,13 +10,32 @@
 
 ## Interfaces
 
-- [ITenant](interfaces/ITenant.md)
-- [ITenantAdminComponent](interfaces/ITenantAdminComponent.md)
 - [ITenantAdminServiceConfig](interfaces/ITenantAdminServiceConfig.md)
 - [ITenantAdminServiceConstructorOptions](interfaces/ITenantAdminServiceConstructorOptions.md)
 - [ITenantProcessorConfig](interfaces/ITenantProcessorConfig.md)
 - [ITenantProcessorConstructorOptions](interfaces/ITenantProcessorConstructorOptions.md)
+- [ITenantCreateRequest](interfaces/ITenantCreateRequest.md)
+- [ITenantGetByApiKeyRequest](interfaces/ITenantGetByApiKeyRequest.md)
+- [ITenantGetByIdRequest](interfaces/ITenantGetByIdRequest.md)
+- [ITenantGetByPublicOriginRequest](interfaces/ITenantGetByPublicOriginRequest.md)
+- [ITenantGetResponse](interfaces/ITenantGetResponse.md)
+- [ITenantListRequest](interfaces/ITenantListRequest.md)
+- [ITenantListResponse](interfaces/ITenantListResponse.md)
+- [ITenantRemoveRequest](interfaces/ITenantRemoveRequest.md)
+- [ITenantUpdateRequest](interfaces/ITenantUpdateRequest.md)
+
+## Variables
+
+- [tagsTenants](variables/tagsTenants.md)
 
 ## Functions
 
 - [initSchema](functions/initSchema.md)
+- [generateRestRoutesTenants](functions/generateRestRoutesTenants.md)
+- [tenantList](functions/tenantList.md)
+- [tenantById](functions/tenantById.md)
+- [tenantByApiKey](functions/tenantByApiKey.md)
+- [tenantByPublicOrigin](functions/tenantByPublicOrigin.md)
+- [tenantRemove](functions/tenantRemove.md)
+- [tenantCreate](functions/tenantCreate.md)
+- [tenantUpdate](functions/tenantUpdate.md)

package/docs/reference/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the Tenant Admin Service constructor.
 
 The entity storage for the tenants.
 
-#### Default
-
-```ts
-tenant
-```
-
 ***
 
 ### config?

package/docs/reference/interfaces/ITenantCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantCreateRequest
+
+The tenant to create.
+
+## Properties
+
+### body
+
+> **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to create.
+
+#### Type Declaration
+
+##### id?
+
+> `optional` **id**: `string`

package/docs/reference/interfaces/ITenantGetByApiKeyRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByApiKeyRequest
+
+The tenant to get by API key.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### apiKey
+
+> **apiKey**: `string`
+
+The API key of the tenant to get.

package/docs/reference/interfaces/ITenantGetByIdRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByIdRequest
+
+The tenant to get by id.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to get.

package/docs/reference/interfaces/ITenantGetByPublicOriginRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByPublicOriginRequest
+
+The tenant to get by public origin.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### publicOrigin
+
+> **publicOrigin**: `string`
+
+The public origin of the tenant to get.

package/docs/reference/interfaces/ITenantGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: ITenantGetResponse
+
+The tenant get response.
+
+## Properties
+
+### body
+
+> **body**: `ITenant`
+
+The tenant.

package/docs/reference/interfaces/ITenantListRequest.md

@@ -0,0 +1,23 @@
+# Interface: ITenantListRequest
+
+The list of tenants.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get the next chunk of tenants.
+
+#### limit?
+
+> `optional` **limit**: `string`
+
+The number of tenants to return.

package/docs/reference/interfaces/ITenantListResponse.md

@@ -0,0 +1,23 @@
+# Interface: ITenantListResponse
+
+The list of tenants.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to include the cursor.
+
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
+***
+
+### body
+
+> **body**: `ITenant`[]
+
+The list of tenants.

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -9,9 +9,3 @@ Configuration for the tenant processor
 > `optional` **apiKeyName**: `string`
 
 The key to look for in the header or query params for the api key.
-
-#### Default
-
-```ts
-x-api-key
-```

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the Tenant Processor constructor.
 
 The entity storage for the tenants.
 
-#### Default
-
-```ts
-tenant
-```
-
 ***
 
 ### config?

package/docs/reference/interfaces/ITenantRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantRemoveRequest
+
+The tenant to remove by id.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to remove.