@compassdigital/sdk.typescript 4.108.0 → 4.109.0

package/src/interface/user.ts

@@ -322,6 +322,11 @@ export interface UserMeta {
 	[index: string]: any;
 }
 
+export interface Pagination {
+	last_key?: string;
+	count?: number;
+}
+
 // GET /user/auth - Gets the JWT token for a user
 
 export interface GetUserAuthQuery {
@@ -645,17 +650,24 @@ export interface GetUserRealmUsersPath {
 }
 
 export interface GetUserRealmUsersQuery {
-	// Max number of records to return. Defaults to 100
+	// Max number of records to return. Defaults to 100. Max 10,000.
 	max?: number;
 	// Last modified date greater than this parameter
 	lastmodified_start?: string;
 	// Use ACL permission system
 	acl?: boolean;
+	// If true, the response will include pagination metadata
+	paginate?: boolean;
+	// The last key from the previous response for pagination
+	last_key?: string;
 	// Graphql query string
 	_query?: string;
 }
 
-export type GetUserRealmUsersResponse = Users;
+export interface GetUserRealmUsersResponse {
+	users?: User[];
+	meta?: Pagination;
+}
 
 export interface GetUserRealmUsersRequest
 	extends BaseRequest,