Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/lab5e/csharp-spanapi

C#/.NET Span API client
https://github.com/lab5e/csharp-spanapi

Last synced: 11 months ago
JSON representation

C#/.NET Span API client

Awesome Lists containing this project

README 

          
# Com.Lab5e.Span - the C# library for the The Span API



API for device, collection, output and firmware management



This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:



- API version: 5.0.5 contented-jamila

- SDK version: 5.0.5

- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

    For more information, please visit [https://lab5e.com](https://lab5e.com)





## Frameworks supported





## Dependencies



- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later

- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later

- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later

- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later



The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

```

Install-Package RestSharp

Install-Package Newtonsoft.Json

Install-Package JsonSubTypes

Install-Package System.ComponentModel.Annotations

```



NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742).

NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).





## Installation

Run the following command to generate the DLL

- [Mac/Linux] `/bin/sh build.sh`

- [Windows] `build.bat`



Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:

```csharp

using Com.Lab5e.Span.Api;

using Com.Lab5e.Span.Client;

using Com.Lab5e.Span.Model;

```



## Packaging



A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages.



This `.nuspec` uses placeholders from the `.csproj`, so build the `.csproj` directly:



```

nuget pack -Build -OutputDirectory out Com.Lab5e.Span.csproj

```



Then, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual.





## Usage



To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`

```csharp

Configuration c = new Configuration();

System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");

webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;

c.Proxy = webProxy;

```





## Getting Started



```csharp

using System.Collections.Generic;

using System.Diagnostics;

using Com.Lab5e.Span.Api;

using Com.Lab5e.Span.Client;

using Com.Lab5e.Span.Model;



namespace Example

{

    public class Example

    {

        public static void Main()

        {



            Configuration config = new Configuration();

            config.BasePath = "https://api.lab5e.com";

            // Configure API key authorization: APIToken

            config.ApiKey.Add("X-API-Token", "YOUR_API_KEY");

            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed

            // config.ApiKeyPrefix.Add("X-API-Token", "Bearer");



            var apiInstance = new BlobsApi(config);

            var collectionId = "collectionId_example";  // string | 

            var blobId = "blobId_example";  // string | 



            try

            {

                // Remove a blob stored on a collection

                Object result = apiInstance.DeleteBlob(collectionId, blobId);

                Debug.WriteLine(result);

            }

            catch (ApiException e)

            {

                Debug.Print("Exception when calling BlobsApi.DeleteBlob: " + e.Message );

                Debug.Print("Status Code: "+ e.ErrorCode);

                Debug.Print(e.StackTrace);

            }



        }

    }

}

