@compassdigital/sdk.typescript 3.19.0 → 3.20.0

package/src/interface/user.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;
@@ -227,7 +227,9 @@ export interface GetUserAuthQuery {
 
 export type GetUserAuthResponse = auth;
 
-export interface GetUserAuthRequest extends RequestQuery<GetUserAuthQuery> {}
+export interface GetUserAuthRequest extends RequestQuery<GetUserAuthQuery> {
+  context?: RequestContext;
+}
 
 // POST /user/auth - Use refresh token to generate a new access token and refresh token
 
@@ -237,6 +239,7 @@ export type PostUserAuthResponse = auth;
 
 export interface PostUserAuthRequest {
   body: PostUserAuthBody;
+  context?: RequestContext;
 }
 
 // GET /user/zendesk - Get zendesk JWT token to allow web widget to search restricted articles
@@ -245,7 +248,9 @@ export interface GetUserZendeskResponse {
   token: string;
 }
 
-export type GetUserZendeskRequest = {};
+export interface GetUserZendeskRequest {
+  context?: RequestContext;
+}
 
 // POST /user - Create an User
 
@@ -260,6 +265,7 @@ export type PostUserResponse = User;
 
 export interface PostUserRequest extends RequestQuery<PostUserQuery> {
   body: PostUserBody;
+  context?: RequestContext;
 }
 
 // GET /user/{id} - Get an individual user
@@ -276,7 +282,9 @@ export interface GetUserQuery {
 
 export type GetUserResponse = User;
 
-export interface GetUserRequest extends RequestQuery<GetUserQuery>, GetUserPath {}
+export interface GetUserRequest extends RequestQuery<GetUserQuery>, GetUserPath {
+  context?: RequestContext;
+}
 
 // PUT /user/{id} - Update an individual user
 
@@ -296,6 +304,7 @@ export type PutUserResponse = User;
 
 export interface PutUserRequest extends RequestQuery<PutUserQuery>, PutUserPath {
   body: PutUserBody;
+  context?: RequestContext;
 }
 
 // PATCH /user/{id} - Update an individual user
@@ -316,6 +325,7 @@ export type PatchUserResponse = User;
 
 export interface PatchUserRequest extends RequestQuery<PatchUserQuery>, PatchUserPath {
   body: PatchUserBody;
+  context?: RequestContext;
 }
 
 // DELETE /user/{id} - delete an individual user
@@ -332,7 +342,9 @@ export interface DeleteUserQuery {
 
 export type DeleteUserResponse = success;
 
-export interface DeleteUserRequest extends RequestQuery<DeleteUserQuery>, DeleteUserPath {}
+export interface DeleteUserRequest extends RequestQuery<DeleteUserQuery>, DeleteUserPath {
+  context?: RequestContext;
+}
 
 // POST /user/device/auth - Endpoint for generating/retrieving KDS device token
 
@@ -342,6 +354,7 @@ export type PostUserKdsTokenResponse = KDSToken;
 
 export interface PostUserKdsTokenRequest {
   body: PostUserKdsTokenBody;
+  context?: RequestContext;
 }
 
 // GET /user/device/auth - Endpoint retrieving KDS device token
@@ -352,7 +365,9 @@ export interface GetUserKdsTokenQuery {
 
 export type GetUserKdsTokenResponse = KDSDevices;
 
-export interface GetUserKdsTokenRequest extends RequestQuery<GetUserKdsTokenQuery> {}
+export interface GetUserKdsTokenRequest extends RequestQuery<GetUserKdsTokenQuery> {
+  context?: RequestContext;
+}
 
 // DELETE /user/device/auth/{device_id} - Endpoint for deleting a device by specified device_id
 
@@ -363,7 +378,9 @@ export interface DeleteUserDeviceAuthPath {
 
 export type DeleteUserDeviceAuthResponse = Error;
 
-export interface DeleteUserDeviceAuthRequest extends DeleteUserDeviceAuthPath {}
+export interface DeleteUserDeviceAuthRequest extends DeleteUserDeviceAuthPath {
+  context?: RequestContext;
+}
 
 // PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
 
@@ -374,7 +391,9 @@ export interface PatchUserAuthKdsPath {
 
 export type PatchUserAuthKdsResponse = KDSDevice;
 
-export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {}
+export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {
+  context?: RequestContext;
+}
 
 // POST /user/{id}/changepassword - Change the users password
 
@@ -389,13 +408,16 @@ export type PostUserChangePasswordResponse = User;
 
 export interface PostUserChangePasswordRequest extends PostUserChangePasswordPath {
   body: PostUserChangePasswordBody;
+  context?: RequestContext;
 }
 
 // DELETE /user/logout - Logs out current user
 
 export type DeleteUserLogoutResponse = success;
 
-export type DeleteUserLogoutRequest = {};
+export interface DeleteUserLogoutRequest {
+  context?: RequestContext;
+}
 
 // POST /user/{id}/secret/{key} - Add a secret key
 
@@ -411,6 +433,7 @@ export type PostUserAddSecretResponse = Key;
 
 export interface PostUserAddSecretRequest extends PostUserAddSecretPath {
   body: PostUserAddSecretBody;
+  context?: RequestContext;
 }
 
 // GET /user/{id}/secret/{key} - Get back a secret key
@@ -425,7 +448,9 @@ export interface GetUserSecretResponse {
   [index: string]: any;
 }
 
-export interface GetUserSecretRequest extends GetUserSecretPath {}
+export interface GetUserSecretRequest extends GetUserSecretPath {
+  context?: RequestContext;
+}
 
 // POST /user/forgotpassword - Reset the users password
 
@@ -442,6 +467,7 @@ export type PostUserResetPasswordResponse = success;
 
 export interface PostUserResetPasswordRequest extends RequestQuery<PostUserResetPasswordQuery> {
   body: PostUserResetPasswordBody;
+  context?: RequestContext;
 }
 
 // POST /user/{id}/resetpassword - Reset the users password using a reset token
@@ -464,6 +490,7 @@ export interface PostUserResetPasswordTokenRequest
   extends RequestQuery<PostUserResetPasswordTokenQuery>,
     PostUserResetPasswordTokenPath {
   body: PostUserResetPasswordTokenBody;
+  context?: RequestContext;
 }
 
 // GET /user/realm/{realm} - Get all the users in a realm
@@ -486,7 +513,9 @@ export type GetUserRealmUsersResponse = Users;
 
 export interface GetUserRealmUsersRequest
   extends RequestQuery<GetUserRealmUsersQuery>,
-    GetUserRealmUsersPath {}
+    GetUserRealmUsersPath {
+  context?: RequestContext;
+}
 
 // GET /user/{id}/permissions - Get user permissions
 
@@ -504,7 +533,9 @@ export type GetUserPermissionsResponse = User;
 
 export interface GetUserPermissionsRequest
   extends RequestQuery<GetUserPermissionsQuery>,
-    GetUserPermissionsPath {}
+    GetUserPermissionsPath {
+  context?: RequestContext;
+}
 
 // PUT /user/{id}/permissions - Update user permissions
 
@@ -528,6 +559,7 @@ export interface PutUserPermissionsRequest
   extends RequestQuery<PutUserPermissionsQuery>,
     PutUserPermissionsPath {
   body: PutUserPermissionsBody;
+  context?: RequestContext;
 }
 
 // POST /user/{id}/checkin - Create check-in for user
@@ -543,6 +575,7 @@ export type PostUserCheckInResponse = Checkin;
 
 export interface PostUserCheckInRequest extends PostUserCheckInPath {
   body: PostUserCheckInBody;
+  context?: RequestContext;
 }
 
 // PATCH /user/{id}/checkin/{checkin_id} - Update check-in
@@ -560,6 +593,7 @@ export type PatchUserCheckinResponse = Checkin;
 
 export interface PatchUserCheckinRequest extends PatchUserCheckinPath {
   body: PatchUserCheckinBody;
+  context?: RequestContext;
 }
 
 // GET /user/checkin/search - Search check-in
@@ -573,7 +607,9 @@ export interface GetUserSearchCheckInQuery {
 
 export type GetUserSearchCheckInResponse = Checkin;
 
-export interface GetUserSearchCheckInRequest extends RequestQuery<GetUserSearchCheckInQuery> {}
+export interface GetUserSearchCheckInRequest extends RequestQuery<GetUserSearchCheckInQuery> {
+  context?: RequestContext;
+}
 
 // POST /user/{id}/verification - Send email verification to user
 
@@ -584,7 +620,9 @@ export interface PostUserSendEmailVerificationPath {
 
 export type PostUserSendEmailVerificationResponse = success;
 
-export interface PostUserSendEmailVerificationRequest extends PostUserSendEmailVerificationPath {}
+export interface PostUserSendEmailVerificationRequest extends PostUserSendEmailVerificationPath {
+  context?: RequestContext;
+}
 
 // PUT /user/{id}/verification/confirm - Verify a users email
 
@@ -599,6 +637,7 @@ export type PutUserVerifyUserEmailResponse = success;
 
 export interface PutUserVerifyUserEmailRequest extends PutUserVerifyUserEmailPath {
   body: PutUserVerifyUserEmailBody;
+  context?: RequestContext;
 }
 
 // POST /user/{id}/verification/phone - Send phone verification to user
@@ -623,6 +662,7 @@ export interface PostUserVerificationPhoneRequest
   extends RequestQuery<PostUserVerificationPhoneQuery>,
     PostUserVerificationPhonePath {
   body: PostUserVerificationPhoneBody;
+  context?: RequestContext;
 }
 
 // PUT /user/{id}/verification/phone - Attempt phone verification for user
@@ -641,4 +681,5 @@ export type PutUserVerificationPhoneResponse = success;
 
 export interface PutUserVerificationPhoneRequest extends PutUserVerificationPhonePath {
   body: PutUserVerificationPhoneBody;
+  context?: RequestContext;
 }

package/src/interface/util.ts

@@ -2,5 +2,18 @@
  * 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;
 }

package/src/interface/vendor.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;
@@ -204,6 +204,7 @@ export type PostVendorApplicationResponse = Application;
 
 export interface PostVendorApplicationRequest {
   body: PostVendorApplicationBody;
+  context?: RequestContext;
 }
 
 // GET /vendor/application - Get a list of all applications
@@ -216,7 +217,9 @@ export interface GetVendorApplicationQuery {
 
 export type GetVendorApplicationResponse = Applications;
 
-export interface GetVendorApplicationRequest extends RequestQuery<GetVendorApplicationQuery> {}
+export interface GetVendorApplicationRequest extends RequestQuery<GetVendorApplicationQuery> {
+  context?: RequestContext;
+}
 
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
@@ -231,6 +234,7 @@ export type PatchVendorApplicationResponse = Application;
 
 export interface PatchVendorApplicationRequest extends PatchVendorApplicationPath {
   body: PatchVendorApplicationBody;
+  context?: RequestContext;
 }
 
 // POST /vendor - Create new vendor
@@ -241,13 +245,16 @@ export type PostVendorResponse = Vendor;
 
 export interface PostVendorRequest {
   body: PostVendorBody;
+  context?: RequestContext;
 }
 
 // GET /vendor - Get all Vendors
 
 export type GetVendorsResponse = Vendors;
 
-export type GetVendorsRequest = {};
+export interface GetVendorsRequest {
+  context?: RequestContext;
+}
 
 // GET /vendor/{id} - Get info about the Vendor
 
@@ -258,7 +265,9 @@ export interface GetVendorPath {
 
 export type GetVendorResponse = Vendor;
 
-export interface GetVendorRequest extends GetVendorPath {}
+export interface GetVendorRequest extends GetVendorPath {
+  context?: RequestContext;
+}
 
 // PATCH /vendor/{id} - Update info about the Vendor
 
@@ -273,13 +282,16 @@ export type PatchVendorResponse = Vendor;
 
 export interface PatchVendorRequest extends PatchVendorPath {
   body: PatchVendorBody;
+  context?: RequestContext;
 }
 
 // GET /vendor/auth - Get access/refresh tokens for accessing our APIs
 
 export type GetVendorAuthResponse = Auth;
 
-export type GetVendorAuthRequest = {};
+export interface GetVendorAuthRequest {
+  context?: RequestContext;
+}
 
 // POST /vendor/auth - Get new access token using refresh token and previous token
 
@@ -289,6 +301,7 @@ export type PostVendorAuthResponse = Auth;
 
 export interface PostVendorAuthRequest {
   body: PostVendorAuthBody;
+  context?: RequestContext;
 }
 
 // GET /vendor/{id}/key - Get list of Vendor keys
@@ -300,7 +313,9 @@ export interface GetVendorKeysPath {
 
 export type GetVendorKeysResponse = Keys;
 
-export interface GetVendorKeysRequest extends GetVendorKeysPath {}
+export interface GetVendorKeysRequest extends GetVendorKeysPath {
+  context?: RequestContext;
+}
 
 // POST /vendor/{id}/key - Create new key for the vendor
 
@@ -315,6 +330,7 @@ export type PostVendorKeyResponse = Key;
 
 export interface PostVendorKeyRequest extends PostVendorKeyPath {
   body: PostVendorKeyBody;
+  context?: RequestContext;
 }
 
 // GET /vendor/{id}/key/{key} - Get info about vendor key
@@ -333,7 +349,9 @@ export interface GetVendorKeyQuery {
 
 export type GetVendorKeyResponse = Key;
 
-export interface GetVendorKeyRequest extends RequestQuery<GetVendorKeyQuery>, GetVendorKeyPath {}
+export interface GetVendorKeyRequest extends RequestQuery<GetVendorKeyQuery>, GetVendorKeyPath {
+  context?: RequestContext;
+}
 
 // PATCH /vendor/{id}/key/{key} - Update info for vendor key
 
@@ -350,6 +368,7 @@ export type PatchVendorKeyResponse = Key;
 
 export interface PatchVendorKeyRequest extends PatchVendorKeyPath {
   body: PatchVendorKeyBody;
+  context?: RequestContext;
 }
 
 // DELETE /vendor/{id}/key/{key} - Mark key as expired
@@ -363,7 +382,9 @@ export interface DeleteVendorKeyPath {
 
 export type DeleteVendorKeyResponse = Key;
 
-export interface DeleteVendorKeyRequest extends DeleteVendorKeyPath {}
+export interface DeleteVendorKeyRequest extends DeleteVendorKeyPath {
+  context?: RequestContext;
+}
 
 // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
 
@@ -382,7 +403,9 @@ export type PostVendorKeyRotateResponse = Success;
 
 export interface PostVendorKeyRotateRequest
   extends RequestQuery<PostVendorKeyRotateQuery>,
-    PostVendorKeyRotatePath {}
+    PostVendorKeyRotatePath {
+  context?: RequestContext;
+}
 
 // POST /vendor/{id}/reset/password - Reset the existing password for vendor
 
@@ -397,4 +420,5 @@ export type PostVendorResetPasswordResponse = Success;
 
 export interface PostVendorResetPasswordRequest extends PostVendorResetPasswordPath {
   body: PostVendorResetPasswordBody;
+  context?: RequestContext;
 }