Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseAPI
    • BetaAPIsApi

Index

Constructors

constructor

  • new BetaAPIsApi(configuration?: Configuration): BetaAPIsApi
  • Parameters

    • configuration: Configuration = ...

    Returns BetaAPIsApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createAttribute

createAttributeRaw

createTrailer

  • createTrailer(requestParameters: CreateTrailerRequest): Promise<TrailersCreateTrailerResponseBody>

createTrailerRaw

  • createTrailerRaw(requestParameters: CreateTrailerRequest): Promise<ApiResponse<TrailersCreateTrailerResponseBody>>
  • Creates a new trailer asset. [beta] Creates a new trailer asset

    Parameters

    Returns Promise<ApiResponse<TrailersCreateTrailerResponseBody>>

deleteAttribute

deleteAttributeRaw

deleteDocument

deleteDocumentRaw

deleteGateway

deleteGatewayRaw

deleteTrailer

deleteTrailerRaw

getAttribute

  • Fetch an attribute by id, including all of its applications. [beta] Retrieve an attribute

    Parameters

    Returns Promise<AttributeExpandedResponse>

getAttributeRaw

  • getAttributeRaw(requestParameters: GetAttributeRequest): Promise<ApiResponse<AttributeExpandedResponse>>
  • Fetch an attribute by id, including all of its applications. [beta] Retrieve an attribute

    Parameters

    Returns Promise<ApiResponse<AttributeExpandedResponse>>

getAttributesByEntityType

getAttributesByEntityTypeRaw

  • Fetch all attributes in an organization associated with either drivers or assets. [beta] List all attributes by entity type

    Parameters

    Returns Promise<ApiResponse<GetAttributesByEntityTypeResponse>>

getComplianceSettings

  • getComplianceSettings(): Promise<SettingsGetComplianceSettingsResponseBody>
  • Get organization's compliance settings, including carrier name, office address, and DOT number [beta] Get compliance settings

    Returns Promise<SettingsGetComplianceSettingsResponseBody>

getComplianceSettingsRaw

  • getComplianceSettingsRaw(): Promise<ApiResponse<SettingsGetComplianceSettingsResponseBody>>
  • Get organization's compliance settings, including carrier name, office address, and DOT number [beta] Get compliance settings

    Returns Promise<ApiResponse<SettingsGetComplianceSettingsResponseBody>>

getDocument

  • getDocument(requestParameters: GetDocumentRequest): Promise<DocumentsGetDocumentResponseBody>

getDocumentRaw

  • getDocumentRaw(requestParameters: GetDocumentRequest): Promise<ApiResponse<DocumentsGetDocumentResponseBody>>

getDocumentTypes

getDocumentTypesRaw

  • getDocumentTypesRaw(requestParameters: GetDocumentTypesRequest): Promise<ApiResponse<DocumentTypesGetDocumentTypesResponseBody>>
  • Returns a list of the organization document types. [beta] Fetch document types

    Parameters

    Returns Promise<ApiResponse<DocumentTypesGetDocumentTypesResponseBody>>

getDocuments

  • getDocuments(requestParameters: GetDocumentsRequest): Promise<DocumentsGetDocumentsResponseBody>

getDocumentsRaw

  • getDocumentsRaw(requestParameters: GetDocumentsRequest): Promise<ApiResponse<DocumentsGetDocumentsResponseBody>>
  • Get all documents for the given time range. [beta] Fetch all documents

    Parameters

    Returns Promise<ApiResponse<DocumentsGetDocumentsResponseBody>>

getDriverAppSettings

  • getDriverAppSettings(): Promise<SettingsGetDriverAppSettingsResponseBody>
  • Get driver app settings. [beta] Get driver app settings

    Returns Promise<SettingsGetDriverAppSettingsResponseBody>

