Merge pull request #26 from pieces-app/2.3.0

feat: updated sdk for pos 10.0.0 release
pieces-app · Jul 9, 2024 · 95a3be0 · 95a3be0
2 parents 70d5ba7 + 58bcffa
commit 95a3be0
Show file tree

Hide file tree

Showing 1,081 changed files with 19,006 additions and 2,262 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/pieces-os-client-sdk-for-python.iml b/.idea/pieces-os-client-sdk-for-python.iml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/docs/Accessor.md b/docs/Accessor.md
@@ -27,7 +27,7 @@ print Accessor.to_json()
 # convert the object into a dict
 accessor_dict = accessor_instance.to_dict()
 # create an instance of Accessor from a dict
-accessor_form_dict = accessor.from_dict(accessor_dict)
+accessor_from_dict = Accessor.from_dict(accessor_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Accessors.md b/docs/Accessors.md
@@ -22,7 +22,7 @@ print Accessors.to_json()
 # convert the object into a dict
 accessors_dict = accessors_instance.to_dict()
 # create an instance of Accessors from a dict
-accessors_form_dict = accessors.from_dict(accessors_dict)
+accessors_from_dict = Accessors.from_dict(accessors_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ActiveOSServerApplet.md b/docs/ActiveOSServerApplet.md
@@ -0,0 +1,31 @@
+# ActiveOSServerApplet
+
+TODO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) |  | [optional] 
+**port** | **int** |  | 
+**type** | [**OSAppletEnum**](OSAppletEnum.md) |  | 
+
+## Example
+
+```python
+from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ActiveOSServerApplet from a JSON string
+active_os_server_applet_instance = ActiveOSServerApplet.from_json(json)
+# print the JSON string representation of the object
+print ActiveOSServerApplet.to_json()
+
+# convert the object into a dict
+active_os_server_applet_dict = active_os_server_applet_instance.to_dict()
+# create an instance of ActiveOSServerApplet from a dict
+active_os_server_applet_from_dict = ActiveOSServerApplet.from_dict(active_os_server_applet_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Activities.md b/docs/Activities.md
@@ -23,7 +23,7 @@ print Activities.to_json()
 # convert the object into a dict
 activities_dict = activities_instance.to_dict()
 # create an instance of Activities from a dict
-activities_form_dict = activities.from_dict(activities_dict)
+activities_from_dict = Activities.from_dict(activities_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Activity.md b/docs/Activity.md
@@ -1,6 +1,6 @@
 # Activity
 
-consider a rename to Event? That being said if we go with event we need to think about a word to pre/post fix event because it is likely to be a reserved word.  additional documentation: https://www.notion.so/getpieces/Activity-4da8de193733441f85f87b510235fb74   Notes: - user/asset/format are all optional, NOT required that one of these are present. - if mechanism == internal we will not display to the user.  Thoughts around additional properties. - hmm dismissed array here, that is an array of strings, where the string is the userId that dismissed this notification? or we could potentially do it based on the os_ID. - 
+
 
 ## Properties
 Name | Type | Description | Notes
@@ -33,7 +33,7 @@ print Activity.to_json()
 # convert the object into a dict
 activity_dict = activity_instance.to_dict()
 # create an instance of Activity from a dict
-activity_form_dict = activity.from_dict(activity_dict)
+activity_from_dict = Activity.from_dict(activity_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Aesthetics.md b/docs/Aesthetics.md
@@ -24,7 +24,7 @@ print Aesthetics.to_json()
 # convert the object into a dict
 aesthetics_dict = aesthetics_instance.to_dict()
 # create an instance of Aesthetics from a dict
-aesthetics_form_dict = aesthetics.from_dict(aesthetics_dict)
+aesthetics_from_dict = Aesthetics.from_dict(aesthetics_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AllocationCloud.md b/docs/AllocationCloud.md
@@ -30,7 +30,7 @@ print AllocationCloud.to_json()
 # convert the object into a dict
 allocation_cloud_dict = allocation_cloud_instance.to_dict()
 # create an instance of AllocationCloud from a dict
-allocation_cloud_form_dict = allocation_cloud.from_dict(allocation_cloud_dict)
+allocation_cloud_from_dict = AllocationCloud.from_dict(allocation_cloud_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AllocationCloudStatus.md b/docs/AllocationCloudStatus.md
@@ -22,7 +22,7 @@ print AllocationCloudStatus.to_json()
 # convert the object into a dict
 allocation_cloud_status_dict = allocation_cloud_status_instance.to_dict()
 # create an instance of AllocationCloudStatus from a dict
-allocation_cloud_status_form_dict = allocation_cloud_status.from_dict(allocation_cloud_status_dict)
+allocation_cloud_status_from_dict = AllocationCloudStatus.from_dict(allocation_cloud_status_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AllocationCloudUrl.md b/docs/AllocationCloudUrl.md
@@ -24,7 +24,7 @@ print AllocationCloudUrl.to_json()
 # convert the object into a dict
 allocation_cloud_url_dict = allocation_cloud_url_instance.to_dict()
 # create an instance of AllocationCloudUrl from a dict
-allocation_cloud_url_form_dict = allocation_cloud_url.from_dict(allocation_cloud_url_dict)
+allocation_cloud_url_from_dict = AllocationCloudUrl.from_dict(allocation_cloud_url_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AllocationCloudUrls.md b/docs/AllocationCloudUrls.md
@@ -25,7 +25,7 @@ print AllocationCloudUrls.to_json()
 # convert the object into a dict
 allocation_cloud_urls_dict = allocation_cloud_urls_instance.to_dict()
 # create an instance of AllocationCloudUrls from a dict
-allocation_cloud_urls_form_dict = allocation_cloud_urls.from_dict(allocation_cloud_urls_dict)
+allocation_cloud_urls_from_dict = AllocationCloudUrls.from_dict(allocation_cloud_urls_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Allocations.md b/docs/Allocations.md
@@ -22,7 +22,7 @@ print Allocations.to_json()
 # convert the object into a dict
 allocations_dict = allocations_instance.to_dict()
 # create an instance of Allocations from a dict
-allocations_form_dict = allocations.from_dict(allocations_dict)
+allocations_from_dict = Allocations.from_dict(allocations_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Analyses.md b/docs/Analyses.md
@@ -22,7 +22,7 @@ print Analyses.to_json()
 # convert the object into a dict
 analyses_dict = analyses_instance.to_dict()
 # create an instance of Analyses from a dict
-analyses_form_dict = analyses.from_dict(analyses_dict)
+analyses_from_dict = Analyses.from_dict(analyses_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Analysis.md b/docs/Analysis.md
@@ -26,7 +26,7 @@ print Analysis.to_json()
 # convert the object into a dict
 analysis_dict = analysis_instance.to_dict()
 # create an instance of Analysis from a dict
-analysis_form_dict = analysis.from_dict(analysis_dict)
+analysis_from_dict = Analysis.from_dict(analysis_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs.md b/docs/AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs.md
@@ -23,7 +23,7 @@ print AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs.to_json()
 # convert the object into a dict
 analytics_tracked_adoption_event_identifier_description_pairs_dict = analytics_tracked_adoption_event_identifier_description_pairs_instance.to_dict()
 # create an instance of AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs from a dict
-analytics_tracked_adoption_event_identifier_description_pairs_form_dict = analytics_tracked_adoption_event_identifier_description_pairs.from_dict(analytics_tracked_adoption_event_identifier_description_pairs_dict)
+analytics_tracked_adoption_event_identifier_description_pairs_from_dict = AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs.from_dict(analytics_tracked_adoption_event_identifier_description_pairs_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/Anchor.md b/docs/Anchor.md
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **conversations** | [**FlattenedConversations**](FlattenedConversations.md) |  | [optional] 
 **score** | [**Score**](Score.md) |  | [optional] 
 **summaries** | [**FlattenedWorkstreamSummaries**](FlattenedWorkstreamSummaries.md) |  | [optional] 
+**persons** | [**FlattenedPersons**](FlattenedPersons.md) |  | [optional] 
 
 ## Example
 
@@ -34,7 +35,7 @@ print Anchor.to_json()
 # convert the object into a dict
 anchor_dict = anchor_instance.to_dict()
 # create an instance of Anchor from a dict
-anchor_form_dict = anchor.from_dict(anchor_dict)
+anchor_from_dict = Anchor.from_dict(anchor_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnchorApi.md b/docs/AnchorApi.md
@@ -6,9 +6,11 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**anchor_associate_asset**](AnchorApi.md#anchor_associate_asset) | **POST** /anchor/{anchor}/assets/associate/{asset} | /anchor/{anchor}/assets/associate/{asset} [POST]
 [**anchor_associate_conversation**](AnchorApi.md#anchor_associate_conversation) | **POST** /anchor/{anchor}/conversations/associate/{conversation} | /anchor/{anchor}/conversations/associate/{conversation} [POST]
+[**anchor_associate_person**](AnchorApi.md#anchor_associate_person) | **POST** /anchor/{anchor}/persons/associate/{person} | /anchor/{anchor}/persons/associate/{person} [POST]
 [**anchor_associate_workstream_summary**](AnchorApi.md#anchor_associate_workstream_summary) | **POST** /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} | /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]
 [**anchor_disassociate_asset**](AnchorApi.md#anchor_disassociate_asset) | **POST** /anchor/{anchor}/assets/disassociate/{asset} | /anchor/{anchor}/assets/disassociate/{asset} [POST]
 [**anchor_disassociate_conversation**](AnchorApi.md#anchor_disassociate_conversation) | **POST** /anchor/{anchor}/conversations/disassociate/{conversation} | /anchor/{anchor}/conversations/disassociate/{conversation} [POST]
+[**anchor_disassociate_person**](AnchorApi.md#anchor_disassociate_person) | **POST** /anchor/{anchor}/persons/disassociate/{person} | /anchor/{anchor}/persons/disassociate/{person} [POST]
 [**anchor_disassociate_workstream_summary**](AnchorApi.md#anchor_disassociate_workstream_summary) | **POST** /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} | /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]
 [**anchor_rename**](AnchorApi.md#anchor_rename) | **POST** /anchor/{anchor}/rename | /anchor/{anchor}/rename [POST]
 [**anchor_scores_increment**](AnchorApi.md#anchor_scores_increment) | **POST** /anchor/{anchor}/scores/increment | &#39;/anchor/{anchor}/scores/increment&#39; [POST]
@@ -150,6 +152,73 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **anchor_associate_person**
+> anchor_associate_person(anchor, person)
+
+/anchor/{anchor}/persons/associate/{person} [POST]
+
+associates an anchor and a person. It performs the same action as the person equivalent.
+
+### Example
+
+```python
+import time
+import os
+import pieces_os_client
+from pieces_os_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost:1000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = pieces_os_client.Configuration(
+    host = "http://localhost:1000"
+)
+
+
+# Enter a context with an instance of the API client
+with pieces_os_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = pieces_os_client.AnchorApi(api_client)
+    anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
+    person = 'person_example' # str | This is a uuid that represents a person.
+
+    try:
+        # /anchor/{anchor}/persons/associate/{person} [POST]
+        api_instance.anchor_associate_person(anchor, person)
+    except Exception as e:
+        print("Exception when calling AnchorApi->anchor_associate_person: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **anchor** | **str**| This is the specific uuid of an anchor. | 
+ **person** | **str**| This is a uuid that represents a person. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content |  -  |
+**500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **anchor_associate_workstream_summary**
 > anchor_associate_workstream_summary(anchor, workstream_summary)
 
@@ -351,6 +420,73 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **anchor_disassociate_person**
+> anchor_disassociate_person(anchor, person)
+
+/anchor/{anchor}/persons/disassociate/{person} [POST]
+
+Disassociates an anchor from a person. It performs the same action as the person equivalent.
+
+### Example
+
+```python
+import time
+import os
+import pieces_os_client
+from pieces_os_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost:1000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = pieces_os_client.Configuration(
+    host = "http://localhost:1000"
+)
+
+
+# Enter a context with an instance of the API client
+with pieces_os_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = pieces_os_client.AnchorApi(api_client)
+    anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
+    person = 'person_example' # str | This is a uuid that represents a person.
+
+    try:
+        # /anchor/{anchor}/persons/disassociate/{person} [POST]
+        api_instance.anchor_disassociate_person(anchor, person)
+    except Exception as e:
+        print("Exception when calling AnchorApi->anchor_disassociate_person: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **anchor** | **str**| This is the specific uuid of an anchor. | 
+ **person** | **str**| This is a uuid that represents a person. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No Content |  -  |
+**500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **anchor_disassociate_workstream_summary**
 > anchor_disassociate_workstream_summary(anchor, workstream_summary)
 

diff --git a/docs/AnchorPoint.md b/docs/AnchorPoint.md
@@ -30,7 +30,7 @@ print AnchorPoint.to_json()
 # convert the object into a dict
 anchor_point_dict = anchor_point_instance.to_dict()
 # create an instance of AnchorPoint from a dict
-anchor_point_form_dict = anchor_point.from_dict(anchor_point_dict)
+anchor_point_from_dict = AnchorPoint.from_dict(anchor_point_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AnchorPoints.md b/docs/AnchorPoints.md
@@ -25,7 +25,7 @@ print AnchorPoints.to_json()
 # convert the object into a dict
 anchor_points_dict = anchor_points_instance.to_dict()
 # create an instance of AnchorPoints from a dict
-anchor_points_form_dict = anchor_points.from_dict(anchor_points_dict)
+anchor_points_from_dict = AnchorPoints.from_dict(anchor_points_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)