From 2a89db7444bf6dec260d4f3952bbbc1670678539 Mon Sep 17 00:00:00 2001 From: jbreckmckye Date: Wed, 20 Jun 2018 10:47:09 +0100 Subject: [PATCH] Add paged user search interface to Node-Auth0 --- types/auth0/index.d.ts | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/types/auth0/index.d.ts b/types/auth0/index.d.ts index be87ceed2c..d39fc6e49b 100644 --- a/types/auth0/index.d.ts +++ b/types/auth0/index.d.ts @@ -68,7 +68,6 @@ export interface UpdateUserData extends UserData { export interface GetUsersData { per_page?: number; page?: number; - include_totals?: boolean; sort?: string; connection?: string; fields?: string; @@ -77,6 +76,10 @@ export interface GetUsersData { search_engine?: string; } +export interface GetUsersDataPaged extends GetUsersData { + include_totals: boolean; +} + export interface Rule { /** * The name of the rule. @@ -345,6 +348,17 @@ export interface User { family_name?: string; } +export interface Page { + start: number; + limit: number; + length: number; + total: number; +} + +export interface UserPage extends Page { + users: User[] +} + export interface Identity { connection: string; user_id: string; @@ -353,7 +367,7 @@ export interface Identity { access_token?: string; profileData?: { email?: string; - email_verified?: boolean; + email_verified?: boolean; name?: string; phone_number?: string; phone_verified?: boolean; @@ -662,7 +676,7 @@ export class ManagementClient { deleteClient(params: ClientParams): Promise; deleteClient(params: ClientParams, cb: (err: Error) => void): void; - + // Client Grants getClientGrants(): Promise; getClientGrants(cb: (err: Error, data: ClientGrant[]) => void): void; @@ -706,6 +720,8 @@ export class ManagementClient { // Users + getUsers(params: GetUsersDataPaged): Promise; + getUsers(params: GetUsersDataPaged, cb: (err: Error, userPage: UserPage) => void): void; getUsers(params?: GetUsersData): Promise; getUsers(cb: (err: Error, users: User[]) => void): void; getUsers(params?: GetUsersData, cb?: (err: Error, users: User[]) => void): void;