@compassdigital/sdk.typescript 3.45.1 → 3.45.2

package/src/interface/menu.ts

@@ -27,6 +27,16 @@ export interface LayoutListResponse {
   results?: Layout[];
 }
 
+export interface BrandListResponse {
+  meta?: Meta;
+  results?: Brand[];
+}
+
+export interface StationListResponse {
+  meta?: Meta;
+  results?: Station[];
+}
+
 export interface CategoryListResponse {
   meta?: Meta;
   results?: Category[];
@@ -80,6 +90,8 @@ export interface Modifier {
   created_at?: string;
   updated_at?: string;
   deleted_at?: string;
+  brand_id?: string;
+  station_id?: string;
   [index: string]: any;
 }
 
@@ -94,6 +106,8 @@ export interface ModifierGroup {
   created_at?: string;
   updated_at?: string;
   deleted_at?: string;
+  brand_id?: string;
+  station_id?: string;
   [index: string]: any;
 }
 
@@ -113,6 +127,8 @@ export interface LocalItem {
   created_at?: string;
   updated_at?: string;
   deleted_at?: string;
+  brand_id?: string;
+  station_id?: string;
   [index: string]: any;
 }
 
@@ -131,6 +147,24 @@ export interface Layout {
   created_at?: string;
   updated_at?: string;
   deleted_at?: string;
+  brand_id?: string;
+  station_id?: string;
+  [index: string]: any;
+}
+
+export interface Brand {
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface Station {
+  id?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
   [index: string]: any;
 }
 
@@ -827,94 +861,34 @@ export interface DeleteMenuV3ItemRelationshipsModifierGroupRequest
   extends BaseRequest,
     DeleteMenuV3ItemRelationshipsModifierGroupPath {}
 
-// GET /menu/v3/menus
-
-export interface GetMenuV3MenusQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetMenuV3MenusResponse = MenuV2ListResponse;
-
-export interface GetMenuV3MenusRequest extends BaseRequest, RequestQuery<GetMenuV3MenusQuery> {}
-
-// GET /menu/v3/menu/{id}
-
-export interface GetMenuV3MenuPath {
-  id: string;
-}
+// GET /menu/v3/layouts
 
-export interface GetMenuV3MenuQuery {
+export interface GetMenuV3LayoutsQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetMenuV3MenuResponse = MenuV2;
-
-export interface GetMenuV3MenuRequest
-  extends BaseRequest,
-    RequestQuery<GetMenuV3MenuQuery>,
-    GetMenuV3MenuPath {}
-
-// PATCH /menu/v3/menu/{id}
-
-export interface PatchMenuV3MenuPath {
-  id: string;
-}
-
-export type PatchMenuV3MenuBody = MenuV2;
-
-export type PatchMenuV3MenuResponse = MenuV2;
+export type GetMenuV3LayoutsResponse = LayoutListResponse;
 
-export interface PatchMenuV3MenuRequest extends BaseRequest, PatchMenuV3MenuPath {
-  body: PatchMenuV3MenuBody;
-}
+export interface GetMenuV3LayoutsRequest extends BaseRequest, RequestQuery<GetMenuV3LayoutsQuery> {}
 
-// DELETE /menu/v3/menu/{id}
+// GET /menu/v3/layout/{id}/categories
 
-export interface DeleteMenuV3MenuPath {
+export interface GetMenuV3LayoutCategoriesPath {
   id: string;
 }
 
-export type DeleteMenuV3MenuResponse = MenuV2;
-
-export interface DeleteMenuV3MenuRequest extends BaseRequest, DeleteMenuV3MenuPath {}
-
-// POST /menu/v3/menu
-
-export type PostMenuV3MenuBody = MenuV2;
-
-export type PostMenuV3MenuResponse = MenuV2;
-
-export interface PostMenuV3MenuRequest extends BaseRequest {
-  body: PostMenuV3MenuBody;
-}
-
-// GET /menu/v3/menus/count
-
-export interface GetMenuV3MenusCountQuery {
+export interface GetMenuV3LayoutCategoriesQuery {
   // Graphql query string
   _query?: string;
 }
 
-export interface GetMenuV3MenusCountResponse {
-  count?: number;
-}
+export type GetMenuV3LayoutCategoriesResponse = CategoryListResponse;
 
-export interface GetMenuV3MenusCountRequest
+export interface GetMenuV3LayoutCategoriesRequest
   extends BaseRequest,
-    RequestQuery<GetMenuV3MenusCountQuery> {}
-
-// GET /menu/v3/layouts
-
-export interface GetMenuV3LayoutsQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetMenuV3LayoutsResponse = LayoutListResponse;
-
-export interface GetMenuV3LayoutsRequest extends BaseRequest, RequestQuery<GetMenuV3LayoutsQuery> {}
+    RequestQuery<GetMenuV3LayoutCategoriesQuery>,
+    GetMenuV3LayoutCategoriesPath {}
 
 // GET /menu/v3/layout/{id}
 
@@ -1124,6 +1098,218 @@ export interface DeleteMenuV3CategoryRelationshipsItemRequest
   extends BaseRequest,
     DeleteMenuV3CategoryRelationshipsItemPath {}
 
+// GET /menu/v3/brands
+
+export interface GetMenuV3BrandsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3BrandsResponse = BrandListResponse;
+
+export interface GetMenuV3BrandsRequest extends BaseRequest, RequestQuery<GetMenuV3BrandsQuery> {}
+
+// GET /menu/v3/brand/{id}/modifiers
+
+export interface GetMenuV3BrandModifiersPath {
+  id: string;
+}
+
+export interface GetMenuV3BrandModifiersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3BrandModifiersResponse = ModifiersListResponse;
+
+export interface GetMenuV3BrandModifiersRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3BrandModifiersQuery>,
+    GetMenuV3BrandModifiersPath {}
+
+// GET /menu/v3/brand/{id}/modifier_groups
+
+export interface GetMenuV3BrandModifier_groupsPath {
+  id: string;
+}
+
+export interface GetMenuV3BrandModifier_groupsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3BrandModifier_groupsResponse = ModifierGroupsListResponse;
+
+export interface GetMenuV3BrandModifier_groupsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3BrandModifier_groupsQuery>,
+    GetMenuV3BrandModifier_groupsPath {}
+
+// GET /menu/v3/brand/{id}/items
+
+export interface GetMenuV3BrandItemsPath {
+  id: string;
+}
+
+export interface GetMenuV3BrandItemsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3BrandItemsResponse = ItemsListResponse;
+
+export interface GetMenuV3BrandItemsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3BrandItemsQuery>,
+    GetMenuV3BrandItemsPath {}
+
+// GET /menu/v3/brand/{id}
+
+export interface GetMenuV3BrandPath {
+  id: string;
+}
+
+export interface GetMenuV3BrandQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3BrandResponse = Brand;
+
+export interface GetMenuV3BrandRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3BrandQuery>,
+    GetMenuV3BrandPath {}
+
+// PATCH /menu/v3/brand/{id}
+
+export interface PatchMenuV3BrandPath {
+  id: string;
+}
+
+export type PatchMenuV3BrandBody = Brand;
+
+export type PatchMenuV3BrandResponse = Brand;
+
+export interface PatchMenuV3BrandRequest extends BaseRequest, PatchMenuV3BrandPath {
+  body: PatchMenuV3BrandBody;
+}
+
+// DELETE /menu/v3/brand/{id}
+
+export interface DeleteMenuV3BrandPath {
+  id: string;
+}
+
+export type DeleteMenuV3BrandResponse = Brand;
+
+export interface DeleteMenuV3BrandRequest extends BaseRequest, DeleteMenuV3BrandPath {}
+
+// POST /menu/v3/brand
+
+export type PostMenuV3BrandBody = Brand;
+
+export type PostMenuV3BrandResponse = Brand;
+
+export interface PostMenuV3BrandRequest extends BaseRequest {
+  body: PostMenuV3BrandBody;
+}
+
+// GET /menu/v3/brands/count
+
+export interface GetMenuV3BrandsCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3BrandsCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV3BrandsCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3BrandsCountQuery> {}
+
+// GET /menu/v3/stations
+
+export interface GetMenuV3StationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3StationsResponse = StationListResponse;
+
+export interface GetMenuV3StationsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3StationsQuery> {}
+
+// GET /menu/v3/station/{id}
+
+export interface GetMenuV3StationPath {
+  id: string;
+}
+
+export interface GetMenuV3StationQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV3StationResponse = Station;
+
+export interface GetMenuV3StationRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3StationQuery>,
+    GetMenuV3StationPath {}
+
+// PATCH /menu/v3/station/{id}
+
+export interface PatchMenuV3StationPath {
+  id: string;
+}
+
+export type PatchMenuV3StationBody = Station;
+
+export type PatchMenuV3StationResponse = Station;
+
+export interface PatchMenuV3StationRequest extends BaseRequest, PatchMenuV3StationPath {
+  body: PatchMenuV3StationBody;
+}
+
+// DELETE /menu/v3/station/{id}
+
+export interface DeleteMenuV3StationPath {
+  id: string;
+}
+
+export type DeleteMenuV3StationResponse = Station;
+
+export interface DeleteMenuV3StationRequest extends BaseRequest, DeleteMenuV3StationPath {}
+
+// POST /menu/v3/station
+
+export type PostMenuV3StationBody = Station;
+
+export type PostMenuV3StationResponse = Station;
+
+export interface PostMenuV3StationRequest extends BaseRequest {
+  body: PostMenuV3StationBody;
+}
+
+// GET /menu/v3/stations/count
+
+export interface GetMenuV3StationsCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3StationsCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV3StationsCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3StationsCountQuery> {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {

package/src/interface/order.ts

@@ -105,16 +105,29 @@ export interface Order {
     out_for_delivery?: boolean;
     delivered?: boolean;
     checkin_order?: boolean;
+    no_show?: boolean;
   };
   date?: {
+    // Date order was accepted into our system and shown on kitchen apps
     accepted?: string;
     created?: string;
     modified?: string;
+    // Date kitchen should start preparation ideally(not mandatory)
     should_start?: string;
+    // Date kitchen should be half way preparation ideally(not mandatory)
     completion_warning?: string;
+    // Date kitchen finished preparation
     ready?: string;
+    // Date kitchen started preparation
     started?: string;
+    // Date till which show orders as active
     show_as_active_until?: string;
+    // For delivery orders - date customer did not pick the order
+    no_show?: string;
+    // For delivery orders - date order was delivered to destination(not picked by user)
+    delivered?: string;
+    // For delivery orders - date order was picked up from station for delivery(out_for_delivery)
+    pickup?: string;
   };
   pickup?: string;
   pickup_name?: string;
@@ -161,6 +174,14 @@ export interface Order {
     };
     // Indicate whether the order is active or inactive
     active?: boolean;
+    // Delivery details
+    delivery?: {
+      // provider
+      provider?: string;
+      tracker_url?: string;
+      loading_code?: string;
+      [index: string]: any;
+    };
     [index: string]: any;
   };
   issue?: Issue;