types-salon-management 1.0.1

package/src/models/api/subscription-plan.api.model.ts

@@ -0,0 +1,49 @@
+import { FeatureModel } from "../feature.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import {
+  BillingChargeTiming,
+  BillingCycle,
+  EntityType,
+  PaymentGateway,
+  PlanPricingType,
+  PlanType,
+} from "../../enum";
+import { CountryModel } from "../country.model";
+import { TimeFrameModel } from "../time-frame.model";
+import { PlanUnitType } from "../../enum/plan-unit-type";
+
+export interface SubscriptionPlanApiModel {
+  id: string;
+  name: string;
+  country: CountryModel;
+  billingCycle: BillingCycle;
+
+  pricingType: PlanPricingType;
+  billingChargeTiming: BillingChargeTiming;
+  
+  paymentGateway: PaymentGateway | null;
+  basePrice: number;
+  unitType: PlanUnitType;
+  unitPrice: number;
+
+  hasTrial: boolean;
+  trialPeriod: TimeFrameModel | null;
+  
+  description: string;
+  planType: PlanType;
+
+  active: boolean;
+  showOnWebsite: boolean;
+
+  features: FeatureModel[];
+
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  source: EntityType;
+}

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

@@ -0,0 +1,70 @@
+import { Timestamp } from "../timestamp";
+import { CreatedByModel } from "../created-by.model";
+import { CompanyModel } from "../company.model";
+import { EntityType, PaymentGateway, SubscriptionStatus } from "../../enum";
+import { SubscriptionPlan } from "../subscription-plan.model";
+import { TimeFrameModel } from "../time-frame.model";
+
+export interface SubscriptionApiModel {
+  id: string;
+  subscriptionStatus: SubscriptionStatus;
+  subscriptionPlan: SubscriptionPlan | null;
+
+  hasTrial: boolean;
+  trial?: SubscriptionTrialModel | null;
+
+  /**
+   * Current configured additional units (what UI shows, and what
+   * next cycle will use as baseline).
+   */
+  additionalUnits: number;
+
+  /**
+   * For postpaid (end_of_cycle) plans:
+   * Additional units locked at the start of the current billing cycle.
+   * Used to compute the base cycle amount. Set at cycle start and
+   * kept unchanged until the cycle is closed.
+   */
+  cycleBaseAdditionalUnits?: number;
+
+  /**
+   * For postpaid (end_of_cycle) plans:
+   * Accumulated prorated amount for mid‑cycle unit changes in the
+   * current billing cycle (in main currency units, e.g. INR).
+   * Reset to 0 at the end of the cycle after billing.
+   */
+  usageAccruedAmount?: number;
+
+  currentStartDate: Timestamp | null;
+  currentEndDate: Timestamp | null;
+  nextBillingAt: Timestamp | null;
+
+  isCancelled?: boolean;
+  cancelledAt?: Timestamp | null;
+  cancelledBy?: CreatedByModel | null;
+
+  retryNextAt?: Timestamp | null;
+  retryCount?: number;
+  delinquentSince?: Timestamp | null;
+
+  paymentGateway: PaymentGateway;
+  defaultPaymentMethodId?: string | null;
+  company: CompanyModel;
+  userId: string;
+
+  createdBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedBy: CreatedByModel;
+  updatedAt: Timestamp;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel | null;
+  deletedAt: Timestamp | null;
+  source: EntityType;
+}
+
+export interface SubscriptionTrialModel {
+  period: TimeFrameModel;
+  startDate: Timestamp;
+  endDate: Timestamp;
+  isEnded: boolean;
+}

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

@@ -0,0 +1,31 @@
+import { PhoneNumberModel } from "../phone-number-model";
+import { CompanyModel } from "../company.model";
+import { TimeApiModel } from "./time.api.model";
+import { AddressApiModel } from "./address.api.model";
+import { CreatedByModel } from "../created-by.model";
+import { ProductApiModel } from "./product.api.model";
+import { EntityType } from "../../enum";
+import { CreationSource } from "../../consts";
+
+export interface SupplierApiModel {
+  id: string;
+  name: string;
+  phoneNumber: PhoneNumberModel | null;
+  address: AddressApiModel;
+  description: string;
+  company: CompanyModel;
+  email: string | null;
+  website: string;
+  contactPersonName: string | null;
+  products: Array<Pick<ProductApiModel, "id" | "name">>;
+  creationSource: CreationSource;
+  importBatchId?: string;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  deletedBy: CreatedByModel;
+  isDeleted: boolean;
+  source: EntityType;
+}

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

@@ -0,0 +1,24 @@
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {EntityType, TaxCategory} from "../../enum";
+
+
+export interface TaxApiModel {
+    id: string;
+    taxes: string[];
+    name: string;
+    percentage: number | null;
+    type: TaxCategory;
+    isDefault?: boolean;
+    company: CompanyModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    updatedAt: TimeApiModel;
+    createdAt: TimeApiModel;
+    deletedAt: TimeApiModel | null;
+    isDeleted: boolean;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+}
+

package/src/models/api/till-drop.api.model.ts

@@ -0,0 +1,26 @@
+import {OutletModel} from '../outlet.model';
+import {CompanyModel} from '../company.model';
+import {StaffDropdownModel} from '../view';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {TillModel} from '../till.model';
+import {EntityType} from "../../enum";
+
+export interface TillDropApiModel {
+  id: string;
+  tillDropAmount: string;
+  staff: Array<StaffDropdownModel>;
+  till: Array<TillModel>;
+  description: string;
+  outlet: OutletModel;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+

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

@@ -0,0 +1,22 @@
+import {OutletModel} from '../outlet.model';
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from "../../enum";
+
+
+export interface TillApiModel {
+  id: string;
+  name: string;
+  amount: string;
+  outlet: OutletModel;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  source: EntityType;
+}
+

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

@@ -0,0 +1,9 @@
+import {Timestamp} from '../timestamp';
+
+export interface TimeApiModel {
+  seconds: number;
+  nanoseconds: number;
+}
+
+
+export default Timestamp;

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

@@ -0,0 +1,27 @@
+import {CompanyModel} from '../company.model';
+import {RazorpayPaymentError, RazorpaySuccessResponse} from '../razorpay.model';
+import {Timestamp} from '../timestamp';
+import {EntityType, PaymentStatus, TransactionType} from '../../enum';
+import {CreatedByModel} from '../created-by.model';
+
+export interface TransactionApiModel {
+    company: CompanyModel;
+    orderId: string;
+    paymentId: string;
+    amount: number;
+    paymentStatus: PaymentStatus;
+    transactionType: TransactionType;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    metadata: Record<string, any>,
+    paymentVerified: boolean;
+    razorpaySignature?: string;
+    paymentInfo?: RazorpaySuccessResponse;
+    error?: RazorpayPaymentError;
+}

package/src/models/api/user-notification-settings.api.model.ts

@@ -0,0 +1,49 @@
+import {CompanyModel} from "../company.model";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import {ActivityPreference, EntityType} from "../../enum";
+import {StaffModel} from "../view";
+
+export interface UserNotificationSettingsApiModel {
+    id: string;
+    staffId: string;
+    staff: StaffModel;
+    userId: string;
+    outletIds: string[];
+    deviceTokens: string[];
+    activityPreference: ActivityPreference;
+    settings: UserNotificationConfig;
+    company: CompanyModel;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: false;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    timeZone: string;
+}
+
+export interface UserNotificationConfig {
+    clientReview: boolean;
+    appointmentCreated: boolean;
+    appointmentCancelled: boolean;
+    appointmentRescheduled: boolean;
+    appointmentConfirmed: boolean,
+    appointmentNoShow: boolean;
+    appointmentStarted: boolean;
+    appointmentCheckIn: boolean;
+    productLowStockLevel: boolean;
+    productWarningStockLevel: boolean;
+    timesheetShiftAboutToStart: boolean;
+    timesheetShiftAboutToEnd: boolean;
+    dailySummaryReport: {
+        enabled: boolean;
+        time: number; // clarify unit (e.g., minutes since midnight, Unix timestamp, etc.)
+    };
+    productSaleReport: {
+        enabled: boolean;
+        frequency: 'daily' | 'weekly' | 'monthly';
+    };
+}

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

@@ -0,0 +1,25 @@
+import {CompanyModel} from "../company.model";
+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;
+    order: number;
+    permissions: Record<PermissionKeys, UserRolePermission> | null;
+    isDefault?: boolean;
+    company: CompanyModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}

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

