spotcharge-types 1.0.288

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

@@ -0,0 +1,28 @@
+import {PhoneNumberModel} from "../phone-number-model";
+import {UserRoleApiModel} from "./user-role.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface AdminUserApiModel {
+    id: string;
+    firstName: string;
+    lastName: string;
+    displayName?: string;
+    photoURL: string | null;
+    color: string;
+    userId: string;
+    active: boolean;
+    isOwner: boolean;
+    email: string;
+    password: string;
+    phoneNumber: PhoneNumberModel;
+    roles?: Pick<UserRoleApiModel, 'title' | 'value' | 'id'>;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}

package/src/models/api/api-consumer.api.model.ts

@@ -0,0 +1,31 @@
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+
+export interface ApiConsumerApiModel {
+  id: string; // internal UUID
+  name: string; // Partner / company name
+  description?: string;
+
+  // Client Credentials
+  clientId: string; // public identifier
+  clientSecretHash: string; // hashed secret only (never expose)
+
+  isActive: boolean; // master kill switch
+
+  // Optional security controls
+  allowedIps?: string[]; // IP whitelist
+  rateLimit?: {
+    requestsPerMinute: number;
+  };
+
+  // Audit fields
+  lastAuthAt?: string; // last successful authentication
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

package/src/models/api/asset-api.model.ts

@@ -0,0 +1,41 @@
+import {LastInOutModel, PhotoEvidenceModel} from "./in-out.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+
+export interface AssetApiModel {
+    id: string;
+    name: string;
+    type: AssetType;
+    status: string;
+    identificationNumber: string;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    lastIn: LastInOutModel;
+    lastOut: LastInOutModel;
+    inOutStatus: string;
+    photo?: PhotoEvidenceModel
+    inOutDate: Timestamp;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}
+
+export interface AssetType {
+    id: string;
+    name: string;
+}
+
+export interface AssetModel {
+    id: string;
+    name: string;
+    status: string;
+    type: AssetType;
+    identificationNumber: string;
+}

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

@@ -0,0 +1,91 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {BookingPaymentInfo} from "../booking-payment-info.model";
+import {BookingStatus, PaymentStatus, PointType} from "../../enum";
+import {ServiceChargeModel} from "../service-charge.model";
+import {PublicUserVehicle} from "../public-user-vehicle.model";
+import {PhoneNumberModel} from "../phone-number-model";
+import {ConnectorTypeModel} from "../connector-type.model";
+import {ResolvedTariff} from "../resolved-tariff.model";
+
+export interface BookingApiModel {
+  id: string;
+  userId: string;
+  userInfo: {
+    id: string;
+    name: string;
+    phoneNumber: PhoneNumberModel;
+  };
+  chargingDate: Timestamp;
+  startTime: number;
+  endTime: number;
+  startDateTime: Timestamp;
+  endDateTime: Timestamp;
+  charger: {
+    id: string;
+    name: string;
+    address: string;
+    pointType: PointType;
+  };
+  connectorNo: number;
+  connectorType?: ConnectorTypeModel;
+  unit: number;
+  unitRate: number;
+  vehicle: PublicUserVehicle;
+  amount: number;
+  tax: number;
+  totalAmount: number;
+  paymentInfo: BookingPaymentInfo | null;
+  paymentStatus: PaymentStatus;
+  status: BookingStatus;
+  bookingRef: string;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  invoiceId?: string;
+  invoiceNo?: number;
+  serviceChargeInfo: ServiceChargeModel;
+  serviceCharge: number;
+  isServiceChargeApplicable: boolean;
+  refundData?: Record<string, Refund>;
+  timeZone: string;
+  sourceHoldId: string;
+  
+  // Optimistic booking fields
+  paymentExpiresAt?: Timestamp;
+  confirmedAt?: Timestamp;
+  expiredAt?: Timestamp;
+  failedAt?: Timestamp;
+  failureReason?: string;
+  lastReconciliationCheck?: Timestamp;
+  reconciliationAttempts?: number;
+  
+  // Payment retry tracking
+  paymentAttempts?: number; // Number of times user attempted payment
+  previousOrderIds?: string[]; // History of abandoned Razorpay order IDs
+  convertedFromRazorpay?: boolean; // True if booking was converted from Razorpay to wallet payment
+  resolvedTariff?: ResolvedTariff;
+}
+
+
+export interface Refund {
+  id: string;
+  entity: string;
+  amount: number;
+  receipt: string | null;
+  currency: string;
+  payment_id: string;
+  notes: string[];
+  acquirer_data: {
+    arn: string | null;
+  };
+  created_at: number;
+  batch_id: string | null;
+  status: "pending" | "processed" | "failed";
+  speed_processed: string;
+  speed_requested: string;
+}

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

@@ -0,0 +1,17 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface BrandApiModel {
+  id: string;
+  name: string;
+  logo: string | null;
+  showOnFleet: boolean;
+  showOnPublic: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deleteBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}

package/src/models/api/charger-capacity.api.model.ts

@@ -0,0 +1,22 @@
+import {CapacityUnit, PointType} from "../../enum";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {ColorModel} from "../color.model";
+import {ServiceChargeModel} from "../service-charge.model";
+
+
+export interface ChargerCapacityApiModel {
+    id: string;
+    value: number;
+    unit: CapacityUnit;
+    outputType?: PointType;
+    color: ColorModel;
+    serviceCharge: ServiceChargeModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

package/src/models/api/charger-error.api.model.ts

@@ -0,0 +1,39 @@
+import {Timestamp} from "../timestamp";
+import {AppType, EntityType} from "../../enum";
+import {VendorModel} from "../vendor.model";
+import {CreatedByModel} from "../created-by.model";
+import {AddressApiModel} from "./address.api.model";
+
+export interface ChargerErrorApiModel {
+    id: string;
+    payload: ErrorPayload;
+    messageId: number;
+    connectorId: number;
+    chargerId: string;
+    chargerName: string;
+    chargerLocation: AddressApiModel;
+    status: string;
+    source: EntityType;
+    appType: AppType,
+    vendor: VendorModel;
+    orderIds: string[];
+    resolved: boolean;
+    resolvedAt: null,
+    resolvedBy: null,
+    reportedAt: Timestamp;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    isDeleted: boolean;
+    deletedAt: Date | null;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+}
+
+export interface ErrorPayload {
+    status: string;
+    errorCode: string;
+    timestamp: Timestamp;
+    connectorId: number;
+    vendorErrorCode: string;
+}

package/src/models/api/charger-report.api.model.ts

@@ -0,0 +1,19 @@
+import {ChargerLocationType, ChargerStatus} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface ChargerReportApiModel {
+    id: string;
+    chargerId: string;
+    chargerName: string;
+    chargerLocationType: ChargerLocationType;
+    status: ChargerStatus;
+    lastSeen?: Timestamp;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

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

@@ -0,0 +1,54 @@
+import {ChargerAllowedMode, ChargerLocationType, ChargerStatus, ChargerType, PointType} from "../../enum";
+import {AddressApiModel} from "./address.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {ConnectorModel} from "../connector.model";
+import {VendorModel} from "../vendor.model";
+import {GstModel} from "./gst-record-api.model";
+
+export interface ChargerApiModel {
+    id: string;
+    _firestore_id: string;
+    stationId: string;
+    name: string;
+    chargerId: string;
+    type: ChargerType;
+    pointType: PointType;
+    location: AddressApiModel;
+    connectors: Record<string, ConnectorModel>;
+    gst: GstModel;
+    protocol: string;
+    // @deprecated: remove in future
+    chargerLocationType: ChargerLocationType;
+    // @deprecated: remove in future
+    chargerVisibility: ChargerLocationType[];
+    allowedModes?: ChargerAllowedMode[];
+    accessNote?: string;
+    purchaseRate: number;
+    active: boolean;
+    isServiceChargeApplicable: boolean;
+    maintenanceMode: boolean;
+    vendor: VendorModel;
+    status: ChargerStatus;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    _geo: {
+        lat: number;
+        lng: number;
+    };
+    _geoDistance: number;
+
+    lastChargeAt?: Timestamp;
+
+    fleetIds?: string[];
+    lastSeen?: Timestamp;
+    onlineAt?: Timestamp;
+    firmwareVersion?: string;
+}
+
+

package/src/models/api/company-user-entity-access.api.model.ts

@@ -0,0 +1,19 @@
+import {CompanyUserEntityRole, CompanyUserEntityAccessStatus} from "../../enum";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface CompanyUserEntityAccessApiModel {
+  id: string;
+  companyUserId: string;
+  companyId: string;
+  franchiseId: string;
+  role: CompanyUserEntityRole;
+  status: CompanyUserEntityAccessStatus;
+  revokedAt?: Timestamp;
+  revokedBy?: string;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  timeZone: string;
+}

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

@@ -0,0 +1,18 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {CompanyUserStatus} from "../../enum";
+
+export interface CompanyUserApiModel {
+  id: string; // `${companyId}__${userId}`
+  companyId: string;
+  userId: string;
+  timeZone: string;
+  status: CompanyUserStatus;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}

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

@@ -0,0 +1,25 @@
+import {CompanyType, CompanyStatus} from "../../enum";
+import {PhoneNumberModel} from "../phone-number-model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {AddressApiModel} from "./address.api.model";
+
+export interface CompanyApiModel {
+    id: string;
+    name: string;
+    displayName?: string;
+    type?: CompanyType;
+    contactName: string;
+    contactPhone?: PhoneNumberModel;
+    contactEmail?: string;
+    address?: AddressApiModel;
+    gstNumber?: string;
+    status: CompanyStatus;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt?: Timestamp | null;
+    isDeleted: boolean;
+}

package/src/models/api/connector-type.api.model.ts

@@ -0,0 +1,15 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface ConnectorTypeApiModel {
+    id: string;
+    name: string;
+    icon?: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deleteBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

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

@@ -0,0 +1,28 @@
+import { ConnectorStatus, ConnectorType } from "../../enum";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+
+export interface ConnectorApiModel {
+    id: string;               // Firestore document ID (unique)
+    connectorNo: number;      // OCPP connector number (1, 2, 3, …)
+    name: string;             // Human label for UI
+
+    connectorType: ConnectorType;  // Connector standard: e.g., "Type2", "CCS2", "CHAdeMO"
+    outputType: "AC" | "DC"; // Clearly AC or DC — easy to filter & use
+
+    capacity: string; // reference to charger capacity document ID
+    unitRate: number;
+    isManualPricing?: boolean; // true = use unitRate directly, false/undefined = use tariff resolution
+    status: ConnectorStatus;  // Current connector status
+
+    qrCodeId?: string;        // Stable QR code identifier (nanoid), immutable after creation
+    isActive: boolean;        // Enabled/disabled flag
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}

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

@@ -0,0 +1,34 @@
+import {ChargerLocationType, ChargerType, PointType} from "../../enum";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+import {AddressApiModel} from "./address.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {ConnectorModel} from "../connector.model";
+import {VendorModel} from "../vendor.model";
+
+export interface FleetChargerApiModel {
+    id: string;
+    name: string;
+    chargerId: string;
+    type: ChargerType;
+    franchise: FranchiseModel;
+    pointType: PointType;
+    location: AddressApiModel;
+    connectors: Array<ConnectorModel>;
+    occpProtocol: string;
+    chargerLocationType: ChargerLocationType;
+    purchaseRate: number;
+    active: boolean;
+    vendor: VendorModel;
+    fleet?: FleetModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}
+
+

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

@@ -0,0 +1,24 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {FleetModel} from "../fleet.model";
+import {FranchiseModel} from "../franchise.model";
+
+export interface FleetInvoiceApiModel {
+    id: string;
+    invoiceNo: number;
+    billDate: Timestamp;
+    fleet: FleetModel;
+    franchise: FranchiseModel;
+    totalAmount: number;
+    totalUsedAmount: number;
+    totalConsumedUnits: number;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}
+
+

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

@@ -0,0 +1,24 @@
+import { CreatedByModel } from "../created-by.model";
+import { PhoneNumberModel } from "../phone-number-model";
+import { Timestamp } from "../timestamp";
+import { UserRoleApiModel } from "./user-role.api.model";
+
+export interface FleetOperatorApiModel {
+    id: string;
+    firstName: string;
+    lastName: string;
+    fleetIds: string[];
+    email: string;
+    password: string;
+    phoneNumber: PhoneNumberModel | null;
+    userId: string;
+    roles: Pick<UserRoleApiModel, "title" | "value" | "id">,
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}

package/src/models/api/fleet-station-visibility.api.model.ts

@@ -0,0 +1,21 @@
+import { FleetStationVisibilityStatus } from "../../enum";
+import { CreatedByModel } from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+
+export interface FleetStationVisibilityApiModel {
+    id: string;
+    fleetId: string;
+    stationId: string;
+    status: FleetStationVisibilityStatus;
+    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/fleet-user-access.api.model.ts

@@ -0,0 +1,25 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface FleetUserAccessApiModel {
+  id: string; // `${userId}__${fleetId}`
+
+  userId: string;
+  fleetId: string;
+
+  status: "active" | "revoked";
+
+  createdAt: Timestamp;
+  createdBy: CreatedByModel;
+
+  revokedAt?: Timestamp;
+  revokedBy?: CreatedByModel;
+
+  updatedAt: Timestamp;
+  updatedBy: CreatedByModel;
+
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+
+  timeZone: string;
+}

package/src/models/api/fleet-user-franchise-change-log.api.model.ts

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

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

@@ -0,0 +1,18 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {UserRoleApiModel} from "./user-role.api.model";
+
+export interface FleetUserV2ApiModel {
+  id: string;
+  userId: string;
+  role: Pick<UserRoleApiModel, "title" | "value" | "id">;
+  status: "active" | "revoked";
+  timeZone: string;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}