Class StarlinkAPI

Hierarchy

default
- StarlinkAPI

Index

Constructors

Properties

baseUrl client_id client_secret

Methods

delete fetch_accounts get post put disconnect

Constructors

constructor

new StarlinkAPI(client_id: string, client_secret: string): StarlinkAPI
Parameters
- client_id: string
- client_secret: string
Returns StarlinkAPI
Inherited from BaseAPI.constructor

Properties

`Readonly`baseUrl

baseUrl: "https://web-api.starlink.com" = 'https://web-api.starlink.com'

`Readonly`client_id

client_id: string

`Protected` `Readonly`client_secret

client_secret: string

Methods

`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

fetch_accounts

fetch_accounts(
    options?: Partial<
        { all: boolean; limit: number; page: number; regionCode: string[] },
    >,
): Promise<Account[]>
Fetches accounts of the current authenticated user
Parameters
- options: Partial<{ all: boolean; limit: number; page: number; regionCode: string[] }> = ...
Returns Promise<Account[]>

`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`post

post<Type extends Starlink.Response = any>(
endpoint: string,
payload?: object,
): 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
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

`Static`disconnect

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

Returns Promise<void>
Inherited from BaseAPI.disconnect