Skip to content

Latest commit

 

History

History
178 lines (155 loc) · 12.4 KB

README.md

File metadata and controls

178 lines (155 loc) · 12.4 KB
Raw

Swift5 API client for Span

API for device, collection, output and firmware management

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 5.0.3 pitch-dark-elza
  • Package version:
  • Build package: org.openapitools.codegen.languages.Swift5ClientCodegen For more information, please visit https://lab5e.com

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

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 retrieveCollectionStats GET /span/collections/{collectionId}/stats Retrieve collection statistics
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 retrieveDeviceStats GET /span/collections/{collectionId}/devices/{deviceId}/stats Retrieve device statistics
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 retrieveFirmwareStats GET /span/collections/{collectionId}/firmware/{imageId}/stats Retrieve firmware statistics
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 retrieveGatewayStats GET /span/collections/{collectionId}/gateways/{gatewayId}/stats Retrieve gateway statistics
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 retrieveOutputStats GET /span/collections/{collectionId}/outputs/{outputId}/stats Retrieve output statistics
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

Documentation For Models

Documentation For Authorization

APIToken

  • Type: API key
  • API key parameter name: X-API-Token
  • Location: HTTP header

Author

dev@lab5e.com