Class ApplicationClient

Hierarchy

BaseClient
- ApplicationClient

Index

Constructors

Properties

Methods

createLocation createNode createServer createUser getEgg getEggs getExternalServer getExternalUser getLocation getLocations getNest getNests getNode getNodes getServer getServers getUser getUsers

Constructors

constructor

new ApplicationClient(options): ApplicationClient
Parameters
- options: ClientOptions
Returns ApplicationClient
Overrides BaseClient.constructor
- Defined in src/ApplicationClient/ApplicationClient.ts:20

Properties

api

api: ((config: AxiosRequestConfig<any>, errorSet?: {
code: number;
message: string;
}[], ignoredErrors?: string[]) => Promise<any>) = ...

`Protected`apikey

apikey: string

panel

panel: string

Methods

createLocation

createLocation(locationProperties): Promise<PanelLocation>
Create a location for this panel
Parameters
- locationProperties: LocationBuilder
Returns Promise<PanelLocation>
- Defined in src/ApplicationClient/ApplicationClient.ts:115

createNode

createNode(nodeProperties): Promise<PanelNode>
Create a node
Parameters
- nodeProperties: NodeBuilder
  The properties for the new node
Returns Promise<PanelNode>
- Defined in src/ApplicationClient/ApplicationClient.ts:90

createServer

createServer(serverProperties): Promise<PanelServer>
Create a server
Parameters
- serverProperties: ServerBuilder
Returns Promise<PanelServer>
- Defined in src/ApplicationClient/ApplicationClient.ts:150

createUser

createUser(userProperties): Promise<PanelUser>
Create a user
Parameters
- userProperties: UserBuilder
  Construct a user via new UserBuilder()
Returns Promise<PanelUser>
- Defined in src/ApplicationClient/ApplicationClient.ts:63

getEgg

getEgg(nestId, eggId): Promise<Egg>
Get a specific egg of this panel
Parameters
- nestId: number
  The if of the nest you want to get the egg from
- eggId: number
  The egg you want to get
Returns Promise<Egg>
- Defined in src/ApplicationClient/ApplicationClient.ts:188

getEggs

getEggs(nestId): Promise<Egg[]>
Get the eggs of this panel
Parameters
- nestId: number
  The if of the nest you want to get the eggs from
Returns Promise<Egg[]>
- Defined in src/ApplicationClient/ApplicationClient.ts:177

getExternalServer

getExternalServer(externalId): Promise<PanelServer>
Get a server by their external id
Parameters
- externalId: string
  The target servers external id
Returns Promise<PanelServer>
- Defined in src/ApplicationClient/ApplicationClient.ts:142

getExternalUser

getExternalUser(externalId): Promise<PanelUser>
Get a user via their external id
Parameters
- externalId: string
  The external id of a user
Returns Promise<PanelUser>
- Defined in src/ApplicationClient/ApplicationClient.ts:54

getLocation

getLocation(locationId): Promise<PanelLocation>
Get a location of this panel
Parameters
- locationId: number
Returns Promise<PanelLocation>
- Defined in src/ApplicationClient/ApplicationClient.ts:107

getLocations

getLocations(): Promise<PanelLocation[]>
Get the locations of this panel

Returns Promise<PanelLocation[]>
- Defined in src/ApplicationClient/ApplicationClient.ts:98

getNest

getNest(nestId): Promise<Nest>
Get a nest by id of this panel
Parameters
- nestId: number
  The id of the nest you want to get
Returns Promise<Nest>
- Defined in src/ApplicationClient/ApplicationClient.ts:168

getNests

getNests(): Promise<Nest[]>
Get the nests of this panel

Returns Promise<Nest[]>
- Defined in src/ApplicationClient/ApplicationClient.ts:158

getNode

getNode(nodeId): Promise<PanelNode>
Get a specific Node by nodeId
Parameters
- nodeId: number
  The id of the specific node
Returns Promise<PanelNode>
- Defined in src/ApplicationClient/ApplicationClient.ts:81

getNodes

getNodes(): Promise<PanelNode[]>
Get all nodes of a panel

Returns Promise<PanelNode[]>
- Defined in src/ApplicationClient/ApplicationClient.ts:71

getServer

getServer(serverId): Promise<PanelServer>
Get a server for this panel
Parameters
- serverId: number
  The target server Id
Returns Promise<PanelServer>
- Defined in src/ApplicationClient/ApplicationClient.ts:133

getServers

getServers(): Promise<PanelServer[]>
Get servers for this panel

Returns Promise<PanelServer[]>
- Defined in src/ApplicationClient/ApplicationClient.ts:123

getUser

getUser(userId): Promise<PanelUser>
Get a user via their userId
Parameters
- userId: number
  The id of a user
Returns Promise<PanelUser>
- Defined in src/ApplicationClient/ApplicationClient.ts:45

getUsers

getUsers(filter?, sortBy?, reverseSort?): Promise<PanelUser[]>
Get all users associated to the panel
Parameters
- Optionalfilter: {
      email?: string;
      externalId?: string;
      username?: string;
      uuid?: string;
  }
  Filter users by email, uuid, username and/or externalId
  - Optionalemail?: string
  - OptionalexternalId?: string
  - Optionalusername?: string
  - Optionaluuid?: string
- OptionalsortBy: "id" | "uuid"
  Sort users by id oder uuid
- OptionalreverseSort: boolean
  Reverse the sort
Returns Promise<PanelUser[]>
Requires
sortBy
- Defined in src/ApplicationClient/ApplicationClient.ts:30

Class ApplicationClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ApplicationClient

Properties

api

Protectedapikey

panel

Methods

createLocation

Parameters

Returns Promise<PanelLocation>

createNode

Parameters

Returns Promise<PanelNode>

createServer

Parameters

Returns Promise<PanelServer>

createUser

Parameters

Returns Promise<PanelUser>

getEgg

Parameters

Returns Promise<Egg>

getEggs

Parameters

Returns Promise<Egg[]>

getExternalServer

Parameters

Returns Promise<PanelServer>

getExternalUser

Parameters

Returns Promise<PanelUser>

getLocation

Parameters

Returns Promise<PanelLocation>

getLocations

Returns Promise<PanelLocation[]>

getNest

Parameters

Returns Promise<Nest>

getNests

Returns Promise<Nest[]>

getNode

Parameters

Returns Promise<PanelNode>

getNodes

Returns Promise<PanelNode[]>

getServer

Parameters

Returns Promise<PanelServer>

getServers

Returns Promise<PanelServer[]>

getUser

Parameters

Returns Promise<PanelUser>

getUsers

Parameters

Optionalemail?: string

OptionalexternalId?: string

Optionalusername?: string

Optionaluuid?: string

Returns Promise<PanelUser[]>

Requires

Settings

On This Page

`Protected`apikey

`Optional`email?: string

`Optional`externalId?: string

`Optional`username?: string

`Optional`uuid?: string