@dalmore/api-contracts 0.0.0-dev.4bb6b7a → 0.0.0-dev.4db6454

package/common/types/issuer.types.d.ts

@@ -0,0 +1,539 @@
+import { z } from 'zod';
+import { IssuerStatus, SortBy, SortOrder } from './common.types';
+export declare enum IssuerTypes {
+    LLC = "LLC",
+    S_CORP = "S_CORP",
+    C_CORP = "C_CORP"
+}
+export declare const issuerIdSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * @description Query parameters for including related entities
+ * @xample in contract us as -> query: z.object({}).merge(IssuerIncludeQuery),
+ */
+export declare const IssuersIncludeQuery: z.ZodObject<{
+    include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+}, "strip", z.ZodTypeAny, {
+    include: string[];
+}, {
+    include?: string | undefined;
+}>;
+export declare const PostIssuerZod: z.ZodIntersection<z.ZodObject<{
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    legalName: z.ZodString;
+    dba: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    doi: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
+    ein: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    type: z.ZodNativeEnum<typeof IssuerTypes>;
+}, "strip", z.ZodTypeAny, {
+    type: IssuerTypes;
+    legalName: string;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    dba?: string | null | undefined;
+    doi?: Date | null | undefined;
+    ein?: string | null | undefined;
+}, {
+    type: IssuerTypes;
+    legalName: string;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    dba?: string | null | undefined;
+    doi?: string | null | undefined;
+    ein?: string | null | undefined;
+}>, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    city: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    zip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>>>;
+export type PostIssuerZod = z.infer<typeof PostIssuerZod>;
+export declare const CompliancePostIssuerZod: z.ZodIntersection<z.ZodObject<{
+    accountId: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+}, {
+    accountId: string;
+}>, z.ZodIntersection<z.ZodObject<{
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    legalName: z.ZodString;
+    dba: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    doi: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
+    ein: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    type: z.ZodNativeEnum<typeof IssuerTypes>;
+}, "strip", z.ZodTypeAny, {
+    type: IssuerTypes;
+    legalName: string;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    dba?: string | null | undefined;
+    doi?: Date | null | undefined;
+    ein?: string | null | undefined;
+}, {
+    type: IssuerTypes;
+    legalName: string;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    dba?: string | null | undefined;
+    doi?: string | null | undefined;
+    ein?: string | null | undefined;
+}>, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    city: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    zip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>>>>;
+export type CompliancePostIssuerZod = z.infer<typeof CompliancePostIssuerZod>;
+export declare const PutIssuerZod: z.ZodIntersection<z.ZodObject<{
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    legalName: z.ZodOptional<z.ZodString>;
+    dba: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    doi: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>>;
+    ein: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    type: z.ZodOptional<z.ZodNativeEnum<typeof IssuerTypes>>;
+    ss4LetterFileId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    formationDocumentFileId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    coverArtId: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+}, "strip", z.ZodTypeAny, {
+    type?: IssuerTypes | undefined;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    legalName?: string | undefined;
+    dba?: string | null | undefined;
+    doi?: Date | null | undefined;
+    ein?: string | null | undefined;
+    ss4LetterFileId?: string | null | undefined;
+    formationDocumentFileId?: string | null | undefined;
+    coverArtId?: string | null | undefined;
+}, {
+    type?: IssuerTypes | undefined;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    legalName?: string | undefined;
+    dba?: string | null | undefined;
+    doi?: string | null | undefined;
+    ein?: string | null | undefined;
+    ss4LetterFileId?: string | null | undefined;
+    formationDocumentFileId?: string | null | undefined;
+    coverArtId?: string | null | undefined;
+}>, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    city: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}, {
+    address?: string | null | undefined;
+    city?: string | null | undefined;
+    address2?: string | null | undefined;
+}>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    state?: string | null | undefined;
+}>>, z.ZodEffects<z.ZodObject<{
+    country: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<Readonly<Record<string, string>>>>>;
+    zip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}, {
+    country?: string | null | undefined;
+    zip?: string | null | undefined;
+}>>>;
+export type PutIssuerZod = z.infer<typeof PutIssuerZod>;
+export declare const IIssuer: any;
+export type IIssuer = z.infer<typeof IIssuer>;
+export declare const IPaginatedIssuer: 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 IPaginatedIssuer = z.infer<typeof IPaginatedIssuer>;
+export declare const GetIssuersZod: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    ein: z.ZodOptional<z.ZodString>;
+    legalName: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodNativeEnum<typeof IssuerTypes>>;
+    status: z.ZodOptional<z.ZodNativeEnum<typeof IssuerStatus>>;
+}, "strip", z.ZodTypeAny, {
+    type?: IssuerTypes | undefined;
+    status?: IssuerStatus | undefined;
+    accountId?: string | undefined;
+    legalName?: string | undefined;
+    ein?: string | undefined;
+}, {
+    type?: IssuerTypes | undefined;
+    status?: IssuerStatus | undefined;
+    accountId?: string | undefined;
+    legalName?: string | undefined;
+    ein?: string | undefined;
+}>;
+export type GetIssuersZod = z.infer<typeof GetIssuersZod>;
+export declare enum CatalogMode {
+    CATALOG = "CATALOG",
+    CATEGORY = "CATEGORY",
+    PRODUCT = "PRODUCT"
+}
+export declare const IPaginatedCatalog: 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;
+    } & {
+        mode: z.ZodOptional<z.ZodNativeEnum<typeof CatalogMode>>;
+    }, "strip", z.ZodTypeAny, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+        mode?: CatalogMode | undefined;
+    }, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+        mode?: CatalogMode | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    items: any[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+        mode?: CatalogMode | undefined;
+    };
+}, {
+    items: any[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+        mode?: CatalogMode | undefined;
+    };
+}>;
+export declare const GetIssuersSummaryZod: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    coveredPersons: z.ZodNumber;
+    offerings: z.ZodNumber;
+    assets: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    assets: number;
+    offerings: number;
+    coveredPersons: number;
+    accountId?: string | undefined;
+    issuerId?: string | undefined;
+}, {
+    assets: number;
+    offerings: number;
+    coveredPersons: number;
+    accountId?: string | undefined;
+    issuerId?: string | undefined;
+}>;
+export type GetIssuersSummaryZod = z.infer<typeof GetIssuersSummaryZod>;
+export declare const IPaginatedIssersSummary: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        coveredPersons: z.ZodNumber;
+        offerings: z.ZodNumber;
+        assets: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        assets: number;
+        offerings: number;
+        coveredPersons: number;
+        accountId?: string | undefined;
+        issuerId?: string | undefined;
+    }, {
+        assets: number;
+        offerings: number;
+        coveredPersons: number;
+        accountId?: string | undefined;
+        issuerId?: string | undefined;
+    }>, "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: {
+        assets: number;
+        offerings: number;
+        coveredPersons: number;
+        accountId?: string | undefined;
+        issuerId?: string | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: {
+        assets: number;
+        offerings: number;
+        coveredPersons: number;
+        accountId?: string | undefined;
+        issuerId?: string | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;
+export type IPaginatedIssersSummary = z.infer<typeof IPaginatedIssersSummary>;
+export declare const IssuersSummaryFilterZod: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    search: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    accountId?: string | undefined;
+    search?: string | undefined;
+    issuerId?: string | undefined;
+}, {
+    accountId?: string | undefined;
+    search?: string | undefined;
+    issuerId?: string | undefined;
+}>;
+export type IssuersSummaryFilterZod = z.infer<typeof IssuersSummaryFilterZod>;
+export declare const IssuersSortZod: z.ZodObject<{
+    sort: z.ZodOptional<z.ZodEnum<[SortBy.LEGAL_NAME, SortBy.CREATED_AT, SortBy.UPDATED_AT]>>;
+    dir: z.ZodOptional<z.ZodNativeEnum<typeof SortOrder>>;
+}, "strip", z.ZodTypeAny, {
+    sort?: SortBy.CREATED_AT | SortBy.UPDATED_AT | SortBy.LEGAL_NAME | undefined;
+    dir?: SortOrder | undefined;
+}, {
+    sort?: SortBy.CREATED_AT | SortBy.UPDATED_AT | SortBy.LEGAL_NAME | undefined;
+    dir?: SortOrder | undefined;
+}>;
+export type IssuersSortZod = z.infer<typeof IssuersSortZod>;
+/**
+ * Schema for transforming EIN (Employer Identification Number) formats.
+ *
+ * This schema validates and transforms a 9-digit EIN by inserting a hyphen after
+ * the first two digits (XX-XXXXXXX format). If the input doesn't match the expected
+ * 9-digit pattern, the original value is returned unchanged.
+ *
+ * The schema uses passthrough to allow additional fields in the object without validation,
+ * making it flexible for use with various data structures that include an EIN.
+ *
+ * @example
+ * // Transforms: { ein: '123456789' } -> { ein: '12-3456789' }
+ * // Keeps as-is: { ein: '12-3456789' } -> { ein: '12-3456789' }
+ */
+export declare const EinTransformerSchema: z.ZodObject<{
+    ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const PaginatedEinTransformerSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+    }, z.ZodTypeAny, "passthrough">>, "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: z.objectOutputType<{
+        ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+    }, z.ZodTypeAny, "passthrough">[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: z.objectInputType<{
+        ein: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | null | undefined, string | null | undefined>;
+    }, z.ZodTypeAny, "passthrough">[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;