@open-tender/types 0.4.13 → 0.4.14

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.
@@ -23,7 +23,6 @@ export * from './notifications';
23
23
  export * from './offlineAuths';
24
24
  export * from './order';
25
25
  export * from './orders';
26
- export * from './pos';
27
26
  export * from './refund';
28
27
  export * from './revenueCenter';
29
28
  export * from './settings';
@@ -11,7 +11,6 @@ tslib_1.__exportStar(require("./completedOrders"), exports);
11
11
  tslib_1.__exportStar(require("./config"), exports);
12
12
  tslib_1.__exportStar(require("./creditCards"), exports);
13
13
  tslib_1.__exportStar(require("./customer"), exports);
14
- // export * from './deals'
15
14
  tslib_1.__exportStar(require("./device"), exports);
16
15
  tslib_1.__exportStar(require("./discounts"), exports);
17
16
  tslib_1.__exportStar(require("./donations"), exports);
@@ -27,7 +26,6 @@ tslib_1.__exportStar(require("./notifications"), exports);
27
26
  tslib_1.__exportStar(require("./offlineAuths"), exports);
28
27
  tslib_1.__exportStar(require("./order"), exports);
29
28
  tslib_1.__exportStar(require("./orders"), exports);
30
- tslib_1.__exportStar(require("./pos"), exports);
31
29
  tslib_1.__exportStar(require("./refund"), exports);
32
30
  tslib_1.__exportStar(require("./revenueCenter"), exports);
33
31
  tslib_1.__exportStar(require("./settings"), exports);
@@ -1,4 +1,4 @@
1
- import { OrdersKds } from './pos';
1
+ import { Orders } from './order';
2
2
  export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
