types-salon-management 1.0.1

package/src/models/duration.model.ts

@@ -0,0 +1,16 @@
+export interface DurationSegment {
+    type: DurationSegmentType;
+    duration: DurationModel;
+    order: number;
+}
+
+export type DurationSegmentType =
+    | "SERVICING_TIME"
+    | "EXTRA_SERVICING_TIME"
+    | "PROCESSING_TIME"
+    | "BLOCK_TIME";
+
+export interface DurationModel {
+    label: string;
+    value: number;
+}

package/src/models/dynamic-field.model.ts

@@ -0,0 +1,43 @@
+export interface DynamicFieldModel {
+  name: string;
+  type: FieldType;
+  label: string;
+  order: number;
+  placeholder?: string;
+  description?: string;
+  defaultValue?: any;
+  disabled?: boolean;
+  hidden?: boolean;
+  readonly?: boolean;
+  validations?: ValidationRules;
+  options?: Option[] | string[] | { [key: string]: any };
+  optionLabel?: string;
+  optionValue?: string; 
+}
+
+export type FieldType = 
+  | 'text' 
+  | 'number' 
+  | 'textarea' 
+  | 'checkbox' 
+  | 'select' 
+  | 'radio' 
+  | 'date' 
+  | 'email' 
+  | 'password';
+
+export interface ValidationRules {
+  required?: boolean;
+  minLength?: number;
+  maxLength?: number;
+  min?: number | Date;
+  max?: number | Date;
+  pattern?: string | RegExp;
+  email?: boolean;
+}
+
+export interface Option {
+  label: string;
+  value: any;
+  disabled?: boolean;
+}

package/src/models/employment.model.ts

@@ -0,0 +1,6 @@
+import {Timestamp} from "./timestamp";
+
+export  interface Employment {
+  startDate: Timestamp;
+  endDate: Timestamp;
+}

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

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

package/src/models/expense.model.ts

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

package/src/models/expiry.model.ts

@@ -0,0 +1,5 @@
+import {GiftCardValidityModel} from "./gift-card-validity.model";
+
+export interface ExpiryModel extends GiftCardValidityModel {
+
+}

package/src/models/feature.model.ts

@@ -0,0 +1,10 @@
+export interface FeatureModel {
+    id: string;
+    name: string;
+    description: string;
+    link: string;
+    icon: string;
+    checked: boolean;
+    indeterminate: boolean;
+    subFeatures: FeatureModel[];
+}

package/src/models/gift-card-image.model.ts

@@ -0,0 +1,4 @@
+export interface GiftCardImageModel {
+    id: string;
+    image: string;
+}

package/src/models/gift-card-redeemed-record.model.ts

@@ -0,0 +1,14 @@
+import {Timestamp} from "./timestamp";
+import {StaffDropdownModel} from "./view";
+import {RedeemType} from "../enum";
+
+export interface GiftCardRedeemedRecordModel {
+    redeemedAmount: number;
+    remainingAmount: number;
+    refundAmount: number;
+    invoiceId: string;
+    invoiceNo: number;
+    redeemedDate: Timestamp;
+    staff: StaffDropdownModel;
+    type: RedeemType;
+}

package/src/models/gift-card-validity.model.ts

@@ -0,0 +1,5 @@
+export interface GiftCardValidityModel {
+    value: number;
+    label: string;
+    unit: string;
+}

package/src/models/gradient-color.ts

@@ -0,0 +1,5 @@
+export interface GradientColor {
+    id: number,
+    from: string;
+    to: string;
+}

package/src/models/gst-number.model.ts

@@ -0,0 +1,6 @@
+export interface GstNumberModel {
+    id: string;
+    gstNumber: string;
+    businessLegalName: string;
+    businessTradeName: string;
+}

package/src/models/image.model.ts

@@ -0,0 +1,7 @@
+export interface ImageModel {
+  original: string;
+  xs: string;
+  sm: string;
+  md: string;
+  lg: string;
+}

package/src/models/import-definitions.model.ts

@@ -0,0 +1,11 @@
+export interface ImportDefinitionsModel  {
+  [key: string]: { 
+    required: boolean; 
+    type: 'string' | 'number' | 'date' | 'phoneNumber'; 
+    examples: any[];
+    fieldDescription: string;
+    headers?: string[]; 
+    allowedValues?: string[];
+    valueMap?: Record<string, any>;
+  };
+}

package/src/models/index.ts

@@ -0,0 +1,88 @@
+export * from './user.model';
+export * from './company.model';
+export * from './outlet.model';
+export * from  './till.model';
+export * from './api/user-role.api.model';
+export * from './country.model';
+export * from './outlet-settings';
+export * from './appointment-reminder.model';
+export {PriceModel, OutletPricingModel, StaffPricingModel} from './price.model';
+export * from './master-data.model';
+export * from './employment.model';
+export * from './created-by.model';
+export * from './service.stage.model';
+export * from './image.model';
+export * from './tax-setting.model';
+export * from './payment.model';
+export * from './gift-card-validity.model';
+export * from './payment-method';
+export * from './phone-number-model';
+export * from './razorpay.model';
+export * from './api';
+export * from './view';
+export * from './timestamp';
+export {PhotoModel} from './photo.model';
+export {TaxDetails} from  './tax-details.model';
+export {DealModel} from  './deal.model';
+export {ProductModel} from  './product.model';
+export {GradientColor} from './gradient-color';
+export {FeatureModel} from './feature.model';
+export {CurrencyModel} from './currency.model';
+export {SubscriptionPlan} from './subscription-plan.model';
+export {BusinessCategoryModel} from './business-category.model';
+export {ProviderData} from './provider-data.model';
+export {SocialMediaLinksModel} from './social-media-links.model';
+export {SubscriptionInvoiceModel} from './subscription-invoice.model';
+export {UserRoleModel} from './user-role.model';
+export {DownloadData} from './download-data.model';
+export {CashCounterModel} from './cash-counter.model';
+export {ExpenseTypeModel} from './expense-type.model';
+export {ExpenseModel} from './expense.model';
+export {TaxWithPercentageModel} from './tax-with-percentage.model';
+export {TaxDetailModel} from './tax-detail.model';
+export {PayPeriodModel} from './pay-period.model';
+export {ExpiryModel} from './expiry.model';
+export {PackageItemModel} from './package-item.model';
+export {RedeemedItemModel} from './redeemed-item.model';
+export {RedeemedRecordModel} from './redeemed-record.model';
+export {RedeemedPackageApiModel} from './redeemed-package-api.model';
+export {PackageDetailModel, PackageDetailPostModel} from './package-detail.model';
+export {PackageDetailApiModel} from './package-detail-api.model';
+export {CommissionSettingsModel} from './commission-settings.model';
+export {StockLevelModel} from './stock-level.model';
+export {GiftCardRedeemedRecordModel} from './gift-card-redeemed-record.model';
+export {BreakModel} from './break.model';
+export {TimeFrameModel} from './time-frame.model';
+export {UpcomingReminder, MinutesOnly} from './upcoming-reminder';
+export {WarehouseModel} from './warehouse.model';
+export {WarehouseStockLevelModel} from './warehouse-stock-level.model';
+export {PaymentProviderField} from './payment-provider-field.model';
+export {DataCapSuccessResponse} from './datacap-success-response.model';
+export {RefundReason} from './refund-reason.model';
+export {CommunicationProviderFieldModel} from './communication-provider-field.model';
+export {CardOnFilePaymentProviderFieldModel} from './card-on-file-payment-provider-field.model';
+export {UserRolePermission} from './user-role-permission';
+export {DateRange} from './date-range';
+export {DateFilterModel} from './date-filter.model';
+export {Color} from './color.model';
+export {ServiceChargeModel} from './service-charge.model';
+export {SurchargeConfigModel} from './surcharge-config.model';
+export {GstNumberModel} from './gst-number.model';
+export {GiftCardImageModel} from './gift-card-image.model';
+export {BreakApiModel} from './break.api.model';
+export {ShiftModel} from './shift.model';
+export {TerminalRefundRequestModel} from './terminal-refund-request.model';
+export {CardRefundRequestModel} from './card-refund-request.model';
+export {TerminalSaleRequestModel} from './terminal-sale-request.model';
+export {CardSaleRequestModel} from './card-sale-request.model';
+export {DealSettingsModel} from './deal-settings.model';
+export {StockAdjustmentsApiModel} from './api/stock-adjustments.api.model';
+export {DynamicFieldModel, FieldType, ValidationRules, Option} from './dynamic-field.model';
+export {ImportDefinitionsModel} from './import-definitions.model';
+export {DurationModel, DurationSegment, DurationSegmentType} from './duration.model';
+export {BillingEntityModel} from './billing-entity.model';
+export {PayRunModel} from './pay-run.model';
+export {TierModel} from './tier.model';
+export {CommissionCalculationRulesModel} from './commission-calculation-rules.model';
+export {CountryConfigApiModel} from './api/country-config.api.model';
+export {CountrySubscriptionPlanApiModel} from './api/country-subscription-plan.api.model';

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

