lamp-core-lst 2025.11.1-3.basic

package/docs/ActivitySpecApi.md

@@ -0,0 +1,222 @@
+# LAMP.ActivitySpec
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**all**](ActivitySpecApi.md#all) | **GET** /activity_spec | Get all ActivitySpecs registered.
+[**create**](ActivitySpecApi.md#create) | **POST** /activity_spec | Create a new ActivitySpec.
+[**delete**](ActivitySpecApi.md#delete) | **DELETE** /activity_spec/{activity_spec_name} | Delete an ActivitySpec.
+[**update**](ActivitySpecApi.md#update) | **PUT** /activity_spec/{activity_spec_name} | Update an ActivitySpec.
+[**view**](ActivitySpecApi.md#view) | **GET** /activity_spec/{activity_spec_name} | View an ActivitySpec.
+
+
+# **all**
+> array[object] all()
+
+Get all ActivitySpecs registered.
+
+Get all ActivitySpecs registered.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+// Get all ActivitySpecs registered.
+const result = LAMP.ActivitySpec.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(activity.spec)
+
+Create a new ActivitySpec.
+
+Create a new ActivitySpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let activity.spec = ActivitySpec.new("name_example", "help_contents_example", "script_contents_example", 123, 123, 123) // ActivitySpec 
+
+// Create a new ActivitySpec.
+const result = LAMP.ActivitySpec.create(activity.spec)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **activity.spec** | [**ActivitySpec**](ActivitySpec.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(activity.spec.name)
+
+Delete an ActivitySpec.
+
+Delete an ActivitySpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let activity.spec.name = 'activity.spec.name_example' // string 
+
+// Delete an ActivitySpec.
+const result = LAMP.ActivitySpec.delete(activity.spec.name)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **activity.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(activity.spec.name, activity.spec)
+
+Update an ActivitySpec.
+
+Update an ActivitySpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let activity.spec.name = 'activity.spec.name_example' // string 
+let activity.spec = ActivitySpec.new("name_example", "help_contents_example", "script_contents_example", 123, 123, 123) // ActivitySpec 
+
+// Update an ActivitySpec.
+const result = LAMP.ActivitySpec.update(activity.spec.name, activity.spec)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **activity.spec.name** | **string**|  | 
+ **activity.spec** | [**ActivitySpec**](ActivitySpec.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**
+> character view(activity.spec.name)
+
+View an ActivitySpec.
+
+View an ActivitySpec.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let activity.spec.name = 'activity.spec.name_example' // string 
+
+// View an ActivitySpec.
+const result = LAMP.ActivitySpec.view(activity.spec.name)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **activity.spec.name** | **string**|  | 
+ **transform** | **string**|  | [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/Credential.md

@@ -0,0 +1,12 @@
+# LAMP.Credential
+
+Every object can have one or more credential(s) associated with it. (i.e. `my_researcher.credentials = ['person A', 'person B', 'api A'', 'person C', 'api B']`)
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**origin** | **string** | The root object this credential is attached to. The scope of this credential is limited to the object itself and any children. | [optional] 
+**access_key** | **string** | Username or machine-readable public key (access). | [optional] 
+**secret_key** | **string** | SALTED HASH OF Password or machine-readable private key (secret). | [optional] 
+**description** | **string** | The user-visible description of the credential. | [optional] 
+
+

package/docs/CredentialApi.md

@@ -0,0 +1,175 @@
+# LAMP.Credential
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](CredentialApi.md#create) | **POST** /type/{type_id}/credential | 
+[**delete**](CredentialApi.md#delete) | **DELETE** /type/{type_id}/credential/{access_key} | 
+[**list**](CredentialApi.md#list) | **GET** /type/{type_id}/credential | 
+[**update**](CredentialApi.md#update) | **PUT** /type/{type_id}/credential/{access_key} | 
+
+
+# **create**
+> object create(type_id, body)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let body = null // object 
+
+const result = LAMP.Credential.create(type_id, body)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **body** | **object**|  | 
+
+### Return type
+
+**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 |  -  |
+
+# **delete**
+> object delete(type_id, access_key)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let access_key = 'access_key_example' // string 
+
+const result = LAMP.Credential.delete(type_id, access_key)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **access_key** | **string**|  | 
+
+### Return type
+
+**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 |  -  |
+
+# **list**
+> object list(type_id)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+
+const result = LAMP.Credential.list(type_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**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 |  -  |
+
+# **update**
+> object update(type_id, access_key, body)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let access_key = 'access_key_example' // string 
+let body = null // object 
+
+const result = LAMP.Credential.update(type_id, access_key, body)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **access_key** | **string**|  | 
+ **body** | **object**|  | 
+
+### Return type
+
+**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/Document.md

@@ -0,0 +1,9 @@
+# LAMP.Document
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Metadata**](Metadata.md) |  | [optional] 
+**data** | **array[object]** |  | [optional] 
+
+

package/docs/DurationInterval.md

@@ -0,0 +1,11 @@
+# LAMP.DurationInterval
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **number** | The UNIX Epoch date-time representation: number of milliseconds since 1/1/1970 12:00 AM. | [optional] 
+**interval** | **array[object]** |  | [optional] 
+**repeat_count** | **integer** |  | [optional] 
+**end** | **number** | The UNIX Epoch date-time representation: number of milliseconds since 1/1/1970 12:00 AM. | [optional] 
+
+

package/docs/DurationIntervalLegacy.md

@@ -0,0 +1,10 @@
+# LAMP.DurationIntervalLegacy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repeat_type** | **string** |  | [optional] 
+**date** | **number** | The UNIX Epoch date-time representation: number of milliseconds since 1/1/1970 12:00 AM. | [optional] 
+**custom_times** | **array[object]** |  | [optional] 
+
+

package/docs/DynamicAttachment.md

@@ -0,0 +1,14 @@
+# LAMP.DynamicAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The key. | [optional] 
+**from** | **string** | A globally unique reference for objects. | [optional] 
+**to** | **string** | Either \"me\" to apply to the attachment owner only, the ID of an object owned  by the attachment owner, or a string representing the child object type to apply to. | [optional] 
+**triggers** | **array[object]** | The API triggers that activate script execution. These will be event stream types  or object types in the API, or, if scheduling execution periodically, a cron-job string  prefixed with \"!\" (exclamation point). | [optional] 
+**language** | **string** | The script language. | [optional] 
+**contents** | **string** | The script contents. | [optional] 
+**requirements** | **array[object]** | The script requirements. | [optional] 
+
+

package/docs/Error.md

@@ -0,0 +1,8 @@
+# LAMP.Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **string** |  | [optional] 
+
+

package/docs/Metadata.md

@@ -0,0 +1,8 @@
+# LAMP.Metadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access** | [**AccessCitation**](AccessCitation.md) |  | [optional] 
+
+

package/docs/Participant.md

@@ -0,0 +1,14 @@
+# LAMP.Participant
+
+A participant within a study; a participant cannot be enrolled in more than one study at a time.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | A globally unique reference for objects. | [optional] 
+**study_code** | **string** | The researcher-provided study code for the participant. | [optional] 
+**language** | **string** | The participant's selected language code for the LAMP app. | [optional] 
+**theme** | **string** | The participant's selected theme for the LAMP app. | [optional] 
+**emergency_contact** | **string** | The participant's emergency contact number. | [optional] 
+**helpline** | **string** | The participant's selected personal helpline number. | [optional] 
+
+