@compassdigital/sdk.typescript 4.225.0 → 4.227.0

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 (14) hide show
  1. package/lib/messages/events/OrderCreatedEvent.d.ts +231 -0
  2. package/lib/messages/events/OrderCreatedEvent.d.ts.map +1 -0
  3. package/lib/messages/events/OrderCreatedEvent.js +4 -0
  4. package/lib/messages/events/OrderCreatedEvent.js.map +1 -0
  5. package/lib/messages/events/PublishedMenuUpdatedEvent.d.ts +57 -0
  6. package/lib/messages/events/PublishedMenuUpdatedEvent.d.ts.map +1 -0
  7. package/lib/messages/events/PublishedMenuUpdatedEvent.js +4 -0
  8. package/lib/messages/events/PublishedMenuUpdatedEvent.js.map +1 -0
  9. package/lib/messages/events/index.d.ts +2 -0
  10. package/lib/messages/events/index.d.ts.map +1 -1
  11. package/package.json +1 -1
  12. package/src/messages/events/OrderCreatedEvent.ts +295 -0
  13. package/src/messages/events/PublishedMenuUpdatedEvent.ts +66 -0
  14. package/src/messages/events/index.ts +4 -0
package/lib/messages/events/OrderCreatedEvent.d.ts ADDED
@@ -0,0 +1,231 @@
1
+ export interface OrderCreatedEvent {
2
+ id: string;
3
+ type: 'OrderCreatedEvent';
4
+ version: '0.0.1';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceId?: string;
8
+ };
9
+ payload: {
10
+ order?: {
11
+ id?: string;
12
+ locationBrand?: string;
13
+ location?: string;
14
+ shoppingcart?: string;
15
+ payment?: {
16
+ token?: string;
17
+ creditCard?: {
18
+ cardType?: string;
19
+ last4?: string;
20
+ };
21
+ digitalWalletPay?: string;
22
+ badgePay?: {
23
+ id?: string;
24
+ tender?: string;
25
+ name?: string;
26
+ total?: number;
27
+ };
28
+ stipend?: {
29
+ id?: string;
30
+ tender?: string;
31
+ name?: string;
32
+ total?: number;
33
+ };
34
+ voucher?: {
35
+ id?: string;
36
+ tender?: string;
37
+ name?: string;
38
+ total?: number;
39
+ };
40
+ couponVoucher?: {
41
+ id?: string;
42
+ tender?: string;
43
+ name?: string;
44
+ total?: number;
45
+ };
46
+ pos?: {
47
+ provider?: string;
48
+ transactionId?: string;
49
+ [index: string]: any;
50
+ };
51
+ };
52
+ mealplan?: {
53
+ id?: string;
54
+ tender?: string;
55
+ name?: string;
56
+ };
57
+ mealSwipes?: {
58
+ id?: string;
59
+ tender?: string;
60
+ tenderName?: string;
61
+ swipes?: number;
62
+ total?: number;
63
+ };
64
+ mealExchange?: {
65
+ id?: string;
66
+ tender?: string;
67
+ name?: string;
68
+ };
69
+ customer?: string;
70
+ is?: {
71
+ accepted?: boolean;
72
+ inProgress?: boolean;
73
+ ready?: boolean;
74
+ outForDelivery?: boolean;
75
+ delivered?: boolean;
76
+ checkinOrder?: boolean;
77
+ diningHallOrder?: boolean;
78
+ noShow?: boolean;
79
+ collected?: boolean;
80
+ cancelled?: boolean;
81
+ };
82
+ date?: {
83
+ accepted?: string;
84
+ created?: string;
85
+ modified?: string;
86
+ shouldStart?: string;
87
+ completionWarning?: string;
88
+ ready?: string;
89
+ started?: string;
90
+ showAsActiveUntil?: string;
91
+ noShow?: string;
92
+ collected?: string;
93
+ delivered?: string;
94
+ pickup?: string;
95
+ cancelled?: string;
96
+ polled?: string;
97
+ };
98
+ pickup?: string;
99
+ pickupName?: string;
100
+ pickupId?: string;
101
+ requestedDate?: string;
102
+ details?: {
103
+ name?: string;
104
+ displayId?: string;
105
+ contactNumber?: string;
106
+ countryCode?: string;
107
+ orderType?: string;
108
+ duration?: string;
109
+ destination?: string;
110
+ instructions?: string;
111
+ receiptEmail?: string;
112
+ };
113
+ meta?: {
114
+ checkinUuid?: string;
115
+ refunds?: {
116
+ originalShoppingcart?: string;
117
+ refundDate?: string;
118
+ [index: string]: any;
119
+ }[];
120
+ source?: 'web' | 'mobile' | 'pos';
121
+ transaction?: {
122
+ mxTotals?: {
123
+ amount?: number;
124
+ meals?: number;
125
+ };
126
+ transactionRemainderAmount?: number;
127
+ [index: string]: any;
128
+ };
129
+ shoppingcart?: {
130
+ total?: {
131
+ amount?: number;
132
+ meals?: number;
133
+ };
134
+ originalTotal?: {
135
+ amount?: number;
136
+ meals?: number;
137
+ };
138
+ [index: string]: any;
139
+ };
140
+ active?: boolean;
141
+ activeOverride?: boolean;
142
+ delivery?: {
143
+ provider?: string;
144
+ trackerUrl?: string;
145
+ loadingCode?: string;
146
+ [index: string]: any;
147
+ };
148
+ discount?: {
149
+ app?: string;
150
+ code?: string;
151
+ [index: string]: any;
152
+ };
153
+ discounts?: {
154
+ app?: string;
155
+ code?: string;
156
+ [index: string]: any;
157
+ }[];
158
+ discountsRefund?: {
159
+ app?: string;
160
+ date?: string;
161
+ orderCreatedAt?: string;
162
+ orderId?: string;
163
+ orderItems?: {
164
+ sourceId?: string;
165
+ quantity?: number;
166
+ price?: number;
167
+ }[];
168
+ orderTotal?: number;
169
+ reason?: string;
170
+ redemptionId?: string;
171
+ result?: boolean;
172
+ [index: string]: any;
173
+ };
174
+ typeOfKds?: string;
175
+ cancelEligible?: boolean;
176
+ pickupInstruction?: {
177
+ en?: string;
178
+ fr?: string;
179
+ };
180
+ marketPlaceLabel?: {
181
+ en?: string;
182
+ fr?: string;
183
+ };
184
+ marketPlaceDescription?: {
185
+ en?: string;
186
+ fr?: string;
187
+ };
188
+ apexCode?: string;
189
+ apexQr?: string;
190
+ apexCodes?: {
191
+ customerCode?: {
192
+ qrExpiryDate?: string;
193
+ };
194
+ [index: string]: any;
195
+ };
196
+ [index: string]: any;
197
+ };
198
+ issue?: {
199
+ id?: string;
200
+ type?: string;
201
+ items?: any;
202
+ [index: string]: any;
203
+ };
204
+ pastIssues?: {
205
+ id?: string;
206
+ type?: string;
207
+ items?: any;
208
+ [index: string]: any;
209
+ }[];
210
+ runner?: string;
211
+ reorderEligibility?: 'eligible' | 'order_type_ineligible' | 'location_ineligible' | 'active_order' | 'old_order' | 'marketplace_order' | 'duplicate_order' | 'brand_unavailable' | 'menu_unavailable' | 'items_unavailable' | 'refunded_order' | 'modifiers_unavailable' | 'modified_items' | 'cancelled_order';
212
+ refunds?: {
213
+ id?: string;
214
+ amount?: number;
215
+ reason?: string;
216
+ date?: string;
217
+ [index: string]: any;
218
+ }[];
219
+ latestRefunds?: {
220
+ id?: string;
221
+ amount?: number;
222
+ reason?: string;
223
+ date?: string;
224
+ [index: string]: any;
225
+ }[];
226
+ [index: string]: any;
227
+ };
228
+ };
229
+ source: string;
230
+ }
231
+ //# sourceMappingURL=OrderCreatedEvent.d.ts.map
package/lib/messages/events/OrderCreatedEvent.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OrderCreatedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/OrderCreatedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,KAAK,CAAC,EAAE;YAEP,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,OAAO,CAAC,EAAE;gBACT,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,UAAU,CAAC,EAAE;oBACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;oBAClB,KAAK,CAAC,EAAE,MAAM,CAAC;iBACf,CAAC;gBACF,gBAAgB,CAAC,EAAE,MAAM,CAAC;gBAC1B,QAAQ,CAAC,EAAE;oBACV,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,KAAK,CAAC,EAAE,MAAM,CAAC;iBACf,CAAC;gBACF,OAAO,CAAC,EAAE;oBACT,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,KAAK,CAAC,EAAE,MAAM,CAAC;iBACf,CAAC;gBACF,OAAO,CAAC,EAAE;oBACT,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,KAAK,CAAC,EAAE,MAAM,CAAC;iBACf,CAAC;gBACF,aAAa,CAAC,EAAE;oBACf,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,KAAK,CAAC,EAAE,MAAM,CAAC;iBACf,CAAC;gBACF,GAAG,CAAC,EAAE;oBACL,QAAQ,CAAC,EAAE,MAAM,CAAC;oBAClB,aAAa,CAAC,EAAE,MAAM,CAAC;oBACvB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;aACF,CAAC;YACF,QAAQ,CAAC,EAAE;gBACV,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;YACF,UAAU,CAAC,EAAE;gBACZ,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;aACf,CAAC;YACF,YAAY,CAAC,EAAE;gBACd,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;YAEF,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,EAAE,CAAC,EAAE;gBACJ,QAAQ,CAAC,EAAE,OAAO,CAAC;gBACnB,UAAU,CAAC,EAAE,OAAO,CAAC;gBACrB,KAAK,CAAC,EAAE,OAAO,CAAC;gBAChB,cAAc,CAAC,EAAE,OAAO,CAAC;gBACzB,SAAS,CAAC,EAAE,OAAO,CAAC;gBACpB,YAAY,CAAC,EAAE,OAAO,CAAC;gBACvB,eAAe,CAAC,EAAE,OAAO,CAAC;gBAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;gBACjB,SAAS,CAAC,EAAE,OAAO,CAAC;gBACpB,SAAS,CAAC,EAAE,OAAO,CAAC;aACpB,CAAC;YACF,IAAI,CAAC,EAAE;gBAEN,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,OAAO,CAAC,EAAE,MAAM,CAAC;gBACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAE3B,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;aAChB,CAAC;YAEF,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,OAAO,CAAC,EAAE;gBACT,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,SAAS,CAAC,EAAE,MAAM,CAAC;gBACnB,aAAa,CAAC,EAAE,MAAM,CAAC;gBACvB,WAAW,CAAC,EAAE,MAAM,CAAC;gBACrB,SAAS,CAAC,EAAE,MAAM,CAAC;gBACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;aACtB,CAAC;YACF,IAAI,CAAC,EAAE;gBAEN,WAAW,CAAC,EAAE,MAAM,CAAC;gBACrB,OAAO,CAAC,EAAE;oBACT,oBAAoB,CAAC,EAAE,MAAM,CAAC;oBAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;oBACpB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,EAAE,CAAC;gBAEJ,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,KAAK,CAAC;gBAElC,WAAW,CAAC,EAAE;oBAEb,QAAQ,CAAC,EAAE;wBACV,MAAM,CAAC,EAAE,MAAM,CAAC;wBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;qBACf,CAAC;oBAEF,0BAA0B,CAAC,EAAE,MAAM,CAAC;oBACpC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBAEF,YAAY,CAAC,EAAE;oBACd,KAAK,CAAC,EAAE;wBACP,MAAM,CAAC,EAAE,MAAM,CAAC;wBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;qBACf,CAAC;oBAEF,aAAa,CAAC,EAAE;wBACf,MAAM,CAAC,EAAE,MAAM,CAAC;wBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;qBACf,CAAC;oBACF,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBAEF,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEjB,cAAc,CAAC,EAAE,OAAO,CAAC;gBAEzB,QAAQ,CAAC,EAAE;oBACV,QAAQ,CAAC,EAAE,MAAM,CAAC;oBAClB,UAAU,CAAC,EAAE,MAAM,CAAC;oBACpB,WAAW,CAAC,EAAE,MAAM,CAAC;oBACrB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBAEF,QAAQ,CAAC,EAAE;oBACV,GAAG,CAAC,EAAE,MAAM,CAAC;oBACb,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBACF,SAAS,CAAC,EAAE;oBACX,GAAG,CAAC,EAAE,MAAM,CAAC;oBACb,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,EAAE,CAAC;gBAEJ,eAAe,CAAC,EAAE;oBAEjB,GAAG,CAAC,EAAE,MAAM,CAAC;oBAEb,IAAI,CAAC,EAAE,MAAM,CAAC;oBAEd,cAAc,CAAC,EAAE,MAAM,CAAC;oBAExB,OAAO,CAAC,EAAE,MAAM,CAAC;oBAEjB,UAAU,CAAC,EAAE;wBAEZ,QAAQ,CAAC,EAAE,MAAM,CAAC;wBAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;wBAElB,KAAK,CAAC,EAAE,MAAM,CAAC;qBACf,EAAE,CAAC;oBAEJ,UAAU,CAAC,EAAE,MAAM,CAAC;oBAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;oBAEhB,YAAY,CAAC,EAAE,MAAM,CAAC;oBAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;oBACjB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBAEF,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,cAAc,CAAC,EAAE,OAAO,CAAC;gBACzB,iBAAiB,CAAC,EAAE;oBACnB,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,EAAE,CAAC,EAAE,MAAM,CAAC;iBACZ,CAAC;gBACF,gBAAgB,CAAC,EAAE;oBAClB,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,EAAE,CAAC,EAAE,MAAM,CAAC;iBACZ,CAAC;gBACF,sBAAsB,CAAC,EAAE;oBACxB,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,EAAE,CAAC,EAAE,MAAM,CAAC;iBACZ,CAAC;gBACF,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,SAAS,CAAC,EAAE;oBACX,YAAY,CAAC,EAAE;wBACd,YAAY,CAAC,EAAE,MAAM,CAAC;qBACtB,CAAC;oBACF,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;iBACrB,CAAC;gBACF,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;aACrB,CAAC;YACF,KAAK,CAAC,EAAE;gBACP,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,KAAK,CAAC,EAAE,GAAG,CAAC;gBACZ,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;aACrB,CAAC;YACF,UAAU,CAAC,EAAE;gBACZ,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,KAAK,CAAC,EAAE,GAAG,CAAC;gBACZ,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;aACrB,EAAE,CAAC;YAEJ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,kBAAkB,CAAC,EAChB,UAAU,GACV,uBAAuB,GACvB,qBAAqB,GACrB,cAAc,GACd,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,uBAAuB,GACvB,gBAAgB,GAChB,iBAAiB,CAAC;YACrB,OAAO,CAAC,EAAE;gBACT,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;aACrB,EAAE,CAAC;YACJ,aAAa,CAAC,EAAE;gBACf,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;aACrB,EAAE,CAAC;YACJ,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;SACrB,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
package/lib/messages/events/OrderCreatedEvent.js ADDED
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=OrderCreatedEvent.js.map
package/lib/messages/events/OrderCreatedEvent.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OrderCreatedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/OrderCreatedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
package/lib/messages/events/PublishedMenuUpdatedEvent.d.ts ADDED
@@ -0,0 +1,57 @@
1
+ export interface PublishedMenuUpdatedEvent {
2
+ id: string;
3
+ type: 'PublishedMenuUpdatedEvent';
4
+ version: '1.0.0';
5
+ timestamp: string;
6
+ traceContext: {
7
+ traceId?: string;
8
+ };
9
+ payload: {
10
+ menu: {
11
+ id: string;
12
+ date?: {
13
+ created?: string;
14
+ modified?: string;
15
+ published?: string;
16
+ };
17
+ label?: {
18
+ en?: string;
19
+ };
20
+ groups?: Record<string, any>[];
21
+ parentId?: string;
22
+ locationBrand?: string;
23
+ company?: string;
24
+ sector?: string;
25
+ is?: {
26
+ disabled?: boolean;
27
+ hidden?: boolean;
28
+ linked?: boolean;
29
+ promoExemptionsEnabled?: boolean;
30
+ pluEnabled?: boolean;
31
+ itemImagesEnabled?: boolean;
32
+ itemShowcaseEnabled?: boolean;
33
+ itemDescEditEnabled?: boolean;
34
+ caloriesEditEnabled?: boolean;
35
+ itemLabelEditEnabled?: boolean;
36
+ frictionless?: boolean;
37
+ categoryImagesEnabled?: boolean;
38
+ };
39
+ meta?: {
40
+ lockedByUser?: string;
41
+ lastModifiedUser?: string;
42
+ centricos?: boolean;
43
+ version?: number;
44
+ brand?: {
45
+ id?: string;
46
+ name?: string;
47
+ };
48
+ localMenuGroup?: {
49
+ id?: string;
50
+ name?: string;
51
+ };
52
+ };
53
+ };
54
+ };
55
+ source: string;
56
+ }
57
+ //# sourceMappingURL=PublishedMenuUpdatedEvent.d.ts.map
package/lib/messages/events/PublishedMenuUpdatedEvent.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PublishedMenuUpdatedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/PublishedMenuUpdatedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,yBAAyB;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE;YAEL,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,CAAC,EAAE;gBACN,OAAO,CAAC,EAAE,MAAM,CAAC;gBACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,SAAS,CAAC,EAAE,MAAM,CAAC;aACnB,CAAC;YACF,KAAK,CAAC,EAAE;gBACP,EAAE,CAAC,EAAE,MAAM,CAAC;aACZ,CAAC;YAEF,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YAE/B,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,EAAE,CAAC,EAAE;gBACJ,QAAQ,CAAC,EAAE,OAAO,CAAC;gBACnB,MAAM,CAAC,EAAE,OAAO,CAAC;gBACjB,MAAM,CAAC,EAAE,OAAO,CAAC;gBACjB,sBAAsB,CAAC,EAAE,OAAO,CAAC;gBACjC,UAAU,CAAC,EAAE,OAAO,CAAC;gBACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;gBAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;gBAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;gBAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;gBAC9B,oBAAoB,CAAC,EAAE,OAAO,CAAC;gBAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;gBACvB,qBAAqB,CAAC,EAAE,OAAO,CAAC;aAChC,CAAC;YACF,IAAI,CAAC,EAAE;gBAEN,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;gBAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;gBACpB,OAAO,CAAC,EAAE,MAAM,CAAC;gBACjB,KAAK,CAAC,EAAE;oBACP,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,IAAI,CAAC,EAAE,MAAM,CAAC;iBACd,CAAC;gBACF,cAAc,CAAC,EAAE;oBAChB,EAAE,CAAC,EAAE,MAAM,CAAC;oBACZ,IAAI,CAAC,EAAE,MAAM,CAAC;iBACd,CAAC;aACF,CAAC;SACF,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
package/lib/messages/events/PublishedMenuUpdatedEvent.js ADDED
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=PublishedMenuUpdatedEvent.js.map
package/lib/messages/events/PublishedMenuUpdatedEvent.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PublishedMenuUpdatedEvent.js","sourceRoot":"","sources":["../../../src/messages/events/PublishedMenuUpdatedEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}
package/lib/messages/events/index.d.ts CHANGED
@@ -5,4 +5,6 @@ export { FakeEvent } from './FakeEvent';
5
5
  export { LocationCreatedEvent } from './LocationCreatedEvent';
