{"id":25830867,"url":"https://github.com/lab5e/dart-spanapi","last_synced_at":"2026-05-16T05:03:09.747Z","repository":{"id":97095324,"uuid":"359788254","full_name":"lab5e/dart-spanapi","owner":"lab5e","description":"Dart Span API client","archived":false,"fork":false,"pushed_at":"2024-08-28T14:20:46.000Z","size":459,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-28T15:48:13.887Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lab5e.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-20T11:19:17.000Z","updated_at":"2024-08-28T14:20:49.000Z","dependencies_parsed_at":"2024-08-27T13:07:01.751Z","dependency_job_id":null,"html_url":"https://github.com/lab5e/dart-spanapi","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lab5e%2Fdart-spanapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lab5e%2Fdart-spanapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lab5e%2Fdart-spanapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lab5e%2Fdart-spanapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lab5e","download_url":"https://codeload.github.com/lab5e/dart-spanapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241212335,"owners_count":19927924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-28T19:34:20.613Z","updated_at":"2026-05-16T05:03:04.716Z","avatar_url":"https://github.com/lab5e.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spanapi\nAPI for device, collection, output and firmware management\n\nThis Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 4.4.2 nonviolent-adelbert\n- Build package: org.openapitools.codegen.languages.DartClientCodegen\nFor more information, please visit [https://lab5e.com](https://lab5e.com)\n\n## Requirements\n\nDart 2.0 or later\n\n## Installation \u0026 Usage\n\n### Github\nIf this Dart package is published to Github, add the following dependency to your pubspec.yaml\n```\ndependencies:\n  spanapi:\n    git: https://github.com/lab5e/dart-spanapi.git\n```\n\n### Local\nTo use the package in your local drive, add the following dependency to your pubspec.yaml\n```\ndependencies:\n  spanapi:\n    path: /path/to/spanapi\n```\n\n## Tests\n\nTODO\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```dart\nimport 'package:spanapi/api.dart';\n\n// TODO Configure API key authorization: APIToken\n//defaultApiClient.getAuthentication\u003cApiKeyAuth\u003e('APIToken').apiKey = 'YOUR_API_KEY';\n// uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n//defaultApiClient.getAuthentication\u003cApiKeyAuth\u003e('APIToken').apiKeyPrefix = 'Bearer';\n\nfinal api_instance = BlobsApi();\nfinal collectionId = collectionId_example; // String | \nfinal blobId = blobId_example; // String | \n\ntry {\n    final result = api_instance.deleteBlob(collectionId, blobId);\n    print(result);\n} catch (e) {\n    print('Exception when calling BlobsApi-\u003edeleteBlob: $e\\n');\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.lab5e.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BlobsApi* | [**deleteBlob**](doc//BlobsApi.md#deleteblob) | **DELETE** /span/collections/{collectionId}/blobs/{blobId} | Remove a blob stored on a collection\n*BlobsApi* | [**listBlobs**](doc//BlobsApi.md#listblobs) | **GET** /span/collections/{collectionId}/blobs | List the blobs for a collection\n*CertificatesApi* | [**createCertificate**](doc//CertificatesApi.md#createcertificate) | **POST** /span/collections/{collectionId}/certificates/create | Create certificate\n*CertificatesApi* | [**retrieveCertificateChain**](doc//CertificatesApi.md#retrievecertificatechain) | **GET** /span/collections/{collectionId}/certificates | Get certificate chain\n*CertificatesApi* | [**signCertificate**](doc//CertificatesApi.md#signcertificate) | **POST** /span/collections/{collectionId}/certificates/sign | Sign certificate\n*CertificatesApi* | [**verifyCertificate**](doc//CertificatesApi.md#verifycertificate) | **POST** /span/collections/{collectionId}/certificates/verify | Verify certificate\n*CollectionsApi* | [**createCollection**](doc//CollectionsApi.md#createcollection) | **POST** /span/collections | Create collection\n*CollectionsApi* | [**deleteCollection**](doc//CollectionsApi.md#deletecollection) | **DELETE** /span/collections/{collectionId} | Delete collection\n*CollectionsApi* | [**listCollectionData**](doc//CollectionsApi.md#listcollectiondata) | **GET** /span/collections/{collectionId}/data | Retrieve data from devices\n*CollectionsApi* | [**listCollections**](doc//CollectionsApi.md#listcollections) | **GET** /span/collections | List collections\n*CollectionsApi* | [**retrieveCollection**](doc//CollectionsApi.md#retrievecollection) | **GET** /span/collections/{collectionId} | Retrieve collection\n*CollectionsApi* | [**updateCollection**](doc//CollectionsApi.md#updatecollection) | **PATCH** /span/collections/{collectionId} | Update collection\n*DevicesApi* | [**addDownstreamMessage**](doc//DevicesApi.md#adddownstreammessage) | **POST** /span/collections/{collectionId}/devices/{deviceId}/outbox | Add message to oubox\n*DevicesApi* | [**createDevice**](doc//DevicesApi.md#createdevice) | **POST** /span/collections/{collectionId}/devices | Create device\n*DevicesApi* | [**deleteDevice**](doc//DevicesApi.md#deletedevice) | **DELETE** /span/collections/{collectionId}/devices/{deviceId} | Remove device.\n*DevicesApi* | [**deleteDownstreamMessage**](doc//DevicesApi.md#deletedownstreammessage) | **DELETE** /span/collections/{collectionId}/devices/{deviceId}/outbox/{messageId} | Delete outgoing message\n*DevicesApi* | [**deviceCertificate**](doc//DevicesApi.md#devicecertificate) | **GET** /span/collections/{collectionId}/devices/{deviceId}/certs | Get issued certificate(s) for device\n*DevicesApi* | [**listDeviceData**](doc//DevicesApi.md#listdevicedata) | **GET** /span/collections/{collectionId}/devices/{deviceId}/data | Retrieve data from device\n*DevicesApi* | [**listDevices**](doc//DevicesApi.md#listdevices) | **GET** /span/collections/{collectionId}/devices | List devices in collection.\n*DevicesApi* | [**listDownstreamMessages**](doc//DevicesApi.md#listdownstreammessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/outbox | List the messages in the outbox\n*DevicesApi* | [**listUpstreamMessages**](doc//DevicesApi.md#listupstreammessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/inbox | List incoming messages\n*DevicesApi* | [**retrieveDevice**](doc//DevicesApi.md#retrievedevice) | **GET** /span/collections/{collectionId}/devices/{deviceId} | Retrieve device\n*DevicesApi* | [**updateDevice**](doc//DevicesApi.md#updatedevice) | **PATCH** /span/collections/{existingCollectionId}/devices/{deviceId} | Update device\n*FotaApi* | [**clearFirmwareError**](doc//FotaApi.md#clearfirmwareerror) | **DELETE** /span/collections/{collectionId}/devices/{deviceId}/fwerror | Clear FOTA error\n*FotaApi* | [**createFirmware**](doc//FotaApi.md#createfirmware) | **POST** /span/collections/{collectionId}/firmware | Create firmware\n*FotaApi* | [**deleteFirmware**](doc//FotaApi.md#deletefirmware) | **DELETE** /span/collections/{collectionId}/firmware/{imageId} | Delete firmware\n*FotaApi* | [**firmwareUsage**](doc//FotaApi.md#firmwareusage) | **GET** /span/collections/{collectionId}/firmware/{imageId}/usage | Firmware usage\n*FotaApi* | [**listFirmware**](doc//FotaApi.md#listfirmware) | **GET** /span/collections/{collectionId}/firmware | List firmware\n*FotaApi* | [**retrieveFirmware**](doc//FotaApi.md#retrievefirmware) | **GET** /span/collections/{collectionId}/firmware/{imageId} | Retrieve firmware\n*FotaApi* | [**updateFirmware**](doc//FotaApi.md#updatefirmware) | **PATCH** /span/collections/{existingCollectionId}/firmware/{imageId} | Update firmware\n*GatewaysApi* | [**createGateway**](doc//GatewaysApi.md#creategateway) | **POST** /span/collections/{collectionId}/gateways | Create gateway\n*GatewaysApi* | [**deleteGateway**](doc//GatewaysApi.md#deletegateway) | **DELETE** /span/collections/{collectionId}/gateways/{gatewayId} | Delete gateway\n*GatewaysApi* | [**gatewayCertificates**](doc//GatewaysApi.md#gatewaycertificates) | **GET** /span/collections/{collectionId}/gateways/{gatewayId}/certs | Get issued certificate(s) for gateway\n*GatewaysApi* | [**listGateways**](doc//GatewaysApi.md#listgateways) | **GET** /span/collections/{collectionId}/gateways | List gateways\n*GatewaysApi* | [**retrieveGateway**](doc//GatewaysApi.md#retrievegateway) | **GET** /span/collections/{collectionId}/gateways/{gatewayId} | Retrieve gateway\n*GatewaysApi* | [**updateGateway**](doc//GatewaysApi.md#updategateway) | **PATCH** /span/collections/{existingCollectionId}/gateways/{gatewayId} | Update gateway\n*OutputsApi* | [**createOutput**](doc//OutputsApi.md#createoutput) | **POST** /span/collections/{collectionId}/outputs | Create output\n*OutputsApi* | [**deleteOutput**](doc//OutputsApi.md#deleteoutput) | **DELETE** /span/collections/{collectionId}/outputs/{outputId} | Delete output\n*OutputsApi* | [**listOutputs**](doc//OutputsApi.md#listoutputs) | **GET** /span/collections/{collectionId}/outputs | List outputs\n*OutputsApi* | [**logs**](doc//OutputsApi.md#logs) | **GET** /span/collections/{collectionId}/outputs/{outputId}/logs | Output logs\n*OutputsApi* | [**retrieveOutput**](doc//OutputsApi.md#retrieveoutput) | **GET** /span/collections/{collectionId}/outputs/{outputId} | Retrieve output\n*OutputsApi* | [**status**](doc//OutputsApi.md#status) | **GET** /span/collections/{collectionId}/outputs/{outputId}/status | Output status\n*OutputsApi* | [**updateOutput**](doc//OutputsApi.md#updateoutput) | **PATCH** /span/collections/{existingCollectionId}/outputs/{outputId} | Update output\n*SpanApi* | [**getSystemInfo**](doc//SpanApi.md#getsysteminfo) | **GET** /span/system | System information\n\n\n## Documentation For Models\n\n - [AddDownstreamMessageRequest](doc//AddDownstreamMessageRequest.md)\n - [Any](doc//Any.md)\n - [Blob](doc//Blob.md)\n - [CellularIoTConfig](doc//CellularIoTConfig.md)\n - [CellularIoTMetadata](doc//CellularIoTMetadata.md)\n - [CertificateChainResponse](doc//CertificateChainResponse.md)\n - [CertificateInfo](doc//CertificateInfo.md)\n - [ClearFirmwareErrorResponse](doc//ClearFirmwareErrorResponse.md)\n - [CoAPMetadata](doc//CoAPMetadata.md)\n - [Collection](doc//Collection.md)\n - [CollectionFirmware](doc//CollectionFirmware.md)\n - [CreateCertificateRequest](doc//CreateCertificateRequest.md)\n - [CreateCertificateResponse](doc//CreateCertificateResponse.md)\n - [CreateCollectionRequest](doc//CreateCollectionRequest.md)\n - [CreateDeviceRequest](doc//CreateDeviceRequest.md)\n - [CreateFirmwareRequest](doc//CreateFirmwareRequest.md)\n - [CreateOutputRequest](doc//CreateOutputRequest.md)\n - [DeleteDownstreamMessageResponse](doc//DeleteDownstreamMessageResponse.md)\n - [Device](doc//Device.md)\n - [DeviceCertificateResponse](doc//DeviceCertificateResponse.md)\n - [DeviceConfig](doc//DeviceConfig.md)\n - [DeviceMetadata](doc//DeviceMetadata.md)\n - [Firmware](doc//Firmware.md)\n - [FirmwareManagement](doc//FirmwareManagement.md)\n - [FirmwareMetadata](doc//FirmwareMetadata.md)\n - [FirmwareUsageResponse](doc//FirmwareUsageResponse.md)\n - [Gateway](doc//Gateway.md)\n - [GatewayCIoTConfig](doc//GatewayCIoTConfig.md)\n - [GatewayCertificateResponse](doc//GatewayCertificateResponse.md)\n - [GatewayConfig](doc//GatewayConfig.md)\n - [GatewayCustomConfig](doc//GatewayCustomConfig.md)\n - [GatewayDeviceConfig](doc//GatewayDeviceConfig.md)\n - [GatewayDeviceMetadata](doc//GatewayDeviceMetadata.md)\n - [GatewayInetConfig](doc//GatewayInetConfig.md)\n - [GatewayMetadata](doc//GatewayMetadata.md)\n - [GatewayStatus](doc//GatewayStatus.md)\n - [GatewayType](doc//GatewayType.md)\n - [InetMetadata](doc//InetMetadata.md)\n - [InlineObject](doc//InlineObject.md)\n - [InlineObject1](doc//InlineObject1.md)\n - [ListBlobResponse](doc//ListBlobResponse.md)\n - [ListCollectionResponse](doc//ListCollectionResponse.md)\n - [ListDataResponse](doc//ListDataResponse.md)\n - [ListDevicesResponse](doc//ListDevicesResponse.md)\n - [ListDownstreamMessagesResponse](doc//ListDownstreamMessagesResponse.md)\n - [ListFirmwareResponse](doc//ListFirmwareResponse.md)\n - [ListGatewayResponse](doc//ListGatewayResponse.md)\n - [ListOutputResponse](doc//ListOutputResponse.md)\n - [ListUpstreamMessagesResponse](doc//ListUpstreamMessagesResponse.md)\n - [MQTTMetadata](doc//MQTTMetadata.md)\n - [MessageDownstream](doc//MessageDownstream.md)\n - [MessageState](doc//MessageState.md)\n - [MessageTransport](doc//MessageTransport.md)\n - [MessageUpstream](doc//MessageUpstream.md)\n - [Output](doc//Output.md)\n - [OutputConfig](doc//OutputConfig.md)\n - [OutputDataMessage](doc//OutputDataMessage.md)\n - [OutputLogEntry](doc//OutputLogEntry.md)\n - [OutputLogResponse](doc//OutputLogResponse.md)\n - [OutputMessageType](doc//OutputMessageType.md)\n - [OutputStatusResponse](doc//OutputStatusResponse.md)\n - [OutputType](doc//OutputType.md)\n - [RetrieveBlobResponse](doc//RetrieveBlobResponse.md)\n - [SignCertificateRequest](doc//SignCertificateRequest.md)\n - [SignCertificateResponse](doc//SignCertificateResponse.md)\n - [Status](doc//Status.md)\n - [SystemInfoResponse](doc//SystemInfoResponse.md)\n - [UDPMetadata](doc//UDPMetadata.md)\n - [UpdateCollectionRequest](doc//UpdateCollectionRequest.md)\n - [UpdateDeviceRequest](doc//UpdateDeviceRequest.md)\n - [UpdateFirmwareRequest](doc//UpdateFirmwareRequest.md)\n - [UpdateOutputRequest](doc//UpdateOutputRequest.md)\n - [VerifyCertificateRequest](doc//VerifyCertificateRequest.md)\n - [VerifyCertificateResponse](doc//VerifyCertificateResponse.md)\n\n\n## Documentation For Authorization\n\n\n## APIToken\n\n- **Type**: API key\n- **API key parameter name**: X-API-Token\n- **Location**: HTTP header\n\n\n## Author\n\ndev@lab5e.com\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flab5e%2Fdart-spanapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flab5e%2Fdart-spanapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flab5e%2Fdart-spanapi/lists"}