3
3
  export declare type PrepStatusMap = {
4
4
  [Property in PrepStatus]: PrepStatus;
@@ -47,6 +47,6 @@ export interface KdsStationCount {
47
47
  }
48
48
  export declare type KdsStationCounts = Record<string, KdsStationCount>;
49
49
  export interface OrdersAndStationCounts {
50
- orders: OrdersKds;
50
+ orders: Orders;
51
51
  stationCounts: KdsStationCounts | null;
52
52
  }
@@ -138,6 +138,15 @@ export interface OrderPrep {
138
138
  ready_at: ISOString | null;
139
139
  requested_at: ISOString;
140
140
  }
141
+ export interface OrderTicket {
142
+ display_order?: number;
143
+ item_nos: number[];
144
+ item_type_id: number;
145
+ item_type_name: string;
146
+ ticket_no?: number;
147
+ ticket_status: PrepStatus;
148
+ }
149
+ export declare type OrderTickets = OrderTicket[];
141
150
  export interface OrderRating {
142
151
  comments: string | null;
143
152
  rating: number;
@@ -272,6 +281,7 @@ export interface Order {
272
281
  surcharges: OrderSurcharges;
273
282
  taxes: OrderTaxes;
274
283
  tenders: OrderTenders;
284
+ tickets?: OrderTickets;
275
285
  timezone: TimezonePython;
276
286
  totals: OrderTotals;
277
287
  }
@@ -23,7 +23,6 @@ export * from './notifications';
23
23
  export * from './offlineAuths';
24
24
  export * from './order';
25
25
  export * from './orders';
26
- export * from './pos';
27
26
  export * from './refund';
28
27
  export * from './revenueCenter';
29
28
  export * from './settings';
@@ -8,7 +8,6 @@ export * from './completedOrders';
8
8
  export * from './config';
9
9
  export * from './creditCards';
10
10
  export * from './customer';
11
- // export * from './deals'
12
11
  export * from './device';
13
12
  export * from './discounts';
14
13
  export * from './donations';
@@ -24,7 +23,6 @@ export * from './notifications';
24
23
  export * from './offlineAuths';
25
24
  export * from './order';
26
25
  export * from './orders';
27
- export * from './pos';
28
26
  export * from './refund';
29
27
  export * from './revenueCenter';
30
28
  export * from './settings';
@@ -1,4 +1,4 @@
1
- import { OrdersKds } from './pos';
1
+ import { Orders } from './order';
2
2
  export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
3
3
  export declare type PrepStatusMap = {
4
4
  [Property in PrepStatus]: PrepStatus;
@@ -47,6 +47,6 @@ export interface KdsStationCount {
47
47
  }
48
48
  export declare type KdsStationCounts = Record<string, KdsStationCount>;
49
49
  export interface OrdersAndStationCounts {
50
- orders: OrdersKds;
50
+ orders: Orders;
51
51
  stationCounts: KdsStationCounts | null;
52
52
  }
@@ -138,6 +138,15 @@ export interface OrderPrep {
138
138
  ready_at: ISOString | null;
139
139
  requested_at: ISOString;
140
140
  }
141
+ export interface OrderTicket {
142
+ display_order?: number;
143
+ item_nos: number[];
144
+ item_type_id: number;
145
+ item_type_name: string;
146
+ ticket_no?: number;
147
+ ticket_status: PrepStatus;
148
+ }
149
+ export declare type OrderTickets = OrderTicket[];
141
150
  export interface OrderRating {
142
151
  comments: string | null;
143
152
  rating: number;
@@ -272,6 +281,7 @@ export interface Order {
272
281
  surcharges: OrderSurcharges;
273
282
  taxes: OrderTaxes;
274
283
  tenders: OrderTenders;
284
+ tickets?: OrderTickets;
275
285
  timezone: TimezonePython;
276
286
  totals: OrderTotals;
277
287
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-tender/types",
3
- "version": "0.4.13",
3
+ "version": "0.4.14",
4
4
  "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",
@@ -1,214 +0,0 @@
1
- import { DateString, ISOStringOffset, TimeString } from '../datetimes';
2
- import { ChannelType, Decimal, Money, NegativeMoney, OrderType, ReceiptType, ServiceType, SurchargeType, TaxType, Weekday } from '../global';
3
- import { PunchAuthType } from './employee';
4
- import { PrepStatus, TicketStatus } from './kds';
5
- import { Order, OrderCart, OrderItem } from './order';
6
- import { PaymentProcessing } from './store';
7
- export interface PosOrderItemGroup {
8
- id: number;
9
- name: string;
10
- options: PosOrderItemOptions;
11
- short_name: string;
12
- }
13
- export declare type PosOrderItemGroups = PosOrderItemGroup[];
14
- export interface PosOrderItem extends Omit<OrderItem, 'groups'> {
15
- item_no: number;
16
- line_no: number;
17
- groups: PosOrderItemGroups;
18
- }
19
- export declare type PosOrderItemOptions = PosOrderItem[];
20
- export declare type PosOrderCart = PosOrderItem[];
21
- export interface OrderTicket {
22
- display_order?: number;
23
- item_nos: number[];
24
- item_type_id: number;
25
- item_type_name: string;
26
- ticket_no?: number;
27
- ticket_status: PrepStatus;
28
- }
29
- export declare type OrderTickets = Array<OrderTicket>;
30
- export interface OrderPos extends Omit<Order, 'cart'> {
31
- cart: PosOrderCart;
32
- }
33
- export interface OrderKds extends Omit<Order, 'fire_at' | 'tickets' | 'expected_at'> {
34
- expected_at: ISOStringOffset;
35
- fire_at: ISOStringOffset;
36
- tickets: OrderTickets;
37
- }
38
- export declare type OrdersKds = Array<OrderKds>;
39
- export interface FetchOrdersArgs {
40
- businessDate?: DateString | null;
41
- receiptType?: ReceiptType | 'BOTH';
42
- channelType?: Array<ChannelType> | null;
43
- prepStatus?: Array<PrepStatus> | null;
44
- search?: string | null;
45
- sortBy?: 'requested_at' | 'expected_at' | 'fire_at';
46
- sortDirection?: 'ASC' | 'DESC';
47
- parentOrderId?: string;
48
- }
49
- export interface FetchOrdersAPIArgs {
50
- business_date?: DateString;
51
- receipt_type?: ReceiptType | 'BOTH';
52
- channel_type?: string;
53
- prep_status?: string;
54
- search?: string;
55
- sort_by?: 'requested_at' | 'expected_at' | 'fire_at';
56
- sort_direction?: 'ASC' | 'DESC';
57
- parent_receipt_uuid?: string;
58
- }
59
- export interface OrderCounts {
60
- current: Record<string, number> | null;
61
- future: Record<string, number> | null;
62
- qa: Record<string, number> | null;
63
- Orders: number;
64
- }
65
- export interface OrdersAndCounts {
66
- orders: OrdersKds;
67
- counts: OrderCounts;
68
- }
69
- export interface OrderUpdate {
70
- expected_at?: string;
71
- prep_status?: PrepStatus;
72
- }
73
- export interface OrderBucket {
74
- orders: OrdersKds;
75
- start: Date;
76
- end: Date;
77
- }
78
- export declare type OrderBuckets = Array<OrderBucket>;
79
- export interface PosOrderTimes {
80
- delayed: number;
81
- requested: Date;
82
- requestedTime: string;
83
- expected: Date;
84
- expectedDate: string;
85
- expectedTime: string;
86
- readyBy: Date;
87
- readyTime: string;
88
- dateStr: string;
89
- status: string;
90
- }
91
- export interface TicketUpdate {
92
- ticket_status: TicketStatus;
93
- }
94
- export interface TicketsUpdate {
95
- ticket_status?: TicketStatus;
96
- ticket_nos?: number[];
97
- }
98
- export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
99
- export interface Ticket {
100
- item_nos: number[];
101
- item_type_id: number;
102
- item_type_name: string;
103
- ticket_no: number;
104
- ticket_status: TicketStatus;
105
- items: OrderCart;
106
- is_default: boolean;
107
- is_grouped: boolean;
108
- is_hidden_assembly: boolean;
109
- is_hidden_qa: boolean;
110
- print_on_completed: boolean;
111
- }
112
- export declare type Tickets = Ticket[];
113
- export declare type TicketGroup = Ticket[];
114
- export declare type TicketGroups = TicketGroup[];
115
- export interface OrderKdsStatus {
116
- NOT_DONE: boolean;
117
- DONE: boolean;
118
- COMPLETED: boolean;
119
- }
120
- export interface OrderItemCount {
121
- item: OrderItem;
122
- count: number;
123
- }
124
- export interface OrderItemDiscount {
125
- discount_id: number;
126
- amount: NegativeMoney;
127
- amount_total: NegativeMoney;
128
- }
129
- export declare type OrderItemDiscounts = Array<OrderItemDiscount>;
130
- export interface OrderItemTax {
131
- tax_id: number;
132
- name: string;
133
- amount: NegativeMoney;
134
- amount_total: NegativeMoney;
135
- }
136
- export declare type OrderItemTaxes = Array<OrderItemTax>;
137
- export interface OrderSurchargeDiscount {
138
- amount: NegativeMoney;
139
- discount_id: number;
140
- employee_id: number | null;
141
- }
142
- export interface OrderSurchargeTax {
143
- tax_id: number;
144
- name: string;
145
- amount: NegativeMoney;
146
- amount_total: NegativeMoney;
147
- }
148
- export interface PosOrderSurcharge {
149
- amount: Money;
150
- discount: NegativeMoney;
151
- discounts: Array<OrderSurchargeDiscount>;
152
- description?: string;
153
- employee_id: number | null;
154
- id: number;
155
- surcharge_id?: number;
156
- is_optional?: boolean;
157
- is_taxed: boolean;
158
- label?: string;
159
- name: string;
160
- percentage: Decimal | null;
161
- surcharge_type: SurchargeType;
162
- tax: Money;
163
- taxes: Array<OrderSurchargeTax>;
164
- }
165
- export declare type PosOrderSurcharges = Array<PosOrderSurcharge>;
166
- export interface PosRevenueCenterTax {
167
- amount: Decimal;
168
- display_order: number;
169
- is_active: boolean;
170
- is_optional: boolean;
171
- name: string;
172
- tax_id: number;
173
- tax_type: TaxType;
174
- }
175
- export interface PosRevenueCenter {
176
- credit: PaymentProcessing;
177
- dine_in_prompt: boolean;
178
- dine_in_show: boolean;
179
- end_of_day: TimeString;
180
- greeting: string;
181
- has_loyalty: boolean;
182
- is_closed: boolean;
183
- is_outpost: boolean;
184
- is_temporarily_closed: boolean;
185
- item_discount_approval: boolean;
186
- name: string;
187
- olo_print_device_id: number;
188
- olo_print_order_type: 'BOTH_OLO_CATERING' | 'OLO_ONLY' | 'CATERING_ONLY';
189
- olo_print_server_id: number;
190
- olo_print_stage: 'PLACED' | 'FIRED' | 'CONFIRMED';
191
- order_page_swipe: boolean;
192
- overtime_threshold: number;
193
- overtime_threshold_daily: number;
194
- page_timeout: number;
195
- punch_type: PunchAuthType;
196
- receipt_footer: string;
197
- receipt_header: string;
198
- receipt_phone: boolean;
199
- revenue_center_id: number;
200
- revenue_center_type: OrderType;
201
- send_offline_alerts: boolean;
202
- service_types: Array<ServiceType>;
203
- short_name: string;
204
- slug: string;
205
- starting_cash: Money;
206
- tax_exempt_approval: boolean;
207
- taxes: Array<PosRevenueCenterTax>;
208
- week_start_day: Weekday;
209
- delivery_wait_time_id: number | null;
210
- temporary_delivery_wait_time_id: number | null;
211
- pickup_wait_time_id: number | null;
212
- temporary_pickup_wait_time_id: number | null;
213
- distance?: number;
214
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,214 +0,0 @@
1
- import { DateString, ISOStringOffset, TimeString } from '../datetimes';
2
- import { ChannelType, Decimal, Money, NegativeMoney, OrderType, ReceiptType, ServiceType, SurchargeType, TaxType, Weekday } from '../global';
3
- import { PunchAuthType } from './employee';
4
- import { PrepStatus, TicketStatus } from './kds';
5
- import { Order, OrderCart, OrderItem } from './order';
6
- import { PaymentProcessing } from './store';
7
- export interface PosOrderItemGroup {
8
- id: number;
9
- name: string;
10
- options: PosOrderItemOptions;
11
- short_name: string;
12
- }
13
- export declare type PosOrderItemGroups = PosOrderItemGroup[];
14
- export interface PosOrderItem extends Omit<OrderItem, 'groups'> {
15
- item_no: number;
16
- line_no: number;
17
- groups: PosOrderItemGroups;
18
- }
19
- export declare type PosOrderItemOptions = PosOrderItem[];
20
- export declare type PosOrderCart = PosOrderItem[];
21
- export interface OrderTicket {
22
- display_order?: number;
23
- item_nos: number[];
24
- item_type_id: number;
25
- item_type_name: string;
26
- ticket_no?: number;
27
- ticket_status: PrepStatus;
28
- }
29
- export declare type OrderTickets = Array<OrderTicket>;
30
- export interface OrderPos extends Omit<Order, 'cart'> {
31
- cart: PosOrderCart;
32
- }
33
- export interface OrderKds extends Omit<Order, 'fire_at' | 'tickets' | 'expected_at'> {
34
- expected_at: ISOStringOffset;
35
- fire_at: ISOStringOffset;
36
- tickets: OrderTickets;
37
- }
38
- export declare type OrdersKds = Array<OrderKds>;
39
- export interface FetchOrdersArgs {
40
- businessDate?: DateString | null;
41
- receiptType?: ReceiptType | 'BOTH';
42
- channelType?: Array<ChannelType> | null;
43
- prepStatus?: Array<PrepStatus> | null;
44
- search?: string | null;
45
- sortBy?: 'requested_at' | 'expected_at' | 'fire_at';
46
- sortDirection?: 'ASC' | 'DESC';
47
- parentOrderId?: string;
48
- }
49
- export interface FetchOrdersAPIArgs {
50
- business_date?: DateString;
51
- receipt_type?: ReceiptType | 'BOTH';
52
- channel_type?: string;
53
- prep_status?: string;
54
- search?: string;
55
- sort_by?: 'requested_at' | 'expected_at' | 'fire_at';
56
- sort_direction?: 'ASC' | 'DESC';
57
- parent_receipt_uuid?: string;
58
- }
59
- export interface OrderCounts {
60
- current: Record<string, number> | null;
61
- future: Record<string, number> | null;
62
- qa: Record<string, number> | null;
63
- Orders: number;
64
- }
65
- export interface OrdersAndCounts {
66
- orders: OrdersKds;
67
- counts: OrderCounts;
68
- }
69
- export interface OrderUpdate {
70
- expected_at?: string;
71
- prep_status?: PrepStatus;
72
- }
73
- export interface OrderBucket {
74
- orders: OrdersKds;
75
- start: Date;
76
- end: Date;
77
- }
78
- export declare type OrderBuckets = Array<OrderBucket>;
79
- export interface PosOrderTimes {
80
- delayed: number;
81
- requested: Date;
82
- requestedTime: string;
83
- expected: Date;
84
- expectedDate: string;
85
- expectedTime: string;
86
- readyBy: Date;
87
- readyTime: string;
88
- dateStr: string;
89
- status: string;
90
- }
91
- export interface TicketUpdate {
92
- ticket_status: TicketStatus;
93
- }
94
- export interface TicketsUpdate {
95
- ticket_status?: TicketStatus;
96
- ticket_nos?: number[];
97
- }
98
- export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
99
- export interface Ticket {
100
- item_nos: number[];
101
- item_type_id: number;
102
- item_type_name: string;
103
- ticket_no: number;
104
- ticket_status: TicketStatus;
105
- items: OrderCart;
106
- is_default: boolean;
107
- is_grouped: boolean;
108
- is_hidden_assembly: boolean;
109
- is_hidden_qa: boolean;
110
- print_on_completed: boolean;
111
- }
112
- export declare type Tickets = Ticket[];
113
- export declare type TicketGroup = Ticket[];
114
- export declare type TicketGroups = TicketGroup[];
115
- export interface OrderKdsStatus {
116
- NOT_DONE: boolean;
117
- DONE: boolean;
118
- COMPLETED: boolean;
119
- }
120
- export interface OrderItemCount {
121
- item: OrderItem;
122
- count: number;
123
- }
124
- export interface OrderItemDiscount {
125
- discount_id: number;
126
- amount: NegativeMoney;
127
- amount_total: NegativeMoney;
128
- }
129
- export declare type OrderItemDiscounts = Array<OrderItemDiscount>;
130
- export interface OrderItemTax {
131
- tax_id: number;
132
- name: string;
133
- amount: NegativeMoney;
134
- amount_total: NegativeMoney;
135
- }
136
- export declare type OrderItemTaxes = Array<OrderItemTax>;
137
- export interface OrderSurchargeDiscount {
138
- amount: NegativeMoney;
139
- discount_id: number;
140
- employee_id: number | null;
141
- }
142
- export interface OrderSurchargeTax {
143
- tax_id: number;
144
- name: string;
145
- amount: NegativeMoney;
146
- amount_total: NegativeMoney;
147
- }
148
- export interface PosOrderSurcharge {
149
- amount: Money;
150
- discount: NegativeMoney;
151
- discounts: Array<OrderSurchargeDiscount>;
152
- description?: string;
153
- employee_id: number | null;
154
- id: number;
155
- surcharge_id?: number;
156
- is_optional?: boolean;
157
- is_taxed: boolean;
158
- label?: string;
159
- name: string;
160
- percentage: Decimal | null;
161
- surcharge_type: SurchargeType;
162
- tax: Money;
163
- taxes: Array<OrderSurchargeTax>;
164
- }
165
- export declare type PosOrderSurcharges = Array<PosOrderSurcharge>;
166
- export interface PosRevenueCenterTax {
167
- amount: Decimal;
168
- display_order: number;
169
- is_active: boolean;
170
- is_optional: boolean;
171
- name: string;
172
- tax_id: number;
173
- tax_type: TaxType;
174
- }
175
- export interface PosRevenueCenter {
176
- credit: PaymentProcessing;
177
- dine_in_prompt: boolean;
178
- dine_in_show: boolean;
179
- end_of_day: TimeString;
180
- greeting: string;
181
- has_loyalty: boolean;
182
- is_closed: boolean;
183
- is_outpost: boolean;
184
- is_temporarily_closed: boolean;
185
- item_discount_approval: boolean;
186
- name: string;
187
- olo_print_device_id: number;
188
- olo_print_order_type: 'BOTH_OLO_CATERING' | 'OLO_ONLY' | 'CATERING_ONLY';
189
- olo_print_server_id: number;
190
- olo_print_stage: 'PLACED' | 'FIRED' | 'CONFIRMED';
191
- order_page_swipe: boolean;
192
- overtime_threshold: number;
193
- overtime_threshold_daily: number;
194
- page_timeout: number;
195
- punch_type: PunchAuthType;
196
- receipt_footer: string;
197
- receipt_header: string;
198
- receipt_phone: boolean;
199
- revenue_center_id: number;
200
- revenue_center_type: OrderType;
201
- send_offline_alerts: boolean;
202
- service_types: Array<ServiceType>;
203
- short_name: string;
204
- slug: string;
205
- starting_cash: Money;
206
- tax_exempt_approval: boolean;
207
- taxes: Array<PosRevenueCenterTax>;
208
- week_start_day: Weekday;
209
- delivery_wait_time_id: number | null;
210
- temporary_delivery_wait_time_id: number | null;
211
- pickup_wait_time_id: number | null;
212
- temporary_pickup_wait_time_id: number | null;
213
- distance?: number;
214
- }
@@ -1 +0,0 @@
1
- export {};