@@ -0,0 +1,4 @@
+export interface MasterData {
+  title: string;
+  value: number | string;
+}

package/src/models/outlet-settings.ts

@@ -0,0 +1,11 @@
+export interface OutletSettingsModel {
+  enableSms: boolean;
+  greetingMessage: string;
+  smsSenderId: string;
+  replyToEmail: string;
+  salonReturnURL: string;
+  showPaymentDialog: boolean;
+  siteBookOnline: boolean;
+  siteGiftCertificate: boolean;
+  siteProductSale: boolean;
+}

package/src/models/outlet.model.ts

@@ -0,0 +1,13 @@
+import {PhoneNumberModel} from './phone-number-model';
+import {AddressApiModel} from './api';
+
+export interface OutletModel {
+  id: string;
+  name: string;
+  address?: AddressApiModel;
+  email?: string;
+  phoneNumber1?: PhoneNumberModel;
+  serviceTax?: string | number;
+  productTax?: string | number;
+  thumbnail?: string;
+}

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

@@ -0,0 +1,13 @@
+import {ExpiryModel} from "./expiry.model";
+import {PackageItemModel} from "./package-item.model";
+import {ClientApiModel} from "./api";
+import {Timestamp} from "./timestamp";
+
+export interface PackageDetailApiModel {
+    expiresAfter: ExpiryModel;
+    purchaseId: string;
+    items: PackageItemModel[];
+    validFrom: Timestamp;
+    validUntil: Timestamp | null;
+    client: ClientApiModel;
+}

package/src/models/package-detail.model.ts

@@ -0,0 +1,22 @@
+import {ExpiryModel} from "./expiry.model";
+import {PackageItemModel} from "./package-item.model";
+import {ClientApiModel} from "./api";
+
+export interface PackageDetailModel<T> {
+    expiresAfter: ExpiryModel;
+    purchaseId: string;
+    items: PackageItemModel[];
+    validFrom: T;
+    validUntil: T | null;
+    client: ClientApiModel;
+}
+
+
+export interface PackageDetailPostModel {
+    expiresAfter: ExpiryModel;
+    purchaseId: string;
+    items: PackageItemModel[];
+    validFrom: Date;
+    validUntil: Date | null;
+    client: ClientApiModel;
+}

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

@@ -0,0 +1,12 @@
+import {PriceModel} from "./price.model";
+import {MasterData} from "./master-data.model";
+
+export interface PackageItemModel {
+    id: string;
+    name: string;
+    price: PriceModel;
+    duration: MasterData;
+    qty: number;
+    redeemedQty: number;
+    color: string;
+}

package/src/models/pay-period.model.ts

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

package/src/models/pay-run.model.ts

@@ -0,0 +1,10 @@
+import { PayrollFrequency } from "../enum";
+import { Timestamp } from "./timestamp";
+
+export interface PayRunModel {
+  id: string;
+  start: Timestamp;
+  end: Timestamp;
+  frequency: PayrollFrequency;
+  periodStartDay: number | null;
+}

package/src/models/payment-method.ts

@@ -0,0 +1,12 @@
+import {PaymentProcessingMethod} from "../enum";
+import {SurchargeConfigModel} from "./surcharge-config.model";
+
+export interface PaymentMethodModel {
+    id: string;
+    name: string;
+    paymentProcessingMethod?: PaymentProcessingMethod;
+    paymentProvider?: string | null;
+    paymentMode?: string;
+    metadata?: any;
+    surchargeConfig?: SurchargeConfigModel | null;
+}

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

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

