@compassdigital/sdk.typescript 4.58.0 → 4.60.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/base.js +3 -3
- package/lib/index.d.ts +235 -7
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +263 -3
- package/lib/index.js.map +1 -1
- package/lib/interface/menu.d.ts +340 -22
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +2 -0
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/user.d.ts +38 -35
- package/lib/interface/user.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +660 -10
- package/src/interface/menu.ts +574 -40
- package/src/interface/shoppingcart.ts +2 -0
- package/src/interface/user.ts +46 -41
package/src/interface/user.ts
CHANGED
|
@@ -30,41 +30,7 @@ export interface User {
|
|
|
30
30
|
// realm
|
|
31
31
|
realm?: string;
|
|
32
32
|
gender?: "male" | "female" | "non-binary";
|
|
33
|
-
meta?:
|
|
34
|
-
marketing_opt_in?: boolean;
|
|
35
|
-
marketing_opt_in_date?: string;
|
|
36
|
-
marketing_opt_in_source?: "App" | "Web";
|
|
37
|
-
// Stores notification preference for order status, opt-in/opt-out from receiving order status update notifications
|
|
38
|
-
order_status_notification?: {
|
|
39
|
-
send_emails?: boolean;
|
|
40
|
-
send_emails_date_updated?: string;
|
|
41
|
-
};
|
|
42
|
-
mealplan_added_date?: string;
|
|
43
|
-
// limit set to prevent too many login attempts with incorrect password
|
|
44
|
-
login_limit?: {
|
|
45
|
-
login_attempts?: number;
|
|
46
|
-
last_attempt_date?: string;
|
|
47
|
-
};
|
|
48
|
-
// forgot password verification details
|
|
49
|
-
password_verification?: {
|
|
50
|
-
attempts?: number;
|
|
51
|
-
first_attempted?: string;
|
|
52
|
-
};
|
|
53
|
-
//@deprecated
|
|
54
|
-
phone_verification?: {
|
|
55
|
-
verification_code?: string;
|
|
56
|
-
date_generated?: number;
|
|
57
|
-
failed_attempts?: number;
|
|
58
|
-
consecutive_failed_attempts?: number;
|
|
59
|
-
};
|
|
60
|
-
cashless?: {
|
|
61
|
-
stipend?: CashlessLog;
|
|
62
|
-
voucher?: CashlessLog;
|
|
63
|
-
badge_pay?: CashlessLog;
|
|
64
|
-
coupon_voucher?: CashlessLog;
|
|
65
|
-
};
|
|
66
|
-
[index: string]: any;
|
|
67
|
-
};
|
|
33
|
+
meta?: UserMeta;
|
|
68
34
|
is?: {
|
|
69
35
|
disabled?: boolean;
|
|
70
36
|
// User locked out status
|
|
@@ -321,6 +287,42 @@ export interface Acl {
|
|
|
321
287
|
[index: string]: any;
|
|
322
288
|
}
|
|
323
289
|
|
|
290
|
+
export interface UserMeta {
|
|
291
|
+
marketing_opt_in?: boolean;
|
|
292
|
+
marketing_opt_in_date?: string;
|
|
293
|
+
marketing_opt_in_source?: "App" | "Web";
|
|
294
|
+
// Stores notification preference for order status, opt-in/opt-out from receiving order status update notifications
|
|
295
|
+
order_status_notification?: {
|
|
296
|
+
send_emails?: boolean;
|
|
297
|
+
send_emails_date_updated?: string;
|
|
298
|
+
};
|
|
299
|
+
mealplan_added_date?: string;
|
|
300
|
+
// limit set to prevent too many login attempts with incorrect password
|
|
301
|
+
login_limit?: {
|
|
302
|
+
login_attempts?: number;
|
|
303
|
+
last_attempt_date?: string;
|
|
304
|
+
};
|
|
305
|
+
// forgot password verification details
|
|
306
|
+
password_verification?: {
|
|
307
|
+
attempts?: number;
|
|
308
|
+
first_attempted?: string;
|
|
309
|
+
};
|
|
310
|
+
//@deprecated
|
|
311
|
+
phone_verification?: {
|
|
312
|
+
verification_code?: string;
|
|
313
|
+
date_generated?: number;
|
|
314
|
+
failed_attempts?: number;
|
|
315
|
+
consecutive_failed_attempts?: number;
|
|
316
|
+
};
|
|
317
|
+
cashless?: {
|
|
318
|
+
stipend?: CashlessLog;
|
|
319
|
+
voucher?: CashlessLog;
|
|
320
|
+
badge_pay?: CashlessLog;
|
|
321
|
+
coupon_voucher?: CashlessLog;
|
|
322
|
+
};
|
|
323
|
+
[index: string]: any;
|
|
324
|
+
}
|
|
325
|
+
|
|
324
326
|
// GET /user/auth - Gets the JWT token for a user
|
|
325
327
|
|
|
326
328
|
export interface GetUserAuthQuery {
|
|
@@ -363,18 +365,20 @@ export interface PostUserOauthRequest extends BaseRequest {
|
|
|
363
365
|
body: PostUserOauthBody;
|
|
364
366
|
}
|
|
365
367
|
|
|
366
|
-
//
|
|
368
|
+
// POST /user/zendesk - Get Zendesk JWT token to allow web widget to search restricted articles
|
|
367
369
|
|
|
368
|
-
export interface
|
|
369
|
-
//
|
|
370
|
-
|
|
370
|
+
export interface PostUserZendeskBody {
|
|
371
|
+
// Zendesk JWT
|
|
372
|
+
token?: string;
|
|
371
373
|
}
|
|
372
374
|
|
|
373
|
-
export interface
|
|
375
|
+
export interface PostUserZendeskResponse {
|
|
374
376
|
token: string;
|
|
375
377
|
}
|
|
376
378
|
|
|
377
|
-
export interface
|
|
379
|
+
export interface PostUserZendeskRequest extends BaseRequest {
|
|
380
|
+
body: PostUserZendeskBody;
|
|
381
|
+
}
|
|
378
382
|
|
|
379
383
|
// POST /user - Create an User
|
|
380
384
|
|
|
@@ -826,6 +830,7 @@ export interface GetUserProfileResponse {
|
|
|
826
830
|
created?: string;
|
|
827
831
|
modified?: string;
|
|
828
832
|
};
|
|
833
|
+
meta?: UserMeta;
|
|
829
834
|
ssoId?: string;
|
|
830
835
|
is?: {
|
|
831
836
|
disabled?: boolean;
|