@compassdigital/sdk.typescript 4.35.0 → 4.36.0

package/src/interface/user.ts

@@ -816,3 +816,32 @@ export interface PostUserEmbedurlResponse {
 export interface PostUserEmbedurlRequest extends BaseRequest {
   body: PostUserEmbedurlBody;
 }
+
+// GET /user/profile - Returns user profile with limited information
+
+export interface GetUserProfileQuery {
+  // user's email address
+  email: string;
+  // app realm
+  realm: string;
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetUserProfileResponse {
+  // user
+  id?: string;
+  name?: {
+    first?: string;
+    last?: string;
+  };
+  email?: string;
+  // User phone number
+  phone?: number;
+  date?: {
+    created?: string;
+    modified?: string;
+  };
+}
+
+export interface GetUserProfileRequest extends BaseRequest, RequestQuery<GetUserProfileQuery> {}