@compassdigital/sdk.typescript 3.38.0 → 3.39.0

package/src/interface/menu.ts

@@ -305,14 +305,24 @@ 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 +367,7 @@ export interface GetMenuQuery {
   extended?: boolean;
   // Show unlinked groups
   show_unlinked?: boolean;
-  // fields to return
+  // Graphql query string
   _query?: string;
   nocache?: boolean;
 }
@@ -446,6 +456,8 @@ export interface GetMenuItemPath {
 }
 
 export interface GetMenuItemQuery {
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -481,6 +493,8 @@ export interface PostMenuItemRequest extends BaseRequest {
 
 export interface GetMenuItemsQuery {
   query: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuItemsResponse = Items;
@@ -507,9 +521,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 +547,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 +574,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 +592,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 +611,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 +640,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 +685,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 +704,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 +723,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 +747,8 @@ export interface GetMenuPartialGroupsQuery {
   extended?: boolean;
   // Show unlinked groups
   show_unlinked?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetMenuPartialGroupsResponse = Menu;
@@ -698,6 +770,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

@@ -324,9 +324,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 +409,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 +431,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 +467,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 +500,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 +531,8 @@ export interface GetOrderGroupOrdersQuery {
   brand?: string;
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetOrderGroupOrdersResponse {
@@ -541,6 +560,8 @@ export interface GetOrderUserOrdersQuery {
   end?: number;
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetOrderUserOrdersResponse {

package/src/interface/partner.ts

@@ -703,17 +703,31 @@ export interface PostPartnerStandardcognitionShoppingcartRequest extends BaseReq
 
 // GET /partner/standardcognition/locations - Gets the locations where Standard Cognition is available
 
+export interface GetPartnerStandardcognitionLocationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerStandardcognitionLocationsResponse {
   groups?: LocationGroup;
 }
 
-export interface GetPartnerStandardcognitionLocationsRequest extends BaseRequest {}
+export interface GetPartnerStandardcognitionLocationsRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerStandardcognitionLocationsQuery> {}
 
 // GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
 
+export interface GetPartnerStandardcognitionStoresQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
 
-export interface GetPartnerStandardcognitionStoresRequest extends BaseRequest {}
+export interface GetPartnerStandardcognitionStoresRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerStandardcognitionStoresQuery> {}
 
 // POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
 
@@ -738,11 +752,18 @@ export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
 
 // GET /partner/coolr/locations - Gets the locations where Coolr is available
 
+export interface GetPartnerCoolrLocationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerCoolrLocationsResponse {
   locations?: CoolrLocations[];
 }
 
-export interface GetPartnerCoolrLocationsRequest extends BaseRequest {}
+export interface GetPartnerCoolrLocationsRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerCoolrLocationsQuery> {}
 
 // GET /partner/coolr/{id}/images - Gets the latest images for Coolr Location AssetID
 
@@ -751,16 +772,31 @@ export interface GetPartnerCoolrImagesPath {
   id: string;
 }
 
+export interface GetPartnerCoolrImagesQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerCoolrImagesResponse {
   images?: CoolrImages;
 }
 
-export interface GetPartnerCoolrImagesRequest extends BaseRequest, GetPartnerCoolrImagesPath {}
+export interface GetPartnerCoolrImagesRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerCoolrImagesQuery>,
+    GetPartnerCoolrImagesPath {}
 
 // GET /partner/swagger.json
 
+export interface GetPartnerSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerSwaggerResponse {
   [index: string]: any;
 }
 
-export interface GetPartnerSwaggerRequest extends BaseRequest {}
+export interface GetPartnerSwaggerRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerSwaggerQuery> {}

package/src/interface/payment.ts

@@ -192,9 +192,17 @@ export interface GetPaymentClienttokenPath {
   id: string;
 }
 
+export interface GetPaymentClienttokenQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPaymentClienttokenResponse = ClientToken;
 
-export interface GetPaymentClienttokenRequest extends BaseRequest, GetPaymentClienttokenPath {}
+export interface GetPaymentClienttokenRequest
+  extends BaseRequest,
+    RequestQuery<GetPaymentClienttokenQuery>,
+    GetPaymentClienttokenPath {}
 
 // POST /payment/{id}/paymenttoken
 
@@ -267,6 +275,8 @@ export interface GetPaymentMethodPath {
 export interface GetPaymentMethodQuery {
   // The user id
   user_id: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentMethodResponse {
@@ -311,6 +321,8 @@ export interface GetPaymentTokenQuery {
   terminalId: string;
   // name on card
   nameOnCard: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPaymentTokenResponse = TokenInformation;
@@ -375,6 +387,8 @@ export interface GetPaymentMethodsQuery {
   storeId: any[];
   // FP TerminalId
   terminalId: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentMethodsResponse {
@@ -393,6 +407,8 @@ export interface GetPaymentHpcQuery {
   storeId: string;
   // FP TerminalId
   terminalId: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentHpcResponse {
@@ -407,6 +423,8 @@ export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPayme
 export interface GetPaymentHcaptchaVerifyQuery {
   // hCaptcha response key
   responseKey?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentHcaptchaVerifyResponse {
@@ -424,11 +442,19 @@ export interface GetPaymentBadgepayPath {
   id: string;
 }
 
+export interface GetPaymentBadgepayQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPaymentBadgepayResponse {
   tenders?: BadgePayTender[];
 }
 
-export interface GetPaymentBadgepayRequest extends BaseRequest, GetPaymentBadgepayPath {}
+export interface GetPaymentBadgepayRequest
+  extends BaseRequest,
+    RequestQuery<GetPaymentBadgepayQuery>,
+    GetPaymentBadgepayPath {}
 
 // POST /payment/{id}/badgepay
 

package/src/interface/permission.ts

@@ -146,6 +146,8 @@ export interface GetPermissionRoleQuery {
   status?: string;
   // Key for pagination, retrieves the next page of items
   start_at?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPermissionRoleResponse = Roles;
@@ -191,6 +193,8 @@ export interface GetPermissionRecipientPath {
 export interface GetPermissionRecipientQuery {
   // Show additional meta fields
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPermissionRecipientResponse = Permissions;
@@ -207,9 +211,17 @@ export interface GetPermissionRoleUserPath {
   user_id: string;
 }
 
+export interface GetPermissionRoleUserQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPermissionRoleUserResponse = RoleAssignments;
 
-export interface GetPermissionRoleUserRequest extends BaseRequest, GetPermissionRoleUserPath {}
+export interface GetPermissionRoleUserRequest
+  extends BaseRequest,
+    RequestQuery<GetPermissionRoleUserQuery>,
+    GetPermissionRoleUserPath {}
 
 // POST /permission/role/user/{user_id} - Assign a role to a user
 

package/src/interface/promo.ts

@@ -257,6 +257,8 @@ export interface PostPromoRequest extends BaseRequest {
 export interface GetPromosQuery {
   // Limit to promotions in selected multigroup
   multigroup?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPromosResponse = Promotions;
@@ -273,6 +275,8 @@ export interface GetPromoPath {
 export interface GetPromoQuery {
   // Show all props of the promotion(ex., location_group_ids)
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPromoResponse = Promotion;
@@ -317,6 +321,8 @@ export interface GetPromoCompanyLocationGroupPath {
 export interface GetPromoCompanyLocationGroupQuery {
   // Return only promos of certain status.
   status?: string;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -446,6 +452,13 @@ export interface PostPromoVoucherifyActivityExecuteRequest extends BaseRequest {
 
 // GET /promo/voucherify/activity/config.json - Get SFMC Journey Custom Activity configuration
 
+export interface GetPromoVoucherifyActivityConfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPromoVoucherifyActivityConfigResponse = SFMCConfig;
 
-export interface GetPromoVoucherifyActivityConfigRequest extends BaseRequest {}
+export interface GetPromoVoucherifyActivityConfigRequest
+  extends BaseRequest,
+    RequestQuery<GetPromoVoucherifyActivityConfigQuery> {}

package/src/interface/report.ts

@@ -319,6 +319,8 @@ export interface GetReportAnalyticsGroupQuery {
   end_date: string;
   time_frame: string;
   order_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
@@ -341,6 +343,8 @@ export interface GetReportAnalyticsCombinedGroupQuery {
   end_date: string;
   time_frame: string;
   order_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetReportAnalyticsCombinedGroupResponse = SAReport;
@@ -365,6 +369,8 @@ export interface GetReportEodGroupQuery {
   format?: string;
   // Location IDs, comma-separated
   locations?: string;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -381,10 +387,16 @@ export interface GetReportEodGroupSubscribersPath {
   id: string;
 }
 
+export interface GetReportEodGroupSubscribersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetReportEodGroupSubscribersResponse = EODSubscribers;
 
 export interface GetReportEodGroupSubscribersRequest
   extends BaseRequest,
+    RequestQuery<GetReportEodGroupSubscribersQuery>,
     GetReportEodGroupSubscribersPath {}
 
 // POST /report/eod/group/{id}/subscribers - Add emails to selected location group

package/src/interface/shoppingcart.ts

@@ -319,9 +319,17 @@ export interface GetShoppingcartCartPath {
   id: string;
 }
 
+export interface GetShoppingcartCartQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetShoppingcartCartResponse = ShoppingCartResponse;
 
-export interface GetShoppingcartCartRequest extends BaseRequest, GetShoppingcartCartPath {}
+export interface GetShoppingcartCartRequest
+  extends BaseRequest,
+    RequestQuery<GetShoppingcartCartQuery>,
+    GetShoppingcartCartPath {}
 
 // PATCH /shoppingcart/{id} - Update a ShoppingCart