@@ -0,0 +1,52 @@
+import { EntityType, SubscriptionStatus } from "../../enum";
+import { CompanyModel } from "../company.model";
+import { CountryModel } from "../country.model";
+import { OutletModel } from "../outlet.model";
+import { PhoneNumberModel } from "../phone-number-model";
+import { Timestamp } from "../timestamp";
+import { AddressApiModel } from "./address.api.model";
+import { UserRoleApiModel } from "./user-role.api.model";
+import { CreatedByModel } from "../created-by.model";
+import { ProviderData } from "../provider-data.model";
+import { PermissionKeys } from "../../consts";
+import { UserRolePermission } from "../user-role-permission";
+
+export interface UserApiModel {
+  id: string;
+  userId: string;
+  email: string;
+  company: CompanyModel | null;
+  country: CountryModel;
+  phoneNumber: PhoneNumberModel;
+  photoURL: string | null;
+  displayName?: string;
+  firstName: string;
+  lastName?: string;
+  gender: string;
+  color: string;
+  staffId: string;
+  outlets: Array<OutletModel>;
+  outletIds: Array<string>;
+  emailVerified: boolean;
+  subscriptionId: string | null;
+  subscriptionStatus: SubscriptionStatus | null;
+  roles?: Pick<UserRoleApiModel, 'title' | 'value' | 'id'>;
+  address?: AddressApiModel;
+  favouriteSalons?: string[];
+  providerData?: ProviderData[];
+  permissions?: Record<PermissionKeys, UserRolePermission> | null;
+  agreed?: boolean;
+  agreedAt?: Timestamp;
+  legalDocumentId?: string;
+  onboardingComplete?: boolean;
+
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+  timeZone: string;
+}

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

@@ -0,0 +1,23 @@
+import {Timestamp} from "../timestamp";
+import {CompanyModel} from "../company.model";
+import {CreatedByModel} from "../created-by.model";
+import {EntityType} from "../../enum";
+import {AddressApiModel} from "./address.api.model";
+
+export interface WarehouseApiModel {
+    id: string;
+    name: string;
+    active: boolean;
+    description: string;
+    address: AddressApiModel | null;
+    company: CompanyModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean | null;
+    source: EntityType;
+    timeZone: string;
+}

package/src/models/appointment-reminder.model.ts

@@ -0,0 +1,4 @@
+export interface AppointmentReminderModel {
+  beforeDay: boolean;
+  time: string;
+}

package/src/models/billing-entity.model.ts

@@ -0,0 +1,17 @@
+import { BillingEntityType } from "../enum";
+import { PhoneNumberModel } from "./phone-number-model";
+
+export interface BillingEntityModel {
+    entityType: BillingEntityType; // "Company" | "Individual"
+    companyName?: string;           // Required if entityType is "Company"
+    firstName: string;              // Always required
+    lastName: string;               // Always required
+    taxId: string;                  // GSTIN if country is India; VAT/TIN otherwise
+    email: string | null;                  // Always required
+    phoneNumber: PhoneNumberModel | null;            // Always required
+    addressLine: string | null;
+    city: string | null;
+    state: string | null;
+    postalCode: string | null;
+    country: string | null;
+}

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

@@ -0,0 +1,9 @@
+import {BreakType} from "../enum";
+import {Timestamp} from "./timestamp";
+
+export interface BreakApiModel {
+    start: number;
+    end: number;
+    type: BreakType;
+    date: Timestamp;
+}

package/src/models/break.model.ts

@@ -0,0 +1,8 @@
+import {BreakType} from "../enum";
+
+export interface BreakModel<T = Date> {
+    start: number;
+    end: number;
+    type: BreakType;
+    date: T;
+}

package/src/models/business-category.model.ts

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

package/src/models/card-on-file-payment-provider-field.model.ts

@@ -0,0 +1,7 @@
+export interface CardOnFilePaymentProviderFieldModel {
+    name: string;
+    type: string;
+    label: string;
+    required: boolean;
+    readonly: boolean;
+}

package/src/models/card-refund-request.model.ts

@@ -0,0 +1,11 @@
+export interface CardRefundRequestModel {
+    paymentProcessingMethod: string;
+    providerId: string;
+    invoiceNo: number;
+    companyId: string;
+    amount: number;
+    token: string;
+}
+
+
+ 

package/src/models/card-sale-request.model.ts

