@managesome/eposmatic-toolkit 0.3.8 → 0.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (436) hide show
  1. package/esm/constants/ANALYTICS.js +146 -0
  2. package/esm/constants/API_ERRORS.js +6 -0
  3. package/esm/constants/COMMON.js +369 -0
  4. package/esm/constants/DELIVERY.js +45 -0
  5. package/esm/constants/DIALER_ENUMS.js +11 -0
  6. package/esm/constants/ENUMS.js +1988 -0
  7. package/esm/constants/FBR_ENUMS.js +18 -0
  8. package/esm/constants/HUBRISE_ENUMS.js +179 -0
  9. package/esm/constants/INTERNAL_ENUMS.js +49 -0
  10. package/esm/constants/NOTIFICATIONS.js +6 -0
  11. package/esm/constants/ORDER.js +251 -0
  12. package/esm/constants/PRA_ENUMS.js +18 -0
  13. package/esm/constants/REPORT_WEBVIEW.js +28 -0
  14. package/esm/constants/RFQ_GO.js +83 -0
  15. package/esm/constants/SMARTPAY_ENUMS.js +55 -0
  16. package/esm/constants/SOCKET.js +149 -0
  17. package/esm/constants/SRB_ENUMS.js +13 -0
  18. package/esm/constants/SWITCHPAY.js +28 -0
  19. package/esm/constants/TENANT_ENUMS.js +90 -0
  20. package/esm/constants/TENANT_PURCHASE_ORDER.js +91 -0
  21. package/esm/constants/WALLET.js +51 -0
  22. package/esm/constants/WAREHOUSE_ANALYTICS.js +28 -0
  23. package/esm/constants/WAREHOUSE_ENUMS.js +420 -0
  24. package/esm/constants/WAREHOUSE_PURCHASE_ORDER.js +97 -0
  25. package/esm/constants/WEBVIEW.js +43 -0
  26. package/esm/constants/WORKER_ENDPOINTS.js +79 -0
  27. package/esm/constants/index.js +27 -0
  28. package/esm/constants/types.js +2 -0
  29. package/esm/helpers/fbr/generate-invoice.js +94 -0
  30. package/esm/helpers/fbr/index.js +1 -0
  31. package/esm/helpers/hubrise/hubrise-catalog.js +304 -0
  32. package/esm/helpers/hubrise/index.js +1 -0
  33. package/esm/helpers/index.js +9 -0
  34. package/esm/helpers/kpra/generate-invoice.js +26 -0
  35. package/esm/helpers/kpra/index.js +1 -0
  36. package/esm/helpers/order/generate-order.js +508 -0
  37. package/esm/helpers/order/generate-warehouse-internal-movement.js +71 -0
  38. package/esm/helpers/order/generate-warehouse-purchase-order-rfq.js +176 -0
  39. package/esm/helpers/order/generate-warehouse-purchase-order.js +187 -0
  40. package/esm/helpers/order/generate-warehouse-sale-order-rfq.js +176 -0
  41. package/esm/helpers/order/generate-warehouse-sale-order.js +149 -0
  42. package/esm/helpers/order/index.js +6 -0
  43. package/esm/helpers/pra/generate-invoice.js +94 -0
  44. package/esm/helpers/pra/index.js +1 -0
  45. package/esm/helpers/srb/generate-invoice.js +68 -0
  46. package/esm/helpers/srb/index.js +1 -0
  47. package/esm/helpers/store/all-orders-actions.js +17 -0
  48. package/esm/helpers/store/all-tenant-purchase-orders-actions.js +45 -0
  49. package/esm/helpers/store/all-warehouse-purchase-order-rfqs-actions.js +66 -0
  50. package/esm/helpers/store/all-warehouse-purchase-order-vendor-return-actions.js +50 -0
  51. package/esm/helpers/store/all-warehouse-purchase-orders-actions.js +49 -0
  52. package/esm/helpers/store/all-warehouse-sale-order-invoices-actions.js +132 -0
  53. package/esm/helpers/store/all-warehouse-sale-order-rfqs-actions.js +66 -0
  54. package/esm/helpers/store/all-warehouse-sale-orders-actions.js +72 -0
  55. package/esm/helpers/store/cart-actions.js +3563 -0
  56. package/esm/helpers/store/catalog-actions.js +379 -0
  57. package/esm/helpers/store/common-order-actions.js +937 -0
  58. package/esm/helpers/store/common-tenant-purchase-order-actions.js +440 -0
  59. package/esm/helpers/store/common-warehouse-internal-movement-actions.js +95 -0
  60. package/esm/helpers/store/common-warehouse-purchase-order-actions.js +530 -0
  61. package/esm/helpers/store/common-warehouse-purchase-order-receipt-actions.js +33 -0
  62. package/esm/helpers/store/common-warehouse-purchase-order-rfq-actions.js +523 -0
  63. package/esm/helpers/store/common-warehouse-purchase-order-vendor-return-actions.js +25 -0
  64. package/esm/helpers/store/common-warehouse-sale-order-actions.js +483 -0
  65. package/esm/helpers/store/common-warehouse-sale-order-invoice-actions.js +54 -0
  66. package/esm/helpers/store/common-warehouse-sale-order-rfq-actions.js +523 -0
  67. package/esm/helpers/store/index.js +26 -0
  68. package/esm/helpers/store/offline-ordering.js +251 -0
  69. package/esm/helpers/store/tenant-purchase-orders-cart-actions.js +379 -0
  70. package/esm/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +360 -0
  71. package/esm/helpers/store/warehouse-purchase-orders-cart-actions.js +470 -0
  72. package/esm/helpers/store/warehouse-sale-order-rfq-cart-actions.js +359 -0
  73. package/esm/helpers/store/warehouse-sale-orders-cart-actions.js +456 -0
  74. package/esm/helpers/types/api-types.js +1 -0
  75. package/esm/helpers/types/cart-actions.js +1 -0
  76. package/esm/helpers/types/cart-helpers.js +1 -0
  77. package/esm/helpers/types/catalog.js +1 -0
  78. package/esm/helpers/types/common.js +1 -0
  79. package/esm/helpers/types/deliverect_menu.js +1 -0
  80. package/esm/helpers/types/email-templates.js +1 -0
  81. package/esm/helpers/types/fbr-generate-invoice.js +1 -0
  82. package/esm/helpers/types/halfhalf.js +1 -0
  83. package/esm/helpers/types/hubrise_catalog.js +1 -0
  84. package/esm/helpers/types/hubrise_customers.js +1 -0
  85. package/esm/helpers/types/hubrise_deliveries.js +1 -0
  86. package/esm/helpers/types/hubrise_location.js +1 -0
  87. package/esm/helpers/types/hubrise_orders.js +1 -0
  88. package/esm/helpers/types/index.js +33 -0
  89. package/esm/helpers/types/internal-leads.js +1 -0
  90. package/esm/helpers/types/inventory-catalog.js +1 -0
  91. package/esm/helpers/types/kpra-generate-invoice.js +1 -0
  92. package/esm/helpers/types/marketing.js +1 -0
  93. package/esm/helpers/types/order-engine.js +1 -0
  94. package/esm/helpers/types/pra-generate-invoice.js +1 -0
  95. package/esm/helpers/types/report-webview.js +1 -0
  96. package/esm/helpers/types/reports.js +1 -0
  97. package/esm/helpers/types/smartpay-apis.js +2 -0
  98. package/esm/helpers/types/specials.js +1 -0
  99. package/esm/helpers/types/split_bill.js +1 -0
  100. package/esm/helpers/types/srb-generate-invoice.js +1 -0
  101. package/esm/helpers/types/switchpay.js +1 -0
  102. package/esm/helpers/types/tenant-purchase-order-cart-actions.js +1 -0
  103. package/esm/helpers/types/warehouse-catalog.js +1 -0
  104. package/esm/helpers/types/warehouse-purchase-order-cart-actions.js +1 -0
  105. package/esm/helpers/types/warehouse-purchase-order-rfq-cart-actions.js +1 -0
  106. package/esm/helpers/types/warehouse-sale-order-cart-actions.js +1 -0
  107. package/esm/helpers/types/warehouse-sale-order-rfq-cart-actions.js +1 -0
  108. package/esm/helpers/types/workers.js +1 -0
  109. package/esm/helpers/utils/asaanbill-identifier-helpers.js +31 -0
  110. package/esm/helpers/utils/business-day-helpers.js +201 -0
  111. package/esm/helpers/utils/cart-helpers.js +156 -0
  112. package/esm/helpers/utils/catalog-conversion.js +129 -0
  113. package/esm/helpers/utils/code-redemption-helpers.js +452 -0
  114. package/esm/helpers/utils/color-helpers.js +31 -0
  115. package/esm/helpers/utils/common.js +368 -0
  116. package/esm/helpers/utils/crypt.js +40 -0
  117. package/esm/helpers/utils/customers-helpers.js +15 -0
  118. package/esm/helpers/utils/delivery-area-helpers.js +42 -0
  119. package/esm/helpers/utils/delivery-helpers.js +87 -0
  120. package/esm/helpers/utils/denominations-helpers.js +53 -0
  121. package/esm/helpers/utils/dinein.js +39 -0
  122. package/esm/helpers/utils/discount-helpers.js +55 -0
  123. package/esm/helpers/utils/email-helpers.js +111 -0
  124. package/esm/helpers/utils/error-helpers.js +14 -0
  125. package/esm/helpers/utils/expense.js +26 -0
  126. package/esm/helpers/utils/getFormFieldsDiff.js +15 -0
  127. package/esm/helpers/utils/gift-card-helpers.js +258 -0
  128. package/esm/helpers/utils/halfhalf-setup-helpers.js +779 -0
  129. package/esm/helpers/utils/hourly-comparison-report-helpers.js +851 -0
  130. package/esm/helpers/utils/hr-helpers.js +62 -0
  131. package/esm/helpers/utils/hubrise-utils.js +32 -0
  132. package/esm/helpers/utils/image-helpers.js +95 -0
  133. package/esm/helpers/utils/image-url-helpers.js +96 -0
  134. package/esm/helpers/utils/index.js +96 -0
  135. package/esm/helpers/utils/ingredients.js +26 -0
  136. package/esm/helpers/utils/internal-amount-helpers.js +49 -0
  137. package/esm/helpers/utils/inventory.js +123 -0
  138. package/esm/helpers/utils/inventory_entries.js +91 -0
  139. package/esm/helpers/utils/inventory_transactions.js +91 -0
  140. package/esm/helpers/utils/item-report-helpers.js +2603 -0
  141. package/esm/helpers/utils/items-comparison-report-helpers.js +1057 -0
  142. package/esm/helpers/utils/kds-helpers.js +43 -0
  143. package/esm/helpers/utils/location-helpers.js +13 -0
  144. package/esm/helpers/utils/menu-helpers.js +44 -0
  145. package/esm/helpers/utils/minified-catalog.js +428 -0
  146. package/esm/helpers/utils/offer-apply-helpers.js +613 -0
  147. package/esm/helpers/utils/offers-helpers.js +3351 -0
  148. package/esm/helpers/utils/operational-roles-helpers.js +33 -0
  149. package/esm/helpers/utils/order-engine.js +1409 -0
  150. package/esm/helpers/utils/order-history.js +208 -0
  151. package/esm/helpers/utils/payment-comparison-report-helpers.js +873 -0
  152. package/esm/helpers/utils/payment-helpers.js +302 -0
  153. package/esm/helpers/utils/pdf-generator.js +110 -0
  154. package/esm/helpers/utils/platform-catalog.js +306 -0
  155. package/esm/helpers/utils/platform-num.js +188 -0
  156. package/esm/helpers/utils/platform-specific-tenant-shifts.js +19 -0
  157. package/esm/helpers/utils/price-conversion.js +24 -0
  158. package/esm/helpers/utils/printer-helpers.js +319 -0
  159. package/esm/helpers/utils/public-holidays-helpers.js +8 -0
  160. package/esm/helpers/utils/ratings-comparison-report-helpers.js +1187 -0
  161. package/esm/helpers/utils/receipt-engine.js +1050 -0
  162. package/esm/helpers/utils/review-helpers.js +391 -0
  163. package/esm/helpers/utils/rider-tracking.js +12 -0
  164. package/esm/helpers/utils/riders-report-helpers.js +1590 -0
  165. package/esm/helpers/utils/sales-comparison-report-helpers.js +1259 -0
  166. package/esm/helpers/utils/sales-comparitive-report-helpers.js +939 -0
  167. package/esm/helpers/utils/sales-overview-report-helpers.js +1046 -0
  168. package/esm/helpers/utils/sales-summary-report-helpers.js +877 -0
  169. package/esm/helpers/utils/scan-code-helpers.js +31 -0
  170. package/esm/helpers/utils/selection-model.js +68 -0
  171. package/esm/helpers/utils/shift-window-helpers.js +148 -0
  172. package/esm/helpers/utils/simplified-catalog.js +107 -0
  173. package/esm/helpers/utils/simplified-halfhalf.js +101 -0
  174. package/esm/helpers/utils/simplified-specials.js +107 -0
  175. package/esm/helpers/utils/simplified-tenant.js +411 -0
  176. package/esm/helpers/utils/specials-helpers.js +727 -0
  177. package/esm/helpers/utils/tenant-calendar-helpers.js +67 -0
  178. package/esm/helpers/utils/tenant-cash-drawer-sessions-helpers.js +248 -0
  179. package/esm/helpers/utils/tenant-cash-drawers-helpers.js +31 -0
  180. package/esm/helpers/utils/tenant-cash-in-out-helpers.js +47 -0
  181. package/esm/helpers/utils/tenant-day-sessions-helpers.js +167 -0
  182. package/esm/helpers/utils/tenant-instore-shift-sessions-helpers.js +227 -0
  183. package/esm/helpers/utils/tenant-staff-helpers.js +19 -0
  184. package/esm/helpers/utils/tenant_cash_in_hand_transactions.js +31 -0
  185. package/esm/helpers/utils/time-helpers.js +142 -0
  186. package/esm/helpers/utils/void-items-report-helpers.js +529 -0
  187. package/esm/helpers/utils/void-order-items-helpers.js +32 -0
  188. package/esm/helpers/utils/voidations-summary-report-helpers.js +800 -0
  189. package/esm/helpers/utils/wallet-helpers.js +22 -0
  190. package/esm/helpers/utils/wallet-redemption-helpers.js +46 -0
  191. package/esm/helpers/utils/warehouse-catalog-conversion.js +117 -0
  192. package/esm/helpers/utils/warehouse-inventory.js +59 -0
  193. package/esm/helpers/utils/warehouse-purchase-order-engine.js +27 -0
  194. package/esm/helpers/utils/warehouse-purchase-order-receipt-engine.js +205 -0
  195. package/esm/helpers/utils/warehouse-purchase-order-x-report-helpers.js +1432 -0
  196. package/esm/helpers/utils/warehouse-sale-order-engine.js +27 -0
  197. package/esm/helpers/utils/warehouse-sale-order-receipt-engine.js +207 -0
  198. package/esm/helpers/utils/warehouse-sale-order-x-report-helpers.js +1 -0
  199. package/esm/helpers/utils/warehouse-sale-x-report-helpers.js +1434 -0
  200. package/esm/helpers/utils/warehouse-settings-helpers.js +37 -0
  201. package/esm/helpers/utils/warehouse-void-purchase-order-items-helpers.js +34 -0
  202. package/esm/helpers/utils/warehouse-void-purchase-order-items-report-helpers.js +18 -0
  203. package/esm/helpers/utils/warehouse-void-sale-order-items-helpers.js +34 -0
  204. package/esm/helpers/utils/warehouse-void-sale-order-items-report-helpers.js +18 -0
  205. package/esm/helpers/utils/warehouse_inventory_transactions.js +91 -0
  206. package/esm/helpers/utils/x-report-helpers.js +1850 -0
  207. package/esm/index.js +3 -0
  208. package/esm/schemas/index.js +2 -0
  209. package/esm/schemas/models/app_configs.js +36 -0
  210. package/esm/schemas/models/applied_order_discounts.js +103 -0
  211. package/esm/schemas/models/brands.js +56 -0
  212. package/esm/schemas/models/categories.js +74 -0
  213. package/esm/schemas/models/close_dates.js +63 -0
  214. package/esm/schemas/models/common-models.js +449 -0
  215. package/esm/schemas/models/courses.js +62 -0
  216. package/esm/schemas/models/customer_redemptions.js +82 -0
  217. package/esm/schemas/models/customers.js +269 -0
  218. package/esm/schemas/models/deliveries.js +137 -0
  219. package/esm/schemas/models/delivery_areas.js +97 -0
  220. package/esm/schemas/models/dinein_floors.js +55 -0
  221. package/esm/schemas/models/dinein_tables.js +97 -0
  222. package/esm/schemas/models/dinein_tables_fingerprints.js +96 -0
  223. package/esm/schemas/models/discounts.js +87 -0
  224. package/esm/schemas/models/expense_categories.js +61 -0
  225. package/esm/schemas/models/expense_details.js +130 -0
  226. package/esm/schemas/models/gift_cards.js +342 -0
  227. package/esm/schemas/models/halfhalf_setup.js +142 -0
  228. package/esm/schemas/models/index.js +111 -0
  229. package/esm/schemas/models/internal_customers.js +139 -0
  230. package/esm/schemas/models/internal_invoices.js +119 -0
  231. package/esm/schemas/models/internal_leads.js +78 -0
  232. package/esm/schemas/models/internal_operational_roles.js +85 -0
  233. package/esm/schemas/models/internal_staffs.js +65 -0
  234. package/esm/schemas/models/inventories.js +103 -0
  235. package/esm/schemas/models/inventory_categories.js +52 -0
  236. package/esm/schemas/models/inventory_transactions.js +143 -0
  237. package/esm/schemas/models/item_transactions.js +117 -0
  238. package/esm/schemas/models/items.js +341 -0
  239. package/esm/schemas/models/marketing_fingerprints.js +92 -0
  240. package/esm/schemas/models/menus.js +66 -0
  241. package/esm/schemas/models/messaging_devices.js +99 -0
  242. package/esm/schemas/models/modifier_extras.js +120 -0
  243. package/esm/schemas/models/offers.js +470 -0
  244. package/esm/schemas/models/offers_fingerprints.js +61 -0
  245. package/esm/schemas/models/operational_roles.js +155 -0
  246. package/esm/schemas/models/orders.js +1051 -0
  247. package/esm/schemas/models/printer_settings.js +245 -0
  248. package/esm/schemas/models/public_holidays.js +58 -0
  249. package/esm/schemas/models/reservations.js +127 -0
  250. package/esm/schemas/models/reviews.js +145 -0
  251. package/esm/schemas/models/rewards_usage.js +61 -0
  252. package/esm/schemas/models/riders.js +75 -0
  253. package/esm/schemas/models/specials.js +169 -0
  254. package/esm/schemas/models/staff_shifts.js +66 -0
  255. package/esm/schemas/models/tenant-activity-logs.js +126 -0
  256. package/esm/schemas/models/tenant_active_jobs.js +77 -0
  257. package/esm/schemas/models/tenant_calendar.js +89 -0
  258. package/esm/schemas/models/tenant_cash_drawer_sessions.js +208 -0
  259. package/esm/schemas/models/tenant_cash_drawers.js +60 -0
  260. package/esm/schemas/models/tenant_cash_in_hand_transactions.js +69 -0
  261. package/esm/schemas/models/tenant_cash_in_out.js +104 -0
  262. package/esm/schemas/models/tenant_clients.js +66 -0
  263. package/esm/schemas/models/tenant_day_sessions.js +166 -0
  264. package/esm/schemas/models/tenant_hr_attendance_records.js +87 -0
  265. package/esm/schemas/models/tenant_hr_biometric_enrollments.js +69 -0
  266. package/esm/schemas/models/tenant_hr_departments.js +42 -0
  267. package/esm/schemas/models/tenant_hr_documents.js +71 -0
  268. package/esm/schemas/models/tenant_hr_employees.js +172 -0
  269. package/esm/schemas/models/tenant_hr_leave_requests.js +80 -0
  270. package/esm/schemas/models/tenant_hr_payrolls.js +131 -0
  271. package/esm/schemas/models/tenant_hr_performance_reviews.js +58 -0
  272. package/esm/schemas/models/tenant_hr_policies.js +57 -0
  273. package/esm/schemas/models/tenant_hr_positions.js +48 -0
  274. package/esm/schemas/models/tenant_hr_shift_schedules.js +84 -0
  275. package/esm/schemas/models/tenant_hr_shifts.js +64 -0
  276. package/esm/schemas/models/tenant_instore_shift_sessions.js +204 -0
  277. package/esm/schemas/models/tenant_instore_shifts.js +63 -0
  278. package/esm/schemas/models/tenant_inventory_department_transactions.js +116 -0
  279. package/esm/schemas/models/tenant_inventory_department_utilities.js +85 -0
  280. package/esm/schemas/models/tenant_inventory_departments.js +55 -0
  281. package/esm/schemas/models/tenant_inventory_entries.js +131 -0
  282. package/esm/schemas/models/tenant_metadata.js +88 -0
  283. package/esm/schemas/models/tenant_order_item_instructions.js +66 -0
  284. package/esm/schemas/models/tenant_purchase_order_vendor_returns.js +80 -0
  285. package/esm/schemas/models/tenant_purchase_orders.js +158 -0
  286. package/esm/schemas/models/tenant_shifts.js +57 -0
  287. package/esm/schemas/models/tenant_staffs.js +129 -0
  288. package/esm/schemas/models/tenant_vendors.js +99 -0
  289. package/esm/schemas/models/tenants.js +811 -0
  290. package/esm/schemas/models/terminal_devices.js +63 -0
  291. package/esm/schemas/models/tokens.js +73 -0
  292. package/esm/schemas/models/track_order_numbers.js +42 -0
  293. package/esm/schemas/models/void_order_items.js +210 -0
  294. package/esm/schemas/models/vouchers.js +101 -0
  295. package/esm/schemas/models/wallet_transactions.js +128 -0
  296. package/esm/schemas/models/wallets.js +44 -0
  297. package/esm/schemas/models/warehouse-activity-logs.js +144 -0
  298. package/esm/schemas/models/warehouse_categories.js +83 -0
  299. package/esm/schemas/models/warehouse_clients.js +81 -0
  300. package/esm/schemas/models/warehouse_communications.js +226 -0
  301. package/esm/schemas/models/warehouse_internal_movements.js +463 -0
  302. package/esm/schemas/models/warehouse_inventory_entries.js +125 -0
  303. package/esm/schemas/models/warehouse_inventory_lot_serial_numbers.js +188 -0
  304. package/esm/schemas/models/warehouse_inventory_transactions.js +133 -0
  305. package/esm/schemas/models/warehouse_item_transactions.js +97 -0
  306. package/esm/schemas/models/warehouse_items.js +173 -0
  307. package/esm/schemas/models/warehouse_operational_roles.js +87 -0
  308. package/esm/schemas/models/warehouse_purchase_order_receipts.js +163 -0
  309. package/esm/schemas/models/warehouse_purchase_order_rfqs.js +339 -0
  310. package/esm/schemas/models/warehouse_purchase_order_vendor_returns.js +199 -0
  311. package/esm/schemas/models/warehouse_purchase_orders.js +334 -0
  312. package/esm/schemas/models/warehouse_sale_deliveries.js +155 -0
  313. package/esm/schemas/models/warehouse_sale_invoices.js +229 -0
  314. package/esm/schemas/models/warehouse_sale_order_rfqs.js +340 -0
  315. package/esm/schemas/models/warehouse_sale_orders.js +322 -0
  316. package/esm/schemas/models/warehouse_staffs.js +104 -0
  317. package/esm/schemas/models/warehouse_track_order_numbers.js +73 -0
  318. package/esm/schemas/models/warehouse_vendors.js +99 -0
  319. package/esm/schemas/models/warehouse_void_purchase_order_items.js +174 -0
  320. package/esm/schemas/models/warehouse_void_sale_order_items.js +174 -0
  321. package/esm/schemas/models/warehouses.js +253 -0
  322. package/esm/schemas/types/app_configs.js +1 -0
  323. package/esm/schemas/types/applied_order_discounts.js +1 -0
  324. package/esm/schemas/types/brands.js +1 -0
  325. package/esm/schemas/types/categories.js +1 -0
  326. package/esm/schemas/types/close_dates.js +1 -0
  327. package/esm/schemas/types/common.js +1 -0
  328. package/esm/schemas/types/courses.js +1 -0
  329. package/esm/schemas/types/customer_redemptions.js +1 -0
  330. package/esm/schemas/types/customers.js +1 -0
  331. package/esm/schemas/types/deliveries.js +1 -0
  332. package/esm/schemas/types/delivery_areas.js +1 -0
  333. package/esm/schemas/types/dinein_floors.js +1 -0
  334. package/esm/schemas/types/dinein_tables.js +1 -0
  335. package/esm/schemas/types/dinein_tables_fingerprints.js +1 -0
  336. package/esm/schemas/types/discounts.js +1 -0
  337. package/esm/schemas/types/expense_categories.js +1 -0
  338. package/esm/schemas/types/expense_details.js +1 -0
  339. package/esm/schemas/types/gift_cards.js +1 -0
  340. package/esm/schemas/types/halfhalf_setup.js +1 -0
  341. package/esm/schemas/types/index.js +113 -0
  342. package/esm/schemas/types/internal_customers.js +1 -0
  343. package/esm/schemas/types/internal_invoices.js +1 -0
  344. package/esm/schemas/types/internal_leads.js +1 -0
  345. package/esm/schemas/types/internal_operational_roles.js +16 -0
  346. package/esm/schemas/types/internal_staffs.js +1 -0
  347. package/esm/schemas/types/inventories.js +1 -0
  348. package/esm/schemas/types/inventory_categories.js +1 -0
  349. package/esm/schemas/types/inventory_department_transactions.js +1 -0
  350. package/esm/schemas/types/inventory_department_utilities.js +1 -0
  351. package/esm/schemas/types/inventory_departments.js +1 -0
  352. package/esm/schemas/types/inventory_transactions.js +1 -0
  353. package/esm/schemas/types/item_transactions.js +1 -0
  354. package/esm/schemas/types/items.js +1 -0
  355. package/esm/schemas/types/marketing_fingerprints.js +1 -0
  356. package/esm/schemas/types/menus.js +1 -0
  357. package/esm/schemas/types/messaging_devices.js +1 -0
  358. package/esm/schemas/types/modifier_extras.js +1 -0
  359. package/esm/schemas/types/multi_tenants.js +1 -0
  360. package/esm/schemas/types/offers.js +1 -0
  361. package/esm/schemas/types/offers_fingerprints.js +1 -0
  362. package/esm/schemas/types/operational_roles.js +15 -0
  363. package/esm/schemas/types/orders.js +1 -0
  364. package/esm/schemas/types/printer_settings.js +1 -0
  365. package/esm/schemas/types/public_holidays.js +1 -0
  366. package/esm/schemas/types/reservations.js +1 -0
  367. package/esm/schemas/types/reviews.js +1 -0
  368. package/esm/schemas/types/rewards_usage.js +1 -0
  369. package/esm/schemas/types/riders.js +1 -0
  370. package/esm/schemas/types/specials.js +1 -0
  371. package/esm/schemas/types/staff_shifts.js +1 -0
  372. package/esm/schemas/types/tenant-activity-logs.js +1 -0
  373. package/esm/schemas/types/tenant_active_jobs.js +1 -0
  374. package/esm/schemas/types/tenant_calendar.js +1 -0
  375. package/esm/schemas/types/tenant_cash_drawer_sessions.js +1 -0
  376. package/esm/schemas/types/tenant_cash_drawers.js +1 -0
  377. package/esm/schemas/types/tenant_cash_in_hand_transactions.js +1 -0
  378. package/esm/schemas/types/tenant_cash_in_out.js +1 -0
  379. package/esm/schemas/types/tenant_clients.js +1 -0
  380. package/esm/schemas/types/tenant_day_sessions.js +1 -0
  381. package/esm/schemas/types/tenant_hr_attendance_records.js +1 -0
  382. package/esm/schemas/types/tenant_hr_biometric_enrollments.js +1 -0
  383. package/esm/schemas/types/tenant_hr_departments.js +1 -0
  384. package/esm/schemas/types/tenant_hr_documents.js +1 -0
  385. package/esm/schemas/types/tenant_hr_employees.js +1 -0
  386. package/esm/schemas/types/tenant_hr_leave_requests.js +1 -0
  387. package/esm/schemas/types/tenant_hr_payrolls.js +1 -0
  388. package/esm/schemas/types/tenant_hr_performance_reviews.js +1 -0
  389. package/esm/schemas/types/tenant_hr_policies.js +1 -0
  390. package/esm/schemas/types/tenant_hr_positions.js +1 -0
  391. package/esm/schemas/types/tenant_hr_shift_schedules.js +1 -0
  392. package/esm/schemas/types/tenant_hr_shifts.js +1 -0
  393. package/esm/schemas/types/tenant_instore_shift_sessions.js +1 -0
  394. package/esm/schemas/types/tenant_instore_shifts.js +1 -0
  395. package/esm/schemas/types/tenant_inventory_entries.js +1 -0
  396. package/esm/schemas/types/tenant_metadata.js +1 -0
  397. package/esm/schemas/types/tenant_order_item_instructions.js +1 -0
  398. package/esm/schemas/types/tenant_purchase_order_vendor_returns.js +1 -0
  399. package/esm/schemas/types/tenant_purchase_orders.js +1 -0
  400. package/esm/schemas/types/tenant_shifts.js +1 -0
  401. package/esm/schemas/types/tenant_staffs.js +1 -0
  402. package/esm/schemas/types/tenant_vendors.js +1 -0
  403. package/esm/schemas/types/tenants.js +1 -0
  404. package/esm/schemas/types/terminal_devices.js +1 -0
  405. package/esm/schemas/types/tokens.js +1 -0
  406. package/esm/schemas/types/track_order_numbers.js +1 -0
  407. package/esm/schemas/types/void_order_items.js +1 -0
  408. package/esm/schemas/types/vouchers.js +1 -0
  409. package/esm/schemas/types/wallet_transactions.js +1 -0
  410. package/esm/schemas/types/wallets.js +1 -0
  411. package/esm/schemas/types/warehouse-activity-logs.js +1 -0
  412. package/esm/schemas/types/warehouse_categories.js +1 -0
  413. package/esm/schemas/types/warehouse_clients.js +1 -0
  414. package/esm/schemas/types/warehouse_communications.js +1 -0
  415. package/esm/schemas/types/warehouse_internal_movements.js +1 -0
  416. package/esm/schemas/types/warehouse_inventory_entries.js +1 -0
  417. package/esm/schemas/types/warehouse_inventory_lot_serial_numbers.js +1 -0
  418. package/esm/schemas/types/warehouse_inventory_transactions.js +1 -0
  419. package/esm/schemas/types/warehouse_item_transactions.js +1 -0
  420. package/esm/schemas/types/warehouse_items.js +1 -0
  421. package/esm/schemas/types/warehouse_operational_roles.js +15 -0
  422. package/esm/schemas/types/warehouse_purchase_order_receipts.js +18 -0
  423. package/esm/schemas/types/warehouse_purchase_order_rfqs.js +1 -0
  424. package/esm/schemas/types/warehouse_purchase_order_vendor_returns.js +1 -0
  425. package/esm/schemas/types/warehouse_purchase_orders.js +1 -0
  426. package/esm/schemas/types/warehouse_sale_deliveries.js +1 -0
  427. package/esm/schemas/types/warehouse_sale_invoices.js +1 -0
  428. package/esm/schemas/types/warehouse_sale_order_rfqs.js +1 -0
  429. package/esm/schemas/types/warehouse_sale_orders.js +1 -0
  430. package/esm/schemas/types/warehouse_staffs.js +1 -0
  431. package/esm/schemas/types/warehouse_track_order_numbers.js +1 -0
  432. package/esm/schemas/types/warehouse_vendors.js +1 -0
  433. package/esm/schemas/types/warehouse_void_purchase_order_items.js +1 -0
  434. package/esm/schemas/types/warehouse_void_sale_order_items.js +1 -0
  435. package/esm/schemas/types/warehouses.js +1 -0
  436. package/package.json +6 -3
