Skip to main content

IssuerDocuments

Workspace API

Workspace API / models/IssuerDocuments

models/IssuerDocuments

Interfaces​

IssuerDocument​

Defined in: models/IssuerDocuments.ts:5

Properties​

id​

id: string

Defined in: models/IssuerDocuments.ts:6

issuer_id​

issuer_id: string

Defined in: models/IssuerDocuments.ts:7

document_id​

document_id: string

Defined in: models/IssuerDocuments.ts:8

document_type​

document_type: string

Defined in: models/IssuerDocuments.ts:9

fiscal_year​

fiscal_year: Date | null

Defined in: models/IssuerDocuments.ts:10

issue_date​

issue_date: Date | null

Defined in: models/IssuerDocuments.ts:11

version​

version: string | null

Defined in: models/IssuerDocuments.ts:12

project_id​

project_id: string | null

Defined in: models/IssuerDocuments.ts:13

uploaded_at​

uploaded_at: Date

Defined in: models/IssuerDocuments.ts:14

uploaded_by​

uploaded_by: string | null

Defined in: models/IssuerDocuments.ts:15

created_at​

created_at: Date

Defined in: models/IssuerDocuments.ts:16

updated_at​

updated_at: Date

Defined in: models/IssuerDocuments.ts:17

CreateIssuerDocumentData​

Defined in: models/IssuerDocuments.ts:21

Properties​

issuerId​

issuerId: string

Defined in: models/IssuerDocuments.ts:22

documentId​

documentId: string

Defined in: models/IssuerDocuments.ts:23

documentType​

documentType: string

Defined in: models/IssuerDocuments.ts:24

fiscalYear?​

optional fiscalYear: string

Defined in: models/IssuerDocuments.ts:25

issueDate?​

optional issueDate: string

Defined in: models/IssuerDocuments.ts:26

version?​

optional version: string

Defined in: models/IssuerDocuments.ts:27

projectId?​

optional projectId: string

Defined in: models/IssuerDocuments.ts:28

UpdateIssuerDocumentData​

Defined in: models/IssuerDocuments.ts:31

Properties​

fiscalYear?​

optional fiscalYear: string

Defined in: models/IssuerDocuments.ts:32

issueDate?​

optional issueDate: string

Defined in: models/IssuerDocuments.ts:33

version?​

optional version: string

Defined in: models/IssuerDocuments.ts:34

projectId?​

optional projectId: string

Defined in: models/IssuerDocuments.ts:35

Functions​

createIssuerDocument()​

createIssuerDocument(data, userId, organizationId, log): Promise<IssuerDocument>

Defined in: models/IssuerDocuments.ts:42

Create a new issuer document linkage RLS enforcement: Validates that issuer belongs to user's organization

Parameters​

data​

CreateIssuerDocumentData

userId​

string

organizationId​

string

log​

Logger = logger

Returns​

Promise<IssuerDocument>

getIssuerDocumentByDocumentId()​

getIssuerDocumentByDocumentId(documentId, organizationId, log): Promise<IssuerDocument | null>

Defined in: models/IssuerDocuments.ts:116

Get issuer document by document_id RLS enforcement: Joins with issuers table to filter by organization_id Returns 404 if document not linked or belongs to different organization

Parameters​

documentId​

string

organizationId​

string

log​

Logger = logger

Returns​

Promise<IssuerDocument | null>

getIssuerDocumentById()​

getIssuerDocumentById(id, organizationId, log): Promise<IssuerDocument | null>

Defined in: models/IssuerDocuments.ts:153

Get issuer document by ID RLS enforcement: Joins with issuers table to filter by organization_id

Parameters​

id​

string

organizationId​

string

log​

Logger = logger

Returns​

Promise<IssuerDocument | null>

listIssuerDocuments()​

listIssuerDocuments(organizationId, log): Promise<IssuerDocument[]>

Defined in: models/IssuerDocuments.ts:186

List all issuer documents for an organization RLS enforcement: Joins with issuers table to filter by organization_id

Parameters​

organizationId​

string

log​

Logger = logger

Returns​

Promise<IssuerDocument[]>

updateIssuerDocument()​

updateIssuerDocument(id, data, organizationId, log): Promise<IssuerDocument>

Defined in: models/IssuerDocuments.ts:215

Update issuer document RLS enforcement: Validates that issuer belongs to user's organization

Parameters​

id​

string

data​

UpdateIssuerDocumentData

organizationId​

string

log​

Logger = logger

Returns​

Promise<IssuerDocument>

deleteIssuerDocument()​

deleteIssuerDocument(id, organizationId, log): Promise<void>

Defined in: models/IssuerDocuments.ts:256

Delete issuer document RLS enforcement: Validates that issuer belongs to user's organization

Parameters​

id​

string

organizationId​

string

log​

Logger = logger

Returns​

Promise<void>