@compassdigital/sdk.typescript 4.102.0 → 4.103.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.
- package/lib/index.d.ts +139 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +166 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/centricos.d.ts +95 -0
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/consumer.d.ts +2 -2
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/discount.d.ts +180 -0
- package/lib/interface/discount.d.ts.map +1 -0
- package/lib/interface/discount.js +5 -0
- package/lib/interface/discount.js.map +1 -0
- package/lib/interface/frictionless.d.ts +3 -11
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/location.d.ts +1 -0
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +333 -0
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/tax.d.ts +2 -1
- package/lib/interface/tax.d.ts.map +1 -1
- package/manifest.json +5 -1
- package/package.json +1 -1
- package/src/index.ts +377 -0
- package/src/interface/centricos.ts +122 -0
- package/src/interface/consumer.ts +2 -2
- package/src/interface/discount.ts +249 -0
- package/src/interface/frictionless.ts +3 -13
- package/src/interface/location.ts +1 -0
- package/src/interface/menu.ts +396 -0
- package/src/interface/tax.ts +3 -2
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
|
+
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
|
+
|
|
6
|
+
export interface DiscountStatus {
|
|
7
|
+
live?: boolean;
|
|
8
|
+
readyToPublish?: boolean;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export interface DiscountIs {
|
|
12
|
+
badgepayPromo?: boolean;
|
|
13
|
+
mealplanPromo?: boolean;
|
|
14
|
+
decliningBalancePromo?: boolean;
|
|
15
|
+
voucherPromo?: boolean;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export interface PostDiscountRequestDTO {
|
|
19
|
+
// user is of discount creator
|
|
20
|
+
createdBy?: string;
|
|
21
|
+
name?: string;
|
|
22
|
+
status?: DiscountStatus;
|
|
23
|
+
is?: DiscountIs;
|
|
24
|
+
app?: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface PostDiscountResponseDTO {
|
|
28
|
+
// user is of discount creator
|
|
29
|
+
createdBy?: string;
|
|
30
|
+
id: string;
|
|
31
|
+
createdAt: string;
|
|
32
|
+
updatedAt: string;
|
|
33
|
+
name?: string;
|
|
34
|
+
status?: DiscountStatus;
|
|
35
|
+
is?: DiscountIs;
|
|
36
|
+
app?: string;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface BadRequestErrorDTO {
|
|
40
|
+
message: string;
|
|
41
|
+
code: number;
|
|
42
|
+
data: Record<string, any>;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface UnauthorizedErrorDTO {
|
|
46
|
+
message: string;
|
|
47
|
+
code: number;
|
|
48
|
+
data: Record<string, any>;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export interface VoucherifyMetaDataDiscount {
|
|
52
|
+
type: string;
|
|
53
|
+
amountOff?: number;
|
|
54
|
+
percentOff?: number;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface VoucherifyMetaData {
|
|
58
|
+
id?: string;
|
|
59
|
+
code?: string;
|
|
60
|
+
discount?: VoucherifyMetaDataDiscount;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export interface MetaProvider {
|
|
64
|
+
voucherify?: VoucherifyMetaData;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface DiscountMeta {
|
|
68
|
+
provider: MetaProvider;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface GetDiscountResponseDTO {
|
|
72
|
+
// user is of discount creator
|
|
73
|
+
createdBy?: string;
|
|
74
|
+
id: string;
|
|
75
|
+
createdAt: string;
|
|
76
|
+
updatedAt: string;
|
|
77
|
+
name?: string;
|
|
78
|
+
status?: DiscountStatus;
|
|
79
|
+
is?: DiscountIs;
|
|
80
|
+
app?: string;
|
|
81
|
+
meta?: DiscountMeta;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export interface NotFoundErrorDTO {
|
|
85
|
+
message: string;
|
|
86
|
+
code: number;
|
|
87
|
+
data: Record<string, any>;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export interface DiscountDTO {
|
|
91
|
+
// user is of discount creator
|
|
92
|
+
createdBy?: string;
|
|
93
|
+
id: string;
|
|
94
|
+
createdAt: string;
|
|
95
|
+
updatedAt: string;
|
|
96
|
+
name?: string;
|
|
97
|
+
status?: DiscountStatus;
|
|
98
|
+
is?: DiscountIs;
|
|
99
|
+
app?: string;
|
|
100
|
+
meta?: DiscountMeta;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export interface GetDiscountsResponseDTO {
|
|
104
|
+
discounts: DiscountDTO[];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export interface PutDiscountRequestDTO {
|
|
108
|
+
taxonomy?: Record<string, any>;
|
|
109
|
+
id: string;
|
|
110
|
+
name?: string;
|
|
111
|
+
status?: DiscountStatus;
|
|
112
|
+
is?: DiscountIs;
|
|
113
|
+
app?: string;
|
|
114
|
+
meta?: DiscountMeta;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export interface PutDiscountResponseDTO {
|
|
118
|
+
// user is of discount creator
|
|
119
|
+
createdBy?: string;
|
|
120
|
+
id: string;
|
|
121
|
+
createdAt: string;
|
|
122
|
+
updatedAt: string;
|
|
123
|
+
name?: string;
|
|
124
|
+
status?: DiscountStatus;
|
|
125
|
+
is?: DiscountIs;
|
|
126
|
+
app?: string;
|
|
127
|
+
meta?: DiscountMeta;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
export type InternalServerErrorException = Record<string, any>;
|
|
131
|
+
|
|
132
|
+
export interface PutDiscountPublishRequestDTO {
|
|
133
|
+
taxonomy?: Record<string, any>;
|
|
134
|
+
id: string;
|
|
135
|
+
name?: string;
|
|
136
|
+
status?: DiscountStatus;
|
|
137
|
+
is?: DiscountIs;
|
|
138
|
+
app?: string;
|
|
139
|
+
meta?: DiscountMeta;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export interface PutDiscountPublishResponseDTO {
|
|
143
|
+
// user is of discount creator
|
|
144
|
+
createdBy?: string;
|
|
145
|
+
id: string;
|
|
146
|
+
createdAt: string;
|
|
147
|
+
updatedAt: string;
|
|
148
|
+
name?: string;
|
|
149
|
+
status?: DiscountStatus;
|
|
150
|
+
is?: DiscountIs;
|
|
151
|
+
app?: string;
|
|
152
|
+
meta?: DiscountMeta;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export interface DeleteDiscountRequestDTO {
|
|
156
|
+
id: string;
|
|
157
|
+
meta?: DiscountMeta;
|
|
158
|
+
app?: string;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
export interface DeleteDiscountResponseDTO {
|
|
162
|
+
success: boolean;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
// POST /discount - Post a discount
|
|
166
|
+
|
|
167
|
+
export type PostDiscountBody = PostDiscountRequestDTO;
|
|
168
|
+
|
|
169
|
+
export type PostDiscountResponse = PostDiscountResponseDTO;
|
|
170
|
+
|
|
171
|
+
export interface PostDiscountRequest extends BaseRequest {
|
|
172
|
+
body: PostDiscountBody;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
// GET /discount - Get discounts by taxonomy
|
|
176
|
+
|
|
177
|
+
export interface GetDiscountsQuery {
|
|
178
|
+
taxonomyFilter: string;
|
|
179
|
+
active: boolean;
|
|
180
|
+
// Graphql query string
|
|
181
|
+
_query?: string;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export type GetDiscountsResponse = GetDiscountsResponseDTO;
|
|
185
|
+
|
|
186
|
+
export interface GetDiscountsRequest extends BaseRequest, RequestQuery<GetDiscountsQuery> {}
|
|
187
|
+
|
|
188
|
+
// GET /discount/{id} - Get a discount
|
|
189
|
+
|
|
190
|
+
export interface GetDiscountPath {
|
|
191
|
+
id: string;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export interface GetDiscountQuery {
|
|
195
|
+
// Graphql query string
|
|
196
|
+
_query?: string;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
export type GetDiscountResponse = GetDiscountResponseDTO;
|
|
200
|
+
|
|
201
|
+
export interface GetDiscountRequest
|
|
202
|
+
extends BaseRequest,
|
|
203
|
+
RequestQuery<GetDiscountQuery>,
|
|
204
|
+
GetDiscountPath {}
|
|
205
|
+
|
|
206
|
+
// PUT /discount/{id} - update a discount
|
|
207
|
+
|
|
208
|
+
export interface PutDiscountPath {
|
|
209
|
+
// Discount id
|
|
210
|
+
id: string;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export type PutDiscountBody = PutDiscountRequestDTO;
|
|
214
|
+
|
|
215
|
+
export type PutDiscountResponse = PutDiscountResponseDTO;
|
|
216
|
+
|
|
217
|
+
export interface PutDiscountRequest extends BaseRequest, PutDiscountPath {
|
|
218
|
+
body: PutDiscountBody;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
// DELETE /discount/{id} - delete a discount
|
|
222
|
+
|
|
223
|
+
export interface DeleteDiscountPath {
|
|
224
|
+
// Discount id
|
|
225
|
+
id: string;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
export type DeleteDiscountBody = DeleteDiscountRequestDTO;
|
|
229
|
+
|
|
230
|
+
export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
|
|
231
|
+
|
|
232
|
+
export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {
|
|
233
|
+
body: DeleteDiscountBody;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
// PUT /discount/{id}/publish - update and publish a discount
|
|
237
|
+
|
|
238
|
+
export interface PutDiscountPublishPath {
|
|
239
|
+
// Discount id
|
|
240
|
+
id: string;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
export type PutDiscountPublishBody = PutDiscountPublishRequestDTO;
|
|
244
|
+
|
|
245
|
+
export type PutDiscountPublishResponse = PutDiscountPublishResponseDTO;
|
|
246
|
+
|
|
247
|
+
export interface PutDiscountPublishRequest extends BaseRequest, PutDiscountPublishPath {
|
|
248
|
+
body: PutDiscountPublishBody;
|
|
249
|
+
}
|
|
@@ -157,15 +157,7 @@ export interface AmazonJWOIdentityKeysRequestDTO {
|
|
|
157
157
|
storeId: string;
|
|
158
158
|
}
|
|
159
159
|
|
|
160
|
-
export
|
|
161
|
-
// The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
|
|
162
|
-
id: string;
|
|
163
|
-
type: 'SHOPPER' | 'ASSOCIATE' | 'CASH_SHOPPER';
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
export interface AmazonJWOIdentityKeysResponseDTO {
|
|
167
|
-
visitorDetails: VisitorDetailsDTO;
|
|
168
|
-
}
|
|
160
|
+
export type AmazonJWOIdentityKeysResponseDTO = Record<string, any>;
|
|
169
161
|
|
|
170
162
|
export interface BadRequestErrorDTO {
|
|
171
163
|
message: string;
|
|
@@ -192,7 +184,7 @@ export interface CartItemDTO {
|
|
|
192
184
|
// Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
|
|
193
185
|
id: string;
|
|
194
186
|
// Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
|
|
195
|
-
type:
|
|
187
|
+
type: string;
|
|
196
188
|
quantity: QuantityDTO;
|
|
197
189
|
}
|
|
198
190
|
|
|
@@ -213,9 +205,7 @@ export interface AmazonJWOOrderingRequestDTO {
|
|
|
213
205
|
shopperIdentity: ShopperIdentity;
|
|
214
206
|
}
|
|
215
207
|
|
|
216
|
-
export
|
|
217
|
-
purchaseId: string;
|
|
218
|
-
}
|
|
208
|
+
export type AmazonJWOOrderingResponseDTO = Record<string, any>;
|
|
219
209
|
|
|
220
210
|
// GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
|
|
221
211
|
|