Skip to main content

rules

@adamondo/backend

@adamondo/backend / core/documentApproval/rules

core/documentApproval/rules

Type Aliases​

DocumentReadinessSummary​

DocumentReadinessSummary = object

Defined in: src/core/documentApproval/rules.ts:65

Properties​

ready​

ready: boolean

Defined in: src/core/documentApproval/rules.ts:66

missing​

missing: DocumentType[]

Defined in: src/core/documentApproval/rules.ts:67

pendingReview​

pendingReview: DocumentType[]

Defined in: src/core/documentApproval/rules.ts:68

needsFix​

needsFix: DocumentType[]

Defined in: src/core/documentApproval/rules.ts:69

Variables​

REQUIRED_USER_DOCUMENTS​

const REQUIRED_USER_DOCUMENTS: DocumentType[]

Defined in: src/core/documentApproval/rules.ts:21

REQUIRED_LISTING_DOCUMENTS​

const REQUIRED_LISTING_DOCUMENTS: DocumentType[]

Defined in: src/core/documentApproval/rules.ts:25

Functions​

normalizeDocumentScope()​

normalizeDocumentScope(value?): DocumentScope

Defined in: src/core/documentApproval/rules.ts:31

Parameters​

value?​

string | null

Returns​

DocumentScope

normalizeDocumentType()​

normalizeDocumentType(value?): DocumentType

Defined in: src/core/documentApproval/rules.ts:36

Parameters​

value?​

string | null

Returns​

DocumentType

getUserBookingReadiness()​

getUserBookingReadiness(userId): Promise<DocumentReadinessSummary>

Defined in: src/core/documentApproval/rules.ts:109

Parameters​

userId​

string

Returns​

Promise<DocumentReadinessSummary>

getListingPublishReadiness()​

getListingPublishReadiness(userId, listId): Promise<DocumentReadinessSummary>

Defined in: src/core/documentApproval/rules.ts:123

Parameters​

userId​

string

listId​

number

Returns​

Promise<DocumentReadinessSummary>

getScopeRequiredDocuments()​

getScopeRequiredDocuments(scope): DocumentType[]

Defined in: src/core/documentApproval/rules.ts:139

Parameters​

scope​

DocumentScope

Returns​

DocumentType[]

isDocumentTypeAllowedForScope()​

isDocumentTypeAllowedForScope(scope, type): boolean

Defined in: src/core/documentApproval/rules.ts:149

Parameters​

scope​

DocumentScope

type​

DocumentType

Returns​

boolean