package/src/models/payment.model.ts

@@ -0,0 +1,21 @@
+import {PaymentMethodModel} from './payment-method';
+import {Timestamp} from "./timestamp";
+
+export interface PaymentModel {
+    amount: number | string;
+    paymentMethod: PaymentMethodModel;
+    originalPaymentMethod?: PaymentMethodModel;
+    date: Timestamp;
+    terminalId?: string;
+    id?: string;
+    redeemedQty?: number;
+    cardToken?: string;
+    cardName?: string;
+    saleResponse?: Record<string, any>;
+    refundSaleResponse?: Record<string, any>;
+    voidSaleResponse?: Record<string, any>;
+    surchargeAmount?: number | null;
+    refundSuccess?: boolean;
+    paymentLogId: string;
+    applySurcharge?: boolean;
+}

package/src/models/phone-number-model.ts

@@ -0,0 +1,21 @@
+export interface PhoneNumberModel {
+    number: NumberModel;
+    regionCode: string;
+    countryCode: number,
+    valid: boolean;
+    possible: boolean;
+    canBeInternationallyDialled: boolean;
+    type: string;
+    typeIsFixedLine: boolean;
+    typeIsMobile: boolean;
+    possibility: string;
+}
+
+export interface NumberModel {
+    input: string;
+    international: string;
+    national: string;
+    e164: string;
+    rfc3966: string;
+    significant: string;
+}

package/src/models/photo.model.ts

@@ -0,0 +1,4 @@
+export interface PhotoModel {
+    imageUrl: string;
+    isFeatured: boolean;
+}

package/src/models/place-search.model.ts

@@ -0,0 +1,12 @@
+export interface PlaceSearchModel {
+    location: any;
+    name: string;
+    plus_code: string;
+    landmark: string;
+    street_number: string;
+    route: string;
+    locality: string;
+    administrative_area_level_1: string;
+    country: string;
+    postal_code: string;
+}

package/src/models/price.model.ts

@@ -0,0 +1,29 @@
+import {ServicePricingType} from "../enum";
+
+export interface PriceModel {
+    retailPrice: string;
+    discountPrice: string;
+    pricingType?: ServicePricingType;
+    advancePricing?: Record<string, OutletPricingModel>;
+}
+
+export interface OutletPricingModel {
+    active: boolean;
+    outletId: string;
+    outletName: string;
+    retailPrice: string;
+    pricingType: ServicePricingType;
+    pricingMode: 'default' | 'custom';
+    staffPricing: Record<string, StaffPricingModel>;
+}
+
+export interface StaffPricingModel {
+    active: boolean;
+    staffId: string;
+    staffName: string;
+    outletId: string;
+    retailPrice: string;
+    pricingType: ServicePricingType;
+    pricingMode: 'default' | 'custom';
+}
+

package/src/models/product.model.ts

@@ -0,0 +1,18 @@
+import {BrandModel, ProductCategoryModel} from "./api";
+import {PhotoModel} from "./photo.model";
+import {StockLevelModel} from "./stock-level.model";
+import {WarehouseStockLevelModel} from "./warehouse-stock-level.model";
+
+export interface ProductModel {
+    id: string;
+    name: string;
+    price: string;
+    originalPrice: string;
+    discountPriceAvailable: boolean;
+    category: ProductCategoryModel;
+    brandName: BrandModel;
+    barcode: string;
+    photos: Array<PhotoModel>;
+    stockLevels: Record<string, StockLevelModel>;
+    warehouseStockLevels: Record<string, WarehouseStockLevelModel>;
+}

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

@@ -0,0 +1,10 @@
+import {FirebaseProviderType} from "../enum";
+
+export interface ProviderData {
+    displayName:string;
+    email: string;
+    phoneNumber: null;
+    photoURL: string;
+    providerId: FirebaseProviderType;
+    uid:string;
+}

package/src/models/razorpay.model.ts

@@ -0,0 +1,23 @@
+export interface RazorpaySuccessResponse {
+    razorpay_order_id: string;
+    razorpay_payment_id: string
+    razorpay_signature: string
+}
+
+export interface Metadata {
+    payment_id: string;
+    order_id: string;
+}
+
+export interface RazorpayPaymentError {
+    code: string;
+    description: string;
+    source: string;
+    step: string;
+    reason: string;
+    metadata: Metadata;
+}
+
+export interface RazorpayErrorResponse {
+    error: RazorpayPaymentError;
+}

