Class BankDashboardWorkspaceAdminService

constructor

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

  Parameters

  • __namedParameters: { db: B2bDatabase }

  Returns BankDashboardWorkspaceAdminService

Staticinstance

get

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

  Parameters

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

  Returns Promise<BankDashboardStaffWorkspace | null>

search

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

  Every bank's workspace, for CFX staff to enter, by name, closed dashboards included. Only for a holder of user-shadow:r; each carries its owner role's keys as the caller may use them.

  Parameters

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

    • OptionalbankIds?: string[]

    • OptionaldashboardDomains?: string[]

      Matched against the stored lowercased domain.

    • OptionaldashboardEnabled?: boolean

    • Optionalpage?: number

    • OptionalpageSize?: number

    • Optionalq?: string

    • staff: Pick<DashboardStaff, "canShadowRead" | "canShadowWrite">

    • OptionalworkspaceIds?: string[]

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