SDK Reference
Overview
TypeScript client options, result contracts, service pages, and shared SDK conventions.
Services
Service Surface
linxio.authloginverifyOtprefreshmelogoutlinxio.vehicleslistiteratestreamgetcreateupdatearchiverestoregetOdometerrecalibrateOdometergetEngineHourscounttypeslinxio.deviceslistiteratestreamgetcreateupdateinstalluninstallarchiverestorecoordinatessensorshistoryvendorsinstallationscameraslinxio.users, linxio.clients, linxio.drivers, linxio.resellersuserclientdriverand reseller account workflowslinxio.geofencesarea and area-group lifecycle workflowslinxio.fuelrecordssummariescardsfuel typestransaction assignmentlinxio.reports, linxio.digitalFormsscheduled reports and digital form answer downloadslinxio.routes, linxio.sensors, linxio.camerasroute historytemperature/humidity reportsand camera eventslinxio.metadataread-only tenant settings and reference datalinxio.realtimeconnectsubscribeonPositiononNotificationdisconnectlinxio.request, linxio.httpraw HTTP access with SDK authretrytimeoutand refresh behaviorexported utilitiesresult helperspagination helpersendpoint catalogue helpersCreate a client
Result Contract
Domain service methods return result objects so scripts can branch without
wrapping every call in try/catch.
Service methods normalize Linxio response envelopes, including result,
data, and endpoint-key collection wrappers, so result.data contains the
developer-facing payload. Use client.request() when you need the raw wire
response for diagnostics.
LinxioResult<T>
T | null
optionalSuccessful response payload. Null when the call failed.
LinxioError | null
optionalTyped SDK error. Null when the call succeeded.
Show child fields
string
requiredSafe error message.
string
requiredSDK error class name.
unknown
optionalOriginal cause when available.
string
optionalHTTP method when the error came from a request.
string
optionalAPI path when the error came from a request.
string
optionalRequest identifier from X-Request-Id when supplied.
LinxioPageResult<T>
T[] | null
optionalCurrent page of records, or null when the request failed.
LinxioError | null
optionalTyped SDK error. Null when the page was loaded successfully.
Show child fields
string
requiredSafe error message.
string
requiredSDK error class name.
unknown
optionalOriginal cause when available.
string
optionalHTTP method when the error came from a request.
string
optionalAPI path when the error came from a request.
string
optionalRequest identifier from X-Request-Id when supplied.
LinxioPaginationMeta | null
optionalNormalized pagination metadata.
Show child fields
number
requiredPage size.
number
requiredCurrent page number.
number
requiredTotal matching record count.
unknown
optionalAggregation payload returned by Linxio when the endpoint includes it.
Shared list parameters
Parameters
number
optionalNumber of records to request per page.
number
optionalPage number to request.
Default:
1string
optionalSort expression accepted by the underlying Linxio endpoint.
string[]
optionalMapped to Linxio's fields[] query parameter to keep responses small.
string | number | boolean | string[] | number[]
optionalAdditional endpoint-specific filters are forwarded as query parameters.
Pagination helpers
Use list() when you want one page, iterate() when you want a result object
containing every page, and stream() when you want to process large tenants
without holding every record in memory.
const page = await linxio.vehicles.list({
fields: ["id", "regNo"],
limit: 100,
page: 1,
});const { data: vehicles, error } = await linxio.vehicles.iterate({
fields: ["id", "regNo", "lastLoggedAt"],
limit: 100,
});
if (error) {
throw error;
}for await (const vehicle of linxio.vehicles.stream({ limit: 100 })) {
console.log(vehicle.id, vehicle.regNo);
}