Class EntityDocumentQueryService

Read-only access to entity documents

Hierarchy (View Summary)

EntityDocumentQueryService
- EntityDocumentService

Index

Constructors

constructor

new EntityDocumentQueryService(
    __namedParameters: {
        s3Bucket: string;
        s3Client: S3Client;
        sqlClient: Pool;
    },
): EntityDocumentQueryService
Parameters
- __namedParameters: { s3Bucket: string; s3Client: S3Client; sqlClient: Pool }
Returns EntityDocumentQueryService
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:41

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

`Protected` `Readonly`s3Bucket

s3Bucket: string

`Protected` `Readonly`s3Client

s3Client: S3Client

Methods

get

get(
__namedParameters: { customerId: string; entityId: string; id: string },
): Promise<{ ok: true; value: EntityDocument | null }>
Parameters
- __namedParameters: { customerId: string; entityId: string; id: string }
Returns Promise<{ ok: true; value: EntityDocument | null }>
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:56

getDownloadUrl

getDownloadUrl(
    __namedParameters: {
        customerId: string;
        disposition?: "attachment" | "inline";
        entityId: string;
        id: string;
    },
): Promise<{ ok: true; value: string | null }>
Parameters
- __namedParameters: {
      customerId: string;
      disposition?: "attachment" | "inline";
      entityId: string;
      id: string;
  }
  - customerId: string
  - Optionaldisposition?: "attachment" | "inline"
    
    attachment (the default) forces a download — the dashboards' download buttons depend on it, because they click a programmatic anchor and would otherwise navigate the panel away to a raw S3 URL. inline lets a browser render the bytes in place, for the document viewer.
  - entityId: string
  - id: string
Returns Promise<{ ok: true; value: string | null }>
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:110

search

