@compassdigital/sdk.typescript 3.19.0 → 3.21.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 (71) hide show
  1. package/lib/interface/announcement.d.ts +7 -7
  2. package/lib/interface/announcement.d.ts.map +1 -1
  3. package/lib/interface/calendar.d.ts +8 -7
  4. package/lib/interface/calendar.d.ts.map +1 -1
  5. package/lib/interface/compassconnect.d.ts +2 -2
  6. package/lib/interface/compassconnect.d.ts.map +1 -1
  7. package/lib/interface/config.d.ts +11 -9
  8. package/lib/interface/config.d.ts.map +1 -1
  9. package/lib/interface/datalake.d.ts +4 -2
  10. package/lib/interface/datalake.d.ts.map +1 -1
  11. package/lib/interface/email.d.ts +2 -1
  12. package/lib/interface/email.d.ts.map +1 -1
  13. package/lib/interface/file.d.ts +3 -2
  14. package/lib/interface/file.d.ts.map +1 -1
  15. package/lib/interface/kds.d.ts +8 -7
  16. package/lib/interface/kds.d.ts.map +1 -1
  17. package/lib/interface/location.d.ts +55 -53
  18. package/lib/interface/location.d.ts.map +1 -1
  19. package/lib/interface/mealplan.d.ts +12 -12
  20. package/lib/interface/mealplan.d.ts.map +1 -1
  21. package/lib/interface/menu.d.ts +27 -27
  22. package/lib/interface/menu.d.ts.map +1 -1
  23. package/lib/interface/notification.d.ts +8 -7
  24. package/lib/interface/notification.d.ts.map +1 -1
  25. package/lib/interface/order.d.ts +15 -15
  26. package/lib/interface/order.d.ts.map +1 -1
  27. package/lib/interface/partner.d.ts +12 -7
  28. package/lib/interface/partner.d.ts.map +1 -1
  29. package/lib/interface/payment.d.ts +15 -15
  30. package/lib/interface/payment.d.ts.map +1 -1
  31. package/lib/interface/permission.d.ts +10 -10
  32. package/lib/interface/permission.d.ts.map +1 -1
  33. package/lib/interface/promo.d.ts +18 -17
  34. package/lib/interface/promo.d.ts.map +1 -1
  35. package/lib/interface/report.d.ts +8 -8
  36. package/lib/interface/report.d.ts.map +1 -1
  37. package/lib/interface/shoppingcart.d.ts +15 -14
  38. package/lib/interface/shoppingcart.d.ts.map +1 -1
  39. package/lib/interface/task.d.ts +11 -11
  40. package/lib/interface/task.d.ts.map +1 -1
  41. package/lib/interface/user.d.ts +31 -29
  42. package/lib/interface/user.d.ts.map +1 -1
  43. package/lib/interface/util.d.ts +19 -0
  44. package/lib/interface/util.d.ts.map +1 -1
  45. package/lib/interface/vendor.d.ts +19 -17
  46. package/lib/interface/vendor.d.ts.map +1 -1
  47. package/package.json +2 -2
  48. package/src/interface/announcement.ts +9 -7
  49. package/src/interface/calendar.ts +11 -7
  50. package/src/interface/compassconnect.ts +3 -2
  51. package/src/interface/config.ts +10 -10
  52. package/src/interface/datalake.ts +3 -3
  53. package/src/interface/email.ts +2 -2
  54. package/src/interface/file.ts +3 -3
  55. package/src/interface/kds.ts +7 -7
  56. package/src/interface/location.ts +92 -53
  57. package/src/interface/mealplan.ts +13 -12
  58. package/src/interface/menu.ts +40 -27
  59. package/src/interface/notification.ts +7 -7
  60. package/src/interface/order.ts +22 -15
  61. package/src/interface/partner.ts +8 -8
  62. package/src/interface/payment.ts +20 -15
  63. package/src/interface/permission.ts +13 -10
  64. package/src/interface/promo.ts +19 -17
  65. package/src/interface/report.ts +18 -8
  66. package/src/interface/shoppingcart.ts +27 -15
  67. package/src/interface/sms.ts +1 -1
  68. package/src/interface/task.ts +14 -11
  69. package/src/interface/user.ts +43 -29
  70. package/src/interface/util.ts +22 -1
  71. package/src/interface/vendor.ts +23 -17
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  code?: number;
@@ -53,7 +53,7 @@ export type PostAnnouncementBody = Announcement;
53
53
 
54
54
  export type PostAnnouncementResponse = Announcement;
55
55
 
