@compassdigital/sdk.typescript 3.77.1 → 4.1.0

package/src/interface/notification.ts

@@ -22,7 +22,7 @@ export interface Notification {
 export interface NotificationBody {
   title?: string;
   text: string;
-  realm: string;
+  realm: "cdl" | "boost" | "thrive" | "nourish" | "rogers" | "jjkitchen";
   // Recipient of the notifications. Example: specific realm, role or user id
   target: string;
   release_date?: string;
@@ -49,7 +49,7 @@ export interface Success {
 
 export interface GetNotificationsQuery {
   // Realm of notifications
-  realm: string;
+  realm: "cdl" | "boost" | "thrive" | "nourish" | "rogers" | "jjkitchen";
   // Recipient of the notifications. Can be the whole realm, role or user id
   target: string;
   // Start date of the notifications. If not provided will default to 90 days ago.

package/src/interface/order.ts

@@ -24,7 +24,7 @@ export interface CreateOrder {
   };
   meta?: {
     // which ui the order was placed on
-    source?: string;
+    source?: "web" | "mobile";
     [index: string]: any;
   };
   pickup?: string;
@@ -158,7 +158,7 @@ export interface Order {
     checkin_uuid?: string;
     refunds?: RefundTransaction[];
     // which ui the order was placed on
-    source?: string;
+    source?: "web" | "mobile";
     // details pertaining to the amount charged on the order
     transaction?: {
       // used in mx orders - cart totals in dollars and meal exchange value (meals)
@@ -203,7 +203,18 @@ export interface Order {
   past_issues?: Issue[];
   // Delivery user
   runner?: string;
-  reorder_eligibility?: string;
+  reorder_eligibility?:
+    | "eligible"
+    | "order_type_ineligible"
+    | "location_ineligible"
+    | "active_order"
+    | "old_order"
+    | "marketplace_order"
+    | "duplicate_order"
+    | "brand_unavailable"
+    | "menu_unavailable"
+    | "items_unavailable"
+    | "modifiers_unavailable";
   [index: string]: any;
 }
 
@@ -445,9 +456,9 @@ export interface GetOrderCustomerOrdersPath {
 export interface GetOrderCustomerOrdersQuery {
   // Sort the customers order by order created date, pickup date or requested date. Possible values: created, pickup. Default is created.
   sort?: string;
-  // Filter orders by their pickup date. Only return orders that have a date greater than or equal to the date. Default is the current time in milliseconds.
+  //@deprecated
   pickup_start?: number;
-  // Filter orders by their pickup 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.
+  //@deprecated
   pickup_end?: number;
   // 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.
   end?: number;
@@ -455,6 +466,10 @@ export interface GetOrderCustomerOrdersQuery {
   start?: number;
   // This is the key for which the query will be made. E.g if order_type equals 'delivery', the response will include the results based on delivery
   order_type?: string;
+  // Filter orders by active status.
+  active?: boolean;
+  // Filter orders by eligible for reorder.
+  reorder_eligible?: boolean;
   // Graphql query string
   _query?: string;
 }
@@ -497,9 +512,9 @@ export interface GetOrderLocationBrandPath {
 }
 
 export interface GetOrderLocationBrandQuery {
-  // Filter orders by their pickup date. Only return orders that have a date greater than or equal to the date in milliseconds.
+  //@deprecated
   pickup_start?: number;
-  // Filter orders by their pickup date. Only return orders that have a date less than or equal to the date in milliseconds.
+  //@deprecated
   pickup_end?: number;
   // Filter orders to just those with this ready state
   ready?: boolean;
@@ -532,9 +547,9 @@ export interface GetOrderLocationOrdersPath {
 }
 
 export interface GetOrderLocationOrdersQuery {
-  // Filter orders by their pickup date. Only return orders that have a date greater than or equal to the date in milliseconds.
+  //@deprecated
   pickup_start?: number;
-  // Filter orders by their pickup date. Only return orders that have a date less than or equal to the date in milliseconds.
+  //@deprecated
   pickup_end?: number;
   // Filter orders to just those with this ready state
   ready?: boolean;
@@ -566,13 +581,13 @@ export interface GetOrderGroupOrdersPath {
 
 export interface GetOrderGroupOrdersQuery {
   // Filter orders by their status.
-  status?: string;
+  status?: "accepted" | "in_progress" | "ready" | "out_for_delivery" | "delivered";
   // Filter orders by their requested date. Only return orders that have a date greater than or equal to the date. Default is all orders
   start?: number;
   // Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is the current time in milliseconds.
   end?: number;
   // Filter orders by their order type
-  order_type?: string;
+  order_type?: "delivery" | "pickup";
   // Filter orders by brand ID. Only return orders that involve brand ID, either as the only brand, or as part of a market place order.
   brand?: string;
   // show additional hidden properties/entities
@@ -599,7 +614,7 @@ export interface GetOrderUserOrdersPath {
 
 export interface GetOrderUserOrdersQuery {
   // Filter orders by their status.
-  status?: string;
+  status?: "accepted" | "in_progress" | "ready" | "out_for_delivery" | "delivered";
   // Filter orders by their requested date. Only return orders that have a date greater than or equal to the date. Default is all orders
   start?: number;
   // Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is the current time in milliseconds.

package/src/interface/partner.ts

@@ -107,7 +107,7 @@ export interface ShoppingCartResponse {
   };
   is?: {
     // Shoppingcart Type: delivery, pickup
-    type?: string;
+    type?: "delivery" | "pickup" | "scan_and_go" | "frictionless";
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
     // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
@@ -180,7 +180,7 @@ export interface ItemResponse {
         original_label?: Label;
         taxes?: string[];
       };
-      amount_off_exclusions?: string[];
+      amount_off_exclusions?: "promo"[];
       is?: {
         disabled?: boolean;
       };
@@ -193,7 +193,7 @@ export interface ItemResponse {
   item_discount?: any;
   // user specified instructions for the item
   special_instructions?: string;
-  amount_off_exclusions?: string[];
+  amount_off_exclusions?: ("discount" | "promo")[];
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
@@ -420,7 +420,7 @@ export interface Brand {
     business_number?: number;
     website?: string;
     cuisine_types?: string[];
-    status?: string;
+    status?: "await_partner" | "await_scout" | "completed";
     active?: boolean;
     max_showcase_items?: number;
     jde_category?: string;
@@ -475,7 +475,7 @@ export interface MenuHours {
   is_delivery?: boolean;
   is_frictionless?: boolean;
   // Identifies a brand or menu state, i.e open, closed or accepting preorders
-  state?: string;
+  state?: "open" | "closed" | "preorder";
 }
 
 export interface Hours {
@@ -751,7 +751,11 @@ export interface Nutrition {
   unit?: string;
 }
 
-export type AmountOffExclusionTypes = string;
+enum AmountOffExclusionTypes {
+  LOYALTY = "loyalty",
+  DISCOUNT = "discount",
+  PROMO = "promo",
+}
 
 export interface CognitionStore {
   // UUID for external store

package/src/interface/payment.ts

@@ -13,10 +13,7 @@ export interface Transaction {
   reasonCode?: number;
   decision?: string;
   status?: string;
-  creditCard?: {
-    cardType?: string;
-    last4?: string;
-  };
+  creditCard?: CreditCard;
   digital_wallet_pay?: DigitalWalletPay;
   requestID?: string;
   [index: string]: any;
@@ -30,6 +27,7 @@ export interface Refund {
   refund_amount?: number;
   // remaining amount available for refund
   transaction_remainder_amount?: number;
+  decision?: string;
   [index: string]: any;
 }
 
@@ -87,6 +85,7 @@ export interface TokenInformation {
   tokenExpiration?: string;
   posData?: string;
   newToken?: string;
+  sessionKey?: string;
   [index: string]: any;
 }
 
@@ -137,7 +136,7 @@ export interface Options {
   pickup_id?: string;
   // user_id
   user_id?: string;
-  payment_type?: string;
+  payment_type?: "credit_card" | "badge_pay" | "stipend" | "voucher" | "coupon_voucher";
   // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
   tender?: string;
   digital_wallet_pay?: DigitalWalletPay;
@@ -160,7 +159,7 @@ export interface CashlessTender {
   // name associated with badgepay tender, stored in site public config
   name?: string;
   // account type associated with badgepay tender, stored in site public config
-  type?: string;
+  type?: "badge_pay" | "stipend" | "voucher" | "coupon_voucher";
 }
 
 export type BadgePayTender = CashlessTender;
@@ -170,6 +169,21 @@ export interface DigitalWalletPay {
   total?: number;
 }
 
+export interface CreditCard {
+  cardType?: string;
+  last4?: string;
+}
+
+export interface PaymentCards {
+  data?: PaymentCard[];
+  recordsTotal?: number;
+}
+
+export interface HpcIframe {
+  iframe?: string;
+  sessionKey?: string;
+}
+
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
@@ -188,8 +202,8 @@ export interface PostPaymentTransactionBody {
   digital_wallet_token?: string;
   account_number?: string;
   cv_number?: string;
-  expiration_month?: string;
-  expiration_year?: string;
+  expiration_month?: number;
+  expiration_year?: number;
   cart_items?: {
     id?: string;
     label?: {
@@ -342,7 +356,7 @@ export interface GetPaymentTokenQuery {
   // Session key
   sessionKey: string;
   // CDL Site Id
-  siteId: any[];
+  siteId: string;
   // name on card
   nameOnCard: string;
   // Graphql query string
@@ -402,15 +416,12 @@ export interface DeletePaymentTokenRequest extends BaseRequest {
 
 export interface GetPaymentMethodsQuery {
   // CDL Site Id
-  siteId: any[];
+  siteId: string;
   // Graphql query string
   _query?: string;
 }
 
-export interface GetPaymentMethodsResponse {
-  data?: PaymentCard[];
-  recordsTotal?: number;
-}
+export type GetPaymentMethodsResponse = PaymentCards;
 
 export interface GetPaymentMethodsRequest
   extends BaseRequest,
@@ -427,10 +438,7 @@ export interface GetPaymentHpcQuery {
   _query?: string;
 }
 
-export interface GetPaymentHpcResponse {
-  iframe?: string;
-  sessionKey?: string;
-}
+export type GetPaymentHpcResponse = HpcIframe;
 
 export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPaymentHpcQuery> {}
 

package/src/interface/promo.ts

@@ -22,7 +22,7 @@ export interface PromotionBody {
     fr?: string;
   };
   multigroup: string;
-  type: string;
+  type: "bogo" | "bundle" | "lto";
   items: PromotionItems;
   status: Status;
   location_group_ids: string[];
@@ -49,7 +49,7 @@ export interface Promotion {
     fr?: string;
   };
   multigroup?: string;
-  type: string;
+  type: "bogo" | "bundle" | "lto";
   items: PromotionItems;
   status: Status;
   location_group_ids?: string[];
@@ -58,7 +58,13 @@ export interface Promotion {
   meta?: PromoMeta;
 }
 
-export type Status = string;
+enum Status {
+  ACTIVE = "active",
+  SCHEDULED = "scheduled",
+  PAUSED = "paused",
+  EXPIRED = "expired",
+  ARCHIVED = "archived",
+}
 
 export interface DatetimeObject {
   year: number;
@@ -74,7 +80,7 @@ export interface DatetimeObject {
 
 export interface Event {
   data?: {
-    calendar?: string;
+    calendar?: "hours" | "holidays";
     [index: string]: any;
   };
   schedule?: {
@@ -84,7 +90,7 @@ export interface Event {
     // Is used to calculate the time event will end (times[0]+duration)
     duration?: number;
     // Defines the type of duration property
-    durationUnit?: string;
+    durationUnit?: "minutes" | "hours" | "days";
     dayOfWeek?: number[];
     dayOfMonth?: number[];
     dayOfYear?: number[];
@@ -186,7 +192,7 @@ export interface UpdateVoucher {
 }
 
 export interface Voucher {
-  provider?: string;
+  provider?: "fp" | "voucherify";
   code?: string;
   valid?: boolean;
   discount?: AppliedDiscount;

package/src/interface/report.ts

@@ -318,7 +318,7 @@ export interface EODItemReport {
 
 export interface GetReportAnalyticsGroupPath {
   location_group: string;
-  report_type: string;
+  report_type: "bills" | "sales" | "transactions" | "top-items";
 }
 
 export interface GetReportAnalyticsGroupQuery {
@@ -326,8 +326,8 @@ export interface GetReportAnalyticsGroupQuery {
   brand_ids?: string;
   start_date: string;
   end_date: string;
-  time_frame: string;
-  order_type?: string;
+  time_frame: "week" | "month" | "day";
+  order_type?: "delivery" | "pickup" | "frictionless";
   // Graphql query string
   _query?: string;
 }
@@ -350,8 +350,8 @@ export interface GetReportAnalyticsCombinedGroupQuery {
   brand_ids?: string;
   start_date: string;
   end_date: string;
-  time_frame: string;
-  order_type?: string;
+  time_frame: "week" | "month" | "day";
+  order_type?: "delivery" | "pickup" | "frictionless";
   // Graphql query string
   _query?: string;
 }
@@ -375,7 +375,7 @@ export interface GetReportEodGroupQuery {
   // Report end date in ISO 8601 format
   end?: string;
   // Output format
-  format?: string;
+  format?: "json" | "xslx";
   // Location IDs, comma-separated
   locations?: string;
   // Graphql query string
@@ -464,9 +464,9 @@ export interface GetReportEodGroupItemsQuery {
   // Report end date in ISO 8601 format
   end: string;
   // Output format
-  format: string;
+  format: "xslx";
   // Partner name for specific formatting
-  partner: string;
+  partner: "onemarket";
   // Location IDs, comma-separated
   locations: string;
   // Graphql query string

package/src/interface/shoppingcart.ts

@@ -26,7 +26,7 @@ export interface ItemRequest {
     [index: string]: any;
   };
   special_instructions?: string;
-  amount_off_exclusions?: string[];
+  amount_off_exclusions?: AmountOffExclusion[];
 }
 
 export interface ItemResponse {
@@ -72,7 +72,7 @@ export interface ItemResponse {
   item_discount?: any;
   // user specified instructions for the item
   special_instructions?: string;
-  amount_off_exclusions?: string[];
+  amount_off_exclusions?: AmountOffExclusion[];
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
@@ -106,7 +106,7 @@ export interface ModifierRequest {
   label?: Label;
   _index?: string;
   quantity?: Quantity;
-  amount_off_exclusions?: string[];
+  amount_off_exclusions?: AmountOffExclusion[];
 }
 
 export interface ModifierResponse {
@@ -123,7 +123,7 @@ export interface ModifierResponse {
     taxes?: string[];
     [index: string]: any;
   };
-  amount_off_exclusions?: string[];
+  amount_off_exclusions?: AmountOffExclusion[];
   is?: {
     disabled?: boolean;
   };
@@ -229,7 +229,7 @@ export interface ShoppingCartRequest {
   brand?: string;
   is?: {
     // Shoppingcart Type: delivery, pickup
-    type?: string;
+    type?: "delivery" | "pickup" | "scan_and_go";
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
     // If a user's email domain is a match in a sites list of tax exempt domains
@@ -260,7 +260,7 @@ export interface ShoppingCartResponse {
   };
   promo?: {
     code?: string;
-    provider?: string;
+    provider?: "fp" | "voucherify";
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
@@ -281,7 +281,7 @@ export interface ShoppingCartResponse {
   };
   discount?: {
     code?: string;
-    provider?: string;
+    provider?: "fp" | "voucherify";
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
@@ -319,7 +319,7 @@ export interface ShoppingCartResponse {
   };
   is?: {
     // Shoppingcart Type: delivery, pickup
-    type?: string;
+    type?: "delivery" | "pickup" | "scan_and_go" | "frictionless";
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
     // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
@@ -390,7 +390,7 @@ export interface Tender {
   id: string;
   name?: string;
   balance?: MonetaryValue;
-  type: string;
+  type: "declining_balance" | "meal_equivalent" | "meal_exchange";
   is: {
     eligible: boolean;
     validated?: boolean;
@@ -428,6 +428,11 @@ export interface FPValidationData {
   [index: string]: any;
 }
 
+enum AmountOffExclusion {
+  DISCOUNT = "discount",
+  PROMO = "promo",
+}
+
 // POST /shoppingcart/ - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;

package/src/interface/task.ts

@@ -36,12 +36,12 @@ export interface Task {
   // location id for this task
   location_id?: string;
   // type of location id
-  location_type?: string;
+  location_type?: "brand" | "group";
   order?: TaskOrder;
   pickup_details?: TaskLocation;
   dropoff_details?: TaskLocation;
   // Task Status
-  status?: string;
+  status?: "new" | "in_progress" | "ready" | "out_for_delivery" | "delivered" | "order_is_ready";
   // Any related metadata information about this Task
   meta?: {
     [index: string]: any;
@@ -61,7 +61,7 @@ export interface Task {
   // runnerid
   assignee?: string;
   // Task Type
-  type?: string;
+  type?: "bolter" | "kds";
 }
 
 export interface Tasks {
@@ -78,18 +78,24 @@ export interface TaskCreate {
   // location id for this task
   location_id: string;
   // type of location id
-  location_type: string;
+  location_type: "brand" | "group";
   order: TaskOrder;
   pickup_details: TaskLocation;
   dropoff_details: TaskLocation;
   // Task Status
-  status: string;
+  status:
+    | "accepted"
+    | "in_progress"
+    | "ready"
+    | "out_for_delivery"
+    | "delivered"
+    | "order_is_ready";
   // Any related metadata information about this Task
   meta?: {
     [index: string]: any;
   };
   // Task Type
-  type: string;
+  type: "bolter" | "kds";
 }
 
 export interface TaskUpdate {
@@ -101,12 +107,18 @@ export interface TaskUpdate {
   location_id?: string;
   unit_id?: string;
   // type of location id
-  location_type?: string;
+  location_type?: "brand" | "group";
   order?: TaskOrder;
   pickup_details?: TaskLocation;
   dropoff_details?: TaskLocation;
   // Task Status
-  status?: string;
+  status?:
+    | "accepted"
+    | "in_progress"
+    | "ready"
+    | "out_for_delivery"
+    | "delivered"
+    | "order_is_ready";
   // Any related metadata information about this Task
   meta?: {
     [index: string]: any;
@@ -115,7 +127,7 @@ export interface TaskUpdate {
 
 export interface OrderUpdate {
   // This is the new status of the order that you are trying to update
-  order_status: string;
+  order_status: "ready";
 }
 
 export interface ActionResponse {
@@ -263,7 +275,7 @@ export interface GetTaskAssigneePath {
 
 export interface GetTaskAssigneeQuery {
   // Task Status
-  status?: string;
+  status?: "new" | "in_progress" | "ready" | "out_for_delivery" | "delivered" | "order_is_ready";
   // 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.
@@ -292,7 +304,7 @@ export interface GetTaskLocationBrandPath {
 
 export interface GetTaskLocationBrandQuery {
   // Task Status
-  status?: string;
+  status?: "new" | "in_progress" | "ready" | "out_for_delivery" | "delivered" | "order_is_ready";
   // 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.
@@ -304,7 +316,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?: string;
+  query_type?: "kds" | "bolter";
   // Graphql query string
   _query?: string;
 }
@@ -325,7 +337,7 @@ export interface GetTaskLocationGroupPath {
 
 export interface GetTaskLocationGroupQuery {
   // Task Status
-  status?: string;
+  status?: "new" | "in_progress" | "ready" | "out_for_delivery" | "delivered" | "order_is_ready";
   // 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.
@@ -337,7 +349,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?: string;
+  query_type?: "kds" | "bolter";
   // Graphql query string
   _query?: string;
 }