```





## Documentation for API Endpoints



All URIs are relative to *https://api.lab5e.com*



Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*BlobsApi* | [**DeleteBlob**](docs/BlobsApi.md#deleteblob) | **DELETE** /span/collections/{collectionId}/blobs/{blobId} | Remove a blob stored on a collection

*BlobsApi* | [**ListBlobs**](docs/BlobsApi.md#listblobs) | **GET** /span/collections/{collectionId}/blobs | List the blobs for a collection

*CertificatesApi* | [**CreateCertificate**](docs/CertificatesApi.md#createcertificate) | **POST** /span/collections/{collectionId}/certificates/create | Create certificate

*CertificatesApi* | [**RetrieveCertificateChain**](docs/CertificatesApi.md#retrievecertificatechain) | **GET** /span/collections/{collectionId}/certificates | Get certificate chain

*CertificatesApi* | [**SignCertificate**](docs/CertificatesApi.md#signcertificate) | **POST** /span/collections/{collectionId}/certificates/sign | Sign certificate

*CertificatesApi* | [**VerifyCertificate**](docs/CertificatesApi.md#verifycertificate) | **POST** /span/collections/{collectionId}/certificates/verify | Verify certificate

*CollectionsApi* | [**CreateCollection**](docs/CollectionsApi.md#createcollection) | **POST** /span/collections | Create collection

*CollectionsApi* | [**DeleteCollection**](docs/CollectionsApi.md#deletecollection) | **DELETE** /span/collections/{collectionId} | Delete collection

*CollectionsApi* | [**ListCollectionData**](docs/CollectionsApi.md#listcollectiondata) | **GET** /span/collections/{collectionId}/data | Retrieve data from devices

*CollectionsApi* | [**ListCollections**](docs/CollectionsApi.md#listcollections) | **GET** /span/collections | List collections

*CollectionsApi* | [**RetrieveCollection**](docs/CollectionsApi.md#retrievecollection) | **GET** /span/collections/{collectionId} | Retrieve collection

*CollectionsApi* | [**RetrieveCollectionStats**](docs/CollectionsApi.md#retrievecollectionstats) | **GET** /span/collections/{collectionId}/stats | Retrieve collection statistics

*CollectionsApi* | [**UpdateCollection**](docs/CollectionsApi.md#updatecollection) | **PATCH** /span/collections/{collectionId} | Update collection

*DevicesApi* | [**AddDownstreamMessage**](docs/DevicesApi.md#adddownstreammessage) | **POST** /span/collections/{collectionId}/devices/{deviceId}/outbox | Add message to oubox

*DevicesApi* | [**CreateDevice**](docs/DevicesApi.md#createdevice) | **POST** /span/collections/{collectionId}/devices | Create device

*DevicesApi* | [**DeleteDevice**](docs/DevicesApi.md#deletedevice) | **DELETE** /span/collections/{collectionId}/devices/{deviceId} | Remove device.

*DevicesApi* | [**DeleteDownstreamMessage**](docs/DevicesApi.md#deletedownstreammessage) | **DELETE** /span/collections/{collectionId}/devices/{deviceId}/outbox/{messageId} | Delete outgoing message

*DevicesApi* | [**DeviceCertificate**](docs/DevicesApi.md#devicecertificate) | **GET** /span/collections/{collectionId}/devices/{deviceId}/certs | Get issued certificate(s) for device

*DevicesApi* | [**ListDeviceData**](docs/DevicesApi.md#listdevicedata) | **GET** /span/collections/{collectionId}/devices/{deviceId}/data | Retrieve data from device

*DevicesApi* | [**ListDevices**](docs/DevicesApi.md#listdevices) | **GET** /span/collections/{collectionId}/devices | List devices in collection.

*DevicesApi* | [**ListDownstreamMessages**](docs/DevicesApi.md#listdownstreammessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/outbox | List the messages in the outbox

*DevicesApi* | [**ListUpstreamMessages**](docs/DevicesApi.md#listupstreammessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/inbox | List incoming messages

*DevicesApi* | [**RetrieveDevice**](docs/DevicesApi.md#retrievedevice) | **GET** /span/collections/{collectionId}/devices/{deviceId} | Retrieve device

*DevicesApi* | [**RetrieveDeviceStats**](docs/DevicesApi.md#retrievedevicestats) | **GET** /span/collections/{collectionId}/devices/{deviceId}/stats | Retrieve device statistics

*DevicesApi* | [**UpdateDevice**](docs/DevicesApi.md#updatedevice) | **PATCH** /span/collections/{existingCollectionId}/devices/{deviceId} | Update device

*FotaApi* | [**AssignTargetImage**](docs/FotaApi.md#assigntargetimage) | **PATCH** /span/collections/{collectionId}/firmware/labeled/{imageId}/assign | BETA: Assign a target image

*FotaApi* | [**ClearFirmwareError**](docs/FotaApi.md#clearfirmwareerror) | **DELETE** /span/collections/{collectionId}/devices/{deviceId}/fwerror | Clear FOTA error

*FotaApi* | [**CreateFirmware**](docs/FotaApi.md#createfirmware) | **POST** /span/collections/{collectionId}/firmware | Create firmware

*FotaApi* | [**CreateLabeledFirmware**](docs/FotaApi.md#createlabeledfirmware) | **POST** /span/collections/{collectionId}/firmware/labeled | BETA: Create a labeled firmware image

*FotaApi* | [**DeleteFirmware**](docs/FotaApi.md#deletefirmware) | **DELETE** /span/collections/{collectionId}/firmware/{imageId} | Delete firmware

*FotaApi* | [**DeleteLabeledImage**](docs/FotaApi.md#deletelabeledimage) | **DELETE** /span/collections/{collectionId}/firmware/labeled/{imageId} | BETA: Remove a tagged firmware image

*FotaApi* | [**FirmwareUsage**](docs/FotaApi.md#firmwareusage) | **GET** /span/collections/{collectionId}/firmware/{imageId}/usage | Firmware usage

*FotaApi* | [**GetImageState**](docs/FotaApi.md#getimagestate) | **PATCH** /span/collections/{collectionId}/devices/{deviceId}/fotastate | BETA: Get state for a single device

*FotaApi* | [**ListFirmware**](docs/FotaApi.md#listfirmware) | **GET** /span/collections/{collectionId}/firmware | List firmware

*FotaApi* | [**ListImageStates**](docs/FotaApi.md#listimagestates) | **GET** /span/collections/{collectionId}/firmware/labeled/states | BETA: List image assignments plus states

*FotaApi* | [**ListImageVersionHistory**](docs/FotaApi.md#listimageversionhistory) | **PATCH** /span/collections/{collectionId}/devices/{deviceId}/fotalog | BETA: List version history for a single device

*FotaApi* | [**ListLabeledFirmware**](docs/FotaApi.md#listlabeledfirmware) | **GET** /span/collections/{collectionId}/firmware/labeled | BETA: List the labeled firmware images for a collection

*FotaApi* | [**RetrieveFirmware**](docs/FotaApi.md#retrievefirmware) | **GET** /span/collections/{collectionId}/firmware/{imageId} | Retrieve firmware

*FotaApi* | [**RetrieveFirmwareStats**](docs/FotaApi.md#retrievefirmwarestats) | **GET** /span/collections/{collectionId}/firmware/{imageId}/stats | Retrieve firmware statistics

*FotaApi* | [**UpdateFirmware**](docs/FotaApi.md#updatefirmware) | **PATCH** /span/collections/{existingCollectionId}/firmware/{imageId} | Update firmware

*GatewaysApi* | [**CreateGateway**](docs/GatewaysApi.md#creategateway) | **POST** /span/collections/{collectionId}/gateways | Create gateway

*GatewaysApi* | [**DeleteGateway**](docs/GatewaysApi.md#deletegateway) | **DELETE** /span/collections/{collectionId}/gateways/{gatewayId} | Delete gateway

*GatewaysApi* | [**GatewayCertificates**](docs/GatewaysApi.md#gatewaycertificates) | **GET** /span/collections/{collectionId}/gateways/{gatewayId}/certs | Get issued certificate(s) for gateway

*GatewaysApi* | [**ListGateways**](docs/GatewaysApi.md#listgateways) | **GET** /span/collections/{collectionId}/gateways | List gateways

*GatewaysApi* | [**RetrieveGateway**](docs/GatewaysApi.md#retrievegateway) | **GET** /span/collections/{collectionId}/gateways/{gatewayId} | Retrieve gateway

*GatewaysApi* | [**RetrieveGatewayStats**](docs/GatewaysApi.md#retrievegatewaystats) | **GET** /span/collections/{collectionId}/gateways/{gatewayId}/stats | Retrieve gateway statistics

*GatewaysApi* | [**UpdateGateway**](docs/GatewaysApi.md#updategateway) | **PATCH** /span/collections/{existingCollectionId}/gateways/{gatewayId} | Update gateway

*OutputsApi* | [**CreateOutput**](docs/OutputsApi.md#createoutput) | **POST** /span/collections/{collectionId}/outputs | Create output

*OutputsApi* | [**DeleteOutput**](docs/OutputsApi.md#deleteoutput) | **DELETE** /span/collections/{collectionId}/outputs/{outputId} | Delete output

*OutputsApi* | [**ListOutputs**](docs/OutputsApi.md#listoutputs) | **GET** /span/collections/{collectionId}/outputs | List outputs

*OutputsApi* | [**Logs**](docs/OutputsApi.md#logs) | **GET** /span/collections/{collectionId}/outputs/{outputId}/logs | Output logs

*OutputsApi* | [**RetrieveOutput**](docs/OutputsApi.md#retrieveoutput) | **GET** /span/collections/{collectionId}/outputs/{outputId} | Retrieve output

*OutputsApi* | [**RetrieveOutputStats**](docs/OutputsApi.md#retrieveoutputstats) | **GET** /span/collections/{collectionId}/outputs/{outputId}/stats | Retrieve output statistics

*OutputsApi* | [**Status**](docs/OutputsApi.md#status) | **GET** /span/collections/{collectionId}/outputs/{outputId}/status | Output status

*OutputsApi* | [**UpdateOutput**](docs/OutputsApi.md#updateoutput) | **PATCH** /span/collections/{existingCollectionId}/outputs/{outputId} | Update output

*SpanApi* | [**GetSystemInfo**](docs/SpanApi.md#getsysteminfo) | **GET** /span/system | System information





## Documentation for Models



 - [Model.ActivityEvent](docs/ActivityEvent.md)

 - [Model.AddDownstreamMessageBody](docs/AddDownstreamMessageBody.md)

 - [Model.Any](docs/Any.md)

 - [Model.AssignTargetImageResponse](docs/AssignTargetImageResponse.md)

 - [Model.Blob](docs/Blob.md)

 - [Model.BlobStats](docs/BlobStats.md)

 - [Model.CellularIoTConfig](docs/CellularIoTConfig.md)

 - [Model.CellularIoTMetadata](docs/CellularIoTMetadata.md)

 - [Model.CertificateChainResponse](docs/CertificateChainResponse.md)

 - [Model.CertificateInfo](docs/CertificateInfo.md)

 - [Model.ClearFirmwareErrorResponse](docs/ClearFirmwareErrorResponse.md)

 - [Model.CoAPMetadata](docs/CoAPMetadata.md)

 - [Model.Collection](docs/Collection.md)

 - [Model.CollectionFirmware](docs/CollectionFirmware.md)

 - [Model.CollectionStats](docs/CollectionStats.md)

 - [Model.CreateCertificateBody](docs/CreateCertificateBody.md)

 - [Model.CreateCertificateResponse](docs/CreateCertificateResponse.md)

 - [Model.CreateCollectionRequest](docs/CreateCollectionRequest.md)

 - [Model.CreateDeviceBody](docs/CreateDeviceBody.md)

 - [Model.CreateFirmwareBody](docs/CreateFirmwareBody.md)

 - [Model.CreateGatewayBody](docs/CreateGatewayBody.md)

 - [Model.CreateLabeledFirmwareResponse](docs/CreateLabeledFirmwareResponse.md)

 - [Model.CreateOutputBody](docs/CreateOutputBody.md)

 - [Model.DeleteDownstreamMessageResponse](docs/DeleteDownstreamMessageResponse.md)

 - [Model.Device](docs/Device.md)

 - [Model.DeviceCertificateResponse](docs/DeviceCertificateResponse.md)

 - [Model.DeviceConfig](docs/DeviceConfig.md)

 - [Model.DeviceImageState](docs/DeviceImageState.md)

 - [Model.DeviceMetadata](docs/DeviceMetadata.md)

 - [Model.DeviceStats](docs/DeviceStats.md)

 - [Model.Firmware](docs/Firmware.md)

 - [Model.FirmwareManagement](docs/FirmwareManagement.md)

 - [Model.FirmwareMetadata](docs/FirmwareMetadata.md)

 - [Model.FirmwareStats](docs/FirmwareStats.md)

 - [Model.FirmwareUsageResponse](docs/FirmwareUsageResponse.md)

 - [Model.Gateway](docs/Gateway.md)

 - [Model.GatewayCIoTConfig](docs/GatewayCIoTConfig.md)

 - [Model.GatewayCertificateResponse](docs/GatewayCertificateResponse.md)

 - [Model.GatewayConfig](docs/GatewayConfig.md)

 - [Model.GatewayCustomConfig](docs/GatewayCustomConfig.md)

 - [Model.GatewayDeviceConfig](docs/GatewayDeviceConfig.md)

 - [Model.GatewayDeviceMetadata](docs/GatewayDeviceMetadata.md)

 - [Model.GatewayInetConfig](docs/GatewayInetConfig.md)

 - [Model.GatewayMetadata](docs/GatewayMetadata.md)

 - [Model.GatewayStats](docs/GatewayStats.md)

 - [Model.GatewayStatus](docs/GatewayStatus.md)

 - [Model.GatewayType](docs/GatewayType.md)

 - [Model.GetImageStateResponse](docs/GetImageStateResponse.md)

 - [Model.ImageState](docs/ImageState.md)

 - [Model.ImageVersionEntry](docs/ImageVersionEntry.md)

 - [Model.InetMetadata](docs/InetMetadata.md)

 - [Model.LabeledFirmware](docs/LabeledFirmware.md)

 - [Model.ListBlobResponse](docs/ListBlobResponse.md)

 - [Model.ListCollectionResponse](docs/ListCollectionResponse.md)

 - [Model.ListDataResponse](docs/ListDataResponse.md)

 - [Model.ListDevicesResponse](docs/ListDevicesResponse.md)

 - [Model.ListDownstreamMessagesResponse](docs/ListDownstreamMessagesResponse.md)

 - [Model.ListFirmwareResponse](docs/ListFirmwareResponse.md)

 - [Model.ListGatewayResponse](docs/ListGatewayResponse.md)

 - [Model.ListImageStatesResponse](docs/ListImageStatesResponse.md)

 - [Model.ListImageVersionHistoryResponse](docs/ListImageVersionHistoryResponse.md)

 - [Model.ListLabeledFirmwareResponse](docs/ListLabeledFirmwareResponse.md)

 - [Model.ListOutputResponse](docs/ListOutputResponse.md)

 - [Model.ListUpstreamMessagesResponse](docs/ListUpstreamMessagesResponse.md)

 - [Model.MQTTMetadata](docs/MQTTMetadata.md)

 - [Model.MessageDownstream](docs/MessageDownstream.md)

 - [Model.MessageState](docs/MessageState.md)

 - [Model.MessageTransport](docs/MessageTransport.md)

 - [Model.MessageUpstream](docs/MessageUpstream.md)

 - [Model.Output](docs/Output.md)

 - [Model.OutputConfig](docs/OutputConfig.md)

 - [Model.OutputDataMessage](docs/OutputDataMessage.md)

 - [Model.OutputLogEntry](docs/OutputLogEntry.md)

 - [Model.OutputLogResponse](docs/OutputLogResponse.md)

 - [Model.OutputMessageType](docs/OutputMessageType.md)

 - [Model.OutputStats](docs/OutputStats.md)

 - [Model.OutputStatusResponse](docs/OutputStatusResponse.md)

 - [Model.OutputType](docs/OutputType.md)

 - [Model.RetrieveBlobResponse](docs/RetrieveBlobResponse.md)

 - [Model.RpcStatus](docs/RpcStatus.md)

 - [Model.SignCertificateBody](docs/SignCertificateBody.md)

 - [Model.SignCertificateResponse](docs/SignCertificateResponse.md)

 - [Model.SystemInfoResponse](docs/SystemInfoResponse.md)

 - [Model.UDPMetadata](docs/UDPMetadata.md)

 - [Model.UpdateCollectionBody](docs/UpdateCollectionBody.md)

 - [Model.UpdateDeviceBody](docs/UpdateDeviceBody.md)

 - [Model.UpdateFirmwareBody](docs/UpdateFirmwareBody.md)

 - [Model.UpdateGatewayBody](docs/UpdateGatewayBody.md)

 - [Model.UpdateOutputBody](docs/UpdateOutputBody.md)

 - [Model.VerifyCertificateBody](docs/VerifyCertificateBody.md)

 - [Model.VerifyCertificateResponse](docs/VerifyCertificateResponse.md)





## Documentation for Authorization





### APIToken



- **Type**: API key

- **API key parameter name**: X-API-Token

- **Location**: HTTP header