Class CustomerApplicationAdminService

CFX's side of an application: handing an APPROVED one over to provisioning.

Hierarchy (View Summary)

CustomerApplicationService
- CustomerApplicationAdminService

Index

Constructors

constructor

new CustomerApplicationAdminService(
    args: {
        aiPriseClient: Pick<
            AiPriseClient,
            | "createBusinessProfile"
            | "createVerificationSessionUrlForBusinessProfile"
            | "renewBusinessVerificationUrl"
            | "verifyOrigin",
        >;
        db: B2bDatabase;
        internalEventPublisher: Pick<InternalEventPublisher, "publish">;
        logger?: Pick<Console, "warn" | "error">;
        verificationTemplateService: Pick<VerificationTemplateService, "search">;
        workspaceAdminService: Pick<
            CustomerDashboardWorkspaceAdminService,
            "createForApplicant",
        >;
    } & {
        aiPriseClient: Pick<
            AiPriseClient,
            "getBusinessProfile"
            | "getUserProfile",
        >;
        attioClient: Pick<AttioClient, "findOrCreateCompanyByDomain">;
        onboardingWorkflowService: Pick<
            CustomerOnboardingWorkflowService,
            "start",
        >;
    },
): CustomerApplicationAdminService
Parameters
- args: {
      aiPriseClient: Pick<
          AiPriseClient,
          | "createBusinessProfile"
          | "createVerificationSessionUrlForBusinessProfile"
          | "renewBusinessVerificationUrl"
          | "verifyOrigin",
      >;
      db: B2bDatabase;
      internalEventPublisher: Pick<InternalEventPublisher, "publish">;
      logger?: Pick<Console, "warn" | "error">;
      verificationTemplateService: Pick<VerificationTemplateService, "search">;
      workspaceAdminService: Pick<
          CustomerDashboardWorkspaceAdminService,
          "createForApplicant",
      >;
  } & {
      aiPriseClient: Pick<
          AiPriseClient,
          "getBusinessProfile"
          | "getUserProfile",
      >;
      attioClient: Pick<AttioClient, "findOrCreateCompanyByDomain">;
      onboardingWorkflowService: Pick<CustomerOnboardingWorkflowService, "start">;
  }
  - aiPriseClient: Pick<
        AiPriseClient,
        | "createBusinessProfile"
        | "createVerificationSessionUrlForBusinessProfile"
        | "renewBusinessVerificationUrl"
        | "verifyOrigin",
    >
  - db: B2bDatabase
  - internalEventPublisher: Pick<InternalEventPublisher, "publish">
    
    Tells the applicant's workspace, by email, as the application moves.
  - Optionallogger?: Pick<Console, "warn" | "error">
  - verificationTemplateService: Pick<VerificationTemplateService, "search">
  - workspaceAdminService: Pick<CustomerDashboardWorkspaceAdminService, "createForApplicant">
  - aiPriseClient: Pick<AiPriseClient, "getBusinessProfile" | "getUserProfile">
  - attioClient: Pick<AttioClient, "findOrCreateCompanyByDomain">
  - onboardingWorkflowService: Pick<CustomerOnboardingWorkflowService, "start">
