@managesome/eposmatic-toolkit 0.2.426 → 0.2.429
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.
- package/lib/constants/RFQ.js +8 -8
- package/lib/schemas/models/applied_order_discounts.d.ts +80 -0
- package/lib/schemas/models/applied_order_discounts.js +106 -0
- package/lib/schemas/models/brands.d.ts +45 -0
- package/lib/schemas/models/brands.js +45 -0
- package/lib/schemas/models/categories.d.ts +60 -0
- package/lib/schemas/models/categories.js +67 -0
- package/lib/schemas/models/close_dates.js +2 -2
- package/lib/schemas/models/dinein_tables.d.ts +6 -6
- package/lib/schemas/models/dinein_tables_fingerprints.d.ts +65 -0
- package/lib/schemas/models/dinein_tables_fingerprints.js +85 -0
- package/lib/schemas/models/discounts.js +3 -3
- package/lib/schemas/models/expense_categories.d.ts +83 -0
- package/lib/schemas/models/expense_categories.js +64 -0
- package/lib/schemas/models/halfhalf_setup.js +3 -3
- package/lib/schemas/models/index.d.ts +23 -23
- package/lib/schemas/models/index.js +23 -23
- package/lib/schemas/models/inventories.d.ts +99 -0
- package/lib/schemas/models/inventories.js +87 -0
- package/lib/schemas/models/inventory_lot_serial_numbers.d.ts +15 -15
- package/lib/schemas/models/items.d.ts +11269 -0
- package/lib/schemas/models/items.js +333 -0
- package/lib/schemas/models/menus.d.ts +941 -0
- package/lib/schemas/models/menus.js +69 -0
- package/lib/schemas/models/offers.js +3 -3
- package/lib/schemas/models/orders.d.ts +15437 -0
- package/lib/schemas/models/orders.js +891 -0
- package/lib/schemas/models/public_holidays.js +2 -2
- package/lib/schemas/models/purchase_order_receipts.d.ts +3 -3
- package/lib/schemas/models/purchase_order_receipts.js +2 -2
- package/lib/schemas/models/purchase_order_rfqs.d.ts +1959 -0
- package/lib/schemas/models/purchase_order_rfqs.js +328 -0
- package/lib/schemas/models/purchase_order_vendor_returns.d.ts +15 -15
- package/lib/schemas/models/purchase_order_vendor_returns.js +2 -2
- package/lib/schemas/models/purchase_orders.js +4 -4
- package/lib/schemas/models/riders.d.ts +65 -0
- package/lib/schemas/models/riders.js +74 -0
- package/lib/schemas/models/specials.js +3 -3
- package/lib/schemas/models/tenant_staffs.d.ts +932 -0
- package/lib/schemas/models/tenant_staffs.js +96 -0
- package/lib/schemas/models/tenants.d.ts +528 -0
- package/lib/schemas/models/tenants.js +755 -0
- package/lib/schemas/models/track_order_numbers.d.ts +413 -0
- package/lib/schemas/models/track_order_numbers.js +45 -0
- package/lib/schemas/models/void_purchase_order_items.js +2 -2
- package/lib/schemas/models/void_warehouse_invoice_items.d.ts +6 -6
- package/lib/schemas/models/void_warehouse_invoice_items.js +2 -2
- package/lib/schemas/models/wallets.d.ts +38 -0
- package/lib/schemas/models/wallets.js +37 -0
- package/lib/schemas/models/warehouse-activity-logs.js +2 -2
- package/lib/schemas/models/warehouse_communications.d.ts +228 -0
- package/lib/schemas/models/warehouse_communications.js +216 -0
- package/lib/schemas/models/warehouse_internal_movements.d.ts +33 -34
- package/lib/schemas/models/warehouse_internal_movements.js +2 -34
- package/lib/schemas/models/warehouse_invoices.js +2 -2
- package/lib/schemas/models/warehouse_items.js +2 -2
- package/lib/schemas/models/warehouse_sale_deliveries.d.ts +167 -0
- package/lib/schemas/models/warehouse_sale_deliveries.js +155 -0
- package/lib/schemas/models/warehouse_sale_invoices.d.ts +227 -0
- package/lib/schemas/models/warehouse_sale_invoices.js +206 -0
- package/lib/schemas/models/warehouse_sale_order_rfqs.d.ts +1938 -0
- package/lib/schemas/models/warehouse_sale_order_rfqs.js +309 -0
- package/lib/schemas/models/warehouse_sale_orders.d.ts +1943 -0
- package/lib/schemas/models/warehouse_sale_orders.js +324 -0
- package/lib/schemas/models/warehouse_staffs.d.ts +65 -0
- package/lib/schemas/models/warehouse_staffs.js +78 -0
- package/lib/schemas/models/warehouse_track_order_numbers.d.ts +50 -0
- package/lib/schemas/models/warehouse_track_order_numbers.js +52 -0
- package/lib/schemas/models/warehouse_vendors.d.ts +3 -3
- package/lib/schemas/models/warehouses.d.ts +162 -0
- package/lib/schemas/models/warehouses.js +222 -0
- package/lib/schemas/types/applied_order_discounts.d.ts +22 -0
- package/lib/schemas/types/applied_order_discounts.js +2 -0
- package/lib/schemas/types/brands.d.ts +32 -0
- package/lib/schemas/types/brands.js +2 -0
- package/lib/schemas/types/categories.d.ts +15 -0
- package/lib/schemas/types/categories.js +2 -0
- package/lib/schemas/types/deliveries.d.ts +1 -1
- package/lib/schemas/types/expense_categories.d.ts +20 -0
- package/lib/schemas/types/expense_categories.js +2 -0
- package/lib/schemas/types/expense_details.d.ts +1 -1
- package/lib/schemas/types/index.d.ts +22 -22
- package/lib/schemas/types/index.js +22 -22
- package/lib/schemas/types/inventories.d.ts +48 -0
- package/lib/schemas/types/inventories.js +2 -0
- package/lib/schemas/types/items.d.ts +89 -0
- package/lib/schemas/types/items.js +2 -0
- package/lib/schemas/types/menus.d.ts +17 -0
- package/lib/schemas/types/menus.js +2 -0
- package/lib/schemas/types/multi_tenants.d.ts +2 -2
- package/lib/schemas/types/orders.d.ts +242 -0
- package/lib/schemas/types/orders.js +2 -0
- package/lib/schemas/types/purchase_order_common.d.ts +1 -1
- package/lib/schemas/types/purchase_order_rfqs.d.ts +33 -0
- package/lib/schemas/types/purchase_order_rfqs.js +2 -0
- package/lib/schemas/types/purchase_orders.d.ts +1 -1
- package/lib/schemas/types/reservations.d.ts +1 -1
- package/lib/schemas/types/riders.d.ts +16 -0
- package/lib/schemas/types/riders.js +2 -0
- package/lib/schemas/types/sale_order_common.d.ts +1 -1
- package/lib/schemas/types/specials.d.ts +1 -1
- package/lib/schemas/types/tenant_staffs.d.ts +22 -0
- package/lib/schemas/types/tenant_staffs.js +2 -0
- package/lib/schemas/types/tenants.d.ts +205 -0
- package/lib/schemas/types/tenants.js +2 -0
- package/lib/schemas/types/track_order_numbers.d.ts +10 -0
- package/lib/schemas/types/track_order_numbers.js +2 -0
- package/lib/schemas/types/wallets.d.ts +7 -0
- package/lib/schemas/types/wallets.js +2 -0
- package/lib/schemas/types/warehouse_communications.d.ts +54 -0
- package/lib/schemas/types/warehouse_communications.js +2 -0
- package/lib/schemas/types/warehouse_internal_movements.d.ts +2 -2
- package/lib/schemas/types/warehouse_invoices.d.ts +1 -1
- package/lib/schemas/types/warehouse_sale_deliveries.d.ts +67 -0
- package/lib/schemas/types/warehouse_sale_deliveries.js +2 -0
- package/lib/schemas/types/warehouse_sale_invoices.d.ts +49 -0
- package/lib/schemas/types/warehouse_sale_invoices.js +2 -0
- package/lib/schemas/types/warehouse_sale_order_rfqs.d.ts +25 -0
- package/lib/schemas/types/warehouse_sale_order_rfqs.js +2 -0
- package/lib/schemas/types/warehouse_sale_orders.d.ts +30 -0
- package/lib/schemas/types/warehouse_sale_orders.js +2 -0
- package/lib/schemas/types/warehouse_staffs.d.ts +17 -0
- package/lib/schemas/types/warehouse_staffs.js +2 -0
- package/lib/schemas/types/warehouse_track_order_numbers.d.ts +11 -0
- package/lib/schemas/types/warehouse_track_order_numbers.js +2 -0
- package/lib/schemas/types/warehouses.d.ts +49 -0
- package/lib/schemas/types/warehouses.js +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
import { ALERT_NOTIFICATIONS_TYPE_ENUM, CARD_PROCESSING_PROVIDERS_ENUM, 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, DELIVERY_AREAS_SEARCH_TYPE_ENUM, EMAIL_PROCESSING_PROVIDERS_ENUM, GST_TYPE_ENUM, INTEGRATIONS_ENUM, ONLINE_ORDERING_DESIGN_TYPE_ENUM, ORDER_COMPLETION_TYPE_ENUM, ORDER_NUMBER_GROUPING_TYPE_ENUM, ORDER_STATUS_ENUM, ORDER_TYPE_ENUM, PLATFORMS_ENUM, RATING_TYPE_ENUM, RECEIPT_QR_CODE_TYPE_ENUM, RIDER_FEE_TYPE_ENUM, SMS_PROCESSING_PROVIDERS_ENUM, TAX_INVOICE_PROVIDER_ENUM, TRACK_ORDER_NUMBER_ENUM, WEB_AUTH_TYPE_ENUM, WEB_UNPAID_PAYMENT_TYPE_ENUM } from '../../constants';
|
|
2
|
+
import { IBrand } from './brands';
|
|
3
|
+
export interface IWebStopTakingOrders {
|
|
4
|
+
order_types: ORDER_TYPE_ENUM[];
|
|
5
|
+
date: Date;
|
|
6
|
+
}
|
|
7
|
+
export interface ITenant {
|
|
8
|
+
_id: string;
|
|
9
|
+
brand_id: string;
|
|
10
|
+
provider_id: string;
|
|
11
|
+
name: string;
|
|
12
|
+
image_url: string;
|
|
13
|
+
active: boolean;
|
|
14
|
+
currency_code: CURRENCY_CODE_ENUM;
|
|
15
|
+
currency_symbol: CURRENCY_SYMBOL_ENUM;
|
|
16
|
+
currency_name: CURRENCY_NAME_ENUM;
|
|
17
|
+
country_code: COUNTRY_CODE_ENUM;
|
|
18
|
+
country_alpha_2: COUNTRY_ALPHA_2_ENUM;
|
|
19
|
+
country_alpha_3: COUNTRY_ALPHA_3_ENUM;
|
|
20
|
+
country_name: COUNTRY_NAME_ENUM;
|
|
21
|
+
country_flag: COUNTRY_FLAG_ENUM;
|
|
22
|
+
coordinates: number[];
|
|
23
|
+
city: string;
|
|
24
|
+
google_review_link: string | null;
|
|
25
|
+
takeaway_time: number;
|
|
26
|
+
delivery_time: number;
|
|
27
|
+
enable_inventory: boolean;
|
|
28
|
+
pay_first_for_dine_in: boolean;
|
|
29
|
+
closed_store_message: string | null;
|
|
30
|
+
break_time_message: string | null;
|
|
31
|
+
announcement_message: string | null;
|
|
32
|
+
review_emails: string[];
|
|
33
|
+
review_phone_numbers: string[];
|
|
34
|
+
enabled_review_platforms: PLATFORMS_ENUM[];
|
|
35
|
+
payment_report_emails: string[];
|
|
36
|
+
pos_enable_internal_auth: boolean;
|
|
37
|
+
pos_enable_takeaway: boolean;
|
|
38
|
+
pos_enable_delivery: boolean;
|
|
39
|
+
pos_enable_dine_in: boolean;
|
|
40
|
+
pos_enable_drive_thru: boolean;
|
|
41
|
+
pos_enable_kiosk: boolean;
|
|
42
|
+
pos_pre_ordering_days?: number | null;
|
|
43
|
+
pos_opt_in_for_holiday_surcharge: boolean;
|
|
44
|
+
pos_holiday_surcharge: number;
|
|
45
|
+
pos_enable_card_payments: boolean;
|
|
46
|
+
pos_min_takeaway_order_value: number;
|
|
47
|
+
pos_end_seating_when_order_paid_off: boolean;
|
|
48
|
+
pos_accedental_touch_protection_enabled?: boolean;
|
|
49
|
+
web_charge_customer_for_online_processing: boolean;
|
|
50
|
+
web_allow_ordering_till_closing_time: boolean;
|
|
51
|
+
web_enable_takeaway: boolean;
|
|
52
|
+
web_enable_delivery: boolean;
|
|
53
|
+
web_enable_dine_in: boolean;
|
|
54
|
+
web_enable_pre_ordering?: boolean;
|
|
55
|
+
web_pre_ordering_visibility_minutes?: number | null;
|
|
56
|
+
web_pre_ordering_days?: number | null;
|
|
57
|
+
max_preorder_delivery_minutes?: number | null;
|
|
58
|
+
max_preorder_takeaway_minutes?: number | null;
|
|
59
|
+
default_prep_minutes: number;
|
|
60
|
+
web_opt_in_for_holiday_surcharge: boolean;
|
|
61
|
+
web_holiday_surcharge: number;
|
|
62
|
+
web_enable_cash_payments_takeaway: boolean;
|
|
63
|
+
web_enable_cash_payments_delivery: boolean;
|
|
64
|
+
web_enable_cash_payments_dine_in: boolean;
|
|
65
|
+
web_enable_terminal_payments?: boolean;
|
|
66
|
+
web_min_takeaway_order_value: number;
|
|
67
|
+
web_max_cash_order_value: number;
|
|
68
|
+
web_stop_taking_orders: IWebStopTakingOrders | null;
|
|
69
|
+
web_unpaid_payment_types: WEB_UNPAID_PAYMENT_TYPE_ENUM[];
|
|
70
|
+
dinein_service_fee: number;
|
|
71
|
+
opt_in_for_radius_based_delivery: boolean;
|
|
72
|
+
delivery_radius: number;
|
|
73
|
+
min_delivery_order_value: number;
|
|
74
|
+
delivery_min_cost: number;
|
|
75
|
+
delivery_min_cost_distance_mtrs: number;
|
|
76
|
+
delivery_cost_per_meter: number;
|
|
77
|
+
delivery_free_over: number;
|
|
78
|
+
delivery_order_value_per_meter: number;
|
|
79
|
+
static_delivery_cost_multiplier: number;
|
|
80
|
+
rider_revenue_type: RIDER_FEE_TYPE_ENUM;
|
|
81
|
+
rider_revenue_per_meter: number;
|
|
82
|
+
static_rider_revenue_multiplier: number;
|
|
83
|
+
min_service_fee_order_value?: number;
|
|
84
|
+
packaging_charges?: number;
|
|
85
|
+
packaging_charges_free_over?: number;
|
|
86
|
+
min_packaging_charges_order_value?: number;
|
|
87
|
+
cash_in_hand_limit?: number;
|
|
88
|
+
rider_pickup_food_image_mandatory?: boolean;
|
|
89
|
+
rider_dropoff_food_image_mandatory?: boolean;
|
|
90
|
+
disable_reason_for_discount?: boolean;
|
|
91
|
+
brand_color: string;
|
|
92
|
+
restaurant_address: string;
|
|
93
|
+
public_business_name: string;
|
|
94
|
+
support_email: string;
|
|
95
|
+
business_website: string | null;
|
|
96
|
+
staff_ordering_domain: string | null;
|
|
97
|
+
business_type: string;
|
|
98
|
+
tax_business_number: string;
|
|
99
|
+
track_order_number_by: TRACK_ORDER_NUMBER_ENUM;
|
|
100
|
+
order_number_grouping_type: ORDER_NUMBER_GROUPING_TYPE_ENUM;
|
|
101
|
+
public_phone_numbers: string[];
|
|
102
|
+
web_show_featured_items: boolean;
|
|
103
|
+
featured_category_name: string;
|
|
104
|
+
card_gst: number;
|
|
105
|
+
cash_gst: number;
|
|
106
|
+
default_gst_type: GST_TYPE_ENUM;
|
|
107
|
+
web_cover_image: string;
|
|
108
|
+
web_favicon: string;
|
|
109
|
+
web_design_type: ONLINE_ORDERING_DESIGN_TYPE_ENUM;
|
|
110
|
+
store_description: string;
|
|
111
|
+
operational_time_zone_offset_gmt: number;
|
|
112
|
+
operational_start_time: number;
|
|
113
|
+
operational_end_time: number;
|
|
114
|
+
card_processing_provider?: CARD_PROCESSING_PROVIDERS_ENUM;
|
|
115
|
+
card_processing_account_id?: string | null;
|
|
116
|
+
_card_processing_account_token?: string | null;
|
|
117
|
+
sms_processing_provider?: SMS_PROCESSING_PROVIDERS_ENUM;
|
|
118
|
+
sms_processing_account_id?: string | null;
|
|
119
|
+
email_processing_provider?: EMAIL_PROCESSING_PROVIDERS_ENUM;
|
|
120
|
+
email_processing_account_id?: string | null;
|
|
121
|
+
send_sms_on_order_status: ORDER_STATUS_ENUM[];
|
|
122
|
+
send_email_on_order_status: ORDER_STATUS_ENUM[];
|
|
123
|
+
auto_sms_platforms: PLATFORMS_ENUM[];
|
|
124
|
+
auto_email_platforms: PLATFORMS_ENUM[];
|
|
125
|
+
alert_phone_numbers: string[];
|
|
126
|
+
alert_email_addresses: string[];
|
|
127
|
+
alert_when: ALERT_NOTIFICATIONS_TYPE_ENUM[];
|
|
128
|
+
auto_accept_order_for_platforms: PLATFORMS_ENUM[];
|
|
129
|
+
custom_payment_types: string[];
|
|
130
|
+
expense_payment_types: string[];
|
|
131
|
+
takeaway_is_pickup?: boolean;
|
|
132
|
+
reservation_enabled: boolean;
|
|
133
|
+
ms_clarity_id?: string | null;
|
|
134
|
+
fb_pixel_id?: string | null;
|
|
135
|
+
gtm_id?: string | null;
|
|
136
|
+
tax_invoice_provider?: TAX_INVOICE_PROVIDER_ENUM;
|
|
137
|
+
tax_invoice_generation_id?: string | null;
|
|
138
|
+
_tax_invoice_generation_token?: string | null;
|
|
139
|
+
web_hide_order_total_for_staff?: boolean;
|
|
140
|
+
is_service_fee_percentage?: boolean;
|
|
141
|
+
is_service_fee_taxable?: boolean;
|
|
142
|
+
is_surcharge_percentage?: boolean;
|
|
143
|
+
is_surcharge_taxable?: boolean;
|
|
144
|
+
exclude_discount_from_gst?: boolean;
|
|
145
|
+
apply_service_fee_on_original_price?: boolean;
|
|
146
|
+
is_gst_inclusive?: boolean;
|
|
147
|
+
apply_tax_on_complimentary_payment?: boolean;
|
|
148
|
+
web_auth_type?: WEB_AUTH_TYPE_ENUM;
|
|
149
|
+
delivery_areas_search_type?: DELIVERY_AREAS_SEARCH_TYPE_ENUM;
|
|
150
|
+
omit_offers_for_anonymous?: boolean;
|
|
151
|
+
integrations: INTEGRATIONS_ENUM[];
|
|
152
|
+
exempt_gst_for_platforms: PLATFORMS_ENUM[];
|
|
153
|
+
edit_settled_order?: boolean;
|
|
154
|
+
playstore_url?: string | null;
|
|
155
|
+
appstore_url?: string | null;
|
|
156
|
+
dark_mode?: boolean;
|
|
157
|
+
hide_gst_value?: boolean;
|
|
158
|
+
subscription_expiry?: Date | null;
|
|
159
|
+
digital_menu_images?: string[] | null;
|
|
160
|
+
web_slider_images?: string[] | null;
|
|
161
|
+
enabled_rating_types: RATING_TYPE_ENUM[];
|
|
162
|
+
specials_name?: string | null;
|
|
163
|
+
order_completion_type: ORDER_COMPLETION_TYPE_ENUM;
|
|
164
|
+
fb_link?: string | null;
|
|
165
|
+
instagram_link?: string | null;
|
|
166
|
+
twitter_link?: string | null;
|
|
167
|
+
tiktok_link?: string | null;
|
|
168
|
+
receipt_qr_type?: RECEIPT_QR_CODE_TYPE_ENUM | null;
|
|
169
|
+
menu_source?: string | null;
|
|
170
|
+
app_version?: string | null;
|
|
171
|
+
force_isolated_printing?: boolean;
|
|
172
|
+
createdAt: Date;
|
|
173
|
+
updatedAt: Date;
|
|
174
|
+
}
|
|
175
|
+
export interface ITenantOnlineOrderingMetadata {
|
|
176
|
+
_id: string;
|
|
177
|
+
image_url: ITenant['image_url'];
|
|
178
|
+
business_website: ITenant['business_website'];
|
|
179
|
+
staff_ordering_domain: ITenant['staff_ordering_domain'];
|
|
180
|
+
public_business_name: ITenant['public_business_name'];
|
|
181
|
+
restaurant_address: ITenant['restaurant_address'];
|
|
182
|
+
store_description: ITenant['store_description'];
|
|
183
|
+
web_favicon: ITenant['web_favicon'];
|
|
184
|
+
brand_color: ITenant['brand_color'];
|
|
185
|
+
business_type: ITenant['business_type'];
|
|
186
|
+
city: ITenant['city'];
|
|
187
|
+
fb_link: ITenant['fb_link'];
|
|
188
|
+
instagram_link: ITenant['instagram_link'];
|
|
189
|
+
twitter_link: ITenant['twitter_link'];
|
|
190
|
+
tiktok_link: ITenant['tiktok_link'];
|
|
191
|
+
}
|
|
192
|
+
export interface IBrandOnlineOrderingMetadata {
|
|
193
|
+
_id: string;
|
|
194
|
+
image_url: IBrand['image_url'];
|
|
195
|
+
name: IBrand['name'];
|
|
196
|
+
multi_tenant_website: IBrand['multi_tenant_website'];
|
|
197
|
+
store_description: ITenant['store_description'];
|
|
198
|
+
web_favicon: ITenant['web_favicon'];
|
|
199
|
+
brand_color: ITenant['brand_color'];
|
|
200
|
+
business_type: ITenant['business_type'];
|
|
201
|
+
fb_link: ITenant['fb_link'];
|
|
202
|
+
instagram_link: ITenant['instagram_link'];
|
|
203
|
+
twitter_link: ITenant['twitter_link'];
|
|
204
|
+
tiktok_link: ITenant['tiktok_link'];
|
|
205
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { IPlatformNumber } from './common';
|
|
2
|
+
export interface ITrackOrderNumber {
|
|
3
|
+
_id: string;
|
|
4
|
+
YEAR: Partial<IPlatformNumber>;
|
|
5
|
+
MONTH: Partial<IPlatformNumber>;
|
|
6
|
+
DAY: Partial<IPlatformNumber>;
|
|
7
|
+
runningLocalDate?: string;
|
|
8
|
+
createdAt: Date;
|
|
9
|
+
updatedAt: Date;
|
|
10
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { COMMUNICATION_CHANNEL_ENUM, EMAIL_DOCUMENT_KIND_ENUM } from '../../constants';
|
|
2
|
+
export type TWarehouseCommunicationDocumentKind = EMAIL_DOCUMENT_KIND_ENUM;
|
|
3
|
+
export type TWarehouseCommunicationChannel = COMMUNICATION_CHANNEL_ENUM;
|
|
4
|
+
interface IWarehouseCommunicationActionButton {
|
|
5
|
+
title: string;
|
|
6
|
+
url: string;
|
|
7
|
+
button_color: string;
|
|
8
|
+
button_text_color: string;
|
|
9
|
+
icon?: string;
|
|
10
|
+
}
|
|
11
|
+
interface IWarehouseCommunicationLineItem {
|
|
12
|
+
name: string;
|
|
13
|
+
quantity: number;
|
|
14
|
+
price: number;
|
|
15
|
+
subtotal: number;
|
|
16
|
+
currency_symbol?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface IWarehouseCommunicationMetadata {
|
|
19
|
+
warehouse_name: string;
|
|
20
|
+
warehouse_logo_url: string;
|
|
21
|
+
support_email: string;
|
|
22
|
+
counterparty_name: string;
|
|
23
|
+
counterparty_email: string;
|
|
24
|
+
reference_number?: string | null;
|
|
25
|
+
order_number?: number | null;
|
|
26
|
+
issued_date: string;
|
|
27
|
+
expected_deadline?: string | null;
|
|
28
|
+
payment_terms_days?: number | null;
|
|
29
|
+
currency_symbol: string;
|
|
30
|
+
subtotal: number;
|
|
31
|
+
gst?: number | null;
|
|
32
|
+
gst_amount?: number | null;
|
|
33
|
+
is_gst_inclusive?: boolean | null;
|
|
34
|
+
grand_total: number;
|
|
35
|
+
line_items: IWarehouseCommunicationLineItem[];
|
|
36
|
+
notes?: string | null;
|
|
37
|
+
action_buttons?: IWarehouseCommunicationActionButton[];
|
|
38
|
+
theme_color?: string | null;
|
|
39
|
+
}
|
|
40
|
+
export interface IWarehouseCommunication {
|
|
41
|
+
_id: string;
|
|
42
|
+
warehouse_id: string;
|
|
43
|
+
document_kind: TWarehouseCommunicationDocumentKind;
|
|
44
|
+
document_id: string;
|
|
45
|
+
communication_channel: TWarehouseCommunicationChannel;
|
|
46
|
+
to: string;
|
|
47
|
+
subject: string;
|
|
48
|
+
description: string;
|
|
49
|
+
metadata: IWarehouseCommunicationMetadata;
|
|
50
|
+
sent_at?: Date | null;
|
|
51
|
+
createdAt: Date;
|
|
52
|
+
updatedAt: Date;
|
|
53
|
+
}
|
|
54
|
+
export {};
|
|
@@ -27,7 +27,7 @@ export interface IWarehouseInternalMovementStatusMeta {
|
|
|
27
27
|
cancelled_by?: IWarehouseInternalMovementActorRef | null;
|
|
28
28
|
}
|
|
29
29
|
export interface IWarehouseInternalMovementEditRequestMeta {
|
|
30
|
-
edit_request_status
|
|
30
|
+
edit_request_status?: INTERNAL_MOVEMENT_EDIT_REQUEST_STATUS_ENUM | null;
|
|
31
31
|
edit_requested_at?: Date | null;
|
|
32
32
|
edit_requested_by?: IWarehouseInternalMovementActorRef | null;
|
|
33
33
|
edit_request_note?: string | null;
|
|
@@ -37,7 +37,7 @@ export interface IWarehouseInternalMovementEditRequestMeta {
|
|
|
37
37
|
edit_approved_for_context_id?: string | null;
|
|
38
38
|
}
|
|
39
39
|
export interface IWarehouseInternalMovementCancelRequestMeta {
|
|
40
|
-
cancel_request_status
|
|
40
|
+
cancel_request_status?: INTERNAL_MOVEMENT_EDIT_REQUEST_STATUS_ENUM | null;
|
|
41
41
|
cancel_requested_at?: Date | null;
|
|
42
42
|
cancel_requested_by?: IWarehouseInternalMovementActorRef | null;
|
|
43
43
|
cancel_request_note?: string | null;
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { SALE_ORDER_DELIVERY_RETURN_STATUS_ENUM, SALE_ORDER_DELIVERY_STATUS_ENUM, SALE_ORDER_PHYSICAL_DOC_KIND_ENUM } from '../../constants';
|
|
2
|
+
export interface ISaleOrderPhysicalItems {
|
|
3
|
+
item_id: string;
|
|
4
|
+
item_name: string;
|
|
5
|
+
quantity: number;
|
|
6
|
+
reason?: string | null;
|
|
7
|
+
}
|
|
8
|
+
export type ISaleOrderDeliveryItems = ISaleOrderPhysicalItems;
|
|
9
|
+
export type ISaleOrderDeliveryReturnItems = ISaleOrderPhysicalItems;
|
|
10
|
+
export interface ISaleOrderDeliveryActor {
|
|
11
|
+
_id: string;
|
|
12
|
+
name: string;
|
|
13
|
+
}
|
|
14
|
+
export interface ISaleOrderDelivery {
|
|
15
|
+
_id: string;
|
|
16
|
+
doc_kind: SALE_ORDER_PHYSICAL_DOC_KIND_ENUM;
|
|
17
|
+
warehouse_id: string;
|
|
18
|
+
sale_order_id: string;
|
|
19
|
+
applied_to_doc_id?: string | null;
|
|
20
|
+
items: ISaleOrderDeliveryItems[];
|
|
21
|
+
status: SALE_ORDER_DELIVERY_STATUS_ENUM | SALE_ORDER_DELIVERY_RETURN_STATUS_ENUM;
|
|
22
|
+
notes?: string | null;
|
|
23
|
+
inventory_consumed?: boolean;
|
|
24
|
+
inventory_restocked?: boolean;
|
|
25
|
+
created_by?: ISaleOrderDeliveryActor | null;
|
|
26
|
+
delivered_by?: ISaleOrderDeliveryActor | null;
|
|
27
|
+
returned_by?: ISaleOrderDeliveryActor | null;
|
|
28
|
+
cancelled_by?: ISaleOrderDeliveryActor | null;
|
|
29
|
+
delivered_at?: Date | null;
|
|
30
|
+
returned_at?: Date | null;
|
|
31
|
+
cancelled_at?: Date | null;
|
|
32
|
+
cancel_reason?: string | null;
|
|
33
|
+
createdAt_mins: number;
|
|
34
|
+
createdAt: Date;
|
|
35
|
+
updatedAt: Date;
|
|
36
|
+
}
|
|
37
|
+
export interface ISaleOrderDeliveryDocument extends ISaleOrderDelivery {
|
|
38
|
+
doc_kind: SALE_ORDER_PHYSICAL_DOC_KIND_ENUM.DELIVERY;
|
|
39
|
+
status: SALE_ORDER_DELIVERY_STATUS_ENUM;
|
|
40
|
+
applied_to_doc_id?: null;
|
|
41
|
+
}
|
|
42
|
+
export interface ISaleOrderDeliveryReturnDocument extends ISaleOrderDelivery {
|
|
43
|
+
doc_kind: SALE_ORDER_PHYSICAL_DOC_KIND_ENUM.DELIVERY_RETURN;
|
|
44
|
+
applied_to_doc_id: string;
|
|
45
|
+
status: SALE_ORDER_DELIVERY_RETURN_STATUS_ENUM;
|
|
46
|
+
}
|
|
47
|
+
interface ICreateSaleOrderPhysicalDocBodyBase {
|
|
48
|
+
item_id: string;
|
|
49
|
+
quantity: number;
|
|
50
|
+
reason?: string | null;
|
|
51
|
+
}
|
|
52
|
+
interface ICreateSaleOrderPhysicalDocBase {
|
|
53
|
+
items: ICreateSaleOrderPhysicalDocBodyBase[];
|
|
54
|
+
notes?: string;
|
|
55
|
+
sale_order_updatedAt?: Date | string;
|
|
56
|
+
}
|
|
57
|
+
export interface ICreateSaleOrderDeliveryBody extends ICreateSaleOrderPhysicalDocBase {
|
|
58
|
+
doc_kind?: SALE_ORDER_PHYSICAL_DOC_KIND_ENUM.DELIVERY;
|
|
59
|
+
status?: SALE_ORDER_DELIVERY_STATUS_ENUM;
|
|
60
|
+
}
|
|
61
|
+
export interface ICreateSaleOrderDeliveryReturnBody extends ICreateSaleOrderPhysicalDocBase {
|
|
62
|
+
doc_kind: SALE_ORDER_PHYSICAL_DOC_KIND_ENUM.DELIVERY_RETURN;
|
|
63
|
+
applied_to_doc_id: string;
|
|
64
|
+
status: SALE_ORDER_DELIVERY_RETURN_STATUS_ENUM;
|
|
65
|
+
}
|
|
66
|
+
export type ICreateSaleOrderPhysicalDocBody = ICreateSaleOrderDeliveryBody | ICreateSaleOrderDeliveryReturnBody;
|
|
67
|
+
export {};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { SALE_ORDER_CREDIT_NOTE_STATUS_ENUM, SALE_ORDER_FIN_DOC_KIND_ENUM, SALE_ORDER_INVOICE_PAYMENT_STATUS_ENUM, SALE_ORDER_INVOICE_TYPE_ENUM } from '../../constants';
|
|
2
|
+
import { IOrderPayment } from './orders';
|
|
3
|
+
export type ISaleOrderFinancialDocStatus = SALE_ORDER_INVOICE_PAYMENT_STATUS_ENUM | SALE_ORDER_CREDIT_NOTE_STATUS_ENUM;
|
|
4
|
+
export interface ISaleOrderFinancialLine {
|
|
5
|
+
item_id: string;
|
|
6
|
+
item_name: string;
|
|
7
|
+
quantity: number;
|
|
8
|
+
unit_price: number;
|
|
9
|
+
reason?: string | null;
|
|
10
|
+
}
|
|
11
|
+
export interface ISaleOrderFinancialDocActor {
|
|
12
|
+
_id: string;
|
|
13
|
+
name: string;
|
|
14
|
+
}
|
|
15
|
+
export type ISaleOrderInvoicePaymentRecord = IOrderPayment;
|
|
16
|
+
export interface ISaleOrderInvoice {
|
|
17
|
+
_id: string;
|
|
18
|
+
doc_kind: SALE_ORDER_FIN_DOC_KIND_ENUM;
|
|
19
|
+
warehouse_id: string;
|
|
20
|
+
sale_order_id: string;
|
|
21
|
+
doc_number: number;
|
|
22
|
+
applied_to_doc_id?: string | null;
|
|
23
|
+
items: ISaleOrderFinancialLine[];
|
|
24
|
+
amount: number;
|
|
25
|
+
notes?: string | null;
|
|
26
|
+
status: ISaleOrderFinancialDocStatus;
|
|
27
|
+
invoice_type: SALE_ORDER_INVOICE_TYPE_ENUM;
|
|
28
|
+
amount_paid?: number;
|
|
29
|
+
down_payment_value?: number;
|
|
30
|
+
payments?: ISaleOrderInvoicePaymentRecord[];
|
|
31
|
+
gst?: number | null;
|
|
32
|
+
gst_amount?: number | null;
|
|
33
|
+
is_gst_inclusive?: boolean | null;
|
|
34
|
+
created_by?: ISaleOrderFinancialDocActor | null;
|
|
35
|
+
posted_by?: ISaleOrderFinancialDocActor | null;
|
|
36
|
+
confirmed_by?: ISaleOrderFinancialDocActor | null;
|
|
37
|
+
refund_pending_by?: ISaleOrderFinancialDocActor | null;
|
|
38
|
+
refunded_by?: ISaleOrderFinancialDocActor | null;
|
|
39
|
+
cancelled_by?: ISaleOrderFinancialDocActor | null;
|
|
40
|
+
posted_at?: Date | null;
|
|
41
|
+
confirmed_at?: Date | null;
|
|
42
|
+
refund_pending_at?: Date | null;
|
|
43
|
+
refunded_at?: Date | null;
|
|
44
|
+
cancelled_at?: Date | null;
|
|
45
|
+
cancel_reason?: string | null;
|
|
46
|
+
createdAt_mins: number;
|
|
47
|
+
createdAt: Date;
|
|
48
|
+
updatedAt: Date;
|
|
49
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { SALE_ORDER_RFQ_STATUS_ENUM } from '../../constants';
|
|
2
|
+
import { ISaleOrderCommonCategoryByCategoryId, ISaleOrderCommonItem, ISaleOrderCommonIterationBase } from './sale_order_common';
|
|
3
|
+
export type ISaleOrderRFQItem = ISaleOrderCommonItem;
|
|
4
|
+
export type ISaleOrderRFQCategory = ISaleOrderCommonCategoryByCategoryId;
|
|
5
|
+
export interface ISaleOrderRFQIteration extends ISaleOrderCommonIterationBase<ISaleOrderRFQCategory, SALE_ORDER_RFQ_STATUS_ENUM | string> {
|
|
6
|
+
tax_number: string;
|
|
7
|
+
}
|
|
8
|
+
export interface ISaleOrderRFQ extends ISaleOrderRFQIteration {
|
|
9
|
+
_id: string;
|
|
10
|
+
warehouse_id: string;
|
|
11
|
+
client_id: string;
|
|
12
|
+
client_name: string;
|
|
13
|
+
iterations: ISaleOrderRFQIteration[];
|
|
14
|
+
order_number: number | null;
|
|
15
|
+
expected_deadline: string;
|
|
16
|
+
payment_terms: number;
|
|
17
|
+
delete_reason?: string | null;
|
|
18
|
+
cancel_reason?: string | null;
|
|
19
|
+
is_deleted: boolean;
|
|
20
|
+
order_status_updated_at: Date;
|
|
21
|
+
special_instructions: string;
|
|
22
|
+
is_reopened?: boolean;
|
|
23
|
+
createdAt_mins: number;
|
|
24
|
+
createdAt: Date;
|
|
25
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { SALES_ORDER_STATUS_ENUM } from '../../constants';
|
|
2
|
+
import { ISaleOrderCommonCategoryByCategoryId, ISaleOrderCommonItem, ISaleOrderCommonIterationBase } from './sale_order_common';
|
|
3
|
+
export type ISaleOrderItem = ISaleOrderCommonItem;
|
|
4
|
+
export type ISaleOrderCategory = ISaleOrderCommonCategoryByCategoryId;
|
|
5
|
+
export interface ISaleOrderIteration extends ISaleOrderCommonIterationBase<ISaleOrderCategory, SALES_ORDER_STATUS_ENUM> {
|
|
6
|
+
tax_number: string;
|
|
7
|
+
}
|
|
8
|
+
export interface ISaleOrder extends ISaleOrderIteration {
|
|
9
|
+
_id: string;
|
|
10
|
+
warehouse_id: string;
|
|
11
|
+
client_id: string;
|
|
12
|
+
client_name: string;
|
|
13
|
+
/** Source RFQ reference when this sales order is confirmed from an RFQ. */
|
|
14
|
+
rfq_id?: string | null;
|
|
15
|
+
iterations: ISaleOrderIteration[];
|
|
16
|
+
/**
|
|
17
|
+
* amount_collected is the total amount collected from the consumer
|
|
18
|
+
*/
|
|
19
|
+
amount_collected: number;
|
|
20
|
+
order_number: number | null;
|
|
21
|
+
delete_reason?: string | null;
|
|
22
|
+
cancel_reason?: string | null;
|
|
23
|
+
is_deleted: boolean;
|
|
24
|
+
order_status_updated_at: Date;
|
|
25
|
+
is_reopened?: boolean;
|
|
26
|
+
order_settled_at: Date;
|
|
27
|
+
order_settled_at_mins: number;
|
|
28
|
+
createdAt_mins: number;
|
|
29
|
+
createdAt: Date;
|
|
30
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { USER_ROLES_ENUM } from '../../constants';
|
|
2
|
+
export interface IWarehouseStaff {
|
|
3
|
+
_id: string;
|
|
4
|
+
uid: string;
|
|
5
|
+
warehouse_id: string;
|
|
6
|
+
staff_auth_code: string | null;
|
|
7
|
+
email: string | null;
|
|
8
|
+
email_verified: boolean;
|
|
9
|
+
display_name: string | null;
|
|
10
|
+
image_url: string | null;
|
|
11
|
+
is_disabled: boolean;
|
|
12
|
+
phone_number: string;
|
|
13
|
+
phone_number_verified: boolean;
|
|
14
|
+
role: USER_ROLES_ENUM;
|
|
15
|
+
createdAt: Date;
|
|
16
|
+
updatedAt: Date;
|
|
17
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { 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, REMOVAL_STRATEGY_ENUM, TAX_INVOICE_PROVIDER_ENUM, TRACK_ORDER_NUMBER_ENUM } from '../../constants';
|
|
2
|
+
export interface IWarehouse {
|
|
3
|
+
_id: string;
|
|
4
|
+
brand_id: string;
|
|
5
|
+
name: string;
|
|
6
|
+
warehouse_address: string;
|
|
7
|
+
public_business_name: string;
|
|
8
|
+
support_email: string;
|
|
9
|
+
public_phone_numbers: string[];
|
|
10
|
+
image_url: string;
|
|
11
|
+
currency_code: CURRENCY_CODE_ENUM;
|
|
12
|
+
currency_symbol: CURRENCY_SYMBOL_ENUM;
|
|
13
|
+
currency_name: CURRENCY_NAME_ENUM;
|
|
14
|
+
country_code: COUNTRY_CODE_ENUM;
|
|
15
|
+
country_alpha_2: COUNTRY_ALPHA_2_ENUM;
|
|
16
|
+
country_alpha_3: COUNTRY_ALPHA_3_ENUM;
|
|
17
|
+
country_name: COUNTRY_NAME_ENUM;
|
|
18
|
+
country_flag: COUNTRY_FLAG_ENUM;
|
|
19
|
+
is_gst_inclusive?: boolean;
|
|
20
|
+
hide_gst_value?: boolean;
|
|
21
|
+
exclude_discount_from_gst?: boolean;
|
|
22
|
+
po_card_gst: number;
|
|
23
|
+
po_cash_gst: number;
|
|
24
|
+
invoice_card_gst: number;
|
|
25
|
+
invoice_cash_gst: number;
|
|
26
|
+
default_po_gst_type: GST_TYPE_ENUM;
|
|
27
|
+
default_invoice_gst_type: GST_TYPE_ENUM;
|
|
28
|
+
tax_business_number: string;
|
|
29
|
+
tax_invoice_provider?: TAX_INVOICE_PROVIDER_ENUM;
|
|
30
|
+
tax_invoice_generation_id?: string | null;
|
|
31
|
+
_tax_invoice_generation_token?: string | null;
|
|
32
|
+
track_purchase_order_number_by: TRACK_ORDER_NUMBER_ENUM;
|
|
33
|
+
track_invoice_number_by: TRACK_ORDER_NUMBER_ENUM;
|
|
34
|
+
operational_time_zone_offset_gmt: number;
|
|
35
|
+
operational_start_time: number;
|
|
36
|
+
operational_end_time: number;
|
|
37
|
+
coordinates: number[];
|
|
38
|
+
brand_color: string;
|
|
39
|
+
alert_phone_numbers: string[];
|
|
40
|
+
alert_email_addresses: string[];
|
|
41
|
+
alert_when: string[];
|
|
42
|
+
enable_lot_serial_tracking: boolean;
|
|
43
|
+
default_removal_strategy: REMOVAL_STRATEGY_ENUM;
|
|
44
|
+
po_custom_payment_types: string[];
|
|
45
|
+
invoice_custom_payment_types: string[];
|
|
46
|
+
active: boolean;
|
|
47
|
+
createdAt: Date;
|
|
48
|
+
updatedAt: Date;
|
|
49
|
+
}
|