Class UserTerminal

Hierarchy

default
- UserTerminal

Index

Constructors

Properties

baseUrl client_id client_secret

Accessors

accountNumber active dishSerialNumber kitSerialNumber nickname object routers serviceLineNumber userTerminalId

Methods

add_to_service_line delete get paginate post put remove_from_service_line toString disconnect

Constructors

constructor

new UserTerminal(
    client_id: string,
    client_secret: string,
    userTerminal: Starlink.Management.Response.UserTerminal,
): UserTerminal
Parameters
- client_id: string
- client_secret: string
- userTerminal: Starlink.Management.Response.UserTerminal
Returns UserTerminal
Overrides BaseAPI.constructor

Properties

`Readonly`baseUrl

baseUrl: "https://starlink.com/api/public" = 'https://starlink.com/api/public'

`Readonly`client_id

client_id: string

`Protected` `Readonly`client_secret

client_secret: string

Accessors

accountNumber

get accountNumber(): string
Returns string

active

get active(): boolean
Returns boolean

dishSerialNumber

get dishSerialNumber(): string
Returns string

kitSerialNumber

get kitSerialNumber(): string
Returns string

nickname

get nickname(): string | null
Returns string | null

object

get object(): Starlink.Management.Response.UserTerminal
Returns Starlink.Management.Response.UserTerminal

routers

get routers(): Router[]
Returns Router[]

serviceLineNumber

get serviceLineNumber(): string | null
Returns string | null

userTerminalId

get userTerminalId(): string
Returns string

Methods

add_to_service_line

add_to_service_line(serviceLineOrNumber: string | ServiceLine): Promise<boolean>
Adds the terminal to the service line specified
Parameters
- serviceLineOrNumber: string | ServiceLine
Returns Promise<boolean>

`Protected`delete

delete<Type extends Starlink.Response = any>(
endpoint: string,
params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP delete request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.delete

`Protected`get

get<Type extends Starlink.Response = any>(
endpoint: string,
params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP get request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.get

`Protected`paginate

paginate<Record_>(
    method: "GET" | "POST",
    endpoint: string,
    opts?: Partial<
        {
            all: boolean;
            body: object;
            filters: Record<string, any>;
            page: number;
        },
    >,
): Promise<Record_[]>
Protected
Walks a paginated endpoint, returning every record.

When all: false, fetches the single page given by page and returns its results. When all: true (default), walks pages until isLastPage, asserting that the total received matches totalCount from the wire response.
Type Parameters
- Record_
Parameters
- method: "GET" | "POST"
- endpoint: string
- opts: Partial<
      {
          all: boolean;
          body: object;
          filters: Record<string, any>;
          page: number;
      },
  > = {}
Returns Promise<Record_[]>
Inherited from BaseAPI.paginate

`Protected`post

post<Type extends Starlink.Response = any>(
    endpoint: string,
    payload?: object,
    params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP post request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- Optionalpayload: object
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.post

`Protected`put

put<Type extends Starlink.Response = any>(
endpoint: string,
payload?: string | object,
): Promise<Type>
Protected
Performs an HTTP put request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- Optionalpayload: string | object
Returns Promise<Type>
Inherited from BaseAPI.put

remove_from_service_line

remove_from_service_line(): Promise<boolean>
Removes the terminal from it's assigned service line

Returns Promise<boolean>

toString

toString(): string
Converts the instance to a string (JSON encoded)

Returns string

`Static`disconnect

disconnect(): Promise<void>
Disconnects the internal rate-limit cache and releases its resources

Returns Promise<void>
Inherited from BaseAPI.disconnect