@compassdigital/sdk.typescript 3.0.0-beta.8 → 3.0.0-rc.1

package/src/{announcement.ts → interface/announcement.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;

package/src/{brand.ts → interface/brand.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Brand {
   // brand
   id?: string;

package/src/{calendar.ts → interface/calendar.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;
@@ -63,9 +65,13 @@ export interface GetCalendarPath {
   id: string;
 }
 
+export interface GetCalendarQuery {
+  nocache?: boolean;
+}
+
 export type GetCalendarResponse = Calendar;
 
-export interface GetCalendarRequest extends GetCalendarPath {}
+export interface GetCalendarRequest extends GetCalendarQuery, GetCalendarPath {}
 
 // PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
 

package/src/{config.ts → interface/config.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export type CreateConfig = any;
 
 export interface Config {

package/src/{datalake.ts → interface/datalake.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/{delivery.ts → interface/delivery.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;

package/src/{dh.ts → interface/dh.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/interface/email.ts

@@ -0,0 +1,30 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Error {
+  message?: string;
+  code?: number;
+}
+
+export interface Success {
+  success?: boolean;
+}
+
+export interface EmailPayload {
+  from: string;
+  to: string;
+  subject?: string;
+  // Text of an email instead of template_id/data
+  text?: string;
+  template_id?: string;
+  data?: any;
+}
+
+// POST /email - Send an email
+
+export type PostEmailBody = EmailPayload;
+
+export type PostEmailResponse = Success;
+
+export interface PostEmailRequest {
+  body: PostEmailBody;
+}

package/src/{file.ts → interface/file.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{kds.ts → interface/kds.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   message?: string;
@@ -45,6 +47,8 @@ export interface AuthPostBodyResponse {
 export interface GetKdsDevicesQuery {
   // Unit numbers string separated with commas
   unitNumber: string;
+  // Do not return cached device information
+  nocache?: boolean;
 }
 
 export type GetKdsDevicesResponse = Units;

package/src/{location.ts → interface/location.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface POS {
   // pos
   id?: string;
@@ -133,6 +135,8 @@ export interface Brand {
   brand?: string;
   // location
   location?: string;
+  // location group
+  group?: string;
   // payment
   payment_provider?: string;
   location_description?: string;
@@ -180,6 +184,7 @@ export interface Brand {
       fr?: string;
     };
   };
+  external_id?: string;
   [index: string]: any;
 }
 
@@ -339,7 +344,7 @@ export interface PostOrPatchDeliveryDestination {
 }
 
 export interface DeliveryDestination {
-  // ID of the delivery destination
+  // delivery_destination
   id?: string;
   // Name of the delivery destination
   name: string;
@@ -442,6 +447,7 @@ export interface GetLocationQuery {
   active_cafes?: any[];
   // show additional hidden properties/entities
   extended?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationResponse = Location;
@@ -524,9 +530,13 @@ export interface PutLocationPosRequest extends PutLocationPosPath {
 
 // GET /location/multigroup - Get all the top level multigroups
 
+export interface GetLocationMultigroupsQuery {
+  nocache?: boolean;
+}
+
 export type GetLocationMultigroupsResponse = Multigroups;
 
-export type GetLocationMultigroupsRequest = {};
+export interface GetLocationMultigroupsRequest extends GetLocationMultigroupsQuery {}
 
 // POST /location/multigroup - Create a new multigroup
 
@@ -558,6 +568,7 @@ export interface GetLocationMultigroupQuery {
   extended?: boolean;
   // return additional hours and deliveryHours properties in response
   hours?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationMultigroupResponse = MultiGroup;
@@ -625,6 +636,7 @@ export interface GetLocationUserMultigroupPath {
 
 export interface GetLocationUserMultigroupQuery {
   expanded?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationUserMultigroupResponse = Groups;
@@ -659,6 +671,7 @@ export interface GetLocationGroupQuery {
   extended?: boolean;
   // return only groups with brands that have web_order_enabled switched on
   web?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationGroupResponse = Group;
@@ -749,53 +762,59 @@ export interface PostLocationGroupDeliverydestinationRequest
   body: PostLocationGroupDeliverydestinationBody;
 }
 
-// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
+// PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
 
-export interface GetLocationGroupDeliverydestinationPath {
+export interface PatchLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
-  // Delivery Destination ID
-  delivery_destination: string;
 }
 
-export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
+export interface PatchLocationGroupDeliverydestinationBody {
+  delivery_destinations?: PostOrPatchDeliveryDestination;
+}
 
-export interface GetLocationGroupDeliverydestinationRequest
-  extends GetLocationGroupDeliverydestinationPath {}
+export interface PatchLocationGroupDeliverydestinationResponse {
+  delivery_destinations?: DeliveryDestination;
+}
 
-// PATCH /location/group/{id}/deliverydestination/{delivery_destination} - Patch a delivery destination
+export interface PatchLocationGroupDeliverydestinationRequest
+  extends PatchLocationGroupDeliverydestinationPath {
+  body: PatchLocationGroupDeliverydestinationBody;
+}
 
-export interface PatchLocationGroupDeliverydestinationPath {
+// DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
+
+export interface DeleteLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
-  // Delivery Destination ID
-  delivery_destination: string;
 }
 
-export type PatchLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
+export interface DeleteLocationGroupDeliverydestinationBody {
+  delivery_destination_ids?: string[];
+}
 
-export type PatchLocationGroupDeliverydestinationResponse = DeliveryDestination;
+export interface DeleteLocationGroupDeliverydestinationResponse {
+  deleted_delivery_destinations?: DeliveryDestination;
+}
 
-export interface PatchLocationGroupDeliverydestinationRequest
-  extends PatchLocationGroupDeliverydestinationPath {
-  body: PatchLocationGroupDeliverydestinationBody;
+export interface DeleteLocationGroupDeliverydestinationRequest
+  extends DeleteLocationGroupDeliverydestinationPath {
+  body: DeleteLocationGroupDeliverydestinationBody;
 }
 
-// DELETE /location/group/{id}/deliverydestination/{delivery_destination} - Delete a delivery destination
+// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
 
-export interface DeleteLocationGroupDeliverydestinationPath {
+export interface GetLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
   // Delivery Destination ID
   delivery_destination: string;
 }
 
-export interface DeleteLocationGroupDeliverydestinationResponse {
-  deleted_delivery_destination?: DeliveryDestination;
-}
+export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
-export interface DeleteLocationGroupDeliverydestinationRequest
-  extends DeleteLocationGroupDeliverydestinationPath {}
+export interface GetLocationGroupDeliverydestinationRequest
+  extends GetLocationGroupDeliverydestinationPath {}
 
 // GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
 
@@ -809,6 +828,7 @@ export interface GetLocationUserGroupPath {
 export interface GetLocationUserGroupQuery {
   latitude?: number;
   longitude?: number;
+  nocache?: boolean;
 }
 
 export type GetLocationUserGroupResponse = Group;
@@ -1037,6 +1057,7 @@ export interface GetLocationBrandQuery {
   include_config?: boolean;
   // show additional hidden properties/entities
   extended?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationBrandResponse = Brand;
@@ -1090,9 +1111,13 @@ export interface PutLocationBrandRequest extends PutLocationBrandPath {
 
 // GET /location/sector - Get list of all the sectors
 
+export interface GetLocationSectorsQuery {
+  nocache?: boolean;
+}
+
 export type GetLocationSectorsResponse = Sectors;
 
-export type GetLocationSectorsRequest = {};
+export interface GetLocationSectorsRequest extends GetLocationSectorsQuery {}
 
 // POST /location/sector - Create a new sector
 
@@ -1114,6 +1139,7 @@ export interface GetLocationSectorPath {
 export interface GetLocationSectorQuery {
   // Omits nested children of a sector if false
   expanded?: boolean;
+  nocache?: boolean;
 }
 
 export type GetLocationSectorResponse = Sector;
@@ -1145,15 +1171,13 @@ export interface PatchLocationSectorRequest
 // POST /location/company - Create a new company
 
 export interface PostLocationCompanyBody {
-  name: {
-    // Sector name
-    name: string;
-    // sector
-    sector: string;
-    label?: any;
-    is?: {
-      global_images_enabled?: boolean;
-    };
+  // Sector name
+  name: string;
+  // sector
+  sector: string;
+  label?: any;
+  is?: {
+    global_images_enabled?: boolean;
   };
 }
 
@@ -1194,3 +1218,20 @@ export type PatchLocationCompanyResponse = Company;
 export interface PatchLocationCompanyRequest extends PatchLocationCompanyPath {
   body: PatchLocationCompanyBody;
 }
+
+// GET /location/brand/external/{external_id} - Get an individual Location filtered by external_id
+
+export interface GetLocationBrandExternalPath {
+  // external location id
+  external_id: string;
+}
+
+export interface GetLocationBrandExternalQuery {
+  nocache?: boolean;
+}
+
+export type GetLocationBrandExternalResponse = Location;
+
+export interface GetLocationBrandExternalRequest
+  extends GetLocationBrandExternalQuery,
+    GetLocationBrandExternalPath {}

package/src/{logger.ts → interface/logger.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   error?: string;
   code?: number;

package/src/{loyalty.ts → interface/loyalty.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{mealplan.ts → interface/mealplan.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   code?: number;
   message?: string;