@compassdigital/sdk.typescript 4.14.0 → 4.16.0

package/src/interface/notification.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Notification {
@@ -33,7 +33,7 @@ export interface PushNotificationBody {
   text: string;
   // Recipient of the notifications. Example: specific realm, role or user id
   target: string;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface NotificationStatus {

package/src/interface/order.ts

@@ -49,7 +49,7 @@ export interface CreateOrder {
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Issue {
@@ -327,7 +327,7 @@ export interface OrderedItem {
       id?: string;
       // index
       _index?: string;
-      meta?: Record<string, any>;
+      meta?: any;
     }[];
   }[];
   [index: string]: any;
@@ -338,7 +338,7 @@ export interface Orders {
   lastKey?: string;
   count?: number;
   // url to query next set of data
-  links?: Record<string, any>;
+  links?: any;
 }
 
 export interface ItemsWithIssue extends OrderedItem {

package/src/interface/partner.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface ShoppingCartResponse {
@@ -18,18 +18,20 @@ export interface ShoppingCartResponse {
   menu?: string;
   // brand
   brand?: string;
-  date?: Record<string, any>;
+  date?: any;
   items?: ItemResponse[];
   sub_total?: {
     amount?: MonetaryValue;
   };
   promo?: {
     code?: string;
+    provider?: "fp" | "voucherify";
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
     app?: string;
-    discount?: Record<string, any>;
+    discount?: any;
+    provider_data?: FPValidationData;
   };
   //@deprecated
   loyalty?: {
@@ -44,10 +46,12 @@ export interface ShoppingCartResponse {
   };
   discount?: {
     code?: string;
+    provider?: "fp" | "voucherify";
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
-    discount?: Record<string, any>;
+    discount?: any;
+    provider_data?: FPValidationData;
   };
   payment_method?: {
     // Mealplan payment details
@@ -55,17 +59,20 @@ export interface ShoppingCartResponse {
       id?: string;
       tender?: string;
       total?: MonetaryValue;
+      type?: PaymentType;
     };
     // Credit Cart payment details
     credit_card?: {
       card_type?: string;
       last4?: string;
       total?: MonetaryValue;
+      type?: PaymentType;
     };
     // Digital Wallet Pay payment details
     digital_wallet_pay?: {
       wallet_type?: string;
       total?: MonetaryValue;
+      type?: PaymentType;
     };
     // Meal Swipes payment details
     meal_swipes?: {
@@ -76,11 +83,13 @@ export interface ShoppingCartResponse {
       swipes?: MonetaryValue;
       rate?: MonetaryValue;
       total?: MonetaryValue;
+      type?: PaymentType;
     };
     // Meal Exchange payment details
     meal_exchange?: {
       id?: string;
       tender?: string;
+      type?: PaymentType;
     };
     badge_pay?: CashlessTender;
     stipend?: CashlessTender;
@@ -117,7 +126,7 @@ export interface ShoppingCartResponse {
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
-    vendor?: Record<string, any>;
+    vendor?: any;
     [index: string]: any;
   };
 }
@@ -180,7 +189,7 @@ export interface ItemResponse {
         original_label?: Label;
         taxes?: string[];
       };
-      amount_off_exclusions?: "promo"[];
+      amount_off_exclusions?: AmountOffExclusion[];
       is?: {
         disabled?: boolean;
       };
@@ -190,10 +199,10 @@ export interface ItemResponse {
     };
   }[];
   // Details about discount like BOGO, LTO, Bundle etc.
-  item_discount?: Record<string, any>;
+  item_discount?: any;
   // user specified instructions for the item
   special_instructions?: string;
-  amount_off_exclusions?: ("discount" | "promo")[];
+  amount_off_exclusions?: AmountOffExclusion[];
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
@@ -203,6 +212,24 @@ export interface ItemResponse {
 
 export type MonetaryValue = number;
 
+export type PaymentType = string;
+
+export interface FPValidationData {
+  discountIncentives?: {
+    id?: string;
+    program?: {
+      code?: string;
+    };
+    [index: string]: any;
+  }[];
+  [index: string]: any;
+}
+
+enum AmountOffExclusion {
+  DISCOUNT = "discount",
+  PROMO = "promo",
+}
+
 export interface Label {
   en?: string;
   fr?: string;
@@ -221,6 +248,7 @@ export interface CashlessTender {
   total?: MonetaryValue;
   tender?: string;
   name?: string;
+  type?: PaymentType;
 }
 
 export interface Taxes {
@@ -251,7 +279,7 @@ export interface LocationGroup {
   meta?: {
     [index: string]: any;
   };
-  style?: Record<string, any>;
+  style?: any;
   [index: string]: any;
 }
 
@@ -309,8 +337,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: any;
+    deliveryHours?: any;
     service_fee?: {
       type?: string;
       value?: number;
@@ -342,10 +370,10 @@ export interface Brand {
   };
   hours?: Hours[];
   deliveryHours?: DeliveryHours[];
-  style?: Record<string, any>;
+  style?: any;
   // pos
   pos?: string;
-  terminals?: Record<string, any>[];
+  terminals?: any[];
   timeslots?: {
     time?: string;
     averagePrepTime?: string;
@@ -370,6 +398,8 @@ export interface Brand {
     promo_exemptions_enabled?: boolean;
     local_images_enabled?: boolean;
     hidden?: boolean;
+    show_in_kiosk?: boolean;
+    show_in_pos?: boolean;
     item_desc_edit_enabled?: boolean;
     scan_and_go_supported?: boolean;
     calories_edit_enabled?: boolean;
@@ -390,8 +420,8 @@ export interface Brand {
   // company
   company?: string;
   config?: {
-    private?: Record<string, any>;
-    public?: Record<string, any>;
+    private?: any;
+    public?: any;
   };
   tax_rate?: number;
   meta?: {
@@ -581,7 +611,7 @@ export interface Group {
     };
     // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
     unit?: number;
-    ingredients?: Record<string, any>[];
+    ingredients?: any[];
     amount_off_exclusions?: AmountOffExclusionTypes[];
     nutrition?: {
       kcal?: number;
@@ -751,7 +781,11 @@ export interface Nutrition {
   unit?: string;
 }
 
-export type AmountOffExclusionTypes = "loyalty" | "discount" | "promo";
+enum AmountOffExclusionTypes {
+  LOYALTY = "loyalty",
+  DISCOUNT = "discount",
+  PROMO = "promo",
+}
 
 export interface CognitionStore {
   // UUID for external store
@@ -786,7 +820,7 @@ export interface PostPartnerStandardcognitionShoppingcartBody {
   // shoppingcart
   shoppingcart?: string;
   // Meta data from Standard Cognition shoppingcart
-  meta?: Record<string, any>;
+  meta?: any;
 }
 
 export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCartResponse;
@@ -849,7 +883,7 @@ export interface PostPartnerEventPath {
   id: string;
 }
 
-export type PostPartnerEventBody = Record<string, any>;
+export type PostPartnerEventBody = any;
 
 export type PostPartnerEventResponse = Success;
 

package/src/interface/payment.ts

@@ -149,7 +149,7 @@ export interface Success {
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface CashlessTender {

package/src/interface/promo.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface PromotionBody {
@@ -58,7 +58,13 @@ export interface Promotion {
   meta?: PromoMeta;
 }
 
-export type Status = "active" | "scheduled" | "paused" | "expired" | "archived";
+enum Status {
+  ACTIVE = "active",
+  SCHEDULED = "scheduled",
+  PAUSED = "paused",
+  EXPIRED = "expired",
+  ARCHIVED = "archived",
+}
 
 export interface DatetimeObject {
   year: number;
@@ -254,10 +260,10 @@ export interface Customer {
   name?: string;
   email?: string;
   description?: string;
-  address?: Record<string, any>;
+  address?: any;
   phone?: string;
-  summary?: Record<string, any>;
-  loyalty?: Record<string, any>;
+  summary?: any;
+  loyalty?: any;
   metadata?: {
     origin?: string;
   };

package/src/interface/report.ts

@@ -10,7 +10,7 @@ export interface Success {
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface EODReports {
@@ -329,11 +329,11 @@ export interface ReportGroupConfigRequest {
 }
 
 export interface ReportGroupConfigResponse {
-  location_group_id?: string;
+  location_group_id: string;
   // Time in 24-hour format (HH:MM).
-  day_start?: string;
-  day_parts?: DayPartConfig;
-  is_default?: boolean;
+  day_start: string;
+  day_parts: DayPartConfig;
+  is_default: boolean;
 }
 
 // GET /report/analytics/group/{location_group}/{report_type}
@@ -503,7 +503,7 @@ export interface GetReportEodGroupItemsRequest
     RequestQuery<GetReportEodGroupItemsQuery>,
     GetReportEodGroupItemsPath {}
 
-// PUT /report/group/{location_group}/config - Update report configuration for a location group
+// PUT /report/group/{location_group}/config - Update report configuration for a location group. Times are in UTC.
 
 export interface PutReportGroupConfigPath {
   location_group: string;
@@ -516,3 +516,31 @@ export type PutReportGroupConfigResponse = ReportGroupConfigResponse;
 export interface PutReportGroupConfigRequest extends BaseRequest, PutReportGroupConfigPath {
   body: PutReportGroupConfigBody;
 }
+
+// GET /report/group/{location_group}/config - Get report configuration for a location group. Times are in UTC.
+
+export interface GetReportGroupConfigPath {
+  location_group: string;
+}
+
+export interface GetReportGroupConfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetReportGroupConfigResponse = ReportGroupConfigResponse;
+
+export interface GetReportGroupConfigRequest
+  extends BaseRequest,
+    RequestQuery<GetReportGroupConfigQuery>,
+    GetReportGroupConfigPath {}
+
+// DELETE /report/group/{location_group}/config - Delete report configuration for a location group
+
+export interface DeleteReportGroupConfigPath {
+  location_group: string;
+}
+
+export type DeleteReportGroupConfigResponse = ReportGroupConfigResponse;
+
+export interface DeleteReportGroupConfigRequest extends BaseRequest, DeleteReportGroupConfigPath {}

package/src/interface/shoppingcart.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface ItemsRequest {
@@ -69,7 +69,7 @@ export interface ItemResponse {
   };
   options?: ModifierGroupResponse[];
   // Details about discount like BOGO, LTO, Bundle etc.
-  item_discount?: Record<string, any>;
+  item_discount?: any;
   // user specified instructions for the item
   special_instructions?: string;
   amount_off_exclusions?: AmountOffExclusion[];
@@ -239,7 +239,7 @@ export interface ShoppingCartRequest {
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
-    vendor?: Record<string, any>;
+    vendor?: any;
     [index: string]: any;
   };
 }
@@ -253,7 +253,7 @@ export interface ShoppingCartResponse {
   menu?: string;
   // brand
   brand?: string;
-  date?: Record<string, any>;
+  date?: any;
   items?: ItemResponse[];
   sub_total?: {
     amount?: MonetaryValue;
@@ -265,7 +265,7 @@ export interface ShoppingCartResponse {
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
     app?: string;
-    discount?: Record<string, any>;
+    discount?: any;
     provider_data?: FPValidationData;
   };
   //@deprecated
@@ -285,7 +285,7 @@ export interface ShoppingCartResponse {
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
-    discount?: Record<string, any>;
+    discount?: any;
     provider_data?: FPValidationData;
   };
   payment_method?: {
@@ -329,7 +329,7 @@ export interface ShoppingCartResponse {
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
-    vendor?: Record<string, any>;
+    vendor?: any;
     [index: string]: any;
   };
 }
@@ -428,7 +428,10 @@ export interface FPValidationData {
   [index: string]: any;
 }
 
-export type AmountOffExclusion = "discount" | "promo";
+enum AmountOffExclusion {
+  DISCOUNT = "discount",
+  PROMO = "promo",
+}
 
 // POST /shoppingcart/ - Create a new ShoppingCart
 

package/src/interface/task.ts

@@ -15,13 +15,13 @@ export interface TaskLocation {
   // Pickup or Dropoff time
   action_time: string;
   // optional details
-  details?: Record<string, any>;
+  details?: any;
 }
 
 export interface Error {
   code?: number;
   message?: string;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Task {
@@ -131,8 +131,8 @@ export interface ActionResponse {
 export interface TaskOrder {
   order_id?: string;
   customer_id?: string;
-  customer?: Record<string, any>;
-  order_details?: Record<string, any>;
+  customer?: any;
+  order_details?: any;
   delivery_instructions?: string;
   issue?: OrderIssue;
   past_issues?: OrderIssue[];
@@ -146,7 +146,7 @@ export interface OrderIssue {
     [index: string]: any;
   };
   // Array of Items with issues
-  items?: Record<string, any>[];
+  items?: any[];
   // Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
   reason?: string;
   meta?: {
@@ -155,13 +155,14 @@ export interface OrderIssue {
   };
 }
 
-export type TaskStatus =
-  | "new"
-  | "in_progress"
-  | "ready"
-  | "out_for_delivery"
-  | "delivered"
-  | "order_is_ready";
+enum TaskStatus {
+  NEW = "new",
+  IN_PROGRESS = "in_progress",
+  READY = "ready",
+  OUT_FOR_DELIVERY = "out_for_delivery",
+  DELIVERED = "delivered",
+  ORDER_IS_READY = "order_is_ready",
+}
 
 // POST /task/ - Create new Task
 
@@ -277,7 +278,7 @@ export interface GetTaskAssigneePath {
 
 export interface GetTaskAssigneeQuery {
   // Task Status
-  status?: TaskStatus;
+  status?: string;
   // Task Location ID
   location_id?: string;
   // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
@@ -306,7 +307,7 @@ export interface GetTaskLocationBrandPath {
 
 export interface GetTaskLocationBrandQuery {
   // Task Status
-  status?: TaskStatus;
+  status?: string;
   // Task Location ID
   location_id?: string;
   // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
@@ -318,7 +319,7 @@ export interface GetTaskLocationBrandQuery {
   // Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
   pickup_time?: number;
   // The type of task that will be searched on. The default is: 'bolter'
-  query_type?: "kds" | "bolter";
+  query_type?: string;
   // Graphql query string
   _query?: string;
 }
@@ -339,7 +340,7 @@ export interface GetTaskLocationGroupPath {
 
 export interface GetTaskLocationGroupQuery {
   // Task Status
-  status?: TaskStatus;
+  status?: string;
   // Task Location ID
   location_id?: string;
   // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
@@ -351,7 +352,7 @@ export interface GetTaskLocationGroupQuery {
   // Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
   pickup_time?: number;
   // The type of task that will be searched on. The default is: 'bolter'
-  query_type?: "kds" | "bolter";
+  query_type?: string;
   // Graphql query string
   _query?: string;
 }

package/src/interface/user.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface User {
@@ -184,7 +184,7 @@ export interface guestAuthToken {
 export type Permission = string;
 
 export interface KDSToken {
-  device?: Record<string, any>;
+  device?: any;
   access?: {
     token?: string;
     expires?: number;
@@ -512,7 +512,7 @@ export interface PatchUserAuthKdsPath {
   device_id: string;
 }
 
-export type PatchUserAuthKdsBody = Record<string, any>;
+export type PatchUserAuthKdsBody = any;
 
 export type PatchUserAuthKdsResponse = KDSDevice;
 
@@ -549,7 +549,7 @@ export interface PostUserAddSecretPath {
   key: string;
 }
 
-export type PostUserAddSecretBody = Record<string, any>;
+export type PostUserAddSecretBody = any;
 
 export type PostUserAddSecretResponse = Key;
 

package/src/interface/util.ts

@@ -5,9 +5,30 @@ export type RequestQuery<T extends object> = {
   [K in keyof T]: T[K] extends number|undefined ? string : T[K];
 }
 
+/**
+ * Provider TokenDetails
+ */
+export interface RequestContextSession {
+  user_id: string;
+  expiry: Date | null;
+  iat: Date;
+  scopes: string;
+  sub: string;
+  domain?: string;
+}
+
+/**
+ * Provider request context.
+ */
+export interface RequestContext {
+  method?: string;
+  session?: RequestContextSession;
+}
+
 /**
  *  All requests implement this interface.
  */
 export interface BaseRequest {
+  context?: RequestContext;
   headers?: Record<string, string>;
 }

package/src/interface/vendor.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface ApplicationPostBody {