Class RelatedPersonService

Read/write access to an organization's related persons. Writes are forwarded to AiPrise (the KYB provider): create links a fresh user profile onto the org's business profile, update re-pushes the changed fields, delete removes the association. AiPrise failures propagate as thrown errors (mirrors OrganizationService.verify); invalid input is rejected up-front.

Hierarchy (View Summary)

RelatedPersonQueryService
- RelatedPersonService

Index

Constructors

constructor

Properties

Methods

create delete get search update

Constructors

constructor

new RelatedPersonService(
    args: {
        aiPriseClient: AiPriseClient;
        db: B2bDatabase;
        eventPublisher: CustomerEventPublisher;
        organizationService: OrganizationQueryService;
    },
): RelatedPersonService
Parameters
- args: {
      aiPriseClient: AiPriseClient;
      db: B2bDatabase;
      eventPublisher: CustomerEventPublisher;
      organizationService: OrganizationQueryService;
  }
Returns RelatedPersonService
Overrides RelatedPersonQueryService.constructor
- Defined in packages/entity-services/src/related-person/RelatedPersonService.ts:58

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    __namedParameters: RelatedPersonInput & {
        countryOfResidence: string;
        customerId: string;
        organizationId: string;
        type: "BENEFICIAL_OWNER" | "CONTROL";
    },
): Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"ORGANIZATION_NOT_FOUND" | "ORGANIZATION_NOT_VERIFIED">;
        ok: false;
    },
>
Parameters
- __namedParameters: RelatedPersonInput & {
      countryOfResidence: string;
      customerId: string;
      organizationId: string;
      type: "BENEFICIAL_OWNER" | "CONTROL";
  }
  - countryOfResidence: string
    
    Alpha-2 ISO-3166-1. Required: it supplies identity_country_code on this person's AiPrise verifications, which are rejected without it.
  - customerId: string
  - organizationId: string
  - type: "BENEFICIAL_OWNER" | "CONTROL"
Returns Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"ORGANIZATION_NOT_FOUND" | "ORGANIZATION_NOT_VERIFIED">;
        ok: false;
    },
>
- Defined in packages/entity-services/src/related-person/RelatedPersonService.ts:103

delete

delete(
    __namedParameters: {
        customerId: string;
        id: string;
        organizationId: string;
    },
): Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    },
>
Parameters
- __namedParameters: { customerId: string; id: string; organizationId: string }
Returns Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    },
>
- Defined in packages/entity-services/src/related-person/RelatedPersonService.ts:335

get

get(
    __namedParameters: {
        customerId: string;
        id: string;
        organizationId?: string;
    },
): Promise<
    {
        ok: true;
        value: | {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        }
        | null;
    },
>
Parameters
- __namedParameters: { customerId: string; id: string; organizationId?: string }
  - customerId: string
  - id: string
  - OptionalorganizationId?: string
    
    When provided, scopes to a specific organization (the API path case). When omitted, scopes by customer only — used by the document flow, which knows the related person id but not its organization.
Returns Promise<
    {
        ok: true;
        value: | {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        }
        | null;
    },
>
Inherited from RelatedPersonQueryService.get
- Defined in packages/entity-services/src/related-person/RelatedPersonQueryService.ts:31

search

