Skip to content

ARC

Modules

@sourceloop/ctrl-plane-tenant-management-service / Exports

@sourceloop/ctrl-plane-tenant-management-service¶

Table of contents¶

Namespaces¶

TenantManagementServiceBindings

Enumerations¶

Classes¶

Interfaces¶

Type Aliases¶

Variables¶

Functions¶

Type Aliases¶

BaseUser¶

Ƭ BaseUser: Object

Type declaration¶

Name	Type
`id`	`string`

Defined in¶

services/tenant-management-service/src/types/index.ts:9

InvoiceWithRelations¶

Ƭ InvoiceWithRelations: Invoice & InvoiceRelations

Defined in¶

services/tenant-management-service/src/models/invoice.model.ts:96

LeadUser¶

Ƭ LeadUser: { email: string ; userTenantId: string } & BaseUser

Defined in¶

services/tenant-management-service/src/types/index.ts:13

LeadUserWithToken¶

Ƭ LeadUserWithToken: { token: string } & LeadUser

Defined in¶

services/tenant-management-service/src/types/index.ts:18

LeadWithRelations¶

Ƭ LeadWithRelations: Lead & LeadRelations

Defined in¶

services/tenant-management-service/src/models/lead.model.ts:78

ResourceData¶

Ƭ ResourceData: Object

Represents the data of a resource.

Type declaration¶

Name	Type
`externalIdentifier`	`string`
`metadata`	{ `bucket`: `string` ; `path`: `string` }
`metadata.bucket`	`string`
`metadata.path`	`string`
`type`	`BUCKET`

Defined in¶

services/tenant-management-service/src/types/resource.type.ts:4

ResourceProvisionedWebhookPayload¶

Ƭ ResourceProvisionedWebhookPayload: Object

Represents the payload for a resource provisioned webhook.

Type declaration¶

Name	Type	Description
`data`	{ `appPlaneUrl`: `string` ; `resources`: `AnyObject`[] ; `status`: `SUCCESS` \| `FAILURE` }	The data of the webhook.
`data.appPlaneUrl`	`string`	-
`data.resources`	`AnyObject`[]	-
`data.status`	`SUCCESS` \| `FAILURE`	-
`initiatorId`	`string`	The ID of the initiator.
`type`	`RESOURCES_PROVISIONED`	The type of the webhook.

Defined in¶

services/tenant-management-service/src/types/webhook-payload.type.ts:18

ResourceWithRelations¶

Ƭ ResourceWithRelations<T>: Resource<T> & ResourceRelations

Type parameters¶

Name	Type
`T`	extends `ResourceData`[`"metadata"`]

Defined in¶

services/tenant-management-service/src/models/resource.model.ts:68

SubscriptionCreationType¶

Ƭ SubscriptionCreationType: Omit<ISubscription, "id" | "deleted" | "deletedOn" | "deletedBy" | "createdOn" | "modifiedOn" | "createdBy" | "modifiedBy" | "plan">

Defined in¶

services/tenant-management-service/src/types/i-subscription.interface.ts:26

SubscriptionUpdationType¶

Ƭ SubscriptionUpdationType: Partial<Omit<ISubscription, "id" | "deleted" | "deletedOn" | "deletedBy" | "createdOn" | "modifiedOn" | "createdBy" | "modifiedBy" | "plan">>

Defined in¶

services/tenant-management-service/src/types/i-subscription.interface.ts:39

TenantWithRelations¶

Ƭ TenantWithRelations: Tenant & TenantRelations

Defined in¶

services/tenant-management-service/src/models/tenant.model.ts:108

WebhookConfig¶

Ƭ WebhookConfig: Object

Type declaration¶

Name	Type
`signatureHeaderName`	`string`
`timestampHeaderName`	`string`
`timestampTolerance`	`number`

Defined in¶

services/tenant-management-service/src/types/index.ts:26

WebhookPayload¶

Ƭ WebhookPayload: ResourceProvisionedWebhookPayload

Represents the payload for a webhook.

Defined in¶

services/tenant-management-service/src/types/webhook-payload.type.ts:13

WebhookRequest¶

Ƭ WebhookRequest: Object

Type declaration¶

Name	Type
`initiaterId`	`string`

Defined in¶

services/tenant-management-service/src/types/index.ts:22

Variables¶

EventConnectorBinding¶

• Const EventConnectorBinding: BindingKey<IEventConnector<unknown>>

Defined in¶

services/tenant-management-service/src/keys.ts:74

LEAD_TOKEN_VERIFIER¶

• Const LEAD_TOKEN_VERIFIER: BindingKey<BearerFn<LeadUser>>

Binding key for the lead token verifier.

Defined in¶

services/tenant-management-service/src/keys.ts:30

SYSTEM_USER¶

• Const SYSTEM_USER: BindingKey<IAuthUser & AnyObject>

Binding key for the system user.

Defined in¶

services/tenant-management-service/src/keys.ts:37

TenantManagementCacheSourceName¶

• Const TenantManagementCacheSourceName: "TenantManagementCacheDB"

Defined in¶

services/tenant-management-service/src/types/index.ts:34

TenantManagementDbSourceName¶

• Const TenantManagementDbSourceName: "TenantManagementDB"

Defined in¶

services/tenant-management-service/src/types/index.ts:32

WEBHOOK_CONFIG¶

• Const WEBHOOK_CONFIG: BindingKey<WebhookConfig>

Binding key for the webhook configuration.

Defined in¶

services/tenant-management-service/src/keys.ts:44

WEBHOOK_VERIFIER¶

• Const WEBHOOK_VERIFIER: BindingKey<Interceptor>

Binding key for the webhook verifier.

Defined in¶

services/tenant-management-service/src/keys.ts:50

WebhookHandlerEP¶

• Const WebhookHandlerEP: BindingKey<WebhookController<never>>

Binding key for the webhook handler extension point.

Defined in¶

services/tenant-management-service/src/keys.ts:57

WebhookNotificationService¶

• Const WebhookNotificationService: BindingKey<WebhookNotificationServiceType>

Defined in¶

services/tenant-management-service/src/keys.ts:69

Functions¶

asWebhookHandler¶

▸ asWebhookHandler(binding): void

Binding template for the webhook handler.

Parameters¶

Name	Type
`binding`	`Binding`<`unknown`>

Returns¶

void

Defined in¶

node_modules/@loopback/context/dist/binding.d.ts:202

webhookHandler¶

▸ webhookHandler(): ClassDecorator

Returns¶

ClassDecorator

Defined in¶

services/tenant-management-service/src/decorators/webhook-handler.decorator.ts:4