spotcharge-types 1.0.288

package/src/models/api/fleet-user.api.model.ts

@@ -0,0 +1,43 @@
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {PhoneNumberModel} from "../phone-number-model";
+import {VehicleModel} from "../vehicle.model";
+import {UserRoleApiModel} from "./user-role.api.model";
+
+export interface FleetUserApiModel {
+    id: string;
+    firstName: string;
+    lastName: string;
+    franchise: FranchiseModel;
+    fleets: FleetModel[];
+    fleetIds: string[];
+    email: string;
+    password: string;
+    phoneNumber: PhoneNumberModel | null;
+    fleetVehicle: FleetVehicleModel;
+    fleetVehicleId: string;
+    // vehicle: VehicleModel | null;
+    // vehicleNumber?: string;
+    roles: Pick<UserRoleApiModel, "title" | "value" | "id">,
+    userId: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+    previousFleetUserId?: string;
+    fleetUserFranchiseChangeLogId?: string;
+}
+
+
+
+export interface FleetVehicleModel {
+    id: string;
+    vehicle: VehicleModel;
+    vehicleNumber:string;
+}

package/src/models/api/fleet-vehicle-search.api.model.ts

@@ -0,0 +1,20 @@
+import {VehicleModel} from "../vehicle.model";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+
+/**
+ * Meilisearch document format for FleetVehicle search index
+ */
+export interface FleetVehicleSearchApiModel {
+    id: string;
+    vehicleNumber: string;
+    vehicle: VehicleModel;
+    franchise: FranchiseModel;
+    fleets: FleetModel[];
+    fleetIds: string[];
+    inOutStatus: string;
+    isRegistered: boolean;
+    isDeleted: boolean;
+    createdAt?: number;
+    updatedAt?: number;
+}

package/src/models/api/fleet-vehicle.api.model.ts

@@ -0,0 +1,29 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {VehicleModel} from "../vehicle.model";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+import {LastInOutModel} from "./in-out.api.model";
+
+export interface FleetVehicleApiModel {
+    id: string;
+    vehicle: VehicleModel;
+    vehicleNumber:string;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    fleets: FleetModel[];
+    fleetIds: string[];
+    timeZone: string;
+    lastIn: LastInOutModel;
+    lastOut: LastInOutModel;
+    inOutStatus: string;
+    isRegistered: boolean;
+    inOutDate: Timestamp;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

package/src/models/api/fleet.api.model.ts

@@ -0,0 +1,25 @@
+import {FranchiseModel} from "../franchise.model";
+import {AddressApiModel} from "./address.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface FleetApiModel {
+  id: string;
+  name: string;
+  fleetCode?: string;
+  status?: 'active' | 'inactive';
+  address: AddressApiModel;
+  franchise: FranchiseModel;
+  chargers: string[];
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  credit: number;
+  remainingCredit: number;
+  billingStartDate: number;
+  timeZone: string;
+}

package/src/models/api/franchise-business-model.ts

@@ -0,0 +1,18 @@
+import {BusinessOwnership} from "../../enum/business-ownership.enum";
+import {BusinessOperation} from "../../enum/business-operation.enum";
+import {RevenueModel} from "../../enum/revenue-model.enum";
+import {RevenueContractType} from "../../enum/revenue-contract-type.enum";
+
+export interface BusinessModelConfig {
+    ownership: BusinessOwnership;
+    operation: BusinessOperation;
+    revenueModel: RevenueModel;
+}
+
+export interface RevenueConfig {
+    model: RevenueModel;
+    platformShare?: number;
+    payoutPerUnit?: number;
+    contractType?: RevenueContractType;
+    contractValue?: number;
+}

package/src/models/api/franchise-station-access.api.model.ts

@@ -0,0 +1,21 @@
+import { FranchiseStationAccessStatus } from "../../enum";
+import { CreatedByModel } from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+
+export interface FranchiseStationAccessApiModel {
+    id: string;
+    franchiseId: string;
+    stationId: string;
+    status: FranchiseStationAccessStatus;
+    revokedAt?: Timestamp;
+    revokedBy?: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}

package/src/models/api/franchise.api.model.ts

