Class CustomerDashboardMembershipAdminService

constructor

• new CustomerDashboardMembershipAdminService(
      __namedParameters: {
          db: B2bDatabase;
          internalEventPublisher: InternalEventPublisher;
      },
  ): CustomerDashboardMembershipAdminService

  Parameters

  • __namedParameters: { db: B2bDatabase; internalEventPublisher: InternalEventPublisher }

  Returns CustomerDashboardMembershipAdminService

Staticinstance

acceptPendingInvites

• acceptPendingInvites(
      __namedParameters: {
          customerIds?: string[];
          email: string;
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      },
  ): Promise<
      | { ok: true; value: CustomerDashboardInviteAcceptance }
      | { error: ServiceError; ok: false },
  >

  Accepts the proven address's recent PENDING invites for the user (see decideMembership), keeping a live row's status. customerIds limits it to those customers' invites; a sign-in passes none and takes them all.

  Parameters

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

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

delete

• delete(
      __namedParameters: {
          customerId: string;
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      },
  ): Promise<
      | { ok: true; value: AdminMemberSnapshot & { removed: boolean } }
      | { error: ServiceError; ok: false },
  >

  An operator's removal: the row is soft-deleted. No rank rule applies, but the last ACTIVE holder of the top role cannot be removed (LAST_OWNER). removed is false when the row was already removed (a concurrent removal, or a retry); the removal is published either way. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

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

  Returns Promise<
      | { ok: true; value: AdminMemberSnapshot & { removed: boolean } }
      | { error: ServiceError; ok: false },
  >

search

• search(
      __namedParameters?: {
          customerIds?: string[];
          emails?: string[];
          includeDeleted?: boolean;
          page?: number;
          pageSize?: number;
          statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
          userIds?: string[];
          workspaceIds?: string[];
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardMembership[];
              total: number;
          };
      },
  >

  Parameters

  • __namedParameters: {
        customerIds?: string[];
        emails?: string[];
        includeDeleted?: boolean;
        page?: number;
        pageSize?: number;
        statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
        userIds?: string[];
        workspaceIds?: string[];
    } = {}

    • OptionalcustomerIds?: string[]

    • Optionalemails?: string[]

      Matched case-insensitively.

    • OptionalincludeDeleted?: boolean

    • Optionalpage?: number

      Defaults to 1

    • OptionalpageSize?: number

      Defaults to 100

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

    • OptionaluserIds?: string[]

    • OptionalworkspaceIds?: string[]

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

searchUsers

• searchUsers(
      __namedParameters?: {
          ids?: string[];
          page?: number;
          pageSize?: number;
          query?: string;
          standings?: ("ACTIVE" | "DISABLED" | "NONE")[];
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardMemberUser[];
              total: number;
          };
      },
  >

  Dashboard users across every customer, newest first with membership-less users last, each with their live memberships: whoever has joined or been synced, with or without one now.

  Parameters

  • __namedParameters: {
        ids?: string[];
        page?: number;
        pageSize?: number;
        query?: string;
        standings?: ("ACTIVE" | "DISABLED" | "NONE")[];
    } = {}

    • Optionalids?: string[]

    • Optionalpage?: number

      Defaults to 1

    • OptionalpageSize?: number

      Defaults to 50

    • Optionalquery?: string

      Case-insensitive substring of the email, the full name or the id.

    • Optionalstandings?: ("ACTIVE" | "DISABLED" | "NONE")[]

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

update

• update(
      __namedParameters: {
          customerId: string;
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      } & (
          | { roleId: string; status?: WritableStatus | undefined }
          | { roleId?: undefined; status: WritableStatus }
      ),
  ): Promise<
      | {
          ok: true;
          value: AdminMemberSnapshot & {
              changed: boolean;
              previousRoleId: string
              | null;
              previousRoleIsInternal: boolean;
              previousRoleName: string | null;
              previousStatus: "ACTIVE" | "DELETED" | "DISABLED";
              roleIsInternal: boolean;
              status: "ACTIVE" | "DELETED" | "DISABLED";
          };
      }
      | { error: ServiceError; ok: false },
  >

  An operator's role change, enable or disable. A role must be in the customer's current set; only confirmed CFX staff hold its internal role. No rank rule applies, but the last ACTIVE holder of the top role cannot be moved off it or disabled (LAST_OWNER). changed is false when nothing differed; the requested move is published either way. Nothing is recorded in the workspace's own feed, as for an operator's role change: the caller keeps the admin activity log. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

  • __namedParameters: {
        customerId: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        userId: string;
    } & (
        | { roleId: string; status?: WritableStatus | undefined }
        | { roleId?: undefined; status: WritableStatus }
    )

  Returns Promise<
      | {
          ok: true;
          value: AdminMemberSnapshot & {
              changed: boolean;
              previousRoleId: string
              | null;
              previousRoleIsInternal: boolean;
              previousRoleName: string | null;
              previousStatus: "ACTIVE" | "DELETED" | "DISABLED";
              roleIsInternal: boolean;
              status: "ACTIVE" | "DELETED" | "DISABLED";
          };
      }
      | { error: ServiceError; ok: false },
  >