lamp-core-lst 2025.11.1-3.basic

package/docs/SensorApi.md

@@ -0,0 +1,356 @@
+# LAMP.Sensor
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**all**](SensorApi.md#all) | **GET** /sensor | Get the set of all sensors.
+[**allByParticipant**](SensorApi.md#allByParticipant) | **GET** /participant/{participant_id}/sensor | Get all sensors for a participant.
+[**allByResearcher**](SensorApi.md#allByResearcher) | **GET** /researcher/{researcher_id}/sensor | Get all sensors for a researcher.
+[**allByStudy**](SensorApi.md#allByStudy) | **GET** /study/{study_id}/sensor | View all sensors in a study.
+[**create**](SensorApi.md#create) | **POST** /study/{study_id}/sensor | Create a new Sensor under the given Study.
+[**delete**](SensorApi.md#delete) | **DELETE** /sensor/{sensor_id} | Delete a Sensor.
+[**update**](SensorApi.md#update) | **PUT** /sensor/{sensor_id} | Update an Sensor's settings.
+[**view**](SensorApi.md#view) | **GET** /sensor/{sensor_id} | Get a single sensor, by identifier.
+
+
+# **all**
+> array[object] all()
+
+Get the set of all sensors.
+
+Get the set of all sensors.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+// Get the set of all sensors.
+const result = LAMP.Sensor.all()
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **allByParticipant**
+> array[object] allByParticipant(participant_id)
+
+Get all sensors for a participant.
+
+Get the set of all sensors available to a participant, by participant  identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let participant_id = 'participant_id_example' // string 
+
+// Get all sensors for a participant.
+const result = LAMP.Sensor.allByParticipant(participant_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **participant_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **allByResearcher**
+> array[object] allByResearcher(researcher_id)
+
+Get all sensors for a researcher.
+
+Get the set of all sensors available to participants of any study conducted  by a researcher, by researcher identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let researcher_id = 'researcher_id_example' // string 
+
+// Get all sensors for a researcher.
+const result = LAMP.Sensor.allByResearcher(researcher_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **researcher_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **allByStudy**
+> array[object] allByStudy(study_id)
+
+View all sensors in a study.
+
+Get the set of all sensors available to participants of a single  study, by study identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+
+// View all sensors in a study.
+const result = LAMP.Sensor.allByStudy(study_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **study_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **create**
+> character create(study_id, sensor)
+
+Create a new Sensor under the given Study.
+
+Create a new Sensor under the given Study.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+let sensor = Sensor.new("id_example", "spec_example", "name_example", 123) // Sensor 
+
+// Create a new Sensor under the given Study.
+const result = LAMP.Sensor.create(study_id, sensor)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **study_id** | **string**|  | 
+ **sensor** | [**Sensor**](Sensor.md)|  | 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **delete**
+> character delete(sensor_id)
+
+Delete a Sensor.
+
+Delete a Sensor.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor_id = 'sensor_id_example' // string 
+
+// Delete a Sensor.
+const result = LAMP.Sensor.delete(sensor_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor_id** | **string**|  | 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **update**
+> character update(sensor_id, sensor)
+
+Update an Sensor's settings.
+
+Update an Sensor's settings.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor_id = 'sensor_id_example' // string 
+let sensor = Sensor.new("id_example", "spec_example", "name_example", 123) // Sensor 
+
+// Update an Sensor's settings.
+const result = LAMP.Sensor.update(sensor_id, sensor)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor_id** | **string**|  | 
+ **sensor** | [**Sensor**](Sensor.md)|  | 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **view**
+> array[object] view(sensor_id)
+
+Get a single sensor, by identifier.
+
+Get a single sensor, by identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor_id = 'sensor_id_example' // string 
+
+// Get a single sensor, by identifier.
+const result = LAMP.Sensor.view(sensor_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+

package/docs/SensorEvent.md

@@ -0,0 +1,11 @@
+# LAMP.SensorEvent
+
+An event generated by a participant interacting with the LAMP app.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **number** | The UNIX Epoch date-time representation: number of milliseconds since 1/1/1970 12:00 AM. | [optional] 
+**sensor** | **string** | The type of the sensor event. | [optional] 
+**data** | [**object**](.md) | The item information recorded within the sensor event. | [optional] 
+
+

package/docs/SensorEventApi.md

@@ -0,0 +1,250 @@
+# LAMP.SensorEvent
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**allByParticipant**](SensorEventApi.md#allByParticipant) | **GET** /participant/{participant_id}/sensor_event | Get all sensor events for a participant.
+[**allByResearcher**](SensorEventApi.md#allByResearcher) | **GET** /researcher/{researcher_id}/sensor_event | Get all sensor events for a researcher by participant.
+[**allByStudy**](SensorEventApi.md#allByStudy) | **GET** /study/{study_id}/sensor_event | Get all sensor events for a study by participant.
+[**create**](SensorEventApi.md#create) | **POST** /participant/{participant_id}/sensor_event | Create a new SensorEvent for the given Participant.
+[**delete**](SensorEventApi.md#delete) | **DELETE** /participant/{participant_id}/sensor_event | Delete a sensor event.
+
+
+# **allByParticipant**
+> array[object] allByParticipant(participant_id, origin=let origin, from=let from, to=let to)
+
+Get all sensor events for a participant.
+
+Get the set of all sensor events produced by the given participant.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let participant_id = 'participant_id_example' // string 
+let origin = 'origin_example' // string 
+let from = 3.4 // number 
+let to = 3.4 // number 
+
+// Get all sensor events for a participant.
+const result = LAMP.SensorEvent.allByParticipant(participant_id, origin=let origin, from=let from, to=let to)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **participant_id** | **string**|  | 
+ **origin** | **string**|  | [optional] 
+ **from** | **number**|  | [optional] 
+ **to** | **number**|  | [optional] 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **allByResearcher**
+> array[object] allByResearcher(researcher_id, origin=let origin, from=let from, to=let to)
+
+Get all sensor events for a researcher by participant.
+
+Get the set of all sensor events produced by participants of any  study conducted by a researcher, by researcher identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let researcher_id = 'researcher_id_example' // string 
+let origin = 'origin_example' // string 
+let from = 3.4 // number 
+let to = 3.4 // number 
+
+// Get all sensor events for a researcher by participant.
+const result = LAMP.SensorEvent.allByResearcher(researcher_id, origin=let origin, from=let from, to=let to)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **researcher_id** | **string**|  | 
+ **origin** | **string**|  | [optional] 
+ **from** | **number**|  | [optional] 
+ **to** | **number**|  | [optional] 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **allByStudy**
+> array[object] allByStudy(study_id, origin=let origin, from=let from, to=let to)
+
+Get all sensor events for a study by participant.
+
+Get the set of all sensor events produced by participants of a  single study, by study identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+let origin = 'origin_example' // string 
+let from = 3.4 // number 
+let to = 3.4 // number 
+
+// Get all sensor events for a study by participant.
+const result = LAMP.SensorEvent.allByStudy(study_id, origin=let origin, from=let from, to=let to)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **study_id** | **string**|  | 
+ **origin** | **string**|  | [optional] 
+ **from** | **number**|  | [optional] 
+ **to** | **number**|  | [optional] 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**array[object]**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **create**
+> character create(participant_id, sensor.event)
+
+Create a new SensorEvent for the given Participant.
+
+Create a new SensorEvent for the given Participant.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let participant_id = 'participant_id_example' // string 
+let sensor.event = SensorEvent.new(123, "sensor_example", 123) // SensorEvent 
+
+// Create a new SensorEvent for the given Participant.
+const result = LAMP.SensorEvent.create(participant_id, sensor.event)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **participant_id** | **string**|  | 
+ **sensor.event** | [**SensorEvent**](SensorEvent.md)|  | 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **delete**
+> character delete(participant_id, origin=let origin, from=let from, to=let to)
+
+Delete a sensor event.
+
+Delete a sensor event.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let participant_id = 'participant_id_example' // string 
+let origin = 'origin_example' // string 
+let from = 3.4 // number 
+let to = 3.4 // number 
+
+// Delete a sensor event.
+const result = LAMP.SensorEvent.delete(participant_id, origin=let origin, from=let from, to=let to)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **participant_id** | **string**|  | 
+ **origin** | **string**|  | [optional] 
+ **from** | **number**|  | [optional] 
+ **to** | **number**|  | [optional] 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+

package/docs/SensorSpec.md

@@ -0,0 +1,10 @@
+# LAMP.SensorSpec
+
+The SensorSpec determines the parameters of generated SensorEvents.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the sensor. | [optional] 
+**settings_schema** | [**object**](.md) | The data definition of a SensorSpec. | [optional] 
+
+