@compassdigital/sdk.typescript 4.567.0 → 4.569.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/src/index.ts CHANGED
@@ -173,6 +173,7 @@ import {
173
173
  GetLocationV2GroupsQuery,
174
174
  GetLocationV2GroupsResponse,
175
175
  DeleteLocationV2GroupResponse,
176
+ PostLocationGroupRestoreResponse,
176
177
  GetLocationMenuAssociationBrandResponse,
177
178
  GetLocationMenuAssociationMenuQuery,
178
179
  GetLocationMenuAssociationMenuResponse,
@@ -277,6 +278,7 @@ import {
277
278
  PostMealplanCallbackQuery,
278
279
  PostMealplanCallbackBody,
279
280
  PostMealplanCallbackResponse,
281
+ GetMealplanBarcodeResponse,
280
282
  GetMealplanTenderResponse,
281
283
  DeleteMealplanTenderBody,
282
284
  DeleteMealplanTenderResponse,
@@ -3113,6 +3115,26 @@ export class ServiceClient extends BaseServiceClient {
3113
3115
  );
3114
3116
  }
3115
3117
 
3118
+ /**
3119
+ * POST /location/group/{id}/restore - Restore an archived group
3120
+ *
3121
+ * @param id - group id
3122
+ * @param options - additional request options
3123
+ */
3124
+ post_location_group_restore(
3125
+ id: string,
3126
+ options?: RequestOptions,
3127
+ ): ResponsePromise<PostLocationGroupRestoreResponse> {
3128
+ return this.request(
3129
+ 'location',
3130
+ '/location/group/{id}/restore',
3131
+ 'POST',
3132
+ `/location/group/${id}/restore`,
3133
+ null,
3134
+ options,
3135
+ );
3136
+ }
3137
+
3116
3138
  /**
3117
3139
  * GET /location/menu_association/{id}/brand - Get menu association for a brand
3118
3140
  *
@@ -4039,6 +4061,26 @@ export class ServiceClient extends BaseServiceClient {
4039
4061
  );
4040
4062
  }
4041
4063
 
4064
+ /**
4065
+ * GET /mealplan/{id}/barcode - Retrieve dynamic Atrium barcode ID for kiosk scan-and-pay
4066
+ *
4067
+ * @param id - Meal plan ID
4068
+ * @param options - additional request options
4069
+ */
4070
+ get_mealplan_barcode(
4071
+ id: string,
4072
+ options?: RequestOptions,
4073
+ ): ResponsePromise<GetMealplanBarcodeResponse> {
4074
+ return this.request(
4075
+ 'mealplan',
4076
+ '/mealplan/{id}/barcode',
4077
+ 'GET',
4078
+ `/mealplan/${id}/barcode`,
4079
+ null,
4080
+ options,
4081
+ );
4082
+ }
4083
+
4042
4084
  /**
4043
4085
  * GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
4044
4086
  *
@@ -2282,7 +2282,7 @@ export interface ConsumerCashlessTender {
2282
2282
  // Cashless tender tender
2283
2283
  tender?: string;
2284
2284
  // Cashless tender type
2285
- type?: Record<string, any>;
2285
+ type?: 'badge_pay' | 'stipend' | 'voucher' | 'coupon_voucher';
2286
2286
  }
2287
2287
 
2288
2288
  export interface ConsumerGetPaymentCashlessResponse {
@@ -3595,6 +3595,8 @@ export interface GetCustomerOrdersQuery {
3595
3595
  start?: number;
3596
3596
  // Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is 24 hours from the current time in milliseconds. Please ensure to use a millisecond timestamp, not just an epoch timestamp
3597
3597
  end?: number;
3598
+ // When true, only orders eligible for reorder are returned. When false, only orders that are not eligible for reorder are returned. If omitted, no filter is applied.
3599
+ reorderEligible?: boolean;
3598
3600
  }
3599
3601
 
3600
3602
  export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
@@ -4228,7 +4230,7 @@ export interface GetConsumerLocationBrandPath {
4228
4230
  }
4229
4231
 
4230
4232
  export interface GetConsumerLocationBrandQuery {
4231
- // Include config
4233
+ // Include config. When `true`, a valid Bearer token is required; requests without a token return 401 Unauthorized.
4232
4234
  include_config?: boolean;
4233
4235
  // Extended
4234
4236
  extended?: boolean;
@@ -1490,6 +1490,21 @@ export interface DeleteLocationV2GroupResponse {
1490
1490
 
1491
1491
  export interface DeleteLocationV2GroupRequest extends BaseRequest, DeleteLocationV2GroupPath {}
1492
1492
 
1493
+ // POST /location/group/{id}/restore - Restore an archived group
1494
+
1495
+ export interface PostLocationGroupRestorePath {
1496
+ // group id
1497
+ id: string;
1498
+ }
1499
+
1500
+ export interface PostLocationGroupRestoreResponse {
1501
+ success: boolean;
1502
+ }
1503
+
1504
+ export interface PostLocationGroupRestoreRequest
1505
+ extends BaseRequest,
1506
+ PostLocationGroupRestorePath {}
1507
+
1493
1508
  // GET /location/menu_association/{id}/brand - Get menu association for a brand
1494
1509
 
1495
1510
  export interface GetLocationMenuAssociationBrandPath {
@@ -82,6 +82,13 @@ export interface Institution {
82
82
  ShortName?: string;
83
83
  }
84
84
 
85
+ export interface MealplanBarcode {
86
+ // Dynamic payment token from Atrium — encoded in the QR/barcode for scan-and-pay at kiosks
87
+ barcode_id?: string;
88
+ // Active tenders for the user, same as returned by GET /mealplan/{id}
89
+ tenders?: Tender[];
90
+ }
91
+
85
92
  // POST /mealplan/{id} - Authenticate against the meal plan provider
86
93
 
87
94
  export interface PostMealplanPath {
@@ -193,6 +200,17 @@ export interface PostMealplanCallbackRequest
193
200
  body: PostMealplanCallbackBody;
194
201
  }
195
202
 
203
+ // GET /mealplan/{id}/barcode - Retrieve dynamic Atrium barcode ID for kiosk scan-and-pay
204
+
205
+ export interface GetMealplanBarcodePath {
206
+ // Meal plan ID
207
+ id: string;
208
+ }
209
+
210
+ export type GetMealplanBarcodeResponse = MealplanBarcode;
211
+
212
+ export interface GetMealplanBarcodeRequest extends BaseRequest, GetMealplanBarcodePath {}
213
+
196
214
  // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
197
215
 
198
216
  export interface GetMealplanTenderPath {