6
6
  export { LocationUpdatedEvent } from './LocationUpdatedEvent';
7
7
  export { OrderCompletedEvent } from './OrderCompletedEvent';
8
+ export { OrderCreatedEvent } from './OrderCreatedEvent';
9
+ export { PublishedMenuUpdatedEvent } from './PublishedMenuUpdatedEvent';
8
10
  //# sourceMappingURL=index.d.ts.map
package/lib/messages/events/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.225.0",
3
+ "version": "4.227.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/messages/events/OrderCreatedEvent.ts ADDED
@@ -0,0 +1,295 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface OrderCreatedEvent {
4
+ id: string;
5
+ type: 'OrderCreatedEvent';
6
+ version: '0.0.1';
7
+ timestamp: string;
8
+ traceContext: {
9
+ traceId?: string;
10
+ };
11
+ payload: {
12
+ order?: {
13
+ // order id
14
+ id?: string;
15
+ // The CDL id representing the brand location
16
+ locationBrand?: string;
17
+ // The CDL id representing the location
18
+ location?: string;
19
+ // The CDL id representing the shopping cart
20
+ shoppingcart?: string;
21
+ payment?: {
22
+ token?: string;
23
+ creditCard?: {
24
+ cardType?: string;
25
+ last4?: string;
26
+ };
27
+ digitalWalletPay?: string;
28
+ badgePay?: {
29
+ id?: string;
30
+ tender?: string;
31
+ name?: string;
32
+ total?: number;
33
+ };
34
+ stipend?: {
35
+ id?: string;
36
+ tender?: string;
37
+ name?: string;
38
+ total?: number;
39
+ };
40
+ voucher?: {
41
+ id?: string;
42
+ tender?: string;
43
+ name?: string;
44
+ total?: number;
45
+ };
46
+ couponVoucher?: {
47
+ id?: string;
48
+ tender?: string;
49
+ name?: string;
50
+ total?: number;
51
+ };
52
+ pos?: {
53
+ provider?: string;
54
+ transactionId?: string;
55
+ [index: string]: any;
56
+ };
57
+ };
58
+ mealplan?: {
59
+ id?: string;
60
+ tender?: string;
61
+ name?: string;
62
+ };
63
+ mealSwipes?: {
64
+ id?: string;
65
+ tender?: string;
66
+ tenderName?: string;
67
+ swipes?: number;
68
+ total?: number;
69
+ };
70
+ mealExchange?: {
71
+ id?: string;
72
+ tender?: string;
73
+ name?: string;
74
+ };
75
+ // The CDL id representing the customer
76
+ customer?: string;
77
+ is?: {
78
+ accepted?: boolean;
79
+ inProgress?: boolean;
80
+ ready?: boolean;
81
+ outForDelivery?: boolean;
82
+ delivered?: boolean;
83
+ checkinOrder?: boolean;
84
+ diningHallOrder?: boolean;
85
+ noShow?: boolean;
86
+ collected?: boolean;
87
+ cancelled?: boolean;
88
+ };
89
+ date?: {
90
+ // Date order was accepted into our system and shown on kitchen apps
91
+ accepted?: string;
92
+ created?: string;
93
+ modified?: string;
94
+ // Date kitchen should start preparation ideally(not mandatory)
95
+ shouldStart?: string;
96
+ // Date kitchen should be half way preparation ideally(not mandatory)
97
+ completionWarning?: string;
98
+ // Date kitchen finished preparation
99
+ ready?: string;
100
+ // Date kitchen started preparation
101
+ started?: string;
102
+ // Date till which show orders as active
103
+ showAsActiveUntil?: string;
104
+ // For delivery orders - date customer did not pick the order
105
+ noShow?: string;
106
+ // For delivery orders - date customer completed the order collected and sent back robot
107
+ collected?: string;
108
+ // For delivery orders - date order was delivered to destination(not picked by user)
109
+ delivered?: string;
110
+ // For delivery orders - date order was picked up from station for delivery(out_for_delivery)
111
+ pickup?: string;
112
+ // Date order was cancelled
113
+ cancelled?: string;
114
+ // Date order was polled for kds
115
+ polled?: string;
116
+ };
117
+ // @deprecated
118
+ pickup?: string;
119
+ // @deprecated
120
+ pickupName?: string;
121
+ // @deprecated
122
+ pickupId?: string;
123
+ requestedDate?: string;
124
+ details?: {
125
+ name?: string;
126
+ displayId?: string;
127
+ contactNumber?: string;
128
+ countryCode?: string;
129
+ orderType?: string;
130
+ duration?: string;
131
+ destination?: string;
132
+ // Pickup or delivery instructions
133
+ instructions?: string;
134
+ // Email address for receipt
135
+ receiptEmail?: string;
136
+ };
137
+ meta?: {
138
+ // Check-in UUID for frictionless orders
139
+ checkinUuid?: string;
140
+ refunds?: {
141
+ originalShoppingcart?: string;
142
+ refundDate?: string;
143
+ [index: string]: any;
144
+ }[];
145
+ // which ui the order was placed on
146
+ source?: 'web' | 'mobile' | 'pos';
147
+ // details pertaining to the amount charged on the order
148
+ transaction?: {
149
+ // used in mx orders - cart totals in dollars and meal exchange value (meals)
150
+ mxTotals?: {
151
+ amount?: number;
152
+ meals?: number;
153
+ };
154
+ // the amount remaining on the transaction after refund - remaining amount available for refund
155
+ transactionRemainderAmount?: number;
156
+ [index: string]: any;
157
+ };
158
+ // Shoppingcart details
159
+ shoppingcart?: {
160
+ total?: {
161
+ amount?: number;
162
+ meals?: number;
163
+ };
164
+ // Total of first cart on order. Carts can change after refunds, so this is original value
165
+ originalTotal?: {
166
+ amount?: number;
167
+ meals?: number;
168
+ };
169
+ [index: string]: any;
170
+ };
171
+ // Indicate whether the order is active or inactive
172
+ active?: boolean;
173
+ // Override for meta.active for testing purposes
174
+ activeOverride?: boolean;
175
+ // Delivery details
176
+ delivery?: {
177
+ provider?: string;
178
+ trackerUrl?: string;
179
+ loadingCode?: string;
180
+ [index: string]: any;
181
+ };
182
+ // Discount details
183
+ discount?: {
184
+ app?: string;
185
+ code?: string;
186
+ [index: string]: any;
187
+ };
188
+ discounts?: {
189
+ app?: string;
190
+ code?: string;
191
+ [index: string]: any;
192
+ }[];
193
+ // Discounts for refunds
194
+ discountsRefund?: {
195
+ // Client app that applied the discount
196
+ app?: string;
197
+ // Date the discount was refunded
198
+ date?: string;
199
+ // Date the order was created
200
+ orderCreatedAt?: string;
201
+ // Vocuherify Order ID
202
+ orderId?: string;
203
+ // Order items
204
+ orderItems?: {
205
+ // Compassdigital item id
206
+ sourceId?: string;
207
+ // Quantity of the item
208
+ quantity?: number;
209
+ // Price of the item in cents
210
+ price?: number;
211
+ }[];
212
+ // Order total
213
+ orderTotal?: number;
214
+ // Reason for refund
215
+ reason?: string;
216
+ // Voucherify parent redemption id for the stacked discounts
217
+ redemptionId?: string;
218
+ // true if refund succeeded
219
+ result?: boolean;
220
+ [index: string]: any;
221
+ };
222
+ // The type of kds that the brand uses
223
+ typeOfKds?: string;
224
+ // Indicate whether the order is eligible for cancellation
225
+ cancelEligible?: boolean;
226
+ pickupInstruction?: {
227
+ en?: string;
228
+ fr?: string;
229
+ };
230
+ marketPlaceLabel?: {
231
+ en?: string;
232
+ fr?: string;
233
+ };
234
+ marketPlaceDescription?: {
235
+ en?: string;
236
+ fr?: string;
237
+ };
238
+ apexCode?: string;
239
+ apexQr?: string;
240
+ apexCodes?: {
241
+ customerCode?: {
242
+ qrExpiryDate?: string;
243
+ };
244
+ [index: string]: any;
245
+ };
246
+ [index: string]: any;
247
+ };
248
+ issue?: {
249
+ id?: string;
250
+ type?: string;
251
+ items?: any;
252
+ [index: string]: any;
253
+ };
254
+ pastIssues?: {
255
+ id?: string;
256
+ type?: string;
257
+ items?: any;
258
+ [index: string]: any;
259
+ }[];
260
+ // Delivery user
261
+ runner?: string;
262
+ reorderEligibility?:
263
+ | 'eligible'
264
+ | 'order_type_ineligible'
265
+ | 'location_ineligible'
266
+ | 'active_order'
267
+ | 'old_order'
268
+ | 'marketplace_order'
269
+ | 'duplicate_order'
270
+ | 'brand_unavailable'
271
+ | 'menu_unavailable'
272
+ | 'items_unavailable'
273
+ | 'refunded_order'
274
+ | 'modifiers_unavailable'
275
+ | 'modified_items'
276
+ | 'cancelled_order';
277
+ refunds?: {
278
+ id?: string;
279
+ amount?: number;
280
+ reason?: string;
281
+ date?: string;
282
+ [index: string]: any;
283
+ }[];
284
+ latestRefunds?: {
285
+ id?: string;
286
+ amount?: number;
287
+ reason?: string;
288
+ date?: string;
289
+ [index: string]: any;
290
+ }[];
291
+ [index: string]: any;
292
+ };
293
+ };
294
+ source: string;
295
+ }
package/src/messages/events/PublishedMenuUpdatedEvent.ts ADDED
@@ -0,0 +1,66 @@
1
+ // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
+
3
+ export interface PublishedMenuUpdatedEvent {
4
+ id: string;
5
+ type: 'PublishedMenuUpdatedEvent';
6
+ version: '1.0.0';
7
+ timestamp: string;
8
+ traceContext: {
9
+ traceId?: string;
10
+ };
11
+ payload: {
12
+ menu: {
13
+ // menu id
14
+ id: string;
15
+ date?: {
16
+ created?: string;
17
+ modified?: string;
18
+ published?: string;
19
+ };
20
+ label?: {
21
+ en?: string;
22
+ };
23
+ // Array of Group objects
24
+ groups?: Record<string, any>[];
25
+ // Parent menu ID
26
+ parentId?: string;
27
+ // Location brand identifier
28
+ locationBrand?: string;
29
+ // Company identifier
30
+ company?: string;
31
+ // Sector identifier
32
+ sector?: string;
33
+ is?: {
34
+ disabled?: boolean;
35
+ hidden?: boolean;
36
+ linked?: boolean;
37
+ promoExemptionsEnabled?: boolean;
38
+ pluEnabled?: boolean;
39
+ itemImagesEnabled?: boolean;
40
+ itemShowcaseEnabled?: boolean;
41
+ itemDescEditEnabled?: boolean;
42
+ caloriesEditEnabled?: boolean;
43
+ itemLabelEditEnabled?: boolean;
44
+ frictionless?: boolean;
45
+ categoryImagesEnabled?: boolean;
46
+ };
47
+ meta?: {
48
+ // User ID who locked the menu
49
+ lockedByUser?: string;
50
+ // User ID of last modifier
51
+ lastModifiedUser?: string;
52
+ centricos?: boolean;
53
+ version?: number;
54
+ brand?: {
55
+ id?: string;
56
+ name?: string;
57
+ };
58
+ localMenuGroup?: {
59
+ id?: string;
60
+ name?: string;
61
+ };
62
+ };
63
+ };
64
+ };
65
+ source: string;
66
+ }
package/src/messages/events/index.ts CHANGED
@@ -13,3 +13,7 @@ export { LocationCreatedEvent } from './LocationCreatedEvent';
13
13
  export { LocationUpdatedEvent } from './LocationUpdatedEvent';
14
14
 
15
15
  export { OrderCompletedEvent } from './OrderCompletedEvent';
16
+
17
+ export { OrderCreatedEvent } from './OrderCreatedEvent';
18
+
19
+ export { PublishedMenuUpdatedEvent } from './PublishedMenuUpdatedEvent';