@compassdigital/sdk.typescript 3.38.0 → 3.40.0

package/src/interface/announcement.ts

@@ -68,6 +68,8 @@ export interface GetAnnouncementResourceQuery {
   // Resource Id linked to announcement
   allowed_resource_id?: string;
   disabled?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetAnnouncementResourceResponse = Announcements;
@@ -81,6 +83,8 @@ export interface GetAnnouncementResourceRequest
 
 export interface GetAnnouncementResourcesQuery {
   disabled?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetAnnouncementResourcesResponse = Announcements;
@@ -96,9 +100,17 @@ export interface GetAnnouncementPath {
   id: string;
 }
 
+export interface GetAnnouncementQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetAnnouncementResponse = Announcement;
 
-export interface GetAnnouncementRequest extends BaseRequest, GetAnnouncementPath {}
+export interface GetAnnouncementRequest
+  extends BaseRequest,
+    RequestQuery<GetAnnouncementQuery>,
+    GetAnnouncementPath {}
 
 // PUT /announcement/{id} - Update Announcement
 

package/src/interface/calendar.ts

@@ -68,6 +68,8 @@ export interface GetCalendarPath {
 }
 
 export interface GetCalendarQuery {
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -114,6 +116,8 @@ export interface GetCalendarCdlPath {
 export interface GetCalendarCdlQuery {
   // Start date in ms to get 7 day calendar from. Defaults now.
   start_date?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetCalendarCdlResponse = CDLCalendar;
@@ -125,11 +129,18 @@ export interface GetCalendarCdlRequest
 
 // GET /calendar/swagger.json
 
+export interface GetCalendarSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetCalendarSwaggerResponse {
   [index: string]: any;
 }
 
-export interface GetCalendarSwaggerRequest extends BaseRequest {}
+export interface GetCalendarSwaggerRequest
+  extends BaseRequest,
+    RequestQuery<GetCalendarSwaggerQuery> {}
 
 // POST /calendar/{id}/sync - Trigger synchronization of calendar to location API
 

package/src/interface/compassconnect.ts

@@ -45,6 +45,8 @@ export interface GetCompassconnectOmsTokenQuery {
   callback_uri: string;
   // The urle
   oms_url: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetCompassconnectOmsTokenResponse = Auth;

package/src/interface/config.ts

@@ -19,9 +19,16 @@ export interface Success {
 
 // GET /config/appconfig - get appconfig - an object with data for clients including minimum versions apps (boost, thrive, J&J) should be running and a link to the respective app store
 
+export interface GetConfigAppconfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetConfigAppconfigResponse = Config;
 
-export interface GetConfigAppconfigRequest extends BaseRequest {}
+export interface GetConfigAppconfigRequest
+  extends BaseRequest,
+    RequestQuery<GetConfigAppconfigQuery> {}
 
 // GET /config/{key} - get a configuration
 
@@ -30,9 +37,17 @@ export interface GetConfigPath {
   key: string;
 }
 
+export interface GetConfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetConfigResponse = Config;
 
-export interface GetConfigRequest extends BaseRequest, GetConfigPath {}
+export interface GetConfigRequest
+  extends BaseRequest,
+    RequestQuery<GetConfigQuery>,
+    GetConfigPath {}
 
 // POST /config/{key} - Create a configuration
 
@@ -82,9 +97,17 @@ export interface GetConfigPublicPath {
   key: string;
 }
 
+export interface GetConfigPublicQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetConfigPublicResponse = Config;
 
-export interface GetConfigPublicRequest extends BaseRequest, GetConfigPublicPath {}
+export interface GetConfigPublicRequest
+  extends BaseRequest,
+    RequestQuery<GetConfigPublicQuery>,
+    GetConfigPublicPath {}
 
 // POST /config/public/{key} - Create a public configuration
 

package/src/interface/datalake.ts

@@ -27,6 +27,11 @@ export interface PostDatalakeSqlRequest extends BaseRequest {
 
 // GET /swagger.json
 
+export interface GetSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetSwaggerResponse = any;
 
-export interface GetSwaggerRequest extends BaseRequest {}
+export interface GetSwaggerRequest extends BaseRequest, RequestQuery<GetSwaggerQuery> {}

package/src/interface/kds.ts

@@ -63,6 +63,8 @@ export interface GetKdsDevicesQuery {
   unitNumber: string;
   // Do not return cached device information
   nocache?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetKdsDevicesResponse = Units;
@@ -118,8 +120,13 @@ export interface DeleteKdsDeviceInfoRequest extends BaseRequest, DeleteKdsDevice
 
 // GET /kds/swagger.json - Get a swagger for kds service
 
+export interface GetKdsSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetKdsSwaggerResponse {
   [index: string]: any;
 }
 
-export interface GetKdsSwaggerRequest extends BaseRequest {}
+export interface GetKdsSwaggerRequest extends BaseRequest, RequestQuery<GetKdsSwaggerQuery> {}

package/src/interface/location.ts

@@ -309,6 +309,10 @@ export interface MultiGroup {
   [index: string]: any;
 }
 
+export interface success {
+  success?: boolean;
+}
+
 export interface Error {
   error?: string;
   code?: number;
@@ -437,6 +441,8 @@ export interface WaitTime {
   max: number;
   // minimum wait time to the next time slot in minutes
   min: number;
+  // the epoch timestamp of the next available ready time for a station
+  ready_time: number;
 }
 
 // POST /location - Create a new location
@@ -451,9 +457,14 @@ export interface PostLocationRequest extends BaseRequest {
 
 // GET /location - Get all location
 
+export interface GetLocationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLocationsResponse = Locations;
 
-export interface GetLocationsRequest extends BaseRequest {}
+export interface GetLocationsRequest extends BaseRequest, RequestQuery<GetLocationsQuery> {}
 
 // GET /location/search - Gets Location within a radius of the provided point
 
@@ -464,6 +475,8 @@ export interface GetLocationSearchQuery {
   long?: number;
   // Operation id to be used
   operation_id?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationSearchResponse = Locations;
@@ -486,6 +499,8 @@ export interface GetLocationQuery {
   active_cafes?: any[];
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -551,9 +566,17 @@ export interface GetLocationPosPath {
   id: string;
 }
 
+export interface GetLocationPosQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLocationPosResponse = POS;
 
-export interface GetLocationPosRequest extends BaseRequest, GetLocationPosPath {}
+export interface GetLocationPosRequest
+  extends BaseRequest,
+    RequestQuery<GetLocationPosQuery>,
+    GetLocationPosPath {}
 
 // PUT /location/pos/{id} - Set information about a POS
 
@@ -573,6 +596,8 @@ export interface PutLocationPosRequest extends BaseRequest, PutLocationPosPath {
 // GET /location/multigroup - Get all the top level multigroups
 
 export interface GetLocationMultigroupsQuery {
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -618,6 +643,8 @@ export interface GetLocationMultigroupQuery {
   non_market_places?: boolean;
   // filters for non-scan & go locations only
   non_scan_go?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -687,6 +714,8 @@ export interface GetLocationUserMultigroupPath {
 
 export interface GetLocationUserMultigroupQuery {
   expanded?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -729,6 +758,8 @@ export interface GetLocationGroupQuery {
   non_market_places?: boolean;
   // return only groups with non-scan & go locations/brands
   non_scan_go?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -797,6 +828,8 @@ export interface GetLocationGroupDeliverydestinationsPath {
 export interface GetLocationGroupDeliverydestinationsQuery {
   // Delivery destination name
   name?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetLocationGroupDeliverydestinationsResponse {
@@ -876,10 +909,16 @@ export interface GetLocationGroupDeliverydestinationPath {
   delivery_destination: string;
 }
 
+export interface GetLocationGroupDeliverydestinationQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
 export interface GetLocationGroupDeliverydestinationRequest
   extends BaseRequest,
+    RequestQuery<GetLocationGroupDeliverydestinationQuery>,
     GetLocationGroupDeliverydestinationPath {}
 
 // GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
@@ -894,6 +933,8 @@ export interface GetLocationUserGroupPath {
 export interface GetLocationUserGroupQuery {
   latitude?: number;
   longitude?: number;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -906,11 +947,18 @@ export interface GetLocationUserGroupRequest
 
 // GET /location/brands - Get all location brands
 
+export interface GetLocationBrandsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetLocationBrandsResponse {
   brands?: Brands;
 }
 
-export interface GetLocationBrandsRequest extends BaseRequest {}
+export interface GetLocationBrandsRequest
+  extends BaseRequest,
+    RequestQuery<GetLocationBrandsQuery> {}
 
 // GET /location/brand/{id}/deliverydestinations - Get delivery destinations for a brand
 
@@ -919,10 +967,16 @@ export interface GetLocationBrandDestinationsPath {
   id: string;
 }
 
+export interface GetLocationBrandDestinationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLocationBrandDestinationsResponse = DeliveryDestinationIDs;
 
 export interface GetLocationBrandDestinationsRequest
   extends BaseRequest,
+    RequestQuery<GetLocationBrandDestinationsQuery>,
     GetLocationBrandDestinationsPath {}
 
 // POST /location/brand/{id}/document - Attach document to a brand
@@ -984,10 +1038,16 @@ export interface GetLocationBrandDocumentsPath {
   id: string;
 }
 
+export interface GetLocationBrandDocumentsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLocationBrandDocumentsResponse = BrandDocumentsResponse;
 
 export interface GetLocationBrandDocumentsRequest
   extends BaseRequest,
+    RequestQuery<GetLocationBrandDocumentsQuery>,
     GetLocationBrandDocumentsPath {}
 
 // GET /location/brand/{id}/timeslots - Get location brand timeslots
@@ -1002,6 +1062,8 @@ export interface GetLocationBrandTimeslotsQuery {
   date?: number;
   // Limit the number of timeslots returned
   limit?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationBrandTimeslotsResponse = TimeSlots;
@@ -1063,6 +1125,8 @@ export interface GetLocationBrandMenuTimeslotsQuery {
   date?: number;
   // Limit the number of timeslots returned
   limit?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
@@ -1084,6 +1148,8 @@ export interface GetLocationBrandDeliveryTimeslotsQuery {
   date?: number;
   // Limit the number of timeslots returned
   limit?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
@@ -1107,6 +1173,8 @@ export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
   date?: number;
   // Limit the number of timeslots returned
   limit?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
@@ -1138,6 +1206,8 @@ export interface GetLocationBrandQuery {
   include_config?: boolean;
   // show additional hidden properties/entities
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -1170,13 +1240,9 @@ export interface DeleteLocationBrandPath {
   id: string;
 }
 
-export type DeleteLocationBrandBody = Brand;
+export type DeleteLocationBrandResponse = success;
 
-export type DeleteLocationBrandResponse = Brand;
-
-export interface DeleteLocationBrandRequest extends BaseRequest, DeleteLocationBrandPath {
-  body: DeleteLocationBrandBody;
-}
+export interface DeleteLocationBrandRequest extends BaseRequest, DeleteLocationBrandPath {}
 
 // PUT /location/brand/{id} - Update location brand
 
@@ -1196,6 +1262,8 @@ export interface PutLocationBrandRequest extends BaseRequest, PutLocationBrandPa
 // GET /location/sector - Get list of all the sectors
 
 export interface GetLocationSectorsQuery {
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -1225,6 +1293,8 @@ export interface GetLocationSectorPath {
 export interface GetLocationSectorQuery {
   // Omits nested children of a sector if false
   expanded?: boolean;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -1286,6 +1356,8 @@ export interface GetLocationCompanyPath {
 
 export interface GetLocationCompanyQuery {
   expanded?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLocationCompanyResponse = Company;

package/src/interface/loyalty.ts

@@ -192,6 +192,8 @@ export interface GetLoyaltyPointsPath {
 export interface GetLoyaltyPointsQuery {
   // event type
   event: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLoyaltyPointsResponse = Points;
@@ -210,11 +212,19 @@ export interface GetLoyaltyOffersPath {
   user_id: string;
 }
 
+export interface GetLoyaltyOffersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetLoyaltyOffersResponse {
   offers?: Offer[];
 }
 
-export interface GetLoyaltyOffersRequest extends BaseRequest, GetLoyaltyOffersPath {}
+export interface GetLoyaltyOffersRequest
+  extends BaseRequest,
+    RequestQuery<GetLoyaltyOffersQuery>,
+    GetLoyaltyOffersPath {}
 
 // GET /loyalty/{id}/enrollmentstatus/{user_id} - Get enrollment status for logged in user
 
@@ -225,10 +235,16 @@ export interface GetLoyaltyEnrollmentstatusPath {
   user_id: string;
 }
 
+export interface GetLoyaltyEnrollmentstatusQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLoyaltyEnrollmentstatusResponse = EnrollmentStatus;
 
 export interface GetLoyaltyEnrollmentstatusRequest
   extends BaseRequest,
+    RequestQuery<GetLoyaltyEnrollmentstatusQuery>,
     GetLoyaltyEnrollmentstatusPath {}
 
 // GET /loyalty/{id}/balance/{user_id} - Get loyalty point balance for logged in user
@@ -240,9 +256,17 @@ export interface GetLoyaltyBalancePath {
   user_id: string;
 }
 
+export interface GetLoyaltyBalanceQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetLoyaltyBalanceResponse = Points;
 
-export interface GetLoyaltyBalanceRequest extends BaseRequest, GetLoyaltyBalancePath {}
+export interface GetLoyaltyBalanceRequest
+  extends BaseRequest,
+    RequestQuery<GetLoyaltyBalanceQuery>,
+    GetLoyaltyBalancePath {}
 
 // GET /loyalty/{id}/opportunities/{user_id} - Get earning opportunities for the logged in user
 
@@ -256,6 +280,8 @@ export interface GetLoyaltyOpportunitiesPath {
 export interface GetLoyaltyOpportunitiesQuery {
   // Choose what opportunities should not be returned, can be several comma separated
   filter?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetLoyaltyOpportunitiesResponse {
@@ -299,11 +325,19 @@ export interface GetLoyaltyRewardsPath {
   user_id: string;
 }
 
+export interface GetLoyaltyRewardsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetLoyaltyRewardsResponse {
   rewards?: Reward[];
 }
 
-export interface GetLoyaltyRewardsRequest extends BaseRequest, GetLoyaltyRewardsPath {}
+export interface GetLoyaltyRewardsRequest
+  extends BaseRequest,
+    RequestQuery<GetLoyaltyRewardsQuery>,
+    GetLoyaltyRewardsPath {}
 
 // GET /loyalty/{id}/coupons/{user_id} - Get coupons available for the logged in user
 
@@ -314,11 +348,19 @@ export interface GetLoyaltyCouponsPath {
   user_id: string;
 }
 
+export interface GetLoyaltyCouponsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetLoyaltyCouponsResponse {
   coupons?: Coupon[];
 }
 
-export interface GetLoyaltyCouponsRequest extends BaseRequest, GetLoyaltyCouponsPath {}
+export interface GetLoyaltyCouponsRequest
+  extends BaseRequest,
+    RequestQuery<GetLoyaltyCouponsQuery>,
+    GetLoyaltyCouponsPath {}
 
 // GET /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for an order based on amount.
 
@@ -332,6 +374,8 @@ export interface GetLoyaltyOrderpointsPath {
 export interface GetLoyaltyOrderpointsQuery {
   // Order amount before taxes to check potential loyalty points
   order_amount: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLoyaltyOrderpointsResponse = Points;
@@ -436,6 +480,8 @@ export interface GetLoyaltyHistoryQuery {
   page_number?: number;
   // How many entries to return per request. If not specified will return first 1000 events
   entries_per_page?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetLoyaltyHistoryResponse {
@@ -458,13 +504,21 @@ export interface GetLoyaltyCouponPath {
   coupon_id: string;
 }
 
+export interface GetLoyaltyCouponQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetLoyaltyCouponResponse {
   coupon?: Coupon;
   // This will be true if the coupon status is either 'redeemed' or 'reissued'
   is_valid?: boolean;
 }
 
-export interface GetLoyaltyCouponRequest extends BaseRequest, GetLoyaltyCouponPath {}
+export interface GetLoyaltyCouponRequest
+  extends BaseRequest,
+    RequestQuery<GetLoyaltyCouponQuery>,
+    GetLoyaltyCouponPath {}
 
 // PATCH /loyalty/{id}/coupon/{user_id}/{coupon_id} - Update coupon's status
 
@@ -498,6 +552,8 @@ export interface GetLoyaltySearchPath {
 export interface GetLoyaltySearchQuery {
   // User id in 500friends
   search_id: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetLoyaltySearchResponse = UserId;
@@ -519,6 +575,8 @@ export interface GetLoyaltyUsersQuery {
   page_number?: number;
   // Start date to search from
   from_date: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetLoyaltyUsersResponse {
@@ -542,6 +600,8 @@ export interface GetLoyaltyEventsQuery {
   page_number?: number;
   // Start date to search from
   from_date: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetLoyaltyEventsResponse {

package/src/interface/mealplan.ts

@@ -106,9 +106,17 @@ export interface GetMealplanPath {
   id: string;
 }
 
+export interface GetMealplanQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMealplanResponse = TendersAndAuth;
 
-export interface GetMealplanRequest extends BaseRequest, GetMealplanPath {}
+export interface GetMealplanRequest
+  extends BaseRequest,
+    RequestQuery<GetMealplanQuery>,
+    GetMealplanPath {}
 
 // DELETE /mealplan/{id} - Delete a mealplan or a tender from the user's account
 
@@ -151,9 +159,17 @@ export interface GetMealplanTenderPath {
   tender: string;
 }
 
+export interface GetMealplanTenderQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetMealplanTenderResponse = Tender;
 
-export interface GetMealplanTenderRequest extends BaseRequest, GetMealplanTenderPath {}
+export interface GetMealplanTenderRequest
+  extends BaseRequest,
+    RequestQuery<GetMealplanTenderQuery>,
+    GetMealplanTenderPath {}
 
 // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance