types-salon-management 1.0.1

package/src/models/api/cancellation-reasons.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 CancellationReasonsApiModel {
+  id: string;
+  description: string;
+  isDefault: boolean;
+  outlet: OutletModel;
+  company: CompanyModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+

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

@@ -0,0 +1,31 @@
+import {EntityType, PaymentProcessingMethod, PaymentProvider} from "../../enum";
+import {CompanyModel} from "../company.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {CardOnFilePaymentProviderFieldModel} from "../card-on-file-payment-provider-field.model";
+import {SurchargeConfigModel} from "../surcharge-config.model";
+
+export interface CardOnFilePaymentProviderApiModel {
+    id: string;
+    name: string;
+    logoUrl: string;
+    description: string;
+    fields: CardOnFilePaymentProviderFieldModel[];
+    provider: PaymentProvider;
+    active: boolean;
+    isSetup: boolean;
+    setupData: { [key: string]: string };
+    paymentProcessingMethod: PaymentProcessingMethod;
+    isSurchargeApplicable: boolean;
+    surchargeConfig?: SurchargeConfigModel | null;
+    company: CompanyModel;
+    source: EntityType;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}

package/src/models/api/cash-counter.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 CashCounterApiModel {
+    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/client-deal.api.model.ts

@@ -0,0 +1,36 @@
+import {DealType, DiscountType, EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CompanyModel} from "../company.model";
+import {CreatedByModel} from "../created-by.model";
+
+export interface ClientDealApiModel {
+    id: string;
+    notificationSettingId: string;
+    clientId: string;
+    clientName: string;
+    name: string,
+    dealCode: string,
+    dealType: DealType;
+    discountType: DiscountType,
+    discountValue: number,
+    appliesToServices: string[];
+    appliesToProducts: string[];
+    startDate: Timestamp,
+    endDate: Timestamp,
+    dealImage: string | null;
+    minimumPurchaseAmount: number;
+    company: CompanyModel;
+    currencyCode: string;
+    currencySymbol: string;
+    used: boolean;
+    usedAt: Timestamp | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt?: Timestamp | null;
+    isDeleted: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel | null;
+    source: EntityType;
+    timeZone: string;
+}

package/src/models/api/client-import-batches.api.model.ts

@@ -0,0 +1,28 @@
+import { CreatedByModel } from "../created-by.model";
+import { EntityType } from "../../enum";
+import { Timestamp } from "../timestamp";
+
+export type ClientImportBatchStatus = "pending" | "succeeded" | "failed";
+
+export interface ClientImportBatchesApiModel {
+  id: string;
+  importBatchId: string;
+  fileName: string;
+  storagePath: string;
+  storageUrl: string;
+  status: ClientImportBatchStatus;
+  totalClients: number;
+  importedClients: number;
+  failedClients: number;
+  processedClients: number;
+  progressPercent: number;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  updatedAt: Timestamp;
+  createdAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean | null;
+  source: EntityType;
+  timeZone: string;
+}

package/src/models/api/client-transaction-history.api.model.ts

@@ -0,0 +1,23 @@
+import {CompanyModel} from '../company.model';
+import {Timestamp} from '../timestamp';
+import {CreatedByModel} from '../created-by.model';
+import {OutletModel} from '../outlet.model';
+import {EntityType} from "../../enum";
+
+export interface ClientTransactionHistoryApiModel {
+    company: CompanyModel;
+    amount: number;
+    appointmentId: string;
+    appointmentRef: string;
+    paymentId: string;
+    status: string;
+    outlet: OutletModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+}

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

@@ -0,0 +1,92 @@
+import {OutletModel} from '../outlet.model';
+import {CompanyModel} from '../company.model';
+import {PhoneNumberModel} from '../phone-number-model';
+import {ContraindicationModel} from '../view';
+import {TimeApiModel} from './time.api.model';
+import {Timestamp} from '../timestamp';
+import {AddressApiModel} from './address.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {ClientCreationSource, EntityType, PaymentCardBrand, PaymentProvider} from '../../enum';
+import {SurchargeConfigModel} from "../surcharge-config.model";
+
+export interface ClientApiModel {
+    id: string;
+    clientRef: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phoneNumber: PhoneNumberModel;
+    secondPhoneNumber: string;
+    outlet: OutletModel;
+    outletIds: string[];
+    gender: string;
+    company: CompanyModel;
+    notification: ClientNotificationApiModel;
+    lastVisitDate: Timestamp;
+    createdAt: Timestamp;
+    updatedAt: TimeApiModel;
+    deletedAt: TimeApiModel | null;
+    isDeleted: boolean;
+    active: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    birthDate: Timestamp | null;
+    birthDay: number | null;
+    birthMonth: number | null;
+    anniversaryDate: Timestamp | null;
+    anniversaryDay: number | null;
+    anniversaryMonth: number | null;
+    note: string;
+    accountBalance: string;
+    isLoyaltyMember: boolean;
+    loyaltyPointBalance: number;
+    isUnreliable: boolean;
+    clientSource: string;
+    title: string;
+    productDiscount: number;
+    serviceDiscount: number;
+    preferredStaffs: string[];
+    address: AddressApiModel;
+    color: string;
+    contraindication: Array<ContraindicationModel>;
+    cardComplete: boolean;
+    verified: boolean;
+    cardsOnFiles: Record<string, CardOnFileApiModel>;
+    appointmentStats: {
+        visit: number;
+        cancelled: number;
+        completed: number;
+        noShow: number;
+    },
+    userId: string;
+    addedBy: EntityType;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    clientCreationSource: ClientCreationSource;
+    importBatchId?: string;
+}
+
+export interface ClientNotificationApiModel {
+    sms: boolean;
+    whatsApp: boolean;
+    email: boolean;
+    gdpr: boolean;
+    terms: boolean;
+}
+
+export interface CardOnFileApiModel {
+    id: string,
+    token: string;
+    brand: PaymentCardBrand;
+    expirationMonth: string;
+    expirationYear: string;
+    last4: string;
+    bin?: string;
+    cvv?: string;
+    provider: PaymentProvider;
+    providerId: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    isDefault: boolean;
+    surchargeConfig?: SurchargeConfigModel | null;
+}

package/src/models/api/closed-day.api.model.ts

@@ -0,0 +1,24 @@
+import {Timestamp} from "../timestamp";
+import {OutletModel} from "../outlet.model";
+import {CompanyModel} from "../company.model";
+import {CreatedByModel} from "../created-by.model";
+import {EntityType} from "../../enum";
+
+export interface ClosedDayApiModel {
+    id: string;
+    startDate: Timestamp;
+    endDate: Timestamp;
+    outlets: OutletModel[];
+    outletIds: string[];
+    company: CompanyModel;
+    description: string;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean | null;
+    source: EntityType;
+    timeZone: string;
+}

package/src/models/api/commission-bucket-state.api.model.ts

@@ -0,0 +1,30 @@
+import { EntityType } from '../../enum';
+import { CompanyModel } from '../company.model';
+import { CreatedByModel } from '../created-by.model';
+import { Timestamp } from '../timestamp';
+
+export interface CommissionBucketStateApiModel {
+  id: string;
+  staffCommissionId: string;
+  staffId: string;
+  locationId: string;
+  bucketKey: string;
+  itemType: "service" | "product";
+
+  salesToDate: number;
+  commissionToDate: number;
+  paidToDate: number;
+
+  totalSalesBase: number;
+  totalCommission: number;
+
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

package/src/models/api/commission-profile.api.model.ts

@@ -0,0 +1,36 @@
+import {OutletModel} from '../outlet.model';
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {CommissionBy, EntityType} from '../../enum';
+
+export interface CommissionProfileApiModel {
+  id: string;
+  name: string;
+  type: string;
+  rules: RulesModel;
+  outlet: OutletModel;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  updatedAt: TimeApiModel;
+  createdAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+
+export interface RulesModel {
+  service: CommissionRuleModel [];
+  product: CommissionRuleModel [];
+  giftCard: CommissionRuleModel [];
+}
+
+export interface CommissionRuleModel {
+  from: number;
+  to: number;
+  rate: number; // commission rate as a decimal (e.g. 0.05 represents 5%)
+  by: CommissionBy;
+}
+

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

@@ -0,0 +1,23 @@
+import {CreatedByModel} from '../created-by.model';
+import {CommunicationProviderName, CommunicationProviderType, EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CommunicationProviderFieldModel} from "../communication-provider-field.model";
+
+
+export interface CommunicationProviderApiModel {
+    id: string;
+    active: boolean;
+    provider: CommunicationProviderName;
+    type: CommunicationProviderType;
+    fields: CommunicationProviderFieldModel[];
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}
+

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

@@ -0,0 +1,21 @@
+import { CompanyModel } from '../company.model';
+import { CreatedByModel } from '../created-by.model';
+import { Timestamp } from '../timestamp';
+import { AddonId } from '../../consts';
+
+export interface CompanyAddonApiModel {
+  id: string;
+  addonId: AddonId;
+  masterAddonActive: boolean;
+  active: boolean;
+  metadata: Record<string, any>;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

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

@@ -0,0 +1,21 @@
+import { CompanyModel } from '../company.model';
+import { CreatedByModel } from '../created-by.model';
+import { Timestamp } from '../timestamp';
+import { IntegrationId } from '../../consts';
+
+export interface CompanyIntegrationApiModel {
+  id: string;
+  integrationId: IntegrationId;
+  integrationActive: boolean;
+  active: boolean;
+  metadata: Record<string, any>;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

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

@@ -0,0 +1,78 @@
+import {BillingCycle, CompanyInvoiceType, PaymentGateway, PaymentStatus} from "../../enum";
+import {BillingEntityModel} from "../billing-entity.model";
+import {CompanyModel} from "../company.model";
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+
+export interface CompanyInvoiceApiModel {
+    id: string;
+    invoiceType: CompanyInvoiceType;
+    invoiceNumber: string;
+    paymentDate: Timestamp;
+
+    // Subscription-specific fields
+    subscriptionId?: string | null;
+    subscriptionPlanName?: string | null;
+    BillingCycle?: BillingCycle | null;
+    billingPeriod?: {
+        strat: Timestamp;
+        to: Timestamp;
+    } | null;
+
+    // Financial details
+    subtotal: number;
+    taxAmount: number;
+    taxRate: number;
+    total: number;
+    currencyCode: string;
+    paymentFee?: number | null;
+    paymentTax?: number | null;
+
+    // Payment details
+    paymentStatus: PaymentStatus;
+    paymentGateway: PaymentGateway;
+    paymentGatewayTransactionId?: string;
+    paymentMethod: 'card' | 'upi';
+    paymentGatewayInvoiceId?: string | null;
+    paymentGatewayOrderId?: string | null;
+    paymentGatewayCustomerId?: string | null;
+    paymentDescription?: string | null;
+
+    // Billing address
+    // Line items
+    items: {
+        itemType: 'basePlan' | 'additionalUnit' | 'addon' | 'whatsappCredit' | 'smsCredit';
+        unit: number;
+        unitPrice: number;
+        amount: number;
+        taxable: boolean;
+    }[];
+
+    company: CompanyModel;
+    billingEntity: BillingEntityModel;
+    issuer: InvoiceIssuerCompany;
+
+    // Additional fields
+    termsAndConditions?: string;
+    createdAt: Timestamp;
+    createdBy: CreatedByModel;
+    updatedAt: Timestamp;
+    updatedBy: CreatedByModel;
+    isDeleted: boolean;
+    deletedAt?: Timestamp | null;
+    deletedBy?: CreatedByModel | null;
+}
+
+export interface InvoiceIssuerCompany {
+    companyName: string;
+    addressLine1: string;
+    city: string;
+    state: string;
+    country: string;
+    postalCode: string;
+    gstin?: string | null;
+    pan?: string | null;
+    vatNumber?: string | null;
+    email: string;
+    phoneNumber?: string | null;
+}

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

@@ -0,0 +1,168 @@
+import { OutletModel } from '../outlet.model';
+import { GiftCardValidityModel } from '../gift-card-validity.model';
+import { PhoneNumberModel } from '../phone-number-model';
+import { CountryModel } from '../country.model';
+import { AddressApiModel } from './address.api.model';
+import { CreatedByModel } from '../created-by.model';
+import { EntityType, PayrollFrequency, SubscriptionStatus, TaxCalculationMethod } from "../../enum";
+import { Timestamp } from "../timestamp";
+import { SocialMediaLinksModel } from "../social-media-links.model";
+import { TimeFrameModel } from "../time-frame.model";
+import { BillingEntityModel } from '../billing-entity.model';
+import { PayRunModel } from '../pay-run.model';
+
+export interface CompanyUserTokens {
+    deviceToken: string;
+    outletIds: string[];
+    role: string;
+    staffId: string;
+}
+
+export interface CompanyApiModel {
+    id: string;
+    userId: string;
+    phoneNumber: PhoneNumberModel;
+    agree: boolean;
+    firstName: string;
+    companyName: string;
+    locations: OutletModel[];
+    lastName: string;
+    email: string;
+    color: string;
+    desc: string;
+    address: AddressApiModel;
+    // TODO: Remove optional when all companies have billing entity
+    billingEntity?: BillingEntityModel;
+    country: CountryModel;
+    logo?: string;
+    invoiceCount: number;
+    stockOrderCount: number;
+    stockTransferCount: number;
+    smsCredit: number;
+    whatsAppCredit: number;
+    receiptSettings: ReceiptSettingsModel;
+    supportId: string;
+    primaryCategory: string;
+    secondaryCategories: string[];
+    sendCredentialsViaMail: boolean;
+    password: string;
+    socialMediaLinks: SocialMediaLinksModel;
+    settings: CompanySettingsModel;
+    tokens: CompanyUserTokens[];
+    subscriptionId: string | null;
+    subscriptionStatus: SubscriptionStatus;
+    defaultPaymentMethodId: string | null;
+    paymentUrl: string | null;
+    outlets: OutletModel[];
+    payrollSettings: PayrollSettingsApiModel;
+    payRunSettings?: PayRunSettingsModel | null;
+    bookingSettings: BookingSettingsModel;
+    timesheetSettings: TimesheetSettingsModel;
+    isWhiteLabel?: boolean;
+    whiteLabelSettings: WhiteLabelSettingsModel | null;
+    whatsappTemplateAliases: WhatsappTemplateAliasMapping;
+    slug: string;
+
+    isDeleted: boolean;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt?: Timestamp | null;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel | null;
+    source: EntityType;
+    timeZone: string;
+}
+
+export interface CompanySettingsModel {
+    loyaltyPointsActive: boolean;
+    loyaltyPointValue: number;
+    giftCardExpiry: GiftCardValidityModel;
+    advanceBookingLimit: number;
+    bookingFeeActive: boolean;
+    bookingFee: number;
+    whatsAppId: string | null;
+    taxCalculationMethod: TaxCalculationMethod;
+    invoiceBackDating: boolean;
+    invoiceBackDatingLimit: number | null;
+    showAppointmentPricing: boolean;
+}
+
+export interface ReceiptSettingsModel {
+    showCompanyLogo: boolean;
+    showGST: boolean;
+    receiptHeading: string;
+    showTermsAndCondition: boolean;
+    termsAndCondition: string;
+    showTaxSummary: boolean;
+}
+
+export interface PayrollSettingsApiModel {
+    active: boolean;
+    frequency: PayrollFrequency;
+    periodStartDay: number | null;
+    currentPayPeriod: PayPeriodApiModel;
+    payGenerationDate: Timestamp;
+}
+
+export interface PayRunSettingsModel {
+    active: boolean;
+    frequency: PayrollFrequency;
+    periodStartDay: number | null;
+    currentPayRun: PayRunModel;
+}
+
+export interface PayPeriodApiModel {
+    start: Timestamp;
+    end: Timestamp;
+    frequency: PayrollFrequency
+    periodStartDay: number | null;
+}
+
+export type WhatsappTemplateKeys =
+    | "appointmentCompleted"
+    | "appointmentRescheduled"
+    | "downloadBookingApp"
+    | "appointmentCancellationByClient"
+    | "appointmentCancellation"
+    | "appointmentConfirmation"
+    | "dailySummaryReport"
+    | "unpaidInvoiceReminder"
+    | "warningOrderStockLevel"
+    | "supplierStockOrderMessage"
+    | "minimumOrderStockLevel"
+    | "serviceRebookReminder"
+    | "invoiceRefund"
+    | "clientAnniversary"
+    | "clientAnniversaryWithDeal"
+    | "clientBirthday"
+    | "clientBirthdayWithDeal";
+
+
+export type WhatsappTemplateAliasMapping = {
+    [key in WhatsappTemplateKeys | string]: string;
+};
+
+export interface BookingSettingsModel {
+    autoConfirmAppointment: boolean;
+    avoidGap: boolean;
+    advanceBookingWindow: TimeFrameModel;
+    bookingWindow: TimeFrameModel;
+    rescheduling: TimeFrameModel;
+    autoNoShowEnabled: boolean;
+    autoNoShowBuffer: TimeFrameModel | null;
+}
+
+export interface TimesheetSettingsModel {
+    proximityControls: boolean;
+    autoClockIn: boolean;
+    autoClockOut: boolean;
+    autoStartEndBreak: boolean;
+}
+
+export interface WhiteLabelSettingsModel {
+    bookingLink: string;
+}
+
+
+

package/src/models/api/contraindication.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 ContraindicationApiModel {
+  id: string;
+  name: string;
+  description: string;
+  outlet: OutletModel;
+  company: CompanyModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+