@compassdigital/sdk.typescript 4.50.0 → 4.52.0

package/src/interface/menu.ts

@@ -137,6 +137,7 @@ export interface Item {
     barcodes?: string[];
     tax?: {
       tax_tag_code?: string;
+      tax_jwo_code?: string;
     };
     [index: string]: any;
   };
@@ -257,7 +258,6 @@ export interface Option {
     sort_number?: number;
     // menu sort order
     menu_sort_number?: number;
-    plu?: string;
     sizing?: {
       name?: string;
       posid?: string;
@@ -384,7 +384,7 @@ export interface DraftBrandDTO {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   applied_diff_snapshot?: Record<string, any>;
   permissions?: Record<string, any>;
   [index: string]: any;
@@ -401,7 +401,7 @@ export interface PublishedBrandDTO {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -619,6 +619,7 @@ export interface DraftItemDTO {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: Record<string, any>[];
@@ -855,6 +856,19 @@ export interface BrandStatusDTO {
   [index: string]: any;
 }
 
+export interface AuditDTO {
+  process_id?: string;
+  brand_id?: string;
+  status_type?: string;
+  status?: string;
+  message?: string;
+  id?: string;
+  data?: Record<string, any>;
+  brand?: DraftBrandDTO;
+  permissions?: Record<string, any>;
+  [index: string]: any;
+}
+
 export interface SiteGroupWithMenuGroupNameResponseDTO {
   site_id: string;
   local_menu_group_id: string;
@@ -872,6 +886,23 @@ export interface SiteGroupDTO {
   [index: string]: any;
 }
 
+export interface AuditListDraftItemDTO {
+  process_id: string;
+  brand_id: string;
+  status_type: string;
+  status: string;
+  message: string;
+  id: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  data?: Record<string, any>;
+  version?: number;
+  brand?: DraftBrandDTO;
+  permissions?: Record<string, any>;
+  [index: string]: any;
+}
+
 export interface ReportingCategorySuggestion {
   category?: string;
   occurrences?: number;
@@ -990,6 +1021,7 @@ export interface PublishedItemDTO {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1338,6 +1370,7 @@ export interface DraftItemEntityDTO {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1613,6 +1646,25 @@ export interface GetMenuItemsRequest
     RequestQuery<GetMenuItemsQuery>,
     GetMenuItemsPath {}
 
+// POST /menu/{id}/recommended - get recommended items
+
+export interface PostMenuRecommendedPath {
+  // menu
+  id: string;
+}
+
+export interface PostMenuRecommendedBody {
+  excluded_items?: string[];
+}
+
+export interface PostMenuRecommendedResponse {
+  items?: Item[];
+}
+
+export interface PostMenuRecommendedRequest extends BaseRequest, PostMenuRecommendedPath {
+  body: PostMenuRecommendedBody;
+}
+
 // POST /menu/items/import/{location} - trigger import items
 
 export interface ImportItemsCanteenPath {
@@ -2609,6 +2661,7 @@ export interface PostMenuV3DraftBrandBody {
   modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
   modifiers?: DraftModifierDTO[];
   statuses?: BrandStatusDTO[];
+  audit_logs?: AuditDTO[];
   name: string;
   description?: string;
   is_active?: boolean;
@@ -2618,7 +2671,7 @@ export interface PostMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
@@ -2675,6 +2728,7 @@ export interface PatchMenuV3DraftBrandBody {
   modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
   modifiers?: DraftModifierDTO[];
   statuses?: BrandStatusDTO[];
+  audit_logs?: AuditDTO[];
   id?: string;
   name?: string;
   description?: string;
@@ -2685,7 +2739,7 @@ export interface PatchMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   changes?: BrandChangeDTO[];
@@ -2765,6 +2819,7 @@ export type PostMenuV3DraftBrandsBody = {
   modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
   modifiers?: DraftModifierDTO[];
   statuses?: BrandStatusDTO[];
+  audit_logs?: AuditDTO[];
   name: string;
   description?: string;
   is_active?: boolean;
@@ -2774,7 +2829,7 @@ export type PostMenuV3DraftBrandsBody = {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
@@ -2813,6 +2868,41 @@ export interface GetMenuV3DraftBrandsCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV3DraftBrandsCountQuery> {}
 
+// GET /menu/v3/draft/brand/{id}/audits
+
+export interface GetMenuV3DraftBrandAuditsPath {
+  id: string;
+}
+
+export interface GetMenuV3DraftBrandAuditsQuery {
+  // If specified, only the selected fields will be returned
+  select?: string[];
+  // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
+  relationships?: string[];
+  filter?: string;
+  // Number of records to load per page
+  limit?: number;
+  page?: number;
+  // A field to sort the results based on
+  sort_by?: string;
+  sort_order?: "DESC" | "ASC";
+  // How soft deleted records should be shown in the list
+  soft_deleted?: "include" | "exclude" | "only";
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3DraftBrandAuditsResponse {
+  results: AuditListDraftItemDTO[];
+  meta?: ListResponseMetadataDTO;
+  [index: string]: any;
+}
+
+export interface GetMenuV3DraftBrandAuditsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3DraftBrandAuditsQuery>,
+    GetMenuV3DraftBrandAuditsPath {}
+
 // GET /menu/v3/draft/brand/{id}/menus
 
 export interface GetMenuV3DraftBrandMenusPath {
@@ -3167,7 +3257,7 @@ export interface PostMenuV3BrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
   attachments?: FileAttachmentsDTO;
@@ -3235,7 +3325,7 @@ export interface PatchMenuV3BrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   version?: number;
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
@@ -3327,7 +3417,7 @@ export type PostMenuV3BrandsBody = {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
-  frictionless_partner?: "AWS";
+  frictionless_partner?: string;
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
   attachments?: FileAttachmentsDTO;
@@ -4363,6 +4453,7 @@ export interface PostMenuV3DraftItemBody {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4435,6 +4526,7 @@ export interface PatchMenuV3DraftItemBody {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -4529,6 +4621,7 @@ export type PostMenuV3DraftItemsBody = {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4619,6 +4712,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
   tax_tag_code?: string;
   tags?: string[];
   is_featured?: boolean;
+  tax_jwo_code?: string;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];

package/src/interface/shoppingcart.ts

@@ -64,6 +64,9 @@ export interface ItemResponse {
     brand?: string;
     brand_label?: Label;
     taxes?: string[];
+    tax?: {
+      tax_tag_code?: string;
+    };
     menu_tax_tags?: string[];
     orderable?: boolean;
     volante_id?: string;
@@ -83,6 +86,12 @@ export interface ItemResponse {
   menu_label?: Label;
   tax_rate?: MonetaryValue;
   label?: Label;
+  reporting?: {
+    category?: {
+      primary?: string;
+      secondary?: string;
+    };
+  };
 }
 
 export interface ModifierGroupRequest {
@@ -241,6 +250,8 @@ export interface ShoppingCartRequest {
     email_tax_exempt?: boolean;
     // Indicates to clients that a tax recalculation is required
     tax_calculation_required?: boolean;
+    // Indicates that the shopping cart is a system 365 shopping cart
+    system365?: boolean;
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
@@ -272,6 +283,7 @@ export interface ShoppingCartResponse {
     app?: string;
     discount?: Record<string, any>;
     provider_data?: FPValidationData;
+    order?: PromoOrder;
   };
   //@deprecated
   loyalty?: {
@@ -331,6 +343,8 @@ export interface ShoppingCartResponse {
     email_tax_exempt?: boolean;
     // Indicates to clients that a tax recalculation is required
     tax_calculation_required?: boolean;
+    // Indicates that the shopping cart is a system 365 shopping cart
+    system365?: boolean;
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
@@ -435,6 +449,26 @@ export interface FPValidationData {
 
 export type AmountOffExclusion = "discount" | "promo";
 
+export interface PromoOrder {
+  items_applied_discount_amount?: number;
+  amount?: number;
+  items_discount_amount?: number;
+  total_amount?: number;
+  total_applied_discount_amount?: number;
+  total_discount_amount?: number;
+  items?: PromoItem[];
+}
+
+export interface PromoItem {
+  applied_discount_amount?: number;
+  amount?: number;
+  discount_amount?: number;
+  price?: number;
+  quantity?: number;
+  source_id?: string;
+  subtotal_amount?: number;
+}
+
 // POST /shoppingcart - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;

package/src/interface/user.ts

@@ -348,13 +348,13 @@ export interface PostUserAuthRequest extends BaseRequest {
 
 export interface PostUserOauthBody {
   // OMS code from commpass sso
-  code?: string;
+  code: string;
   // the oms url for compass
-  oms_url?: string;
+  oms_url: string;
   // the return uri for compassconnect
-  callback_uri?: string;
+  callback_uri: string;
   // the id of the application for compassconnect
-  client_id?: string;
+  client_id: string;
 }
 
 export type PostUserOauthResponse = omsauth;