washday-sdk 0.0.9 → 0.0.10

package/src/interfaces/Store.ts

@@ -1,350 +1,350 @@
-import { IProduct } from "./Product"
-import { ISection } from "./Section"
-import { IStoreImage } from "./StoreImage"
-import { IUser, IStaff } from "./User"
-import { IOrder, IOrderPaymentLines } from "./Order"
-
-export interface IStore {
-    name: string,
-    streetAddress?: string,
-    zipCode?: string,
-    administrator: IUser | string,
-    owner: IUser | string,
-    createdBy: IUser | string,
-    city: string,
-    state: string,
-    country: string,
-    phone: string,
-    taxesType: string,
-    taxOne?: ITax,
-    isActive: boolean,
-    allowPrePaid: boolean,
-    taxTwo?: ITax,
-    taxThree?: ITax,
-    paymentConfig: IPaymentConfig,
-    orderPageConfig: IOrderPageConfig,
-    printingConfig: IPrintingConfig,
-    notificationConfig: INotificationConfig,
-    schedule?: ISchedule,
-    pickupDeliverySchedule?: IPickupDeliverySchedule,
-    sections?: Array<ISection | string>
-    storeImages: Array<IStoreImage | string>
-    staffs?: Array<IStaff | string>,
-    currencySymbol: string,
-    inventory?: IInventory,
-    supplies?: ISupplies,
-    cashUpReports?: ICashUpReport,
-    cashierBoxes?: ICashierBox,
-    ticketStructure?: ITicketStructure | null,
-    ticketForLaundryStructure?: ITicketForLaundryStructure | null,
-    storeDiscounts: IStoreDiscount | null,
-    discountCodes: IDiscountCode | null,
-    marketingConfig: IMarketingConfig,
-    emailReportSuscribed: boolean,
-    emailReportFrequency: string,
-    emailReportDateRange: string
-}
-
-export interface ITaxConfig {
-    name: string,
-    value: number
-}
-
-export interface IProductStockActivity {
-    type: string,
-    date: Date,
-    amount: number,
-    order?: IOrder | string,
-    addedBy?: IUser | string,
-    notes?: string
-}
-
-export interface ISupplyStockActivity {
-    type: string,
-    date: Date,
-    amount: number,
-    order?: IOrder | string,
-    product?: IProduct | string,
-    addedBy?: IUser | string,
-    notes?: string
-}
-
-export interface IInventory {
-    store: IStore | string,
-    product: IProduct | string,
-    stock: number,
-    alertOnStock: number,
-    stockActivityHistory: Array<IProductStockActivity | string>,
-    isActive: boolean
-}
-
-export interface IInventory {
-    store: IStore | string,
-    product: IProduct | string,
-    stock: number,
-    alertOnStock: number,
-    stockActivityHistory: Array<IProductStockActivity | string>,
-    isActive: boolean
-}
-
-export interface ISupplies {
-    name: String,
-    code: String,
-    purchaseUnit: String,
-    usageUnit: String,
-    usageFactor: number,
-    stock: number,
-    alertOnStock: number,
-    supplyActivityHistory: Array<ISupplyStockActivity | string>
-    isActive: boolean
-}
-
-export interface ISupplies {
-    name: String,
-    code: String,
-    purchaseUnit: String,
-    usageUnit: String,
-    usageFactor: number,
-    stock: number,
-    alertOnStock: number,
-    supplyActivityHistory: Array<ISupplyStockActivity | string>,
-    isActive: boolean
-}
-
-export interface ICashUpReportLine {
-    type: string,
-    orderPaymentLineId: string | null | IOrderPaymentLines,
-    order: string | null | IOrder,
-    movement: string | null | IInOutMovement,
-    amount: number,
-    paymentMethod: string,
-}
-
-export interface ICashUpReport {
-    createdBy: IUser | string,
-    createdDate: Date,
-    startingCashDate: Date,
-    startingCash: number,
-    cardFromOrders: number,
-    totalCashCalculated: number,
-    totalCardCalculated: number,
-    totalTransferCalculated?: number,
-    cashFromOrders: number,
-    cashPayIns: number,
-    cardPayIns: number,
-    cardPayOuts: number,
-    cashPayOuts: number,
-    transferPayIns?: number,
-    transferPayOuts?: number,
-    transferFromOrders?: number,
-    declaredCash: number,
-    declaredCard: number,
-    declaredTransfer?: number,
-    leftInDrawer: number,
-    cashToBank: number,
-    expectedCash: number,
-    variance: number,
-    notes: string,
-    cashierBox: ICashierBox | string,
-    orders: Array<IOrder> | Array<string>,
-    movements: Array<IInOutMovement> | Array<string>,
-    lines: Array<ICashUpReportLine>,
-}
-
-export interface ICashUpReport {
-    createdBy: IUser | string,
-    createdDate: Date,
-    startingCashDate: Date,
-    startingCash: number,
-    cardFromOrders: number,
-    totalCashCalculated: number,
-    totalCardCalculated: number,
-    totalTransferCalculated?: number,
-    cashFromOrders: number,
-    transferPayIns?: number,
-    transferPayOuts?: number,
-    transferFromOrders?: number,
-    cashPayIns: number,
-    cashPayOuts: number,
-    declaredCash: number,
-    declaredCard: number,
-    declaredTransfer?: number,
-    leftInDrawer: number,
-    cashToBank: number,
-    expectedCash: number,
-    variance: number,
-    notes: string,
-    cashierBox: ICashierBox | string,
-    orders: Array<IOrder> | Array<string>,
-    movements: Array<IInOutMovement> | Array<string>,
-}
-
-
-export interface IInOutMovement {
-    type: string,
-    date: Date,
-    amount: number,
-    notes: string,
-    paymentMethod: string | null,
-    isOnACashUpReport: Boolean,
-    createdBy: IUser | string,
-}
-export interface ICashierBox {
-    createdBy: IUser | string,
-    name: string,
-    inOutMovements?: IInOutMovement,
-    isActive: boolean
-}
-
-export interface ITax {
-    name: string,
-    value: number
-}
-
-export interface INotificationConfig {
-    notifyOrderCreated: boolean,
-    notifyPickedUp: boolean,
-    notifyCleaned: boolean,
-    notifyCollected: boolean,
-    notifyDelivered: boolean,
-    notifyOwnerOnOrderCreated: boolean,
-    notifyEmail: string
-}
-
-export interface IPaymentConfig {
-    defaultPaymentMethod: string
-}
-
-export interface IPrintingConfig {
-    printLogoOnTicket: Boolean,
-    printTicketForLaundry: Boolean
-}
-
-export interface IMarketingConfig {
-    googlePlaceID: string,
-    facebookUrl: string,
-    ordersForFirstReview: number,
-    ordersForSecondReview: number,
-    sendReviewByEmail: Boolean,
-    sendReviewBySMS: Boolean,
-}
-
-export interface IOrderPageConfig {
-    showProductSearchBarWeb: Boolean,
-    defaultDeliveryDate: string,
-    defaultDeliveryTime: string,
-    defaultNotifyMethod: string,
-    printTicketAfterOrder: Boolean,
-    shippingServiceCost: number,
-}
-
-export interface ITicketStructure {
-    showTotalPieces: Boolean,
-    showEmisionDate: Boolean,
-    showEmisionTime: Boolean,
-    showLegend: Boolean,
-    showPaymentMethod: Boolean,
-    showStorePhone: Boolean,
-    showDeliveryDate: Boolean,
-    showDeliveryTime: Boolean,
-    ticketLegendText: String,
-    showStoreName: Boolean,
-    showCustomerName: Boolean,
-    showCreatedByName: Boolean,
-    showOrderNotes: Boolean,
-    showTaxes: Boolean,
-    showDiscounts: Boolean,
-    showCredit: Boolean,
-}
-
-export interface ITicketForLaundryStructure {
-    showTotalPieces: Boolean,
-    showEmisionDate: Boolean,
-    showEmisionTime: Boolean,
-    showLegend: Boolean,
-    showPaymentMethod: Boolean,
-    showStorePhone: Boolean,
-    showDeliveryDate: Boolean,
-    showDeliveryTime: Boolean,
-    ticketLegendText: String,
-    printLogoOnTicket: Boolean,
-    showStoreName: Boolean,
-    showCustomerName: Boolean,
-    showCreatedByName: Boolean,
-    showOrderNotes: Boolean,
-    showTaxes: Boolean,
-    showDiscounts: Boolean,
-    showCredit: Boolean,
-}
-
-export interface ITiming {
-    openingTime: Date,
-    closingTime: Date
-}
-
-export interface IPickupDeliveryTiming {
-    fromTime: String,
-    toTime: String
-}
-export interface IPickupDeliverySchedule {
-    1: [IPickupDeliveryTiming],
-    2: [IPickupDeliveryTiming],
-    3: [IPickupDeliveryTiming],
-    4: [IPickupDeliveryTiming],
-    5: [IPickupDeliveryTiming],
-    6: [IPickupDeliveryTiming],
-    7: [IPickupDeliveryTiming],
-}
-
-export interface ISchedule {
-    sunday: ITiming,
-    monday: ITiming,
-    tuesday: ITiming,
-    wednesday: ITiming,
-    thursday: ITiming,
-    friday: ITiming,
-    saturday: ITiming
-}
-
-export interface IStoreDiscount {
-    name: String,
-    type: String,
-    value: number,
-    fromDate: Date,
-    toDate: Date,
-    fromTime: string,
-    toTime: string,
-    weekDays: Array<Number>,
-    products: Array<IProduct | string>
-    createdBy: IUser | string,
-    isActive: boolean
-}
-
-export interface IBuyAndGetCondition {
-    buyConditions: Array<any>,
-    getConditions: Array<any>,
-    getDiscountType: string,
-    discountValue: number
-}
-
-export interface IDiscountCode {
-    name: String,
-    code: String,
-    type: String,
-    value: number,
-    fromDate: Date,
-    toDate: Date,
-    fromTime: string,
-    toTime: string,
-    weekDays: Array<Number>,
-    products: Array<IProduct | string>
-    createdBy: IUser | string,
-    isActive: boolean,
-    applyOnceOnOrder: boolean,
-    applyToAllProducts: boolean,
-    hasUseLimit: boolean,
-    useLimitQty: number,
-    usedCounter: number,
-    onePerCustomer: boolean,
-    buyAndGetConditions: Array<IBuyAndGetCondition | string>,
-}
+import { IProduct } from "./Product"
+import { ISection } from "./Section"
+import { IStoreImage } from "./StoreImage"
+import { IUser, IStaff } from "./User"
+import { IOrder, IOrderPaymentLines } from "./Order"
+
+export interface IStore {
+    name: string,
+    streetAddress?: string,
+    zipCode?: string,
+    administrator: IUser | string,
+    owner: IUser | string,
+    createdBy: IUser | string,
+    city: string,
+    state: string,
+    country: string,
+    phone: string,
+    taxesType: string,
+    taxOne?: ITax,
+    isActive: boolean,
+    allowPrePaid: boolean,
+    taxTwo?: ITax,
+    taxThree?: ITax,
+    paymentConfig: IPaymentConfig,
+    orderPageConfig: IOrderPageConfig,
+    printingConfig: IPrintingConfig,
+    notificationConfig: INotificationConfig,
+    schedule?: ISchedule,
+    pickupDeliverySchedule?: IPickupDeliverySchedule,
+    sections?: Array<ISection | string>
+    storeImages: Array<IStoreImage | string>
+    staffs?: Array<IStaff | string>,
+    currencySymbol: string,
+    inventory?: IInventory,
+    supplies?: ISupplies,
+    cashUpReports?: ICashUpReport,
+    cashierBoxes?: ICashierBox,
+    ticketStructure?: ITicketStructure | null,
+    ticketForLaundryStructure?: ITicketForLaundryStructure | null,
+    storeDiscounts: IStoreDiscount | null,
+    discountCodes: IDiscountCode | null,
+    marketingConfig: IMarketingConfig,
+    emailReportSuscribed: boolean,
+    emailReportFrequency: string,
+    emailReportDateRange: string
+}
+
+export interface ITaxConfig {
+    name: string,
+    value: number
+}
+
+export interface IProductStockActivity {
+    type: string,
+    date: Date,
+    amount: number,
+    order?: IOrder | string,
+    addedBy?: IUser | string,
+    notes?: string
+}
+
+export interface ISupplyStockActivity {
+    type: string,
+    date: Date,
+    amount: number,
+    order?: IOrder | string,
+    product?: IProduct | string,
+    addedBy?: IUser | string,
+    notes?: string
+}
+
+export interface IInventory {
+    store: IStore | string,
+    product: IProduct | string,
+    stock: number,
+    alertOnStock: number,
+    stockActivityHistory: Array<IProductStockActivity | string>,
+    isActive: boolean
+}
+
+export interface IInventory {
+    store: IStore | string,
+    product: IProduct | string,
+    stock: number,
+    alertOnStock: number,
+    stockActivityHistory: Array<IProductStockActivity | string>,
+    isActive: boolean
+}
+
+export interface ISupplies {
+    name: String,
+    code: String,
+    purchaseUnit: String,
+    usageUnit: String,
+    usageFactor: number,
+    stock: number,
+    alertOnStock: number,
+    supplyActivityHistory: Array<ISupplyStockActivity | string>
+    isActive: boolean
+}
+
+export interface ISupplies {
+    name: String,
+    code: String,
+    purchaseUnit: String,
+    usageUnit: String,
+    usageFactor: number,
+    stock: number,
+    alertOnStock: number,
+    supplyActivityHistory: Array<ISupplyStockActivity | string>,
+    isActive: boolean
+}
+
+export interface ICashUpReportLine {
+    type: string,
+    orderPaymentLineId: string | null | IOrderPaymentLines,
+    order: string | null | IOrder,
+    movement: string | null | IInOutMovement,
+    amount: number,
+    paymentMethod: string,
+}
+
+export interface ICashUpReport {
+    createdBy: IUser | string,
+    createdDate: Date,
+    startingCashDate: Date,
+    startingCash: number,
+    cardFromOrders: number,
+    totalCashCalculated: number,
+    totalCardCalculated: number,
+    totalTransferCalculated?: number,
+    cashFromOrders: number,
+    cashPayIns: number,
+    cardPayIns: number,
+    cardPayOuts: number,
+    cashPayOuts: number,
+    transferPayIns?: number,
+    transferPayOuts?: number,
+    transferFromOrders?: number,
+    declaredCash: number,
+    declaredCard: number,
+    declaredTransfer?: number,
+    leftInDrawer: number,
+    cashToBank: number,
+    expectedCash: number,
+    variance: number,
+    notes: string,
+    cashierBox: ICashierBox | string,
+    orders: Array<IOrder> | Array<string>,
+    movements: Array<IInOutMovement> | Array<string>,
+    lines: Array<ICashUpReportLine>,
+}
+
+export interface ICashUpReport {
+    createdBy: IUser | string,
+    createdDate: Date,
+    startingCashDate: Date,
+    startingCash: number,
+    cardFromOrders: number,
+    totalCashCalculated: number,
+    totalCardCalculated: number,
+    totalTransferCalculated?: number,
+    cashFromOrders: number,
+    transferPayIns?: number,
+    transferPayOuts?: number,
+    transferFromOrders?: number,
+    cashPayIns: number,
+    cashPayOuts: number,
+    declaredCash: number,
+    declaredCard: number,
+    declaredTransfer?: number,
+    leftInDrawer: number,
+    cashToBank: number,
+    expectedCash: number,
+    variance: number,
+    notes: string,
+    cashierBox: ICashierBox | string,
+    orders: Array<IOrder> | Array<string>,
+    movements: Array<IInOutMovement> | Array<string>,
+}
+
+
+export interface IInOutMovement {
+    type: string,
+    date: Date,
+    amount: number,
+    notes: string,
+    paymentMethod: string | null,
+    isOnACashUpReport: Boolean,
+    createdBy: IUser | string,
+}
+export interface ICashierBox {
+    createdBy: IUser | string,
+    name: string,
+    inOutMovements?: IInOutMovement,
+    isActive: boolean
+}
+
+export interface ITax {
+    name: string,
+    value: number
+}
+
+export interface INotificationConfig {
+    notifyOrderCreated: boolean,
+    notifyPickedUp: boolean,
+    notifyCleaned: boolean,
+    notifyCollected: boolean,
+    notifyDelivered: boolean,
+    notifyOwnerOnOrderCreated: boolean,
+    notifyEmail: string
+}
+
+export interface IPaymentConfig {
+    defaultPaymentMethod: string
+}
+
+export interface IPrintingConfig {
+    printLogoOnTicket: Boolean,
+    printTicketForLaundry: Boolean
+}
+
+export interface IMarketingConfig {
+    googlePlaceID: string,
+    facebookUrl: string,
+    ordersForFirstReview: number,
+    ordersForSecondReview: number,
+    sendReviewByEmail: Boolean,
+    sendReviewBySMS: Boolean,
+}
+
+export interface IOrderPageConfig {
+    showProductSearchBarWeb: Boolean,
+    defaultDeliveryDate: string,
+    defaultDeliveryTime: string,
+    defaultNotifyMethod: string,
+    printTicketAfterOrder: Boolean,
+    shippingServiceCost: number,
+}
+
+export interface ITicketStructure {
+    showTotalPieces: Boolean,
+    showEmisionDate: Boolean,
+    showEmisionTime: Boolean,
+    showLegend: Boolean,
+    showPaymentMethod: Boolean,
+    showStorePhone: Boolean,
+    showDeliveryDate: Boolean,
+    showDeliveryTime: Boolean,
+    ticketLegendText: String,
+    showStoreName: Boolean,
+    showCustomerName: Boolean,
+    showCreatedByName: Boolean,
+    showOrderNotes: Boolean,
+    showTaxes: Boolean,
+    showDiscounts: Boolean,
+    showCredit: Boolean,
+}
+
+export interface ITicketForLaundryStructure {
+    showTotalPieces: Boolean,
+    showEmisionDate: Boolean,
+    showEmisionTime: Boolean,
+    showLegend: Boolean,
+    showPaymentMethod: Boolean,
+    showStorePhone: Boolean,
+    showDeliveryDate: Boolean,
+    showDeliveryTime: Boolean,
+    ticketLegendText: String,
+    printLogoOnTicket: Boolean,
+    showStoreName: Boolean,
+    showCustomerName: Boolean,
+    showCreatedByName: Boolean,
+    showOrderNotes: Boolean,
+    showTaxes: Boolean,
+    showDiscounts: Boolean,
+    showCredit: Boolean,
+}
+
+export interface ITiming {
+    openingTime: Date,
+    closingTime: Date
+}
+
+export interface IPickupDeliveryTiming {
+    fromTime: String,
+    toTime: String
+}
+export interface IPickupDeliverySchedule {
+    1: [IPickupDeliveryTiming],
+    2: [IPickupDeliveryTiming],
+    3: [IPickupDeliveryTiming],
+    4: [IPickupDeliveryTiming],
+    5: [IPickupDeliveryTiming],
+    6: [IPickupDeliveryTiming],
+    7: [IPickupDeliveryTiming],
+}
+
+export interface ISchedule {
+    sunday: ITiming,
+    monday: ITiming,
+    tuesday: ITiming,
+    wednesday: ITiming,
+    thursday: ITiming,
+    friday: ITiming,
+    saturday: ITiming
+}
+
+export interface IStoreDiscount {
+    name: String,
+    type: String,
+    value: number,
+    fromDate: Date,
+    toDate: Date,
+    fromTime: string,
+    toTime: string,
+    weekDays: Array<Number>,
+    products: Array<IProduct | string>
+    createdBy: IUser | string,
+    isActive: boolean
+}
+
+export interface IBuyAndGetCondition {
+    buyConditions: Array<any>,
+    getConditions: Array<any>,
+    getDiscountType: string,
+    discountValue: number
+}
+
+export interface IDiscountCode {
+    name: String,
+    code: String,
+    type: String,
+    value: number,
+    fromDate: Date,
+    toDate: Date,
+    fromTime: string,
+    toTime: string,
+    weekDays: Array<Number>,
+    products: Array<IProduct | string>
+    createdBy: IUser | string,
+    isActive: boolean,
+    applyOnceOnOrder: boolean,
+    applyToAllProducts: boolean,
+    hasUseLimit: boolean,
+    useLimitQty: number,
+    usedCounter: number,
+    onePerCustomer: boolean,
+    buyAndGetConditions: Array<IBuyAndGetCondition | string>,
+}