Class BankDocumentService

Manage bank documents stored in S3

Hierarchy (View Summary)

BankDocumentQueryService
- BankDocumentService

Index

Constructors

Properties

s3Bucket s3Client

Methods

create delete get getDownloadUrl getStream listFolders search

Constructors

constructor

new BankDocumentService(
__namedParameters: { s3Bucket: string; s3Client: S3Client },
): BankDocumentService
Parameters
- __namedParameters: { s3Bucket: string; s3Client: S3Client }
Returns BankDocumentService
Inherited from BankDocumentQueryService.constructor
- Defined in packages/bank-services/src/BankDocumentService.ts:36

Properties

`Protected` `Readonly`s3Bucket

s3Bucket: string

`Protected` `Readonly`s3Client

s3Client: S3Client

Methods

create

create(
    __namedParameters: {
        bankId: string;
        contentType?: string;
        document: Buffer;
        fileName: string;
        folder?: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: BankDocument }>
Parameters
- __namedParameters: {
      bankId: string;
      contentType?: string;
      document: Buffer;
      fileName: string;
      folder?: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: BankDocument }>
- Defined in packages/bank-services/src/BankDocumentService.ts:222

delete

delete(
    __namedParameters: {
        bankId: string;
        key: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: void }>
Parameters
- __namedParameters: {
      bankId: string;
      key: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: void }>
- Defined in packages/bank-services/src/BankDocumentService.ts:260

get

get(
    __namedParameters: {
        bankId: string;
        fileName: string;
        folder?: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: BankDocument | null }>
Parameters
- __namedParameters: {
      bankId: string;
      fileName: string;
      folder?: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: BankDocument | null }>
Inherited from BankDocumentQueryService.get
- Defined in packages/bank-services/src/BankDocumentService.ts:47

getDownloadUrl

getDownloadUrl(
    __namedParameters: {
        bankId: string;
        fileName: string;
        folder?: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: string | null }>
Parameters
- __namedParameters: {
      bankId: string;
      fileName: string;
      folder?: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: string | null }>
Inherited from BankDocumentQueryService.getDownloadUrl
- Defined in packages/bank-services/src/BankDocumentService.ts:115

getStream

getStream(
    __namedParameters: {
        bankId: string;
        fileName: string;
        folder?: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: BankDocumentStream | null }>
Parameters
- __namedParameters: {
      bankId: string;
      fileName: string;
      folder?: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: BankDocumentStream | null }>
Inherited from BankDocumentQueryService.getStream
- Defined in packages/bank-services/src/BankDocumentService.ts:80

listFolders

listFolders(
    __namedParameters: {
        bankId: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: string[] }>
List folder names under the given type prefix for a bank.
Parameters
- __namedParameters: { bankId: string; type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS" }
Returns Promise<{ ok: true; value: string[] }>
Inherited from BankDocumentQueryService.listFolders
- Defined in packages/bank-services/src/BankDocumentService.ts:194

search

search(
    __namedParameters: {
        bankId: string;
        folder?: string;
        type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
    },
): Promise<{ ok: true; value: BankDocument[] }>
List files in a given folder (or root if no folder specified).
Parameters
- __namedParameters: {
      bankId: string;
      folder?: string;
      type: "CUSTOM" | "LOGO" | "PRICING_SCHEDULE" | "TERMS";
  }
Returns Promise<{ ok: true; value: BankDocument[] }>
Inherited from BankDocumentQueryService.search
- Defined in packages/bank-services/src/BankDocumentService.ts:153