@compassdigital/sdk.typescript 3.49.0 → 3.51.0

package/src/interface/partner.ts

@@ -28,6 +28,7 @@ export interface ShoppingCartResponse {
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
     app?: string;
+    discount?: any;
   };
   //@deprecated
   loyalty?: {
@@ -45,23 +46,28 @@ export interface ShoppingCartResponse {
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
+    discount?: any;
   };
   payment_method?: {
     email?: string;
+    // Mealplan payment details
     mealplan?: {
       id?: string;
       tender?: string;
       total?: MonetaryValue;
     };
+    // Credit Cart payment details
     credit_card?: {
       card_type?: string;
       last4?: string;
       total?: MonetaryValue;
     };
+    // Digital Wallet Pay payment details
     digital_wallet_pay?: {
       wallet_type?: string;
       total?: MonetaryValue;
     };
+    // Meal Swipes payment details
     meal_swipes?: {
       id?: string;
       tender?: string;
@@ -71,6 +77,7 @@ export interface ShoppingCartResponse {
       rate?: MonetaryValue;
       total?: MonetaryValue;
     };
+    // Meal Exchange payment details
     meal_exchange?: {
       id?: string;
       tender?: string;
@@ -188,6 +195,7 @@ export interface ItemResponse {
   meal_value?: IntegerValue;
   category?: Label;
   tax_rate?: MonetaryValue;
+  label?: Label;
 }
 
 export type MonetaryValue = number;
@@ -806,8 +814,6 @@ export interface PostPartnerStandardcognitionMenuBody {
   sector: string;
   // CDL location brand ID
   location_brand: string;
-  // jsonfile
-  jsonfile?: string;
   // Link for S3 menu file provided by Standard Cognition
   s3_link: string;
 }
@@ -847,3 +853,29 @@ export interface GetPartnerSwaggerResponse {
 export interface GetPartnerSwaggerRequest
   extends BaseRequest,
     RequestQuery<GetPartnerSwaggerQuery> {}
+
+// POST /partner/{id}/menu - Create a Partner menu from files(only xls for now)
+
+export interface PostPartnerMenuPath {
+  // partner
+  id: string;
+}
+
+export interface PostPartnerMenuBody {
+  // Link for S3 menu file(file is uploaded to S3 before it gets processed)
+  s3_link: string;
+  // CDL Id of a location group units of which being updated
+  location_group: string;
+  // Should make items visible in local menu by default
+  default_items_visible?: boolean;
+}
+
+export interface PostPartnerMenuResponse {
+  menus?: {
+    id: string;
+  }[];
+}
+
+export interface PostPartnerMenuRequest extends BaseRequest, PostPartnerMenuPath {
+  body: PostPartnerMenuBody;
+}

package/src/interface/payment.ts

@@ -139,14 +139,18 @@ export interface Error {
   code?: number;
 }
 
-export interface BadgePayTender {
+export interface CashlessTender {
   balance?: number;
   // ID('payment', '<provider>', 'tender', <timestamp via Data.now()>
   id?: string;
   // 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;
 }
 
+export type BadgePayTender = CashlessTender;
+
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
@@ -202,6 +206,8 @@ export interface GetPaymentClienttokenPath {
 }
 
 export interface GetPaymentClienttokenQuery {
+  // hCaptcha response key
+  captchaResponseKey: string;
   // Graphql query string
   _query?: string;
 }
@@ -394,63 +400,63 @@ export interface GetPaymentHpcResponse {
 
 export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPaymentHpcQuery> {}
 
-// GET /payment/{id}/badgepay
+// GET /payment/{id}/cashless
 
-export interface GetPaymentBadgepayPath {
+export interface GetPaymentCashlessPath {
   // TODO: add parameter to swagger.json
   id: string;
 }
 
-export interface GetPaymentBadgepayQuery {
+export interface GetPaymentCashlessQuery {
   // Graphql query string
   _query?: string;
 }
 
-export interface GetPaymentBadgepayResponse {
-  tenders?: BadgePayTender[];
+export interface GetPaymentCashlessResponse {
+  tenders?: CashlessTender[];
 }
 
-export interface GetPaymentBadgepayRequest
+export interface GetPaymentCashlessRequest
   extends BaseRequest,
-    RequestQuery<GetPaymentBadgepayQuery>,
-    GetPaymentBadgepayPath {}
+    RequestQuery<GetPaymentCashlessQuery>,
+    GetPaymentCashlessPath {}
 
-// POST /payment/{id}/badgepay
+// POST /payment/{id}/cashless
 
-export interface PostPaymentBadgepayPath {
+export interface PostPaymentCashlessPath {
   // TODO: add parameter to swagger.json
   id: string;
 }
 
-export interface PostPaymentBadgepayBody {
+export interface PostPaymentCashlessBody {
   // The reference ID returned from FP account confirmation
   token: string;
 }
 
-export interface PostPaymentBadgepayResponse {
-  tenders?: BadgePayTender[];
+export interface PostPaymentCashlessResponse {
+  tenders?: CashlessTender[];
 }
 
-export interface PostPaymentBadgepayRequest extends BaseRequest, PostPaymentBadgepayPath {
-  body: PostPaymentBadgepayBody;
+export interface PostPaymentCashlessRequest extends BaseRequest, PostPaymentCashlessPath {
+  body: PostPaymentCashlessBody;
 }
 
-// DELETE /payment/{id}/badgepay
+// DELETE /payment/{id}/cashless
 
-export interface DeletePaymentBadgepayPath {
+export interface DeletePaymentCashlessPath {
   // TODO: add parameter to swagger.json
   id: string;
 }
 
-export interface DeletePaymentBadgepayBody {
+export interface DeletePaymentCashlessBody {
   // An optional array of tenders to delete
   tenders?: string[];
 }
 
-export interface DeletePaymentBadgepayResponse {
-  tenders?: BadgePayTender[];
+export interface DeletePaymentCashlessResponse {
+  tenders?: CashlessTender[];
 }
 
-export interface DeletePaymentBadgepayRequest extends BaseRequest, DeletePaymentBadgepayPath {
-  body: DeletePaymentBadgepayBody;
+export interface DeletePaymentCashlessRequest extends BaseRequest, DeletePaymentCashlessPath {
+  body: DeletePaymentCashlessBody;
 }

package/src/interface/report.ts

@@ -306,6 +306,13 @@ export interface P2AnalyticsReport {
   }[];
 }
 
+export interface EODItemReport {
+  // Base64 encoded file
+  file?: string;
+  // Base64 encoded file format
+  format?: string;
+}
+
 // GET /report/analytics/group/{location_group}/{report_type}
 
 export interface GetReportAnalyticsGroupPath {
@@ -443,3 +450,32 @@ export interface PutReportEodGroupSubscribersRequest
     PutReportEodGroupSubscribersPath {
   body: PutReportEodGroupSubscribersBody;
 }
+
+// GET /report/eod/group/{id}/items - Get items sales report for selected location group
+
+export interface GetReportEodGroupItemsPath {
+  id: string;
+}
+
+export interface GetReportEodGroupItemsQuery {
+  // Report start date in ISO 8601 format
+  start: string;
+  // Report end date in ISO 8601 format
+  end: string;
+  // Output format
+  format: string;
+  // Partner name for specific formatting
+  partner: string;
+  // Location IDs, comma-separated
+  locations: string;
+  // Graphql query string
+  _query?: string;
+  nocache?: boolean;
+}
+
+export type GetReportEodGroupItemsResponse = EODItemReport;
+
+export interface GetReportEodGroupItemsRequest
+  extends BaseRequest,
+    RequestQuery<GetReportEodGroupItemsQuery>,
+    GetReportEodGroupItemsPath {}

package/src/interface/shoppingcart.ts

@@ -81,6 +81,7 @@ export interface ItemResponse {
 
 export interface ModifierGroupRequest {
   label?: Label;
+  id?: string;
   items?: ModifierRequest[];
 }
 

package/src/interface/user.ts

@@ -39,6 +39,11 @@ export interface User {
       send_emails_date_updated?: string;
     };
     mealplan_added_date?: string;
+    // limit set to prevent too many login attempts with incorrect password
+    login_limit?: {
+      login_attempts?: number;
+      last_attempt_date?: string;
+    };
     // forgot password verification details
     password_verification?: {
       attempts?: number;
@@ -55,6 +60,8 @@ export interface User {
   };
   is?: {
     disabled?: boolean;
+    // User locked out status
+    locked_out?: boolean;
     // If the users email is verified
     verified?: boolean;
     // User phone number verification