User

@julep/sdk / Modules / managers/user / UsersManager

Class: UsersManager

managers/user.UsersManager

BaseManager serves as the base class for all manager classes that interact with the Julep API. It provides common functionality needed for API interactions.

Hierarchy

• BaseManager

  ↳ UsersManager

Table of contents

Constructors

• constructor

Properties

• apiClient

Methods

• create

• delete

• get

• list

• update

Constructors

constructor

• new UsersManager(apiClient): UsersManager

Constructs a new instance of BaseManager.

Parameters

Name	Type	Description
apiClient	JulepApiClient	The JulepApiClient instance used for API interactions.

Returns

UsersManager

Inherited from

BaseManager.constructor

Defined in

src/managers/base.ts:14

Properties

apiClient

• apiClient: JulepApiClient

The JulepApiClient instance used for API interactions.

Inherited from

BaseManager.apiClient

Defined in

src/managers/base.ts:14

Methods

create

▸ create(options?): Promise<User>

Parameters

Name	Type
options	CreateUserRequest

Returns

Promise<User>

Defined in

src/managers/user.ts:22

---

delete

▸ delete(userId): Promise<void>

Parameters

Name	Type
userId	string & Format<"uuid">

Returns

Promise<void>

Defined in

src/managers/user.ts:70

---

get

▸ get(userId): Promise<User>

Parameters

Name	Type
userId	string & Format<"uuid">

Returns

Promise<User>

Defined in

src/managers/user.ts:14

---

list

▸ list(options?): Promise<User[]>

Parameters

Name	Type
options	Object
options.limit?	number & Type<"uint32"> & Minimum<1> & Maximum<1000>
options.metadataFilter?	Object
options.offset?	number & Type<"uint32"> & Minimum<0>

Returns

Promise<User[]>

Defined in

src/managers/user.ts:37

---

update

▸ update(userId, request, overwrite): Promise<User>

Parameters

Name	Type
userId	string
request	UpdateUserRequest
overwrite	true

Returns

Promise<User>

Defined in

src/managers/user.ts:76

▸ update(userId, request, overwrite?): Promise<User>

Parameters

Name	Type
userId	string
request	PatchUserRequest
overwrite?	false

Returns

Promise<User>

Defined in

src/managers/user.ts:82