Class OrganizationAdminService

Hierarchy (View Summary)

OrganizationAdminQueryService
- OrganizationAdminService

Index

Constructors

constructor

new OrganizationAdminService(
    args: {
        db: B2bDatabase;
        eventPublisher: EventPublisher;
        valkeyClient: ValkeyClient | null;
    },
): OrganizationAdminService
Parameters
- args: {
      db: B2bDatabase;
      eventPublisher: EventPublisher;
      valkeyClient: ValkeyClient | null;
  }
Returns OrganizationAdminService
Overrides OrganizationAdminQueryService.constructor
- Defined in packages/entity-services/src/organization/OrganizationAdminService.ts:391

Properties

`Protected` `Readonly`cache

cache: ServiceCache<
{ hasNext: boolean; items: CachedOrgWithCustomer[]; total: number },
>

`Protected` `Readonly`db

db: B2bDatabase

Methods

get

get(
    __namedParameters: { id: string; includeDeleted?: boolean },
): Promise<
    {
        ok: true;
        value: | {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                regionCode?: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            displayName: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            type: "ORGANIZATION";
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        } & { customerId: string; customerName: string }
        | null;
    },
>
Parameters
- __namedParameters: { id: string; includeDeleted?: boolean }
  - id: string
  - OptionalincludeDeleted?: boolean
    Default: false
Returns Promise<
    {
        ok: true;
        value: | {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                regionCode?: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            displayName: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            type: "ORGANIZATION";
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        } & { customerId: string; customerName: string }
        | null;
    },
>
Inherited from OrganizationAdminQueryService.get
- Defined in packages/entity-services/src/organization/OrganizationAdminService.ts:109

search

search(
    __namedParameters: {
        countriesOfIncorporation?: string[];
        createdAt?: DbTimestampCriteria;
        customerIds?: string[];
        descriptionLike?: string;
        ids?: string[];
        includeDeleted?: boolean;
        legalEntityTypeLike?: string;
        nameLike?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfIncorporation: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            createdAt: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            data: PgBuildColumn<
                                "organization",
                                Set$Type<
                                    PgJsonbBuilder,
                                    {
                                        address?: ...;
                                        email?: ...;
                                        phone?: ...;
                                        verificationData?: ...;
                                        verificationProfileId?: ...;
                                        websiteUrl?: ...;
                                    },
                                >,
                                {
                                    data: {
                                        address?: ...;
                                        email?: ...;
                                        phone?: ...;
                                        verificationData?: ...;
                                        verificationProfileId?: ...;
                                        websiteUrl?: ...;
                                    };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "organization";
                                },
                            >;
                            description: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            entityType: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            id: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            name: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            referenceId: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            status: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            taxId: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "organization",
                                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: "organization";
                                },
                            >;
                            uuid: PgBuildColumn<
                                "organization",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string uuid";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "organization";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "organization";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        q?: string;
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[];
        unverified?: boolean;
        updatedAt?: DbTimestampCriteria;
        uuids?: string[];
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                {
                    address?: {
                        city: string;
                        countryCode: string;
                        line1: string;
                        line2?: string;
                        postalCode: string;
                        regionCode?: string;
                    };
                    capabilities: (
                        | "TRANSACT"
                        | "MANAGE_PAYMENT_INSTRUMENT"
                        | "MANAGE_LEDGER_ACCOUNT"
                        | "MANAGE_DEPOSIT_MEMO"
                    )[];
                    countryCode: string;
                    countryOfIncorporation: string;
                    createdAt: Date;
                    description?: string;
                    displayName: string;
                    email?: string;
                    id: string;
                    legalEntityType: string;
                    name: string;
                    phone?: E164Phone;
                    referenceId?: string;
                    status: "ACTIVE"
                    | "DISABLED"
                    | "PENDING_VERIFICATION";
                    taxId: string;
                    type: "ORGANIZATION";
                    updatedAt: Date;
                    uuid: string;
                    verificationData?: {
                        status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                        verificationSessionId: string;
                        verificationTemplateId: string;
                    };
                    verificationProfileId?: string;
                    websiteUrl?: string;
                } & { customerId: string; customerName: string }
            )[];
            total: number;
        };
    },
