@compassdigital/sdk.typescript 4.2.0 → 4.4.0

package/src/interface/centricos.ts

@@ -0,0 +1,120 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface AIItemDescriptionRequest {
+  name: string;
+  modifiers?: string[];
+}
+
+export interface AIItemDescriptionResponse {
+  description: string;
+}
+
+export interface BadRequestErrorDTO {
+  message: string;
+  code: number;
+  data: any;
+}
+
+export interface UnauthorizedErrorDTO {
+  message: string;
+  code: number;
+  data: any;
+}
+
+export type InternalServerErrorException = any;
+
+export interface AIItemImageRequest {
+  name?: string;
+  modifiers?: string[];
+  description: string;
+  number_of_images: number;
+}
+
+export interface ImageData {
+  data: string;
+  mime_type: string;
+}
+
+export interface AIItemImageResponse {
+  // Array of images
+  images: ImageData[];
+}
+
+export interface OrdersExportResponse {
+  // Order data in CSV
+  csv: string;
+  // CSV file name
+  fileName: string;
+}
+
+// POST /centricos/ai/item/description - Generate item description
+
+export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
+
+export type PostCentricosAiItemDescriptionResponse = AIItemDescriptionResponse;
+
+export interface PostCentricosAiItemDescriptionRequest extends BaseRequest {
+  body: PostCentricosAiItemDescriptionBody;
+}
+
+// POST /centricos/ai/item/image - Generate item image
+
+export type PostCentricosAiItemImageBody = AIItemImageRequest;
+
+export type PostCentricosAiItemImageResponse = AIItemImageResponse;
+
+export interface PostCentricosAiItemImageRequest extends BaseRequest {
+  body: PostCentricosAiItemImageBody;
+}
+
+// GET /centricos/orders/export - Get orders in csv format
+
+export interface PostCentricosOrdersExportQuery {
+  // Filter orders by site id
+  source_group_id: string;
+  // Filter orders with created date not earlier than
+  date_created_start: string;
+  // Filter orders with created date not later than this date
+  date_created_end: string;
+  // Filter orders by brand id
+  source_brand_id?: string;
+  // Filter orders by order/pickup number
+  pickup_id?: string;
+  // Filter orders by user customer name
+  pickup_name?: string;
+  // Filter orders by customer email
+  email?: string;
+  // Filter orders by payment category
+  payment_category?: ("digital wallet" | "badge pay" | "credit card" | "mealplan")[];
+  // Search order by refund_status
+  refund_status?: ("partial" | "full")[];
+  // Return items sorted by this column
+  sortBy?:
+    | "date_created"
+    | "destination"
+    | "id"
+    | "pickup"
+    | "pickup_id"
+    | "pickup_name"
+    | "source_id"
+    | "sub_total"
+    | "total"
+    | "site_name"
+    | "status"
+    | "order_type"
+    | "fulfillment_date";
+  sortOrder?: "ASC" | "DESC";
+  // Export Personal Identifiable Information
+  include_pii?: string;
+  // Graphql query string
+  _query?: string;
+}
+
+export type PostCentricosOrdersExportResponse = OrdersExportResponse;
+
+export interface PostCentricosOrdersExportRequest
+  extends BaseRequest,
+    RequestQuery<PostCentricosOrdersExportQuery> {}

package/src/interface/mealplan.ts

