Class OrganizationService

Unless need to directly act on an organization specifically, you should be using EntityService instead.

Hierarchy (View Summary)

OrganizationQueryService
- OrganizationService

Index

Constructors

constructor

new OrganizationService(
    args: {
        aiPriseClient: AiPriseClient;
        customerService: CustomerService;
        defaultAiPriseTemplateId: string;
        eventPublisher: EventPublisher;
        productConfigService: ProductConfigService;
        sqlClient: Sql;
    },
): OrganizationService
Parameters
- args: {
      aiPriseClient: AiPriseClient;
      customerService: CustomerService;
      defaultAiPriseTemplateId: string;
      eventPublisher: EventPublisher;
      productConfigService: ProductConfigService;
      sqlClient: Sql;
  }
Returns OrganizationService
Overrides OrganizationQueryService.constructor
- Defined in packages/entity-services/src/organization/OrganizationService.ts:40

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

create

create(
    __namedParameters: Omit<
        {
            address?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                regionCode?: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        },
        | "id"
        | "status"
        | "createdAt"
        | "updatedAt"
        | "uuid"
        | "address"
        | "verificationProfileId"
        | "capabilities",
    > & {
        address: {
            city: string;
            countryCode: string;
            line1: string;
            line2?: string;
            postalCode: string;
            regionCode?: string;
        };
        customerId: 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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | {
        error: | ServiceError<"PRODUCT_INACTIVE" | "DUPLICATE">
        | ServiceError<"INVALID_EMAIL" | "INVALID_WEBSITE_URL">;
        ok: false;
    },
>
Parameters
- __namedParameters: Omit<
      {
          address?: {
              city: string;
              countryCode: string;
              line1: string;
              line2?: string;
              postalCode: string;
              regionCode?: string;
          };
          capabilities: (
              | "TRANSACT"
              | "MANAGE_PAYMENT_INSTRUMENT"
              | "MANAGE_LEDGER_ACCOUNT"
              | "MANAGE_DEPOSIT_MEMO"
          )[];
          countryOfIncorporation: string;
          createdAt: Date;
          description?: string;
          email?: string;
          id: string;
          legalEntityType: string;
          name: string;
          phone?: E164Phone;
          referenceId?: string;
          status: "ACTIVE"
          | "DISABLED"
          | "PENDING_VERIFICATION";
          taxId: string;
          updatedAt: Date;
          uuid: string;
          verificationData?: {
              status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
              verificationSessionId: string;
              verificationTemplateId: string;
          };
          verificationProfileId?: string;
          websiteUrl?: string;
      },
      | "id"
      | "status"
      | "createdAt"
      | "updatedAt"
      | "uuid"
      | "address"
      | "verificationProfileId"
      | "capabilities",
  > & {
      address: {
          city: string;
          countryCode: string;
          line1: string;
          line2?: string;
          postalCode: string;
          regionCode?: string;
      };
      customerId: 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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | {
        error: | ServiceError<"PRODUCT_INACTIVE" | "DUPLICATE">
        | ServiceError<"INVALID_EMAIL" | "INVALID_WEBSITE_URL">;
        ok: false;
    },
>
- Defined in packages/entity-services/src/organization/OrganizationService.ts:56

delete

delete(
    __namedParameters: { customerId: string; id: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/entity-services/src/organization/OrganizationService.ts:259

get

get(
    __namedParameters: { customerId: string; 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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        }
        | null;
    },
>
Parameters
- __namedParameters: { customerId: string; 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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        }
        | null;
    },
>
Inherited from OrganizationQueryService.get
- Defined in packages/entity-services/src/organization/OrganizationQueryService.ts:38

getVerificationUrl

getVerificationUrl(
    __namedParameters: {
        customerId: string;
        id: string;
        redirectUrl: string;
    },
): Promise<
    | { error: ServiceError; ok: false }
    | { ok: true; value: { url: string } },
>
Parameters
- __namedParameters: { customerId: string; id: string; redirectUrl: string }
  - customerId: string
  - id: string
  - redirectUrl: string
    The URL to redirect to, after verification is completed
Returns Promise<
| { error: ServiceError; ok: false }
| { ok: true; value: { url: string } },
>
URL to start an identity document verification session
- Defined in packages/entity-services/src/organization/OrganizationService.ts:298

search

search(
    __namedParameters: {
        countriesOfIncorporation?: string[];
        createdAt?: DbTimestampCriteria;
        customerId: string;
        descriptionLike?: string;
        ids?: string[];
        legalEntityTypeLike?: string;
        nameLike?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfIncorporation: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "countryOfIncorporation";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            createdAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "createdAt";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            customerId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "customerId";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            data: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: {
                                        address?: ...;
                                        email?: ...;
                                        phone?: ...;
                                        verificationData?: ...;
                                        verificationProfileId?: ...;
                                        websiteUrl?: ...;
                                    };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "data";
                                    notNull: false;
                                    tableName: "organization";
                                },
                                {},
                                {
                                    $type: {
                                        address?: ...;
                                        email?: ...;
                                        phone?: ...;
                                        verificationData?: ...;
                                        verificationProfileId?: ...;
                                        websiteUrl?: ...;
                                    };
                                },
                            >;
                            description: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "description";
                                    notNull: false;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            entityType: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "entityType";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            externalId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: true;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "externalId";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            id: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: true;
                                    name: "id";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            name: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "name";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            referenceId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "referenceId";
                                    notNull: false;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            status: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "status";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                { $type: (...)
                                | (...)
                                | (...)
                                | (...) },
                            >;
                            taxId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "taxId";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            updatedAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "updatedAt";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                            uuid: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgUUID";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "uuid";
                                    notNull: true;
                                    tableName: "organization";
                                },
                                {},
                                {},
                            >;
                        };
                        dialect: "pg";
                        name: "organization";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[];
        updatedAt?: DbTimestampCriteria;
    },
): 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"
                )[];
                countryOfIncorporation: string;
                createdAt: Date;
                description?: string;
                email?: string;
                id: string;
                legalEntityType: string;
                name: string;
                phone?: E164Phone;
                referenceId?: string;
                status: "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION";
                taxId: string;
                updatedAt: Date;
                uuid: string;
                verificationData?: {
                    status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                    verificationSessionId: string;
                    verificationTemplateId: string;
                };
                verificationProfileId?: string;
                websiteUrl?: string;
            }[];
        };
    },