56
- export interface PostAnnouncementRequest {
56
+ export interface PostAnnouncementRequest extends BaseRequest {
57
57
  body: PostAnnouncementBody;
58
58
  }
59
59
 
@@ -73,7 +73,8 @@ export interface GetAnnouncementResourceQuery {
73
73
  export type GetAnnouncementResourceResponse = Announcements;
74
74
 
75
75
  export interface GetAnnouncementResourceRequest
76
- extends RequestQuery<GetAnnouncementResourceQuery>,
76
+ extends BaseRequest,
77
+ RequestQuery<GetAnnouncementResourceQuery>,
77
78
  GetAnnouncementResourcePath {}
78
79
 
79
80
  // GET /announcement/resource - Get Announcements
@@ -85,7 +86,8 @@ export interface GetAnnouncementResourcesQuery {
85
86
  export type GetAnnouncementResourcesResponse = Announcements;
86
87
 
87
88
  export interface GetAnnouncementResourcesRequest
88
- extends RequestQuery<GetAnnouncementResourcesQuery> {}
89
+ extends BaseRequest,
90
+ RequestQuery<GetAnnouncementResourcesQuery> {}
89
91
 
90
92
  // GET /announcement/{id} - Get Announcement
91
93
 
@@ -96,7 +98,7 @@ export interface GetAnnouncementPath {
96
98
 
97
99
  export type GetAnnouncementResponse = Announcement;
98
100
 
99
- export interface GetAnnouncementRequest extends GetAnnouncementPath {}
101
+ export interface GetAnnouncementRequest extends BaseRequest, GetAnnouncementPath {}
100
102
 
101
103
  // PUT /announcement/{id} - Update Announcement
102
104
 
@@ -109,7 +111,7 @@ export type PutAnnouncementBody = Announcement;
109
111
 
110
112
  export type PutAnnouncementResponse = Announcement;
111
113
 
112
- export interface PutAnnouncementRequest extends PutAnnouncementPath {
114
+ export interface PutAnnouncementRequest extends BaseRequest, PutAnnouncementPath {
113
115
  body: PutAnnouncementBody;
114
116
  }
115
117
 
@@ -122,4 +124,4 @@ export interface DeleteAnnouncementPath {
122
124
 
123
125
  export type DeleteAnnouncementResponse = Success;
124
126
 
125
- export interface DeleteAnnouncementRequest extends DeleteAnnouncementPath {}
127
+ export interface DeleteAnnouncementRequest extends BaseRequest, DeleteAnnouncementPath {}
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  message?: string;
@@ -73,7 +73,10 @@ export interface GetCalendarQuery {
73
73
 
74
74
  export type GetCalendarResponse = Calendar;
75
75
 
76
- export interface GetCalendarRequest extends RequestQuery<GetCalendarQuery>, GetCalendarPath {}
76
+ export interface GetCalendarRequest
77
+ extends BaseRequest,
78
+ RequestQuery<GetCalendarQuery>,
79
+ GetCalendarPath {}
77
80
 
78
81
  // PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
79
82
 
@@ -86,7 +89,7 @@ export type PutCalendarBody = UpdatedCalendar;
86
89
 
87
90
  export type PutCalendarResponse = Calendar;
88
91
 
89
- export interface PutCalendarRequest extends PutCalendarPath {
92
+ export interface PutCalendarRequest extends BaseRequest, PutCalendarPath {
90
93
  body: PutCalendarBody;
91
94
  }
92
95
 
@@ -99,7 +102,7 @@ export interface DeleteCalendarPath {
99
102
 
100
103
  export type DeleteCalendarResponse = Success;
101
104
 
102
- export interface DeleteCalendarRequest extends DeleteCalendarPath {}
105
+ export interface DeleteCalendarRequest extends BaseRequest, DeleteCalendarPath {}
103
106
 
104
107
  // GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
105
108
 
@@ -116,7 +119,8 @@ export interface GetCalendarCdlQuery {
116
119
  export type GetCalendarCdlResponse = CDLCalendar;
117
120
 
118
121
  export interface GetCalendarCdlRequest
119
- extends RequestQuery<GetCalendarCdlQuery>,
122
+ extends BaseRequest,
123
+ RequestQuery<GetCalendarCdlQuery>,
120
124
  GetCalendarCdlPath {}
121
125
 
122
126
  // GET /calendar/swagger.json
@@ -125,7 +129,7 @@ export interface GetCalendarSwaggerResponse {
125
129
  [index: string]: any;
126
130
  }
127
131
 
128
- export type GetCalendarSwaggerRequest = {};
132
+ export interface GetCalendarSwaggerRequest extends BaseRequest {}
129
133
 
130
134
  // POST /calendar/{id}/sync - Trigger synchronization of calendar to location API
131
135
 
@@ -136,4 +140,4 @@ export interface PostCalendarSyncPath {
136
140
 
137
141
  export type PostCalendarSyncResponse = Success;
138
142
 
139
- export interface PostCalendarSyncRequest extends PostCalendarSyncPath {}
143
+ export interface PostCalendarSyncRequest extends BaseRequest, PostCalendarSyncPath {}
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface OMSRequest {
6
6
  code: string;
@@ -50,4 +50,5 @@ export interface GetCompassconnectOmsTokenQuery {
50
50
  export type GetCompassconnectOmsTokenResponse = Auth;
51
51
 
52
52
  export interface GetCompassconnectOmsTokenRequest
53
- extends RequestQuery<GetCompassconnectOmsTokenQuery> {}
53
+ extends BaseRequest,
54
+ RequestQuery<GetCompassconnectOmsTokenQuery> {}
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export type CreateConfig = any;
6
6
 
@@ -21,7 +21,7 @@ export interface Success {
21
21
 
22
22
  export type GetConfigAppconfigResponse = Config;
23
23
 
24
- export type GetConfigAppconfigRequest = {};
24
+ export interface GetConfigAppconfigRequest extends BaseRequest {}
25
25
 
26
26
  // GET /config/{key} - get a configuration
27
27
 
@@ -32,7 +32,7 @@ export interface GetConfigPath {
32
32
 
33
33
  export type GetConfigResponse = Config;
34
34
 
35
- export interface GetConfigRequest extends GetConfigPath {}
35
+ export interface GetConfigRequest extends BaseRequest, GetConfigPath {}
36
36
 
37
37
  // POST /config/{key} - Create a configuration
38
38
 
@@ -45,7 +45,7 @@ export type PostConfigBody = CreateConfig;
45
45
 
46
46
  export type PostConfigResponse = Config;
47
47
 
48
- export interface PostConfigRequest extends PostConfigPath {
48
+ export interface PostConfigRequest extends BaseRequest, PostConfigPath {
49
49
  body: PostConfigBody;
50
50
  }
51
51
 
@@ -60,7 +60,7 @@ export type PutConfigBody = CreateConfig;
60
60
 
61
61
  export type PutConfigResponse = Config;
62
62
 
63
- export interface PutConfigRequest extends PutConfigPath {
63
+ export interface PutConfigRequest extends BaseRequest, PutConfigPath {
64
64
  body: PutConfigBody;
65
65
  }
66
66
 
@@ -73,7 +73,7 @@ export interface DeleteConfigPath {
73
73
 
74
74
  export type DeleteConfigResponse = Success;
75
75
 
76
- export interface DeleteConfigRequest extends DeleteConfigPath {}
76
+ export interface DeleteConfigRequest extends BaseRequest, DeleteConfigPath {}
77
77
 
78
78
  // GET /config/public/{key} - get a public configuration
79
79
 
@@ -84,7 +84,7 @@ export interface GetConfigPublicPath {
84
84
 
85
85
  export type GetConfigPublicResponse = Config;
86
86
 
87
- export interface GetConfigPublicRequest extends GetConfigPublicPath {}
87
+ export interface GetConfigPublicRequest extends BaseRequest, GetConfigPublicPath {}
88
88
 
89
89
  // POST /config/public/{key} - Create a public configuration
90
90
 
@@ -97,7 +97,7 @@ export type PostConfigPublicBody = CreateConfig;
97
97
 
98
98
  export type PostConfigPublicResponse = Config;
99
99
 
100
- export interface PostConfigPublicRequest extends PostConfigPublicPath {
100
+ export interface PostConfigPublicRequest extends BaseRequest, PostConfigPublicPath {
101
101
  body: PostConfigPublicBody;
102
102
  }
103
103
 
@@ -112,7 +112,7 @@ export type PutConfigPublicBody = CreateConfig;
112
112
 
113
113
  export type PutConfigPublicResponse = Config;
114
114
 
115
- export interface PutConfigPublicRequest extends PutConfigPublicPath {
115
+ export interface PutConfigPublicRequest extends BaseRequest, PutConfigPublicPath {
116
116
  body: PutConfigPublicBody;
117
117
  }
118
118
 
@@ -125,4 +125,4 @@ export interface DeleteConfigPublicPath {
125
125
 
126
126
  export type DeleteConfigPublicResponse = Success;
127
127
 
128
- export interface DeleteConfigPublicRequest extends DeleteConfigPublicPath {}
128
+ export interface DeleteConfigPublicRequest extends BaseRequest, DeleteConfigPublicPath {}
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  error?: string;
@@ -21,7 +21,7 @@ export interface PostDatalakeSqlResponse {
21
21
  }[];
22
22
  }
23
23
 
24
- export interface PostDatalakeSqlRequest {
24
+ export interface PostDatalakeSqlRequest extends BaseRequest {
25
25
  body: PostDatalakeSqlBody;
26
26
  }
27
27
 
@@ -29,4 +29,4 @@ export interface PostDatalakeSqlRequest {
29
29
 
30
30
  export type GetSwaggerResponse = any;
31
31
 
32
- export type GetSwaggerRequest = {};
32
+ export interface GetSwaggerRequest extends BaseRequest {}
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  message?: string;
@@ -27,6 +27,6 @@ export type PostEmailBody = EmailPayload;
27
27
 
28
28
  export type PostEmailResponse = Success;
29
29
 
30
- export interface PostEmailRequest {
30
+ export interface PostEmailRequest extends BaseRequest {
31
31
  body: PostEmailBody;
32
32
  }
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  message?: string;
@@ -24,7 +24,7 @@ export interface PostFileBody {
24
24
 
25
25
  export type PostFileResponse = File;
26
26
 
27
- export interface PostFileRequest {
27
+ export interface PostFileRequest extends BaseRequest {
28
28
  body: PostFileBody;
29
29
  }
30
30
 
@@ -41,6 +41,6 @@ export interface DeleteFileResponse {
41
41
  success?: boolean;
42
42
  }
43
43
 
44
- export interface DeleteFileRequest {
44
+ export interface DeleteFileRequest extends BaseRequest {
45
45
  body: DeleteFileBody;
46
46
  }
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Success {
6
6
  success: boolean;
@@ -67,7 +67,7 @@ export interface GetKdsDevicesQuery {
67
67
 
68
68
  export type GetKdsDevicesResponse = Units;
69
69
 
70
- export interface GetKdsDevicesRequest extends RequestQuery<GetKdsDevicesQuery> {}
70
+ export interface GetKdsDevicesRequest extends BaseRequest, RequestQuery<GetKdsDevicesQuery> {}
71
71
 
72
72
  // POST /kds/device/auth - Get auth token for a device
73
73
 
@@ -75,7 +75,7 @@ export type PostKdsDeviceAuthBody = AuthPostBody;
75
75
 
76
76
  export type PostKdsDeviceAuthResponse = AuthPostBodyResponse;
77
77
 
78
- export interface PostKdsDeviceAuthRequest {
78
+ export interface PostKdsDeviceAuthRequest extends BaseRequest {
79
79
  body: PostKdsDeviceAuthBody;
80
80
  }
81
81
 
@@ -88,7 +88,7 @@ export interface DeleteKdsDeviceAuthPath {
88
88
 
89
89
  export type DeleteKdsDeviceAuthResponse = Error;
90
90
 
91
- export interface DeleteKdsDeviceAuthRequest extends DeleteKdsDeviceAuthPath {}
91
+ export interface DeleteKdsDeviceAuthRequest extends BaseRequest, DeleteKdsDeviceAuthPath {}
92
92
 
93
93
  // PATCH /kds/device/info/{device_id} - Update additional information related to the kds
94
94
 
@@ -101,7 +101,7 @@ export type PatchKdsDeviceInfoBody = DeviceInfo;
101
101
 
102
102
  export type PatchKdsDeviceInfoResponse = DeviceInfo;
103
103
 
104
- export interface PatchKdsDeviceInfoRequest extends PatchKdsDeviceInfoPath {
104
+ export interface PatchKdsDeviceInfoRequest extends BaseRequest, PatchKdsDeviceInfoPath {
105
105
  body: PatchKdsDeviceInfoBody;
106
106
  }
107
107
 
@@ -114,7 +114,7 @@ export interface DeleteKdsDeviceInfoPath {
114
114
 
115
115
  export type DeleteKdsDeviceInfoResponse = Success;
116
116
 
117
- export interface DeleteKdsDeviceInfoRequest extends DeleteKdsDeviceInfoPath {}
117
+ export interface DeleteKdsDeviceInfoRequest extends BaseRequest, DeleteKdsDeviceInfoPath {}
118
118
 
119
119
  // GET /kds/swagger.json - Get a swagger for kds service
120
120
 
@@ -122,4 +122,4 @@ export interface GetKdsSwaggerResponse {
122
122
  [index: string]: any;
123
123
  }
124
124
 
125
- export type GetKdsSwaggerRequest = {};
125
+ export interface GetKdsSwaggerRequest extends BaseRequest {}