@@ -0,0 +1,7 @@
+export interface CardSaleRequestModel {
+    companyId: string;
+    providerId: string;
+    amount: number;
+    token: string;
+    invoiceNo: string;
+}

package/src/models/cash-counter.model.ts

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

package/src/models/color.model.ts

@@ -0,0 +1,5 @@
+export interface Color {
+    id: number;
+    title: string;
+    value:  string;
+}

package/src/models/commission-calculation-rules.model.ts

@@ -0,0 +1,13 @@
+export interface CommissionCalculationRulesModel {
+  /** true = calculate commission AFTER discount, false = BEFORE discount */
+  deductDiscount: boolean;
+
+  /** true = calculate commission AFTER tax, false = BEFORE tax */
+  deductTax: boolean;
+
+  /** true = calculate commission when invoice is PAID, false = when invoice is CREATED */
+  earnCommissionOnFullyPaidInvoice: boolean;
+
+  /** true = include package redeemed items in commission */
+  earnCommissionOnServiceRedeemedBYPackage: boolean;
+}

package/src/models/commission-settings.model.ts

@@ -0,0 +1,14 @@
+import {CommissionType, CommissionRateType, SalesPeriod} from "../consts";
+import {TierModel} from "./tier.model";
+import { Timestamp } from "./timestamp";
+
+export interface CommissionSettingsModel {
+  active: boolean;
+  type: CommissionType;
+  salesPeriod: SalesPeriod | null;
+  salesPeriodWeekStart: number | null;
+  rateType: CommissionRateType;
+  amount: number | null;
+  tiers: TierModel[];
+  effectiveDate: Timestamp;
+}

package/src/models/communication-provider-field.model.ts

@@ -0,0 +1,6 @@
+export interface CommunicationProviderFieldModel {
+    name: string;
+    type: string;
+    label: string;
+    required: boolean;
+}

package/src/models/company.model.ts

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

package/src/models/country.model.ts

@@ -0,0 +1,8 @@
+export interface CountryModel {
+  name: string;
+  code: string;
+  currencyCode: string;
+  currencySymbol: string;
+  locale: string;
+  tax: 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/currency.model.ts

@@ -0,0 +1,4 @@
+export interface CurrencyModel {
+    code: string;
+    symbol: string;
+}

package/src/models/datacap-success-response.model.ts

@@ -0,0 +1,38 @@
+export interface DataCapSuccessRStream {
+    CardType: string;
+    ProcessData: string;
+    AcctNo: string;
+    RefNo: string;
+    TVR: string;
+    Date: string;
+    TSI: string;
+    Purchase: string;
+    TextResponse: string;
+    UserTrace: string;
+    PayAPI_Id: string;
+    Authorize: string;
+    InvoiceNo: string;
+    CaptureStatus: string;
+    EntryMethod: string;
+    ApplicationLabel: string;
+    IAD: string;
+    TranCode: string;
+    Time: string;
+    AcqRefData: string;
+    AID: string;
+    ResponseOrigin: string;
+    AuthCode: string;
+    CmdStatus: string;
+    SequenceNo: string;
+    CVM: string;
+    MerchantID: string;
+    DSIXReturnCode: string;
+    RecordNo: string;
+
+    // Index signature for "Line" fields
+    [key: `Line${number}`]: string;
+}
+
+export interface DataCapSuccessResponse {
+    RStream: DataCapSuccessRStream;
+}

package/src/models/date-filter.model.ts

@@ -0,0 +1,7 @@
+import {DateRange} from "./date-range";
+
+export interface DateFilterModel {
+    dateRange: DateRange;
+    name: string;
+    active?: boolean;
+}

package/src/models/date-range.ts

@@ -0,0 +1,4 @@
+export interface DateRange {
+    start: Date;
+    end: Date;
+}

package/src/models/deal-settings.model.ts

@@ -0,0 +1,11 @@
+import { DealType, DiscountType } from "../enum";
+
+export interface DealSettingsModel {
+  discountCode: string;
+  dealType: DealType;
+  discountType: DiscountType;
+  discountValue: number;
+  appliesToServices: string[];
+  appliesToProducts: string[];
+  expiresAfter: number; // no of days after the deal expires
+}

package/src/models/deal.model.ts

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

package/src/models/download-data.model.ts

@@ -0,0 +1,5 @@
+export interface DownloadData<T> {
+    data: Array<T>;
+    type: string;
+    headings: string[];
+}