@isaac-platform/isaac-integration-sdk
Version:
A Typescript SDK for integrating with ISAAC
21 lines • 982 B
TypeScript
import { Subsystem, SubsystemType } from "./SubsystemTypes.js";
declare class SubsystemController {
constructor();
/**
* Get details for all subsystems from ISAAC.
* @param type - filter by Subsystem Type
* @param isCMS - filter to only CMS types
* @param includePlayers - include players (not included by default)
* @returns Promise<Subsystem[]> - An array of subsystems from ISAAC
*/
getSubsystems: (type?: SubsystemType, isCMS?: boolean, includePlayers?: boolean) => Promise<Subsystem[]>;
/**
* Get subsystem details from ISAAC.
* @param id - the internal ID number or externalRef string used to identify the subsystem in ISAAC.
* @returns Promise<Subsystem> - The details for the identified subsystem. (May be empty)
*/
getSubsystem: (id: number | string) => Promise<Subsystem>;
}
declare const subsystemController: SubsystemController;
export default subsystemController;
//# sourceMappingURL=index.d.ts.map