@@ -0,0 +1,51 @@
+import {FranchiseType} from "../../enum";
+import {FranchiseBusinessType} from "../../enum/franchise-business-type.enum";
+import {FranchiseStatus} from "../../enum/franchise-status.enum";
+import {PricingControl} from "../../enum/pricing-control.enum";
+import {PhoneNumberModel} from "../phone-number-model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {AddressApiModel} from "./address.api.model";
+import {BusinessModelConfig, RevenueConfig} from "./franchise-business-model";
+
+export interface FranchiseApiModel {
+    id: string;
+    franchiseName: string;
+    franchiseCode: string; // Human-friendly, unique, immutable
+    contactEmail?: string;
+    contactPhone?: PhoneNumberModel;
+    // @deprecated — do not use 
+    franchiseType: FranchiseType;
+    // @deprecated — do not use 
+    firstName: string;
+    // @deprecated — do not use 
+    lastName: string;
+    // @deprecated — do not use
+    phoneNumber: PhoneNumberModel;
+    // @deprecated — do not use 
+    email: string;
+    // @deprecated — do not use 
+    password: string;
+    chargers: string[];
+    address: AddressApiModel;
+    // @deprecated — do not use 
+    fleetInvoiceCount: number;
+    // @deprecated — do not use 
+    allowedFleetIds?: string[];
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    // @deprecated — do not use 
+    userId: string;
+    timeZone: string;
+    companyId?: string;
+    status?: FranchiseStatus;
+    businessType?: FranchiseBusinessType;
+    businessModel?: BusinessModelConfig;
+    revenueConfig?: RevenueConfig;
+    pricingControl?: PricingControl;
+}

package/src/models/api/gst-record-api.model.ts

@@ -0,0 +1,42 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType, GstType} from "../../enum";
+import {StateModel} from "./address.api.model";
+
+export interface GstRecordApiModel {
+    id: string;
+    gstNumber: string;
+    interTax: StateTaxModel;
+    intraTax: StateTaxModel;
+    businessLegalName: string;
+    state: StateModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}
+
+export interface StateTaxModel {
+    id: string;
+    name: string;
+    taxPercentages: TaxWithPercentageModel[]
+}
+
+export interface TaxWithPercentageModel {
+    id: string;
+    name: string;
+    percentage: number;
+    type: GstType;
+}
+
+export interface GstModel {
+    id: string;
+    businessLegalName: string;
+    gstNumber: string;
+    gstState: string;
+}

package/src/models/api/in-out.api.model.ts

@@ -0,0 +1,83 @@
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import {InOutKeys, VehiclePurposeDetailType} from "../../consts";
+import {FleetModel} from "../fleet.model";
+import {FleetVehicleModel} from "../fleet-vehicle.model";
+import {FranchiseModel} from "../franchise.model";
+import {AssetModel} from "./asset-api.model";
+
+// Union type for vehicle status
+export type VehicleStatus = "IN" | "OUT";
+
+// Interface for vehicle checklist status
+export interface VehicleChecklist {
+    auxiliaryBattery: boolean;
+    fireExtinguisher: boolean;
+    spareWheel: boolean;
+    hydraulicJack : boolean;
+    rightSideMirror: boolean;
+    leftSideMirror: boolean;
+    vehicleKey: boolean;
+}
+
+// Main interface with improved type constraints
+export interface InOutApiModel {
+    id: string;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    asset: AssetModel;
+    vehicle: FleetVehicleModel;
+    driver: string | null;
+    status: VehicleStatus;
+    batteryPercentage: number;
+    odometer: number;
+    inOutType: InOutKeys;
+    purpose: VehiclePurposeDetailType;
+    checklistStatus: VehicleChecklist;
+    previousInOutId?: string;
+    isChecklistChanged: boolean;
+    missingChecklistItems?: string[];
+    newlyAddedCheckListItems?: string[];
+    photoEvidence: PhotoEvidenceModel[];
+    profileImage: PhotoEvidenceModel;
+    notes: string | null;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}
+
+// Interface for Photo evidence
+export interface PhotoEvidenceModel {
+    imageUrl: string;
+    title: string;
+    exif: any | null;
+}
+
+export interface LastInOutModel {
+    id: string;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    asset: AssetModel;
+    vehicle: FleetVehicleModel;
+    driver: string | null;
+    status: VehicleStatus;
+    batteryPercentage: number;
+    odometer: number;
+    inOutType: InOutKeys;
+    purpose: VehiclePurposeDetailType;
+    checklistStatus: VehicleChecklist;
+    previousInOutId?: string;
+    isChecklistChanged: boolean;
+    missingChecklistItems?: string[];
+    newlyAddedCheckListItems?: string[];
+    photoEvidence: PhotoEvidenceModel[];
+    profileImage: PhotoEvidenceModel;
+    notes: string | null;
+    createdBy: CreatedByModel;
+    createdAt: Timestamp;
+    timeStamp: Timestamp;
+}

package/src/models/api/index.ts

