SDK Reference
SDK Reference
TypeScript client options, result contracts, service pages, and shared SDK conventions.
The SDK reference is split by service so scripts and agents can retrieve the piece they need without loading the whole surface area.
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.
LinxioResult<T>
dataT | null
optionalSuccessful response payload. Null when the call failed.
errorLinxioError | null
optionalTyped SDK error. Null when the call succeeded.
LinxioPageResult<T>
dataT[] | null
optionalCurrent page of records, or null when the request failed.
errorLinxioError | null
optionalTyped SDK error. Null when the page was loaded successfully.
meta{ page: number; limit: number; total: number } | null
optionalNormalized pagination metadata.
aggregationsunknown
optionalAggregation payload returned by Linxio when the endpoint includes it.
Shared list parameters
Parameters
limitnumber
optionalNumber of records to request per page.
pagenumber
optionalPage number to request.
Default:
1sortstring
optionalSort expression accepted by the underlying Linxio endpoint.
fieldsstring[]
optionalMapped to Linxio's fields[] query parameter to keep responses small.
[filter]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);
}