UserManager | @devnote-dev/pterojs

Hierarchy

BaseManager
- UserManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UserManager(client: PteroApp): UserManager

Overrides BaseManager.constructor
- Defined in src/application/UserManager.ts:55
Parameters
- client: PteroApp
Returns UserManager

Properties

cache

cache: Dict<number, User>

client

client: PteroApp

Accessors

FILTERS

get FILTERS(): readonly string[]

Overrides BaseManager.FILTERS
- Defined in src/application/UserManager.ts:32
Allowed filter arguments for users:
- email
- uuid
- username
- externalId
Returns readonly string[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/application/UserManager.ts:40
Allowed include arguments for users:
- servers
Returns readonly string[]

SORTS

get SORTS(): readonly string[]

Overrides BaseManager.SORTS
- Defined in src/application/UserManager.ts:51
Allowed sort arguments for users:
- id
- -id
- uuid
- -uuid
Returns readonly string[]

Methods

_patch

_patch(data: any): any

- Defined in src/application/UserManager.ts:66
Transforms the raw user object(s) into class objects.

Parameters
- data: any
  
  The resolvable user object(s).
Returns any
The resolved user object(s).

adminURLFor

adminURLFor(id: number): string

- Defined in src/application/UserManager.ts:119
Parameters
- id: number
  
  The ID of the user.
Returns string
The formatted URL to the user in the admin panel.

create

create(options: CreateUserOptions): Promise<User>

Creates a user account.

see

CreateUserOptions.

example

app.users.create({
 email: 'user@example.com',
 username: 'example-user',
 firstname: 'example',
 lastname: 'user',
 externalId: 'example1'
})
 .then(console.log)
 .catch(console.error);

Parameters

options: CreateUserOptions

Create user options.

Returns Promise<User>

The new user.

delete

delete(id: number): Promise<void>

- Defined in src/application/UserManager.ts:351
Deletes a user account.
example
```
app.users.delete(8).catch(console.error);
```
Parameters
- id: number
  
  The ID of the user.
Returns Promise<void>

fetch

fetch(id: number, options?: Include<FetchOptions>): Promise<User>
fetch(id: string, options?: Include<FetchOptions>): Promise<User>
fetch(options?: Include<FetchOptions>): Promise<Dict<number, User>>

Overrides BaseManager.fetch
- Defined in src/application/UserManager.ts:135
Fetches a user from the API by its ID. This will check the cache first unless the force option is specified.
example
```
app.users.fetch(5).then(console.log).catch(console.error);
```
Parameters
- id: number
  
  The ID of the user.
- Optional options: Include<FetchOptions>
Returns Promise<User>
The fetched user.
Overrides BaseManager.fetch
- Defined in src/application/UserManager.ts:148
Fetches a user from the API by its external ID. This will check the cache first unless the force option is specified.
example
```
app.users.fetch('admin').then(console.log).catch(console.error);
```
Parameters
- id: string
  
  The external ID of the user.
- Optional options: Include<FetchOptions>
Returns Promise<User>
The fetched user.
Overrides BaseManager.fetch
- Defined in src/application/UserManager.ts:160
Fetches a list of users from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.users.fetch({ perPage: 20 }).then(console.log).catch(console.error);
```
Parameters
- Optional options: Include<FetchOptions>
Returns Promise<Dict<number, User>>
The fetched users.

fetchAll

fetchAll(options?: Include<FetchOptions>): Promise<Dict<number, User>>

- Defined in src/application/UserManager.ts:215
Fetches all users from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.users.fetchAll({ perPage: 20 }).then(console.log).catch(console.error);
```
Parameters
- Optional options: Include<FetchOptions>
Returns Promise<Dict<number, User>>
The fetched users.

fetchExternal

fetchExternal(id: string, options: Include<FetchOptions>): Promise<User>

- Defined in src/application/UserManager.ts:200
deprecated
Use UserManager.fetch.

Parameters
- id: string
- options: Include<FetchOptions>
Returns Promise<User>

Protected getFetchAll

getFetchAll<T, K>(...options: unknown[]): Promise<Dict<T, K>>

Inherited from BaseManager.getFetchAll
- Defined in src/structures/BaseManager.ts:37
Fetches rach page and joins the results.

internal
Type Parameters
- T
- K
Parameters
- Rest ...options: unknown[]
Returns Promise<Dict<T, K>>
Dictionary of the specified types

getQueryOptions

getQueryOptions(): { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }

Inherited from BaseManager.getQueryOptions
- Defined in src/structures/BaseManager.ts:24
Gets the allowed query options from the inherited manager.

internal
Returns { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }
The query options.
- filters: readonly string[]
- includes: readonly string[]
- sorts: readonly string[]

query

query(entity: string, options: Filter<{ sort?: string }>): Promise<Dict<number, User>>

- Defined in src/application/UserManager.ts:245
Queries the API for users that match the specified query filters. This fetches from the API directly and does not check the cache. Use cache methods for filtering and sorting.
Available query filters:
- email
- uuid
- username
- externalId
Available sort options:
- id
- -id
- uuid
- -uuid
example
```
app.users.query('d5f506c9', { filter: 'uuid' })
 .then(console.log)
 .catch(console.error);
```
Parameters
- entity: string
  
  The entity to query.
- options: Filter<{ sort?: string }>
  
  The query options to filter by.
Returns Promise<Dict<number, User>>
The queried users.

resolve

resolve(obj: Resolvable<User>): undefined | User

- Defined in src/application/UserManager.ts:99
Resolves a user from an object. This can be:
- a string
- a number
- an object
Parameters
- obj: Resolvable<User>
  
  The object to resolve from.
Returns undefined | User
The resolved user or undefined if not found.

update

update(id: number, options: Partial<UpdateUserOptions>): Promise<User>

- Defined in src/application/UserManager.ts:313
Updates the user account with the specified options.
see
UpdateUserOptions.

example
```
app.users.update(7, { externalId: 'admin2', isAdmin: true })
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the user.
- options: Partial<UpdateUserOptions>
  
  Update user options.
Returns Promise<User>
The updated user.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: PteroApp

Returns UserManager

Properties

cache

client

meta

Accessors

FILTERS

Returns readonly string[]

INCLUDES

Returns readonly string[]

SORTS

Returns readonly string[]

Methods

_patch

Parameters

data: any

Returns any

adminURLFor

Parameters

id: number

Returns string

create

Parameters

options: CreateUserOptions

Returns Promise<User>

delete

Parameters

id: number

Returns Promise<void>

fetch

Parameters

id: number

Optional options: Include<FetchOptions>

Returns Promise<User>

Parameters

id: string

Optional options: Include<FetchOptions>

Returns Promise<User>

Parameters

Optional options: Include<FetchOptions>

Returns Promise<Dict<number, User>>

fetchAll

Parameters

Optional options: Include<FetchOptions>

Returns Promise<Dict<number, User>>

fetchExternal

Parameters

id: string

options: Include<FetchOptions>

Returns Promise<User>

Protected getFetchAll

Type Parameters

T

K

Parameters

Rest ...options: unknown[]

Returns Promise<Dict<T, K>>

getQueryOptions

Returns { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }

filters: readonly string[]

includes: readonly string[]

sorts: readonly string[]

query

Parameters

entity: string

options: Filter<{ sort?: string }>

Returns Promise<Dict<number, User>>

resolve

Parameters

obj: Resolvable<User>