getDriverAppSettingsRaw

  • getDriverAppSettingsRaw(): Promise<ApiResponse<SettingsGetDriverAppSettingsResponseBody>>
  • Get driver app settings. [beta] Get driver app settings

    Returns Promise<ApiResponse<SettingsGetDriverAppSettingsResponseBody>>

getDriverEfficiency

getDriverEfficiencyRaw

getGateways

  • getGateways(requestParameters: GetGatewaysRequest): Promise<GatewaysGetGatewaysResponseBody>

getGatewaysRaw

  • getGatewaysRaw(requestParameters: GetGatewaysRequest): Promise<ApiResponse<GatewaysGetGatewaysResponseBody>>

getTrailer

  • getTrailer(requestParameters: GetTrailerRequest): Promise<TrailersGetTrailerResponseBody>

getTrailerRaw

  • getTrailerRaw(requestParameters: GetTrailerRequest): Promise<ApiResponse<TrailersGetTrailerResponseBody>>
  • Retrieve a trailer with given ID. [beta] Retrieve a trailer

    Parameters

    Returns Promise<ApiResponse<TrailersGetTrailerResponseBody>>

getTrailerStatsFeed

  • Follow a feed of trailer stats. The first call to this endpoint will provide the most recent stats for each trailer and an endCursor. Providing the endCursor value to the after query parameter will fetch all updates since the previous API call. If hasNextPage is false, no new data is immediately available. Please wait a minimum of 5 seconds before making a subsequent request. [beta] Get trailer stats feed

    Parameters

    Returns Promise<TrailerStatsGetTrailerStatsFeedResponseBody>

getTrailerStatsFeedRaw

  • getTrailerStatsFeedRaw(requestParameters: GetTrailerStatsFeedRequest): Promise<ApiResponse<TrailerStatsGetTrailerStatsFeedResponseBody>>
  • Follow a feed of trailer stats. The first call to this endpoint will provide the most recent stats for each trailer and an endCursor. Providing the endCursor value to the after query parameter will fetch all updates since the previous API call. If hasNextPage is false, no new data is immediately available. Please wait a minimum of 5 seconds before making a subsequent request. [beta] Get trailer stats feed

    Parameters

    Returns Promise<ApiResponse<TrailerStatsGetTrailerStatsFeedResponseBody>>

getTrailerStatsHistory

  • Returns trailer stats during the given time range for all trailers. This can be optionally filtered by tags or specific trailer IDs. [beta] Get trailer stats history

    Parameters

    Returns Promise<TrailerStatsGetTrailerStatsHistoryResponseBody>

getTrailerStatsHistoryRaw

  • getTrailerStatsHistoryRaw(requestParameters: GetTrailerStatsHistoryRequest): Promise<ApiResponse<TrailerStatsGetTrailerStatsHistoryResponseBody>>
  • Returns trailer stats during the given time range for all trailers. This can be optionally filtered by tags or specific trailer IDs. [beta] Get trailer stats history

    Parameters

    Returns Promise<ApiResponse<TrailerStatsGetTrailerStatsHistoryResponseBody>>

getTrailerStatsSnapshot

  • Returns the last known stats of all trailers at the given time. If no time is specified, the current time is used. [beta] Get trailer stats

    Parameters

    Returns Promise<TrailerStatsGetTrailerStatsSnapshotResponseBody>

getTrailerStatsSnapshotRaw

  • getTrailerStatsSnapshotRaw(requestParameters: GetTrailerStatsSnapshotRequest): Promise<ApiResponse<TrailerStatsGetTrailerStatsSnapshotResponseBody>>
  • Returns the last known stats of all trailers at the given time. If no time is specified, the current time is used. [beta] Get trailer stats

    Parameters

    Returns Promise<ApiResponse<TrailerStatsGetTrailerStatsSnapshotResponseBody>>

listTrailers

  • listTrailers(requestParameters: ListTrailersRequest): Promise<TrailersListTrailersResponseBody>

