@dalmore/api-contracts 0.0.0-dev.9d42e16 → 0.0.0-dev.a0429a1

package/common/types/file.types.d.ts

@@ -0,0 +1,425 @@
+import { z } from 'zod';
+import { ComplianceReview, FileStatus } from './common.types';
+export declare const allowedFileExtension: string[];
+export declare enum ADFFileProcessingPipeline {
+    NONE = "NONE",
+    SUBDOCS_PHOENIX = "SUBDOCS_PHOENIX",
+    SUBDOCS_GENERAL = "SUBDOCS_GENERAL",
+    AIC_TAX_RETURNS = "AIC_TAX_RETURNS",
+    AIC_ACCOUNT_STATEMENTS = "AIC_ACCOUNT_STATEMENTS",
+    PAY_STUBS = "PAY_STUBS"
+}
+/**
+ * BoldSign brand logo supported file extensions
+ * @see https://developers.boldsign.com/branding/create-brand/?region=us
+ */
+export declare const boldSignAllowedFileExtension: string[];
+export declare const maxFileSize: number;
+export declare const fileIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const FileZod: any;
+export type FileZod = z.infer<typeof FileZod>;
+export declare const LinkFileZod: z.ZodObject<{
+    targetId: z.ZodEffects<z.ZodString, string, string>;
+    label: z.ZodOptional<z.ZodEnum<[string, ...string[]]>>;
+    category: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    targetId: string;
+    category?: string | undefined;
+    label?: string | undefined;
+}, {
+    targetId: string;
+    category?: string | undefined;
+    label?: string | undefined;
+}>;
+export type LinkFileZod = z.infer<typeof LinkFileZod>;
+export declare const IPaginatedFile: z.ZodObject<{
+    items: z.ZodArray<any, "many">;
+    meta: z.ZodObject<{
+        itemCount: z.ZodNumber;
+        totalItems: z.ZodOptional<z.ZodNumber>;
+        itemsPerPage: z.ZodNumber;
+        totalPages: z.ZodOptional<z.ZodNumber>;
+        currentPage: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    items: any[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: any[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;
+export type IPaginatedFile = z.infer<typeof IPaginatedFile>;
+export declare const PatchFile: z.ZodObject<{
+    name: z.ZodString;
+    category: z.ZodString;
+    label: z.ZodEnum<[string, ...string[]]>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, {
+        user_defined_data: any;
+        expected: any;
+    } | null, string>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    category: string;
+    label: string;
+    metadata?: {
+        user_defined_data: any;
+        expected: any;
+    } | null | undefined;
+}, {
+    name: string;
+    category: string;
+    label: string;
+    metadata?: string | null | undefined;
+}>;
+export type PatchFile = z.infer<typeof PatchFile>;
+export declare const PostFileQueryParams: z.ZodObject<{
+    name: z.ZodString;
+    category: z.ZodString;
+    label: z.ZodEnum<[string, ...string[]]>;
+    targetId: z.ZodEffects<z.ZodString, string, string>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, {
+        user_defined_data: any;
+        expected: any;
+    } | null, string>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    targetId: string;
+    category: string;
+    label: string;
+    metadata?: {
+        user_defined_data: any;
+        expected: any;
+    } | null | undefined;
+}, {
+    name: string;
+    targetId: string;
+    category: string;
+    label: string;
+    metadata?: string | null | undefined;
+}>;
+export type PostFileQueryParams = z.infer<typeof PostFileQueryParams>;
+/**
+ * CLIENT portal specific schema for file uploads
+ * Only allows INDIVIDUALS and TRADES as target for file uploads
+ */
+export declare const ClientPostFileQueryParams: z.ZodObject<{
+    name: z.ZodString;
+    category: z.ZodString;
+    label: z.ZodEnum<[string, ...string[]]>;
+    targetId: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, {
+        user_defined_data: any;
+        expected: any;
+    } | null, string>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    targetId: string;
+    category: string;
+    label: string;
+    metadata?: {
+        user_defined_data: any;
+        expected: any;
+    } | null | undefined;
+}, {
+    name: string;
+    targetId: string;
+    category: string;
+    label: string;
+    metadata?: string | null | undefined;
+}>;
+export type ClientPostFileQueryParams = z.infer<typeof ClientPostFileQueryParams>;
+export declare const FileFilters: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    targetId: z.ZodOptional<z.ZodString>;
+    fileType: z.ZodOptional<z.ZodString>;
+    targetTable: z.ZodOptional<z.ZodEnum<["KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS", ...("KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS")[]]>>;
+    includeLinkedFrom: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>, boolean, string | undefined>;
+}, "strip", z.ZodTypeAny, {
+    includeLinkedFrom: boolean;
+    name?: string | undefined;
+    targetId?: string | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+    fileType?: string | undefined;
+    category?: string | undefined;
+    label?: string | undefined;
+}, {
+    name?: string | undefined;
+    targetId?: string | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+    fileType?: string | undefined;
+    category?: string | undefined;
+    label?: string | undefined;
+    includeLinkedFrom?: string | undefined;
+}>;
+export declare const filesInclude: z.ZodEnum<["user", "account"]>;
+/**
+ * @description Query parameters for including related entities
+ * @xample in contract us as -> query: z.object({}).merge(AccountsIncludeQuery),
+ */
+export declare const FilesIncludeQuery: z.ZodObject<{
+    include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+    targetTable: z.ZodOptional<z.ZodEnum<["KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS", ...("KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS")[]]>>;
+    targetId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+}, "strip", z.ZodTypeAny, {
+    include: string[];
+    targetId?: string | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+}, {
+    include?: string | undefined;
+    targetId?: string | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+}>;
+export interface FilesIncludeQuery extends z.infer<typeof FilesIncludeQuery> {
+}
+export declare const ComplianceFilesIncludeQuery: z.ZodObject<{
+    include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+    targetTable: z.ZodOptional<z.ZodEnum<["KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS", ...("KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS")[]]>>;
+    targetId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+    status: z.ZodOptional<z.ZodNativeEnum<typeof FileStatus>>;
+    label: z.ZodOptional<z.ZodNativeEnum<{
+        readonly TRADE_DOCUMENT: import("./common.types").TradeFileLables.TRADE_DOCUMENT;
+        readonly IDENTITY_FRONT: import("./common.types").IdentityFileLabels.IDENTITY_FRONT;
+        readonly IDENTITY_BACK: import("./common.types").IdentityFileLabels.IDENTITY_BACK;
+        readonly PASSPORT: import("./common.types").IdentityFileLabels.PASSPORT;
+        readonly SS4_LETTER: import("./common.types").IssuerFileLabels.SS4_LETTER;
+        readonly FORMATION_DOCUMENT: import("./common.types").IssuerFileLabels.FORMATION_DOCUMENT;
+        readonly COVER_ART: import("./common.types").IssuerFileLabels.COVER_ART;
+        readonly MEMORANDUM: import("./common.types").OfferingFileLabels.MEMORANDUM;
+        readonly SUBSCRIPTION_AGREEMENT: import("./common.types").OfferingFileLabels.SUBSCRIPTION_AGREEMENT;
+        readonly ESCROW_AGREEMENT: import("./common.types").OfferingFileLabels.ESCROW_AGREEMENT;
+        readonly LOGO: import("./common.types").SiteBrandingFileLabels.LOGO;
+        readonly FAVICON: import("./common.types").SiteBrandingFileLabels.FAVICON;
+        readonly BACKGROUND_IMAGE: import("./common.types").SiteBrandingFileLabels.BACKGROUND_IMAGE;
+        readonly CUSTODIAN_INSTRUCTION_DOCUMENT: import("./common.types").RetirementFileLabels.CUSTODIAN_INSTRUCTION_DOCUMENT;
+        readonly OTHER: import("./common.types").OtherFileLabels.OTHER;
+        readonly COMPLIANCE_REQUEST: import("./common.types").OtherFileLabels.COMPLIANCE_REQUEST;
+        readonly SUB_DOC: import("./common.types").OtherFileLabels.SUB_DOC;
+        readonly CONTENT_FILE: import("./common.types").OtherFileLabels.CONTENT_FILE;
+        readonly CSV_EXPORT_FILE: import("./common.types").OtherFileLabels.CSV_EXPORT_FILE;
+        readonly BAD_ACTOR_REPORT_FILE: import("./common.types").CoveredPersonFileLabels.BAD_ACTOR_REPORT_FILE;
+        readonly PROOF_OF_INCOME: import("./common.types").AccreditationFileLabels.PROOF_OF_INCOME;
+        readonly PROOF_OF_NET_WORTH: import("./common.types").AccreditationFileLabels.PROOF_OF_NET_WORTH;
+        readonly EMPLOYEE: import("./common.types").AccreditationFileLabels.EMPLOYEE;
+        readonly TAX_RETURNS: import("./common.types").AccreditationFileLabels.TAX_RETURNS;
+        readonly ACCOUNT_STATEMENT: import("./common.types").AccreditationFileLabels.ACCOUNT_STATEMENT;
+        readonly ACCREDITATION_LETTER: import("./common.types").AccreditationFileLabels.ACCREDITATION_LETTER;
+        readonly LICENSE: import("./common.types").AccreditationFileLabels.LICENSE;
+    }>>;
+    accountId: z.ZodOptional<z.ZodString>;
+    complianceReview: z.ZodOptional<z.ZodNativeEnum<typeof ComplianceReview>>;
+    pipeline: z.ZodOptional<z.ZodNativeEnum<typeof ADFFileProcessingPipeline>>;
+}, "strip", z.ZodTypeAny, {
+    include: string[];
+    targetId: string[];
+    status?: FileStatus | undefined;
+    accountId?: string | undefined;
+    complianceReview?: ComplianceReview | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+    label?: import("./common.types").AccreditationFileLabels | import("./common.types").CoveredPersonFileLabels.BAD_ACTOR_REPORT_FILE | import("./common.types").OtherFileLabels | import("./common.types").RetirementFileLabels | import("./common.types").SiteBrandingFileLabels | import("./common.types").OfferingFileLabels.MEMORANDUM | import("./common.types").OfferingFileLabels.SUBSCRIPTION_AGREEMENT | import("./common.types").OfferingFileLabels.ESCROW_AGREEMENT | import("./common.types").IssuerFileLabels | import("./common.types").IdentityFileLabels | import("./common.types").TradeFileLables | undefined;
+    pipeline?: ADFFileProcessingPipeline | undefined;
+}, {
+    status?: FileStatus | undefined;
+    accountId?: string | undefined;
+    complianceReview?: ComplianceReview | undefined;
+    include?: string | undefined;
+    targetId?: string | undefined;
+    targetTable?: "KYCS" | "AMLS" | "AICS" | "KYBS" | "INDIVIDUALS" | "LEGAL_ENTITIES" | "INVESTOR_ACCOUNTS" | "TRADES" | "OFFERINGS" | "ISSUERS" | "COVERED_PERSONS" | "PAYMENT_METHODS" | "NOTES" | "USERS" | "ACCOUNTS" | "PAGES" | "TASKS" | "FILES" | "DATA_RECORD_FILES" | "ASSETS" | "SITES" | "PAGE_REVISIONS" | "TRADE_LINE_ITEMS" | "TRANSACTIONS" | "DISBURSEMENTS" | "DISBURSEMENT_REVIEWS" | "ISSUER_PAYMENT_METHODS" | "SIGNER_BRANDS" | "THEMES" | "THEME_SETTINGS" | "CAP_TABLES" | "CAP_TABLE_SHARE_CLASSES" | "CAP_TABLE_ENTRIES" | "EMAIL_THEMES" | "EMAIL_THEME_SETTINGS" | undefined;
+    label?: import("./common.types").AccreditationFileLabels | import("./common.types").CoveredPersonFileLabels.BAD_ACTOR_REPORT_FILE | import("./common.types").OtherFileLabels | import("./common.types").RetirementFileLabels | import("./common.types").SiteBrandingFileLabels | import("./common.types").OfferingFileLabels.MEMORANDUM | import("./common.types").OfferingFileLabels.SUBSCRIPTION_AGREEMENT | import("./common.types").OfferingFileLabels.ESCROW_AGREEMENT | import("./common.types").IssuerFileLabels | import("./common.types").IdentityFileLabels | import("./common.types").TradeFileLables | undefined;
+    pipeline?: ADFFileProcessingPipeline | undefined;
+}>;
+export interface ComplianceFilesIncludeQuery extends z.infer<typeof ComplianceFilesIncludeQuery> {
+}
+export declare const reviewFiles: z.ZodObject<{
+    complianceReview: z.ZodNativeEnum<typeof ComplianceReview>;
+    data: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
+}, "strip", z.ZodTypeAny, {
+    complianceReview: ComplianceReview;
+    data: string[];
+}, {
+    complianceReview: ComplianceReview;
+    data: string[];
+}>;
+export type reviewFiles = z.infer<typeof reviewFiles>;
+export declare const PatchFileMetadata: z.ZodObject<{
+    corrected: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnknown, unknown, unknown>>;
+    expectedCorrected: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnknown, unknown, unknown>>>>;
+}, "strip", z.ZodTypeAny, {
+    corrected: Record<string, unknown>;
+    expectedCorrected?: Record<string, unknown> | null | undefined;
+}, {
+    corrected: Record<string, unknown>;
+    expectedCorrected?: Record<string, unknown> | null | undefined;
+}>;
+export type PatchFileMetadata = z.infer<typeof PatchFileMetadata>;
+/**
+ * Zod schema for file metadata structure
+ * Used to validate the metadata field in File entity
+ */
+export declare const FileMetadataSchema: z.ZodObject<{
+    extracted: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodAny>, Record<string, any>, Record<string, any>>;
+    expected: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodAny>, Record<string, any>, Record<string, any>>;
+    corrected: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    expectedCorrected: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    expected: Record<string, any>;
+    extracted: Record<string, any>;
+    corrected?: Record<string, any> | undefined;
+    expectedCorrected?: Record<string, any> | undefined;
+}, {
+    expected: Record<string, any>;
+    extracted: Record<string, any>;
+    corrected?: Record<string, any> | undefined;
+    expectedCorrected?: Record<string, any> | undefined;
+}>;
+export type FileMetadata = z.infer<typeof FileMetadataSchema>;
+export declare enum FilePipeLineReviewAction {
+    SAVE = "SAVE",
+    REJECTED = "REJECTED",
+    ACCEPTED = "ACCEPTED"
+}
+export declare const FilePipeLineReviewSchemaZod: z.ZodObject<{
+    action: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof FilePipeLineReviewAction>>>;
+}, "strip", z.ZodTypeAny, {
+    action: FilePipeLineReviewAction;
+}, {
+    action?: FilePipeLineReviewAction | undefined;
+}>;
+export type FilePipeLineReviewSchemaZod = z.infer<typeof FilePipeLineReviewSchemaZod>;
+export declare const ADFPipelineResponseZod: z.ZodObject<{
+    extracted: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    extracted: Record<string, unknown>;
+}, {
+    extracted: Record<string, unknown>;
+}>;
+export type ADFPipelineResponseZod = z.infer<typeof ADFPipelineResponseZod>;
+export declare const ReprocessAllFilesZod: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    success: boolean;
+}, {
+    message: string;
+    success: boolean;
+}>;
+export type ReprocessAllFilesZod = z.infer<typeof ReprocessAllFilesZod>;
+/**
+ * Shared constants for BoldSign form field names.
+ * These constants ensure consistency between:
+ * - BoldSignService.getAllFormFields() - which generates form fields
+ * - getRequiredFieldPatterns() - which validates required fields
+ *
+ * If field names change, update them here to keep both functions in sync.
+ */
+/**
+ * Base form field names that are always present
+ */
+export declare const BOLDSIGN_BASE_FORM_FIELDS: {
+    readonly LEGAL_NAME: "LegalName";
+    readonly QUANTITY: "Quantity";
+    readonly TOTAL: "Total";
+    readonly BONUS_SHARES: "BonusShares";
+    readonly TOTAL_NUMBER_OF_SHARES: "TotalNumberOfShares";
+    readonly INVESTOR_TYPE: "InvestorType";
+    readonly OFFERING_NAME: "OfferingName";
+    readonly ASSET_NAME: "AssetName";
+    readonly PRICE_PER_SHARE: "PricePerShare";
+    readonly ISSUER_NAME: "IssuerName";
+};
+/**
+ * Entity form field name prefixes and suffixes
+ */
+export declare const ENTITY_FIELD_PREFIX = "Entity";
+export declare const ENTITY_FORM_FIELDS: {
+    readonly NAME: "EntityName";
+    readonly ADDRESS: "EntityAddress";
+    readonly ADDRESS2: "EntityAddress2";
+    readonly CITY: "EntityCity";
+    readonly STATE: "EntityState";
+    readonly ZIP: "EntityZip";
+    readonly COUNTRY: "EntityCountry";
+    readonly FULL_ADDRESS: "EntityFullAddress";
+    readonly PHONE: "EntityPhone";
+    readonly TYPE: "EntityType";
+    readonly EIN: "EntityEIN";
+    readonly STATE_OF_INCORPORATION: "EntityStateOfIncorporation";
+    readonly DATE_OF_INCORPORATION: "EntityDateOfIncorporation";
+};
+/**
+ * Signer form field name prefixes and suffixes
+ */
+export declare const SIGNER_FIELD_PREFIX = "Signer";
+export declare const SIGNER_FIELD_SUFFIXES: {
+    readonly NAME: "Name";
+    readonly EMAIL: "Email";
+    readonly PHONE: "Phone";
+    readonly FULL_ADDRESS: "FullAddress";
+    readonly ADDRESS: "Address";
+    readonly ADDRESS2: "Address2";
+    readonly CITY: "City";
+    readonly STATE: "State";
+    readonly ZIP: "Zip";
+    readonly COUNTRY: "Country";
+    readonly SSN_LAST_4: "SSNLast4";
+    readonly CITIZENSHIP: "Citizenship";
+    readonly ACCREDITATION_TYPE: "AccreditationType";
+    readonly IS_ACCREDITED: "IsAccredited";
+    readonly DOB: "DOB";
+};
+/**
+ * Helper function to generate signer field name
+ * @param signerIndex - The signer index (1-based)
+ * @param suffix - The field suffix (e.g., 'Name', 'Email')
+ * @returns The complete field name (e.g., 'Signer1Name', 'Signer2Email')
+ */
+export declare function getSignerFieldName(signerIndex: number, suffix: string): string;
+/**
+ * Type for all form field names
+ */
+export type FormFieldName = (typeof BOLDSIGN_BASE_FORM_FIELDS)[keyof typeof BOLDSIGN_BASE_FORM_FIELDS] | (typeof ENTITY_FORM_FIELDS)[keyof typeof ENTITY_FORM_FIELDS] | ReturnType<typeof getSignerFieldName>;
+/**
+ * Azure Blob SAS URL generation API response types
+ */
+export declare const AzureSasUrlSuccessResponse: z.ZodObject<{
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+}, {
+    url: string;
+}>;
+export type AzureSasUrlSuccessResponse = z.infer<typeof AzureSasUrlSuccessResponse>;
+export declare const AzureSasUrlErrorResponse: z.ZodObject<{
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>;
+export type AzureSasUrlErrorResponse = z.infer<typeof AzureSasUrlErrorResponse>;