@compassdigital/sdk.typescript 3.19.0 → 3.20.0

package/src/interface/permission.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";
 
 export interface Success {
   success?: boolean;
@@ -124,6 +124,7 @@ export type PostPermissionResponse = Permission;
 
 export interface PostPermissionRequest {
   body: PostPermissionBody;
+  context?: RequestContext;
 }
 
 // DELETE /permission/{id} - Delete a permission from a role or a user
@@ -135,7 +136,9 @@ export interface DeletePermissionPath {
 
 export type DeletePermissionResponse = Success;
 
-export interface DeletePermissionRequest extends DeletePermissionPath {}
+export interface DeletePermissionRequest extends DeletePermissionPath {
+  context?: RequestContext;
+}
 
 // GET /permission/role - Get Roles, with pagination and filters
 
@@ -150,7 +153,9 @@ export interface GetPermissionRoleQuery {
 
 export type GetPermissionRoleResponse = Roles;
 
-export interface GetPermissionRoleRequest extends RequestQuery<GetPermissionRoleQuery> {}
+export interface GetPermissionRoleRequest extends RequestQuery<GetPermissionRoleQuery> {
+  context?: RequestContext;
+}
 
 // POST /permission/role - Create a new role
 
@@ -160,6 +165,7 @@ export type PostPermissionRoleResponse = Role;
 
 export interface PostPermissionRoleRequest {
   body: PostPermissionRoleBody;
+  context?: RequestContext;
 }
 
 // PATCH /permission/role/{id} - Update a role
@@ -175,6 +181,7 @@ export type PatchPermissionRoleResponse = Role;
 
 export interface PatchPermissionRoleRequest extends PatchPermissionRolePath {
   body: PatchPermissionRoleBody;
+  context?: RequestContext;
 }
 
 // GET /permission/recipient/{recipient_id} - Get permissions for a recipient(role or user id)
@@ -195,7 +202,9 @@ export type GetPermissionRecipientResponse = Permissions;
 
 export interface GetPermissionRecipientRequest
   extends RequestQuery<GetPermissionRecipientQuery>,
-    GetPermissionRecipientPath {}
+    GetPermissionRecipientPath {
+  context?: RequestContext;
+}
 
 // GET /permission/role/user/{user_id} - Get a list of role assignments for a user
 
@@ -206,7 +215,9 @@ export interface GetPermissionRoleUserPath {
 
 export type GetPermissionRoleUserResponse = RoleAssignments;
 
-export interface GetPermissionRoleUserRequest extends GetPermissionRoleUserPath {}
+export interface GetPermissionRoleUserRequest extends GetPermissionRoleUserPath {
+  context?: RequestContext;
+}
 
 // POST /permission/role/user/{user_id} - Assign a role to a user
 
@@ -221,6 +232,7 @@ export type PostPermissionRoleUserResponse = RoleAssignment;
 
 export interface PostPermissionRoleUserRequest extends PostPermissionRoleUserPath {
   body: PostPermissionRoleUserBody;
+  context?: RequestContext;
 }
 
 // DELETE /permission/role/user/{user_id} - Remove a role from a user
@@ -236,4 +248,5 @@ export type DeletePermissionRoleUserResponse = Success;
 
 export interface DeletePermissionRoleUserRequest extends DeletePermissionRoleUserPath {
   body: DeletePermissionRoleUserBody;
+  context?: RequestContext;
 }

package/src/interface/promo.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 {
   message?: string;
@@ -250,6 +250,7 @@ export type PostPromoResponse = Promotion;
 
 export interface PostPromoRequest {
   body: PostPromoBody;
+  context?: RequestContext;
 }
 
 // GET /promo - Get all promotions
@@ -261,7 +262,9 @@ export interface GetPromosQuery {
 
 export type GetPromosResponse = Promotions;
 
-export interface GetPromosRequest extends RequestQuery<GetPromosQuery> {}
+export interface GetPromosRequest extends RequestQuery<GetPromosQuery> {
+  context?: RequestContext;
+}
 
 // GET /promo/{id} - Get an individual promotion
 
@@ -277,7 +280,9 @@ export interface GetPromoQuery {
 
 export type GetPromoResponse = Promotion;
 
-export interface GetPromoRequest extends RequestQuery<GetPromoQuery>, GetPromoPath {}
+export interface GetPromoRequest extends RequestQuery<GetPromoQuery>, GetPromoPath {
+  context?: RequestContext;
+}
 
 // PUT /promo/{id} - Update a promotion
 
@@ -292,6 +297,7 @@ export type PutPromoResponse = Promotion;
 
 export interface PutPromoRequest extends PutPromoPath {
   body: PutPromoBody;
+  context?: RequestContext;
 }
 
 // DELETE /promo/{id} - Delete promotion
@@ -303,7 +309,9 @@ export interface DeletePromoPath {
 
 export type DeletePromoResponse = Success;
 
-export interface DeletePromoRequest extends DeletePromoPath {}
+export interface DeletePromoRequest extends DeletePromoPath {
+  context?: RequestContext;
+}
 
 // GET /promo/company/{company}/location/group/{location_group} - Get all promotions within company for a location group
 
@@ -324,7 +332,9 @@ export type GetPromoCompanyLocationGroupResponse = Promotions;
 
 export interface GetPromoCompanyLocationGroupRequest
   extends RequestQuery<GetPromoCompanyLocationGroupQuery>,
-    GetPromoCompanyLocationGroupPath {}
+    GetPromoCompanyLocationGroupPath {
+  context?: RequestContext;
+}
 
 // POST /promo/validate/voucher - Validate a promo voucher
 
@@ -334,6 +344,7 @@ export type PostPromoValidateVoucherResponse = Voucher;
 
 export interface PostPromoValidateVoucherRequest {
   body: PostPromoValidateVoucherBody;
+  context?: RequestContext;
 }
 
 // POST /promo/redeem/voucher - Redeem a promo voucher
@@ -344,6 +355,7 @@ export type PostPromoRedeemVoucherResponse = Redemption;
 
 export interface PostPromoRedeemVoucherRequest {
   body: PostPromoRedeemVoucherBody;
+  context?: RequestContext;
 }
 
 // POST /promo/voucher - Create new voucher
@@ -354,6 +366,7 @@ export type PostPromoVoucherResponse = Voucher;
 
 export interface PostPromoVoucherRequest {
   body: PostPromoVoucherBody;
+  context?: RequestContext;
 }
 
 // PUT /promo/voucher/{id} - Update voucher
@@ -369,6 +382,7 @@ export type PutPromoVoucherResponse = Voucher;
 
 export interface PutPromoVoucherRequest extends PutPromoVoucherPath {
   body: PutPromoVoucherBody;
+  context?: RequestContext;
 }
 
 // DELETE /promo/voucher/{id} - Delete voucher
@@ -389,7 +403,9 @@ export interface DeletePromoVoucherResponse {
 
 export interface DeletePromoVoucherRequest
   extends RequestQuery<DeletePromoVoucherQuery>,
-    DeletePromoVoucherPath {}
+    DeletePromoVoucherPath {
+  context?: RequestContext;
+}
 
 // POST /promo/customer/ - Add user to voucherify
 
@@ -399,6 +415,7 @@ export type PostPromoCustomerResponse = Customer;
 
 export interface PostPromoCustomerRequest {
   body: PostPromoCustomerBody;
+  context?: RequestContext;
 }
 
 // DELETE /promo/customer/ - Delete user from voucherify
@@ -415,6 +432,7 @@ export interface DeletePromoCustomerResponse {
 
 export interface DeletePromoCustomerRequest {
   body: DeletePromoCustomerBody;
+  context?: RequestContext;
 }
 
 // POST /promo/voucher/{id}/reverse - Reverse a redemption from a promo voucher
@@ -430,6 +448,7 @@ export type PostPromoVoucherReverseResponse = RedemptionReversal;
 
 export interface PostPromoVoucherReverseRequest extends PostPromoVoucherReversePath {
   body: PostPromoVoucherReverseBody;
+  context?: RequestContext;
 }
 
 // POST /promo/voucherify/activity/execute - Execute a Journey custom Activity request
@@ -440,10 +459,13 @@ export type PostPromoVoucherifyActivityExecuteResponse = Customer;
 
 export interface PostPromoVoucherifyActivityExecuteRequest {
   body: PostPromoVoucherifyActivityExecuteBody;
+  context?: RequestContext;
 }
 
 // GET /promo/voucherify/activity/config.json - Get SFMC Journey Custom Activity configuration
 
 export type GetPromoVoucherifyActivityConfigResponse = SFMCConfig;
 
-export type GetPromoVoucherifyActivityConfigRequest = {};
+export interface GetPromoVoucherifyActivityConfigRequest {
+  context?: RequestContext;
+}

package/src/interface/report.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";
 
 export interface Success {
   success?: boolean;
@@ -325,7 +325,9 @@ export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
 
 export interface GetReportAnalyticsGroupRequest
   extends RequestQuery<GetReportAnalyticsGroupQuery>,
-    GetReportAnalyticsGroupPath {}
+    GetReportAnalyticsGroupPath {
+  context?: RequestContext;
+}
 
 // GET /report/analytics/combined/group/{location_group}
 
@@ -346,7 +348,9 @@ export type GetReportAnalyticsCombinedGroupResponse = SAReport;
 
 export interface GetReportAnalyticsCombinedGroupRequest
   extends RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
-    GetReportAnalyticsCombinedGroupPath {}
+    GetReportAnalyticsCombinedGroupPath {
+  context?: RequestContext;
+}
 
 // GET /report/eod/group/{id} - Get reports for selected location group
 
@@ -370,7 +374,9 @@ export type GetReportEodGroupResponse = EODReports;
 
 export interface GetReportEodGroupRequest
   extends RequestQuery<GetReportEodGroupQuery>,
-    GetReportEodGroupPath {}
+    GetReportEodGroupPath {
+  context?: RequestContext;
+}
 
 // GET /report/eod/group/{id}/subscribers - Get reports for selected location group
 
@@ -380,7 +386,9 @@ export interface GetReportEodGroupSubscribersPath {
 
 export type GetReportEodGroupSubscribersResponse = EODSubscribers;
 
-export interface GetReportEodGroupSubscribersRequest extends GetReportEodGroupSubscribersPath {}
+export interface GetReportEodGroupSubscribersRequest extends GetReportEodGroupSubscribersPath {
+  context?: RequestContext;
+}
 
 // POST /report/eod/group/{id}/subscribers - Add emails to selected location group
 
@@ -394,6 +402,7 @@ export type PostReportEodGroupSubscribersResponse = EODSubscribers;
 
 export interface PostReportEodGroupSubscribersRequest extends PostReportEodGroupSubscribersPath {
   body: PostReportEodGroupSubscribersBody;
+  context?: RequestContext;
 }
 
 // DELETE /report/eod/group/{id}/subscribers - deletes subscribers from selected group
@@ -405,7 +414,9 @@ export interface DeleteReportEodGroupSubscribersPath {
 export type DeleteReportEodGroupSubscribersResponse = Success;
 
 export interface DeleteReportEodGroupSubscribersRequest
-  extends DeleteReportEodGroupSubscribersPath {}
+  extends DeleteReportEodGroupSubscribersPath {
+  context?: RequestContext;
+}
 
 // PUT /report/eod/group/{id}/subscribers - replace all subscribers from selected location group with payload
 
@@ -419,4 +430,5 @@ export type PutReportEodGroupSubscribersResponse = EODSubscribers;
 
 export interface PutReportEodGroupSubscribersRequest extends PutReportEodGroupSubscribersPath {
   body: PutReportEodGroupSubscribersBody;
+  context?: RequestContext;
 }

package/src/interface/shoppingcart.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 {
   message?: string;
@@ -240,6 +240,7 @@ export type PostShoppingcartCartResponse = ShoppingCart;
 
 export interface PostShoppingcartCartRequest {
   body: PostShoppingcartCartBody;
+  context?: RequestContext;
 }
 
 // PUT /shoppingcart/{id} - Put a menu item into a ShoppingCart
@@ -255,6 +256,7 @@ export type PutShoppingcartCartItemsResponse = ShoppingCart;
 
 export interface PutShoppingcartCartItemsRequest extends PutShoppingcartCartItemsPath {
   body: PutShoppingcartCartItemsBody;
+  context?: RequestContext;
 }
 
 // DELETE /shoppingcart/{id} - Delete a menu item from a ShoppingCart
@@ -270,6 +272,7 @@ export type DeleteShoppingcartCartItemsResponse = ShoppingCart;
 
 export interface DeleteShoppingcartCartItemsRequest extends DeleteShoppingcartCartItemsPath {
   body: DeleteShoppingcartCartItemsBody;
+  context?: RequestContext;
 }
 
 // GET /shoppingcart/{id} - Get an individual ShoppingCart
@@ -281,7 +284,9 @@ export interface GetShoppingcartCartPath {
 
 export type GetShoppingcartCartResponse = ShoppingCart;
 
-export interface GetShoppingcartCartRequest extends GetShoppingcartCartPath {}
+export interface GetShoppingcartCartRequest extends GetShoppingcartCartPath {
+  context?: RequestContext;
+}
 
 // PATCH /shoppingcart/{id} - Update a ShoppingCart
 
@@ -296,6 +301,7 @@ export type PatchShoppingcartCartResponse = ShoppingCart;
 
 export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {
   body: PatchShoppingcartCartBody;
+  context?: RequestContext;
 }
 
 // PUT /shoppingcart/{id}/promo - Put a promo in a ShoppingCart
@@ -311,6 +317,7 @@ export type PutShoppingcartCartPromoResponse = ShoppingCart;
 
 export interface PutShoppingcartCartPromoRequest extends PutShoppingcartCartPromoPath {
   body: PutShoppingcartCartPromoBody;
+  context?: RequestContext;
 }
 
 // DELETE /shoppingcart/{id}/promo - Delete the promo in a ShoppingCart
@@ -322,7 +329,9 @@ export interface DeleteShoppingcartCartPromoPath {
 
 export type DeleteShoppingcartCartPromoResponse = ShoppingCart;
 
-export interface DeleteShoppingcartCartPromoRequest extends DeleteShoppingcartCartPromoPath {}
+export interface DeleteShoppingcartCartPromoRequest extends DeleteShoppingcartCartPromoPath {
+  context?: RequestContext;
+}
 
 // PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
 
@@ -337,6 +346,7 @@ export type PutShoppingcartCartPaymentResponse = ShoppingCart;
 
 export interface PutShoppingcartCartPaymentRequest extends PutShoppingcartCartPaymentPath {
   body: PutShoppingcartCartPaymentBody;
+  context?: RequestContext;
 }
 
 // PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
@@ -352,6 +362,7 @@ export type PutShoppingcartCartOrderResponse = ShoppingCart;
 
 export interface PutShoppingcartCartOrderRequest extends PutShoppingcartCartOrderPath {
   body: PutShoppingcartCartOrderBody;
+  context?: RequestContext;
 }
 
 // PUT /shoppingcart/{id}/loyalty/{user_id} - Apply a loyalty coupon in a ShoppingCart
@@ -369,6 +380,7 @@ export type PutShoppingcartCartLoyaltyResponse = ShoppingCart;
 
 export interface PutShoppingcartCartLoyaltyRequest extends PutShoppingcartCartLoyaltyPath {
   body: PutShoppingcartCartLoyaltyBody;
+  context?: RequestContext;
 }
 
 // DELETE /shoppingcart/{id}/loyalty/{user_id} - Delete loyalty coupon in shoppingCart
@@ -382,7 +394,9 @@ export interface DeleteShoppingcartCartLoyaltyPath {
 
 export type DeleteShoppingcartCartLoyaltyResponse = ShoppingCart;
 
-export interface DeleteShoppingcartCartLoyaltyRequest extends DeleteShoppingcartCartLoyaltyPath {}
+export interface DeleteShoppingcartCartLoyaltyRequest extends DeleteShoppingcartCartLoyaltyPath {
+  context?: RequestContext;
+}
 
 // POST /shoppingcart/{id}/clone - Create a shopping cart from existing shopping cart
 
@@ -400,6 +414,7 @@ export type PostShoppingcartCloneCartResponse = ShoppingCart;
 
 export interface PostShoppingcartCloneCartRequest extends PostShoppingcartCloneCartPath {
   body: PostShoppingcartCloneCartBody;
+  context?: RequestContext;
 }
 
 // PUT /shoppingcart/{id}/checkout - handle ui checkout flow and call taxjar for full tax breakdown
@@ -411,7 +426,9 @@ export interface PutShoppingcartCheckoutPath {
 
 export type PutShoppingcartCheckoutResponse = ShoppingCart;
 
-export interface PutShoppingcartCheckoutRequest extends PutShoppingcartCheckoutPath {}
+export interface PutShoppingcartCheckoutRequest extends PutShoppingcartCheckoutPath {
+  context?: RequestContext;
+}
 
 // POST /shoppingcart/bulk - Get multiple ShoppingCarts
 
@@ -424,4 +441,5 @@ export type PostShoppingcartBulkResponse = ShoppingCarts;
 
 export interface PostShoppingcartBulkRequest {
   body: PostShoppingcartBulkBody;
+  context?: RequestContext;
 }

package/src/interface/sms.ts

@@ -1,3 +1,3 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";

package/src/interface/task.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, RequestContext } from "./util";
 
 export interface TaskLocation {
   // Location ID
@@ -145,6 +145,7 @@ export type PostTaskResponse = Task;
 
 export interface PostTaskRequest {
   body: PostTaskBody;
+  context?: RequestContext;
 }
 
 // GET /task/{id} - Get task based on passed ID
@@ -156,7 +157,9 @@ export interface GetTaskPath {
 
 export type GetTaskResponse = Task;
 
-export interface GetTaskRequest extends GetTaskPath {}
+export interface GetTaskRequest extends GetTaskPath {
+  context?: RequestContext;
+}
 
 // PATCH /task/{id} - Update Task
 
@@ -171,6 +174,7 @@ export type PatchTaskResponse = Task;
 
 export interface PatchTaskRequest extends PatchTaskPath {
   body: PatchTaskBody;
+  context?: RequestContext;
 }
 
 // DELETE /task/{id} - Delete Task
@@ -182,7 +186,9 @@ export interface DeleteTaskPath {
 
 export type DeleteTaskResponse = ActionResponse;
 
-export interface DeleteTaskRequest extends DeleteTaskPath {}
+export interface DeleteTaskRequest extends DeleteTaskPath {
+  context?: RequestContext;
+}
 
 // GET /task/order/{id} - Get task based on passed order ID
 
@@ -193,7 +199,9 @@ export interface GetTaskOrderPath {
 
 export type GetTaskOrderResponse = Task;
 
-export interface GetTaskOrderRequest extends GetTaskOrderPath {}
+export interface GetTaskOrderRequest extends GetTaskOrderPath {
+  context?: RequestContext;
+}
 
 // GET /task/order/{id}/kds - Get KDS tasks based on passed order ID
 
@@ -204,7 +212,9 @@ export interface GetTaskOrderKdsPath {
 
 export type GetTaskOrderKdsResponse = Tasks;
 
-export interface GetTaskOrderKdsRequest extends GetTaskOrderKdsPath {}
+export interface GetTaskOrderKdsRequest extends GetTaskOrderKdsPath {
+  context?: RequestContext;
+}
 
 // PATCH /task/order/{id}/kds - Update an order and its associated tasks
 
@@ -219,6 +229,7 @@ export type PatchTaskOrderKdsResponse = Tasks;
 
 export interface PatchTaskOrderKdsRequest extends PatchTaskOrderKdsPath {
   body: PatchTaskOrderKdsBody;
+  context?: RequestContext;
 }
 
 // GET /task/assignee/{id} - Get Assignee tasks
@@ -245,7 +256,9 @@ export type GetTaskAssigneeResponse = Tasks;
 
 export interface GetTaskAssigneeRequest
   extends RequestQuery<GetTaskAssigneeQuery>,
-    GetTaskAssigneePath {}
+    GetTaskAssigneePath {
+  context?: RequestContext;
+}
 
 // GET /task/location/brand/{id} - Get location brand tasks
 
@@ -275,7 +288,9 @@ export type GetTaskLocationBrandResponse = Tasks;
 
 export interface GetTaskLocationBrandRequest
   extends RequestQuery<GetTaskLocationBrandQuery>,
-    GetTaskLocationBrandPath {}
+    GetTaskLocationBrandPath {
+  context?: RequestContext;
+}
 
 // GET /task/location/group/{id} - Get location group tasks
 
@@ -305,4 +320,6 @@ export type GetTaskLocationGroupResponse = Tasks;
 
 export interface GetTaskLocationGroupRequest
   extends RequestQuery<GetTaskLocationGroupQuery>,
-    GetTaskLocationGroupPath {}
+    GetTaskLocationGroupPath {
+  context?: RequestContext;
+}