Class AssetsApi

Hierarchy

BaseAPI
- AssetsApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new AssetsApi(configuration?: Configuration): AssetsApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns AssetsApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

v1getAllAssetCurrentLocations

v1getAllAssetCurrentLocations(requestParameters: V1getAllAssetCurrentLocationsRequest): Promise<InlineResponse2002>

- Defined in apis/AssetsApi.ts:98
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch current locations of all assets. List current location for all assets

Parameters
- requestParameters: V1getAllAssetCurrentLocationsRequest
Returns Promise<InlineResponse2002>

v1getAllAssetCurrentLocationsRaw

v1getAllAssetCurrentLocationsRaw(requestParameters: V1getAllAssetCurrentLocationsRequest): Promise<ApiResponse<InlineResponse2002>>

- Defined in apis/AssetsApi.ts:67
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch current locations of all assets. List current location for all assets

Parameters
- requestParameters: V1getAllAssetCurrentLocationsRequest
Returns Promise<ApiResponse<InlineResponse2002>>

v1getAllAssets

v1getAllAssets(): Promise<InlineResponse2001>

- Defined in apis/AssetsApi.ts:126
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch all of the assets. List all assets

Returns Promise<InlineResponse2001>

v1getAllAssetsRaw

v1getAllAssetsRaw(): Promise<ApiResponse<InlineResponse2001>>

- Defined in apis/AssetsApi.ts:107
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch all of the assets. List all assets

Returns Promise<ApiResponse<InlineResponse2001>>

v1getAssetLocation

v1getAssetLocation(requestParameters: V1getAssetLocationRequest): Promise<object[]>

- Defined in apis/AssetsApi.ts:174
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. List historical locations for a given asset. List historical locations for a given asset

Parameters
- requestParameters: V1getAssetLocationRequest
Returns Promise<object[]>

v1getAssetLocationRaw

v1getAssetLocationRaw(requestParameters: V1getAssetLocationRequest): Promise<ApiResponse<object[]>>

- Defined in apis/AssetsApi.ts:135
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. List historical locations for a given asset. List historical locations for a given asset

Parameters
- requestParameters: V1getAssetLocationRequest
Returns Promise<ApiResponse<object[]>>

v1getAssetReefer

v1getAssetReefer(requestParameters: V1getAssetReeferRequest): Promise<V1AssetReeferResponse>

- Defined in apis/AssetsApi.ts:222
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the reefer-specific stats of an asset. List stats for a given reefer

Parameters
- requestParameters: V1getAssetReeferRequest
Returns Promise<V1AssetReeferResponse>

v1getAssetReeferRaw

v1getAssetReeferRaw(requestParameters: V1getAssetReeferRequest): Promise<ApiResponse<V1AssetReeferResponse>>

- Defined in apis/AssetsApi.ts:183
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the reefer-specific stats of an asset. List stats for a given reefer

Parameters
- requestParameters: V1getAssetReeferRequest
Returns Promise<ApiResponse<V1AssetReeferResponse>>

v1getAssetsReefers

v1getAssetsReefers(requestParameters: V1getAssetsReefersRequest): Promise<InlineResponse2003>

- Defined in apis/AssetsApi.ts:278
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetches all reefers and reefer-specific stats. List stats for all reefers

Parameters
- requestParameters: V1getAssetsReefersRequest
Returns Promise<InlineResponse2003>

v1getAssetsReefersRaw

v1getAssetsReefersRaw(requestParameters: V1getAssetsReefersRequest): Promise<ApiResponse<InlineResponse2003>>

- Defined in apis/AssetsApi.ts:231
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetches all reefers and reefer-specific stats. List stats for all reefers

Parameters
- requestParameters: V1getAssetsReefersRequest
Returns Promise<ApiResponse<InlineResponse2003>>

withMiddleware

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

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

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

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
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

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc