spotcharge-types 1.0.288

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

@@ -0,0 +1,60 @@
+import { Timestamp } from "../timestamp";
+import { CreatedByModel } from "../created-by.model";
+import { 
+  EntityType, 
+  PaymentMethod, 
+  PaymentEntityType, 
+  PaymentProvider, 
+  PaymentTransactionStatus 
+} from "../../enum";
+
+/**
+ * Payment API Model
+ * 
+ * Represents a payment transaction in the system.
+ * Tracks payment lifecycle from initiation to capture/refund.
+ */
+export interface PaymentApiModel {
+  id: string;
+
+  entityType: PaymentEntityType;
+  entityId: string;
+
+  userId: string;
+  userInfo?: {
+    id: string;
+    name: string;
+  };
+
+  provider: PaymentProvider;
+  providerOrderId: string;
+  providerPaymentId?: string;
+
+  /** External money only */
+  amount: number;
+  currency: "INR";
+
+  paymentMethod: PaymentMethod;
+
+  /** Derived from refundedAmount */
+  status: PaymentTransactionStatus;
+
+  /** Guardrail for refunds */
+  refundedAmount: number;
+
+  /** Provider raw data (never used for logic) */
+  providerResponse?: Record<string, unknown>;
+
+  errorCode?: string;
+  errorDescription?: string;
+
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt?: Timestamp | null;
+  isDeleted: boolean;
+  source: EntityType;
+  timeZone?: string;
+}

package/src/models/api/permission-group.api.model.ts

@@ -0,0 +1,20 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {Permission, PermissionKeys} from "../../consts";
+
+export interface PermissionGroupApiModel {
+    id: string;
+    name: string;
+    order: number;
+    permissions: Record<PermissionKeys, Permission>;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}
+
+

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

@@ -0,0 +1,72 @@
+import { Timestamp } from "../timestamp";
+import { CreatedByModel } from "../created-by.model";
+import { 
+  EntityType, 
+  PaymentEntityType, 
+  RefundStatus, 
+  RefundReason, 
+  RefundDestination, 
+  PaymentProvider
+} from "../../enum";
+
+/**
+ * Refund API Model
+ * 
+ * Represents a refund transaction in the system.
+ * Tracks refund lifecycle from initiation to completion.
+ */
+export interface RefundApiModel {
+  id: string;
+
+  /** Link to original payment (if external money involved) */
+  paymentId?: string;
+
+  entityType: PaymentEntityType;
+  entityId: string; // bookingId or walletTopupId
+
+  userId: string;
+  userInfo?: {
+    id: string;
+    name: string;
+  };
+
+  /** Amount refunded in THIS refund event */
+  amount: number;
+  currency: "INR";
+
+  /** Why refund happened */
+  reason: RefundReason;
+  reasonDescription?: string;
+
+  /** Where money went */
+  refundTo: RefundDestination;
+
+  /** Lifecycle (async only for bank refunds) */
+  status: RefundStatus;
+
+  /** Provider details (only for bank refunds) */
+  provider?: PaymentProvider;
+  providerRefundId?: string;
+  providerResponse?: Record<string, unknown>;
+
+  errorCode?: string;
+  errorDescription?: string;
+
+  /** Related entities */
+  bookingId: string | null;
+  invoiceId: string | null;
+  walletTransactionId: string | null;
+
+  /** Who triggered this refund */
+  triggeredBy: EntityType; // system | admin | superAdmin
+
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt?: Timestamp | null;
+  isDeleted: boolean;
+  source: EntityType;
+  timeZone?: string;
+}

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

@@ -0,0 +1,16 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+
+export interface RfidApiModel {
+  id: string;
+  rfid: string;
+  userId: string;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deleteBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}

package/src/models/api/service-charge.api.model.ts

@@ -0,0 +1,21 @@
+import {CreatedByModel} from "../created-by.model";
+import {RateDuration} from "../rate-duration.model";
+import {Timestamp} from "../timestamp";
+
+export interface ServiceChargeApiModel {
+    id: string;
+    name: string;
+    rate: number;
+    rateDuration: RateDuration;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}
+
+
+
+

package/src/models/api/slot-hold.api.model.ts

@@ -0,0 +1,48 @@
+import { PointType } from "../../enum";
+import { ConnectorTypeModel } from "../connector-type.model";
+import { CreatedByModel } from "../created-by.model";
+import { PhoneNumberModel } from "../phone-number-model";
+import { PublicUserVehicle } from "../public-user-vehicle.model";
+import { ResolvedTariff } from "../resolved-tariff.model";
+import { ServiceChargeModel } from "../service-charge.model";
+import { Timestamp } from "../timestamp";
+
+export interface SlotHoldApiModel {
+  id: string;
+  userId: string;
+  userInfo: {
+    id: string;
+    name: string;
+    phoneNumber: PhoneNumberModel;
+  };
+  chargingDate: Timestamp;
+  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;
+  serviceChargeInfo: ServiceChargeModel;
+  serviceCharge: number;
+  isServiceChargeApplicable: boolean;
+  resolvedTariff?: ResolvedTariff;
+  expiresAt: Timestamp; // TTL (5 min)
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deleteBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

package/src/models/api/station-search.api.model.ts

@@ -0,0 +1,23 @@
+import {AddressApiModel} from "./address.api.model";
+import {StationAmenities} from "./station.api.model";
+import {GstModel} from "./gst-record-api.model";
+
+/**
+ * Meilisearch document format for Station search index
+ */
+export interface StationSearchApiModel {
+    id: string;
+    name: string;
+    stationCode: string;
+    status: string;
+    address?: AddressApiModel;
+    amenities?: StationAmenities;
+    gst?: GstModel | null;
+    _geo?: {
+        lat: number;
+        lng: number;
+    } | null;
+    capabilitiesAccess?: string[];
+    createdAt?: number;
+    updatedAt?: number;
+}

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

@@ -0,0 +1,59 @@
+import {AddressApiModel} from "./address.api.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {StationAccessCapability, StationStatus} from "../../enum";
+import { GstModel } from "./gst-record-api.model";
+
+export interface StationPhotoModel {
+    imageUrl: string;
+    isFeatured: boolean;
+}
+
+export interface StationApiModel {
+    id: string;
+    stationCode: string;
+    name: string;
+    address: AddressApiModel;
+    location: {
+        lat: number;
+        lng: number;
+    };
+    gst: GstModel;
+    _geo: {
+        lat: number;
+        lng: number;
+    };
+    /* ---------- CAPABILITIES (DERIVED, REQUIRED) ---------- */
+    capabilities: {
+      access: StationAccessCapability[];
+    };
+    amenities: StationAmenities;
+    photos: StationPhotoModel[];
+
+    /* ---------- CHARGER COUNTS (DERIVED, REQUIRED) ---------- */
+    chargerCounts: StationChargerCounts;
+    status: StationStatus;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}
+
+export interface StationChargerCounts {
+  total: number;
+  fleet: number;
+  public: number;
+  residentsOnly: number;
+}
+
+export interface StationAmenities {
+  parking: boolean;
+  restroom?: boolean;
+  cafe?: boolean;
+  waitingArea?: boolean;
+  wheelchairAccessible?: boolean;
+}

package/src/models/api/support-queries.api.model.ts

@@ -0,0 +1,20 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export  interface SupportQueriesApiModel {
+    id: string;
+    email: string;
+    timeZone: string;
+    appId: string;
+    source: string;
+    status: string;
+    fullName: string;
+    message: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+}

package/src/models/api/tariff-assignment.api.model.ts

@@ -0,0 +1,25 @@
+import {TariffScope} from "../../enum/tariff-scope.enum";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface TariffAssignmentApiModel {
+    id: string;
+    tariffId: string;
+
+    scope: TariffScope;
+    scopeId: string | null;           // null for global; stationId/chargerDocId/userId otherwise
+    capacityId?: string | null;       // optional; references ChargerCapacity doc; null = all capacities
+
+    priority: number;                  // auto-set: global=1, station=2, charger=3, user=5
+
+    validFrom: Timestamp;
+    validTo: Timestamp | null;
+    isActive: boolean;
+
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    isDeleted: boolean;
+    deletedAt: Timestamp | null;
+}

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

@@ -0,0 +1,22 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface TariffApiModel {
+    id: string;
+    name: string;
+    description?: string;
+
+    energyRate: number;
+
+    // References a doc in the ServiceCharges collection
+    serviceChargeId?: string | null;
+
+    isActive: boolean;
+
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    isDeleted: boolean;
+    deletedAt: Timestamp | null;
+}

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

@@ -0,0 +1,20 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType, GstType, TaxCategory} from "../../enum";
+
+export interface TaxApiModel {
+    id: string;
+    taxes: string[];
+    name: string;
+    percentage: number | null;
+    type: TaxCategory;
+    taxSpecificType: GstType;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+}

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

@@ -0,0 +1,22 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType} from "../../enum";
+import {UserRolePermission} from "../user-role-permission";
+import {PermissionKeys} from "../../consts";
+
+export interface UserRoleApiModel {
+  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/vehicle.api.model.ts

@@ -0,0 +1,21 @@
+import {BrandModel} from "../brand.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {VehicleType} from "../../enum";
+
+export interface VehicleApiModel {
+  id: string;
+  brand: BrandModel;
+  model: string;
+  year: number;
+  batteryCapacity: number;
+  image: string;
+  type: VehicleType;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deleteBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}

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

@@ -0,0 +1,23 @@
+import {CreatedByModel} from "../created-by.model";
+import {PhoneNumberModel} from "../phone-number-model";
+import {Timestamp} from "../timestamp";
+import {AddressApiModel} from "./address.api.model";
+
+export interface VendorApiModel {
+  id: string;
+  name: string;
+  contactPersonName: string;
+  phoneNumber: PhoneNumberModel;
+  website: string;
+  email: string;
+  description: string;
+  address: AddressApiModel;
+  chargers: any[];
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+}

package/src/models/api/wallet-transaction.api.model.ts

@@ -0,0 +1,27 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType, TransactionReason, TransactionType} from "../../enum";
+import { BookingPaymentInfo } from "../booking-payment-info.model";
+
+export interface WalletTransactionApiModel {
+  id: string;
+  userId: string;
+  amount: number;
+  topUpAmount?: number | null;
+  paymentInfo?: BookingPaymentInfo | null;
+  closingBalance?: number;
+  type: TransactionType;
+  reason: TransactionReason;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deleteBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  invoiceId?: string;
+  bookingId?: string;
+  bookingRef?: string;
+  source: EntityType;
+  timeZone?: string;
+}

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

@@ -0,0 +1,7 @@
+import { ApiErrorCode } from "../enum";
+
+export interface ApiErrorResponse {
+  errorCode: ApiErrorCode;
+  message: string;
+  details?: Record<string, unknown>;
+}

package/src/models/booking-payment-info.model.ts

@@ -0,0 +1,20 @@
+import { PaymentMethod, PaymentProvider } from "../enum";
+
+/**
+ * Generic payment info for bookings
+ * Provider-agnostic structure that can work with any payment gateway
+ */
+export interface BookingPaymentInfo {
+  // Payment method used
+  method: PaymentMethod;
+
+  // Provider details (optional - not present for wallet-only payments)
+  provider?: PaymentProvider;
+  providerOrderId?: string;
+  providerPaymentId?: string;
+  providerSignature?: string;
+
+  // Amount breakdown
+  walletAmount: number;
+  topUpAmount: number;
+}

package/src/models/brand.model.ts

@@ -0,0 +1,4 @@
+export interface BrandModel {
+    id: string;
+    name: string;
+}

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

@@ -0,0 +1,11 @@
+import {ColorModel} from "./color.model";
+import {ServiceChargeModel} from "./service-charge.model";
+
+export interface ChargerCapacity {
+  id: string;
+  capacity: string;
+  color: ColorModel;
+  capacityValue?: number;
+  capacityUnit?: string;
+  serviceCharge?: ServiceChargeModel;
+}

package/src/models/charging-transaction.ts

@@ -0,0 +1,17 @@
+import {Timestamp} from "./timestamp";
+
+export interface ChargingTransaction {
+    unitConsumed: number;
+    power: number;
+    endTime: Timestamp;
+    startTime: Timestamp;
+    meterStop: number;
+    meterStart: number;
+    state: string;
+    highestAmpere?: number;
+    ampere?: number;
+}
+
+export interface ChargingTransactionRecords {
+    [transactionId: string]: ChargingTransaction;
+}

package/src/models/color.model.ts

@@ -0,0 +1,6 @@
+export interface ColorModel {
+    id: number,
+    primary: string;
+    secondary: string;
+    tertiary: string;
+}

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

@@ -0,0 +1,5 @@
+export interface ConnectorTypeModel {
+  id: string;
+  name: string;
+  icon?: string;
+}

package/src/models/connector.model.ts

@@ -0,0 +1,11 @@
+import {ConnectorStatus} from "../enum";
+import {ChargerCapacity} from "./charger-capacity.model";
+import {ConnectorTypeModel} from "./connector-type.model";
+
+export interface ConnectorModel {
+    name: number;
+    status: ConnectorStatus;
+    capacity: string | ChargerCapacity;
+    unitRate: number;
+    type: ConnectorTypeModel;
+}

package/src/models/country.model.ts

@@ -0,0 +1,6 @@
+export interface CountryModel {
+  name: string;
+  code: string;
+  currencyCode: string;
+  currencySymbol: string;
+}

package/src/models/created-by.model.ts

@@ -0,0 +1,9 @@
+export interface CreatedByModel {
+  id: string;
+  name: string;
+}
+
+export interface PerformedBy {
+  id: string;
+  name: string;
+}

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

@@ -0,0 +1,5 @@
+export interface FleetChargerModel {
+  id: string;
+  name: string;
+  chargerId: string;
+}

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

@@ -0,0 +1,7 @@
+import {VehicleModel} from "./vehicle.model";
+
+export interface FleetVehicleModel {
+    id: string;
+    vehicle: VehicleModel;
+    vehicleNumber: string;
+}

package/src/models/fleet.model.ts

@@ -0,0 +1,4 @@
+export interface FleetModel {
+  id: string;
+  name: string;
+}

package/src/models/franchise.model.ts

@@ -0,0 +1,5 @@
+export interface FranchiseModel {
+  id: string;
+  name: string;
+  email?: string;
+}