API for device, collection, output and firmware management
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 4.4.2 nonviolent-adelbert
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://lab5e.com
Dart 2.0 or later
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
spanapi:
git: https://github.com/lab5e/dart-spanapi.git
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
spanapi:
path: /path/to/spanapi
TODO
Please follow the installation procedure and then run the following:
import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';
final api_instance = BlobsApi();
final collectionId = collectionId_example; // String |
final blobId = blobId_example; // String |
try {
final result = api_instance.deleteBlob(collectionId, blobId);
print(result);
} catch (e) {
print('Exception when calling BlobsApi->deleteBlob: $e\n');
}
All URIs are relative to https://api.lab5e.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BlobsApi | deleteBlob | DELETE /span/collections/{collectionId}/blobs/{blobId} | Remove a blob stored on a collection |
| BlobsApi | listBlobs | GET /span/collections/{collectionId}/blobs | List the blobs for a collection |
| CertificatesApi | createCertificate | POST /span/collections/{collectionId}/certificates/create | Create certificate |
| CertificatesApi | retrieveCertificateChain | GET /span/collections/{collectionId}/certificates | Get certificate chain |
| CertificatesApi | signCertificate | POST /span/collections/{collectionId}/certificates/sign | Sign certificate |
| CertificatesApi | verifyCertificate | POST /span/collections/{collectionId}/certificates/verify | Verify certificate |
| CollectionsApi | createCollection | POST /span/collections | Create collection |
| CollectionsApi | deleteCollection | DELETE /span/collections/{collectionId} | Delete collection |
| CollectionsApi | listCollectionData | GET /span/collections/{collectionId}/data | Retrieve data from devices |
| CollectionsApi | listCollections | GET /span/collections | List collections |
| CollectionsApi | retrieveCollection | GET /span/collections/{collectionId} | Retrieve collection |
| CollectionsApi | updateCollection | PATCH /span/collections/{collectionId} | Update collection |
| DevicesApi | addDownstreamMessage | POST /span/collections/{collectionId}/devices/{deviceId}/outbox | Add message to oubox |
| DevicesApi | createDevice | POST /span/collections/{collectionId}/devices | Create device |
| DevicesApi | deleteDevice | DELETE /span/collections/{collectionId}/devices/{deviceId} | Remove device. |
| DevicesApi | deleteDownstreamMessage | DELETE /span/collections/{collectionId}/devices/{deviceId}/outbox/{messageId} | Delete outgoing message |
| DevicesApi | deviceCertificate | GET /span/collections/{collectionId}/devices/{deviceId}/certs | Get issued certificate(s) for device |
| DevicesApi | listDeviceData | GET /span/collections/{collectionId}/devices/{deviceId}/data | Retrieve data from device |
| DevicesApi | listDevices | GET /span/collections/{collectionId}/devices | List devices in collection. |
| DevicesApi | listDownstreamMessages | GET /span/collections/{collectionId}/devices/{deviceId}/outbox | List the messages in the outbox |
| DevicesApi | listUpstreamMessages | GET /span/collections/{collectionId}/devices/{deviceId}/inbox | List incoming messages |
| DevicesApi | retrieveDevice | GET /span/collections/{collectionId}/devices/{deviceId} | Retrieve device |
| DevicesApi | updateDevice | PATCH /span/collections/{existingCollectionId}/devices/{deviceId} | Update device |
| FotaApi | clearFirmwareError | DELETE /span/collections/{collectionId}/devices/{deviceId}/fwerror | Clear FOTA error |
| FotaApi | createFirmware | POST /span/collections/{collectionId}/firmware | Create firmware |
| FotaApi | deleteFirmware | DELETE /span/collections/{collectionId}/firmware/{imageId} | Delete firmware |
| FotaApi | firmwareUsage | GET /span/collections/{collectionId}/firmware/{imageId}/usage | Firmware usage |
| FotaApi | listFirmware | GET /span/collections/{collectionId}/firmware | List firmware |
| FotaApi | retrieveFirmware | GET /span/collections/{collectionId}/firmware/{imageId} | Retrieve firmware |
| FotaApi | updateFirmware | PATCH /span/collections/{existingCollectionId}/firmware/{imageId} | Update firmware |
| GatewaysApi | createGateway | POST /span/collections/{collectionId}/gateways | Create gateway |
| GatewaysApi | deleteGateway | DELETE /span/collections/{collectionId}/gateways/{gatewayId} | Delete gateway |
| GatewaysApi | gatewayCertificates | GET /span/collections/{collectionId}/gateways/{gatewayId}/certs | Get issued certificate(s) for gateway |
| GatewaysApi | listGateways | GET /span/collections/{collectionId}/gateways | List gateways |
| GatewaysApi | retrieveGateway | GET /span/collections/{collectionId}/gateways/{gatewayId} | Retrieve gateway |
| GatewaysApi | updateGateway | PATCH /span/collections/{existingCollectionId}/gateways/{gatewayId} | Update gateway |
| OutputsApi | createOutput | POST /span/collections/{collectionId}/outputs | Create output |
| OutputsApi | deleteOutput | DELETE /span/collections/{collectionId}/outputs/{outputId} | Delete output |
| OutputsApi | listOutputs | GET /span/collections/{collectionId}/outputs | List outputs |
| OutputsApi | logs | GET /span/collections/{collectionId}/outputs/{outputId}/logs | Output logs |
| OutputsApi | retrieveOutput | GET /span/collections/{collectionId}/outputs/{outputId} | Retrieve output |
| OutputsApi | status | GET /span/collections/{collectionId}/outputs/{outputId}/status | Output status |
| OutputsApi | updateOutput | PATCH /span/collections/{existingCollectionId}/outputs/{outputId} | Update output |
| SpanApi | getSystemInfo | GET /span/system | System information |
- AddDownstreamMessageRequest
- Any
- Blob
- CellularIoTConfig
- CellularIoTMetadata
- CertificateChainResponse
- CertificateInfo
- ClearFirmwareErrorResponse
- CoAPMetadata
- Collection
- CollectionFirmware
- CreateCertificateRequest
- CreateCertificateResponse
- CreateCollectionRequest
- CreateDeviceRequest
- CreateFirmwareRequest
- CreateOutputRequest
- DeleteDownstreamMessageResponse
- Device
- DeviceCertificateResponse
- DeviceConfig
- DeviceMetadata
- Firmware
- FirmwareManagement
- FirmwareMetadata
- FirmwareUsageResponse
- Gateway
- GatewayCIoTConfig
- GatewayCertificateResponse
- GatewayConfig
- GatewayCustomConfig
- GatewayDeviceConfig
- GatewayDeviceMetadata
- GatewayInetConfig
- GatewayMetadata
- GatewayStatus
- GatewayType
- InetMetadata
- InlineObject
- InlineObject1
- ListBlobResponse
- ListCollectionResponse
- ListDataResponse
- ListDevicesResponse
- ListDownstreamMessagesResponse
- ListFirmwareResponse
- ListGatewayResponse
- ListOutputResponse
- ListUpstreamMessagesResponse
- MQTTMetadata
- MessageDownstream
- MessageState
- MessageTransport
- MessageUpstream
- Output
- OutputConfig
- OutputDataMessage
- OutputLogEntry
- OutputLogResponse
- OutputMessageType
- OutputStatusResponse
- OutputType
- RetrieveBlobResponse
- SignCertificateRequest
- SignCertificateResponse
- Status
- SystemInfoResponse
- UDPMetadata
- UpdateCollectionRequest
- UpdateDeviceRequest
- UpdateFirmwareRequest
- UpdateOutputRequest
- VerifyCertificateRequest
- VerifyCertificateResponse
- Type: API key
- API key parameter name: X-API-Token
- Location: HTTP header