@@ -0,0 +1,811 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_ALERT_NOTIFICATIONS_TYPES, ALL_CARD_PROCESSING_PROVIDERS, ALL_COUNTRY_ALPHA_2_TYPES, ALL_COUNTRY_ALPHA_3_TYPES, ALL_COUNTRY_CODES, ALL_COUNTRY_FLAG_TYPES, ALL_COUNTRY_NAME_TYPES, ALL_CURRENCY_CODES, ALL_CURRENCY_NAMES, ALL_CURRENCY_SYMBOLS, ALL_DELIVERY_AREAS_SEARCH_TYPES, ALL_EMAIL_PROCESSING_PROVIDERS, ALL_GST_TYPES, ALL_INTEGRATIONS, ALL_ONLINE_ORDERING_DESIGN_TYPES, ALL_ORDER_COMPLETION_TYPES, ALL_ORDER_NUMBER_GROUPING_TYPES, ALL_ORDER_STATUS_NAMES, ALL_ORDER_TYPE_NAMES, ALL_RATING_TYPES, ALL_RECEIPT_QR_CODE_TYPES, ALL_RIDER_FEE_TYPES, ALL_SMS_PROCESSING_PROVIDERS, ALL_TAX_INVOICE_PROVIDERS, ALL_TRACK_ORDER_NUMBER_TYPES, ALL_WEB_AUTH_TYPES, ALL_WEB_UNPAID_PAYMENT_TYPES, COUNTRY_ALPHA_2_ENUM, COUNTRY_ALPHA_3_ENUM, COUNTRY_CODE_ENUM, COUNTRY_FLAG_ENUM, COUNTRY_NAME_ENUM, CURRENCY_CODE_ENUM, CURRENCY_NAME_ENUM, CURRENCY_SYMBOL_ENUM, GST_TYPE_ENUM, ONLINE_ORDERING_DESIGN_TYPE_ENUM, ORDER_COMPLETION_TYPE_ENUM, ORDER_NUMBER_GROUPING_TYPE_ENUM, ORDER_STATUS_ENUM, PLATFORMS_ENUM, RIDER_FEE_TYPE_ENUM, TRACK_ORDER_NUMBER_ENUM, WEB_UNPAID_PAYMENT_TYPE_ENUM, } from '../../constants';
3
+ import { PlatformsSchema } from './items';
4
+ const OrderStatusSchema = { type: String, enum: ALL_ORDER_STATUS_NAMES };
5
+ const RatingTypeSchema = { type: String, enum: ALL_RATING_TYPES };
6
+ const WebStopTakingOrdersSchema = new Schema({
7
+ order_types: { type: [String], enum: ALL_ORDER_TYPE_NAMES, required: true, default: [] },
8
+ date: { type: Schema.Types.Date, required: true },
9
+ }, {
10
+ _id: false,
11
+ minimize: false,
12
+ });
13
+ export const TenantSchema = new Schema({
14
+ _id: {
15
+ type: String,
16
+ required: true,
17
+ immutable: true,
18
+ },
19
+ brand_id: {
20
+ type: String,
21
+ required: true,
22
+ immutable: true,
23
+ ref: 'brands',
24
+ },
25
+ provider_id: {
26
+ type: String,
27
+ required: true,
28
+ immutable: true,
29
+ ref: 'providers',
30
+ },
31
+ name: {
32
+ type: String,
33
+ required: true,
34
+ },
35
+ image_url: {
36
+ type: String,
37
+ required: true,
38
+ },
39
+ active: {
40
+ type: Boolean,
41
+ default: true,
42
+ },
43
+ currency_code: {
44
+ type: String,
45
+ enum: ALL_CURRENCY_CODES,
46
+ default: CURRENCY_CODE_ENUM.PKR,
47
+ },
48
+ currency_symbol: {
49
+ type: String,
50
+ enum: ALL_CURRENCY_SYMBOLS,
51
+ default: CURRENCY_SYMBOL_ENUM.Rs,
52
+ },
53
+ currency_name: {
54
+ type: String,
55
+ enum: ALL_CURRENCY_NAMES,
56
+ default: CURRENCY_NAME_ENUM.PAKISTANI_RUPEE,
57
+ },
58
+ country_code: {
59
+ type: String,
60
+ enum: ALL_COUNTRY_CODES,
61
+ default: COUNTRY_CODE_ENUM['+92'],
62
+ },
63
+ country_alpha_2: {
64
+ type: String,
65
+ enum: ALL_COUNTRY_ALPHA_2_TYPES,
66
+ default: COUNTRY_ALPHA_2_ENUM.PK,
67
+ },
68
+ country_alpha_3: {
69
+ type: String,
70
+ enum: ALL_COUNTRY_ALPHA_3_TYPES,
71
+ default: COUNTRY_ALPHA_3_ENUM.PAK,
72
+ },
73
+ country_name: {
74
+ type: String,
75
+ enum: ALL_COUNTRY_NAME_TYPES,
76
+ default: COUNTRY_NAME_ENUM.PAKISTAN,
77
+ },
78
+ country_flag: {
79
+ type: String,
80
+ enum: ALL_COUNTRY_FLAG_TYPES,
81
+ default: COUNTRY_FLAG_ENUM['🇵🇰'],
82
+ },
83
+ coordinates: {
84
+ type: [Number, Number],
85
+ default: [0, 0],
86
+ },
87
+ city: {
88
+ type: String,
89
+ default: '',
90
+ },
91
+ google_review_link: {
92
+ type: String,
93
+ default: null,
94
+ },
95
+ takeaway_time: {
96
+ type: Number,
97
+ // half an hour in milliseconds
98
+ default: 1800000,
99
+ },
100
+ delivery_time: {
101
+ type: Number,
102
+ default: 1800000,
103
+ },
104
+ enable_inventory: {
105
+ type: Boolean,
106
+ default: false,
107
+ },
108
+ pay_first_for_dine_in: {
109
+ type: Boolean,
110
+ default: false,
111
+ },
112
+ closed_store_message: {
113
+ type: String,
114
+ default: null,
115
+ },
116
+ break_time_message: {
117
+ type: String,
118
+ default: null,
119
+ },
120
+ announcement_message: {
121
+ type: String,
122
+ default: null,
123
+ },
124
+ review_emails: {
125
+ type: [String],
126
+ default: [],
127
+ },
128
+ review_phone_numbers: {
129
+ type: [String],
130
+ default: [],
131
+ },
132
+ enabled_review_platforms: {
133
+ type: [PlatformsSchema],
134
+ default: [],
135
+ },
136
+ payment_report_emails: {
137
+ type: [String],
138
+ default: [],
139
+ },
140
+ pos_enable_internal_auth: {
141
+ type: Boolean,
142
+ default: false,
143
+ },
144
+ pos_enable_takeaway: {
145
+ type: Boolean,
146
+ default: true,
147
+ },
148
+ pos_enable_delivery: {
149
+ type: Boolean,
150
+ default: true,
151
+ },
152
+ pos_enable_dine_in: {
153
+ type: Boolean,
154
+ default: true,
155
+ },
156
+ pos_enable_drive_thru: {
157
+ type: Boolean,
158
+ default: false,
159
+ },
160
+ pos_enable_kiosk: {
161
+ type: Boolean,
162
+ default: false,
163
+ },
164
+ pos_pre_ordering_days: {
165
+ type: Number,
166
+ required: false,
167
+ },
168
+ pos_opt_in_for_holiday_surcharge: {
169
+ type: Boolean,
170
+ default: false,
171
+ },
172
+ pos_holiday_surcharge: {
173
+ type: Number,
174
+ default: 0,
175
+ },
176
+ pos_enable_card_payments: {
177
+ type: Boolean,
178
+ default: true,
179
+ },
180
+ pos_enable_classic_specials_preview: {
181
+ type: Boolean,
182
+ required: false,
183
+ },
184
+ pos_min_takeaway_order_value: {
185
+ type: Number,
186
+ default: 0,
187
+ },
188
+ pos_end_seating_when_order_paid_off: {
189
+ type: Boolean,
190
+ default: true,
191
+ },
192
+ pos_accedental_touch_protection_enabled: {
193
+ type: Boolean,
194
+ required: false,
195
+ },
196
+ web_charge_customer_for_online_processing: {
197
+ type: Boolean,
198
+ default: true,
199
+ },
200
+ web_allow_ordering_till_closing_time: {
201
+ type: Boolean,
202
+ default: false,
203
+ },
204
+ web_enable_takeaway: {
205
+ type: Boolean,
206
+ default: true,
207
+ },
208
+ web_enable_delivery: {
209
+ type: Boolean,
210
+ default: true,
211
+ },
212
+ web_enable_dine_in: {
213
+ type: Boolean,
214
+ default: true,
215
+ },
216
+ web_pre_ordering_days: {
217
+ type: Number,
218
+ required: false,
219
+ },
220
+ max_preorder_delivery_minutes: {
221
+ type: Number,
222
+ required: false,
223
+ },
224
+ max_preorder_takeaway_minutes: {
225
+ type: Number,
226
+ required: false,
227
+ },
228
+ default_prep_minutes: {
229
+ type: Number,
230
+ required: true,
231
+ default: 15,
232
+ },
233
+ web_opt_in_for_holiday_surcharge: {
234
+ type: Boolean,
235
+ default: false,
236
+ },
237
+ web_holiday_surcharge: {
238
+ type: Number,
239
+ default: 0,
240
+ },
241
+ web_enable_cash_payments_takeaway: {
242
+ type: Boolean,
243
+ default: true,
244
+ },
245
+ web_enable_cash_payments_delivery: {
246
+ type: Boolean,
247
+ default: true,
248
+ },
249
+ web_enable_cash_payments_dine_in: {
250
+ type: Boolean,
251
+ default: true,
252
+ },
253
+ web_min_takeaway_order_value: {
254
+ type: Number,
255
+ default: 0,
256
+ },
257
+ web_max_cash_order_value: {
258
+ type: Number,
259
+ default: 0,
260
+ },
261
+ web_stop_taking_orders: {
262
+ type: WebStopTakingOrdersSchema,
263
+ default: null,
264
+ },
265
+ web_unpaid_payment_types: {
266
+ type: [String],
267
+ enum: ALL_WEB_UNPAID_PAYMENT_TYPES,
268
+ required: true,
269
+ default: [
270
+ WEB_UNPAID_PAYMENT_TYPE_ENUM.CASH_ON_DELIVERY,
271
+ WEB_UNPAID_PAYMENT_TYPE_ENUM.CARD_ON_DELIVERY,
272
+ WEB_UNPAID_PAYMENT_TYPE_ENUM.CASH_ON_TAKEAWAY,
273
+ WEB_UNPAID_PAYMENT_TYPE_ENUM.CARD_ON_TAKEAWAY,
274
+ ],
275
+ },
276
+ web_enable_pre_ordering: {
277
+ type: Boolean,
278
+ required: false,
279
+ },
280
+ web_pre_ordering_visibility_minutes: {
281
+ type: Number,
282
+ required: false,
283
+ },
284
+ opt_in_for_radius_based_delivery: {
285
+ type: Boolean,
286
+ default: false,
287
+ },
288
+ min_delivery_order_value: {
289
+ type: Number,
290
+ default: 0,
291
+ },
292
+ delivery_radius: {
293
+ type: Number,
294
+ default: 0,
295
+ },
296
+ delivery_min_cost: {
297
+ type: Number,
298
+ default: 0,
299
+ },
300
+ delivery_min_cost_distance_mtrs: {
301
+ type: Number,
302
+ default: 0,
303
+ },
304
+ delivery_cost_per_meter: {
305
+ type: Number,
306
+ default: 0,
307
+ },
308
+ delivery_free_over: {
309
+ type: Number,
310
+ default: 0,
311
+ },
312
+ delivery_order_value_per_meter: {
313
+ type: Number,
314
+ default: 0,
315
+ },
316
+ static_delivery_cost_multiplier: {
317
+ type: Number,
318
+ default: 0,
319
+ },
320
+ rider_revenue_type: {
321
+ type: String,
322
+ enum: ALL_RIDER_FEE_TYPES,
323
+ default: RIDER_FEE_TYPE_ENUM.DELIVERY_CHARGES_FULL,
324
+ },
325
+ rider_revenue_per_meter: {
326
+ type: Number,
327
+ default: 0,
328
+ },
329
+ static_rider_revenue_multiplier: {
330
+ type: Number,
331
+ default: 0,
332
+ },
333
+ min_service_fee_order_value: {
334
+ type: Number,
335
+ default: 0,
336
+ },
337
+ packaging_charges: {
338
+ type: Number,
339
+ default: 0,
340
+ },
341
+ packaging_charges_free_over: {
342
+ type: Number,
343
+ default: 0,
344
+ },
345
+ min_packaging_charges_order_value: {
346
+ type: Number,
347
+ default: 0,
348
+ },
349
+ cash_in_hand_limit: {
350
+ type: Number,
351
+ default: 0,
352
+ },
353
+ rider_pickup_food_image_mandatory: {
354
+ type: Boolean,
355
+ required: false,
356
+ },
357
+ rider_dropoff_food_image_mandatory: {
358
+ type: Boolean,
359
+ required: false,
360
+ },
361
+ disable_reason_for_discount: {
362
+ type: Boolean,
363
+ required: false,
364
+ },
365
+ brand_color: {
366
+ type: String,
367
+ default: '#5B0888FF',
368
+ },
369
+ restaurant_address: {
370
+ type: String,
371
+ default: '',
372
+ },
373
+ public_business_name: {
374
+ type: String,
375
+ default: '',
376
+ },
377
+ support_email: {
378
+ type: String,
379
+ default: '',
380
+ },
381
+ business_website: {
382
+ type: String,
383
+ default: null,
384
+ },
385
+ staff_ordering_domain: {
386
+ type: String,
387
+ default: null,
388
+ },
389
+ business_type: {
390
+ type: String,
391
+ default: '',
392
+ },
393
+ tax_business_number: {
394
+ type: String,
395
+ default: '',
396
+ },
397
+ track_order_number_by: {
398
+ type: String,
399
+ enum: ALL_TRACK_ORDER_NUMBER_TYPES,
400
+ default: TRACK_ORDER_NUMBER_ENUM.DAY,
401
+ },
402
+ order_number_grouping_type: {
403
+ type: String,
404
+ enum: ALL_ORDER_NUMBER_GROUPING_TYPES,
405
+ default: ORDER_NUMBER_GROUPING_TYPE_ENUM.ORDER_TYPE,
406
+ },
407
+ public_phone_numbers: {
408
+ type: [String],
409
+ default: [],
410
+ },
411
+ web_show_featured_items: {
412
+ type: Boolean,
413
+ default: false,
414
+ },
415
+ featured_category_name: {
416
+ type: String,
417
+ default: 'Popular',
418
+ },
419
+ operational_time_zone_offset_gmt: {
420
+ type: Number,
421
+ min: -12,
422
+ max: 14,
423
+ default: 0,
424
+ },
425
+ operational_start_time: {
426
+ type: Number,
427
+ min: 0,
428
+ max: 1440,
429
+ default: 360,
430
+ },
431
+ operational_end_time: {
432
+ type: Number,
433
+ min: 0,
434
+ max: 1440,
435
+ default: 360,
436
+ },
437
+ card_gst: {
438
+ type: Number,
439
+ default: 0,
440
+ },
441
+ cash_gst: {
442
+ type: Number,
443
+ default: 0,
444
+ },
445
+ default_gst_type: {
446
+ type: String,
447
+ enum: ALL_GST_TYPES,
448
+ default: GST_TYPE_ENUM.CARD,
449
+ },
450
+ im_card_gst: {
451
+ type: Number,
452
+ required: false,
453
+ },
454
+ im_cash_gst: {
455
+ type: Number,
456
+ required: false,
457
+ },
458
+ default_im_gst_type: {
459
+ type: String,
460
+ enum: ALL_GST_TYPES,
461
+ required: false,
462
+ },
463
+ po_card_gst: {
464
+ type: Number,
465
+ required: false,
466
+ },
467
+ po_cash_gst: {
468
+ type: Number,
469
+ required: false,
470
+ },
471
+ default_po_gst_type: {
472
+ type: String,
473
+ enum: ALL_GST_TYPES,
474
+ required: false,
475
+ },
476
+ web_design_type: {
477
+ type: String,
478
+ enum: ALL_ONLINE_ORDERING_DESIGN_TYPES,
479
+ default: ONLINE_ORDERING_DESIGN_TYPE_ENUM.CLASSIC,
480
+ },
481
+ web_cover_image: {
482
+ type: String,
483
+ default: '',
484
+ },
485
+ web_favicon: {
486
+ type: String,
487
+ default: '',
488
+ },
489
+ store_description: {
490
+ type: String,
491
+ default: '',
492
+ },
493
+ // ====><====
494
+ dinein_service_fee: {
495
+ type: Number,
496
+ default: 0,
497
+ },
498
+ card_processing_provider: {
499
+ type: String,
500
+ enum: ALL_CARD_PROCESSING_PROVIDERS,
501
+ required: false,
502
+ },
503
+ card_processing_account_id: {
504
+ type: String,
505
+ required: false,
506
+ },
507
+ _card_processing_account_token: {
508
+ type: String,
509
+ required: false,
510
+ },
511
+ sms_processing_provider: {
512
+ type: String,
513
+ enum: ALL_SMS_PROCESSING_PROVIDERS,
514
+ required: false,
515
+ },
516
+ sms_processing_account_id: {
517
+ type: String,
518
+ required: false,
519
+ },
520
+ email_processing_provider: {
521
+ type: String,
522
+ enum: ALL_EMAIL_PROCESSING_PROVIDERS,
523
+ required: false,
524
+ },
525
+ email_processing_account_id: {
526
+ type: String,
527
+ required: false,
528
+ },
529
+ // ====><====
530
+ send_sms_on_order_status: {
531
+ type: [OrderStatusSchema],
532
+ default: [ORDER_STATUS_ENUM.CANCELLED],
533
+ },
534
+ send_email_on_order_status: {
535
+ type: [OrderStatusSchema],
536
+ default: [
537
+ ORDER_STATUS_ENUM.PLACED,
538
+ ORDER_STATUS_ENUM.OUT_FOR_DELIVERY,
539
+ ORDER_STATUS_ENUM.OUT_FOR_DELIVERY,
540
+ ORDER_STATUS_ENUM.CANCELLED,
541
+ ],
542
+ },
543
+ auto_sms_platforms: {
544
+ type: [PlatformsSchema],
545
+ default: [
546
+ PLATFORMS_ENUM.WEB_DELIVERY,
547
+ PLATFORMS_ENUM.WEB_TAKE_AWAY,
548
+ PLATFORMS_ENUM.APP_DELIVERY,
549
+ PLATFORMS_ENUM.APP_TAKE_AWAY,
550
+ ],
551
+ },
552
+ auto_email_platforms: {
553
+ type: [PlatformsSchema],
554
+ default: [
555
+ PLATFORMS_ENUM.WEB_DELIVERY,
556
+ PLATFORMS_ENUM.WEB_TAKE_AWAY,
557
+ PLATFORMS_ENUM.APP_DELIVERY,
558
+ PLATFORMS_ENUM.APP_TAKE_AWAY,
559
+ PLATFORMS_ENUM.POS_DELIVERY,
560
+ ],
561
+ },
562
+ alert_phone_numbers: {
563
+ type: [String],
564
+ default: [],
565
+ },
566
+ alert_email_addresses: {
567
+ type: [String],
568
+ default: [],
569
+ },
570
+ alert_when: {
571
+ type: [String],
572
+ enum: ALL_ALERT_NOTIFICATIONS_TYPES,
573
+ default: [],
574
+ },
575
+ // ====><====
576
+ auto_accept_order_for_platforms: {
577
+ type: [PlatformsSchema],
578
+ default: [
579
+ PLATFORMS_ENUM.POS_DELIVERY,
580
+ PLATFORMS_ENUM.POS_DINE_IN,
581
+ PLATFORMS_ENUM.POS_TAKE_AWAY,
582
+ PLATFORMS_ENUM.POS_DELIVERY,
583
+ PLATFORMS_ENUM.POS_DINE_IN,
584
+ PLATFORMS_ENUM.POS_WALK_IN,
585
+ ],
586
+ },
587
+ kds_status_flow_platforms: {
588
+ type: [PlatformsSchema],
589
+ required: false,
590
+ },
591
+ custom_payment_types: {
592
+ type: [String],
593
+ default: [],
594
+ },
595
+ expense_payment_types: {
596
+ type: [String],
597
+ default: [],
598
+ },
599
+ im_custom_payment_types: {
600
+ type: [String],
601
+ required: false,
602
+ },
603
+ po_custom_payment_types: {
604
+ type: [String],
605
+ required: false,
606
+ },
607
+ takeaway_is_pickup: {
608
+ type: Boolean,
609
+ required: false,
610
+ },
611
+ reservation_enabled: {
612
+ type: Boolean,
613
+ default: false,
614
+ },
615
+ ms_clarity_id: {
616
+ type: String,
617
+ required: false,
618
+ },
619
+ fb_pixel_id: {
620
+ type: String,
621
+ required: false,
622
+ },
623
+ gtm_id: {
624
+ type: String,
625
+ required: false,
626
+ },
627
+ tax_invoice_provider: {
628
+ type: String,
629
+ enum: ALL_TAX_INVOICE_PROVIDERS,
630
+ required: false,
631
+ },
632
+ tax_invoice_generation_id: {
633
+ type: String,
634
+ required: false,
635
+ },
636
+ _tax_invoice_generation_token: {
637
+ type: String,
638
+ required: false,
639
+ },
640
+ web_hide_order_total_for_staff: {
641
+ type: Boolean,
642
+ required: false,
643
+ },
644
+ is_service_fee_percentage: {
645
+ type: Boolean,
646
+ required: false,
647
+ },
648
+ is_service_fee_taxable: {
649
+ type: Boolean,
650
+ required: false,
651
+ },
652
+ is_surcharge_percentage: {
653
+ type: Boolean,
654
+ required: false,
655
+ },
656
+ is_surcharge_taxable: {
657
+ type: Boolean,
658
+ required: false,
659
+ },
660
+ exclude_discount_from_gst: {
661
+ type: Boolean,
662
+ required: false,
663
+ },
664
+ apply_service_fee_on_original_price: {
665
+ type: Boolean,
666
+ required: false,
667
+ },
668
+ is_gst_inclusive: {
669
+ type: Boolean,
670
+ required: false,
671
+ },
672
+ apply_tax_on_complimentary_payment: {
673
+ type: Boolean,
674
+ required: false,
675
+ },
676
+ web_auth_type: {
677
+ type: String,
678
+ enum: ALL_WEB_AUTH_TYPES,
679
+ required: false,
680
+ },
681
+ delivery_areas_search_type: {
682
+ type: String,
683
+ enum: ALL_DELIVERY_AREAS_SEARCH_TYPES,
684
+ required: false,
685
+ },
686
+ integrations: {
687
+ type: [String],
688
+ enum: ALL_INTEGRATIONS,
689
+ default: [],
690
+ },
691
+ exempt_gst_for_platforms: {
692
+ type: [PlatformsSchema],
693
+ default: [],
694
+ },
695
+ edit_settled_order: {
696
+ type: Boolean,
697
+ required: false,
698
+ },
699
+ omit_offers_for_anonymous: {
700
+ type: Boolean,
701
+ required: false,
702
+ },
703
+ playstore_url: {
704
+ type: String,
705
+ required: false,
706
+ },
707
+ appstore_url: {
708
+ type: String,
709
+ required: false,
710
+ },
711
+ dark_mode: {
712
+ type: Boolean,
713
+ required: false,
714
+ },
715
+ hide_gst_value: {
716
+ type: Boolean,
717
+ required: false,
718
+ },
719
+ subscription_expiry: {
720
+ type: Schema.Types.Date,
721
+ required: false,
722
+ },
723
+ digital_menu_images: {
724
+ type: [String],
725
+ required: false,
726
+ },
727
+ web_slider_images: {
728
+ type: [String],
729
+ required: false,
730
+ },
731
+ enabled_rating_types: {
732
+ type: [RatingTypeSchema],
733
+ default: [],
734
+ },
735
+ order_completion_type: {
736
+ type: String,
737
+ enum: ALL_ORDER_COMPLETION_TYPES,
738
+ default: ORDER_COMPLETION_TYPE_ENUM.DEFAULT_ON,
739
+ },
740
+ twitter_link: {
741
+ type: String,
742
+ required: false,
743
+ },
744
+ instagram_link: {
745
+ type: String,
746
+ required: false,
747
+ },
748
+ fb_link: {
749
+ type: String,
750
+ required: false,
751
+ },
752
+ tiktok_link: {
753
+ type: String,
754
+ required: false,
755
+ },
756
+ receipt_qr_type: {
757
+ type: String,
758
+ enum: ALL_RECEIPT_QR_CODE_TYPES,
759
+ required: false,
760
+ },
761
+ menu_source: {
762
+ type: String,
763
+ required: false,
764
+ },
765
+ app_version: {
766
+ type: String,
767
+ required: false,
768
+ },
769
+ force_isolated_printing: {
770
+ type: Boolean,
771
+ required: false,
772
+ },
773
+ // ====><====
774
+ createdAt: {
775
+ type: Schema.Types.Date,
776
+ required: true,
777
+ default: () => new Date(),
778
+ immutable: true,
779
+ },
780
+ updatedAt: {
781
+ type: Schema.Types.Date,
782
+ required: true,
783
+ default: () => new Date(),
784
+ },
785
+ }, {
786
+ timestamps: true,
787
+ versionKey: false,
788
+ minimize: false,
789
+ });
790
+ export const TENANTS_COLLECTION_NAME = 'tenants';
791
+ /**
792
+ * Describes the indexes for `tenants`. Values are Mongo key patterns that can
793
+ * be passed straight to `.hint()`.
794
+ * - `_id`: unique primary key.
795
+ * - `staff_ordering_domain`: tenant lookups by staff ordering domain.
796
+ * - `brand_id__active`: per-brand tenant lookups by active state.
797
+ * - `business_website`: tenant lookups by business website.
798
+ */
799
+ export const TENANTS_COLLECTION_INDEXES = {
800
+ _id: { _id: 1 }, // Unique Index
801
+ staff_ordering_domain: {
802
+ staff_ordering_domain: 1,
803
+ }, // tenant lookups by staff ordering domain
804
+ brand_id__active: {
805
+ brand_id: 1,
806
+ active: 1,
807
+ }, // per-brand tenant lookups by active state
808
+ business_website: {
809
+ business_website: 1,
810
+ }, // tenant lookups by business website
811
+ };