>
Parameters
- __namedParameters: {
      countriesOfIncorporation?: string[];
      createdAt?: DbTimestampCriteria;
      customerIds?: string[];
      descriptionLike?: string;
      ids?: string[];
      includeDeleted?: boolean;
      legalEntityTypeLike?: string;
      nameLike?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfIncorporation: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          createdAt: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          data: PgBuildColumn<
                              "organization",
                              Set$Type<
                                  PgJsonbBuilder,
                                  {
                                      address?: ...;
                                      email?: ...;
                                      phone?: ...;
                                      verificationData?: ...;
                                      verificationProfileId?: ...;
                                      websiteUrl?: ...;
                                  },
                              >,
                              {
                                  data: {
                                      address?: ...;
                                      email?: ...;
                                      phone?: ...;
                                      verificationData?: ...;
                                      verificationProfileId?: ...;
                                      websiteUrl?: ...;
                                  };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "organization";
                              },
                          >;
                          description: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          entityType: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          id: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          name: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          referenceId: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          status: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          taxId: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "organization",
                              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: "organization";
                              },
                          >;
                          uuid: PgBuildColumn<
                              "organization",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string uuid";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "organization";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "organization";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      q?: string;
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[];
      unverified?: boolean;
      updatedAt?: DbTimestampCriteria;
      uuids?: string[];
  }
  - OptionalcountriesOfIncorporation?: string[]
  - OptionalcreatedAt?: DbTimestampCriteria
  - OptionalcustomerIds?: string[]
  - OptionaldescriptionLike?: string
    Partial match on description
  - Optionalids?: string[]
  - OptionalincludeDeleted?: boolean
  - OptionallegalEntityTypeLike?: string
    Partial match on legal entity type
  - OptionalnameLike?: string
    Partial match on legal entity name
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        countryOfIncorporation: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        createdAt: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        customerId: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        data: PgBuildColumn<
                            "organization",
                            Set$Type<
                                PgJsonbBuilder,
                                {
                                    address?: ...;
                                    email?: ...;
                                    phone?: ...;
                                    verificationData?: ...;
                                    verificationProfileId?: ...;
                                    websiteUrl?: ...;
                                },
                            >,
                            {
                                data: {
                                    address?: ...;
                                    email?: ...;
                                    phone?: ...;
                                    verificationData?: ...;
                                    verificationProfileId?: ...;
                                    websiteUrl?: ...;
                                };
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "organization";
                            },
                        >;
                        description: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        entityType: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        id: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        name: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        referenceId: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        status: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        taxId: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "organization",
                            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: "organization";
                            },
                        >;
                        uuid: PgBuildColumn<
                            "organization",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string uuid";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "organization";
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "organization";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 10
  - Optionalq?: string
    Unified free-text search: matches the organization's legal name, its own external id (org_...), the owning customer's name, or the customer's external id (cust_...). Whitespace-only values are a no-op.
  - OptionalreferenceIdLike?: string
    Partial match on reference ID
  - OptionalreferenceIds?: string[]
  - Optionalstatuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[]
  - Optionalunverified?: boolean
  - OptionalupdatedAt?: DbTimestampCriteria
  - Optionaluuids?: string[]
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                {
                    address?: {
                        city: string;
                        countryCode: string;
                        line1: string;
                        line2?: string;
                        postalCode: string;
                        regionCode?: string;
                    };
                    capabilities: (
                        | "TRANSACT"
                        | "MANAGE_PAYMENT_INSTRUMENT"
                        | "MANAGE_LEDGER_ACCOUNT"
                        | "MANAGE_DEPOSIT_MEMO"
                    )[];
                    countryCode: string;
                    countryOfIncorporation: string;
                    createdAt: Date;
                    description?: string;
                    displayName: string;
                    email?: string;
                    id: string;
                    legalEntityType: string;
                    name: string;
                    phone?: E164Phone;
                    referenceId?: string;
                    status: "ACTIVE"
                    | "DISABLED"
                    | "PENDING_VERIFICATION";
                    taxId: string;
                    type: "ORGANIZATION";
                    updatedAt: Date;
                    uuid: string;
                    verificationData?: {
                        status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                        verificationSessionId: string;
                        verificationTemplateId: string;
                    };
                    verificationProfileId?: string;
                    websiteUrl?: string;
                } & { customerId: string; customerName: string }
            )[];
            total: number;
        };
    },
>
Inherited from OrganizationAdminQueryService.search
- Defined in packages/entity-services/src/organization/OrganizationAdminService.ts:152

update

update(
    __namedParameters: {
        data: Partial<Pick<Organization, "status" | "verificationData">>;
        id: string;
    },
): Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                regionCode?: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            displayName: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            type: "ORGANIZATION";
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | { error: ServiceError; ok: false },
>
Updates do NOT trigger AiPrise verification
Parameters
- __namedParameters: { data: Partial<Pick<Organization, "status" | "verificationData">>; id: string }
Returns Promise<
    | {
        ok: true;
        value: {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                regionCode?: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            displayName: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            type: "ORGANIZATION";
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/entity-services/src/organization/OrganizationAdminService.ts:407

Class OrganizationAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OrganizationAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Methods

get

Parameters

id: string

OptionalincludeDeleted?: boolean

search

Parameters

OptionalcountriesOfIncorporation?: string[]

OptionalcreatedAt?: DbTimestampCriteria

OptionalcustomerIds?: string[]

OptionaldescriptionLike?: string

Optionalids?: string[]

OptionalincludeDeleted?: boolean

OptionallegalEntityTypeLike?: string

OptionalnameLike?: string

Optionalpage?: number

OptionalpageSize?: number

Optionalq?: string

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

Optionalstatuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[]

Optionalunverified?: boolean

OptionalupdatedAt?: DbTimestampCriteria

Optionaluuids?: string[]

update

Parameters

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Optional`includeDeleted?: boolean

`Optional`countriesOfIncorporation?: string[]

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`descriptionLike?: string

`Optional`ids?: string[]

`Optional`includeDeleted?: boolean

`Optional`legalEntityTypeLike?: string

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`q?: string

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

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

`Optional`unverified?: boolean

`Optional`updatedAt?: DbTimestampCriteria

`Optional`uuids?: string[]