Merge pull request #12797 from MichalPodeszwa/types-2.0

Add updating user methods to Auth0

auth0/auth0-tests.ts

@@ -49,3 +49,30 @@ auth
   }).catch((err) => {
     // Handle the error.
   });
+
+
+// Update a user
+management
+  .updateUser({id: "user_id"}, {"email": "hi@me.co"});
+
+// Update a user using callback
+management
+  .updateUser({id: "user_id"}, {"email": "hi@me.co"}, (err: Error, users: auth0.User) => {});
+
+
+// Update user metadata
+management
+  .updateUserMetadata({id: "user_id"}, {"key": "value"});
+
+// Update user metadata using callback
+management
+  .updateUserMetadata({id: "user_id"}, {"key": "value"}, (err: Error, users: auth0.User) => {});
+
+
+// Update app metadata
+management
+  .updateAppMetadata({id: "user_id"}, {"key": "value"});
+
+// Update app metadata using callback
+management
+  .updateAppMetadata({id: "user_id"}, {"key": "value"}, (err: Error, users: auth0.User) => {});

auth0/index.d.ts

@@ -10,15 +10,18 @@ export interface ManagementClientOptions {
   domain?: string;
 }
 
+export type UserMetadata = {};
+export type AppMetadata = {};
+
 export interface UserData {
   connection: string;
   email?: string;
   username?: string;
   password?: string;
   phone_number?: string;
-  user_metadata?: {};
+  user_metadata?: UserMetadata;
   email_verified?: boolean;
-  app_metadata?: {};
+  app_metadata?: AppMetadata;
 }
 
 export interface GetUsersData {
@@ -43,8 +46,8 @@ export interface User {
   created_at?: string;
   updated_at?: string;
   identities?: Identity[];
-  app_metadata?: {};
-  user_metadata?: {};
+  app_metadata?: AppMetadata;
+  user_metadata?: UserMetadata;
   picture?: string;
   name?: string;
   nickname?: string;
@@ -53,6 +56,8 @@ export interface User {
   last_login?: string;
   logins_count?: number;
   blocked?: boolean;
+  given_name?: string;
+  family_name?: string;
 }
 
 export interface Identity {
@@ -62,6 +67,10 @@ export interface Identity {
   isSocial: boolean;
 }
 
+export interface UpdateUserParameters {
+  id: string;
+}
+
 export class ManagementClient {
   constructor(options: ManagementClientOptions);
 
@@ -69,6 +78,12 @@ export class ManagementClient {
   getUsers(params?: GetUsersData, cb?: (err: Error, users: User[]) => void): void;
   createUser(data: UserData): Promise<User>;
   createUser(data: UserData, cb: (err: Error, data: User) => void): void;
+  updateUser(params: UpdateUserParameters, data: User): Promise<User>;
+  updateUser(params: UpdateUserParameters, data: User, cb: (err: Error, data: User) => void): void;
+  updateUserMetadata(params: UpdateUserParameters, data: UserMetadata): Promise<User>;
+  updateUserMetadata(params: UpdateUserParameters, data: UserMetadata, cb: (err: Error, data: User) => void): void
+  updateAppMetadata(params: UpdateUserParameters, data: AppMetadata): Promise<User>;
+  updateAppMetadata(params: UpdateUserParameters, data: AppMetadata, cb: (err: Error, data: User) => void): void
 }
 
 export interface AuthenticationClientOptions {
@@ -86,4 +101,4 @@ export class AuthenticationClient {
 
   requestChangePasswordEmail(data: RequestChangePasswordEmailData): Promise<string>;
   requestChangePasswordEmail(data: RequestChangePasswordEmailData, cb: (err: Error, message: string) => void): void;
-}
+}