@@ -0,0 +1,53 @@
+export {UserRoleApiModel} from './user-role.api.model';
+export {AddressApiModel, StateModel} from './address.api.model';
+export {FleetApiModel} from './fleet.api.model';
+export {FleetUserApiModel, FleetVehicleModel} from './fleet-user.api.model';
+export {FranchiseApiModel} from './franchise.api.model';
+export {ChargerApiModel} from './charger.api.model';
+export {FleetChargerApiModel} from './fleet-charger.api.model';
+export {ChargerCapacityApiModel} from './charger-capacity.api.model';
+export {VendorApiModel} from './vendor.api.model';
+export {ConnectorTypeApiModel} from './connector-type.api.model';
+export {RfidApiModel} from './rfid.api.model';
+export {OrderApiModel} from './order.api.model';
+export {FleetInvoiceApiModel} from './fleet-invoice.api.model';
+export {VehicleApiModel} from './vehicle.api.model';
+export {BrandApiModel} from './brand.api.model';
+export {BookingApiModel, Refund} from './booking.api.model';
+export {WalletTransactionApiModel} from './wallet-transaction.api.model';
+export {FleetVehicleApiModel} from './fleet-vehicle.api.model';
+export {InvoiceApiModel} from './invoice.api.model';
+export {FleetUserFranchiseChangeLogApiModel} from './fleet-user-franchise-change-log.api.model';
+export {ServiceChargeApiModel} from './service-charge.api.model';
+export {FleetOperatorApiModel} from './fleet-operator.api.model';
+export {SupportQueriesApiModel} from './support-queries.api.model';
+export {ChargerErrorApiModel} from './charger-error.api.model';
+export {InvoiceDownloadApiModel} from './invoice-download.api.model';
+export {TaxApiModel} from './tax-api-model';
+export {GstRecordApiModel, StateTaxModel, TaxWithPercentageModel, GstModel} from './gst-record-api.model';
+export {VehicleStatus, VehicleChecklist, InOutApiModel, PhotoEvidenceModel, LastInOutModel} from './in-out.api.model';
+export {AssetApiModel, AssetType, AssetModel} from './asset-api.model';
+export {NotificationApiModel} from './notification.api.model';
+export {PermissionGroupApiModel} from './permission-group.api.model';
+export {MasterUserRoleApiModel} from './master-user-role.api.model';
+export {AdminUserApiModel} from './admin-user.api.model';
+export {ChargerReportApiModel} from './charger-report.api.model';
+export {StationApiModel, StationChargerCounts, StationAmenities, StationPhotoModel} from './station.api.model';
+export {StationSearchApiModel} from './station-search.api.model';
+export {FleetVehicleSearchApiModel} from './fleet-vehicle-search.api.model';
+export {ApiConsumerApiModel} from './api-consumer.api.model';
+export {ConnectorApiModel} from './connector.api.model';
+export {FranchiseStationAccessApiModel} from './franchise-station-access.api.model';
+export {FleetStationVisibilityApiModel} from './fleet-station-visibility.api.model';
+export {SlotHoldApiModel} from './slot-hold.api.model';
+export {PaymentApiModel} from './payment.api.model';
+export {RefundApiModel} from './refund.api.model';
+export {InvoiceReviewApiModel} from './invoice-review.api.model';
+export {FleetUserV2ApiModel} from './fleet-user-v2.api.model';
+export {FleetUserAccessApiModel} from './fleet-user-access.api.model';
+export {TariffApiModel} from './tariff.api.model';
+export {TariffAssignmentApiModel} from './tariff-assignment.api.model';
+export {CompanyApiModel} from './company.api.model';
+export {CompanyUserApiModel} from './company-user.api.model';
+export {BusinessModelConfig, RevenueConfig} from './franchise-business-model';
+export {CompanyUserEntityAccessApiModel} from './company-user-entity-access.api.model';

package/src/models/api/invoice-download.api.model.ts

@@ -0,0 +1,19 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface InvoiceDownloadApiModel {
+    id: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deleteBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    isDone: boolean;
+    downloadUrl: string | null;
+    startDate: Timestamp;
+    endDate: Timestamp;
+    timeZone: string;
+}
+

package/src/models/api/invoice-review.api.model.ts

@@ -0,0 +1,22 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface InvoiceReviewApiModel {
+    id: string;
+    invoiceId: string;
+    invoiceNo: number;
+    stationId: string;
+    customerName: string;
+    chargerDocId: string;
+    chargerId: string;
+    userId: string;
+    rating: number;
+    feedback: string;
+    isDeleted: boolean;
+    deletedAt: Timestamp | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+}

package/src/models/api/invoice.api.model.ts