Returns CustomerApplicationAdminService
Overrides CustomerApplicationService.constructor
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:273

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`logger

logger: Pick<Console, "warn" | "error">

`Static`instance

instance: (...args: []) => CustomerApplicationAdminService = ...

The process service: the applicant's side plus AiPrise, Attio and onboarding.

Methods

eligibility

eligibility(
    __namedParameters: { userId: string },
): Promise<
    | { eligible: true }
    | {
        application: CustomerApplication;
        eligible: false;
        reason: "HAS_APPLICATION";
    }
    | { eligible: false; reason: "CUSTOMER_MEMBER" },
>
Whether userId may start an application: not while one of theirs (screened out included) is where they belong, nor once they are an ACTIVE member of a customer. Membership of another ACTIVE customer outranks their own application: an applicant invited into one belongs in its dashboard.
Parameters
- __namedParameters: { userId: string }
Returns Promise<
    | { eligible: true }
    | {
        application: CustomerApplication;
        eligible: false;
        reason: "HAS_APPLICATION";
    }
    | { eligible: false; reason: "CUSTOMER_MEMBER" },
>
Inherited from CustomerApplicationService.eligibility
- Defined in onboarding-services/src/CustomerApplicationService.ts:577

`Protected`extendSession

extendSession(
    __namedParameters: { id: number; sessionId: string },
): Promise<
    { ok: true; value: Instant }
    | { error: AiPriseError; ok: false },
>
Extends a stored session at AiPrise to just under its 90-day ceiling, then records the new expiry.
Parameters
- __namedParameters: { id: number; sessionId: string }
Returns Promise<{ ok: true; value: Instant } | { error: AiPriseError; ok: false }>
Inherited from CustomerApplicationService.extendSession
- Defined in onboarding-services/src/CustomerApplicationService.ts:1282

get

get(
__namedParameters: { id: string; userId?: string },
): Promise<AdminCustomerApplication | null>
Parameters
- __namedParameters: { id: string; userId?: string }
Returns Promise<AdminCustomerApplication | null>
Overrides CustomerApplicationService.get
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:477

handover

handover(
    __namedParameters: { verificationProfileId: string },
): Promise<
    | { ok: true; value: { customerId: string } }
    | {
        error:
            | ServiceError<
                "ADDRESS_REQUIRED"
                | "EMAIL_REQUIRED"
                | "PHONE_REQUIRED",
            >
            | ServiceError<
                | "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NO_CONTROL_PERSON"
                | "INVALID_ADOPTED_PERSON",
            >
            | ServiceError<"ONBOARDING_START_FAILED" | "NOT_A_ROUTE_FUSION_PROGRAM">
            | RoutedError;
        ok: false;
    },
>
Provisions the customer of an application whose business profile AiPrise APPROVED, on the operator path: the applicant's workspace, the people AiPrise holds, one workflow run per application. Safe to repeat, and to run concurrently: one profile's handovers take turns.
Parameters
- __namedParameters: { verificationProfileId: string }
Returns Promise<
    | { ok: true; value: { customerId: string } }
    | {
        error:
            | ServiceError<
                "ADDRESS_REQUIRED"
                | "EMAIL_REQUIRED"
                | "PHONE_REQUIRED",
            >
            | ServiceError<
                | "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NO_CONTROL_PERSON"
                | "INVALID_ADOPTED_PERSON",
            >
            | ServiceError<"ONBOARDING_START_FAILED" | "NOT_A_ROUTE_FUSION_PROGRAM">
            | RoutedError;
        ok: false;
    },
>
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:299

markFailed

markFailed(
__namedParameters: { customerId: string },
): Promise<{ ok: true; value: { marked: boolean } }>
The provisioning workflow calls this when it fails before the customer row exists: PROVISIONING becomes FAILED. Idempotent; marked is false when nothing changed.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<{ ok: true; value: { marked: boolean } }>
Inherited from CustomerApplicationService.markFailed
- Defined in onboarding-services/src/CustomerApplicationService.ts:1051

markProvisioned

markProvisioned(
__namedParameters: { customerId: string },
): Promise<{ ok: true; value: { marked: boolean } }>
The provisioning workflow's last step: PROVISIONING becomes PROVISIONED. Idempotent; marked is false when nothing changed.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<{ ok: true; value: { marked: boolean } }>
Inherited from CustomerApplicationService.markProvisioned
- Defined in onboarding-services/src/CustomerApplicationService.ts:1072

notifyApproved

notifyApproved(
__namedParameters: { customerId: string },
): Promise<{ ok: true; value: { notified: boolean } }>
The customer provisioning made from an application went ACTIVE: tell the workspace its account is ready. Call only from the write that activated it, so it is sent once. notified is false for an operator-path customer.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<{ ok: true; value: { notified: boolean } }>
Inherited from CustomerApplicationService.notifyApproved
- Defined in onboarding-services/src/CustomerApplicationService.ts:1132

openSession

openSession(
    __namedParameters: Applicant & ReturnOrigin & { id: string },
): Promise<
    | { ok: true; value: { url: string } }
    | { error: ServiceError; ok: false },
>
The framed form's URL for an ACTIVE member of the application's workspace. Rebuilds the stored session's URL, renewing it when under a day is left; only a DRAFT asks AiPrise for a session, getting its profile too.
Parameters
- __namedParameters: Applicant & ReturnOrigin & { id: string }
Returns Promise<
| { ok: true; value: { url: string } }
| { error: ServiceError; ok: false },
>
Inherited from CustomerApplicationService.openSession
- Defined in onboarding-services/src/CustomerApplicationService.ts:808

`Protected`readPage

readPage(
__namedParameters: SearchArgs,
db?: Executor,
): Promise<{ hasNext: boolean; rows: ApplicationRow[]; total: number }>
Parameters
- __namedParameters: SearchArgs
- db: Executor = ...
Returns Promise<{ hasNext: boolean; rows: ApplicationRow[]; total: number }>
Inherited from CustomerApplicationService.readPage
- Defined in onboarding-services/src/CustomerApplicationService.ts:835

recordVerification

recordVerification(
    __namedParameters: {
        previous:
            | {
                lifecycleStatus: | "PROFILE_NOT_SUBMITTED"
                | "ONBOARDING_SESSIONS_PENDING"
                | "READY_FOR_REVIEW"
                | "ADDITIONAL_INFO_REQUESTED"
                | "MONITORING_UPDATES"
                | "SESSIONS_EXPIRED"
                | null;
                result: | "DECLINED"
                | "APPROVED"
                | "REVIEW"
                | "UNKNOWN"
                | "DEACTIVATED"
                | null;
            }
            | null;
        verificationProfileId: string;
    },
): Promise<{ ok: true; value: { notified: boolean } }>
A refresh of the application's AiPrise profile has been written: when it moved the application into review, an information request or a decline, tell the workspace. previous is the shadow the refresh's own write replaced, so a duplicate delivery, which replaces an identical row, finds no change. notified is false when nothing was published.
Parameters
- __namedParameters: {
      previous:
          | {
              lifecycleStatus: | "PROFILE_NOT_SUBMITTED"
              | "ONBOARDING_SESSIONS_PENDING"
              | "READY_FOR_REVIEW"
              | "ADDITIONAL_INFO_REQUESTED"
              | "MONITORING_UPDATES"
              | "SESSIONS_EXPIRED"
              | null;
              result: | "DECLINED"
              | "APPROVED"
              | "REVIEW"
              | "UNKNOWN"
              | "DEACTIVATED"
              | null;
          }
          | null;
      verificationProfileId: string;
  }
Returns Promise<{ ok: true; value: { notified: boolean } }>
Inherited from CustomerApplicationService.recordVerification
- Defined in onboarding-services/src/CustomerApplicationService.ts:1094

renewSession

renewSession(
    __namedParameters: { id: string },
): Promise<
    | {
        ok: true;
        value: { expiresAt: string; previousExpiresAt: string
        | null };
    }
    | { error: ServiceError; ok: false },
>
Extends the AiPrise session of an applicant who still has the form to finish to a day under AiPrise's 90: the RENEW_LINK of availableActions. Returns only the expiries, never the session.
Parameters
- __namedParameters: { id: string }
Returns Promise<
    | {
        ok: true;
        value: { expiresAt: string; previousExpiresAt: string
        | null };
    }
    | { error: ServiceError; ok: false },
>
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:547

retryHandover

retryHandover(
    __namedParameters: { id: string },
): Promise<
    | { ok: true; value: { customerId: string } }
    | {
        error:
            | ServiceError<
                "ADDRESS_REQUIRED"
                | "EMAIL_REQUIRED"
                | "PHONE_REQUIRED",
            >
            | ServiceError<
                | "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NO_CONTROL_PERSON"
                | "INVALID_ADOPTED_PERSON",
            >
            | ServiceError<"ONBOARDING_START_FAILED" | "NOT_A_ROUTE_FUSION_PROGRAM">
            | RoutedError
            | ServiceError<
                "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NOT_SUBMITTED",
            >;
        ok: false;
    },
>
Hands a SUBMITTED application whose profile reads APPROVED over again by its id: the RETRY_HANDOVER of availableActions.
Parameters
- __namedParameters: { id: string }
Returns Promise<
    | { ok: true; value: { customerId: string } }
    | {
        error:
            | ServiceError<
                "ADDRESS_REQUIRED"
                | "EMAIL_REQUIRED"
                | "PHONE_REQUIRED",
            >
            | ServiceError<
                | "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NO_CONTROL_PERSON"
                | "INVALID_ADOPTED_PERSON",
            >
            | ServiceError<"ONBOARDING_START_FAILED" | "NOT_A_ROUTE_FUSION_PROGRAM">
            | RoutedError
            | ServiceError<
                "APPLICATION_NOT_FOUND"
                | "NOT_APPROVED"
                | "NOT_SUBMITTED",
            >;
        ok: false;
    },
>
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:491

search

search(
    args: SearchArgs,
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: AdminCustomerApplication[];
            total: number;
        };
    },
>
Live applications with the operator's view of each; never reads out the session id, which rebuilds the applicant's URL.
Parameters
- args: SearchArgs
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: AdminCustomerApplication[];
            total: number;
        };
    },
>
Overrides CustomerApplicationService.search
- Defined in onboarding-services/src/CustomerApplicationAdminService.ts:460

submit

submit(
    __namedParameters: Applicant & ReturnOrigin & {
        basics: ApplicationBasics;
    },
): Promise<
    | { ok: true; value: CustomerApplication }
    | {
        error:
            | ServiceError<"INVALID_BASICS", { field: keyof ApplicationBasics }>
            | ServiceError<
                "SHORT_NAME_TAKEN"
                | "ALREADY_APPLYING"
                | "ALREADY_CUSTOMER_MEMBER",
            >;
        ok: false;
    },
>
Basics and screener in one submit: screened out, or a workspace the applicant owns, an AiPrise profile and a session. An AiPrise failure throws and leaves the row DRAFT, which openSession resumes.
Parameters
- __namedParameters: Applicant & ReturnOrigin & { basics: ApplicationBasics }
Returns Promise<
    | { ok: true; value: CustomerApplication }
    | {
        error:
            | ServiceError<"INVALID_BASICS", { field: keyof ApplicationBasics }>
            | ServiceError<
                "SHORT_NAME_TAKEN"
                | "ALREADY_APPLYING"
                | "ALREADY_CUSTOMER_MEMBER",
            >;
        ok: false;
    },
>
Inherited from CustomerApplicationService.submit
- Defined in onboarding-services/src/CustomerApplicationService.ts:621

`Protected`toApplication

toApplication(row: ApplicationRow): CustomerApplication
The applicant's view of a readPage row; the admin adds the operator's.
Parameters
- row: ApplicationRow
Returns CustomerApplication
Inherited from CustomerApplicationService.toApplication
- Defined in onboarding-services/src/CustomerApplicationService.ts:977

`Protected`update

update(
    __namedParameters: {
        id: number;
        only?: { statuses: CustomerApplicationStatus[] };
        set: Partial<
            Pick<
                SelectCustomerApplication,
                | "status"
                | "verificationProfileId"
                | "verificationSessionId"
                | "verificationSessionExpiresAt"
                | "attioId",
            >,
        >;
        unless?: | { set: "verificationProfileId"
        | "verificationSessionId" }
        | { status: CustomerApplicationStatus }
        | { customer: "exists" };
    },
    db?: Executor,
): Promise<boolean>
The one write to an existing application. only and unless make it a compare-and-set: the row changes only while its status is only's, and while that column is still null, its status is not yet the one named, or no customer holds its workspace. True when a row changed.
Parameters
- __namedParameters: {
      id: number;
      only?: { statuses: CustomerApplicationStatus[] };
      set: Partial<
          Pick<
              SelectCustomerApplication,
              | "status"
              | "verificationProfileId"
              | "verificationSessionId"
              | "verificationSessionExpiresAt"
              | "attioId",
          >,
      >;
      unless?: | { set: "verificationProfileId"
      | "verificationSessionId" }
      | { status: CustomerApplicationStatus }
      | { customer: "exists" };
  }
- db: Executor = ...
Returns Promise<boolean>
Inherited from CustomerApplicationService.update
- Defined in onboarding-services/src/CustomerApplicationService.ts:987

Class CustomerApplicationAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

aiPriseClient: Pick< AiPriseClient, | "createBusinessProfile" | "createVerificationSessionUrlForBusinessProfile" | "renewBusinessVerificationUrl" | "verifyOrigin",>

db: B2bDatabase

internalEventPublisher: Pick<InternalEventPublisher, "publish">

Optionallogger?: Pick<Console, "warn" | "error">

verificationTemplateService: Pick<VerificationTemplateService, "search">

workspaceAdminService: Pick<CustomerDashboardWorkspaceAdminService, "createForApplicant">

aiPriseClient: Pick<AiPriseClient, "getBusinessProfile" | "getUserProfile">

attioClient: Pick<AttioClient, "findOrCreateCompanyByDomain">

onboardingWorkflowService: Pick<CustomerOnboardingWorkflowService, "start">

Returns CustomerApplicationAdminService

Properties

Protected Readonlydb

Protected Readonlylogger

Staticinstance

Methods

eligibility

Parameters

Returns Promise< | { eligible: true } | { application: CustomerApplication; eligible: false; reason: "HAS_APPLICATION"; } | { eligible: false; reason: "CUSTOMER_MEMBER" },>

ProtectedextendSession

Parameters

Returns Promise<{ ok: true; value: Instant } | { error: AiPriseError; ok: false }>

get

Parameters

Returns Promise<AdminCustomerApplication | null>

handover

Parameters

markFailed

Parameters

Returns Promise<{ ok: true; value: { marked: boolean } }>

markProvisioned

Parameters

Returns Promise<{ ok: true; value: { marked: boolean } }>

notifyApproved

Parameters

Returns Promise<{ ok: true; value: { notified: boolean } }>

openSession

Parameters

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

ProtectedreadPage

Parameters

Returns Promise<{ hasNext: boolean; rows: ApplicationRow[]; total: number }>

recordVerification

Parameters

Returns Promise<{ ok: true; value: { notified: boolean } }>

renewSession

Parameters

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

retryHandover

Parameters

search

Parameters

Returns Promise< { ok: true; value: { hasNext: boolean; items: AdminCustomerApplication[]; total: number; }; },>

submit

Parameters

Returns Promise< | { ok: true; value: CustomerApplication } | { error: | ServiceError<"INVALID_BASICS", { field: keyof ApplicationBasics }> | ServiceError< "SHORT_NAME_TAKEN" | "ALREADY_APPLYING" | "ALREADY_CUSTOMER_MEMBER", >; ok: false; },>

ProtectedtoApplication

Parameters

Returns CustomerApplication

Protectedupdate

Parameters

Returns Promise<boolean>

Settings

On This Page

aiPriseClient: Pick<
AiPriseClient,
| "createBusinessProfile"
| "createVerificationSessionUrlForBusinessProfile"
| "renewBusinessVerificationUrl"
| "verifyOrigin",
>

`Optional`logger?: Pick<Console, "warn" | "error">

`Protected` `Readonly`db

`Protected` `Readonly`logger

`Static`instance

Returns Promise<
| { eligible: true }
| {
application: CustomerApplication;
eligible: false;
reason: "HAS_APPLICATION";
}
| { eligible: false; reason: "CUSTOMER_MEMBER" },
>

`Protected`extendSession

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

`Protected`readPage

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

Returns Promise<
{
ok: true;
value: {
hasNext: boolean;
items: AdminCustomerApplication[];
total: number;
};
},
>

Returns Promise<
| { ok: true; value: CustomerApplication }
| {
error:
| ServiceError<"INVALID_BASICS", { field: keyof ApplicationBasics }>
| ServiceError<
"SHORT_NAME_TAKEN"
| "ALREADY_APPLYING"
| "ALREADY_CUSTOMER_MEMBER",
>;
ok: false;
},
>

`Protected`toApplication

`Protected`update