Skip to content

Commit 45c5478

Browse files
author
Lab5e Release Bot
committed
Span release 4.6.0
1 parent dd0d036 commit 45c5478

File tree

207 files changed

+4310
-268
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

207 files changed

+4310
-268
lines changed

‎api/openapi.yaml

Lines changed: 482 additions & 4 deletions
Large diffs are not rendered by default.

‎build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apply plugin: 'java'
44
apply plugin: 'com.diffplug.spotless'
55

66
group = 'com.lab5e'
7-
version = '4.5.0'
7+
version = '4.6.0'
88

99
buildscript {
1010
repositories {

‎build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "com.lab5e",
44
name := "span-java-client",
5-
version := "4.5.0",
5+
version := "4.6.0",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

‎docs/BlobStats.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# BlobStats
4+
5+
Statistics for a single blob
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**blobBytesMb** | **Float** | | [optional] |
12+
13+
14+

‎docs/CollectionStats.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
3+
# CollectionStats
4+
5+
This is statistics for an collection.
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**deviceCount** | **Integer** | | [optional] |
12+
|**outputCount** | **Integer** | | [optional] |
13+
|**firmwareCount** | **Integer** | | [optional] |
14+
|**blobCount** | **Integer** | | [optional] |
15+
|**gatewayCount** | **Integer** | | [optional] |
16+
|**devices** | [**DeviceStats**](DeviceStats.md) | | [optional] |
17+
|**outputs** | [**OutputStats**](OutputStats.md) | | [optional] |
18+
|**firmware** | [**FirmwareStats**](FirmwareStats.md) | | [optional] |
19+
|**blobs** | [**BlobStats**](BlobStats.md) | | [optional] |
20+
|**gateways** | [**GatewayStats**](GatewayStats.md) | | [optional] |
21+
22+
23+

‎docs/CollectionsApi.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.lab5e.com*
99
| [**listCollectionData**](CollectionsApi.md#listCollectionData) | **GET** /span/collections/{collectionId}/data | Retrieve data from devices |
1010
| [**listCollections**](CollectionsApi.md#listCollections) | **GET** /span/collections | List collections |
1111
| [**retrieveCollection**](CollectionsApi.md#retrieveCollection) | **GET** /span/collections/{collectionId} | Retrieve collection |
12+
| [**retrieveCollectionStats**](CollectionsApi.md#retrieveCollectionStats) | **GET** /span/collections/{collectionId}/stats | Retrieve collection statistics |
1213
| [**updateCollection**](CollectionsApi.md#updateCollection) | **PATCH** /span/collections/{collectionId} | Update collection |
1314

1415

@@ -400,6 +401,82 @@ public class Example {
400401
| **500** | I'm sorry. We are broken | - |
401402
| **0** | An unexpected error response. | - |
402403

404+
<a name="retrieveCollectionStats"></a>
405+
# **retrieveCollectionStats**
406+
> CollectionStats retrieveCollectionStats(collectionId)
407+
408+
Retrieve collection statistics
409+
410+
Retrieve statistics for the collection. This is the aggregated metrics for devices, outputs, firmware images, blobs and gateways in the collection
411+
412+
### Example
413+
```java
414+
// Import classes:
415+
import com.lab5e.ApiClient;
416+
import com.lab5e.ApiException;
417+
import com.lab5e.Configuration;
418+
import com.lab5e.auth.*;
419+
import com.lab5e.models.*;
420+
import com.lab5e.span.CollectionsApi;
421+
422+
public class Example {
423+
public static void main(String[] args) {
424+
ApiClient defaultClient = Configuration.getDefaultApiClient();
425+
defaultClient.setBasePath("https://api.lab5e.com");
426+
427+
// Configure API key authorization: APIToken
428+
ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
429+
APIToken.setApiKey("YOUR API KEY");
430+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
431+
//APIToken.setApiKeyPrefix("Token");
432+
433+
CollectionsApi apiInstance = new CollectionsApi(defaultClient);
434+
String collectionId = "collectionId_example"; // String | The collection ID of the collection you are requesting
435+
try {
436+
CollectionStats result = apiInstance.retrieveCollectionStats(collectionId);
437+
System.out.println(result);
438+
} catch (ApiException e) {
439+
System.err.println("Exception when calling CollectionsApi#retrieveCollectionStats");
440+
System.err.println("Status code: " + e.getCode());
441+
System.err.println("Reason: " + e.getResponseBody());
442+
System.err.println("Response headers: " + e.getResponseHeaders());
443+
e.printStackTrace();
444+
}
445+
}
446+
}
447+
```
448+
449+
### Parameters
450+
451+
| Name | Type | Description | Notes |
452+
|------------- | ------------- | ------------- | -------------|
453+
| **collectionId** | **String**| The collection ID of the collection you are requesting | |
454+
455+
### Return type
456+
457+
[**CollectionStats**](CollectionStats.md)
458+
459+
### Authorization
460+
461+
[APIToken](../README.md#APIToken)
462+
463+
### HTTP request headers
464+
465+
- **Content-Type**: Not defined
466+
- **Accept**: application/json
467+
468+
### HTTP response details
469+
| Status code | Description | Response headers |
470+
|-------------|-------------|------------------|
471+
| **200** | A successful response. | - |
472+
| **201** | It&#39;s created. | - |
473+
| **400** | The request has an error. | - |
474+
| **401** | You can&#39;t touch this | - |
475+
| **404** | Couldn&#39;t find the resource. | - |
476+
| **409** | There&#39;s a resource conflict here. | - |
477+
| **500** | I&#39;m sorry. We are broken | - |
478+
| **0** | An unexpected error response. | - |
479+
403480
<a name="updateCollection"></a>
404481
# **updateCollection**
405482
> Collection updateCollection(collectionId, body)

‎docs/DeviceStats.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
3+
# DeviceStats
4+
5+
This is the statistics for a single device
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**bytesUpstreamMb** | **Float** | | [optional] |
12+
|**bytesDownstreamMb** | **Float** | | [optional] |
13+
|**messagesUpstream** | **Integer** | | [optional] |
14+
|**messagesDownstream** | **Integer** | | [optional] |
15+
|**sessionCount** | **Integer** | | [optional] |
16+
17+
18+

‎docs/DevicesApi.md

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ All URIs are relative to *https://api.lab5e.com*
1414
| [**listDownstreamMessages**](DevicesApi.md#listDownstreamMessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/outbox | List the messages in the outbox |
1515
| [**listUpstreamMessages**](DevicesApi.md#listUpstreamMessages) | **GET** /span/collections/{collectionId}/devices/{deviceId}/inbox | List incoming messages |
1616
| [**retrieveDevice**](DevicesApi.md#retrieveDevice) | **GET** /span/collections/{collectionId}/devices/{deviceId} | Retrieve device |
17+
| [**retrieveDeviceStats**](DevicesApi.md#retrieveDeviceStats) | **GET** /span/collections/{collectionId}/devices/{deviceId}/stats | Retrieve device statistics |
1718
| [**updateDevice**](DevicesApi.md#updateDevice) | **PATCH** /span/collections/{existingCollectionId}/devices/{deviceId} | Update device |
1819

1920

@@ -766,7 +767,7 @@ public class Example {
766767

767768
DevicesApi apiInstance = new DevicesApi(defaultClient);
768769
String collectionId = "collectionId_example"; // String | This is the containing collection
769-
String deviceId = "deviceId_example"; // String | The device ID is assigned by the backend.
770+
String deviceId = "deviceId_example"; // String | The device identifier
770771
try {
771772
Device result = apiInstance.retrieveDevice(collectionId, deviceId);
772773
System.out.println(result);
@@ -786,7 +787,7 @@ public class Example {
786787
| Name | Type | Description | Notes |
787788
|------------- | ------------- | ------------- | -------------|
788789
| **collectionId** | **String**| This is the containing collection | |
789-
| **deviceId** | **String**| The device ID is assigned by the backend. | |
790+
| **deviceId** | **String**| The device identifier | |
790791

791792
### Return type
792793

@@ -813,6 +814,82 @@ public class Example {
813814
| **500** | I&#39;m sorry. We are broken | - |
814815
| **0** | An unexpected error response. | - |
815816

817+
<a name="retrieveDeviceStats"></a>
818+
# **retrieveDeviceStats**
819+
> DeviceStats retrieveDeviceStats(collectionId, deviceId)
820+
821+
Retrieve device statistics
822+
823+
### Example
824+
```java
825+
// Import classes:
826+
import com.lab5e.ApiClient;
827+
import com.lab5e.ApiException;
828+
import com.lab5e.Configuration;
829+
import com.lab5e.auth.*;
830+
import com.lab5e.models.*;
831+
import com.lab5e.span.DevicesApi;
832+
833+
public class Example {
834+
public static void main(String[] args) {
835+
ApiClient defaultClient = Configuration.getDefaultApiClient();
836+
defaultClient.setBasePath("https://api.lab5e.com");
837+
838+
// Configure API key authorization: APIToken
839+
ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
840+
APIToken.setApiKey("YOUR API KEY");
841+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
842+
//APIToken.setApiKeyPrefix("Token");
843+
844+
DevicesApi apiInstance = new DevicesApi(defaultClient);
845+
String collectionId = "collectionId_example"; // String | This is the containing collection
846+
String deviceId = "deviceId_example"; // String | The device identifier
847+
try {
848+
DeviceStats result = apiInstance.retrieveDeviceStats(collectionId, deviceId);
849+
System.out.println(result);
850+
} catch (ApiException e) {
851+
System.err.println("Exception when calling DevicesApi#retrieveDeviceStats");
852+
System.err.println("Status code: " + e.getCode());
853+
System.err.println("Reason: " + e.getResponseBody());
854+
System.err.println("Response headers: " + e.getResponseHeaders());
855+
e.printStackTrace();
856+
}
857+
}
858+
}
859+
```
860+
861+
### Parameters
862+
863+
| Name | Type | Description | Notes |
864+
|------------- | ------------- | ------------- | -------------|
865+
| **collectionId** | **String**| This is the containing collection | |
866+
| **deviceId** | **String**| The device identifier | |
867+
868+
### Return type
869+
870+
[**DeviceStats**](DeviceStats.md)
871+
872+
### Authorization
873+
874+
[APIToken](../README.md#APIToken)
875+
876+
### HTTP request headers
877+
878+
- **Content-Type**: Not defined
879+
- **Accept**: application/json
880+
881+
### HTTP response details
882+
| Status code | Description | Response headers |
883+
|-------------|-------------|------------------|
884+
| **200** | A successful response. | - |
885+
| **201** | It&#39;s created. | - |
886+
| **400** | The request has an error. | - |
887+
| **401** | You can&#39;t touch this | - |
888+
| **404** | Couldn&#39;t find the resource. | - |
889+
| **409** | There&#39;s a resource conflict here. | - |
890+
| **500** | I&#39;m sorry. We are broken | - |
891+
| **0** | An unexpected error response. | - |
892+
816893
<a name="updateDevice"></a>
817894
# **updateDevice**
818895
> Device updateDevice(existingCollectionId, deviceId, body)

‎docs/FirmwareStats.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# FirmwareStats
4+
5+
Statistics for a single firmware image
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**firmwareImageSize** | **Integer** | | [optional] |
12+
13+
14+

‎docs/FotaApi.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.lab5e.com*
1010
| [**firmwareUsage**](FotaApi.md#firmwareUsage) | **GET** /span/collections/{collectionId}/firmware/{imageId}/usage | Firmware usage |
1111
| [**listFirmware**](FotaApi.md#listFirmware) | **GET** /span/collections/{collectionId}/firmware | List firmware |
1212
| [**retrieveFirmware**](FotaApi.md#retrieveFirmware) | **GET** /span/collections/{collectionId}/firmware/{imageId} | Retrieve firmware |
13+
| [**retrieveFirmwareStats**](FotaApi.md#retrieveFirmwareStats) | **GET** /span/collections/{collectionId}/firmware/{imageId}/stats | Retrieve firmware statistics |
1314
| [**updateFirmware**](FotaApi.md#updateFirmware) | **PATCH** /span/collections/{existingCollectionId}/firmware/{imageId} | Update firmware |
1415

1516

@@ -469,6 +470,82 @@ public class Example {
469470
| **500** | I&#39;m sorry. We are broken | - |
470471
| **0** | An unexpected error response. | - |
471472

473+
<a name="retrieveFirmwareStats"></a>
474+
# **retrieveFirmwareStats**
475+
> FirmwareStats retrieveFirmwareStats(collectionId, imageId)
476+
477+
Retrieve firmware statistics
478+
479+
### Example
480+
```java
481+
// Import classes:
482+
import com.lab5e.ApiClient;
483+
import com.lab5e.ApiException;
484+
import com.lab5e.Configuration;
485+
import com.lab5e.auth.*;
486+
import com.lab5e.models.*;
487+
import com.lab5e.span.FotaApi;
488+
489+
public class Example {
490+
public static void main(String[] args) {
491+
ApiClient defaultClient = Configuration.getDefaultApiClient();
492+
defaultClient.setBasePath("https://api.lab5e.com");
493+
494+
// Configure API key authorization: APIToken
495+
ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
496+
APIToken.setApiKey("YOUR API KEY");
497+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
498+
//APIToken.setApiKeyPrefix("Token");
499+
500+
FotaApi apiInstance = new FotaApi(defaultClient);
501+
String collectionId = "collectionId_example"; // String |
502+
String imageId = "imageId_example"; // String |
503+
try {
504+
FirmwareStats result = apiInstance.retrieveFirmwareStats(collectionId, imageId);
505+
System.out.println(result);
506+
} catch (ApiException e) {
507+
System.err.println("Exception when calling FotaApi#retrieveFirmwareStats");
508+
System.err.println("Status code: " + e.getCode());
509+
System.err.println("Reason: " + e.getResponseBody());
510+
System.err.println("Response headers: " + e.getResponseHeaders());
511+
e.printStackTrace();
512+
}
513+
}
514+
}
515+
```
516+
517+
### Parameters
518+
519+
| Name | Type | Description | Notes |
520+
|------------- | ------------- | ------------- | -------------|
521+
| **collectionId** | **String**| | |
522+
| **imageId** | **String**| | |
523+
524+
### Return type
525+
526+
[**FirmwareStats**](FirmwareStats.md)
527+
528+
### Authorization
529+
530+
[APIToken](../README.md#APIToken)
531+
532+
### HTTP request headers
533+
534+
- **Content-Type**: Not defined
535+
- **Accept**: application/json
536+
537+
### HTTP response details
538+
| Status code | Description | Response headers |
539+
|-------------|-------------|------------------|
540+
| **200** | A successful response. | - |
541+
| **201** | It&#39;s created. | - |
542+
| **400** | The request has an error. | - |
543+
| **401** | You can&#39;t touch this | - |
544+
| **404** | Couldn&#39;t find the resource. | - |
545+
| **409** | There&#39;s a resource conflict here. | - |
546+
| **500** | I&#39;m sorry. We are broken | - |
547+
| **0** | An unexpected error response. | - |
548+
472549
<a name="updateFirmware"></a>
473550
# **updateFirmware**
474551
> Firmware updateFirmware(existingCollectionId, imageId, body)

‎docs/GatewayStats.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
# GatewayStats
4+
5+
This is statistics for a single gateway
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**messagesUpstream** | **Integer** | | [optional] |
12+
|**messagesDownstream** | **Integer** | | [optional] |
13+
|**bytesUpstreamMb** | **Float** | | [optional] |
14+
|**bytesDownstreamMb** | **Float** | | [optional] |
15+
16+
17+

0 commit comments

Comments
 (0)