Class CustomerDashboardWorkspaceAdminService

constructor

• new CustomerDashboardWorkspaceAdminService(
      __namedParameters: { db: B2bDatabase },
  ): CustomerDashboardWorkspaceAdminService

  Parameters

  • __namedParameters: { db: B2bDatabase }

  Returns CustomerDashboardWorkspaceAdminService

Staticinstance

create

• create(
      __namedParameters?: {
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
      },
  ): Promise<CreatedWorkspace>

  A CUSTOMER workspace on the default role set, with no customer and no members yet. A customer later takes it (CustomerService.createIn).

  Parameters

  • __namedParameters: { tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> } = {}

  Returns Promise<CreatedWorkspace>

createForApplicant

• createForApplicant(
      __namedParameters: {
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      },
  ): Promise<CreatedWorkspace>

  create's workspace with userId as its owner: an ACTIVE member on the default role set's top non-internal role. On an error, a caller's tx must be rolled back by the caller.

  Parameters

  • __namedParameters: {
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        userId: string;
    }

  Returns Promise<CreatedWorkspace>

get

• get(
      __namedParameters: {
          customerId: string;
          staff: Pick<DashboardStaff, "canShadowRead" | "canShadowWrite">;
      },
  ): Promise<CustomerDashboardStaffWorkspace | null>

  Parameters

  • __namedParameters: {
        customerId: string;
        staff: Pick<DashboardStaff, "canShadowRead" | "canShadowWrite">;
    }

  Returns Promise<CustomerDashboardStaffWorkspace | null>

getForBilling

• getForBilling(
      __namedParameters: { customerId: string },
  ): Promise<CustomerDashboardWorkspaceBilling | null>

  The customer's billing addresses and contact line, for operators: unlike get, not gated on user-shadow:r or the customer being ACTIVE. Null for no customer.

  Parameters

  • __namedParameters: { customerId: string }

  Returns Promise<CustomerDashboardWorkspaceBilling | null>

search

• search(
      input: {
          customerIds?: string[];
          page?: number;
          pageSize?: number;
          q?: string;
          staff: Pick<DashboardStaff, "canShadowRead" | "canShadowWrite">;
          workspaceIds?: string[];
      },
  ): Promise<
      | {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardStaffWorkspace[];
              total: number;
          };
      }
      | { error: ServiceError; ok: false },
  >

  The workspaces CFX staff may enter (user-shadow:r only): live ACTIVE customers with their main organization, each with its owner's keys as the caller may use them.

  Parameters

  • input: {
        customerIds?: string[];
        page?: number;
        pageSize?: number;
        q?: string;
        staff: Pick<DashboardStaff, "canShadowRead" | "canShadowWrite">;
        workspaceIds?: string[];
    }

  Returns Promise<
      | {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardStaffWorkspace[];
              total: number;
          };
      }
      | { error: ServiceError; ok: false },
  >

update

• update(
      input: CustomerDashboardWorkspaceBillingUpdate,
  ): Promise<
      | { ok: true; value: CustomerDashboardWorkspaceBilling }
      | {
          error:
              | ServiceError<"CUSTOMER_NOT_FOUND", { customerId: string }>
              | ServiceError<"INVALID_BILLING_EMAIL_ADDRESS", { emailAddress: string }>
              | ServiceError<"INVALID_BILLING_ATTENTION", { attention: string }>;
          ok: false;
      },
  >

  Replace the billing addresses (trimmed, lowercased and deduplicated), the contact line (trimmed; blank clears it), or both. A contact line over 200 characters or with a control character is refused and nothing is written.

  Parameters

  • input: CustomerDashboardWorkspaceBillingUpdate

  Returns Promise<
      | { ok: true; value: CustomerDashboardWorkspaceBilling }
      | {
          error:
              | ServiceError<"CUSTOMER_NOT_FOUND", { customerId: string }>
              | ServiceError<"INVALID_BILLING_EMAIL_ADDRESS", { emailAddress: string }>
              | ServiceError<"INVALID_BILLING_ATTENTION", { attention: string }>;
          ok: false;
      },
  >