@compassdigital/sdk.typescript 3.19.0 → 3.20.0

package/src/interface/location.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";
 
 export interface POS {
   // pos
@@ -430,13 +430,16 @@ export type PostLocationResponse = Location;
 
 export interface PostLocationRequest {
   body: PostLocationBody;
+  context?: RequestContext;
 }
 
 // GET /location - Get all location
 
 export type GetLocationsResponse = Locations;
 
-export type GetLocationsRequest = {};
+export interface GetLocationsRequest {
+  context?: RequestContext;
+}
 
 // GET /location/search - Gets Location within a radius of the provided point
 
@@ -451,7 +454,9 @@ export interface GetLocationSearchQuery {
 
 export type GetLocationSearchResponse = Locations;
 
-export interface GetLocationSearchRequest extends RequestQuery<GetLocationSearchQuery> {}
+export interface GetLocationSearchRequest extends RequestQuery<GetLocationSearchQuery> {
+  context?: RequestContext;
+}
 
 // GET /location/{id} - Get an individual Location
 
@@ -472,7 +477,9 @@ export interface GetLocationQuery {
 
 export type GetLocationResponse = Location;
 
-export interface GetLocationRequest extends RequestQuery<GetLocationQuery>, GetLocationPath {}
+export interface GetLocationRequest extends RequestQuery<GetLocationQuery>, GetLocationPath {
+  context?: RequestContext;
+}
 
 // PUT /location/{id} - Override a complete Location
 
@@ -487,6 +494,7 @@ export type PutLocationResponse = Location;
 
 export interface PutLocationRequest extends PutLocationPath {
   body: PutLocationBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/{id} - Delete brands from a Location
@@ -505,6 +513,7 @@ export type DeleteLocationResponse = Location;
 
 export interface DeleteLocationRequest extends DeleteLocationPath {
   body: DeleteLocationBody;
+  context?: RequestContext;
 }
 
 // PATCH /location/{id} - Update a Location
@@ -520,6 +529,7 @@ export type PatchLocationResponse = Location;
 
 export interface PatchLocationRequest extends PatchLocationPath {
   body: PatchLocationBody;
+  context?: RequestContext;
 }
 
 // GET /location/pos/{id} - Get information about a POS
@@ -531,7 +541,9 @@ export interface GetLocationPosPath {
 
 export type GetLocationPosResponse = POS;
 
-export interface GetLocationPosRequest extends GetLocationPosPath {}
+export interface GetLocationPosRequest extends GetLocationPosPath {
+  context?: RequestContext;
+}
 
 // PUT /location/pos/{id} - Set information about a POS
 
@@ -546,6 +558,7 @@ export type PutLocationPosResponse = POS;
 
 export interface PutLocationPosRequest extends PutLocationPosPath {
   body: PutLocationPosBody;
+  context?: RequestContext;
 }
 
 // GET /location/multigroup - Get all the top level multigroups
@@ -556,7 +569,9 @@ export interface GetLocationMultigroupsQuery {
 
 export type GetLocationMultigroupsResponse = Multigroups;
 
-export interface GetLocationMultigroupsRequest extends RequestQuery<GetLocationMultigroupsQuery> {}
+export interface GetLocationMultigroupsRequest extends RequestQuery<GetLocationMultigroupsQuery> {
+  context?: RequestContext;
+}
 
 // POST /location/multigroup - Create a new multigroup
 
@@ -566,6 +581,7 @@ export type PostLocationMultigroupResponse = MultiGroup;
 
 export interface PostLocationMultigroupRequest {
   body: PostLocationMultigroupBody;
+  context?: RequestContext;
 }
 
 // GET /location/multigroup/{id} - Get a multigroup
@@ -601,7 +617,9 @@ export type GetLocationMultigroupResponse = MultiGroup;
 
 export interface GetLocationMultigroupRequest
   extends RequestQuery<GetLocationMultigroupQuery>,
-    GetLocationMultigroupPath {}
+    GetLocationMultigroupPath {
+  context?: RequestContext;
+}
 
 // PUT /location/multigroup/{id} - Override a complete multigroup
 
@@ -616,6 +634,7 @@ export type PutLocationMultigroupResponse = MultiGroup;
 
 export interface PutLocationMultigroupRequest extends PutLocationMultigroupPath {
   body: PutLocationMultigroupBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/multigroup/{id} - Delete groups from a multigroup
@@ -634,6 +653,7 @@ export type DeleteLocationMultigroupResponse = MultiGroup;
 
 export interface DeleteLocationMultigroupRequest extends DeleteLocationMultigroupPath {
   body: DeleteLocationMultigroupBody;
+  context?: RequestContext;
 }
 
 // PATCH /location/multigroup/{id} - Update a multigroup
@@ -649,6 +669,7 @@ export type PatchLocationMultigroupResponse = MultiGroup;
 
 export interface PatchLocationMultigroupRequest extends PatchLocationMultigroupPath {
   body: PatchLocationMultigroupBody;
+  context?: RequestContext;
 }
 
 // GET /location/multigroup/{id}/user/{user_id} - Get all the groups in a multigroup specific to user permissions
@@ -669,7 +690,9 @@ export type GetLocationUserMultigroupResponse = Groups;
 
 export interface GetLocationUserMultigroupRequest
   extends RequestQuery<GetLocationUserMultigroupQuery>,
-    GetLocationUserMultigroupPath {}
+    GetLocationUserMultigroupPath {
+  context?: RequestContext;
+}
 
 // POST /location/group - Create a new group
 
@@ -679,6 +702,7 @@ export type PostLocationGroupResponse = Group;
 
 export interface PostLocationGroupRequest {
   body: PostLocationGroupBody;
+  context?: RequestContext;
 }
 
 // GET /location/group/{id} - Get an individual Group based on id or latitude/longitude
@@ -710,7 +734,9 @@ export type GetLocationGroupResponse = Group;
 
 export interface GetLocationGroupRequest
   extends RequestQuery<GetLocationGroupQuery>,
-    GetLocationGroupPath {}
+    GetLocationGroupPath {
+  context?: RequestContext;
+}
 
 // PUT /location/group/{id} - Override a complete Group
 
@@ -725,6 +751,7 @@ export type PutLocationGroupResponse = Group;
 
 export interface PutLocationGroupRequest extends PutLocationGroupPath {
   body: PutLocationGroupBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/group/{id} - Delete locations from a Group
@@ -743,6 +770,7 @@ export type DeleteLocationGroupResponse = Group;
 
 export interface DeleteLocationGroupRequest extends DeleteLocationGroupPath {
   body: DeleteLocationGroupBody;
+  context?: RequestContext;
 }
 
 // PATCH /location/group/{id} - Update a Group
@@ -758,6 +786,7 @@ export type PatchLocationGroupResponse = Group;
 
 export interface PatchLocationGroupRequest extends PatchLocationGroupPath {
   body: PatchLocationGroupBody;
+  context?: RequestContext;
 }
 
 // GET /location/group/{id}/deliverydestination - Get all delivery destinations for group
@@ -778,7 +807,9 @@ export interface GetLocationGroupDeliverydestinationsResponse {
 
 export interface GetLocationGroupDeliverydestinationsRequest
   extends RequestQuery<GetLocationGroupDeliverydestinationsQuery>,
-    GetLocationGroupDeliverydestinationsPath {}
+    GetLocationGroupDeliverydestinationsPath {
+  context?: RequestContext;
+}
 
 // POST /location/group/{id}/deliverydestination - Create a new location group delivery destination
 
@@ -794,6 +825,7 @@ export type PostLocationGroupDeliverydestinationResponse = DeliveryDestination;
 export interface PostLocationGroupDeliverydestinationRequest
   extends PostLocationGroupDeliverydestinationPath {
   body: PostLocationGroupDeliverydestinationBody;
+  context?: RequestContext;
 }
 
 // PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
@@ -814,6 +846,7 @@ export interface PatchLocationGroupDeliverydestinationResponse {
 export interface PatchLocationGroupDeliverydestinationRequest
   extends PatchLocationGroupDeliverydestinationPath {
   body: PatchLocationGroupDeliverydestinationBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
@@ -834,6 +867,7 @@ export interface DeleteLocationGroupDeliverydestinationResponse {
 export interface DeleteLocationGroupDeliverydestinationRequest
   extends DeleteLocationGroupDeliverydestinationPath {
   body: DeleteLocationGroupDeliverydestinationBody;
+  context?: RequestContext;
 }
 
 // GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
@@ -848,7 +882,9 @@ export interface GetLocationGroupDeliverydestinationPath {
 export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
 export interface GetLocationGroupDeliverydestinationRequest
-  extends GetLocationGroupDeliverydestinationPath {}
+  extends GetLocationGroupDeliverydestinationPath {
+  context?: RequestContext;
+}
 
 // GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
 
@@ -869,7 +905,9 @@ export type GetLocationUserGroupResponse = Group;
 
 export interface GetLocationUserGroupRequest
   extends RequestQuery<GetLocationUserGroupQuery>,
-    GetLocationUserGroupPath {}
+    GetLocationUserGroupPath {
+  context?: RequestContext;
+}
 
 // GET /location/brands - Get all location brands
 
@@ -877,7 +915,9 @@ export interface GetLocationBrandsResponse {
   brands?: Brands;
 }
 
-export type GetLocationBrandsRequest = {};
+export interface GetLocationBrandsRequest {
+  context?: RequestContext;
+}
 
 // GET /location/brand/{id}/deliverydestinations - Get delivery destinations for a brand
 
@@ -888,7 +928,9 @@ export interface GetLocationBrandDestinationsPath {
 
 export type GetLocationBrandDestinationsResponse = DeliveryDestinationIDs;
 
-export interface GetLocationBrandDestinationsRequest extends GetLocationBrandDestinationsPath {}
+export interface GetLocationBrandDestinationsRequest extends GetLocationBrandDestinationsPath {
+  context?: RequestContext;
+}
 
 // POST /location/brand/{id}/document - Attach document to a brand
 
@@ -910,6 +952,7 @@ export type PostLocationBrandDocumentResponse = BrandDocumentsResponse;
 
 export interface PostLocationBrandDocumentRequest extends PostLocationBrandDocumentPath {
   body: PostLocationBrandDocumentBody;
+  context?: RequestContext;
 }
 
 // PATCH /location/brand/{id}/document - Edit location document
@@ -923,7 +966,9 @@ export interface PatchLocationBrandDocumentResponse {
   document?: BrandDocument;
 }
 
-export interface PatchLocationBrandDocumentRequest extends PatchLocationBrandDocumentPath {}
+export interface PatchLocationBrandDocumentRequest extends PatchLocationBrandDocumentPath {
+  context?: RequestContext;
+}
 
 // DELETE /location/brand/{id}/document - Deleted brand document
 
@@ -936,7 +981,9 @@ export interface DeleteLocationBrandDocumentResponse {
   deleted_document?: BrandDocument;
 }
 
-export interface DeleteLocationBrandDocumentRequest extends DeleteLocationBrandDocumentPath {}
+export interface DeleteLocationBrandDocumentRequest extends DeleteLocationBrandDocumentPath {
+  context?: RequestContext;
+}
 
 // GET /location/brand/{id}/documents - Get location brand attached documents
 
@@ -947,7 +994,9 @@ export interface GetLocationBrandDocumentsPath {
 
 export type GetLocationBrandDocumentsResponse = BrandDocumentsResponse;
 
-export interface GetLocationBrandDocumentsRequest extends GetLocationBrandDocumentsPath {}
+export interface GetLocationBrandDocumentsRequest extends GetLocationBrandDocumentsPath {
+  context?: RequestContext;
+}
 
 // GET /location/brand/{id}/timeslots - Get location brand timeslots
 
@@ -967,7 +1016,9 @@ export type GetLocationBrandTimeslotsResponse = TimeSlots;
 
 export interface GetLocationBrandTimeslotsRequest
   extends RequestQuery<GetLocationBrandTimeslotsQuery>,
-    GetLocationBrandTimeslotsPath {}
+    GetLocationBrandTimeslotsPath {
+  context?: RequestContext;
+}
 
 // POST /location/marketplace/timeslots - Get Market Place timeslots
 
@@ -985,6 +1036,7 @@ export type PostLocationMarketplaceTimeslotsResponse = TimeSlots;
 export interface PostLocationMarketplaceTimeslotsRequest
   extends RequestQuery<PostLocationMarketplaceTimeslotsQuery> {
   body: PostLocationMarketplaceTimeslotsBody;
+  context?: RequestContext;
 }
 
 // POST /location/marketplace/timeslots/delivery - Get Marketplace delivery timeslots
@@ -1003,6 +1055,7 @@ export type PostLocationMarketplaceTimeslotsDeliveryResponse = TimeSlots;
 export interface PostLocationMarketplaceTimeslotsDeliveryRequest
   extends RequestQuery<PostLocationMarketplaceTimeslotsDeliveryQuery> {
   body: PostLocationMarketplaceTimeslotsDeliveryBody;
+  context?: RequestContext;
 }
 
 // GET /location/brand/{id}/timeslots/menu/{menu} - Get location brand timeslots for menu
@@ -1025,7 +1078,9 @@ export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
 
 export interface GetLocationBrandMenuTimeslotsRequest
   extends RequestQuery<GetLocationBrandMenuTimeslotsQuery>,
-    GetLocationBrandMenuTimeslotsPath {}
+    GetLocationBrandMenuTimeslotsPath {
+  context?: RequestContext;
+}
 
 // GET /location/brand/{id}/timeslots/delivery - Get location brand delivery timeslots
 
@@ -1045,7 +1100,9 @@ export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
 
 export interface GetLocationBrandDeliveryTimeslotsRequest
   extends RequestQuery<GetLocationBrandDeliveryTimeslotsQuery>,
-    GetLocationBrandDeliveryTimeslotsPath {}
+    GetLocationBrandDeliveryTimeslotsPath {
+  context?: RequestContext;
+}
 
 // GET /location/brand/{id}/timeslots/delivery/menu/{menu} - Get location brand delivery timeslots for menu
 
@@ -1067,7 +1124,9 @@ export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
 
 export interface GetLocationBrandMenuDeliveryTimeslostsRequest
   extends RequestQuery<GetLocationBrandMenuDeliveryTimeslostsQuery>,
-    GetLocationBrandMenuDeliveryTimeslostsPath {}
+    GetLocationBrandMenuDeliveryTimeslostsPath {
+  context?: RequestContext;
+}
 
 // POST /location/brand - Create a new Brand
 
@@ -1077,6 +1136,7 @@ export type PostLocationBrandResponse = Brand;
 
 export interface PostLocationBrandRequest {
   body: PostLocationBrandBody;
+  context?: RequestContext;
 }
 
 // GET /location/brand/{id} - Get location brand
@@ -1098,7 +1158,9 @@ export type GetLocationBrandResponse = Brand;
 
 export interface GetLocationBrandRequest
   extends RequestQuery<GetLocationBrandQuery>,
-    GetLocationBrandPath {}
+    GetLocationBrandPath {
+  context?: RequestContext;
+}
 
 // PATCH /location/brand/{id} - Update location brand
 
@@ -1113,6 +1175,7 @@ export type PatchLocationBrandResponse = Brand;
 
 export interface PatchLocationBrandRequest extends PatchLocationBrandPath {
   body: PatchLocationBrandBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/brand/{id} - Delete data from a Brand
@@ -1128,6 +1191,7 @@ export type DeleteLocationBrandResponse = Brand;
 
 export interface DeleteLocationBrandRequest extends DeleteLocationBrandPath {
   body: DeleteLocationBrandBody;
+  context?: RequestContext;
 }
 
 // PUT /location/brand/{id} - Update location brand
@@ -1143,6 +1207,7 @@ export type PutLocationBrandResponse = Brand;
 
 export interface PutLocationBrandRequest extends PutLocationBrandPath {
   body: PutLocationBrandBody;
+  context?: RequestContext;
 }
 
 // GET /location/sector - Get list of all the sectors
@@ -1153,7 +1218,9 @@ export interface GetLocationSectorsQuery {
 
 export type GetLocationSectorsResponse = Sectors;
 
-export interface GetLocationSectorsRequest extends RequestQuery<GetLocationSectorsQuery> {}
+export interface GetLocationSectorsRequest extends RequestQuery<GetLocationSectorsQuery> {
+  context?: RequestContext;
+}
 
 // POST /location/sector - Create a new sector
 
@@ -1163,6 +1230,7 @@ export type PostLocationSectorResponse = Sector;
 
 export interface PostLocationSectorRequest {
   body: PostLocationSectorBody;
+  context?: RequestContext;
 }
 
 // GET /location/sector/{id} - Get a sector
@@ -1182,7 +1250,9 @@ export type GetLocationSectorResponse = Sector;
 
 export interface GetLocationSectorRequest
   extends RequestQuery<GetLocationSectorQuery>,
-    GetLocationSectorPath {}
+    GetLocationSectorPath {
+  context?: RequestContext;
+}
 
 // PATCH /location/sector/{id} - Update a sector
 
@@ -1204,6 +1274,7 @@ export interface PatchLocationSectorRequest
   extends RequestQuery<PatchLocationSectorQuery>,
     PatchLocationSectorPath {
   body: PatchLocationSectorBody;
+  context?: RequestContext;
 }
 
 // POST /location/company - Create a new company
@@ -1223,6 +1294,7 @@ export type PostLocationCompanyResponse = Company;
 
 export interface PostLocationCompanyRequest {
   body: PostLocationCompanyBody;
+  context?: RequestContext;
 }
 
 // GET /location/company/{id} - Get a company within sector
@@ -1240,7 +1312,9 @@ export type GetLocationCompanyResponse = Company;
 
 export interface GetLocationCompanyRequest
   extends RequestQuery<GetLocationCompanyQuery>,
-    GetLocationCompanyPath {}
+    GetLocationCompanyPath {
+  context?: RequestContext;
+}
 
 // PATCH /location/company/{id} - Update a company
 
@@ -1255,6 +1329,7 @@ export type PatchLocationCompanyResponse = Company;
 
 export interface PatchLocationCompanyRequest extends PatchLocationCompanyPath {
   body: PatchLocationCompanyBody;
+  context?: RequestContext;
 }
 
 // DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
@@ -1275,4 +1350,6 @@ export interface DeleteLocationRecordResponse {
 
 export interface DeleteLocationRecordRequest
   extends RequestQuery<DeleteLocationRecordQuery>,
-    DeleteLocationRecordPath {}
+    DeleteLocationRecordPath {
+  context?: RequestContext;
+}

package/src/interface/mealplan.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";
 
 export interface Error {
   code?: number;
@@ -78,6 +78,7 @@ export interface PostMealplanResponse {
 
 export interface PostMealplanRequest extends PostMealplanPath {
   body: PostMealplanBody;
+  context?: RequestContext;
 }
 
 // PUT /mealplan/{id} - Save a token for access to the meal plan
@@ -97,6 +98,7 @@ export interface PutMealplanResponse {
 
 export interface PutMealplanRequest extends PutMealplanPath {
   body: PutMealplanBody;
+  context?: RequestContext;
 }
 
 // GET /mealplan/{id} - Check the user's meal plan tenders and get the authentication configuration
@@ -108,7 +110,9 @@ export interface GetMealplanPath {
 
 export type GetMealplanResponse = TendersAndAuth;
 
-export interface GetMealplanRequest extends GetMealplanPath {}
+export interface GetMealplanRequest extends GetMealplanPath {
+  context?: RequestContext;
+}
 
 // DELETE /mealplan/{id} - Delete a mealplan or a tender from the user's account
 
@@ -125,6 +129,7 @@ export type DeleteMealplanResponse = TendersAndAuth;
 
 export interface DeleteMealplanRequest extends DeleteMealplanPath {
   body: DeleteMealplanBody;
+  context?: RequestContext;
 }
 
 // POST /mealplan/{id}/callback - Callback endpoint for meal plans that make a call back from a webview workflow
@@ -140,7 +145,9 @@ export interface PostMealplanCallbackResponse {
   cardNumber?: string;
 }
 
-export interface PostMealplanCallbackRequest extends PostMealplanCallbackPath {}
+export interface PostMealplanCallbackRequest extends PostMealplanCallbackPath {
+  context?: RequestContext;
+}
 
 // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
 
@@ -153,7 +160,9 @@ export interface GetMealplanTenderPath {
 
 export type GetMealplanTenderResponse = Tender;
 
-export interface GetMealplanTenderRequest extends GetMealplanTenderPath {}
+export interface GetMealplanTenderRequest extends GetMealplanTenderPath {
+  context?: RequestContext;
+}
 
 // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
 
@@ -176,7 +185,9 @@ export interface DeleteMealplanTenderResponse {
   transaction_amount?: number;
 }
 
-export interface DeleteMealplanTenderRequest extends DeleteMealplanTenderPath {}
+export interface DeleteMealplanTenderRequest extends DeleteMealplanTenderPath {
+  context?: RequestContext;
+}
 
 // PATCH /mealplan/{id}/tender/{tender} - Refund an amount to the tender balance
 
@@ -199,6 +210,7 @@ export type PatchMealplanTenderResponse = Tender;
 
 export interface PatchMealplanTenderRequest extends PatchMealplanTenderPath {
   body: PatchMealplanTenderBody;
+  context?: RequestContext;
 }
 
 // POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
@@ -221,6 +233,7 @@ export interface PostMealplanVerifyRequest
   extends RequestQuery<PostMealplanVerifyQuery>,
     PostMealplanVerifyPath {
   body: PostMealplanVerifyBody;
+  context?: RequestContext;
 }
 
 // PUT /mealplan/{id}/verify - Verify email address using provided payload
@@ -236,6 +249,7 @@ export type PutMealplanVerifyResponse = success;
 
 export interface PutMealplanVerifyRequest extends PutMealplanVerifyPath {
   body: PutMealplanVerifyBody;
+  context?: RequestContext;
 }
 
 // POST /mealplan/{id}/authorize - Authorize Transaction
@@ -265,4 +279,5 @@ export interface PostMealplanAuthorizeResponse {
 
 export interface PostMealplanAuthorizeRequest extends PostMealplanAuthorizePath {
   body: PostMealplanAuthorizeBody;
+  context?: RequestContext;
 }