Version 4.3.0

Author: Lab5e Release Bot

.openapi-generator/FILES

@@ -45,6 +45,7 @@ docs/ListGatewayResponse.md
 docs/ListNetworkResponse.md
 docs/ListOutputResponse.md
 docs/ListUpstreamMessagesResponse.md
+docs/MQTTMetadata.md
 docs/MessageDownstream.md
 docs/MessageState.md
 docs/MessageTransport.md
@@ -142,6 +143,7 @@ src/main/java/com/lab5e/span/model/ListGatewayResponse.java
 src/main/java/com/lab5e/span/model/ListNetworkResponse.java
 src/main/java/com/lab5e/span/model/ListOutputResponse.java
 src/main/java/com/lab5e/span/model/ListUpstreamMessagesResponse.java
+src/main/java/com/lab5e/span/model/MQTTMetadata.java
 src/main/java/com/lab5e/span/model/MessageDownstream.java
 src/main/java/com/lab5e/span/model/MessageState.java
 src/main/java/com/lab5e/span/model/MessageTransport.java
@@ -211,6 +213,7 @@ src/test/java/com/lab5e/span/model/ListGatewayResponseTest.java
 src/test/java/com/lab5e/span/model/ListNetworkResponseTest.java
 src/test/java/com/lab5e/span/model/ListOutputResponseTest.java
 src/test/java/com/lab5e/span/model/ListUpstreamMessagesResponseTest.java
+src/test/java/com/lab5e/span/model/MQTTMetadataTest.java
 src/test/java/com/lab5e/span/model/MessageDownstreamTest.java
 src/test/java/com/lab5e/span/model/MessageStateTest.java
 src/test/java/com/lab5e/span/model/MessageTransportTest.java

README.md

@@ -1,8 +1,8 @@
 # span-java-client
 
 The Span API
-- API version: 4.2.4 curable-andres
-  - Build date: 2022-06-30T09:27:02.556964Z[Etc/UTC]
+- API version: 4.3.0 grouchy-aloysius
+  - Build date: 2023-01-13T11:18:28.250753Z[Etc/UTC]
 
 API for device, collection, output and firmware management
 
@@ -41,7 +41,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.lab5e</groupId>
   <artifactId>span-java-client</artifactId>