listTrailersRaw

  • listTrailersRaw(requestParameters: ListTrailersRequest): Promise<ApiResponse<TrailersListTrailersResponseBody>>

patchComplianceSettings

  • Update organization's compliance settings, including carrier name, office address, and DOT number [beta] Update compliance settings

    Parameters

    Returns Promise<SettingsPatchComplianceSettingsResponseBody>

patchComplianceSettingsRaw

  • Update organization's compliance settings, including carrier name, office address, and DOT number [beta] Update compliance settings

    Parameters

    Returns Promise<ApiResponse<SettingsPatchComplianceSettingsResponseBody>>

patchDriverAppSettings

patchDriverAppSettingsRaw

patchEquipment

  • Update an equipment. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array [beta] Update an equipment

    Parameters

    Returns Promise<EquipmentPatchEquipmentResponseBody>

patchEquipmentRaw

  • patchEquipmentRaw(requestParameters: PatchEquipmentRequest): Promise<ApiResponse<EquipmentPatchEquipmentResponseBody>>
  • Update an equipment. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array [beta] Update an equipment

    Parameters

    Returns Promise<ApiResponse<EquipmentPatchEquipmentResponseBody>>

postDocument

  • postDocument(requestParameters: PostDocumentRequest): Promise<DocumentsPostDocumentResponseBody>

postDocumentRaw

  • postDocumentRaw(requestParameters: PostDocumentRequest): Promise<ApiResponse<DocumentsPostDocumentResponseBody>>

postGateway

  • postGateway(requestParameters: PostGatewayRequest): Promise<GatewaysPostGatewayResponseBody>
  • Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device's serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated [beta] Activate a new gateway

    Parameters

    Returns Promise<GatewaysPostGatewayResponseBody>

postGatewayRaw

  • postGatewayRaw(requestParameters: PostGatewayRequest): Promise<ApiResponse<GatewaysPostGatewayResponseBody>>
  • Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device's serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated [beta] Activate a new gateway

    Parameters

    Returns Promise<ApiResponse<GatewaysPostGatewayResponseBody>>

Protected request

  • request(context: RequestOpts): Promise<Response>
  • Parameters

    • context: RequestOpts

    Returns Promise<Response>

updateAttribute

updateAttributeRaw

updateEngineImmobilizerState

  • Update the engine immobilizer state of a vehicle. This requires an engine immobilizer to be installed on the vehicle gateway. The desired engine immobilizer state will be set on the vehicle when the vehicle gateway is online, and the engine is not running. [beta] Update engine immobilizer state of a vehicle.

    Parameters

    Returns Promise<EngineImmobilizerUpdateEngineImmobilizerStateResponseBody>

updateEngineImmobilizerStateRaw

  • Update the engine immobilizer state of a vehicle. This requires an engine immobilizer to be installed on the vehicle gateway. The desired engine immobilizer state will be set on the vehicle when the vehicle gateway is online, and the engine is not running. [beta] Update engine immobilizer state of a vehicle.

    Parameters

    Returns Promise<ApiResponse<EngineImmobilizerUpdateEngineImmobilizerStateResponseBody>>

updateTrailer

  • updateTrailer(requestParameters: UpdateTrailerRequest): Promise<TrailersUpdateTrailerResponseBody>
  • Update a trailer. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array [beta] Update a trailer

    Parameters

    Returns Promise<TrailersUpdateTrailerResponseBody>

updateTrailerRaw

  • updateTrailerRaw(requestParameters: UpdateTrailerRequest): Promise<ApiResponse<TrailersUpdateTrailerResponseBody>>
  • Update a trailer. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array [beta] Update a trailer

    Parameters

    Returns Promise<ApiResponse<TrailersUpdateTrailerResponseBody>>

withMiddleware

  • withMiddleware<T>(...middlewares: Middleware[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...middlewares: Middleware[]

    Returns T

withPostMiddleware

  • withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

    Returns T

Generated using TypeDoc