lamp-core-lst 2025.11.1-3.basic

package/docs/SensorSpecApi.md

@@ -0,0 +1,222 @@
+# LAMP.SensorSpec
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**all**](SensorSpecApi.md#all) | **GET** /sensor_spec | Get all SensorSpecs registered.
+[**create**](SensorSpecApi.md#create) | **POST** /sensor_spec | Create a new SensorSpec.
+[**delete**](SensorSpecApi.md#delete) | **DELETE** /sensor_spec/{sensor_spec_name} | Delete an SensorSpec.
+[**update**](SensorSpecApi.md#update) | **PUT** /sensor_spec/{sensor_spec_name} | Update an SensorSpec.
+[**view**](SensorSpecApi.md#view) | **GET** /sensor_spec/{sensor_spec_name} | Get a SensorSpec.
+
+
+# **all**
+> array[object] all()
+
+Get all SensorSpecs registered.
+
+Get all SensorSpecs registered by any Researcher.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+// Get all SensorSpecs registered.
+const result = LAMP.SensorSpec.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 |  -  |
+
+# **create**
+> character create(sensor.spec)
+
+Create a new SensorSpec.
+
+Create a new SensorSpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor.spec = SensorSpec.new("name_example", 123) // SensorSpec 
+
+// Create a new SensorSpec.
+const result = LAMP.SensorSpec.create(sensor.spec)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor.spec** | [**SensorSpec**](SensorSpec.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.spec.name)
+
+Delete an SensorSpec.
+
+Delete an SensorSpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor.spec.name = 'sensor.spec.name_example' // string 
+
+// Delete an SensorSpec.
+const result = LAMP.SensorSpec.delete(sensor.spec.name)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor.spec.name** | **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.spec.name, sensor.spec)
+
+Update an SensorSpec.
+
+Update an SensorSpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor.spec.name = 'sensor.spec.name_example' // string 
+let sensor.spec = SensorSpec.new("name_example", 123) // SensorSpec 
+
+// Update an SensorSpec.
+const result = LAMP.SensorSpec.update(sensor.spec.name, sensor.spec)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor.spec.name** | **string**|  | 
+ **sensor.spec** | [**SensorSpec**](SensorSpec.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.spec.name)
+
+Get a SensorSpec.
+
+Get a SensorSpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let sensor.spec.name = 'sensor.spec.name_example' // string 
+
+// Get a SensorSpec.
+const result = LAMP.SensorSpec.view(sensor.spec.name)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sensor.spec.name** | **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/Study.md

@@ -0,0 +1,11 @@
+# LAMP.Study
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | A globally unique reference for objects. | [optional] 
+**name** | **string** | The name of the study. | [optional] 
+**activities** | **array[object]** | The set of all activities available in the study. | [optional] 
+**participants** | **array[object]** | The set of all enrolled participants in the study. | [optional] 
+
+

package/docs/StudyApi.md

@@ -0,0 +1,268 @@
+# LAMP.Study
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**all**](StudyApi.md#all) | **GET** /study | Get the set of all studies.
+[**allByResearcher**](StudyApi.md#allByResearcher) | **GET** /researcher/{researcher_id}/study | Get the set of studies for a single researcher.
+[**create**](StudyApi.md#create) | **POST** /researcher/{researcher_id}/study | Create a new Study for the given Researcher.
+[**delete**](StudyApi.md#delete) | **DELETE** /study/{study_id} | Delete a study.
+[**update**](StudyApi.md#update) | **PUT** /study/{study_id} | Update the study.
+[**view**](StudyApi.md#view) | **GET** /study/{study_id} | Get a single study, by identifier.
+
+
+# **all**
+> array[object] all()
+
+Get the set of all studies.
+
+Get the set of all studies.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+// Get the set of all studies.
+const result = LAMP.Study.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 |  -  |
+
+# **allByResearcher**
+> array[object] allByResearcher(researcher_id)
+
+Get the set of studies for a single researcher.
+
+Get the set of studies for a single researcher.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let researcher_id = 'researcher_id_example' // string 
+
+// Get the set of studies for a single researcher.
+const result = LAMP.Study.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 |  -  |
+
+# **create**
+> character create(researcher_id, study)
+
+Create a new Study for the given Researcher.
+
+Create a new Study for the given Researcher.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let researcher_id = 'researcher_id_example' // string 
+let study = Study.new("id_example", "name_example", list(123), list(123)) // Study 
+
+// Create a new Study for the given Researcher.
+const result = LAMP.Study.create(researcher_id, study)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **researcher_id** | **string**|  | 
+ **study** | [**Study**](Study.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(study_id)
+
+Delete a study.
+
+Delete a study.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+
+// Delete a study.
+const result = LAMP.Study.delete(study_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **study_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(study_id, study)
+
+Update the study.
+
+Update the study.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+let study = Study.new("id_example", "name_example", list(123), list(123)) // Study 
+
+// Update the study.
+const result = LAMP.Study.update(study_id, study)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **study_id** | **string**|  | 
+ **study** | [**Study**](Study.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(study_id)
+
+Get a single study, by identifier.
+
+Get a single study, by identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let study_id = 'study_id_example' // string 
+
+// Get a single study, by identifier.
+const result = LAMP.Study.view(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 |  -  |
+

package/docs/TemporalSlice.md

@@ -0,0 +1,13 @@
+# LAMP.TemporalSlice
+
+A specific sub-detail of a `ActivityEvent` that contains specific  interaction information that comprises the parent `ActivityEvent`.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item** | [**object**](.md) | The item that was interacted with; for example, in a Jewels game, the  corresponding alphabet, or in a survey, the question index. | [optional] 
+**value** | [**object**](.md) | The value of the item that was interacted with; in most games,  this field is  `null`, but in a survey, this field is the question  choice index. | [optional] 
+**type** | **string** | The type of interaction that for this detail; for example, in  a Jewels game,  `none` if the tapped jewel was  incorrect, or `correct` if it was correct, or in  a  survey, this field will be `null`. | [optional] 
+**duration** | **integer** | The time difference from the previous detail or the  start of the parent result. | [optional] 
+**level** | **integer** | The level of activity for this detail; for example, in  games with multiple  levels, this field might be `2` or  `4`, but for surveys and other games this field  will be `null`. | [optional] 
+
+