@compassdigital/sdk.typescript 3.20.0 → 3.22.0

package/src/interface/payment.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, RequestContext } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Transaction {
   success?: boolean;
@@ -145,9 +145,8 @@ export interface PostPaymentTransactionBody {
 
 export type PostPaymentTransactionResponse = Transaction;
 
-export interface PostPaymentTransactionRequest extends PostPaymentTransactionPath {
+export interface PostPaymentTransactionRequest extends BaseRequest, PostPaymentTransactionPath {
   body: PostPaymentTransactionBody;
-  context?: RequestContext;
 }
 
 // POST /payment/{id}/transaction/{transaction_id}/refund
@@ -172,9 +171,10 @@ export interface PostPaymentTransactionRefundBody {
 
 export type PostPaymentTransactionRefundResponse = Refund;
 
-export interface PostPaymentTransactionRefundRequest extends PostPaymentTransactionRefundPath {
+export interface PostPaymentTransactionRefundRequest
+  extends BaseRequest,
+    PostPaymentTransactionRefundPath {
   body: PostPaymentTransactionRefundBody;
-  context?: RequestContext;
 }
 
 // GET /payment/{id}/clienttoken
@@ -186,9 +186,7 @@ export interface GetPaymentClienttokenPath {
 
 export type GetPaymentClienttokenResponse = ClientToken;
 
-export interface GetPaymentClienttokenRequest extends GetPaymentClienttokenPath {
-  context?: RequestContext;
-}
+export interface GetPaymentClienttokenRequest extends BaseRequest, GetPaymentClienttokenPath {}
 
 // POST /payment/{id}/paymenttoken
 
@@ -218,9 +216,8 @@ export interface PostPaymentPaymenttokenBody {
 
 export type PostPaymentPaymenttokenResponse = PaymentMethod;
 
-export interface PostPaymentPaymenttokenRequest extends PostPaymentPaymenttokenPath {
+export interface PostPaymentPaymenttokenRequest extends BaseRequest, PostPaymentPaymenttokenPath {
   body: PostPaymentPaymenttokenBody;
-  context?: RequestContext;
 }
 
 // POST /payment/consumer
@@ -232,9 +229,8 @@ export interface PostPaymentConsumerBody {
 
 export type PostPaymentConsumerResponse = ConsumerId;
 
-export interface PostPaymentConsumerRequest {
+export interface PostPaymentConsumerRequest extends BaseRequest {
   body: PostPaymentConsumerBody;
-  context?: RequestContext;
 }
 
 // POST /payment/method
@@ -250,9 +246,8 @@ export interface PostPaymentMethodResponse {
   payment_method?: PaymentMethod;
 }
 
-export interface PostPaymentMethodRequest {
+export interface PostPaymentMethodRequest extends BaseRequest {
   body: PostPaymentMethodBody;
-  context?: RequestContext;
 }
 
 // GET /payment/{id}/method - Get a users available payment methods
@@ -272,10 +267,9 @@ export interface GetPaymentMethodResponse {
 }
 
 export interface GetPaymentMethodRequest
-  extends RequestQuery<GetPaymentMethodQuery>,
-    GetPaymentMethodPath {
-  context?: RequestContext;
-}
+  extends BaseRequest,
+    RequestQuery<GetPaymentMethodQuery>,
+    GetPaymentMethodPath {}
 
 // DELETE /payment/{id}/method/{method_id}
 
@@ -293,9 +287,8 @@ export interface DeletePaymentMethodBody {
 
 export type DeletePaymentMethodResponse = Success;
 
-export interface DeletePaymentMethodRequest extends DeletePaymentMethodPath {
+export interface DeletePaymentMethodRequest extends BaseRequest, DeletePaymentMethodPath {
   body: DeletePaymentMethodBody;
-  context?: RequestContext;
 }
 
 // GET /payment/token
@@ -315,9 +308,7 @@ export interface GetPaymentTokenQuery {
 
 export type GetPaymentTokenResponse = TokenInformation;
 
-export interface GetPaymentTokenRequest extends RequestQuery<GetPaymentTokenQuery> {
-  context?: RequestContext;
-}
+export interface GetPaymentTokenRequest extends BaseRequest, RequestQuery<GetPaymentTokenQuery> {}
 
 // POST /payment/token
 
@@ -334,9 +325,8 @@ export interface PostPaymentTokenBody {
 
 export type PostPaymentTokenResponse = PaymentCard;
 
-export interface PostPaymentTokenRequest {
+export interface PostPaymentTokenRequest extends BaseRequest {
   body: PostPaymentTokenBody;
-  context?: RequestContext;
 }
 
 // PUT /payment/token
@@ -352,9 +342,8 @@ export interface PutPaymentTokenBody {
 
 export type PutPaymentTokenResponse = PaymentCard;
 
-export interface PutPaymentTokenRequest {
+export interface PutPaymentTokenRequest extends BaseRequest {
   body: PutPaymentTokenBody;
-  context?: RequestContext;
 }
 
 // DELETE /payment/token
@@ -370,9 +359,8 @@ export interface DeletePaymentTokenBody {
 
 export type DeletePaymentTokenResponse = Success;
 
-export interface DeletePaymentTokenRequest {
+export interface DeletePaymentTokenRequest extends BaseRequest {
   body: DeletePaymentTokenBody;
-  context?: RequestContext;
 }
 
 // GET /payment/methods
@@ -389,9 +377,9 @@ export interface GetPaymentMethodsResponse {
   recordsTotal?: number;
 }
 
-export interface GetPaymentMethodsRequest extends RequestQuery<GetPaymentMethodsQuery> {
-  context?: RequestContext;
-}
+export interface GetPaymentMethodsRequest
+  extends BaseRequest,
+    RequestQuery<GetPaymentMethodsQuery> {}
 
 // GET /payment/hpc
 
@@ -407,6 +395,4 @@ export interface GetPaymentHpcResponse {
   sessionKey?: string;
 }
 
-export interface GetPaymentHpcRequest extends RequestQuery<GetPaymentHpcQuery> {
-  context?: RequestContext;
-}
+export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPaymentHpcQuery> {}

package/src/interface/permission.ts

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

package/src/interface/promo.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, RequestContext } from "./util";
+import { RequestQuery, BaseRequest } from "./util";
 
 export interface Error {
   message?: string;
@@ -248,9 +248,8 @@ export type PostPromoBody = PromotionBody;
 
 export type PostPromoResponse = Promotion;
 
-export interface PostPromoRequest {
+export interface PostPromoRequest extends BaseRequest {
   body: PostPromoBody;
-  context?: RequestContext;
 }
 
 // GET /promo - Get all promotions
@@ -262,9 +261,7 @@ export interface GetPromosQuery {
 
 export type GetPromosResponse = Promotions;
 
-export interface GetPromosRequest extends RequestQuery<GetPromosQuery> {
-  context?: RequestContext;
-}
+export interface GetPromosRequest extends BaseRequest, RequestQuery<GetPromosQuery> {}
 
 // GET /promo/{id} - Get an individual promotion
 
@@ -280,9 +277,7 @@ export interface GetPromoQuery {
 
 export type GetPromoResponse = Promotion;
 
-export interface GetPromoRequest extends RequestQuery<GetPromoQuery>, GetPromoPath {
-  context?: RequestContext;
-}
+export interface GetPromoRequest extends BaseRequest, RequestQuery<GetPromoQuery>, GetPromoPath {}
 
 // PUT /promo/{id} - Update a promotion
 
@@ -295,9 +290,8 @@ export type PutPromoBody = Promotion;
 
 export type PutPromoResponse = Promotion;
 
-export interface PutPromoRequest extends PutPromoPath {
+export interface PutPromoRequest extends BaseRequest, PutPromoPath {
   body: PutPromoBody;
-  context?: RequestContext;
 }
 
 // DELETE /promo/{id} - Delete promotion
@@ -309,9 +303,7 @@ export interface DeletePromoPath {
 
 export type DeletePromoResponse = Success;
 
-export interface DeletePromoRequest extends DeletePromoPath {
-  context?: RequestContext;
-}
+export interface DeletePromoRequest extends BaseRequest, DeletePromoPath {}
 
 // GET /promo/company/{company}/location/group/{location_group} - Get all promotions within company for a location group
 
@@ -331,10 +323,9 @@ export interface GetPromoCompanyLocationGroupQuery {
 export type GetPromoCompanyLocationGroupResponse = Promotions;
 
 export interface GetPromoCompanyLocationGroupRequest
-  extends RequestQuery<GetPromoCompanyLocationGroupQuery>,
-    GetPromoCompanyLocationGroupPath {
-  context?: RequestContext;
-}
+  extends BaseRequest,
+    RequestQuery<GetPromoCompanyLocationGroupQuery>,
+    GetPromoCompanyLocationGroupPath {}
 
 // POST /promo/validate/voucher - Validate a promo voucher
 
@@ -342,9 +333,8 @@ export type PostPromoValidateVoucherBody = VoucherCode;
 
 export type PostPromoValidateVoucherResponse = Voucher;
 
-export interface PostPromoValidateVoucherRequest {
+export interface PostPromoValidateVoucherRequest extends BaseRequest {
   body: PostPromoValidateVoucherBody;
-  context?: RequestContext;
 }
 
 // POST /promo/redeem/voucher - Redeem a promo voucher
@@ -353,9 +343,8 @@ export type PostPromoRedeemVoucherBody = VoucherCode;
 
 export type PostPromoRedeemVoucherResponse = Redemption;
 
-export interface PostPromoRedeemVoucherRequest {
+export interface PostPromoRedeemVoucherRequest extends BaseRequest {
   body: PostPromoRedeemVoucherBody;
-  context?: RequestContext;
 }
 
 // POST /promo/voucher - Create new voucher
@@ -364,9 +353,8 @@ export type PostPromoVoucherBody = CreateVoucher;
 
 export type PostPromoVoucherResponse = Voucher;
 
-export interface PostPromoVoucherRequest {
+export interface PostPromoVoucherRequest extends BaseRequest {
   body: PostPromoVoucherBody;
-  context?: RequestContext;
 }
 
 // PUT /promo/voucher/{id} - Update voucher
@@ -380,9 +368,8 @@ export type PutPromoVoucherBody = UpdateVoucher;
 
 export type PutPromoVoucherResponse = Voucher;
 
-export interface PutPromoVoucherRequest extends PutPromoVoucherPath {
+export interface PutPromoVoucherRequest extends BaseRequest, PutPromoVoucherPath {
   body: PutPromoVoucherBody;
-  context?: RequestContext;
 }
 
 // DELETE /promo/voucher/{id} - Delete voucher
@@ -402,10 +389,9 @@ export interface DeletePromoVoucherResponse {
 }
 
 export interface DeletePromoVoucherRequest
-  extends RequestQuery<DeletePromoVoucherQuery>,
-    DeletePromoVoucherPath {
-  context?: RequestContext;
-}
+  extends BaseRequest,
+    RequestQuery<DeletePromoVoucherQuery>,
+    DeletePromoVoucherPath {}
 
 // POST /promo/customer/ - Add user to voucherify
 
@@ -413,9 +399,8 @@ export type PostPromoCustomerBody = VoucherifyCustomer;
 
 export type PostPromoCustomerResponse = Customer;
 
-export interface PostPromoCustomerRequest {
+export interface PostPromoCustomerRequest extends BaseRequest {
   body: PostPromoCustomerBody;
-  context?: RequestContext;
 }
 
 // DELETE /promo/customer/ - Delete user from voucherify
@@ -430,9 +415,8 @@ export interface DeletePromoCustomerResponse {
   success?: boolean;
 }
 
-export interface DeletePromoCustomerRequest {
+export interface DeletePromoCustomerRequest extends BaseRequest {
   body: DeletePromoCustomerBody;
-  context?: RequestContext;
 }
 
 // POST /promo/voucher/{id}/reverse - Reverse a redemption from a promo voucher
@@ -446,9 +430,8 @@ export type PostPromoVoucherReverseBody = ReverseRedemption;
 
 export type PostPromoVoucherReverseResponse = RedemptionReversal;
 
-export interface PostPromoVoucherReverseRequest extends PostPromoVoucherReversePath {
+export interface PostPromoVoucherReverseRequest extends BaseRequest, PostPromoVoucherReversePath {
   body: PostPromoVoucherReverseBody;
-  context?: RequestContext;
 }
 
 // POST /promo/voucherify/activity/execute - Execute a Journey custom Activity request
@@ -457,15 +440,12 @@ export type PostPromoVoucherifyActivityExecuteBody = string;
 
 export type PostPromoVoucherifyActivityExecuteResponse = Customer;
 
-export interface PostPromoVoucherifyActivityExecuteRequest {
+export interface PostPromoVoucherifyActivityExecuteRequest extends BaseRequest {
   body: PostPromoVoucherifyActivityExecuteBody;
-  context?: RequestContext;
 }
 
 // GET /promo/voucherify/activity/config.json - Get SFMC Journey Custom Activity configuration
 
 export type GetPromoVoucherifyActivityConfigResponse = SFMCConfig;
 
-export interface GetPromoVoucherifyActivityConfigRequest {
-  context?: RequestContext;
-}
+export interface GetPromoVoucherifyActivityConfigRequest extends BaseRequest {}

package/src/interface/report.ts

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