>
Parameters
- __namedParameters: {
      countriesOfIncorporation?: string[];
      createdAt?: DbTimestampCriteria;
      customerId: string;
      descriptionLike?: string;
      ids?: string[];
      legalEntityTypeLike?: string;
      nameLike?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfIncorporation: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "countryOfIncorporation";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          createdAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "createdAt";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          customerId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "customerId";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          data: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: {
                                      address?: ...;
                                      email?: ...;
                                      phone?: ...;
                                      verificationData?: ...;
                                      verificationProfileId?: ...;
                                      websiteUrl?: ...;
                                  };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "data";
                                  notNull: false;
                                  tableName: "organization";
                              },
                              {},
                              {
                                  $type: {
                                      address?: ...;
                                      email?: ...;
                                      phone?: ...;
                                      verificationData?: ...;
                                      verificationProfileId?: ...;
                                      websiteUrl?: ...;
                                  };
                              },
                          >;
                          description: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "description";
                                  notNull: false;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          entityType: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "entityType";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          externalId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: true;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "externalId";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          id: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: true;
                                  name: "id";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          name: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "name";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          referenceId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "referenceId";
                                  notNull: false;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          status: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "status";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              { $type: (...)
                              | (...)
                              | (...)
                              | (...) },
                          >;
                          taxId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "taxId";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          updatedAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "updatedAt";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                          uuid: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgUUID";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "uuid";
                                  notNull: true;
                                  tableName: "organization";
                              },
                              {},
                              {},
                          >;
                      };
                      dialect: "pg";
                      name: "organization";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalcountriesOfIncorporation?: string[]
  - OptionalcreatedAt?: DbTimestampCriteria
  - customerId: string
  - OptionaldescriptionLike?: string
    Partial match on description
  - Optionalids?: string[]
  - OptionallegalEntityTypeLike?: string
    Partial match on legal entity type
  - OptionalnameLike?: string
    Partial match on legal entity name
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        countryOfIncorporation: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "countryOfIncorporation";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        createdAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "createdAt";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        customerId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "customerId";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        data: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: {
                                    address?: ...;
                                    email?: ...;
                                    phone?: ...;
                                    verificationData?: ...;
                                    verificationProfileId?: ...;
                                    websiteUrl?: ...;
                                };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "data";
                                notNull: false;
                                tableName: "organization";
                            },
                            {},
                            {
                                $type: {
                                    address?: ...;
                                    email?: ...;
                                    phone?: ...;
                                    verificationData?: ...;
                                    verificationProfileId?: ...;
                                    websiteUrl?: ...;
                                };
                            },
                        >;
                        description: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "description";
                                notNull: false;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        entityType: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "entityType";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        externalId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: true;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "externalId";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        id: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: true;
                                name: "id";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        name: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "name";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        referenceId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "referenceId";
                                notNull: false;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        status: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: (...)
                                | (...)
                                | (...)
                                | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "status";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            { $type: (...)
                            | (...)
                            | (...)
                            | (...) },
                        >;
                        taxId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "taxId";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        updatedAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "updatedAt";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                        uuid: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgUUID";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "uuid";
                                notNull: true;
                                tableName: "organization";
                            },
                            {},
                            {},
                        >;
                    };
                    dialect: "pg";
                    name: "organization";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 50
  - OptionalreferenceIdLike?: string
    Partial match on reference ID
  - OptionalreferenceIds?: string[]
  - Optionalstatuses?: ("ACTIVE" | "DISABLED" | "PENDING_VERIFICATION")[]
  - OptionalupdatedAt?: DbTimestampCriteria
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"
                )[];
                countryOfIncorporation: string;
                createdAt: Date;
                description?: string;
                email?: string;
                id: string;
                legalEntityType: string;
                name: string;
                phone?: E164Phone;
                referenceId?: string;
                status: "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION";
                taxId: string;
                updatedAt: Date;
                uuid: string;
                verificationData?: {
                    status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                    verificationSessionId: string;
                    verificationTemplateId: string;
                };
                verificationProfileId?: string;
                websiteUrl?: string;
            }[];
        };
    },
