types-salon-management 1.0.1

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

@@ -0,0 +1,53 @@
+import { EntityType, PayRunActivitySubType } from '../../enum';
+import { CommissionSettingsModel } from '../commission-settings.model';
+import { CompanyModel } from '../company.model';
+import { CreatedByModel } from '../created-by.model';
+import { Timestamp } from '../timestamp';
+import { StaffResourceApiModel } from './appointment.api.model';
+
+
+export type CommissionBySource = {
+  service: number;
+  product: number;
+};
+
+export type StaffCommissionStateModel = {
+  staff: StaffResourceApiModel;
+  commission: CommissionBySource;
+};
+
+export interface InvoiceCommissionStateApiModel {
+  id: string;
+  invoiceId: string;
+  invoiceNo: number | null;
+  invoiceDate: Timestamp;
+
+  payRunId: string | null;
+
+  assignmentHash: string;
+
+  staffStates: Record<string, StaffCommissionStateModel>;
+
+  bucketSalesEntries?: InvoiceCommissionBucketSalesEntryModel[];
+
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+
+
+export interface InvoiceCommissionBucketSalesEntryModel {
+  bucketKey: string;
+  bucketDocId: string;
+  staffId: string;
+  staffCommissionId: string;
+  sourceType: PayRunActivitySubType.ProductCommission | PayRunActivitySubType.ProductCommission;
+  commissionSettings: CommissionSettingsModel;
+  salesAmount: number;
+}

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

@@ -0,0 +1,29 @@
+import {CompanyModel} from "../company.model";
+import {OutletModel} from "../outlet.model";
+import {CreatedByModel} from "../created-by.model";
+import {EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+
+
+export interface InvoiceEmailApiModel {
+    email: string,
+    invoiceId: string,
+    company: CompanyModel,
+    outlet: OutletModel,
+    attempts: number,
+    error: string,
+    data: any,
+    source: EntityType;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    deletedBy?: CreatedByModel;
+}
+
+
+
+
+

package/src/models/api/invoice-item-commission.api.model.ts

@@ -0,0 +1,53 @@
+import { EntityType, CommissionDirection, CommissionReason, BillItemType, ClientType } from "../../enum";
+import { CompanyModel } from "../company.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import { OutletModel } from "../outlet.model";
+import { CommissionSettingsModel } from "../commission-settings.model";
+
+export interface InvoiceItemCommissionApiModel {
+  id: string;
+  itemName: string;
+  qty: number; // for reporting
+
+  invoiceItemId: string;
+  invoiceId: string;
+  invoiceNo: number;
+  invoiceDate: Timestamp;
+  isRefund: boolean;
+
+  clientId: string | null;
+  clientName: string | null;
+  clientType: ClientType; // default is walk-in
+
+  staffId: string;
+  staffName: string;
+
+  itemType: BillItemType;
+
+  staffCommissionId: string;
+  commissionSettings: CommissionSettingsModel;
+
+  direction: CommissionDirection;
+  reason: CommissionReason; 
+
+  amount: number; // for reporting => gross sale and refund sale
+  discountAmount: number; // for reporting
+  taxAmount: number; // for reporting
+
+  baseAmount: number;
+  commissionAmount: number; // signed (+ / -)
+
+  payRunEffectiveAt: Timestamp;
+
+  location: OutletModel;
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

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

@@ -0,0 +1,99 @@
+import { CompanyModel } from "../company.model";
+import { Timestamp } from "../timestamp";
+import {
+  BillItemType,
+  ClientType,
+  EntityType,
+  InvoiceStatus,
+  PaymentStatus,
+} from "../../enum";
+import { CreatedByModel } from "../created-by.model";
+import { StaffResourceApiModel } from "./appointment.api.model";
+import { GiftCardValidityModel } from "../gift-card-validity.model";
+import { DealModel } from "../deal.model";
+import { TaxDetailModel } from "../tax-detail.model";
+import { GradientColor } from "../gradient-color";
+import { BrandModel, ProductSupplierModel } from "./product.api.model";
+import { OutletModel } from "../outlet.model";
+import { PackageDetailApiModel } from "../package-detail-api.model";
+
+export interface InvoiceItemApiModel {
+  id: string;
+  relatedId?: string | null; // The ID of the original invoice item when this item is a refund
+  
+  itemId: string; // The ID of the item being invoiced (service, product, gift card, or package)
+  itemName: string;
+  itemDate: Timestamp;
+  itemType: BillItemType;
+  appointmentId?: string | null;
+
+  invoiceId: string;
+  relatedInvoiceId?: string | null;
+  invoiceNo: number;
+  invoiceDate: Timestamp;
+  invoiceStatus: InvoiceStatus;
+  invoicePaymentStatus: PaymentStatus;
+  fullyPaidAt?: Timestamp | null;
+
+  clientId: string | null;
+  clientName: string | null;
+  clientType: ClientType;
+
+  duration: number;
+  staff: StaffResourceApiModel;
+  requiresTwoStaffs?: boolean;
+  staff2?: StaffResourceApiModel | null;
+
+  price: string;
+  originalPrice: string;
+  variantId?: string;
+  advancePriceId?: string;
+  qty: number;
+  redeemedQty?: number | null;
+  refundQty?: number;
+
+  discountType: string;
+  discount: number;
+  discountAmount: number;
+  globalDiscountAmount: number;
+  loyaltyPointsDiscountAmount: number;
+  deal: DealModel | null;
+
+  taxAmount: number;
+  taxPercentage: number;
+  taxDetails: TaxDetailModel[];
+
+  barcode?: string | null;
+  supplier?: ProductSupplierModel | null;
+  brand?: BrandModel | null;
+  image?: string | null;
+
+  giftCardValue?: number | null;
+  giftCardValidFor?: GiftCardValidityModel | null;
+  giftCardPurchaseId?: string | null;
+  giftCardColor?: GradientColor | null;
+  giftCardCode?: string | null;
+  isGift?: boolean;
+  isGiftCardPrivate?: boolean;
+  comboName?: string | null;
+
+  packageDetail?: PackageDetailApiModel | null;
+  redeemedPackageName?: string | null;
+
+  addedBy: EntityType;
+
+  staff1InvoiceItemCommissionId?: string | null; // The invoice item commission ID attached to staff 1. An invoice item can have either credit or debit commission, this stores the last commission ID for the primary staff
+  staff2InvoiceItemCommissionId?: string | null; // The invoice item commission ID attached to staff 2. An invoice item can have either credit or debit commission, this stores the last commission ID for the secondary staff
+
+  location: OutletModel;
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+  timeZone: string;
+}

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

@@ -0,0 +1,25 @@
+import {CreatedByModel} from '../created-by.model';
+import {ClientType, EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CompanyModel} from "../company.model";
+import {OutletModel} from "../outlet.model";
+import {ClientApiModel} from "./client.api.model";
+
+export interface InvoiceReviewApiModel {
+    id: string;
+    invoiceId: string;
+    invoiceNo: number;
+    staffIds: string[];
+    company: CompanyModel;
+    outlet: OutletModel;
+    client: ClientApiModel;
+    rating: number;
+    feedback: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    deletedBy: CreatedByModel | null;
+    source: EntityType;
+    reviewerType: ClientType;
+}

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

@@ -0,0 +1,24 @@
+import {InvoiceActivityType, PaymentStatus} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {PaymentMethodModel} from "../payment-method";
+
+export interface InvoiceActivityApiModel {
+    activityType: InvoiceActivityType;
+    timestamp: Timestamp;
+    description?: string;
+    performedBy: string;
+    oldPaymentMethod?: PaymentMethodModel;
+    newPaymentMethod?: PaymentMethodModel;
+    payments?: Array<{ method: string, amount: number }>;
+    totalAmount?: number;
+    paidAmount?: number;
+    remainingAmount?: number;
+    paymentStatus?: PaymentStatus;
+    oldStaffId?: string;
+    newStaffId?: string;
+    oldReceivedById?: string;
+    newReceivedById?: string;
+    voidReason?: string;
+    reminderSentAt?: Timestamp;
+    outstandingAmount?: number;
+}

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

@@ -0,0 +1,159 @@
+import {OutletApiModel} from './outlet.api.model';
+import {CompanyModel} from '../company.model';
+import {ClientApiModel} from './client.api.model';
+import {StaffDropdownModel, StaffModel} from '../view';
+import {Timestamp} from '../timestamp';
+import {ClientType, DiscountType, EntityType, InvoiceStatus, PaymentStatus, TaxCalculationMethod} from '../../enum';
+import {CreatedByModel} from '../created-by.model';
+import {PaymentModel} from '../payment.model';
+import {PaymentMethodModel} from '../payment-method';
+import {StaffResourceApiModel} from './appointment.api.model';
+import {TaxDetails} from '../tax-details.model';
+import {GiftCardValidityModel} from "../gift-card-validity.model";
+import {DealModel} from '../deal.model';
+import {TaxDetailModel} from "../tax-detail.model";
+import {RedeemedPackageApiModel} from "../redeemed-package-api.model";
+import {PackageDetailApiModel} from "../package-detail-api.model";
+import {GradientColor} from "../gradient-color";
+import {BrandModel, ProductSupplierModel} from "./product.api.model";
+import {DataCapSuccessResponse} from "../datacap-success-response.model";
+import {RefundReason} from "../refund-reason.model";
+import {ServiceChargeModel} from "../service-charge.model";
+
+export interface InvoiceApiModel {
+    id: string;
+    invoiceNo: number;
+    invoiceDate: Timestamp,
+    deletedAt: Timestamp | null;
+    company: CompanyModel;
+    companyEmail: string;
+    companyGSTIN: string;
+    updatedBy: CreatedByModel;
+    receivedBy: StaffDropdownModel;
+    client: ClientApiModel;
+    clientType: ClientType,
+    isDeleted: boolean;
+    paymentMethod: PaymentMethodModel;
+    payment: PaymentModel[];
+    onlinePaymentDetails?: PaymentModel,
+    onlinePaymentAmount?: number,
+    paymentStatus: PaymentStatus;
+    createdBy: CreatedByModel;
+    outlet: Partial<OutletApiModel>;
+    totalDiscount: number;
+    globalDiscount: number,
+    globalDiscountType: DiscountType | null,
+    subTotal: number;
+    totalPrice: number;
+    totalPriceWithBookingFee: number;
+    totalTax: number;
+    taxes: TaxDetails[];
+    taxDetails: TaxDetailModel[];
+    serviceCharges: ServiceChargeModel[];
+    taxCalculationMethod: TaxCalculationMethod;
+    tenderedAmount: number;
+    change: number;
+    createdAt: Timestamp;
+    items: BillItemApiModel[];
+    updatedAt: Timestamp;
+    unpaidReminderSentAt: Timestamp;
+    sourceOfBooking: string;
+    status: InvoiceStatus;
+    note: string;
+    currencyCode: string;
+    recipientEmail: string;
+    convenienceFee: number;
+    transactionFee: number;
+    redeemedGiftCards: GiftCardRedeemApiModel[];
+    redeemedPackage: RedeemedPackageApiModel | null;
+    timeZone: string;
+    bookBy: EntityType;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    redeemedLoyaltyPoints: number;
+    loyaltyPointDiscount: number;
+    staffIds: string[];
+    productIds: string[];
+    serviceIds: string[];
+    giftCardIds: string[];
+    packageIds: string[];
+    paymentDueAmount: number;
+    isReviewAdded?: boolean;
+    reviewId?: string;
+    datacapPaymentInfo?: DataCapSuccessResponse;
+    refundInvoiceIds?: string[];
+    relatedInvoiceId?: string;
+    refundReason: RefundReason;
+    returnItemToInventory?: boolean;
+    paymentAttemptIds?: string[];
+    applySurcharge?: boolean;
+    totalTipAmount?: number;
+    staffTipAllocations?: StaffTipAllocationModel[];
+    fullyPaidAt?: Timestamp | null;
+}
+
+export interface BillItemApiModel {
+    billItemDate: Timestamp;
+    duration: number;
+    staff: StaffResourceApiModel;
+    staff2?: StaffResourceApiModel;
+    qty: number;
+    discount: number;
+    discountAmount: number;
+    globalDiscountAmount: number;
+    price: string;
+    originalPrice: string;
+    discountPriceAvailable: boolean;
+    discountType: string;
+    id: string;
+    itemName: string;
+    type: string;
+    taxAmount: number;
+    itemTaxes: TaxDetails;
+    taxPercentage: number;
+    taxDetails: TaxDetailModel[];
+    byStaffName: string;
+    addedBy: EntityType;
+    deal: DealModel;
+    image?: string;
+    appointmentId?: string;
+    giftCardValue?: number;
+    giftCardValidFor?: GiftCardValidityModel;
+    giftCardPurchaseId?: string | null;
+    giftCardColor?: GradientColor | null;
+    giftCardCode?: string;
+    isGift?: boolean;
+    isGiftCardPrivate?: boolean;
+    comboName?: string;
+    packageDetail?: PackageDetailApiModel;
+    redeemedQty?: number;
+    redeemedPackageName?: string | null;
+    barcode?: string | null;
+    supplier?: ProductSupplierModel | null;
+    brand?: BrandModel | null;
+    refundQty?: number;
+    variantId?: string;
+    advancePriceId?: string;
+    requiresTwoStaffs?: boolean;
+    docId?: string;
+    relatedDocId?: string | null; // when item is a refunded item, original item id
+}
+
+export interface GiftCardRedeemApiModel {
+    id: string;
+    name: string;
+    code: string;
+    barCode: string;
+    color: GradientColor,
+    value: number;
+    redeemedAmount: number;
+    remainingAmount: number;
+    usedAmount: number;
+    redeemedDate: Timestamp;
+    serviceCharges: ServiceChargeModel
+}
+
+export interface StaffTipAllocationModel {
+  staff: StaffModel;
+  tipAmount: number;
+}

package/src/models/api/legal-document.api.model.ts

@@ -0,0 +1,22 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import {EntityType} from "../../enum";
+import {LegalDocumentType} from "../../consts";
+
+export interface LegalDocumentApiModel {
+    id: string;
+    active: boolean;
+    effectiveDate: Timestamp;
+    type: LegalDocumentType;
+    status: 'draft' | 'complete' | 'voided';
+    document: any;
+    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/location-slug.api.model.ts

@@ -0,0 +1,19 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType} from "../../enum";
+
+export interface LocationSlugApiModel {
+    id: string;
+    slug: string;
+    companyId: string;
+    outletId: 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/master-card-on-file-payment-provider-api-model.ts

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

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

@@ -0,0 +1,32 @@
+import { Timestamp } from "../timestamp";
+import { CreatedByModel } from "../created-by.model";
+import { MinutesOnly } from "../upcoming-reminder";
+import { EntityType } from "../../enum";
+import { NotificationTriggerType } from "../../consts";
+import { DynamicFieldModel } from "../dynamic-field.model";
+
+export interface MasterNotificationSettingsApiModel {
+  id: string;
+  title: string;
+  categoryId: string;
+  category: string;
+  categoryOrder: number;
+  description: string;
+  order: number;
+  triggerType: NotificationTriggerType;
+  beforeDays?: number | null; // send notification before no of days
+  reminders?: MinutesOnly[];
+  emailTemplateName: string; // template file name
+  emailSubject: string;
+  fields: DynamicFieldModel[];
+  defaultContent: Record<string, any>;
+  source: EntityType;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

package/src/models/api/master-payment-provider-api-model.ts

@@ -0,0 +1,26 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import {EntityType, PaymentProcessingMethod, PaymentProvider} from "../../enum";
+import {PaymentProviderField} from "../payment-provider-field.model";
+
+export interface MasterPaymentProviderApiModel {
+    id: string;
+    name: string;
+    logoUrl: string;
+    description: string;
+    fields: PaymentProviderField[];
+    provider: PaymentProvider;
+    active: boolean;
+    supportsInStorePayment: boolean;
+    paymentProcessingMethod: PaymentProcessingMethod;
+    isPrivate: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}

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

@@ -0,0 +1,23 @@
+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;
+    order: number;
+    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/message-categories.api.model.ts

@@ -0,0 +1,16 @@
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface MessageCategoriesApiModel {
+    id: string;
+    name: string;
+    description: string;
+    order: number;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: null;
+    isDeleted: false;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+}

package/src/models/api/message-log-api.model.ts

@@ -0,0 +1,34 @@
+import {OutletModel} from '../outlet.model';
+import {ClientApiModel} from './client.api.model';
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {Timestamp} from '../timestamp';
+import {CreatedByModel} from '../created-by.model';
+import {ChannelType, EntityType, MessageType, StockLocationType} from '../../enum';
+import {WarehouseModel} from "../warehouse.model";
+
+export interface MessageLogApiModel {
+    id: string;
+    channel: ChannelType;
+    to: string;
+    from: OutletModel | string;
+    message: string;
+    messageType: MessageType;
+    status: boolean;
+    response: any;
+    sender: EntityType;
+    client: ClientApiModel | null;
+    locationType: StockLocationType,
+    outlet: OutletModel | null;
+    warehouse: WarehouseModel | null;
+    company: CompanyModel;
+    createdAt: Timestamp;
+    updatedAt: TimeApiModel;
+    deletedAt: TimeApiModel | null;
+    isDeleted: boolean;
+    createdBy: CreatedByModel | null;
+    updatedBy: CreatedByModel | null;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+}
+