-  <version>4.2.4</version>
+  <version>4.3.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -57,7 +57,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.lab5e:span-java-client:4.2.4"
+     implementation "com.lab5e:span-java-client:4.3.0"
   }
 ```
 
@@ -71,7 +71,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/span-java-client-4.2.4.jar`
+* `target/span-java-client-4.3.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -202,6 +202,7 @@ Class | Method | HTTP request | Description
  - [ListNetworkResponse](docs/ListNetworkResponse.md)
  - [ListOutputResponse](docs/ListOutputResponse.md)
  - [ListUpstreamMessagesResponse](docs/ListUpstreamMessagesResponse.md)
+ - [MQTTMetadata](docs/MQTTMetadata.md)
  - [MessageDownstream](docs/MessageDownstream.md)
  - [MessageState](docs/MessageState.md)
  - [MessageTransport](docs/MessageTransport.md)

api/openapi.yaml

@@ -6,7 +6,7 @@ info:
     url: https://lab5e.com
   description: API for device, collection, output and firmware management
   title: The Span API
-  version: 4.2.4 curable-andres
+  version: 4.3.0 grouchy-aloysius
 servers:
 - url: https://api.lab5e.com/
 security:
@@ -79,6 +79,8 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/CreateCollectionRequest'
+        description: Request object when creating a collection. The collect ID is
+          assigned by the service.
         required: true
       responses:
         "200":
@@ -3218,11 +3220,14 @@ components:
       properties:
         imsi:
           format: int64
+          title: The IMSI is the unique ID for the (e|nu|whatever)SIM card
           type: string
         imei:
           description: |-
             on your device. This is the primary identifier for your
             device on the network.
+
+            The IMEI number is the unique ID for your hardware as
           format: int64
           type: string
       title: CellularIOTConfig
@@ -3243,27 +3248,38 @@ components:
         network: network
       properties:
         gatewayId:
+          title: The currently used gateway
           type: string
         allocatedIp:
+          description: Allocated IP address.
           type: string
         allocatedAt:
           format: int64
+          title: Time stamp for address allocation
           type: string
         cellId:
           format: int64
+          title: Cell ID for device. This might not be set, depending on
           type: string
         mcc:
-          description: the provider in use.
+          description: |-
+            the provider in use.
+
+            The Mobile Country Code for the operator.
           format: int32
           type: integer
         mnc:
           format: int32
+          title: The Mobile Network Code for the operator
           type: integer
         country:
+          title: The name of the country in plain text
           type: string
         network:
+          title: The name of the mobile network
           type: string
         countryCode:
+          title: ISO country code
           type: string
         lastUpdate:
           format: int64
@@ -3668,6 +3684,7 @@ components:
           title: Last reported manufacturer string
           type: string
         state:
+          description: State of the firmware.
           type: string
         stateMessage:
           title: Description of the firmware state
@@ -3686,6 +3703,7 @@ components:
         - targeted
       properties:
         imageId:
+          title: Yes it is inconsistent
           type: string
         targeted:
           items:
@@ -3775,6 +3793,8 @@ components:
           payload: payload
           messageId: messageId
           received: received
+          mqttMetaData:
+            topic: topic
           transport: transport
           device:
             metadata:
@@ -3832,6 +3852,8 @@ components:
           payload: payload
           messageId: messageId
           received: received
+          mqttMetaData:
+            topic: topic
           transport: transport
           device:
             metadata:
@@ -4172,6 +4194,16 @@ components:
           type: array
       title: ListUpstreamMessagesResponse
       type: object
+    MQTTMetadata:
+      description: MQTT metadata for messages received through one of the MQTT endpoints.
+        This is an EXPERIMENTAL feature.
+      example:
+        topic: topic
+      properties:
+        topic:
+          type: string
+      title: MQTTMetadata
+      type: object
     MessageDownstream:
       description: Downstream messages are sent from the backend to the devices.
       example:
@@ -4222,6 +4254,7 @@ components:
       - unspecified
       - udp
       - coap
+      - mqtt
       title: MessageTransport
       type: string
     MessageUpstream:
@@ -4246,6 +4279,7 @@ components:
           $ref: '#/components/schemas/MessageTransport'
         received:
           format: int64
+          title: Time the message was received, ms from epoch
           type: string
         payload:
           format: byte
@@ -4474,6 +4508,8 @@ components:
         payload: payload
         messageId: messageId
         received: received
+        mqttMetaData:
+          topic: topic
         transport: transport
         device:
           metadata:
@@ -4552,6 +4588,8 @@ components:
             for all messages received. Note that the received time stamp and the
             message ID might not be
           type: string
+        mqttMetaData:
+          $ref: '#/components/schemas/MQTTMetadata'
       title: OutputDataMessage
       type: object
     OutputLogEntry:

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.lab5e'
-version = '4.2.4'
+version = '4.3.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.lab5e",
     name := "span-java-client",
-    version := "4.2.4",
+    version := "4.3.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/CellularIoTConfig.md

@@ -9,7 +9,7 @@ This is the cellular IOT config
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **imsi** | **String** |  |  [optional]
-**imei** | **String** | on your device. This is the primary identifier for your device on the network. |  [optional]
+**imei** | **String** | on your device. This is the primary identifier for your device on the network.  The IMEI number is the unique ID for your hardware as |  [optional]
 
 
 

docs/CellularIoTMetadata.md

@@ -9,10 +9,10 @@ This is the metadata for a Cellular IoT device connected via an APN.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **gatewayId** | **String** |  |  [optional]
-**allocatedIp** | **String** |  |  [optional]
+**allocatedIp** | **String** | Allocated IP address. |  [optional]
 **allocatedAt** | **String** |  |  [optional]
 **cellId** | **String** |  |  [optional]
-**mcc** | **Integer** | the provider in use. |  [optional]
+**mcc** | **Integer** | the provider in use.  The Mobile Country Code for the operator. |  [optional]
 **mnc** | **Integer** |  |  [optional]
 **country** | **String** |  |  [optional]
 **network** | **String** |  |  [optional]

docs/CollectionsApi.md

@@ -42,7 +42,7 @@ public class Example {
     //APIToken.setApiKeyPrefix("Token");
 
     CollectionsApi apiInstance = new CollectionsApi(defaultClient);
-    CreateCollectionRequest body = new CreateCollectionRequest(); // CreateCollectionRequest | 
+    CreateCollectionRequest body = new CreateCollectionRequest(); // CreateCollectionRequest | Request object when creating a collection. The collect ID is assigned by the service.
     try {
       Collection result = apiInstance.createCollection(body);
       System.out.println(result);
@@ -61,7 +61,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**CreateCollectionRequest**](CreateCollectionRequest.md)|  |
+ **body** | [**CreateCollectionRequest**](CreateCollectionRequest.md)| Request object when creating a collection. The collect ID is assigned by the service. |
 
 ### Return type
 

docs/FirmwareMetadata.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **serialNumber** | **String** |  |  [optional]
 **modelNumber** | **String** |  |  [optional]
 **manufacturer** | **String** |  |  [optional]
-**state** | **String** |  |  [optional]
+**state** | **String** | State of the firmware. |  [optional]
 **stateMessage** | **String** |  |  [optional]
 
 

docs/MQTTMetadata.md

@@ -0,0 +1,14 @@
+
+
+# MQTTMetadata
+
+MQTT metadata for messages received through one of the MQTT endpoints. This is an EXPERIMENTAL feature.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic** | **String** |  |  [optional]
+
+
+