search(
    __namedParameters: {
        createdAt?: DbTimestampCriteria;
        customerId: string;
        ids?: string[];
        includeDeleted?: boolean;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfResidence: PgBuildColumn<
                                "related_person",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            createdAt: PgBuildColumn<
                                "related_person",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "related_person",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            data: PgBuildColumn<
                                "related_person",
                                Set$Type<
                                    SetNotNull<(...)>,
                                    {
                                        address?: ...;
                                        dateOfBirth?: ...;
                                        ownershipPercent?: ...;
                                        personReferenceId?: ...;
                                        routeFusionDocumentsUploadedAt?: ...;
                                        routeFusionRepresentativeId?: ...;
                                        sharesAllocated?: ...;
                                        taxId?: ...;
                                        title?: ...;
                                        verificationProfileId?: ...;
                                    },
                                >,
                                {
                                    data: {
                                        address?: ...;
                                        dateOfBirth?: ...;
                                        ownershipPercent?: ...;
                                        personReferenceId?: ...;
                                        routeFusionDocumentsUploadedAt?: ...;
                                        routeFusionRepresentativeId?: ...;
                                        sharesAllocated?: ...;
                                        taxId?: ...;
                                        title?: ...;
                                        verificationProfileId?: ...;
                                    };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            deletedAt: PgBuildColumn<
                                "related_person",
                                PgTimestampBuilder,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "related_person";
                                },
                            >;
                            email: PgBuildColumn<
                                "related_person",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "related_person";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "related_person",
                                SetHasRuntimeDefault<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            id: PgBuildColumn<
                                "related_person",
                                HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            name: PgBuildColumn<
                                "related_person",
                                Set$Type<
                                    PgJsonbBuilder,
                                    { firstName: ...; lastName: ...; middleName?: ... },
                                >,
                                {
                                    data: { firstName: ...; lastName: ...; middleName?: ... };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "related_person";
                                },
                            >;
                            organizationId: PgBuildColumn<
                                "related_person",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            phone: PgBuildColumn<
                                "related_person",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "related_person";
                                },
                            >;
                            status: PgBuildColumn<
                                "related_person",
                                Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                {
                                    data: (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            type: PgBuildColumn<
                                "related_person",
                                Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                {
                                    data: (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "related_person",
                                SetHasDefault<SetHasDefault<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "related_person";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        organizationId: string;
        page?: number;
        pageSize?: number;
        statuses?: ("ACTIVE" | "DELETED")[];
        types?: ("BENEFICIAL_OWNER" | "CONTROL")[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: {
                address?: {
                    city: string;
                    countryCode: string;
                    line1: string;
                    line2?: string;
                    postalCode?: string;
                    regionCode?: string;
                };
                countryOfResidence: string;
                createdAt: Date;
                dateOfBirth?: string;
                deletedAt?: Date;
                email: string
                | null;
                id: string;
                name:
                    | { firstName: string; lastName: string; middleName?: string }
                    | null;
                ownershipPercent?: number;
                phone: string | null;
                routeFusionDocumentsUploadedAt?: string;
                sharesAllocated?: number;
                status: "ACTIVE" | "DELETED";
                taxId?: string;
                title?: string;
                type: "BENEFICIAL_OWNER" | "CONTROL";
                updatedAt: Date;
            }[];
            total: number;
        };
    },
>
Parameters
- __namedParameters: {
      createdAt?: DbTimestampCriteria;
      customerId: string;
      ids?: string[];
      includeDeleted?: boolean;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfResidence: PgBuildColumn<
                              "related_person",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          createdAt: PgBuildColumn<
                              "related_person",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "related_person",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          data: PgBuildColumn<
                              "related_person",
                              Set$Type<
                                  SetNotNull<(...)>,
                                  {
                                      address?: ...;
                                      dateOfBirth?: ...;
                                      ownershipPercent?: ...;
                                      personReferenceId?: ...;
                                      routeFusionDocumentsUploadedAt?: ...;
                                      routeFusionRepresentativeId?: ...;
                                      sharesAllocated?: ...;
                                      taxId?: ...;
                                      title?: ...;
                                      verificationProfileId?: ...;
                                  },
                              >,
                              {
                                  data: {
                                      address?: ...;
                                      dateOfBirth?: ...;
                                      ownershipPercent?: ...;
                                      personReferenceId?: ...;
                                      routeFusionDocumentsUploadedAt?: ...;
                                      routeFusionRepresentativeId?: ...;
                                      sharesAllocated?: ...;
                                      taxId?: ...;
                                      title?: ...;
                                      verificationProfileId?: ...;
                                  };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          deletedAt: PgBuildColumn<
                              "related_person",
                              PgTimestampBuilder,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "related_person";
                              },
                          >;
                          email: PgBuildColumn<
                              "related_person",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "related_person";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "related_person",
                              SetHasRuntimeDefault<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          id: PgBuildColumn<
                              "related_person",
                              HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          name: PgBuildColumn<
                              "related_person",
                              Set$Type<
                                  PgJsonbBuilder,
                                  { firstName: ...; lastName: ...; middleName?: ... },
                              >,
                              {
                                  data: { firstName: ...; lastName: ...; middleName?: ... };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "related_person";
                              },
                          >;
                          organizationId: PgBuildColumn<
                              "related_person",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          phone: PgBuildColumn<
                              "related_person",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "related_person";
                              },
                          >;
                          status: PgBuildColumn<
                              "related_person",
                              Set$Type<SetNotNull<(...)>, (...) | (...)>,
                              {
                                  data: (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          type: PgBuildColumn<
                              "related_person",
                              Set$Type<SetNotNull<(...)>, (...) | (...)>,
                              {
                                  data: (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "related_person",
                              SetHasDefault<SetHasDefault<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "related_person";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      organizationId: string;
      page?: number;
      pageSize?: number;
      statuses?: ("ACTIVE" | "DELETED")[];
      types?: ("BENEFICIAL_OWNER" | "CONTROL")[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalcreatedAt?: DbTimestampCriteria
  - customerId: string
  - Optionalids?: string[]
  - OptionalincludeDeleted?: boolean
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        countryOfResidence: PgBuildColumn<
                            "related_person",
                            SetNotNull<PgTextBuilder<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        createdAt: PgBuildColumn<
                            "related_person",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        customerId: PgBuildColumn<
                            "related_person",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        data: PgBuildColumn<
                            "related_person",
                            Set$Type<
                                SetNotNull<(...)>,
                                {
                                    address?: ...;
                                    dateOfBirth?: ...;
                                    ownershipPercent?: ...;
                                    personReferenceId?: ...;
                                    routeFusionDocumentsUploadedAt?: ...;
                                    routeFusionRepresentativeId?: ...;
                                    sharesAllocated?: ...;
                                    taxId?: ...;
                                    title?: ...;
                                    verificationProfileId?: ...;
                                },
                            >,
                            {
                                data: {
                                    address?: ...;
                                    dateOfBirth?: ...;
                                    ownershipPercent?: ...;
                                    personReferenceId?: ...;
                                    routeFusionDocumentsUploadedAt?: ...;
                                    routeFusionRepresentativeId?: ...;
                                    sharesAllocated?: ...;
                                    taxId?: ...;
                                    title?: ...;
                                    verificationProfileId?: ...;
                                };
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        deletedAt: PgBuildColumn<
                            "related_person",
                            PgTimestampBuilder,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "related_person";
                            },
                        >;
                        email: PgBuildColumn<
                            "related_person",
                            PgTextBuilder<[(...), ...(...)[]]>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "related_person";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "related_person",
                            SetHasRuntimeDefault<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        id: PgBuildColumn<
                            "related_person",
                            HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        name: PgBuildColumn<
                            "related_person",
                            Set$Type<
                                PgJsonbBuilder,
                                { firstName: ...; lastName: ...; middleName?: ... },
                            >,
                            {
                                data: { firstName: ...; lastName: ...; middleName?: ... };
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "related_person";
                            },
                        >;
                        organizationId: PgBuildColumn<
                            "related_person",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        phone: PgBuildColumn<
                            "related_person",
                            PgTextBuilder<[(...), ...(...)[]]>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "related_person";
                            },
                        >;
                        status: PgBuildColumn<
                            "related_person",
                            Set$Type<SetNotNull<(...)>, (...) | (...)>,
                            {
                                data: (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        type: PgBuildColumn<
                            "related_person",
                            Set$Type<SetNotNull<(...)>, (...) | (...)>,
                            {
                                data: (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "related_person",
                            SetHasDefault<SetHasDefault<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "related_person";
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "related_person";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - organizationId: string
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 50
  - Optionalstatuses?: ("ACTIVE" | "DELETED")[]
  - Optionaltypes?: ("BENEFICIAL_OWNER" | "CONTROL")[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: {
                address?: {
                    city: string;
                    countryCode: string;
                    line1: string;
                    line2?: string;
                    postalCode?: string;
                    regionCode?: string;
                };
                countryOfResidence: string;
                createdAt: Date;
                dateOfBirth?: string;
                deletedAt?: Date;
                email: string
                | null;
                id: string;
                name:
                    | { firstName: string; lastName: string; middleName?: string }
                    | null;
                ownershipPercent?: number;
                phone: string | null;
                routeFusionDocumentsUploadedAt?: string;
                sharesAllocated?: number;
                status: "ACTIVE" | "DELETED";
                taxId?: string;
                title?: string;
                type: "BENEFICIAL_OWNER" | "CONTROL";
                updatedAt: Date;
            }[];
            total: number;
        };
    },
>
Inherited from RelatedPersonQueryService.search
- Defined in packages/entity-services/src/related-person/RelatedPersonQueryService.ts:71

update

update(
    __namedParameters: {
        customerId: string;
        data: Partial<RelatedPersonInput & { type: RelatedPerson["type"] }>;
        id: string;
        organizationId: string;
    },
): Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<"NOT_FOUND">
        | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >;
        ok: false;
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      data: Partial<RelatedPersonInput & { type: RelatedPerson["type"] }>;
      id: string;
      organizationId: string;
  }
Returns Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode?: string;
                regionCode?: string;
            };
            countryOfResidence: string;
            createdAt: Date;
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string
            | null;
            id: string;
            name: { firstName: string; lastName: string; middleName?: string } | null;
            ownershipPercent?: number;
            phone: string | null;
            routeFusionDocumentsUploadedAt?: string;
            sharesAllocated?: number;
            status: "ACTIVE" | "DELETED";
            taxId?: string;
            title?: string;
            type: "BENEFICIAL_OWNER" | "CONTROL";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<"NOT_FOUND">
        | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >;
        ok: false;
    },
>
- Defined in packages/entity-services/src/related-person/RelatedPersonService.ts:222

Class RelatedPersonService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelatedPersonService

Properties

Protected Readonlydb

Methods

create

Parameters

countryOfResidence: string

customerId: string

organizationId: string

type: "BENEFICIAL_OWNER" | "CONTROL"

delete

Parameters

get

Parameters

customerId: string

id: string

OptionalorganizationId?: string

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

Optionalids?: string[]

OptionalincludeDeleted?: boolean

organizationId: string

Optionalpage?: number

OptionalpageSize?: number

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

Optionaltypes?: ("BENEFICIAL_OWNER" | "CONTROL")[]

OptionalupdatedAt?: DbTimestampCriteria

update

Parameters

Settings

On This Page

`Protected` `Readonly`db

`Optional`organizationId?: string

`Optional`createdAt?: DbTimestampCriteria

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`page?: number

`Optional`pageSize?: number

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

`Optional`types?: ("BENEFICIAL_OWNER" | "CONTROL")[]

`Optional`updatedAt?: DbTimestampCriteria