search(
    __namedParameters: {
        customerId: string;
        entityId: string;
        page?: number;
        pageSize?: number;
        statuses?: ("ACTIVE" | "DELETED")[];
        types?: (
            | "ADDRESS_PROOF_DOCUMENT"
            | "AML_POLICY"
            | "ANTI_BRIBERY_POLICY"
            | "ARTICLES_OF_INCORPORATION"
            | "AUDITED_ACCOUNTS"
            | "BALANCE_SHEET"
            | "BANK_ACCOUNT_DETAILS"
            | "BANK_STATEMENT_DOCUMENT"
            | "BUSINESS_REGISTRATION_DOCUMENT"
            | "CAC_CERTIFICATE"
            | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
            | "CHAMBER_OF_COMMERCE_CERTIFICATE"
            | "COMPANY_CONSTITUTION"
            | "COMPANY_PROFILE"
            | "CORPORATE_CHART"
            | "DATA_PROTECTION_POLICY"
            | "DIRECTORS_REGISTRY"
            | "DRIVER_LICENSE"
            | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
            | "FRAUD_CHECK_DOCUMENT"
            | "ID_CARD"
            | "INVOICE"
            | "MEMORANDUM_OF_ASSOCIATION"
            | "NATIONAL_ID"
            | "OPERATING_LICENSE_DOCUMENT"
            | "OTHER"
            | "PARTNERSHIP_DEED"
            | "PASSPORT"
            | "PEP_FORM"
            | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
            | "RESIDENT_CARD"
            | "SHAREHOLDERS_REGISTRY"
            | "SOURCE_OF_FUNDS_DOCUMENT"
            | "TAX_CERTIFICATE"
            | "USER_SELFIE"
            | "USER_SELFIE_VIDEO"
            | "VISA_DOCUMENT"
            | "VOTER_ID_CARD"
        )[];
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: EntityDocument[]; total: number };
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      page?: number;
      pageSize?: number;
      statuses?: ("ACTIVE" | "DELETED")[];
      types?: (
          | "ADDRESS_PROOF_DOCUMENT"
          | "AML_POLICY"
          | "ANTI_BRIBERY_POLICY"
          | "ARTICLES_OF_INCORPORATION"
          | "AUDITED_ACCOUNTS"
          | "BALANCE_SHEET"
          | "BANK_ACCOUNT_DETAILS"
          | "BANK_STATEMENT_DOCUMENT"
          | "BUSINESS_REGISTRATION_DOCUMENT"
          | "CAC_CERTIFICATE"
          | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
          | "CHAMBER_OF_COMMERCE_CERTIFICATE"
          | "COMPANY_CONSTITUTION"
          | "COMPANY_PROFILE"
          | "CORPORATE_CHART"
          | "DATA_PROTECTION_POLICY"
          | "DIRECTORS_REGISTRY"
          | "DRIVER_LICENSE"
          | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
          | "FRAUD_CHECK_DOCUMENT"
          | "ID_CARD"
          | "INVOICE"
          | "MEMORANDUM_OF_ASSOCIATION"
          | "NATIONAL_ID"
          | "OPERATING_LICENSE_DOCUMENT"
          | "OTHER"
          | "PARTNERSHIP_DEED"
          | "PASSPORT"
          | "PEP_FORM"
          | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
          | "RESIDENT_CARD"
          | "SHAREHOLDERS_REGISTRY"
          | "SOURCE_OF_FUNDS_DOCUMENT"
          | "TAX_CERTIFICATE"
          | "USER_SELFIE"
          | "USER_SELFIE_VIDEO"
          | "VISA_DOCUMENT"
          | "VOTER_ID_CARD"
      )[];
  }
  - customerId: string
  - entityId: string
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 50
  - Optionalstatuses?: ("ACTIVE" | "DELETED")[]
  - Optionaltypes?: (
        | "ADDRESS_PROOF_DOCUMENT"
        | "AML_POLICY"
        | "ANTI_BRIBERY_POLICY"
        | "ARTICLES_OF_INCORPORATION"
        | "AUDITED_ACCOUNTS"
        | "BALANCE_SHEET"
        | "BANK_ACCOUNT_DETAILS"
        | "BANK_STATEMENT_DOCUMENT"
        | "BUSINESS_REGISTRATION_DOCUMENT"
        | "CAC_CERTIFICATE"
        | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
        | "CHAMBER_OF_COMMERCE_CERTIFICATE"
        | "COMPANY_CONSTITUTION"
        | "COMPANY_PROFILE"
        | "CORPORATE_CHART"
        | "DATA_PROTECTION_POLICY"
        | "DIRECTORS_REGISTRY"
        | "DRIVER_LICENSE"
        | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
        | "FRAUD_CHECK_DOCUMENT"
        | "ID_CARD"
        | "INVOICE"
        | "MEMORANDUM_OF_ASSOCIATION"
        | "NATIONAL_ID"
        | "OPERATING_LICENSE_DOCUMENT"
        | "OTHER"
        | "PARTNERSHIP_DEED"
        | "PASSPORT"
        | "PEP_FORM"
        | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
        | "RESIDENT_CARD"
        | "SHAREHOLDERS_REGISTRY"
        | "SOURCE_OF_FUNDS_DOCUMENT"
        | "TAX_CERTIFICATE"
        | "USER_SELFIE"
        | "USER_SELFIE_VIDEO"
        | "VISA_DOCUMENT"
        | "VOTER_ID_CARD"
    )[]
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: EntityDocument[]; total: number };
    },
>
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:143

Class EntityDocumentQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityDocumentQueryService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Protected` `Readonly`s3Bucket

`Protected` `Readonly`s3Client

Methods

get

Parameters

Returns Promise<{ ok: true; value: EntityDocument | null }>

getDownloadUrl

Parameters

customerId: string

`Optional`disposition?: "attachment" | "inline"

entityId: string

id: string

Returns Promise<{ ok: true; value: string | null }>

search

Parameters

customerId: string

entityId: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`statuses?: ("ACTIVE" | "DELETED")[]

Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: EntityDocument[]; total: number };
    },
>

Settings

On This Page

Class EntityDocumentQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityDocumentQueryService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Protected Readonlys3Bucket

Protected Readonlys3Client

Methods

get

Parameters

Returns Promise<{ ok: true; value: EntityDocument | null }>

getDownloadUrl

Parameters

customerId: string

Optionaldisposition?: "attachment" | "inline"

entityId: string

id: string

Returns Promise<{ ok: true; value: string | null }>

search

Parameters

customerId: string

entityId: string

Optionalpage?: number

OptionalpageSize?: number

Optionalstatuses?: ("ACTIVE" | "DELETED")[]

Returns Promise< { ok: true; value: { hasNext: boolean; items: EntityDocument[]; total: number }; },>

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Protected` `Readonly`s3Bucket

`Protected` `Readonly`s3Client

`Optional`disposition?: "attachment" | "inline"

`Optional`page?: number

`Optional`pageSize?: number

`Optional`statuses?: ("ACTIVE" | "DELETED")[]

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: EntityDocument[]; total: number };
},
>