@@ -0,0 +1,87 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {OrderStopReason, OrderType, PointType} from "../../enum";
+import {ChargingTransactionRecords} from "../charging-transaction";
+import {ServiceChargeModel} from "../service-charge.model";
+import {PublicUserVehicle} from "../public-user-vehicle.model";
+import {PhoneNumberModel} from "../phone-number-model";
+import {AddressApiModel, StateModel} from "./address.api.model";
+import {GstModel} from "./gst-record-api.model";
+import {TaxConfigModel, InvoiceTaxModel} from "../tax-config.model";
+import {ResolvedTariff} from "../resolved-tariff.model";
+
+export interface InvoiceApiModel {
+    id: string;
+    invoiceId: string;
+    bookingId: string;
+    bookingRef: string;
+    bookingDate: Timestamp;
+    bookingStartTime: number;
+    bookingEndTime: number;
+    expectedEndTime?: Timestamp; // for efficient auto-complete cron queries
+    invoiceNo: number;
+    chargerId: string; // this is the id of the charger in which set in machine
+    chargerDocId: string; // this is the doc id of the charger in the chargers collection,
+    stationId: string; // this is the doc id of the station in the stations collection,
+    chargerName: string;
+    stationName: string | null; // Station name at time of invoice creation (for legal compliance)
+    stationAddress: string | null; // Station address at time of invoice creation (for legal compliance)
+    initialBatteryPercentage?: number;
+    chargerAddress: AddressApiModel;
+    chargerState: StateModel;
+    gst: GstModel;
+    customerName: string;
+    chargingDate: Timestamp;
+    startTime: Timestamp;
+    endTime: Timestamp;
+    unitConsumed: number;
+    state: string;
+    connectorNo: number;
+    userId: string;
+    unitRate: number;
+    orderType: OrderType;
+    stopReason: OrderStopReason;
+    stopSource: string;
+    transactionId: number;
+    currentTransactionId: number;
+    transaction: ChargingTransactionRecords;
+    meterStart: number;
+    meterStop: number;
+    isDeleted: boolean;
+    deletedAt: Timestamp | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    serviceChargeInfo: ServiceChargeModel;
+    serviceCharge: number;
+    taxConfig: TaxConfigModel | null;
+    tax: InvoiceTaxModel | null;
+    taxAmount: number;
+    subTotal: number;
+    pointType: PointType;
+    outputType?: "AC" | "DC"
+    isDirectStop?: boolean;
+    batteryPercentage: number;
+    recordHealth: 'bad' | 'good';
+    phoneNumber: PhoneNumberModel;
+    totalConsumedUnits: number;
+    totalAmount: number;
+    bookingUnit: number;
+    bookingAmount: number;
+    /**
+     * @description This field is used to check if the invoice has been reviewed or not
+     */
+    isReviewAdded: boolean;
+    /**
+     * @description This field is used to store the review id of the invoice
+     */
+    reviewId: string | null;
+    /** @deprecated Use invoiceDuration instead */
+    bookingDuration: number;
+    invoiceDuration?: number; // New field - use this instead of bookingDuration
+    vehicle: PublicUserVehicle;
+    isServiceChargeApplicable: boolean;
+    resolvedTariff?: ResolvedTariff;
+}

package/src/models/api/master-user-role.api.model.ts

@@ -0,0 +1,22 @@
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {PermissionKeys} from "../../consts";
+import {UserRolePermission} from "../user-role-permission";
+
+export interface MasterUserRoleApiModel {
+    id: string;
+    title: string;
+    value: string;
+    permissions: Record<PermissionKeys, UserRolePermission> | null;
+    isDefault?: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}

package/src/models/api/notification.api.model.ts

@@ -0,0 +1,27 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import {AppType} from "../../enum";
+
+export interface NotificationApiModel {
+    id: string;
+    notification?: {
+        title: string;
+        body: string;
+    };
+    android?: {
+        priority: 'high' | 'normal';
+    },
+    appType?: AppType,
+    data?: Record<string, any>;
+    message: string;
+    userTokens: string[];
+    userId: string;
+    markedAsRead: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

package/src/models/api/order.api.model.ts

@@ -0,0 +1,52 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+import {ChargerStatus, OrderStopReason, OrderType} from "../../enum";
+import {ChargingTransactionRecords} from "../charging-transaction";
+import {FleetVehicleModel} from "../fleet-vehicle.model";
+
+export interface OrderApiModel {
+    orderId: string;
+    id: string;
+    chargerId: string;
+    chargerName: string;
+    startTime: Timestamp;
+    endTime: Timestamp;
+    chargingDate: Timestamp;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    highestAmpere?: number;
+    stopReason: OrderStopReason;
+    orderNo: number;
+    transactionId: number;
+    currentTransactionId: number;
+    transaction: ChargingTransactionRecords;
+    connectorNo: number;
+    unitConsumed: number;
+    meterStart: number;
+    meterStop: number;
+    customerName: string;
+    state: string;
+    userId: string;
+    unitRate: number;
+    fleetVehicle: FleetVehicleModel,
+    orderType: OrderType;
+    totalConsumedUnits: number;
+    totalAmount: number;
+    type?:string;
+    addedBy?: string;
+    initialBatteryPercentage?: number;
+    completeBatteryPercentage?: number;
+    vehicleBatteryCapacity?: number;
+    approxChargingTime?: number;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    chargerStatus?: ChargerStatus | null;
+    reason?: string | null;
+}