@@ -29,32 +29,7 @@ export interface TenderIs {
 
 export interface TendersAndAuth {
   tenders?: Tender[];
-  auth?: {
-    webview?: {
-      url?: string;
-      method?: string;
-      encoding?: string;
-      body?: {
-        [index: string]: any;
-      };
-    };
-    direct?: {
-      name?: {
-        en?: string;
-      };
-      description?: {
-        en?: string;
-      };
-      username_field?: {
-        en?: string;
-      };
-      password_field?: {
-        en?: string;
-      };
-      username_value?: string;
-      email_value?: string;
-    };
-  };
+  auth?: AuthPayload;
 }
 
 export interface VerifyEmail {
@@ -65,11 +40,40 @@ export interface success {
   success?: boolean;
 }
 
+export interface AuthPayload {
+  webview?: {
+    url?: string;
+    method?: string;
+    encoding?: string;
+    body?: {
+      [index: string]: any;
+    };
+  };
+  direct?: {
+    name?: {
+      en?: string;
+    };
+    description?: {
+      en?: string;
+    };
+    username_field?: {
+      en?: string;
+    };
+    password_field?: {
+      en?: string;
+    };
+    username_value?: string;
+    email_value?: string;
+  };
+}
+
 // POST /mealplan/{id} - Authenticate against the meal plan provider
 
 export interface PostMealplanPath {
   // Meal plan ID
   id: string;
+  // Tender ID
+  tender: string;
 }
 
 export interface PostMealplanBody {
@@ -92,6 +96,8 @@ export interface PostMealplanRequest extends BaseRequest, PostMealplanPath {
 export interface PutMealplanPath {
   // Meal plan ID
   id: string;
+  // Tender ID
+  tender: string;
 }
 
 export interface PutMealplanBody {
@@ -111,6 +117,8 @@ export interface PutMealplanRequest extends BaseRequest, PutMealplanPath {
 export interface GetMealplanPath {
   // Meal plan ID
   id: string;
+  // Tender ID
+  tender: string;
 }
 
 export interface GetMealplanQuery {
@@ -130,6 +138,8 @@ export interface GetMealplanRequest
 export interface DeleteMealplanPath {
   // Meal plan ID
   id: string;
+  // Tender ID
+  tender: string;
 }
 
 export interface DeleteMealplanBody {
@@ -154,6 +164,13 @@ export interface PostMealplanCallbackQuery {
   web?: boolean;
 }
 
+export interface PostMealplanCallbackBody {
+  // Used for ITC SSO
+  Credential?: string;
+  // Used for ITC SSO
+  token?: string;
+}
+
 export interface PostMealplanCallbackResponse {
   token?: string;
   // DH 1.0 format for returning the token
@@ -163,7 +180,9 @@ export interface PostMealplanCallbackResponse {
 export interface PostMealplanCallbackRequest
   extends BaseRequest,
     RequestQuery<PostMealplanCallbackQuery>,
-    PostMealplanCallbackPath {}
+    PostMealplanCallbackPath {
+  body: PostMealplanCallbackBody;
+}
 
 // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
 
@@ -195,6 +214,14 @@ export interface DeleteMealplanTenderPath {
   tender: string;
 }
 
+export interface DeleteMealplanTenderBody {
+  amount: number;
+  type?: string;
+  conversion_amount?: number;
+  terminal_id?: string;
+  is_split_tender?: boolean;
+}
+
 export interface DeleteMealplanTenderResponse {
   // tender
   id?: string;
@@ -202,12 +229,15 @@ export interface DeleteMealplanTenderResponse {
   balance?: number;
   is?: TenderIs;
   transaction_id?: string;
+  type?: number;
   tender_id?: number;
   currency?: string;
   transaction_amount?: number;
 }
 
-export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {}
+export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {
+  body: DeleteMealplanTenderBody;
+}
 
 // PATCH /mealplan/{id}/tender/{tender} - Refund an amount to the tender balance
 
@@ -219,7 +249,7 @@ export interface PatchMealplanTenderPath {
 }
 
 export interface PatchMealplanTenderBody {
-  amount?: number;
+  amount: number;
   transaction_id?: string;
   // Amount for order paid by user
   transaction_amount?: number;
@@ -263,7 +293,9 @@ export interface PutMealplanVerifyPath {
   id: string;
 }
 
-export type PutMealplanVerifyBody = string;
+export interface PutMealplanVerifyBody {
+  token?: string;
+}
 
 export type PutMealplanVerifyResponse = success;
 

package/src/interface/menu.ts

@@ -794,6 +794,7 @@ export interface BrandStatusDTO {
   brand_id?: FilterFieldDTO;
   type?: string;
   status?: string;
+  metadata?: FilterFieldDTO;
   id?: string;
   brand?: any;
   permissions?: FilterFieldDTO;
@@ -2356,7 +2357,7 @@ export interface PostMenuV3GlobalMenuGroupBody {
   allowed_local_menu_groups?: LocalMenuGroupDTO[];
   draft_brands?: DraftBrandDTO[];
   published_brands?: PublishedBrandDTO[];
-  posid_segment?: string;
+  posid_segment: string;
   vendor_metadata?: VendorMetadataDTO[];
   permissions?: any;
   [index: string]: any;
@@ -2434,7 +2435,7 @@ export interface DeleteMenuV3GlobalMenuGroupResponse {
   allowed_local_menu_groups?: LocalMenuGroupDTO[];
   draft_brands?: DraftBrandDTO[];
   published_brands?: PublishedBrandDTO[];
-  posid_segment?: string;
+  posid_segment: string;
   id?: string;
   created_at?: string;
   updated_at?: string;
@@ -2491,7 +2492,7 @@ export type PostMenuV3GlobalMenuGroupsBody = {
   allowed_local_menu_groups?: LocalMenuGroupDTO[];
   draft_brands?: DraftBrandDTO[];
   published_brands?: PublishedBrandDTO[];
-  posid_segment?: string;
+  posid_segment: string;
   id?: any;
   vendor_metadata?: VendorMetadataDTO[];
   permissions?: any;
@@ -3059,7 +3060,6 @@ export interface GetMenuV3DraftBrandDiffsQuery {
   soft_deleted?: "include" | "exclude" | "only";
   // Graphql query string
   _query?: string;
-  nocache?: boolean;
 }
 
 export interface GetMenuV3DraftBrandDiffsResponse {
@@ -4590,21 +4590,55 @@ export interface PostMenuV3ItemAttachmentRequest
     RequestQuery<PostMenuV3ItemAttachmentQuery>,
     PostMenuV3ItemAttachmentPath {}
 
+// POST /menu/v3/items/validate
+
+export interface PostMenuV3ItemsValidateBody {
+  brand_id: string;
+  category_id?: string;
+  data: string;
+  [index: string]: any;
+}
+
+export interface PostMenuV3ItemsValidateResponse {
+  s3_link?: string;
+}
+
+export interface PostMenuV3ItemsValidateRequest extends BaseRequest {
+  body: PostMenuV3ItemsValidateBody;
+}
+
 // POST /menu/v3/items/import
 
-export interface PostMenuV3ItemsImportQuery {
-  "body.brand_id"?: string;
-  "body.category_id"?: string;
-  "body.data"?: string;
+export interface PostMenuV3ItemsImportBody {
+  brand_id: string;
+  category_id?: string;
+  data: string;
+  [index: string]: any;
 }
 
 export interface PostMenuV3ItemsImportResponse {
-  results?: DraftItemEntityDTO[];
+  status?: string;
 }
 
-export interface PostMenuV3ItemsImportRequest
-  extends BaseRequest,
-    RequestQuery<PostMenuV3ItemsImportQuery> {}
+export interface PostMenuV3ItemsImportRequest extends BaseRequest {
+  body: PostMenuV3ItemsImportBody;
+}
+
+// POST /menu/v3/items/export
+
+export interface PostMenuV3ItemsExportBody {
+  brand_id: string;
+  category_id?: string;
+  [index: string]: any;
+}
+
+export interface PostMenuV3ItemsExportResponse {
+  s3_link?: string;
+}
+
+export interface PostMenuV3ItemsExportRequest extends BaseRequest {
+  body: PostMenuV3ItemsExportBody;
+}
 
 // GET /menu/v3/item/{id}
 

package/src/interface/order.ts

@@ -13,6 +13,10 @@ export interface CreateOrder {
   payment?: {
     token?: string;
     credit_card?: CreditCard;
+    badge_pay?: CashlessPayment;
+    stipend?: CashlessPayment;
+    voucher?: CashlessPayment;
+    coupon_voucher?: CashlessPayment;
   };
   mealplan?: MealPlan;
   // user

package/src/interface/shoppingcart.ts

@@ -229,7 +229,7 @@ export interface ShoppingCartRequest {
   brand?: string;
   is?: {
     // Shoppingcart Type: delivery, pickup
-    type?: "delivery" | "pickup" | "scan_and_go";
+    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 domain is a match in a sites list of tax exempt domains

package/src/interface/user.ts

@@ -73,6 +73,8 @@ export interface User {
     verified?: boolean;
     // User phone number verification
     phone_verified?: boolean;
+    // User deleted status
+    deleted?: boolean;
   };
   permissions?: Scopes;
   // User location group
@@ -268,6 +270,8 @@ export interface CheckInUserInfo {
   longitude?: number;
   // NFC URI required for NFC check-in
   nfc_uri?: string;
+  // Balance of the user's mealplan tender
+  tender_balance?: number;
 }
 
 export interface Scopes {
@@ -413,6 +417,8 @@ export interface PutUserPath {
 }
 
 export interface PutUserQuery {
+  // The language of the user ex en, fr
+  lang?: string;
   // Use ACL permission system
   acl?: boolean;
 }
@@ -433,6 +439,8 @@ export interface PatchUserPath {
 }
 
 export interface PatchUserQuery {
+  // The language of the user ex en, fr
+  lang?: string;
   // Use ACL permission system
   acl?: boolean;
 }
@@ -504,9 +512,13 @@ export interface PatchUserAuthKdsPath {
   device_id: string;
 }
 
+export type PatchUserAuthKdsBody = any;
+
 export type PatchUserAuthKdsResponse = KDSDevice;
 
-export interface PatchUserAuthKdsRequest extends BaseRequest, PatchUserAuthKdsPath {}
+export interface PatchUserAuthKdsRequest extends BaseRequest, PatchUserAuthKdsPath {
+  body: PatchUserAuthKdsBody;
+}
 
 // POST /user/{id}/changepassword - Change the users password
 
@@ -598,6 +610,8 @@ export interface PostUserResetPasswordTokenPath {
 export interface PostUserResetPasswordTokenQuery {
   // password reset token
   reset_token: string;
+  // The language of the user ex en, fr
+  lang?: string;
 }
 
 export type PostUserResetPasswordTokenBody = Resetpassword;
@@ -670,7 +684,9 @@ export interface PutUserPermissionsQuery {
 }
 
 export interface PutUserPermissionsBody {
-  scopes?: Permission[];
+  permissions?: {
+    scopes?: Permission[];
+  };
 }
 
 export type PutUserPermissionsResponse = User;