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

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new UsersManager(apiClient): UsersManager

Constructs a new instance of BaseManager.

Parameters

NameTypeDescription

apiClient

The JulepApiClient instance used for API interactions.

Returns

UsersManager

Inherited from

BaseManager.constructor

Defined in

src/managers/base.ts:12

Properties

apiClient

apiClient: JulepApiClient

The JulepApiClient instance used for API interactions.

Inherited from

BaseManager.apiClient

Defined in

src/managers/base.ts:12

Methods

create

create(«destructured»?): Promise<User>

Parameters

NameType

«destructured»

Returns

Promise<User>

Defined in

src/managers/user.ts:27


delete

delete(userId): Promise<void>

Parameters

NameType

userId

string

Returns

Promise<void>

Defined in

src/managers/user.ts:63


get

get(userId): Promise<User>

Parameters

NameType

userId

string

Returns

Promise<User>

Defined in

src/managers/user.ts:15


list

list(«destructured»?): Promise<User[]>

Parameters

NameTypeDefault value

«destructured»

Object

{}

limit?

number

10

metadataFilter?

Object

{}

offset?

number

0

Returns

Promise<User[]>

Defined in

src/managers/user.ts:44


update

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

Parameters

NameType

userId

string

request

overwrite

true

Returns

Promise<User>

Defined in

src/managers/user.ts:73

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

Parameters

NameType

userId

string

request

overwrite?

false

Returns

Promise<User>

Defined in

src/managers/user.ts:79

Last updated