@compassdigital/sdk.typescript 3.19.0 → 3.21.0

package/src/interface/permission.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Success {
   success?: boolean;
@@ -122,7 +122,7 @@ export type PostPermissionBody = PermissionBody;
 
 export type PostPermissionResponse = Permission;
 
-export interface PostPermissionRequest {
+export interface PostPermissionRequest extends BaseRequest {
   body: PostPermissionBody;
 }
 
@@ -135,7 +135,7 @@ export interface DeletePermissionPath {
 
 export type DeletePermissionResponse = Success;
 
-export interface DeletePermissionRequest extends DeletePermissionPath {}
+export interface DeletePermissionRequest extends BaseRequest, DeletePermissionPath {}
 
 // GET /permission/role - Get Roles, with pagination and filters
 
@@ -150,7 +150,9 @@ export interface GetPermissionRoleQuery {
 
 export type GetPermissionRoleResponse = Roles;
 
-export interface GetPermissionRoleRequest extends RequestQuery<GetPermissionRoleQuery> {}
+export interface GetPermissionRoleRequest
+  extends BaseRequest,
+    RequestQuery<GetPermissionRoleQuery> {}
 
 // POST /permission/role - Create a new role
 
@@ -158,7 +160,7 @@ export type PostPermissionRoleBody = RoleBody;
 
 export type PostPermissionRoleResponse = Role;
 
-export interface PostPermissionRoleRequest {
+export interface PostPermissionRoleRequest extends BaseRequest {
   body: PostPermissionRoleBody;
 }
 
@@ -173,7 +175,7 @@ export type PatchPermissionRoleBody = RolePatchBody;
 
 export type PatchPermissionRoleResponse = Role;
 
-export interface PatchPermissionRoleRequest extends PatchPermissionRolePath {
+export interface PatchPermissionRoleRequest extends BaseRequest, PatchPermissionRolePath {
   body: PatchPermissionRoleBody;
 }
 
@@ -194,7 +196,8 @@ export interface GetPermissionRecipientQuery {
 export type GetPermissionRecipientResponse = Permissions;
 
 export interface GetPermissionRecipientRequest
-  extends RequestQuery<GetPermissionRecipientQuery>,
+  extends BaseRequest,
+    RequestQuery<GetPermissionRecipientQuery>,
     GetPermissionRecipientPath {}
 
 // GET /permission/role/user/{user_id} - Get a list of role assignments for a user
@@ -206,7 +209,7 @@ export interface GetPermissionRoleUserPath {
 
 export type GetPermissionRoleUserResponse = RoleAssignments;
 
-export interface GetPermissionRoleUserRequest extends GetPermissionRoleUserPath {}
+export interface GetPermissionRoleUserRequest extends BaseRequest, GetPermissionRoleUserPath {}
 
 // POST /permission/role/user/{user_id} - Assign a role to a user
 
@@ -219,7 +222,7 @@ export type PostPermissionRoleUserBody = RoleAssignmentBody;
 
 export type PostPermissionRoleUserResponse = RoleAssignment;
 
-export interface PostPermissionRoleUserRequest extends PostPermissionRoleUserPath {
+export interface PostPermissionRoleUserRequest extends BaseRequest, PostPermissionRoleUserPath {
   body: PostPermissionRoleUserBody;
 }
 
@@ -234,6 +237,6 @@ export type DeletePermissionRoleUserBody = RoleAssignment;
 
 export type DeletePermissionRoleUserResponse = Success;
 
-export interface DeletePermissionRoleUserRequest extends DeletePermissionRoleUserPath {
+export interface DeletePermissionRoleUserRequest extends BaseRequest, DeletePermissionRoleUserPath {
   body: DeletePermissionRoleUserBody;
 }

package/src/interface/promo.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Error {
   message?: string;
@@ -248,7 +248,7 @@ export type PostPromoBody = PromotionBody;
 
 export type PostPromoResponse = Promotion;
 
-export interface PostPromoRequest {
+export interface PostPromoRequest extends BaseRequest {
   body: PostPromoBody;
 }
 
@@ -261,7 +261,7 @@ export interface GetPromosQuery {
 
 export type GetPromosResponse = Promotions;
 
-export interface GetPromosRequest extends RequestQuery<GetPromosQuery> {}
+export interface GetPromosRequest extends BaseRequest, RequestQuery<GetPromosQuery> {}
 
 // GET /promo/{id} - Get an individual promotion
 
@@ -277,7 +277,7 @@ export interface GetPromoQuery {
 
 export type GetPromoResponse = Promotion;
 
-export interface GetPromoRequest extends RequestQuery<GetPromoQuery>, GetPromoPath {}
+export interface GetPromoRequest extends BaseRequest, RequestQuery<GetPromoQuery>, GetPromoPath {}
 
 // PUT /promo/{id} - Update a promotion
 
@@ -290,7 +290,7 @@ export type PutPromoBody = Promotion;
 
 export type PutPromoResponse = Promotion;
 
-export interface PutPromoRequest extends PutPromoPath {
+export interface PutPromoRequest extends BaseRequest, PutPromoPath {
   body: PutPromoBody;
 }
 
@@ -303,7 +303,7 @@ export interface DeletePromoPath {
 
 export type DeletePromoResponse = Success;
 
-export interface DeletePromoRequest extends DeletePromoPath {}
+export interface DeletePromoRequest extends BaseRequest, DeletePromoPath {}
 
 // GET /promo/company/{company}/location/group/{location_group} - Get all promotions within company for a location group
 
@@ -323,7 +323,8 @@ export interface GetPromoCompanyLocationGroupQuery {
 export type GetPromoCompanyLocationGroupResponse = Promotions;
 
 export interface GetPromoCompanyLocationGroupRequest
-  extends RequestQuery<GetPromoCompanyLocationGroupQuery>,
+  extends BaseRequest,
+    RequestQuery<GetPromoCompanyLocationGroupQuery>,
     GetPromoCompanyLocationGroupPath {}
 
 // POST /promo/validate/voucher - Validate a promo voucher
@@ -332,7 +333,7 @@ export type PostPromoValidateVoucherBody = VoucherCode;
 
 export type PostPromoValidateVoucherResponse = Voucher;
 
-export interface PostPromoValidateVoucherRequest {
+export interface PostPromoValidateVoucherRequest extends BaseRequest {
   body: PostPromoValidateVoucherBody;
 }
 
@@ -342,7 +343,7 @@ export type PostPromoRedeemVoucherBody = VoucherCode;
 
 export type PostPromoRedeemVoucherResponse = Redemption;
 
-export interface PostPromoRedeemVoucherRequest {
+export interface PostPromoRedeemVoucherRequest extends BaseRequest {
   body: PostPromoRedeemVoucherBody;
 }
 
@@ -352,7 +353,7 @@ export type PostPromoVoucherBody = CreateVoucher;
 
 export type PostPromoVoucherResponse = Voucher;
 
-export interface PostPromoVoucherRequest {
+export interface PostPromoVoucherRequest extends BaseRequest {
   body: PostPromoVoucherBody;
 }
 
@@ -367,7 +368,7 @@ export type PutPromoVoucherBody = UpdateVoucher;
 
 export type PutPromoVoucherResponse = Voucher;
 
-export interface PutPromoVoucherRequest extends PutPromoVoucherPath {
+export interface PutPromoVoucherRequest extends BaseRequest, PutPromoVoucherPath {
   body: PutPromoVoucherBody;
 }
 
@@ -388,7 +389,8 @@ export interface DeletePromoVoucherResponse {
 }
 
 export interface DeletePromoVoucherRequest
-  extends RequestQuery<DeletePromoVoucherQuery>,
+  extends BaseRequest,
+    RequestQuery<DeletePromoVoucherQuery>,
     DeletePromoVoucherPath {}
 
 // POST /promo/customer/ - Add user to voucherify
@@ -397,7 +399,7 @@ export type PostPromoCustomerBody = VoucherifyCustomer;
 
 export type PostPromoCustomerResponse = Customer;
 
-export interface PostPromoCustomerRequest {
+export interface PostPromoCustomerRequest extends BaseRequest {
   body: PostPromoCustomerBody;
 }
 
@@ -413,7 +415,7 @@ export interface DeletePromoCustomerResponse {
   success?: boolean;
 }
 
-export interface DeletePromoCustomerRequest {
+export interface DeletePromoCustomerRequest extends BaseRequest {
   body: DeletePromoCustomerBody;
 }
 
@@ -428,7 +430,7 @@ export type PostPromoVoucherReverseBody = ReverseRedemption;
 
 export type PostPromoVoucherReverseResponse = RedemptionReversal;
 
-export interface PostPromoVoucherReverseRequest extends PostPromoVoucherReversePath {
+export interface PostPromoVoucherReverseRequest extends BaseRequest, PostPromoVoucherReversePath {
   body: PostPromoVoucherReverseBody;
 }
 
@@ -438,7 +440,7 @@ export type PostPromoVoucherifyActivityExecuteBody = string;
 
 export type PostPromoVoucherifyActivityExecuteResponse = Customer;
 
-export interface PostPromoVoucherifyActivityExecuteRequest {
+export interface PostPromoVoucherifyActivityExecuteRequest extends BaseRequest {
   body: PostPromoVoucherifyActivityExecuteBody;
 }
 
@@ -446,4 +448,4 @@ export interface PostPromoVoucherifyActivityExecuteRequest {
 
 export type GetPromoVoucherifyActivityConfigResponse = SFMCConfig;
 
-export type GetPromoVoucherifyActivityConfigRequest = {};
+export interface GetPromoVoucherifyActivityConfigRequest extends BaseRequest {}

package/src/interface/report.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Success {
   success?: boolean;
@@ -324,7 +324,8 @@ export interface GetReportAnalyticsGroupQuery {
 export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
 
 export interface GetReportAnalyticsGroupRequest
-  extends RequestQuery<GetReportAnalyticsGroupQuery>,
+  extends BaseRequest,
+    RequestQuery<GetReportAnalyticsGroupQuery>,
     GetReportAnalyticsGroupPath {}
 
 // GET /report/analytics/combined/group/{location_group}
@@ -345,7 +346,8 @@ export interface GetReportAnalyticsCombinedGroupQuery {
 export type GetReportAnalyticsCombinedGroupResponse = SAReport;
 
 export interface GetReportAnalyticsCombinedGroupRequest
-  extends RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
+  extends BaseRequest,
+    RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
     GetReportAnalyticsCombinedGroupPath {}
 
 // GET /report/eod/group/{id} - Get reports for selected location group
@@ -369,7 +371,8 @@ export interface GetReportEodGroupQuery {
 export type GetReportEodGroupResponse = EODReports;
 
 export interface GetReportEodGroupRequest
-  extends RequestQuery<GetReportEodGroupQuery>,
+  extends BaseRequest,
+    RequestQuery<GetReportEodGroupQuery>,
     GetReportEodGroupPath {}
 
 // GET /report/eod/group/{id}/subscribers - Get reports for selected location group
@@ -380,7 +383,9 @@ export interface GetReportEodGroupSubscribersPath {
 
 export type GetReportEodGroupSubscribersResponse = EODSubscribers;
 
-export interface GetReportEodGroupSubscribersRequest extends GetReportEodGroupSubscribersPath {}
+export interface GetReportEodGroupSubscribersRequest
+  extends BaseRequest,
+    GetReportEodGroupSubscribersPath {}
 
 // POST /report/eod/group/{id}/subscribers - Add emails to selected location group
 
@@ -392,7 +397,9 @@ export type PostReportEodGroupSubscribersBody = EODSubscribers;
 
 export type PostReportEodGroupSubscribersResponse = EODSubscribers;
 
-export interface PostReportEodGroupSubscribersRequest extends PostReportEodGroupSubscribersPath {
+export interface PostReportEodGroupSubscribersRequest
+  extends BaseRequest,
+    PostReportEodGroupSubscribersPath {
   body: PostReportEodGroupSubscribersBody;
 }
 
@@ -405,7 +412,8 @@ export interface DeleteReportEodGroupSubscribersPath {
 export type DeleteReportEodGroupSubscribersResponse = Success;
 
 export interface DeleteReportEodGroupSubscribersRequest
-  extends DeleteReportEodGroupSubscribersPath {}
+  extends BaseRequest,
+    DeleteReportEodGroupSubscribersPath {}
 
 // PUT /report/eod/group/{id}/subscribers - replace all subscribers from selected location group with payload
 
@@ -417,6 +425,8 @@ export type PutReportEodGroupSubscribersBody = EODSubscribers;
 
 export type PutReportEodGroupSubscribersResponse = EODSubscribers;
 
-export interface PutReportEodGroupSubscribersRequest extends PutReportEodGroupSubscribersPath {
+export interface PutReportEodGroupSubscribersRequest
+  extends BaseRequest,
+    PutReportEodGroupSubscribersPath {
   body: PutReportEodGroupSubscribersBody;
 }

package/src/interface/shoppingcart.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Error {
   message?: string;
@@ -238,7 +238,7 @@ export type PostShoppingcartCartBody = ShoppingCart;
 
 export type PostShoppingcartCartResponse = ShoppingCart;
 
-export interface PostShoppingcartCartRequest {
+export interface PostShoppingcartCartRequest extends BaseRequest {
   body: PostShoppingcartCartBody;
 }
 
@@ -253,7 +253,7 @@ export type PutShoppingcartCartItemsBody = Items;
 
 export type PutShoppingcartCartItemsResponse = ShoppingCart;
 
-export interface PutShoppingcartCartItemsRequest extends PutShoppingcartCartItemsPath {
+export interface PutShoppingcartCartItemsRequest extends BaseRequest, PutShoppingcartCartItemsPath {
   body: PutShoppingcartCartItemsBody;
 }
 
@@ -268,7 +268,9 @@ export type DeleteShoppingcartCartItemsBody = Items;
 
 export type DeleteShoppingcartCartItemsResponse = ShoppingCart;
 
-export interface DeleteShoppingcartCartItemsRequest extends DeleteShoppingcartCartItemsPath {
+export interface DeleteShoppingcartCartItemsRequest
+  extends BaseRequest,
+    DeleteShoppingcartCartItemsPath {
   body: DeleteShoppingcartCartItemsBody;
 }
 
@@ -281,7 +283,7 @@ export interface GetShoppingcartCartPath {
 
 export type GetShoppingcartCartResponse = ShoppingCart;
 
-export interface GetShoppingcartCartRequest extends GetShoppingcartCartPath {}
+export interface GetShoppingcartCartRequest extends BaseRequest, GetShoppingcartCartPath {}
 
 // PATCH /shoppingcart/{id} - Update a ShoppingCart
 
@@ -294,7 +296,7 @@ export type PatchShoppingcartCartBody = ShoppingCart;
 
 export type PatchShoppingcartCartResponse = ShoppingCart;
 
-export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {
+export interface PatchShoppingcartCartRequest extends BaseRequest, PatchShoppingcartCartPath {
   body: PatchShoppingcartCartBody;
 }
 
@@ -309,7 +311,7 @@ export type PutShoppingcartCartPromoBody = Promo;
 
 export type PutShoppingcartCartPromoResponse = ShoppingCart;
 
-export interface PutShoppingcartCartPromoRequest extends PutShoppingcartCartPromoPath {
+export interface PutShoppingcartCartPromoRequest extends BaseRequest, PutShoppingcartCartPromoPath {
   body: PutShoppingcartCartPromoBody;
 }
 
@@ -322,7 +324,9 @@ export interface DeleteShoppingcartCartPromoPath {
 
 export type DeleteShoppingcartCartPromoResponse = ShoppingCart;
 
-export interface DeleteShoppingcartCartPromoRequest extends DeleteShoppingcartCartPromoPath {}
+export interface DeleteShoppingcartCartPromoRequest
+  extends BaseRequest,
+    DeleteShoppingcartCartPromoPath {}
 
 // PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
 
@@ -335,7 +339,9 @@ export type PutShoppingcartCartPaymentBody = Payment;
 
 export type PutShoppingcartCartPaymentResponse = ShoppingCart;
 
-export interface PutShoppingcartCartPaymentRequest extends PutShoppingcartCartPaymentPath {
+export interface PutShoppingcartCartPaymentRequest
+  extends BaseRequest,
+    PutShoppingcartCartPaymentPath {
   body: PutShoppingcartCartPaymentBody;
 }
 
@@ -350,7 +356,7 @@ export type PutShoppingcartCartOrderBody = OrderId;
 
 export type PutShoppingcartCartOrderResponse = ShoppingCart;
 
-export interface PutShoppingcartCartOrderRequest extends PutShoppingcartCartOrderPath {
+export interface PutShoppingcartCartOrderRequest extends BaseRequest, PutShoppingcartCartOrderPath {
   body: PutShoppingcartCartOrderBody;
 }
 
@@ -367,7 +373,9 @@ export type PutShoppingcartCartLoyaltyBody = CouponCode;
 
 export type PutShoppingcartCartLoyaltyResponse = ShoppingCart;
 
-export interface PutShoppingcartCartLoyaltyRequest extends PutShoppingcartCartLoyaltyPath {
+export interface PutShoppingcartCartLoyaltyRequest
+  extends BaseRequest,
+    PutShoppingcartCartLoyaltyPath {
   body: PutShoppingcartCartLoyaltyBody;
 }
 
@@ -382,7 +390,9 @@ export interface DeleteShoppingcartCartLoyaltyPath {
 
 export type DeleteShoppingcartCartLoyaltyResponse = ShoppingCart;
 
-export interface DeleteShoppingcartCartLoyaltyRequest extends DeleteShoppingcartCartLoyaltyPath {}
+export interface DeleteShoppingcartCartLoyaltyRequest
+  extends BaseRequest,
+    DeleteShoppingcartCartLoyaltyPath {}
 
 // POST /shoppingcart/{id}/clone - Create a shopping cart from existing shopping cart
 
@@ -398,7 +408,9 @@ export interface PostShoppingcartCloneCartBody {
 
 export type PostShoppingcartCloneCartResponse = ShoppingCart;
 
-export interface PostShoppingcartCloneCartRequest extends PostShoppingcartCloneCartPath {
+export interface PostShoppingcartCloneCartRequest
+  extends BaseRequest,
+    PostShoppingcartCloneCartPath {
   body: PostShoppingcartCloneCartBody;
 }
 
@@ -411,7 +423,7 @@ export interface PutShoppingcartCheckoutPath {
 
 export type PutShoppingcartCheckoutResponse = ShoppingCart;
 
-export interface PutShoppingcartCheckoutRequest extends PutShoppingcartCheckoutPath {}
+export interface PutShoppingcartCheckoutRequest extends BaseRequest, PutShoppingcartCheckoutPath {}
 
 // POST /shoppingcart/bulk - Get multiple ShoppingCarts
 
@@ -422,6 +434,6 @@ export interface PostShoppingcartBulkBody {
 
 export type PostShoppingcartBulkResponse = ShoppingCarts;
 
-export interface PostShoppingcartBulkRequest {
+export interface PostShoppingcartBulkRequest extends BaseRequest {
   body: PostShoppingcartBulkBody;
 }

package/src/interface/sms.ts

@@ -1,3 +1,3 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery } from "./util";
+import { RequestQuery, BaseRequest } 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, BaseRequest } from "./util";
 
 export interface TaskLocation {
   // Location ID
@@ -143,7 +143,7 @@ export type PostTaskBody = TaskCreate;
 
 export type PostTaskResponse = Task;
 
-export interface PostTaskRequest {
+export interface PostTaskRequest extends BaseRequest {
   body: PostTaskBody;
 }
 
@@ -156,7 +156,7 @@ export interface GetTaskPath {
 
 export type GetTaskResponse = Task;
 
-export interface GetTaskRequest extends GetTaskPath {}
+export interface GetTaskRequest extends BaseRequest, GetTaskPath {}
 
 // PATCH /task/{id} - Update Task
 
@@ -169,7 +169,7 @@ export type PatchTaskBody = TaskUpdate;
 
 export type PatchTaskResponse = Task;
 
-export interface PatchTaskRequest extends PatchTaskPath {
+export interface PatchTaskRequest extends BaseRequest, PatchTaskPath {
   body: PatchTaskBody;
 }
 
@@ -182,7 +182,7 @@ export interface DeleteTaskPath {
 
 export type DeleteTaskResponse = ActionResponse;
 
-export interface DeleteTaskRequest extends DeleteTaskPath {}
+export interface DeleteTaskRequest extends BaseRequest, DeleteTaskPath {}
 
 // GET /task/order/{id} - Get task based on passed order ID
 
@@ -193,7 +193,7 @@ export interface GetTaskOrderPath {
 
 export type GetTaskOrderResponse = Task;
 
-export interface GetTaskOrderRequest extends GetTaskOrderPath {}
+export interface GetTaskOrderRequest extends BaseRequest, GetTaskOrderPath {}
 
 // GET /task/order/{id}/kds - Get KDS tasks based on passed order ID
 
@@ -204,7 +204,7 @@ export interface GetTaskOrderKdsPath {
 
 export type GetTaskOrderKdsResponse = Tasks;
 
-export interface GetTaskOrderKdsRequest extends GetTaskOrderKdsPath {}
+export interface GetTaskOrderKdsRequest extends BaseRequest, GetTaskOrderKdsPath {}
 
 // PATCH /task/order/{id}/kds - Update an order and its associated tasks
 
@@ -217,7 +217,7 @@ export type PatchTaskOrderKdsBody = OrderUpdate;
 
 export type PatchTaskOrderKdsResponse = Tasks;
 
-export interface PatchTaskOrderKdsRequest extends PatchTaskOrderKdsPath {
+export interface PatchTaskOrderKdsRequest extends BaseRequest, PatchTaskOrderKdsPath {
   body: PatchTaskOrderKdsBody;
 }
 
@@ -244,7 +244,8 @@ export interface GetTaskAssigneeQuery {
 export type GetTaskAssigneeResponse = Tasks;
 
 export interface GetTaskAssigneeRequest
-  extends RequestQuery<GetTaskAssigneeQuery>,
+  extends BaseRequest,
+    RequestQuery<GetTaskAssigneeQuery>,
     GetTaskAssigneePath {}
 
 // GET /task/location/brand/{id} - Get location brand tasks
@@ -274,7 +275,8 @@ export interface GetTaskLocationBrandQuery {
 export type GetTaskLocationBrandResponse = Tasks;
 
 export interface GetTaskLocationBrandRequest
-  extends RequestQuery<GetTaskLocationBrandQuery>,
+  extends BaseRequest,
+    RequestQuery<GetTaskLocationBrandQuery>,
     GetTaskLocationBrandPath {}
 
 // GET /task/location/group/{id} - Get location group tasks
@@ -304,5 +306,6 @@ export interface GetTaskLocationGroupQuery {
 export type GetTaskLocationGroupResponse = Tasks;
 
 export interface GetTaskLocationGroupRequest
-  extends RequestQuery<GetTaskLocationGroupQuery>,
+  extends BaseRequest,
+    RequestQuery<GetTaskLocationGroupQuery>,
     GetTaskLocationGroupPath {}