@compassdigital/sdk.typescript 4.28.0 → 4.30.0

package/src/interface/menu.ts

@@ -34,7 +34,6 @@ export interface Menu {
     item_desc_edit_enabled?: boolean;
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
-    frictionless?: boolean;
   };
   meta?: {
     // User ID
@@ -749,7 +748,6 @@ export interface MenuWorksDTO {
   portion_unit_name?: FilterFieldDTO;
   grams?: number;
   cost?: number;
-  calories?: number;
   id?: Record<string, any>;
   [index: string]: any;
 }
@@ -835,6 +833,14 @@ export interface BrandStatusDTO {
   [index: string]: any;
 }
 
+export interface SiteGroupDTO {
+  site_id: string;
+  local_menu_group_id: string;
+  created_at?: string;
+  updated_at?: string;
+  [index: string]: any;
+}
+
 export interface DraftMenuDraftMenuDTO {
   applied_diff_snapshot?: FilterFieldDTO;
   parent_id?: FilterFieldDTO;
@@ -1896,6 +1902,8 @@ export interface GetMenuQuery {
   show_unlinked?: boolean;
   // Show items and modifiers with weight
   include_items_with_weight?: boolean;
+  // Show out of stock entities, lower in priority to hidden and disabled
+  show_out_of_stock?: boolean;
   // Graphql query string
   _query?: string;
   nocache?: boolean;
@@ -2706,6 +2714,70 @@ export interface PostMenuV3LocalMenuGroupImportBrandsRequest
     RequestQuery<PostMenuV3LocalMenuGroupImportBrandsQuery>,
     PostMenuV3LocalMenuGroupImportBrandsPath {}
 
+// GET /menu/v3/local-menu-group/{id}/site
+
+export interface GetMenuV3LocalMenuGroupSitePath {
+  id: string;
+}
+
+export interface GetMenuV3LocalMenuGroupSiteQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3LocalMenuGroupSiteResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface GetMenuV3LocalMenuGroupSiteRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3LocalMenuGroupSiteQuery>,
+    GetMenuV3LocalMenuGroupSitePath {}
+
+// GET /menu/v3/local-menu-group/{id}/menu-group
+
+export interface GetMenuV3LocalMenuGroupMenuGroupPath {
+  id: string;
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface GetMenuV3LocalMenuGroupMenuGroupRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3LocalMenuGroupMenuGroupQuery>,
+    GetMenuV3LocalMenuGroupMenuGroupPath {}
+
+// POST /menu/v3/local-menu-groups/site-groups
+
+export type PostMenuV3LocalMenuGroupsSiteGroupsBody = SiteGroupDTO[];
+
+export interface PostMenuV3LocalMenuGroupsSiteGroupsResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface PostMenuV3LocalMenuGroupsSiteGroupsRequest extends BaseRequest {
+  body: PostMenuV3LocalMenuGroupsSiteGroupsBody;
+}
+
+// DELETE /menu/v3/local-menu-groups/site-groups
+
+export type DeleteMenuV3LocalMenuGroupsSiteGroupsBody = SiteGroupDTO[];
+
+export interface DeleteMenuV3LocalMenuGroupsSiteGroupsResponse {
+  results?: SiteGroupDTO[];
+}
+
+export interface DeleteMenuV3LocalMenuGroupsSiteGroupsRequest extends BaseRequest {
+  body: DeleteMenuV3LocalMenuGroupsSiteGroupsBody;
+}
+
 // POST /menu/v3/global-menu-group
 
 export interface PostMenuV3GlobalMenuGroupBody {
@@ -6433,19 +6505,19 @@ export interface GetMenuV3GlobalDiffsCountRequest
 
 export interface GetMenuV3MenuworksQuery {
   unit_id?: string;
-  MRN?: string;
+  MRN?: number;
   // Graphql query string
   _query?: string;
 }
 
 export interface GetMenuV3MenuworksResponse {
+  calories?: number;
   MRN?: string;
   unit_id?: string;
   portion_quantity?: number;
   portion_unit_name?: string;
   grams?: number;
   cost?: number;
-  calories?: number;
   [index: string]: any;
 }
 

package/src/interface/partner.ts

@@ -335,8 +335,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: Hours[];
+    deliveryHours?: DeliveryHours[];
     service_fee?: {
       type?: string;
       value?: number;
@@ -574,6 +574,7 @@ export interface Menu {
     item_desc_edit_enabled?: boolean;
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
+    frictionless?: boolean;
   };
   meta?: {
     // User ID

package/src/interface/payment.ts

@@ -204,7 +204,7 @@ export interface ApplePayMerchantSession {
 // POST /payment/{id}/transaction
 
 export interface PostPaymentTransactionPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -242,9 +242,9 @@ export interface PostPaymentTransactionRequest extends BaseRequest, PostPaymentT
 // POST /payment/{id}/transaction/{transaction_id}/refund
 
 export interface PostPaymentTransactionRefundPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
-  // TODO: add parameter to swagger.json
+  // Transaction ID
   transaction_id: string;
 }
 
@@ -266,7 +266,7 @@ export interface PostPaymentTransactionRefundRequest
 // GET /payment/{id}/clienttoken
 
 export interface GetPaymentClienttokenPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -287,7 +287,7 @@ export interface GetPaymentClienttokenRequest
 // POST /payment/{id}/paymenttoken
 
 export interface PostPaymentPaymenttokenPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -345,26 +345,6 @@ export interface PostPaymentMethodRequest extends BaseRequest {
   body: PostPaymentMethodBody;
 }
 
-// DELETE /payment/{id}/method/{method_id}
-
-export interface DeletePaymentMethodPath {
-  // TODO: add parameter to swagger.json
-  id: string;
-  // TODO: add parameter to swagger.json
-  method_id: string;
-}
-
-export interface DeletePaymentMethodBody {
-  // The user from where the payment method will be deleted
-  user: string;
-}
-
-export type DeletePaymentMethodResponse = Success;
-
-export interface DeletePaymentMethodRequest extends BaseRequest, DeletePaymentMethodPath {
-  body: DeletePaymentMethodBody;
-}
-
 // GET /payment/token
 
 export interface GetPaymentTokenQuery {
@@ -462,7 +442,7 @@ export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPayme
 // GET /payment/{id}/cashless
 
 export interface GetPaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -483,7 +463,7 @@ export interface GetPaymentCashlessRequest
 // POST /payment/{id}/cashless
 
 export interface PostPaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 
@@ -503,7 +483,7 @@ export interface PostPaymentCashlessRequest extends BaseRequest, PostPaymentCash
 // DELETE /payment/{id}/cashless
 
 export interface DeletePaymentCashlessPath {
-  // TODO: add parameter to swagger.json
+  // Payment ID
   id: string;
 }
 

package/src/interface/promo.ts

@@ -427,7 +427,6 @@ export interface PostPromoVoucherRequest extends BaseRequest {
 // PUT /promo/voucher/{id} - Update voucher
 
 export interface PutPromoVoucherPath {
-  // TODO: add parameter to swagger.json
   id: string;
 }
 
@@ -442,7 +441,6 @@ export interface PutPromoVoucherRequest extends BaseRequest, PutPromoVoucherPath
 // DELETE /promo/voucher/{id} - Delete voucher
 
 export interface DeletePromoVoucherPath {
-  // TODO: add parameter to swagger.json
   id: string;
 }
 
@@ -460,7 +458,7 @@ export interface DeletePromoVoucherRequest
     RequestQuery<DeletePromoVoucherQuery>,
     DeletePromoVoucherPath {}
 
-// POST /promo/customer/ - Add user to voucherify
+// POST /promo/customer - Add user to voucherify
 
 export type PostPromoCustomerBody = VoucherifyCustomer;
 
@@ -470,7 +468,7 @@ export interface PostPromoCustomerRequest extends BaseRequest {
   body: PostPromoCustomerBody;
 }
 
-// DELETE /promo/customer/ - Delete user from voucherify
+// DELETE /promo/customer - Delete user from voucherify
 
 export interface DeletePromoCustomerBody {
   user_id?: string;

package/src/interface/shoppingcart.ts

@@ -430,7 +430,7 @@ export interface FPValidationData {
 
 export type AmountOffExclusion = "discount" | "promo";
 
-// POST /shoppingcart/ - Create a new ShoppingCart
+// POST /shoppingcart - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;
 
@@ -534,7 +534,7 @@ export interface DeleteShoppingcartCartPromoRequest
   extends BaseRequest,
     DeleteShoppingcartCartPromoPath {}
 
-// PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
+// PUT /shoppingcart/{id}/paymentmethod - Change payment method used in shopping cart
 
 export interface PutShoppingcartCartPaymentPath {
   // Shopping cart ID
@@ -570,7 +570,7 @@ export interface GetShoppingcartPaymentMethodsRequest
     RequestQuery<GetShoppingcartPaymentMethodsQuery>,
     GetShoppingcartPaymentMethodsPath {}
 
-// PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
+// PUT /shoppingcart/{id}/order - Store information about the order created with this shopping cart
 
 export interface PutShoppingcartCartOrderPath {
   // Shopping cart ID

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "conventionalCommits.scopes": [
-    "typescript.sdk"
-  ]
-}