@en-solutions/tgm-client-sdk 1.6.21

package/lib/models/api/energy.models.d.ts

@@ -0,0 +1,210 @@
+import { AncillaryServiceStatus, AncillaryServiceType, GridConnectionStatus, CurtailmentType, CurtailmentStatus, OutageType, OutageStatus } from '../enums';
+export interface AncillaryService {
+    id: number;
+    serviceName: string;
+    description?: string;
+    serviceType?: AncillaryServiceType;
+    status?: AncillaryServiceStatus;
+    contractNumber?: string;
+    gridOperator?: string;
+    unitId?: number;
+    startDate?: string;
+    endDate?: string;
+    committedCapacityMw?: number;
+    availableCapacityMw?: number;
+    ratePerMw?: number;
+    monthlyRevenue?: number;
+    totalRevenue?: number;
+    penaltyRate?: number;
+    availabilityTarget?: number;
+    actualAvailability?: number;
+    responseTimeSeconds?: number;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface GridConnection {
+    id: number;
+    connectionId?: string;
+    connectionName: string;
+    description?: string;
+    status?: GridConnectionStatus;
+    gridOperator?: string;
+    unitId?: number;
+    poiName?: string;
+    meterId?: string;
+    meterType?: string;
+    voltageLevelKv?: number;
+    maxExportCapacityMw?: number;
+    maxImportCapacityMw?: number;
+    poiLatitude?: number;
+    poiLongitude?: number;
+    connectionFee?: number;
+    monthlyCharges?: number;
+    connectionDate?: string;
+    lastMaintenanceDate?: string;
+    nextMaintenanceDate?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CurtailmentEvent {
+    id: number;
+    eventNumber?: string;
+    title: string;
+    description?: string;
+    curtailmentType?: CurtailmentType;
+    status?: CurtailmentStatus;
+    unitId?: number;
+    gridConnectionId?: number;
+    orderedBy?: string;
+    orderReference?: string;
+    startTime?: string;
+    endTime?: string;
+    curtailedCapacityMw?: number;
+    remainingCapacityMw?: number;
+    lostRevenue?: number;
+    compensationAmount?: number;
+    completionNotes?: string;
+    durationHours?: number;
+    netFinancialImpact?: number;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface OutageEvent {
+    id: number;
+    outageNumber?: string;
+    title: string;
+    description?: string;
+    outageType?: OutageType;
+    status?: OutageStatus;
+    unitId?: number;
+    failureId?: number;
+    plannedStart?: string;
+    plannedEnd?: string;
+    actualStart?: string;
+    actualEnd?: string;
+    capacityMw?: number;
+    lostCapacityMw?: number;
+    estimatedCost?: number;
+    actualCost?: number;
+    lostRevenue?: number;
+    rootCause?: string;
+    correctiveAction?: string;
+    approvalDate?: string;
+    approvalNotes?: string;
+    approvalStatus?: string;
+    completionNotes?: string;
+    remainingCapacityMw?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface OperatingEvent {
+    id: number;
+    name?: string;
+    title?: string;
+    description?: string;
+    type?: 'Manual' | 'Automatic' | 'IoT' | 'DigitalTwin' | string;
+    nature?: 'Incident' | 'Trip' | 'Failure' | 'Perturbation' | 'IoT&DigitalTwin' | string;
+    eventTime?: string;
+    eventDate?: string;
+    endTime?: string;
+    duration?: string;
+    impact?: string;
+    reportNumber?: string;
+    primaryCauses?: string;
+    status?: 'convertedToWOR' | string;
+    priority?: 'Low' | 'Medium' | 'High' | string;
+    componentType?: string;
+    alertDefinitionId?: number;
+    triggerValue?: number;
+    acknowledgedBy?: string;
+    acknowledgedAt?: string;
+    displayMetadata?: Record<string, any>;
+    unit?: any;
+    location?: any;
+    initiator?: any;
+    sub_assembly?: any;
+    subAssembly?: any;
+    groups?: any[];
+    sub_components?: any[];
+    components?: any[];
+    unitId?: number;
+    locationId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface OutageResource {
+    id: number;
+    role?: string;
+    resourceType?: string;
+    quantity?: number;
+    estimatedHours?: number;
+    actualHours?: number;
+    status?: string;
+    notes?: string;
+    outageEvent?: any;
+    assignedUser?: any;
+    materialItem?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface EnergyProduction {
+    id: number;
+    unit?: any;
+    periodStart?: string;
+    periodEnd?: string;
+    periodType?: string;
+    grossProductionMwh?: number;
+    netProductionMwh?: number;
+    capacityFactor?: number;
+    availabilityPercent?: number;
+    plannedOutageHours?: number;
+    forcedOutageHours?: number;
+    operatingHours?: number;
+    revenue?: number;
+    costPerMwh?: number;
+    currency?: string;
+    weatherData?: any;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface SiteAssessment {
+    id: number;
+    title?: string;
+    name?: string;
+    description?: string;
+    content?: string;
+    unitId?: number;
+    assessmentDate?: string;
+    status?: string;
+    type?: string;
+    findings?: string;
+    recommendations?: string;
+    overallScore?: string;
+    cancellationReason?: string;
+    /** Assessor (when populated) */
+    assessor?: {
+        id: number;
+        firstName?: string;
+        lastName?: string;
+    };
+    /** Location relation (ManyToOne) */
+    locationId?: number;
+    location?: {
+        id: number;
+        name?: string;
+    };
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/api/failure.models.d.ts

@@ -0,0 +1,171 @@
+import { EventNature, FailureImpact, FailureLikelihood, FailureRiskLevel } from '../enums';
+export interface Failure {
+    id: number;
+    number?: string;
+    uuid?: string;
+    title?: string;
+    description?: string;
+    nature?: EventNature;
+    unitId?: number;
+    componentId?: number;
+    failureDate?: string;
+    resolutionDate?: string;
+    impact?: string;
+    rootCause?: string;
+    severity?: string;
+    measure?: string;
+    detection?: string;
+    failureImpact?: FailureImpact | string;
+    failureLikelihood?: FailureLikelihood | string;
+    failureRiskLevel?: FailureRiskLevel | string;
+    comment?: string;
+    commentFr?: string;
+    commentEn?: string;
+    commentDe?: string;
+    commentPt?: string;
+    commentEs?: string;
+    commentSw?: string;
+    deleted?: boolean;
+    downtimeHours?: string;
+    downtimeMinutes?: number;
+    repairStartTime?: string;
+    repairEndTime?: string;
+    isResolved?: boolean;
+    resolutionNotes?: string;
+    native?: boolean;
+    customFields?: Record<string, any>;
+    titleEn?: string;
+    titleFr?: string;
+    titleDe?: string;
+    titlePt?: string;
+    titleEs?: string;
+    titleSw?: string;
+    descriptionEn?: string;
+    descriptionFr?: string;
+    descriptionDe?: string;
+    descriptionPt?: string;
+    descriptionEs?: string;
+    descriptionSw?: string;
+    impactEn?: string;
+    impactFr?: string;
+    impactDe?: string;
+    impactPt?: string;
+    impactEs?: string;
+    impactSw?: string;
+    detectionEn?: string;
+    detectionFr?: string;
+    detectionDe?: string;
+    detectionPt?: string;
+    detectionEs?: string;
+    detectionSw?: string;
+    location?: any;
+    component?: any;
+    /**
+     * When populated (e.g. via `populate=failureCauses`), contains the linked causes.
+     */
+    failureCauses?: FailureCause[];
+    /**
+     * When populated, contains the linked actions.
+     */
+    failureActions?: FailureAction[];
+    failureCauseIds?: number[];
+    repairTimeMinutes?: number;
+    unit?: any;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FailureCreateRequest extends Partial<Omit<Failure, 'id' | 'createdAt' | 'updatedAt' | 'failureCauses' | 'failureActions'>> {
+    /**
+     * Array of FailureCause IDs to link to this failure.
+     * Backend resolves these via the failure_causes_failure_links join table.
+     */
+    failureCauseIds?: number[];
+}
+export interface FailureUpdateRequest extends FailureCreateRequest {
+}
+export interface FailureCause {
+    id: number;
+    name: string;
+    description?: string;
+    category?: string;
+    isRootCause?: boolean;
+    native?: boolean;
+    failureId?: number;
+    failure?: any;
+    /** When populated, contains the linked actions for this cause. */
+    failureActions?: FailureAction[];
+    locations?: any[];
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface FailureCauseCreateRequest extends Partial<Omit<FailureCause, 'id' | 'createdAt' | 'updatedAt' | 'failureActions'>> {
+    /**
+     * Array of FailureAction IDs to link to this cause.
+     * Backend resolves these via the failure_causes_failure_actions_links join table.
+     */
+    failureActionIds?: number[];
+}
+export interface FailureCauseUpdateRequest extends FailureCauseCreateRequest {
+}
+export interface FailureAction {
+    id: number;
+    name: string;
+    description?: string;
+    actionType?: string;
+    native?: boolean;
+    status?: string;
+    dueDate?: string;
+    completionDate?: string;
+    failureId?: number;
+    assignedToId?: number;
+    assignedTo?: any;
+    failure?: any;
+    failureCause?: any;
+    locations?: any[];
+    deleted?: boolean;
+    nameEn?: string;
+    nameFr?: string;
+    nameDe?: string;
+    namePt?: string;
+    nameEs?: string;
+    nameSw?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type FailureActionCreateRequest = Partial<Omit<FailureAction, 'id' | 'createdAt' | 'updatedAt'>>;
+export type FailureActionUpdateRequest = FailureActionCreateRequest;
+export interface CorrectiveAction {
+    id: number;
+    title?: string;
+    description?: string;
+    status?: string;
+    priority?: string;
+    percentage?: string;
+    notes?: string;
+    dueDate?: string;
+    completionDate?: string;
+    /** @deprecated Use completionDate */
+    completedDate?: string;
+    /** @deprecated Use assignedUsers instead */
+    assignedTo?: any;
+    assignedUsers?: any[];
+    location?: any;
+    initiator?: any;
+    associatedLessonLearned?: any;
+    maintenanceRecord?: any;
+    rootCauseAnalysis?: any;
+    failureId?: number;
+    assignedToId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/lib/models/api/fleet.models.d.ts

@@ -0,0 +1,193 @@
+import { VehicleType, VehicleStatus, DriverStatus, FuelType, VehicleInspectionType, VehicleMaintenanceType, TripStatus, TrackingStatus, GeofenceType, GeofenceEventType, TrackedEntityType } from '../enums';
+export interface Vehicle {
+    id: number;
+    name: string;
+    vin?: string;
+    /** Backend field name */
+    licensePlate?: string;
+    /** Legacy SDK alias — same as licensePlate */
+    plateNumber?: string;
+    make?: string;
+    model?: string;
+    year?: number;
+    vehicleType?: VehicleType;
+    /** Legacy SDK alias — same as vehicleType */
+    type?: VehicleType;
+    color?: string;
+    status?: VehicleStatus;
+    currentMileage?: number;
+    fuelType?: FuelType;
+    fuelCapacity?: number;
+    assignedDriver?: Driver | {
+        id: number;
+    };
+    assignedUnit?: any;
+    company?: any;
+    purchaseDate?: string;
+    purchasePrice?: number;
+    isLeased?: boolean;
+    leaseEndDate?: string;
+    insurancePolicyNumber?: string;
+    insuranceExpiryDate?: string;
+    registrationExpiryDate?: string;
+    gpsDeviceId?: string;
+    lastKnownLatitude?: number;
+    lastKnownLongitude?: number;
+    lastLocationUpdate?: string;
+    notes?: string;
+    companyId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface Driver {
+    id: number;
+    firstName?: string;
+    lastName?: string;
+    /** Computed by backend */
+    fullName?: string;
+    email?: string;
+    phone?: string;
+    licenseNumber?: string;
+    licenseClass?: string;
+    /** Backend: licenseExpiryDate */
+    licenseExpiryDate?: string;
+    /** Legacy SDK alias */
+    licenseExpiry?: string;
+    licenseState?: string;
+    status?: DriverStatus;
+    certifications?: string[];
+    emergencyContactName?: string;
+    emergencyContactPhone?: string;
+    hireDate?: string;
+    notes?: string;
+    company?: any;
+    user?: any;
+    userId?: number;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface VehicleTrip {
+    id: number;
+    vehicleId?: number;
+    driverId?: number;
+    status?: TripStatus;
+    startLocation?: string;
+    endLocation?: string;
+    startMileage?: number;
+    endMileage?: number;
+    startTime?: string;
+    endTime?: string;
+    createdAt?: string;
+}
+export interface VehicleInspection {
+    id: number;
+    vehicleId?: number;
+    type?: VehicleInspectionType;
+    inspectorId?: number;
+    inspectionDate?: string;
+    result?: string;
+    notes?: string;
+    createdAt?: string;
+}
+export interface VehicleMaintenance {
+    id: number;
+    vehicleId?: number;
+    type?: VehicleMaintenanceType;
+    status?: string;
+    scheduledDate?: string;
+    completedDate?: string;
+    cost?: number;
+    notes?: string;
+    createdAt?: string;
+}
+export interface FuelRecord {
+    id: number;
+    vehicleId?: number;
+    fuelType?: FuelType;
+    quantity?: number;
+    cost?: number;
+    mileage?: number;
+    fuelDate?: string;
+    createdAt?: string;
+}
+export interface Geofence {
+    id: number;
+    name: string;
+    companyId?: number;
+    geofenceType?: GeofenceType;
+    type?: GeofenceType;
+    centerLatitude?: number;
+    centerLongitude?: number;
+    radius?: number;
+    coordinates?: any;
+    alertOnEnter?: boolean;
+    alertOnExit?: boolean;
+    activeStartTime?: string;
+    activeEndTime?: string;
+    activeDays?: string[];
+    isActive?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface GeofenceEvent {
+    id: number;
+    companyId?: number;
+    geofenceId?: number;
+    geofence?: Geofence;
+    entityType?: TrackedEntityType;
+    entityId?: number;
+    entityName?: string;
+    eventType?: GeofenceEventType;
+    latitude?: number;
+    longitude?: number;
+    eventTime?: string;
+    alertSent?: boolean;
+    createdAt?: string;
+}
+export interface GeofenceCheckResult {
+    geofence: Geofence;
+    inside: boolean;
+}
+export interface GpsLocation {
+    id: number;
+    entityId?: number;
+    entityType?: string;
+    latitude?: number;
+    longitude?: number;
+    speed?: number;
+    heading?: number;
+    timestamp?: string;
+}
+export interface TrackedEntity {
+    id: number;
+    entityId?: number;
+    entityType?: string;
+    status?: TrackingStatus;
+    lastLatitude?: number;
+    lastLongitude?: number;
+    lastUpdate?: string;
+}
+export interface SlaBreachRecord {
+    id: number;
+    entityType?: string;
+    entityId?: number;
+    entityReference?: string;
+    slaId?: number;
+    breachType?: string;
+    thresholdHours?: number;
+    actualHoursElapsed?: number;
+    detectedAt?: string;
+    escalationLevel?: number;
+    firstEscalationAt?: string;
+    secondEscalationAt?: string;
+    resolved?: boolean;
+    resolvedAt?: string;
+    createdAt?: string;
+}
+export interface BulkOperationResponse {
+    successCount: number;
+    failureCount: number;
+    errors: string[];
+}

package/lib/models/api/inspection.models.d.ts

@@ -0,0 +1,110 @@
+import { InspectionType, InspectionLevel, InspectionNature, ReasonForInspection, WorkOrderStatus, Priority, MaintenanceType, CostAllocation, UnitStatus, OperatingMode, WaterLevel, EventNature, YesNo, CalendarPlanning, MeteringParameterType, MeteringParameterStatus, Periodicity } from '../enums';
+import { StrapiFile } from './media.models';
+import { RelevantInformation } from './intervention.models';
+export interface ComponentInspectionStatus {
+    componentId: number;
+    componentName?: string;
+    status?: string;
+    notes?: string;
+}
+export interface Inspection {
+    id: number;
+    reportNumber?: string;
+    title?: string;
+    description?: string;
+    status?: WorkOrderStatus;
+    priority?: Priority;
+    maintenanceType?: MaintenanceType;
+    costAllocation?: CostAllocation;
+    unitStatus?: UnitStatus;
+    operatingMode?: OperatingMode;
+    waterLevel?: WaterLevel;
+    eventNature?: EventNature;
+    eventDescriptionType?: YesNo;
+    inspectionType?: InspectionType;
+    inspectionNature?: InspectionNature;
+    inspectionLevel?: InspectionLevel;
+    reasonForInspection?: ReasonForInspection;
+    calendarPlanning?: CalendarPlanning;
+    meteringParameterType?: MeteringParameterType;
+    meteringParameterStatus?: MeteringParameterStatus;
+    periodicity?: Periodicity;
+    plannedDate?: string;
+    startDate?: string;
+    scheduleDate?: string;
+    creationDate?: string;
+    meteringParameterStartDate?: string;
+    actionPlan?: string;
+    comments?: string;
+    recommendations?: string;
+    estimatedRevenueShortFall?: string;
+    productInterruption?: string;
+    externalId?: string;
+    meteringParameterValue?: string;
+    meteringParameterPassed?: string;
+    periodicityHash?: string;
+    hasardAnalysisJSANumber?: string;
+    maintenanceJSA?: string;
+    maintenanceTimes?: string;
+    processedIndex?: string;
+    initialInspection?: string;
+    woGroupInformation?: string;
+    inspectionCategory?: string;
+    inspectionInOperationReason?: string;
+    eventDescription?: string;
+    eventReportNumber?: string;
+    chargeCode?: string;
+    phaseRef?: string;
+    plannedOutageDuration?: string;
+    isRiskComponents?: boolean;
+    systemIsolationCompleted?: boolean;
+    isProjectRelated?: boolean;
+    isMultiTeamsWork?: boolean;
+    immediate?: boolean;
+    hasardAnalysisCompleted?: boolean;
+    scheduleFollowUp?: boolean;
+    componentsInspectionStatus?: ComponentInspectionStatus[];
+    groupsSelected?: number[];
+    relevantInformation?: RelevantInformation | string;
+    unit?: any;
+    location?: any;
+    users?: any[];
+    initiator?: any;
+    departments?: any[];
+    subAssembly?: any;
+    components?: any[];
+    attachments?: StrapiFile[];
+    customFields?: Record<string, any>;
+    titleOfInspection?: string;
+    maintenanceReportNumber?: string;
+    unitOperatingMode?: string;
+    unitWaterLevel?: string;
+    maintainance_jsa?: string;
+    sub_assembly?: any;
+    inspection_components?: any[];
+    sevenDaysReminderSent?: boolean;
+    threeDaysReminderSent?: boolean;
+    sameDayReminderSent?: boolean;
+    deleted?: boolean;
+    projectReportNumber?: string;
+    targetComponentInstancesRef?: string;
+    worReportNumber?: string;
+    interventionReportNumber?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type InspectionCreateRequest = Partial<Omit<Inspection, 'id' | 'createdAt' | 'updatedAt'>> & {
+    reportNumber: string;
+};
+export type InspectionUpdateRequest = Partial<Omit<Inspection, 'id' | 'createdAt' | 'updatedAt'>>;
+export interface InspectionComponent {
+    id: number;
+    inspectionId?: number;
+    componentId?: number;
+    condition?: string;
+    notes?: string;
+    referenceCode?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}