Class ServiceLine

Hierarchy

default
- ServiceLine

Constructors

constructor

new ServiceLine(
    client_id: string,
    client_secret: string,
    serviceLine: Starlink.Management.Response.ServiceLine,
): ServiceLine
Parameters
- client_id: string
- client_secret: string
- serviceLine: Starlink.Management.Response.ServiceLine
Returns ServiceLine
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

addressReferenceId

get addressReferenceId(): string
Returns string

aviationMetadata

get aviationMetadata(): AviationMetadata | null
Returns AviationMetadata | null

delayedProductId

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

endDate

get endDate(): Date | null
Returns Date | null

nickname

get nickname(): string | null
Returns string | null
set nickname(value: string): void
Parameters
- value: string
Returns void

object

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

optInProductId

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

productReferenceId

get productReferenceId(): string
Returns string
set productReferenceId(value: string): void
Parameters
- value: string
Returns void

publicIp

get publicIp(): boolean
Returns boolean
set publicIp(value: boolean): void
Parameters
- value: boolean
Returns void

serviceLineNumber

get serviceLineNumber(): string
Returns string

startDate

get startDate(): Date | null
Returns Date | null

Methods

add_terminal

add_terminal(terminalOrId: string | UserTerminal): Promise<boolean>
Adds the specified terminal to this service line
Parameters
- terminalOrId: string | UserTerminal
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

fetch_daily_usage

fetch_daily_usage(): Promise<Starlink.Management.Response.RealtimeDataTracking>
Fetches data usage for this service line via the v2 data-usage query endpoint.

v2 does not expose the per-day data-usage bin breakdown that v1 returned. The response is the same shape used by Account.fetch_realtime_data_tracking(): billing cycles with per-day GB totals.

Returns Promise<Starlink.Management.Response.RealtimeDataTracking>

fetch_partial_periods

fetch_partial_periods(): Promise<
{ periodEnd: Date; periodStart: Date; productReferenceId: string }[],
>
Fetches all historical partial subscription periods by asset for the last 1 month(s) plus the current cycle. Does not include the incomplete period corresponding to the service line's current product

Returns Promise<{ periodEnd: Date; periodStart: Date; productReferenceId: string }[]>

`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

opt_in

opt_in(): Promise<Starlink.Management.Response.OptInProduct>
Opt into product for subscription

Returns Promise<Starlink.Management.Response.OptInProduct>

opt_out

opt_out(): Promise<Starlink.Management.Response.OptInProduct>
Opt out of product for subscription

Returns Promise<Starlink.Management.Response.OptInProduct>

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

remove_terminal(terminalOrId: string | UserTerminal): Promise<boolean>
Removes the specified terminal from this service line
Parameters
- terminalOrId: string | UserTerminal
Returns Promise<boolean>

save

save(): Promise<boolean>
Attempts to save any changes to the nickname, productReferenceId, or publicIp

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

Class ServiceLine

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ServiceLine

Properties

ReadonlybaseUrl

Readonlyclient_id

Protected Readonlyclient_secret

Accessors

accountNumber

Returns string

active

Returns boolean

addressReferenceId

Returns string

aviationMetadata

Returns AviationMetadata | null

delayedProductId

Returns string | null

endDate

Returns Date | null

nickname

Returns string | null

Parameters

Returns void

object

Returns Starlink.Management.Response.ServiceLine

optInProductId

Returns string | null

productReferenceId

Returns string

Parameters

Returns void

publicIp

Returns boolean

Parameters

Returns void

serviceLineNumber

Returns string

startDate

Returns Date | null

Methods

add_terminal

Parameters

Returns Promise<boolean>

Protecteddelete

Type Parameters

Parameters

Returns Promise<Type>

fetch_daily_usage

Returns Promise<Starlink.Management.Response.RealtimeDataTracking>

fetch_partial_periods

Returns Promise<{ periodEnd: Date; periodStart: Date; productReferenceId: string }[]>

Protectedget

Type Parameters

Parameters

Returns Promise<Type>

opt_in

Returns Promise<Starlink.Management.Response.OptInProduct>

opt_out

Returns Promise<Starlink.Management.Response.OptInProduct>

Protectedpaginate

Type Parameters

Parameters

Returns Promise<Record_[]>

Protectedpost

Type Parameters

Parameters

Returns Promise<Type>

Protectedput

Type Parameters

Parameters

Returns Promise<Type>

`Readonly`baseUrl

`Readonly`client_id

`Protected` `Readonly`client_secret

`Protected`delete

`Protected`get

`Protected`paginate

`Protected`post

`Protected`put

`Static`disconnect