@dalmore/api-contracts 0.0.0-dev.d29fb02 → 0.0.0-dev.d2fe663

package/common/types/invite.types.d.ts

@@ -0,0 +1,641 @@
+import { z } from 'zod';
+import { IssuerRole, PortalType, UserRole } from './common.types';
+export declare const inviteIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const InviteWithoutSecretZod: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    code: z.ZodString;
+    roleId: z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>;
+    role: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodString;
+        name: z.ZodNativeEnum<typeof UserRole>;
+        type: z.ZodNativeEnum<typeof PortalType>;
+    }, "strip", z.ZodTypeAny, {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    }, {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    }>>>;
+    used: z.ZodBoolean;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+    deletedAt: z.ZodNullable<z.ZodDate>;
+    account: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        name: z.ZodString;
+        status: z.ZodNativeEnum<typeof import("./common.types").AccountStatus>;
+        managedBy: z.ZodNullable<z.ZodNativeEnum<typeof import("./common.types").ManagedByType>>;
+        platform: z.ZodNativeEnum<typeof import("./common.types").Platform>;
+        onboardingReviewerId: z.ZodNullable<z.ZodString>;
+        onboardingReviewAt: z.ZodNullable<z.ZodDate>;
+        allowPendingComplianceReview: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    }, {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    email: string;
+    roleId: string | null;
+    used: boolean;
+    role?: {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    } | null | undefined;
+    account?: {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    } | null | undefined;
+}, {
+    code: string;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    email: string;
+    roleId: string | null;
+    used: boolean;
+    role?: {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    } | null | undefined;
+    account?: {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    } | null | undefined;
+}>;
+export type InviteWithoutSecretZod = z.infer<typeof InviteWithoutSecretZod>;
+export declare const IPaginatedInvite: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        email: z.ZodString;
+        code: z.ZodString;
+        roleId: z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>;
+        role: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            __entity: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+            updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+            deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+        } & {
+            id: z.ZodString;
+            name: z.ZodNativeEnum<typeof UserRole>;
+            type: z.ZodNativeEnum<typeof PortalType>;
+        }, "strip", z.ZodTypeAny, {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        }, {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        }>>>;
+        used: z.ZodBoolean;
+        createdAt: z.ZodDate;
+        updatedAt: z.ZodDate;
+        deletedAt: z.ZodNullable<z.ZodDate>;
+        account: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            __entity: z.ZodOptional<z.ZodString>;
+            createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+            updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+            deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+        } & {
+            name: z.ZodString;
+            status: z.ZodNativeEnum<typeof import("./common.types").AccountStatus>;
+            managedBy: z.ZodNullable<z.ZodNativeEnum<typeof import("./common.types").ManagedByType>>;
+            platform: z.ZodNativeEnum<typeof import("./common.types").Platform>;
+            onboardingReviewerId: z.ZodNullable<z.ZodString>;
+            onboardingReviewAt: z.ZodNullable<z.ZodDate>;
+            allowPendingComplianceReview: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        }, {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        }>>>;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        email: string;
+        roleId: string | null;
+        used: boolean;
+        role?: {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        } | null | undefined;
+        account?: {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        } | null | undefined;
+    }, {
+        code: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        email: string;
+        roleId: string | null;
+        used: boolean;
+        role?: {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        } | null | undefined;
+        account?: {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        } | null | 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: {
+        code: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        email: string;
+        roleId: string | null;
+        used: boolean;
+        role?: {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        } | null | undefined;
+        account?: {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        } | null | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: {
+        code: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        email: string;
+        roleId: string | null;
+        used: boolean;
+        role?: {
+            type: PortalType;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: UserRole;
+            __entity?: string | undefined;
+        } | null | undefined;
+        account?: {
+            status: import("./common.types").AccountStatus;
+            id: string;
+            createdAt: string | Date;
+            updatedAt: string | Date;
+            deletedAt: string | Date | null;
+            name: string;
+            managedBy: import("./common.types").ManagedByType | null;
+            platform: import("./common.types").Platform;
+            onboardingReviewerId: string | null;
+            onboardingReviewAt: Date | null;
+            allowPendingComplianceReview: boolean;
+            __entity?: string | undefined;
+        } | null | undefined;
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;
+export type InviteWithSecretZod = z.infer<typeof InviteWithoutSecretZod>;
+export declare const InviteWithUrl: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    code: z.ZodString;
+    roleId: z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>;
+    role: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        id: z.ZodString;
+        name: z.ZodNativeEnum<typeof UserRole>;
+        type: z.ZodNativeEnum<typeof PortalType>;
+    }, "strip", z.ZodTypeAny, {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    }, {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    }>>>;
+    used: z.ZodBoolean;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+    deletedAt: z.ZodNullable<z.ZodDate>;
+    account: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        __entity: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+        deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+    } & {
+        name: z.ZodString;
+        status: z.ZodNativeEnum<typeof import("./common.types").AccountStatus>;
+        managedBy: z.ZodNullable<z.ZodNativeEnum<typeof import("./common.types").ManagedByType>>;
+        platform: z.ZodNativeEnum<typeof import("./common.types").Platform>;
+        onboardingReviewerId: z.ZodNullable<z.ZodString>;
+        onboardingReviewAt: z.ZodNullable<z.ZodDate>;
+        allowPendingComplianceReview: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    }, {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    }>>>;
+} & {
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    email: string;
+    roleId: string | null;
+    url: string;
+    used: boolean;
+    role?: {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    } | null | undefined;
+    account?: {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    } | null | undefined;
+}, {
+    code: string;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    email: string;
+    roleId: string | null;
+    url: string;
+    used: boolean;
+    role?: {
+        type: PortalType;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: UserRole;
+        __entity?: string | undefined;
+    } | null | undefined;
+    account?: {
+        status: import("./common.types").AccountStatus;
+        id: string;
+        createdAt: string | Date;
+        updatedAt: string | Date;
+        deletedAt: string | Date | null;
+        name: string;
+        managedBy: import("./common.types").ManagedByType | null;
+        platform: import("./common.types").Platform;
+        onboardingReviewerId: string | null;
+        onboardingReviewAt: Date | null;
+        allowPendingComplianceReview: boolean;
+        __entity?: string | undefined;
+    } | null | undefined;
+}>;
+export type InviteWithUrl = z.infer<typeof InviteWithUrl>;
+export declare const PostIssuerInviteZod: z.ZodObject<{
+    email: z.ZodEffects<z.ZodString, string, string>;
+    role: z.ZodNativeEnum<typeof IssuerRole>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    role: IssuerRole;
+}, {
+    email: string;
+    role: IssuerRole;
+}>;
+export type PostIssuerInviteZod = z.infer<typeof PostIssuerInviteZod>;
+export declare const IssuerInvitesFiltersZod: z.ZodObject<{
+    role: z.ZodEffects<z.ZodOptional<z.ZodNativeEnum<typeof UserRole>>, UserRole | undefined, UserRole | undefined>;
+    used: z.ZodEffects<z.ZodOptional<z.ZodString>, boolean | undefined, string | undefined>;
+    email: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    email?: string | undefined;
+    role?: UserRole | undefined;
+    used?: boolean | undefined;
+}, {
+    email?: string | undefined;
+    role?: UserRole | undefined;
+    used?: string | undefined;
+}>;
+export type IssuerInvitesFiltersZod = z.infer<typeof IssuerInvitesFiltersZod>;
+export declare const IssuerVerifyInviteResponse: z.ZodObject<{
+    valid: z.ZodBoolean;
+    email: z.ZodNullable<z.ZodString>;
+    existingLogin: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    accountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    valid: boolean;
+    email: string | null;
+    accountName?: string | null | undefined;
+    existingLogin?: boolean | null | undefined;
+}, {
+    valid: boolean;
+    email: string | null;
+    accountName?: string | null | undefined;
+    existingLogin?: boolean | null | undefined;
+}>;
+export type IssuerVerifyInviteResponse = z.infer<typeof IssuerVerifyInviteResponse>;
+export declare const IssuerInvitesDecisionResponse: z.ZodObject<{
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+}, {
+    message: string;
+}>;
+export type IssuerInvitesDecisionResponse = z.infer<typeof IssuerInvitesDecisionResponse>;
+export declare const InvitesIncludeQuery: 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 PatchInviteRoleZod: z.ZodObject<{
+    role: z.ZodNativeEnum<typeof UserRole>;
+}, "strip", z.ZodTypeAny, {
+    role: UserRole;
+}, {
+    role: UserRole;
+}>;
+export type PatchInviteRoleZod = z.infer<typeof PatchInviteRoleZod>;
+export declare const PatchInviteForComplianceZod: z.ZodObject<{
+    role: z.ZodNativeEnum<typeof UserRole>;
+} & {
+    accountId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    role: UserRole;
+    accountId?: string | undefined;
+}, {
+    role: UserRole;
+    accountId?: string | undefined;
+}>;
+export type PatchInviteForComplianceZod = z.infer<typeof PatchInviteForComplianceZod>;
+export declare const PostInviteZod: z.ZodObject<{
+    email: z.ZodEffects<z.ZodString, string, string>;
+    role: z.ZodNativeEnum<typeof UserRole>;
+    accountId: z.ZodOptional<z.ZodString>;
+    portalType: z.ZodOptional<z.ZodNativeEnum<typeof PortalType>>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    role: UserRole;
+    accountId?: string | undefined;
+    portalType?: PortalType | undefined;
+}, {
+    email: string;
+    role: UserRole;
+    accountId?: string | undefined;
+    portalType?: PortalType | undefined;
+}>;
+export type PostInviteZod = z.infer<typeof PostInviteZod>;
+export declare const CompliancePostInviteZod: z.ZodObject<{
+    email: z.ZodEffects<z.ZodString, string, string>;
+    role: z.ZodNativeEnum<typeof UserRole>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    role: UserRole;
+}, {
+    email: string;
+    role: UserRole;
+}>;
+export type CompliancePostInviteZod = z.infer<typeof CompliancePostInviteZod>;