>
Inherited from OrganizationQueryService.search
- Defined in packages/entity-services/src/organization/OrganizationQueryService.ts:69

update

update(
    __namedParameters: {
        customerId: string;
        data: Partial<
            Omit<
                Organization,
                | "id"
                | "name"
                | "capabilities"
                | "status"
                | "createdAt"
                | "updatedAt"
                | "verificationProfileId",
            >,
        >;
        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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | {
        error: | ServiceError<"INVALID_EMAIL" | "INVALID_WEBSITE_URL">
        | ServiceError<"NOT_FOUND" | "PRODUCT_INACTIVE" | "DUPLICATE">;
        ok: false;
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      data: Partial<
          Omit<
              Organization,
              | "id"
              | "name"
              | "capabilities"
              | "status"
              | "createdAt"
              | "updatedAt"
              | "verificationProfileId",
          >,
      >;
      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"
            )[];
            countryOfIncorporation: string;
            createdAt: Date;
            description?: string;
            email?: string;
            id: string;
            legalEntityType: string;
            name: string;
            phone?: E164Phone;
            referenceId?: string;
            status: "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION";
            taxId: string;
            updatedAt: Date;
            uuid: string;
            verificationData?: {
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                verificationSessionId: string;
                verificationTemplateId: string;
            };
            verificationProfileId?: string;
            websiteUrl?: string;
        };
    }
    | {
        error: | ServiceError<"INVALID_EMAIL" | "INVALID_WEBSITE_URL">
        | ServiceError<"NOT_FOUND" | "PRODUCT_INACTIVE" | "DUPLICATE">;
        ok: false;
    },
>
- Defined in packages/entity-services/src/organization/OrganizationService.ts:157

Class OrganizationService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OrganizationService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

create

Parameters

delete

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

get

Parameters

getVerificationUrl

Parameters

customerId: string

id: string

redirectUrl: string

Returns Promise< | { error: ServiceError; ok: false } | { ok: true; value: { url: string } },>

search

Parameters

OptionalcountriesOfIncorporation?: string[]

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

OptionaldescriptionLike?: string

Optionalids?: string[]

OptionallegalEntityTypeLike?: string

OptionalnameLike?: string

Optionalpage?: number

OptionalpageSize?: number

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

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

OptionalupdatedAt?: DbTimestampCriteria

update

Parameters

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

Returns Promise<
| { error: ServiceError; ok: false }
| { ok: true; value: { url: string } },
>

`Optional`countriesOfIncorporation?: string[]

`Optional`createdAt?: DbTimestampCriteria

`Optional`descriptionLike?: string

`Optional`ids?: string[]

`Optional`legalEntityTypeLike?: string

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

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

`Optional`updatedAt?: DbTimestampCriteria