@compassdigital/sdk.typescript 3.38.0 → 3.40.0

package/src/interface/menu.ts

@@ -299,20 +299,45 @@ export interface ZippedExcelExport {
   format?: string;
 }
 
+// GET /menu/modifier/count
+
+export interface GetMenuModifierCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuModifierCountResponse {
+  count?: number;
+}
+
+export interface GetMenuModifierCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuModifierCountQuery> {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {
   client_id: string;
 }
 
+export interface GetMenuClientQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuClientResponse = Menus;
 
-export interface GetMenuClientRequest extends BaseRequest, GetMenuClientPath {}
+export interface GetMenuClientRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuClientQuery>,
+    GetMenuClientPath {}
 
 // GET /menu - Get Menus or search for Menus
 
 export interface GetMenusQuery {
   query: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenusResponse = Menus;
@@ -357,7 +382,7 @@ export interface GetMenuQuery {
   extended?: boolean;
   // Show unlinked groups
   show_unlinked?: boolean;
-  // fields to return
+  // Graphql query string
   _query?: string;
   nocache?: boolean;
 }
@@ -446,6 +471,8 @@ export interface GetMenuItemPath {
 }
 
 export interface GetMenuItemQuery {
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -481,6 +508,8 @@ export interface PostMenuItemRequest extends BaseRequest {
 
 export interface GetMenuItemsQuery {
   query: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuItemsResponse = Items;
@@ -507,9 +536,17 @@ export interface GetMenuLocationItemsPath {
   location: string;
 }
 
+export interface GetMenuLocationItemsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuLocationItemsResponse = Items;
 
-export interface GetMenuLocationItemsRequest extends BaseRequest, GetMenuLocationItemsPath {}
+export interface GetMenuLocationItemsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuLocationItemsQuery>,
+    GetMenuLocationItemsPath {}
 
 // GET /menu/item/random/location/{location} - Get a random item
 
@@ -525,6 +562,8 @@ export interface GetMenuLocationItemRandomQuery {
   is_public?: boolean;
   // The start of the session, prevents duplicates for any items voted on from the start time.
   start_time?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuLocationItemRandomResponse = Item;
@@ -550,6 +589,8 @@ export interface GetMenuLocationItemsRandomQuery {
   count?: number;
   // The start of the session, prevents duplicates for any items voted on from the start time.
   start_time?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuLocationItemsRandomResponse = Items;
@@ -566,9 +607,17 @@ export interface GetMenuSectorMenusPath {
   sector: string;
 }
 
+export interface GetMenuSectorMenusQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuSectorMenusResponse = Menus;
 
-export interface GetMenuSectorMenusRequest extends BaseRequest, GetMenuSectorMenusPath {}
+export interface GetMenuSectorMenusRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuSectorMenusQuery>,
+    GetMenuSectorMenusPath {}
 
 // GET /menu/company/{company} - Get menus that belong to company
 
@@ -577,9 +626,17 @@ export interface GetMenuCompanyMenusPath {
   company: string;
 }
 
+export interface GetMenuCompanyMenusQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuCompanyMenusResponse = Menus;
 
-export interface GetMenuCompanyMenusRequest extends BaseRequest, GetMenuCompanyMenusPath {}
+export interface GetMenuCompanyMenusRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuCompanyMenusQuery>,
+    GetMenuCompanyMenusPath {}
 
 // POST /menu/modifier/group - Create a new Menu Modifier Group
 
@@ -598,9 +655,17 @@ export interface GetMenuModifierGroupPath {
   id: string;
 }
 
+export interface GetMenuModifierGroupQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuModifierGroupResponse = OptionsGroup;
 
-export interface GetMenuModifierGroupRequest extends BaseRequest, GetMenuModifierGroupPath {}
+export interface GetMenuModifierGroupRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuModifierGroupQuery>,
+    GetMenuModifierGroupPath {}
 
 // PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
 
@@ -635,10 +700,16 @@ export interface GetMenuCompanyModifierGroupsPath {
   company: string;
 }
 
+export interface GetMenuCompanyModifierGroupsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuCompanyModifierGroupsResponse = OptionsGroupList;
 
 export interface GetMenuCompanyModifierGroupsRequest
   extends BaseRequest,
+    RequestQuery<GetMenuCompanyModifierGroupsQuery>,
     GetMenuCompanyModifierGroupsPath {}
 
 // GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
@@ -648,10 +719,16 @@ export interface GetMenuCompanyModifierGroupsExportPath {
   company: string;
 }
 
+export interface GetMenuCompanyModifierGroupsExportQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuCompanyModifierGroupsExportResponse = ZippedExcelExport;
 
 export interface GetMenuCompanyModifierGroupsExportRequest
   extends BaseRequest,
+    RequestQuery<GetMenuCompanyModifierGroupsExportQuery>,
     GetMenuCompanyModifierGroupsExportPath {}
 
 // GET /menu/{id}/export - Export menu set to zipped excel file.
@@ -661,9 +738,17 @@ export interface GetMenuExportPath {
   id: string;
 }
 
+export interface GetMenuExportQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMenuExportResponse = ZippedExcelExport;
 
-export interface GetMenuExportRequest extends BaseRequest, GetMenuExportPath {}
+export interface GetMenuExportRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuExportQuery>,
+    GetMenuExportPath {}
 
 // GET /menu/partial/{id}/groups - Get an individual menu with its categories only partially loaded. (No items)
 
@@ -677,6 +762,8 @@ export interface GetMenuPartialGroupsQuery {
   extended?: boolean;
   // Show unlinked groups
   show_unlinked?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuPartialGroupsResponse = Menu;
@@ -698,6 +785,8 @@ export interface GetMenuPartialGroupItemsPath {
 export interface GetMenuPartialGroupItemsQuery {
   // Show additional fields like hidden menu items, parent_id. Defaults to false
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuPartialGroupItemsResponse = Items;

package/src/interface/notification.ts

@@ -46,6 +46,8 @@ export interface GetNotificationsQuery {
   start?: string;
   // End date of the notifications. If not provided will default to current date.
   end?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetNotificationsResponse {
@@ -107,8 +109,15 @@ export interface PostNotificationStatusRequest extends BaseRequest, PostNotifica
 
 // GET /notification/swagger.json - Get a swagger for notification service
 
+export interface GetNotificationSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetNotificationSwaggerResponse {
   [index: string]: any;
 }
 
-export interface GetNotificationSwaggerRequest extends BaseRequest {}
+export interface GetNotificationSwaggerRequest
+  extends BaseRequest,
+    RequestQuery<GetNotificationSwaggerQuery> {}

package/src/interface/order.ts

@@ -144,6 +144,8 @@ export interface Order {
         amount?: number;
         meals?: number;
       };
+      // the amount remaining on the transaction after refund - remaining amount available for refund
+      transaction_remainder_amount?: number;
       [index: string]: any;
     };
     // Shoppingcart details
@@ -172,6 +174,8 @@ export interface RefundTransaction {
   refund_date?: string;
   // user
   issued_by?: string;
+  amount?: number;
+  refund_amount?: number;
   [index: string]: any;
 }
 
@@ -324,9 +328,14 @@ export interface GetOrderPath {
   id: string;
 }
 
+export interface GetOrderQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetOrderResponse = Order;
 
-export interface GetOrderRequest extends BaseRequest, GetOrderPath {}
+export interface GetOrderRequest extends BaseRequest, RequestQuery<GetOrderQuery>, GetOrderPath {}
 
 // PUT /order/{id} - Update an individual order
 
@@ -404,6 +413,8 @@ export interface GetOrderCustomerOrdersQuery {
   start?: number;
   // This is the key for which the query will be made. E.g if order_type equals 'delivery', the response will include the results based on delivery
   order_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetOrderCustomerOrdersResponse {
@@ -424,10 +435,16 @@ export interface GetOrderCustomerOrdersBrandPath {
   location_brand: string;
 }
 
+export interface GetOrderCustomerOrdersBrandQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetOrderCustomerOrdersBrandResponse = Orders;
 
 export interface GetOrderCustomerOrdersBrandRequest
   extends BaseRequest,
+    RequestQuery<GetOrderCustomerOrdersBrandQuery>,
     GetOrderCustomerOrdersBrandPath {}
 
 // GET /order/location/brand/{id} - Get all orders for a location Brand
@@ -454,6 +471,8 @@ export interface GetOrderLocationBrandQuery {
   limit?: number;
   // return orders with all status types
   all_statuses?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetOrderLocationBrandResponse = Orders;
@@ -485,6 +504,8 @@ export interface GetOrderLocationOrdersQuery {
   order_type?: string;
   // List of brands you want orders for inside this location. Example: 616kLp3ADNUE2RO8qqzdto8avzyRrOhXRDW5,or2ayBJePqUP4ORXeeGgTw96vKle47IgemPk
   brands?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetOrderLocationOrdersResponse = Orders;
@@ -514,6 +535,8 @@ export interface GetOrderGroupOrdersQuery {
   brand?: string;
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetOrderGroupOrdersResponse {
@@ -541,6 +564,8 @@ export interface GetOrderUserOrdersQuery {
   end?: number;
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetOrderUserOrdersResponse {