Skip to content

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

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

Table of contents

Namespaces

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

ConfigureIdpFunc

Ƭ ConfigureIdpFunc<T>: (payload: IdpDetails) => Promise<T>

Type parameters

Name
T

Type declaration

▸ (payload): Promise<T>

Parameters
Name Type
payload IdpDetails
Returns

Promise<T>

Defined in

services/tenant-management-service/src/types/i-idp.interface.ts:9

InvoiceWithRelations

Ƭ InvoiceWithRelations: Invoice & InvoiceRelations

Defined in

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

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:27

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:40

TempUser

Ƭ TempUser: { tenantId?: string ; tenantType: string ; userTenantId: string } & IAuthUser

Defined in

services/tenant-management-service/src/interceptors/callback-verifier.interceptor.ts:96

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

CALLABCK_VERIFIER

• Const CALLABCK_VERIFIER: BindingKey<Interceptor>

Defined in

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

DEFAULT_SIGNATURE_HEADER

• Const DEFAULT_SIGNATURE_HEADER: "x-signature"

The default header for the signature.

Defined in

services/tenant-management-service/src/utils.ts:15

DEFAULT_TIMESTAMP_HEADER

• Const DEFAULT_TIMESTAMP_HEADER: "x-timestamp"

The default header for the timestamp.

Defined in

services/tenant-management-service/src/utils.ts:20

DEFAULT_TIMESTAMP_TOLERANCE

• Const DEFAULT_TIMESTAMP_TOLERANCE: 5000

The default tolerance for the timestamp.

Defined in

services/tenant-management-service/src/utils.ts:25

EventConnectorBinding

• Const EventConnectorBinding: BindingKey<IEventConnector<unknown>>

Defined in

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

FIVE_SECONDS

• Const FIVE_SECONDS: 5

Defined in

services/tenant-management-service/src/utils.ts:27

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:43

ONE_HOUR

• Const ONE_HOUR: number

Defined in

services/tenant-management-service/src/utils.ts:28

PermissionKey

• Const PermissionKey: Object

Type declaration

Name Type
CreateBillingCustomer string
CreateBillingInvoice string
CreateBillingPaymentSource string
CreateContact string
CreateInvoice string
CreateLead string
CreateNotification string
CreateNotificationTemplate string
CreateSubscription string
CreateTenant string
CreateTenantConfig string
DeleteBillingCustomer string
DeleteBillingInvoice string
DeleteBillingPaymentSource string
DeleteContact string
DeleteInvoice string
DeleteLead string
DeleteNotificationTemplate string
DeleteTenant string
DeleteTenantConfig string
GetBillingCustomer string
GetBillingInvoice string
GetBillingPaymentSource string
ProvisionTenant string
UpdateBillingCustomer string
UpdateBillingInvoice string
UpdateBillingPaymentSource string
UpdateContact string
UpdateInvoice string
UpdateLead string
UpdateNotificationTemplate string
UpdateSubscription string
UpdateTenant string
UpdateTenantConfig string
ViewContact string
ViewInvoice string
ViewLead string
ViewNotificationTemplate string
ViewPlan string
ViewSubscription string
ViewTenant string
ViewTenantConfig string

Defined in

services/tenant-management-service/src/permissions.ts:1

PostWebhookHandlerServiceKey

• Const PostWebhookHandlerServiceKey: BindingKey<IPostWebhookHandlerService<ResourceProvisionedWebhookPayload>>

Defined in

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

SYSTEM_USER

• Const SYSTEM_USER: BindingKey<IAuthUser & AnyObject>

Binding key for the system user.

Defined in

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

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:57

WEBHOOK_VERIFIER

• Const WEBHOOK_VERIFIER: BindingKey<Interceptor>

Binding key for the webhook verifier.

Defined in

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

WebhookHandlerEP

• Const WebhookHandlerEP: BindingKey<unknown>

Binding key for the webhook handler extension point.

Defined in

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

WebhookNotificationService

• Const WebhookNotificationService: BindingKey<WebhookNotificationServiceType>

Defined in

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

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

hasAnyOf

▸ hasAnyOf<T>(ob, keys): boolean

Type parameters

Name
T

Parameters

Name Type
ob T
keys keyof T[]

Returns

boolean

Defined in

services/tenant-management-service/src/utils.ts:39

numericEnumValues

▸ numericEnumValues(enumType): number[]

Returns the numeric values of an enum.

Parameters

Name Type Description
enumType Object The enum to get the numeric values from.

Returns

number[]

The numeric values of the enum.

Defined in

services/tenant-management-service/src/utils.ts:6

weakEqual

▸ weakEqual<T>(value1, value2): boolean

Type parameters

Name
T

Parameters

Name Type
value1 undefined | null | T
value2 undefined | null | T

Returns

boolean

Defined in

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

webhookHandler

▸ webhookHandler(): ClassDecorator

Returns

ClassDecorator

Defined in

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