Variable queryKeysConst

Type Declaration

• capabilities: {
      all: readonly ["capabilities"];
      detail: (moduleKey: string) => readonly ["capabilities", "detail", string];
      list: () => readonly ["capabilities", "list"];
  }

  • all: readonly ["capabilities"]

  • detail: (moduleKey: string) => readonly ["capabilities", "detail", string]

    Key for capabilitiesClient.get(moduleKey).

  • list: () => readonly ["capabilities", "list"]

    Key for capabilitiesClient.list().

• effectiveAccess: {
      all: readonly ["effectiveAccess"];
      batchCan: (
          request: unknown,
      ) => readonly ["effectiveAccess", "batchCan", unknown];
      can: (request: unknown) => readonly ["effectiveAccess", "can", unknown];
      summary: (
          companyId?: string,
      ) => readonly ["effectiveAccess", "summary", string | null];
  }

  • all: readonly ["effectiveAccess"]

  • batchCan: (request: unknown) => readonly ["effectiveAccess", "batchCan", unknown]

    Key for effectiveAccessClient.batchCan(request).

  • can: (request: unknown) => readonly ["effectiveAccess", "can", unknown]

    Key for effectiveAccessClient.can(request).

  • summary: (companyId?: string) => readonly ["effectiveAccess", "summary", string | null]

    Key for effectiveAccessClient.summary(companyId?).

• org: {
      all: readonly ["org"];
      meCompanies: () => readonly ["org", "meCompanies"];
      members: {
          all: (companyId: string) => readonly ["org", "members", string];
          detail: (id: string) => readonly ["org", "members", "detail", string];
          list: (
              companyId: string,
              page?: number,
              pageSize?: number,
          ) => readonly [
              "org",
              "members",
              string,
              "list",
              number
              | null,
              number | null,
          ];
      };
      positions: {
          all: (companyId: string) => readonly ["org", "positions", string];
          detail: (id: string) => readonly ["org", "positions", "detail", string];
          holder: (
              id: string,
              date: string,
          ) => readonly ["org", "positions", "detail", string, "holder", string];
          list: (
              companyId: string,
              page?: number,
              pageSize?: number,
          ) => readonly [
              "org",
              "positions",
              string,
              "list",
              number
              | null,
              number | null,
          ];
      };
      units: {
          all: () => readonly ["org", "units"];
          detail: (id: string) => readonly ["org", "units", string];
          subtree: (id: string) => readonly ["org", "units", string, "subtree"];
      };
  }

  • all: readonly ["org"]

  • meCompanies: () => readonly ["org", "meCompanies"]

    Key for orgClient.meCompanies().

  • members: {
        all: (companyId: string) => readonly ["org", "members", string];
        detail: (id: string) => readonly ["org", "members", "detail", string];
        list: (
            companyId: string,
            page?: number,
            pageSize?: number,
        ) => readonly [
            "org",
            "members",
            string,
            "list",
            number
            | null,
            number | null,
        ];
    }

    • all: (companyId: string) => readonly ["org", "members", string]

      Key for the members list, scoped to one company.

    • detail: (id: string) => readonly ["org", "members", "detail", string]

      Key for orgClient.getMember(id).

    • list: (
          companyId: string,
          page?: number,
          pageSize?: number,
      ) => readonly [
          "org",
          "members",
          string,
          "list",
          number
          | null,
          number | null,
      ]

      Key for orgClient.listMembers(companyId, page?, pageSize?).

  • positions: {
        all: (companyId: string) => readonly ["org", "positions", string];
        detail: (id: string) => readonly ["org", "positions", "detail", string];
        holder: (
            id: string,
            date: string,
        ) => readonly ["org", "positions", "detail", string, "holder", string];
        list: (
            companyId: string,
            page?: number,
            pageSize?: number,
        ) => readonly [
            "org",
            "positions",
            string,
            "list",
            number
            | null,
            number | null,
        ];
    }

    • all: (companyId: string) => readonly ["org", "positions", string]

      Key for the positions list, scoped to one company.

    • detail: (id: string) => readonly ["org", "positions", "detail", string]

      Key for orgClient.getPosition(id).

    • holder: (
          id: string,
          date: string,
      ) => readonly ["org", "positions", "detail", string, "holder", string]

      Key for orgClient.holderOnDate(id, date).

    • list: (
          companyId: string,
          page?: number,
          pageSize?: number,
      ) => readonly [
          "org",
          "positions",
          string,
          "list",
          number
          | null,
          number | null,
      ]

      Key for orgClient.listPositions(companyId, page?, pageSize?).

  • units: {
        all: () => readonly ["org", "units"];
        detail: (id: string) => readonly ["org", "units", string];
        subtree: (id: string) => readonly ["org", "units", string, "subtree"];
    }

    • all: () => readonly ["org", "units"]

      Key for the org-units list.

    • detail: (id: string) => readonly ["org", "units", string]

      Key for orgClient.getUnit(id).

    • subtree: (id: string) => readonly ["org", "units", string, "subtree"]

      Key for orgClient.subtree(id).

• superadmin: {
      all: readonly ["superadmin"];
      catalog: () => readonly ["superadmin", "catalog"];
  }

  • all: readonly ["superadmin"]

  • catalog: () => readonly ["superadmin", "catalog"]

    Key for superadminClient.catalog().