@compassdigital/sdk.typescript 3.19.0 → 3.21.0

package/src/interface/user.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;
@@ -227,7 +227,7 @@ export interface GetUserAuthQuery {
 
 export type GetUserAuthResponse = auth;
 
-export interface GetUserAuthRequest extends RequestQuery<GetUserAuthQuery> {}
+export interface GetUserAuthRequest extends BaseRequest, RequestQuery<GetUserAuthQuery> {}
 
 // POST /user/auth - Use refresh token to generate a new access token and refresh token
 
@@ -235,7 +235,7 @@ export type PostUserAuthBody = RefreshToken;
 
 export type PostUserAuthResponse = auth;
 
-export interface PostUserAuthRequest {
+export interface PostUserAuthRequest extends BaseRequest {
   body: PostUserAuthBody;
 }
 
@@ -245,7 +245,7 @@ export interface GetUserZendeskResponse {
   token: string;
 }
 
-export type GetUserZendeskRequest = {};
+export interface GetUserZendeskRequest extends BaseRequest {}
 
 // POST /user - Create an User
 
@@ -258,7 +258,7 @@ export type PostUserBody = User;
 
 export type PostUserResponse = User;
 
-export interface PostUserRequest extends RequestQuery<PostUserQuery> {
+export interface PostUserRequest extends BaseRequest, RequestQuery<PostUserQuery> {
   body: PostUserBody;
 }
 
@@ -276,7 +276,7 @@ export interface GetUserQuery {
 
 export type GetUserResponse = User;
 
-export interface GetUserRequest extends RequestQuery<GetUserQuery>, GetUserPath {}
+export interface GetUserRequest extends BaseRequest, RequestQuery<GetUserQuery>, GetUserPath {}
 
 // PUT /user/{id} - Update an individual user
 
@@ -294,7 +294,7 @@ export type PutUserBody = User;
 
 export type PutUserResponse = User;
 
-export interface PutUserRequest extends RequestQuery<PutUserQuery>, PutUserPath {
+export interface PutUserRequest extends BaseRequest, RequestQuery<PutUserQuery>, PutUserPath {
   body: PutUserBody;
 }
 
@@ -314,7 +314,7 @@ export type PatchUserBody = User;
 
 export type PatchUserResponse = User;
 
-export interface PatchUserRequest extends RequestQuery<PatchUserQuery>, PatchUserPath {
+export interface PatchUserRequest extends BaseRequest, RequestQuery<PatchUserQuery>, PatchUserPath {
   body: PatchUserBody;
 }
 
@@ -332,7 +332,10 @@ export interface DeleteUserQuery {
 
 export type DeleteUserResponse = success;
 
-export interface DeleteUserRequest extends RequestQuery<DeleteUserQuery>, DeleteUserPath {}
+export interface DeleteUserRequest
+  extends BaseRequest,
+    RequestQuery<DeleteUserQuery>,
+    DeleteUserPath {}
 
 // POST /user/device/auth - Endpoint for generating/retrieving KDS device token
 
@@ -340,7 +343,7 @@ export type PostUserKdsTokenBody = UserDeviceAuthBody;
 
 export type PostUserKdsTokenResponse = KDSToken;
 
-export interface PostUserKdsTokenRequest {
+export interface PostUserKdsTokenRequest extends BaseRequest {
   body: PostUserKdsTokenBody;
 }
 
@@ -352,7 +355,7 @@ export interface GetUserKdsTokenQuery {
 
 export type GetUserKdsTokenResponse = KDSDevices;
 
-export interface GetUserKdsTokenRequest extends RequestQuery<GetUserKdsTokenQuery> {}
+export interface GetUserKdsTokenRequest extends BaseRequest, RequestQuery<GetUserKdsTokenQuery> {}
 
 // DELETE /user/device/auth/{device_id} - Endpoint for deleting a device by specified device_id
 
@@ -363,7 +366,7 @@ export interface DeleteUserDeviceAuthPath {
 
 export type DeleteUserDeviceAuthResponse = Error;
 
-export interface DeleteUserDeviceAuthRequest extends DeleteUserDeviceAuthPath {}
+export interface DeleteUserDeviceAuthRequest extends BaseRequest, DeleteUserDeviceAuthPath {}
 
 // PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
 
@@ -374,7 +377,7 @@ export interface PatchUserAuthKdsPath {
 
 export type PatchUserAuthKdsResponse = KDSDevice;
 
-export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {}
+export interface PatchUserAuthKdsRequest extends BaseRequest, PatchUserAuthKdsPath {}
 
 // POST /user/{id}/changepassword - Change the users password
 
@@ -387,7 +390,7 @@ export type PostUserChangePasswordBody = Changepassword;
 
 export type PostUserChangePasswordResponse = User;
 
-export interface PostUserChangePasswordRequest extends PostUserChangePasswordPath {
+export interface PostUserChangePasswordRequest extends BaseRequest, PostUserChangePasswordPath {
   body: PostUserChangePasswordBody;
 }
 
@@ -395,7 +398,7 @@ export interface PostUserChangePasswordRequest extends PostUserChangePasswordPat
 
 export type DeleteUserLogoutResponse = success;
 
-export type DeleteUserLogoutRequest = {};
+export interface DeleteUserLogoutRequest extends BaseRequest {}
 
 // POST /user/{id}/secret/{key} - Add a secret key
 
@@ -409,7 +412,7 @@ export type PostUserAddSecretBody = any;
 
 export type PostUserAddSecretResponse = Key;
 
-export interface PostUserAddSecretRequest extends PostUserAddSecretPath {
+export interface PostUserAddSecretRequest extends BaseRequest, PostUserAddSecretPath {
   body: PostUserAddSecretBody;
 }
 
@@ -425,7 +428,7 @@ export interface GetUserSecretResponse {
   [index: string]: any;
 }
 
-export interface GetUserSecretRequest extends GetUserSecretPath {}
+export interface GetUserSecretRequest extends BaseRequest, GetUserSecretPath {}
 
 // POST /user/forgotpassword - Reset the users password
 
@@ -440,7 +443,9 @@ export type PostUserResetPasswordBody = Forgotpassword;
 
 export type PostUserResetPasswordResponse = success;
 
-export interface PostUserResetPasswordRequest extends RequestQuery<PostUserResetPasswordQuery> {
+export interface PostUserResetPasswordRequest
+  extends BaseRequest,
+    RequestQuery<PostUserResetPasswordQuery> {
   body: PostUserResetPasswordBody;
 }
 
@@ -461,7 +466,8 @@ export type PostUserResetPasswordTokenBody = Resetpassword;
 export type PostUserResetPasswordTokenResponse = success;
 
 export interface PostUserResetPasswordTokenRequest
-  extends RequestQuery<PostUserResetPasswordTokenQuery>,
+  extends BaseRequest,
+    RequestQuery<PostUserResetPasswordTokenQuery>,
     PostUserResetPasswordTokenPath {
   body: PostUserResetPasswordTokenBody;
 }
@@ -485,7 +491,8 @@ export interface GetUserRealmUsersQuery {
 export type GetUserRealmUsersResponse = Users;
 
 export interface GetUserRealmUsersRequest
-  extends RequestQuery<GetUserRealmUsersQuery>,
+  extends BaseRequest,
+    RequestQuery<GetUserRealmUsersQuery>,
     GetUserRealmUsersPath {}
 
 // GET /user/{id}/permissions - Get user permissions
@@ -503,7 +510,8 @@ export interface GetUserPermissionsQuery {
 export type GetUserPermissionsResponse = User;
 
 export interface GetUserPermissionsRequest
-  extends RequestQuery<GetUserPermissionsQuery>,
+  extends BaseRequest,
+    RequestQuery<GetUserPermissionsQuery>,
     GetUserPermissionsPath {}
 
 // PUT /user/{id}/permissions - Update user permissions
@@ -525,7 +533,8 @@ export interface PutUserPermissionsBody {
 export type PutUserPermissionsResponse = User;
 
 export interface PutUserPermissionsRequest
-  extends RequestQuery<PutUserPermissionsQuery>,
+  extends BaseRequest,
+    RequestQuery<PutUserPermissionsQuery>,
     PutUserPermissionsPath {
   body: PutUserPermissionsBody;
 }
@@ -541,7 +550,7 @@ export type PostUserCheckInBody = CheckInUserInfo;
 
 export type PostUserCheckInResponse = Checkin;
 
-export interface PostUserCheckInRequest extends PostUserCheckInPath {
+export interface PostUserCheckInRequest extends BaseRequest, PostUserCheckInPath {
   body: PostUserCheckInBody;
 }
 
@@ -558,7 +567,7 @@ export type PatchUserCheckinBody = PatchCheckin;
 
 export type PatchUserCheckinResponse = Checkin;
 
-export interface PatchUserCheckinRequest extends PatchUserCheckinPath {
+export interface PatchUserCheckinRequest extends BaseRequest, PatchUserCheckinPath {
   body: PatchUserCheckinBody;
 }
 
@@ -573,7 +582,9 @@ export interface GetUserSearchCheckInQuery {
 
 export type GetUserSearchCheckInResponse = Checkin;
 
-export interface GetUserSearchCheckInRequest extends RequestQuery<GetUserSearchCheckInQuery> {}
+export interface GetUserSearchCheckInRequest
+  extends BaseRequest,
+    RequestQuery<GetUserSearchCheckInQuery> {}
 
 // POST /user/{id}/verification - Send email verification to user
 
@@ -584,7 +595,9 @@ export interface PostUserSendEmailVerificationPath {
 
 export type PostUserSendEmailVerificationResponse = success;
 
-export interface PostUserSendEmailVerificationRequest extends PostUserSendEmailVerificationPath {}
+export interface PostUserSendEmailVerificationRequest
+  extends BaseRequest,
+    PostUserSendEmailVerificationPath {}
 
 // PUT /user/{id}/verification/confirm - Verify a users email
 
@@ -597,7 +610,7 @@ export type PutUserVerifyUserEmailBody = VerifyEmail;
 
 export type PutUserVerifyUserEmailResponse = success;
 
-export interface PutUserVerifyUserEmailRequest extends PutUserVerifyUserEmailPath {
+export interface PutUserVerifyUserEmailRequest extends BaseRequest, PutUserVerifyUserEmailPath {
   body: PutUserVerifyUserEmailBody;
 }
 
@@ -620,7 +633,8 @@ export interface PostUserVerificationPhoneBody {
 export type PostUserVerificationPhoneResponse = success;
 
 export interface PostUserVerificationPhoneRequest
-  extends RequestQuery<PostUserVerificationPhoneQuery>,
+  extends BaseRequest,
+    RequestQuery<PostUserVerificationPhoneQuery>,
     PostUserVerificationPhonePath {
   body: PostUserVerificationPhoneBody;
 }
@@ -639,6 +653,6 @@ export interface PutUserVerificationPhoneBody {
 
 export type PutUserVerificationPhoneResponse = success;
 
-export interface PutUserVerificationPhoneRequest extends PutUserVerificationPhonePath {
+export interface PutUserVerificationPhoneRequest extends BaseRequest, PutUserVerificationPhonePath {
   body: PutUserVerificationPhoneBody;
 }

package/src/interface/util.ts

@@ -2,5 +2,26 @@
  * Convert number query parameters to string.
  */
 export type RequestQuery<T extends object> = {
-	[K in keyof T]: T[K] extends number|undefined ? string : T[K];
+  [K in keyof T]: T[K] extends number|undefined ? string : T[K];
+}
+
+/**
+ * Provider request context.
+ */
+export interface RequestContext {
+  subject: string;
+  user_id: string;
+  expiry: Date | null;
+  iat: Date;
+  scopes: string;
+  sub: string;
+  domain?: string;
+}
+
+/**
+ *  All requests implement this interface.
+ */
+export interface BaseRequest {
+  context?: RequestContext;
+  headers?: Record<string, string>;
 }

package/src/interface/vendor.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;
@@ -202,7 +202,7 @@ export type PostVendorApplicationBody = ApplicationPostBody;
 
 export type PostVendorApplicationResponse = Application;
 
-export interface PostVendorApplicationRequest {
+export interface PostVendorApplicationRequest extends BaseRequest {
   body: PostVendorApplicationBody;
 }
 
@@ -216,7 +216,9 @@ export interface GetVendorApplicationQuery {
 
 export type GetVendorApplicationResponse = Applications;
 
-export interface GetVendorApplicationRequest extends RequestQuery<GetVendorApplicationQuery> {}
+export interface GetVendorApplicationRequest
+  extends BaseRequest,
+    RequestQuery<GetVendorApplicationQuery> {}
 
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
@@ -229,7 +231,7 @@ export type PatchVendorApplicationBody = ApplicationPatchBody;
 
 export type PatchVendorApplicationResponse = Application;
 
-export interface PatchVendorApplicationRequest extends PatchVendorApplicationPath {
+export interface PatchVendorApplicationRequest extends BaseRequest, PatchVendorApplicationPath {
   body: PatchVendorApplicationBody;
 }
 
@@ -239,7 +241,7 @@ export type PostVendorBody = VendorPostBody;
 
 export type PostVendorResponse = Vendor;
 
-export interface PostVendorRequest {
+export interface PostVendorRequest extends BaseRequest {
   body: PostVendorBody;
 }
 
@@ -247,7 +249,7 @@ export interface PostVendorRequest {
 
 export type GetVendorsResponse = Vendors;
 
-export type GetVendorsRequest = {};
+export interface GetVendorsRequest extends BaseRequest {}
 
 // GET /vendor/{id} - Get info about the Vendor
 
@@ -258,7 +260,7 @@ export interface GetVendorPath {
 
 export type GetVendorResponse = Vendor;
 
-export interface GetVendorRequest extends GetVendorPath {}
+export interface GetVendorRequest extends BaseRequest, GetVendorPath {}
 
 // PATCH /vendor/{id} - Update info about the Vendor
 
@@ -271,7 +273,7 @@ export type PatchVendorBody = Vendor;
 
 export type PatchVendorResponse = Vendor;
 
-export interface PatchVendorRequest extends PatchVendorPath {
+export interface PatchVendorRequest extends BaseRequest, PatchVendorPath {
   body: PatchVendorBody;
 }
 
@@ -279,7 +281,7 @@ export interface PatchVendorRequest extends PatchVendorPath {
 
 export type GetVendorAuthResponse = Auth;
 
-export type GetVendorAuthRequest = {};
+export interface GetVendorAuthRequest extends BaseRequest {}
 
 // POST /vendor/auth - Get new access token using refresh token and previous token
 
@@ -287,7 +289,7 @@ export type PostVendorAuthBody = RefreshPayload;
 
 export type PostVendorAuthResponse = Auth;
 
-export interface PostVendorAuthRequest {
+export interface PostVendorAuthRequest extends BaseRequest {
   body: PostVendorAuthBody;
 }
 
@@ -300,7 +302,7 @@ export interface GetVendorKeysPath {
 
 export type GetVendorKeysResponse = Keys;
 
-export interface GetVendorKeysRequest extends GetVendorKeysPath {}
+export interface GetVendorKeysRequest extends BaseRequest, GetVendorKeysPath {}
 
 // POST /vendor/{id}/key - Create new key for the vendor
 
@@ -313,7 +315,7 @@ export type PostVendorKeyBody = KeyPostBody;
 
 export type PostVendorKeyResponse = Key;
 
-export interface PostVendorKeyRequest extends PostVendorKeyPath {
+export interface PostVendorKeyRequest extends BaseRequest, PostVendorKeyPath {
   body: PostVendorKeyBody;
 }
 
@@ -333,7 +335,10 @@ export interface GetVendorKeyQuery {
 
 export type GetVendorKeyResponse = Key;
 
-export interface GetVendorKeyRequest extends RequestQuery<GetVendorKeyQuery>, GetVendorKeyPath {}
+export interface GetVendorKeyRequest
+  extends BaseRequest,
+    RequestQuery<GetVendorKeyQuery>,
+    GetVendorKeyPath {}
 
 // PATCH /vendor/{id}/key/{key} - Update info for vendor key
 
@@ -348,7 +353,7 @@ export type PatchVendorKeyBody = KeyPatchBody;
 
 export type PatchVendorKeyResponse = Key;
 
-export interface PatchVendorKeyRequest extends PatchVendorKeyPath {
+export interface PatchVendorKeyRequest extends BaseRequest, PatchVendorKeyPath {
   body: PatchVendorKeyBody;
 }
 
@@ -363,7 +368,7 @@ export interface DeleteVendorKeyPath {
 
 export type DeleteVendorKeyResponse = Key;
 
-export interface DeleteVendorKeyRequest extends DeleteVendorKeyPath {}
+export interface DeleteVendorKeyRequest extends BaseRequest, DeleteVendorKeyPath {}
 
 // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
 
@@ -381,7 +386,8 @@ export interface PostVendorKeyRotateQuery {
 export type PostVendorKeyRotateResponse = Success;
 
 export interface PostVendorKeyRotateRequest
-  extends RequestQuery<PostVendorKeyRotateQuery>,
+  extends BaseRequest,
+    RequestQuery<PostVendorKeyRotateQuery>,
     PostVendorKeyRotatePath {}
 
 // POST /vendor/{id}/reset/password - Reset the existing password for vendor
@@ -395,6 +401,6 @@ export type PostVendorResetPasswordBody = ResetPassword;
 
 export type PostVendorResetPasswordResponse = Success;
 
-export interface PostVendorResetPasswordRequest extends PostVendorResetPasswordPath {
+export interface PostVendorResetPasswordRequest extends BaseRequest, PostVendorResetPasswordPath {
   body: PostVendorResetPasswordBody;
 }