package/src/models/redeemed-item.model.ts

@@ -0,0 +1,8 @@
+import {PackageItemModel} from "./package-item.model";
+
+export interface RedeemedItemModel extends PackageItemModel {
+    remainingQty: number,
+    usedQty: number,
+    billItemQty: number,
+    isRedeemable: boolean,
+}

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

@@ -0,0 +1,17 @@
+import {RedeemedItemModel} from "./redeemed-item.model";
+import {Timestamp} from "./timestamp";
+
+export interface RedeemedPackageApiModel {
+    id: string;
+    code: string;
+    barCode: string;
+    price: string;
+    name: string;
+    validUntil: Timestamp;
+    validFrom: Timestamp;
+    redeemedItems: RedeemedItemModel[];
+    billItemTotalQty: number;
+    packageItemTotalQty: number;
+    totalUsedQty: number;
+    packageItemRemainingQty: number;
+}

package/src/models/redeemed-record.model.ts

@@ -0,0 +1,9 @@
+import {Timestamp} from "./timestamp";
+
+export interface RedeemedRecordModel {
+    id: string;
+    name: string;
+    redeemedQty: number;
+    invoiceId: string;
+    redeemedDate: Timestamp;
+}

package/src/models/refund-reason.model.ts

@@ -0,0 +1,4 @@
+export interface RefundReason {
+    id: string;
+    reason: string;
+}

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

@@ -0,0 +1,14 @@
+export interface ServiceChargeModel {
+    id: string;
+    name: string;
+    applyToFullValue: boolean;
+    applyToServices: boolean;
+    applyToProducts: boolean;
+    applyToGiftCards: boolean;
+    applyToPackages: boolean;
+    percentageRate: number;
+    flatRate: number;
+    appliedToNetPrice: boolean;
+    tax: string | null;
+    amount: number;
+}

package/src/models/service.stage.model.ts

@@ -0,0 +1,6 @@
+export interface ServiceStageModel {
+  name: string;
+  duration: string;
+  price: string;
+  gap: string;
+}

package/src/models/shift.model.ts

@@ -0,0 +1,7 @@
+export interface ShiftModel {
+    inTime: number;
+    outTime: number;
+    enable: boolean;
+    hours: number;
+    unit: string;
+}

package/src/models/social-media-links.model.ts

@@ -0,0 +1,5 @@
+export interface SocialMediaLinksModel {
+    instagram: string;
+    facebook: string;
+    youtube: string;
+}

package/src/models/stock-level.model.ts

@@ -0,0 +1,8 @@
+import {OutletModel} from "./outlet.model";
+
+export interface StockLevelModel {
+    outlet: OutletModel,
+    currentStockCount: number,
+    minimumOrderLevel: number,
+    warningStockLevel: number
+}

package/src/models/subscription-invoice.model.ts

@@ -0,0 +1,20 @@
+import {PaymentGateway} from "../enum";
+
+export interface SubscriptionInvoiceModel {
+    id: string;
+    subscriptionId: string;
+    paymentId: string;
+    orderId: string;
+    date: Date;
+    status: string,
+    amount: number
+    partialPayment: boolean,
+    amountPaid: number;
+    amountDue: number
+    issuedAt: Date;
+    paidAt: Date;
+    currency: string,
+    currencySymbol: string,
+    paymentGateway: PaymentGateway
+    paymentGatewayData: any;
+}

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

@@ -0,0 +1,16 @@
+import {BillingChargeTiming, BillingCycle, PaymentGateway, PlanPricingType, PlanType, PlanUnitType} from "../enum";
+
+export interface SubscriptionPlan {
+    id: string;
+    name: string;
+    countryCode: string;
+    currencyCode: string;
+    billingCycle: BillingCycle;
+    pricingType: PlanPricingType;
+    billingChargeTiming: BillingChargeTiming;
+    paymentGateway: PaymentGateway | null;
+    basePrice: number;
+    unitType: PlanUnitType;
+    unitPrice: number;
+    planType: PlanType;
+}