diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 1c2fda5..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 1947517..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 34236fd..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/pieces-os-client-sdk-for-python.iml b/.idea/pieces-os-client-sdk-for-python.iml deleted file mode 100644 index 18ec59d..0000000 --- a/.idea/pieces-os-client-sdk-for-python.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index c8397c9..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/docs/Accessor.md b/docs/Accessor.md index 065af93..2cfd3a9 100644 --- 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 index 2c36cb3..64da439 100644 --- 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 new file mode 100644 index 0000000..71aa5c4 --- /dev/null +++ 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 index 3f9bf21..5bebb1f 100644 --- 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 index 5e828cb..d507b50 100644 --- 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 index dba42d0..b0a7ae0 100644 --- 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 index f6260b0..8135057 100644 --- 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 index dbb8efe..3c220d4 100644 --- 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 index c0f36dc..06f8c3d 100644 --- 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 index 27aa1f5..99118dc 100644 --- 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 index 13b6bce..0a711f7 100644 --- 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 index 373a4fc..6a4eede 100644 --- 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 index cbbfadc..3d757e2 100644 --- 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 index ca3c6e7..ef6ef4b 100644 --- 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 index 883b916..2cc4e1c 100644 --- 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 index 3eec850..8abff0b 100644 --- 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 | '/anchor/{anchor}/scores/increment' [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 index 44fd6a9..42a6422 100644 --- 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 index 47134fd..e9f5024 100644 --- 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) diff --git a/docs/Anchors.md b/docs/Anchors.md index c225840..b93fe72 100644 --- a/docs/Anchors.md +++ b/docs/Anchors.md @@ -25,7 +25,7 @@ print Anchors.to_json() # convert the object into a dict anchors_dict = anchors_instance.to_dict() # create an instance of Anchors from a dict -anchors_form_dict = anchors.from_dict(anchors_dict) +anchors_from_dict = Anchors.from_dict(anchors_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/AnchorsApi.md b/docs/AnchorsApi.md index 4491adf..d80245f 100644 --- a/docs/AnchorsApi.md +++ b/docs/AnchorsApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**anchors_create_new_anchor**](AnchorsApi.md#anchors_create_new_anchor) | **POST** /anchors/create | /anchors/create [POST] [**anchors_delete_specific_anchor**](AnchorsApi.md#anchors_delete_specific_anchor) | **POST** /anchors/{anchor}/delete | /anchors/{anchor}/delete [POST] -[**anchors_disassociate_asset**](AnchorsApi.md#anchors_disassociate_asset) | **POST** /anchors/{anchor}/assets/delete/{asset} | /anchors/{anchor}/assets/delete/{asset} [POST] [**anchors_snapshot**](AnchorsApi.md#anchors_snapshot) | **GET** /anchors | /anchors [GET] +[**search_anchors**](AnchorsApi.md#search_anchors) | **POST** /anchors/search | /anchors/search [POST] # **anchors_create_new_anchor** @@ -146,12 +146,12 @@ 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) -# **anchors_disassociate_asset** -> anchors_disassociate_asset(anchor, asset) +# **anchors_snapshot** +> Anchors anchors_snapshot(transferables=transferables) -/anchors/{anchor}/assets/delete/{asset} [POST] +/anchors [GET] -This will update both the asset and the anchor reference, that will remove a anchor from an asset(only the references). This will NOT remove the anchor. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will deprecate this at some point,(please use the AnchorAPI) +This will get a snapshot of all your anchors. ### Example @@ -159,6 +159,7 @@ This will update both the asset and the anchor reference, that will remove a anc import time import os import pieces_os_client +from pieces_os_client.models.anchors import Anchors from pieces_os_client.rest import ApiException from pprint import pprint @@ -173,14 +174,15 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.AnchorsApi(api_client) - anchor = 'anchor_example' # str | This is the specific uuid of an anchor. - asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) try: - # /anchors/{anchor}/assets/delete/{asset} [POST] - api_instance.anchors_disassociate_asset(anchor, asset) + # /anchors [GET] + api_response = api_instance.anchors_snapshot(transferables=transferables) + print("The response of AnchorsApi->anchors_snapshot:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AnchorsApi->anchors_disassociate_asset: %s\n" % e) + print("Exception when calling AnchorsApi->anchors_snapshot: %s\n" % e) ``` @@ -189,12 +191,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **anchor** | **str**| This is the specific uuid of an anchor. | - **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] ### Return type -void (empty response body) +[**Anchors**](Anchors.md) ### Authorization @@ -203,22 +204,22 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain + - **Accept**: application/json, text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**200** | OK | - | **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) -# **anchors_snapshot** -> Anchors anchors_snapshot(transferables=transferables) +# **search_anchors** +> SearchedAnchors search_anchors(transferables=transferables, search_input=search_input) -/anchors [GET] +/anchors/search [POST] -This will get a snapshot of all your anchors. +This will search your anchors for a specific anchor note: we will search all the anchor points ### Example @@ -226,7 +227,8 @@ This will get a snapshot of all your anchors. import time import os import pieces_os_client -from pieces_os_client.models.anchors import Anchors +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_anchors import SearchedAnchors from pieces_os_client.rest import ApiException from pprint import pprint @@ -242,14 +244,15 @@ with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.AnchorsApi(api_client) transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) try: - # /anchors [GET] - api_response = api_instance.anchors_snapshot(transferables=transferables) - print("The response of AnchorsApi->anchors_snapshot:\n") + # /anchors/search [POST] + api_response = api_instance.search_anchors(transferables=transferables, search_input=search_input) + print("The response of AnchorsApi->search_anchors:\n") pprint(api_response) except Exception as e: - print("Exception when calling AnchorsApi->anchors_snapshot: %s\n" % e) + print("Exception when calling AnchorsApi->search_anchors: %s\n" % e) ``` @@ -259,10 +262,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] ### Return type -[**Anchors**](Anchors.md) +[**SearchedAnchors**](SearchedAnchors.md) ### Authorization @@ -270,7 +274,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json, text/plain ### HTTP response details diff --git a/docs/Annotation.md b/docs/Annotation.md index b608dbf..717a868 100644 --- a/docs/Annotation.md +++ b/docs/Annotation.md @@ -39,7 +39,7 @@ print Annotation.to_json() # convert the object into a dict annotation_dict = annotation_instance.to_dict() # create an instance of Annotation from a dict -annotation_form_dict = annotation.from_dict(annotation_dict) +annotation_from_dict = Annotation.from_dict(annotation_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/Annotations.md b/docs/Annotations.md index 9aad8c7..4638a86 100644 --- a/docs/Annotations.md +++ b/docs/Annotations.md @@ -25,7 +25,7 @@ print Annotations.to_json() # convert the object into a dict annotations_dict = annotations_instance.to_dict() # create an instance of Annotations from a dict -annotations_form_dict = annotations.from_dict(annotations_dict) +annotations_from_dict = Annotations.from_dict(annotations_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/AnnotationsApi.md b/docs/AnnotationsApi.md index 35d4837..f294d98 100644 --- a/docs/AnnotationsApi.md +++ b/docs/AnnotationsApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**annotations_create_new_annotation**](AnnotationsApi.md#annotations_create_new_annotation) | **POST** /annotations/create | /annotations/create [POST] [**annotations_delete_specific_annotation**](AnnotationsApi.md#annotations_delete_specific_annotation) | **POST** /annotations/{annotation}/delete | /annotations/{annotation}/delete [POST] [**annotations_snapshot**](AnnotationsApi.md#annotations_snapshot) | **GET** /annotations | /annotations [GET] +[**search_annotations**](AnnotationsApi.md#search_annotations) | **POST** /annotations/search | /annotations/search [POST] # **annotations_create_new_annotation** @@ -211,3 +212,74 @@ 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) +# **search_annotations** +> SearchedAnnotations search_annotations(transferables=transferables, search_input=search_input) + +/annotations/search [POST] + +This will search your annotations for a specific annotation note: we will just search the annotation value + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_annotations import SearchedAnnotations +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.AnnotationsApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /annotations/search [POST] + api_response = api_instance.search_annotations(transferables=transferables, search_input=search_input) + print("The response of AnnotationsApi->search_annotations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AnnotationsApi->search_annotations: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedAnnotations**](SearchedAnnotations.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/AnonymousTemporalRange.md b/docs/AnonymousTemporalRange.md index 08555f8..baf8976 100644 --- a/docs/AnonymousTemporalRange.md +++ b/docs/AnonymousTemporalRange.md @@ -26,7 +26,7 @@ print AnonymousTemporalRange.to_json() # convert the object into a dict anonymous_temporal_range_dict = anonymous_temporal_range_instance.to_dict() # create an instance of AnonymousTemporalRange from a dict -anonymous_temporal_range_form_dict = anonymous_temporal_range.from_dict(anonymous_temporal_range_dict) +anonymous_temporal_range_from_dict = AnonymousTemporalRange.from_dict(anonymous_temporal_range_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/Application.md b/docs/Application.md index 44f99b9..adc6f14 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -31,7 +31,7 @@ print Application.to_json() # convert the object into a dict application_dict = application_instance.to_dict() # create an instance of Application from a dict -application_form_dict = application.from_dict(application_dict) +application_from_dict = Application.from_dict(application_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/Applications.md b/docs/Applications.md index cf9594a..2199b39 100644 --- a/docs/Applications.md +++ b/docs/Applications.md @@ -23,7 +23,7 @@ print Applications.to_json() # convert the object into a dict applications_dict = applications_instance.to_dict() # create an instance of Applications from a dict -applications_form_dict = applications.from_dict(applications_dict) +applications_from_dict = Applications.from_dict(applications_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/Asset.md b/docs/Asset.md index 5a36a8d..f80cdb9 100644 --- a/docs/Asset.md +++ b/docs/Asset.md @@ -51,7 +51,7 @@ print Asset.to_json() # convert the object into a dict asset_dict = asset_instance.to_dict() # create an instance of Asset from a dict -asset_form_dict = asset.from_dict(asset_dict) +asset_from_dict = Asset.from_dict(asset_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/AssetApi.md b/docs/AssetApi.md index 49c19eb..305b743 100644 --- a/docs/AssetApi.md +++ b/docs/AssetApi.md @@ -6,12 +6,14 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**asset_associate_anchor**](AssetApi.md#asset_associate_anchor) | **POST** /asset/{asset}/anchors/associate/{anchor} | /asset/{asset}/persons/associate/{anchor} [POST] [**asset_associate_conversation**](AssetApi.md#asset_associate_conversation) | **POST** /asset/{asset}/conversations/associate/{conversation} | /asset/{asset}/conversations/associate/{conversation} [POST] +[**asset_associate_hint**](AssetApi.md#asset_associate_hint) | **POST** /asset/{asset}/hints/associate/{hint} | /asset/{asset}/hints/associate/{hint} [POST] [**asset_associate_person**](AssetApi.md#asset_associate_person) | **POST** /asset/{asset}/persons/associate/{person} | /asset/{asset}/persons/associate/{person} [POST] [**asset_associate_tag**](AssetApi.md#asset_associate_tag) | **POST** /asset/{asset}/tags/associate/{tag} | /asset/{asset}/tags/associate/{tag} [POST] [**asset_associate_website**](AssetApi.md#asset_associate_website) | **POST** /asset/{asset}/websites/associate/{website} | /asset/{asset}/websites/associate/{website} [POST] [**asset_associate_workstream_summary**](AssetApi.md#asset_associate_workstream_summary) | **POST** /asset/{asset}/workstream_summaries/associate/{workstream_summary} | /asset/{asset}/workstream_summaries/associate/{workstream_summary} [POST] [**asset_disassociate_anchor**](AssetApi.md#asset_disassociate_anchor) | **POST** /asset/{asset}/anchors/disassociate/{anchor} | /asset/{asset}/anchors/disassociate/{anchor} [POST] [**asset_disassociate_conversation**](AssetApi.md#asset_disassociate_conversation) | **POST** /asset/{asset}/conversations/disassociate/{conversation} | /asset/{asset}/conversations/disassociate/{conversation} [POST] +[**asset_disassociate_hint**](AssetApi.md#asset_disassociate_hint) | **POST** /asset/{asset}/hints/disassociate/{hint} | /asset/{asset}/hints/disassociate/{hint} [POST] [**asset_disassociate_person**](AssetApi.md#asset_disassociate_person) | **POST** /asset/{asset}/persons/disassociate/{person} | /asset/{asset}/persons/disassociate/{person} [POST] [**asset_disassociate_tag**](AssetApi.md#asset_disassociate_tag) | **POST** /asset/{asset}/tags/disassociate/{tag} | /asset/{asset}/tags/disassociate/{tag} [POST] [**asset_disassociate_website**](AssetApi.md#asset_disassociate_website) | **POST** /asset/{asset}/websites/disassociate/{website} | /asset/{asset}/websites/disassociate/{website} [POST] @@ -161,6 +163,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) +# **asset_associate_hint** +> asset_associate_hint(asset, hint) + +/asset/{asset}/hints/associate/{hint} [POST] + +associates an asset and a hint. It performs the same action as the hint 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.AssetApi(api_client) + asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + hint = 'hint_example' # str | This is a specific hint uuid + + try: + # /asset/{asset}/hints/associate/{hint} [POST] + api_instance.asset_associate_hint(asset, hint) + except Exception as e: + print("Exception when calling AssetApi->asset_associate_hint: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + **hint** | **str**| This is a specific hint uuid | + +### 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) + # **asset_associate_person** > asset_associate_person(asset, person) @@ -563,6 +632,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) +# **asset_disassociate_hint** +> asset_disassociate_hint(asset, hint) + +/asset/{asset}/hints/disassociate/{hint} [POST] + +Disassociates an asset from a hint. It performs the same action as the hint 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.AssetApi(api_client) + asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + hint = 'hint_example' # str | This is a specific hint uuid + + try: + # /asset/{asset}/hints/disassociate/{hint} [POST] + api_instance.asset_disassociate_hint(asset, hint) + except Exception as e: + print("Exception when calling AssetApi->asset_disassociate_hint: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + **hint** | **str**| This is a specific hint uuid | + +### 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) + # **asset_disassociate_person** > asset_disassociate_person(asset, person) diff --git a/docs/AssetFilter.md b/docs/AssetFilter.md index ee80acc..6234531 100644 --- a/docs/AssetFilter.md +++ b/docs/AssetFilter.md @@ -30,7 +30,7 @@ print AssetFilter.to_json() # convert the object into a dict asset_filter_dict = asset_filter_instance.to_dict() # create an instance of AssetFilter from a dict -asset_filter_form_dict = asset_filter.from_dict(asset_filter_dict) +asset_filter_from_dict = AssetFilter.from_dict(asset_filter_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/AssetFilterPhrase.md b/docs/AssetFilterPhrase.md index 7616b14..fdbd224 100644 --- a/docs/AssetFilterPhrase.md +++ b/docs/AssetFilterPhrase.md @@ -26,7 +26,7 @@ print AssetFilterPhrase.to_json() # convert the object into a dict asset_filter_phrase_dict = asset_filter_phrase_instance.to_dict() # create an instance of AssetFilterPhrase from a dict -asset_filter_phrase_form_dict = asset_filter_phrase.from_dict(asset_filter_phrase_dict) +asset_filter_phrase_from_dict = AssetFilterPhrase.from_dict(asset_filter_phrase_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/AssetFilterPhraseOptions.md b/docs/AssetFilterPhraseOptions.md index 58e5da5..5c17a6e 100644 --- a/docs/AssetFilterPhraseOptions.md +++ b/docs/AssetFilterPhraseOptions.md @@ -22,7 +22,7 @@ print AssetFilterPhraseOptions.to_json() # convert the object into a dict asset_filter_phrase_options_dict = asset_filter_phrase_options_instance.to_dict() # create an instance of AssetFilterPhraseOptions from a dict -asset_filter_phrase_options_form_dict = asset_filter_phrase_options.from_dict(asset_filter_phrase_options_dict) +asset_filter_phrase_options_from_dict = AssetFilterPhraseOptions.from_dict(asset_filter_phrase_options_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/AssetFilterTimestamp.md b/docs/AssetFilterTimestamp.md index ce7dacb..b14d287 100644 --- a/docs/AssetFilterTimestamp.md +++ b/docs/AssetFilterTimestamp.md @@ -25,7 +25,7 @@ print AssetFilterTimestamp.to_json() # convert the object into a dict asset_filter_timestamp_dict = asset_filter_timestamp_instance.to_dict() # create an instance of AssetFilterTimestamp from a dict -asset_filter_timestamp_form_dict = asset_filter_timestamp.from_dict(asset_filter_timestamp_dict) +asset_filter_timestamp_from_dict = AssetFilterTimestamp.from_dict(asset_filter_timestamp_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/AssetFilters.md b/docs/AssetFilters.md index c6f0209..20e3cf4 100644 --- a/docs/AssetFilters.md +++ b/docs/AssetFilters.md @@ -23,7 +23,7 @@ print AssetFilters.to_json() # convert the object into a dict asset_filters_dict = asset_filters_instance.to_dict() # create an instance of AssetFilters from a dict -asset_filters_form_dict = asset_filters.from_dict(asset_filters_dict) +asset_filters_from_dict = AssetFilters.from_dict(asset_filters_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/AssetReclassification.md b/docs/AssetReclassification.md index 655132f..f624435 100644 --- a/docs/AssetReclassification.md +++ b/docs/AssetReclassification.md @@ -24,7 +24,7 @@ print AssetReclassification.to_json() # convert the object into a dict asset_reclassification_dict = asset_reclassification_instance.to_dict() # create an instance of AssetReclassification from a dict -asset_reclassification_form_dict = asset_reclassification.from_dict(asset_reclassification_dict) +asset_reclassification_from_dict = AssetReclassification.from_dict(asset_reclassification_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/AssetSearchSpace.md b/docs/AssetSearchSpace.md index e9cdfad..f999063 100644 --- a/docs/AssetSearchSpace.md +++ b/docs/AssetSearchSpace.md @@ -23,7 +23,7 @@ print AssetSearchSpace.to_json() # convert the object into a dict asset_search_space_dict = asset_search_space_instance.to_dict() # create an instance of AssetSearchSpace from a dict -asset_search_space_form_dict = asset_search_space.from_dict(asset_search_space_dict) +asset_search_space_from_dict = AssetSearchSpace.from_dict(asset_search_space_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/Assets.md b/docs/Assets.md index ca516a2..bd6a99a 100644 --- a/docs/Assets.md +++ b/docs/Assets.md @@ -25,7 +25,7 @@ print Assets.to_json() # convert the object into a dict assets_dict = assets_instance.to_dict() # create an instance of Assets from a dict -assets_form_dict = assets.from_dict(assets_dict) +assets_from_dict = Assets.from_dict(assets_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/AssetsApi.md b/docs/AssetsApi.md index 2cfa63a..e66aba1 100644 --- a/docs/AssetsApi.md +++ b/docs/AssetsApi.md @@ -11,15 +11,14 @@ Method | HTTP request | Description [**assets_get_related_assets**](AssetsApi.md#assets_get_related_assets) | **GET** /assets/related | /assets/related [GET] [**assets_identifiers_snapshot**](AssetsApi.md#assets_identifiers_snapshot) | **GET** /assets/identifiers | /assets/identifiers [GET] [**assets_pseudo_snapshot**](AssetsApi.md#assets_pseudo_snapshot) | **GET** /assets/pseudo | /assets/pseudo [GET] -[**assets_search_assets**](AssetsApi.md#assets_search_assets) | **GET** /assets/search | /assets/search?query=string [GET] [**assets_search_with_filters**](AssetsApi.md#assets_search_with_filters) | **POST** /assets/search | /assets/search [POST] [**assets_snapshot**](AssetsApi.md#assets_snapshot) | **GET** /assets | /assets [GET] Scoped to Assets [**assets_specific_asset_formats_snapshot**](AssetsApi.md#assets_specific_asset_formats_snapshot) | **GET** /assets/{asset}/formats | /assets/{asset}/formats [GET] Scoped To Assets [**assets_specific_asset_snapshot**](AssetsApi.md#assets_specific_asset_snapshot) | **GET** /assets/{asset} | /assets/{asset} [GET] Scoped to Assets [**assets_stream_identifiers**](AssetsApi.md#assets_stream_identifiers) | **GET** /assets/stream/identifiers | /assets/stream/identifiers [WS] [**get_assets_stream_transferables**](AssetsApi.md#get_assets_stream_transferables) | **GET** /assets/stream/transferables | /assets/stream/transferables [WS] +[**search_assets**](AssetsApi.md#search_assets) | **GET** /assets/search | /assets/search?query=string [GET] [**stream_assets**](AssetsApi.md#stream_assets) | **GET** /assets/stream | /assets/stream [WS] -[**workstream_suggestions_stream**](AssetsApi.md#workstream_suggestions_stream) | **GET** /workstream/suggestions/stream | /workstream/suggestions/stream [WS] # **assets_create_new_asset** @@ -495,80 +494,6 @@ 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) -# **assets_search_assets** -> SearchedAssets assets_search_assets(query=query, transferables=transferables, searchable_tags=searchable_tags, pseudo=pseudo) - -/assets/search?query=string [GET] - -Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. - -### Example - -```python -import time -import os -import pieces_os_client -from pieces_os_client.models.searched_assets import SearchedAssets -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.AssetsApi(api_client) - query = 'query_example' # str | This is a string that you can use to search your assets. (optional) - transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) - searchable_tags = 'searchable_tags_example' # str | This is a comma separated value of tags used for search. (optional) - pseudo = True # bool | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. (optional) - - try: - # /assets/search?query=string [GET] - api_response = api_instance.assets_search_assets(query=query, transferables=transferables, searchable_tags=searchable_tags, pseudo=pseudo) - print("The response of AssetsApi->assets_search_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->assets_search_assets: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| This is a string that you can use to search your assets. | [optional] - **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] - **searchable_tags** | **str**| This is a comma separated value of tags used for search. | [optional] - **pseudo** | **bool**| This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. | [optional] - -### Return type - -[**SearchedAssets**](SearchedAssets.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, text/plain - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**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) - # **assets_search_with_filters** > AssetsSearchWithFiltersOutput assets_search_with_filters(transferables=transferables, pseudo=pseudo, assets_search_with_filters_input=assets_search_with_filters_input) @@ -978,12 +903,12 @@ 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) -# **stream_assets** -> Assets stream_assets() +# **search_assets** +> SearchedAssets search_assets(query=query, transferables=transferables, searchable_tags=searchable_tags, pseudo=pseudo) -/assets/stream [WS] +/assets/search?query=string [GET] -Provides a WebSocket connection that emits changes to your assets. +Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. ### Example @@ -991,7 +916,7 @@ Provides a WebSocket connection that emits changes to your assets. import time import os import pieces_os_client -from pieces_os_client.models.assets import Assets +from pieces_os_client.models.searched_assets import SearchedAssets from pieces_os_client.rest import ApiException from pprint import pprint @@ -1006,24 +931,34 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.AssetsApi(api_client) + query = 'query_example' # str | This is a string that you can use to search your assets. (optional) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + searchable_tags = 'searchable_tags_example' # str | This is a comma separated value of tags used for search. (optional) + pseudo = True # bool | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. (optional) try: - # /assets/stream [WS] - api_response = api_instance.stream_assets() - print("The response of AssetsApi->stream_assets:\n") + # /assets/search?query=string [GET] + api_response = api_instance.search_assets(query=query, transferables=transferables, searchable_tags=searchable_tags, pseudo=pseudo) + print("The response of AssetsApi->search_assets:\n") pprint(api_response) except Exception as e: - print("Exception when calling AssetsApi->stream_assets: %s\n" % e) + print("Exception when calling AssetsApi->search_assets: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| This is a string that you can use to search your assets. | [optional] + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **searchable_tags** | **str**| This is a comma separated value of tags used for search. | [optional] + **pseudo** | **bool**| This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. | [optional] ### Return type -[**Assets**](Assets.md) +[**SearchedAssets**](SearchedAssets.md) ### Authorization @@ -1032,21 +967,22 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | +**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) -# **workstream_suggestions_stream** -> WorkstreamSuggestions workstream_suggestions_stream() +# **stream_assets** +> Assets stream_assets() -/workstream/suggestions/stream [WS] +/assets/stream [WS] -Provides a WebSocket connection that emits changes to your workstream suggestions. +Provides a WebSocket connection that emits changes to your assets. ### Example @@ -1054,7 +990,7 @@ Provides a WebSocket connection that emits changes to your workstream suggestion import time import os import pieces_os_client -from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions +from pieces_os_client.models.assets import Assets from pieces_os_client.rest import ApiException from pprint import pprint @@ -1071,12 +1007,12 @@ with pieces_os_client.ApiClient(configuration) as api_client: api_instance = pieces_os_client.AssetsApi(api_client) try: - # /workstream/suggestions/stream [WS] - api_response = api_instance.workstream_suggestions_stream() - print("The response of AssetsApi->workstream_suggestions_stream:\n") + # /assets/stream [WS] + api_response = api_instance.stream_assets() + print("The response of AssetsApi->stream_assets:\n") pprint(api_response) except Exception as e: - print("Exception when calling AssetsApi->workstream_suggestions_stream: %s\n" % e) + print("Exception when calling AssetsApi->stream_assets: %s\n" % e) ``` @@ -1086,7 +1022,7 @@ This endpoint does not need any parameter. ### Return type -[**WorkstreamSuggestions**](WorkstreamSuggestions.md) +[**Assets**](Assets.md) ### Authorization @@ -1095,13 +1031,12 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, text/plain + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**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) diff --git a/docs/AssetsSearchWithFiltersInput.md b/docs/AssetsSearchWithFiltersInput.md index 4f267cf..4546446 100644 --- a/docs/AssetsSearchWithFiltersInput.md +++ b/docs/AssetsSearchWithFiltersInput.md @@ -25,7 +25,7 @@ print AssetsSearchWithFiltersInput.to_json() # convert the object into a dict assets_search_with_filters_input_dict = assets_search_with_filters_input_instance.to_dict() # create an instance of AssetsSearchWithFiltersInput from a dict -assets_search_with_filters_input_form_dict = assets_search_with_filters_input.from_dict(assets_search_with_filters_input_dict) +assets_search_with_filters_input_from_dict = AssetsSearchWithFiltersInput.from_dict(assets_search_with_filters_input_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/AssetsSearchWithFiltersOutput.md b/docs/AssetsSearchWithFiltersOutput.md index 1116993..cb3f962 100644 --- a/docs/AssetsSearchWithFiltersOutput.md +++ b/docs/AssetsSearchWithFiltersOutput.md @@ -23,7 +23,7 @@ print AssetsSearchWithFiltersOutput.to_json() # convert the object into a dict assets_search_with_filters_output_dict = assets_search_with_filters_output_instance.to_dict() # create an instance of AssetsSearchWithFiltersOutput from a dict -assets_search_with_filters_output_form_dict = assets_search_with_filters_output.from_dict(assets_search_with_filters_output_dict) +assets_search_with_filters_output_from_dict = AssetsSearchWithFiltersOutput.from_dict(assets_search_with_filters_output_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/Auth0.md b/docs/Auth0.md index ee163a8..7c02ed2 100644 --- a/docs/Auth0.md +++ b/docs/Auth0.md @@ -30,7 +30,7 @@ print Auth0.to_json() # convert the object into a dict auth0_dict = auth0_instance.to_dict() # create an instance of Auth0 from a dict -auth0_form_dict = auth0.from_dict(auth0_dict) +auth0_from_dict = Auth0.from_dict(auth0_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/Auth0Identity.md b/docs/Auth0Identity.md index d837ce6..2f88abf 100644 --- a/docs/Auth0Identity.md +++ b/docs/Auth0Identity.md @@ -27,7 +27,7 @@ print Auth0Identity.to_json() # convert the object into a dict auth0_identity_dict = auth0_identity_instance.to_dict() # create an instance of Auth0Identity from a dict -auth0_identity_form_dict = auth0_identity.from_dict(auth0_identity_dict) +auth0_identity_from_dict = Auth0Identity.from_dict(auth0_identity_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/Auth0OpenAIUserMetadata.md b/docs/Auth0OpenAIUserMetadata.md index 1190e80..b61d334 100644 --- a/docs/Auth0OpenAIUserMetadata.md +++ b/docs/Auth0OpenAIUserMetadata.md @@ -25,7 +25,7 @@ print Auth0OpenAIUserMetadata.to_json() # convert the object into a dict auth0_open_ai_user_metadata_dict = auth0_open_ai_user_metadata_instance.to_dict() # create an instance of Auth0OpenAIUserMetadata from a dict -auth0_open_ai_user_metadata_form_dict = auth0_open_ai_user_metadata.from_dict(auth0_open_ai_user_metadata_dict) +auth0_open_ai_user_metadata_from_dict = Auth0OpenAIUserMetadata.from_dict(auth0_open_ai_user_metadata_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/Auth0Redirects.md b/docs/Auth0Redirects.md index 04e3f17..10e5373 100644 --- a/docs/Auth0Redirects.md +++ b/docs/Auth0Redirects.md @@ -23,7 +23,7 @@ print Auth0Redirects.to_json() # convert the object into a dict auth0_redirects_dict = auth0_redirects_instance.to_dict() # create an instance of Auth0Redirects from a dict -auth0_redirects_form_dict = auth0_redirects.from_dict(auth0_redirects_dict) +auth0_redirects_from_dict = Auth0Redirects.from_dict(auth0_redirects_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/Auth0User.md b/docs/Auth0User.md index 8bd0e13..b158e3e 100644 --- a/docs/Auth0User.md +++ b/docs/Auth0User.md @@ -40,7 +40,7 @@ print Auth0User.to_json() # convert the object into a dict auth0_user_dict = auth0_user_instance.to_dict() # create an instance of Auth0User from a dict -auth0_user_form_dict = auth0_user.from_dict(auth0_user_dict) +auth0_user_from_dict = Auth0User.from_dict(auth0_user_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/Auth0UserAllocationMetadata.md b/docs/Auth0UserAllocationMetadata.md index f714c82..1fa0ea6 100644 --- a/docs/Auth0UserAllocationMetadata.md +++ b/docs/Auth0UserAllocationMetadata.md @@ -23,7 +23,7 @@ print Auth0UserAllocationMetadata.to_json() # convert the object into a dict auth0_user_allocation_metadata_dict = auth0_user_allocation_metadata_instance.to_dict() # create an instance of Auth0UserAllocationMetadata from a dict -auth0_user_allocation_metadata_form_dict = auth0_user_allocation_metadata.from_dict(auth0_user_allocation_metadata_dict) +auth0_user_allocation_metadata_from_dict = Auth0UserAllocationMetadata.from_dict(auth0_user_allocation_metadata_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/Auth0UserBetaStatus.md b/docs/Auth0UserBetaStatus.md index 9367cb5..a86ba2f 100644 --- a/docs/Auth0UserBetaStatus.md +++ b/docs/Auth0UserBetaStatus.md @@ -23,7 +23,7 @@ print Auth0UserBetaStatus.to_json() # convert the object into a dict auth0_user_beta_status_dict = auth0_user_beta_status_instance.to_dict() # create an instance of Auth0UserBetaStatus from a dict -auth0_user_beta_status_form_dict = auth0_user_beta_status.from_dict(auth0_user_beta_status_dict) +auth0_user_beta_status_from_dict = Auth0UserBetaStatus.from_dict(auth0_user_beta_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/Auth0UserMetadata.md b/docs/Auth0UserMetadata.md index 04bc427..771915d 100644 --- a/docs/Auth0UserMetadata.md +++ b/docs/Auth0UserMetadata.md @@ -29,7 +29,7 @@ print Auth0UserMetadata.to_json() # convert the object into a dict auth0_user_metadata_dict = auth0_user_metadata_instance.to_dict() # create an instance of Auth0UserMetadata from a dict -auth0_user_metadata_form_dict = auth0_user_metadata.from_dict(auth0_user_metadata_dict) +auth0_user_metadata_from_dict = Auth0UserMetadata.from_dict(auth0_user_metadata_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/AvailableFormats.md b/docs/AvailableFormats.md index d369c53..4165cb9 100644 --- a/docs/AvailableFormats.md +++ b/docs/AvailableFormats.md @@ -23,7 +23,7 @@ print AvailableFormats.to_json() # convert the object into a dict available_formats_dict = available_formats_instance.to_dict() # create an instance of AvailableFormats from a dict -available_formats_form_dict = available_formats.from_dict(available_formats_dict) +available_formats_from_dict = AvailableFormats.from_dict(available_formats_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/Backup.md b/docs/Backup.md index 8bd1882..63029c2 100644 --- a/docs/Backup.md +++ b/docs/Backup.md @@ -29,7 +29,7 @@ print Backup.to_json() # convert the object into a dict backup_dict = backup_instance.to_dict() # create an instance of Backup from a dict -backup_form_dict = backup.from_dict(backup_dict) +backup_from_dict = Backup.from_dict(backup_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/BackupStatus.md b/docs/BackupStatus.md index 986aa91..a405264 100644 --- a/docs/BackupStatus.md +++ b/docs/BackupStatus.md @@ -25,7 +25,7 @@ print BackupStatus.to_json() # convert the object into a dict backup_status_dict = backup_status_instance.to_dict() # create an instance of BackupStatus from a dict -backup_status_form_dict = backup_status.from_dict(backup_status_dict) +backup_status_from_dict = BackupStatus.from_dict(backup_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/BackupStreamedProgress.md b/docs/BackupStreamedProgress.md index 8b2104e..224e0fb 100644 --- a/docs/BackupStreamedProgress.md +++ b/docs/BackupStreamedProgress.md @@ -25,7 +25,7 @@ print BackupStreamedProgress.to_json() # convert the object into a dict backup_streamed_progress_dict = backup_streamed_progress_instance.to_dict() # create an instance of BackupStreamedProgress from a dict -backup_streamed_progress_form_dict = backup_streamed_progress.from_dict(backup_streamed_progress_dict) +backup_streamed_progress_from_dict = BackupStreamedProgress.from_dict(backup_streamed_progress_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/Backups.md b/docs/Backups.md index 3f48f43..5802c50 100644 --- a/docs/Backups.md +++ b/docs/Backups.md @@ -25,7 +25,7 @@ print Backups.to_json() # convert the object into a dict backups_dict = backups_instance.to_dict() # create an instance of Backups from a dict -backups_form_dict = backups.from_dict(backups_dict) +backups_from_dict = Backups.from_dict(backups_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/BrowserSelection.md b/docs/BrowserSelection.md index 47afb88..dc43161 100644 --- a/docs/BrowserSelection.md +++ b/docs/BrowserSelection.md @@ -24,7 +24,7 @@ print BrowserSelection.to_json() # convert the object into a dict browser_selection_dict = browser_selection_instance.to_dict() # create an instance of BrowserSelection from a dict -browser_selection_form_dict = browser_selection.from_dict(browser_selection_dict) +browser_selection_from_dict = BrowserSelection.from_dict(browser_selection_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/BrowserTab.md b/docs/BrowserTab.md index ff87e35..dabf2a6 100644 --- a/docs/BrowserTab.md +++ b/docs/BrowserTab.md @@ -28,7 +28,7 @@ print BrowserTab.to_json() # convert the object into a dict browser_tab_dict = browser_tab_instance.to_dict() # create an instance of BrowserTab from a dict -browser_tab_form_dict = browser_tab.from_dict(browser_tab_dict) +browser_tab_from_dict = BrowserTab.from_dict(browser_tab_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/BrowserTabValue.md b/docs/BrowserTabValue.md index c51e0ab..91db8a5 100644 --- a/docs/BrowserTabValue.md +++ b/docs/BrowserTabValue.md @@ -27,7 +27,7 @@ print BrowserTabValue.to_json() # convert the object into a dict browser_tab_value_dict = browser_tab_value_instance.to_dict() # create an instance of BrowserTabValue from a dict -browser_tab_value_form_dict = browser_tab_value.from_dict(browser_tab_value_dict) +browser_tab_value_from_dict = BrowserTabValue.from_dict(browser_tab_value_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/BrowserTabValues.md b/docs/BrowserTabValues.md index 471a21a..467238c 100644 --- a/docs/BrowserTabValues.md +++ b/docs/BrowserTabValues.md @@ -23,7 +23,7 @@ print BrowserTabValues.to_json() # convert the object into a dict browser_tab_values_dict = browser_tab_values_instance.to_dict() # create an instance of BrowserTabValues from a dict -browser_tab_values_form_dict = browser_tab_values.from_dict(browser_tab_values_dict) +browser_tab_values_from_dict = BrowserTabValues.from_dict(browser_tab_values_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/BrowserTabs.md b/docs/BrowserTabs.md index 09b2904..8741397 100644 --- a/docs/BrowserTabs.md +++ b/docs/BrowserTabs.md @@ -23,7 +23,7 @@ print BrowserTabs.to_json() # convert the object into a dict browser_tabs_dict = browser_tabs_instance.to_dict() # create an instance of BrowserTabs from a dict -browser_tabs_form_dict = browser_tabs.from_dict(browser_tabs_dict) +browser_tabs_from_dict = BrowserTabs.from_dict(browser_tabs_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/ByteDescriptor.md b/docs/ByteDescriptor.md index 7e9a6b2..1646307 100644 --- a/docs/ByteDescriptor.md +++ b/docs/ByteDescriptor.md @@ -24,7 +24,7 @@ print ByteDescriptor.to_json() # convert the object into a dict byte_descriptor_dict = byte_descriptor_instance.to_dict() # create an instance of ByteDescriptor from a dict -byte_descriptor_form_dict = byte_descriptor.from_dict(byte_descriptor_dict) +byte_descriptor_from_dict = ByteDescriptor.from_dict(byte_descriptor_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/ChallengedPKCE.md b/docs/ChallengedPKCE.md index ee6177a..df21ad8 100644 --- a/docs/ChallengedPKCE.md +++ b/docs/ChallengedPKCE.md @@ -27,7 +27,7 @@ print ChallengedPKCE.to_json() # convert the object into a dict challenged_pkce_dict = challenged_pkce_instance.to_dict() # create an instance of ChallengedPKCE from a dict -challenged_pkce_form_dict = challenged_pkce.from_dict(challenged_pkce_dict) +challenged_pkce_from_dict = ChallengedPKCE.from_dict(challenged_pkce_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/CheckedOSUpdate.md b/docs/CheckedOSUpdate.md index 08d625b..ead0afb 100644 --- a/docs/CheckedOSUpdate.md +++ b/docs/CheckedOSUpdate.md @@ -1,30 +1,18 @@ +--- +title: CheckedOSUpdate | Python SDK +--- + # CheckedOSUpdate -This is the returnable for /os/update/check +This is the model for the progress of the current update of Pieces os. /os/update/check/stream && /os/update/check/ we will emit on a progress update updated: is an optional property that will let us know when the update was checked last. NOTE: it is reccommended to use the stream instead of pulling. NOTE: lets think about if we want to have a closing(as well as how we want to handle restarts) ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] **status** | [**UpdatingStatusEnum**](UpdatingStatusEnum.md) | | - -## Example - -```python -from pieces_os_client.models.checked_os_update import CheckedOSUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of CheckedOSUpdate from a JSON string -checked_os_update_instance = CheckedOSUpdate.from_json(json) -# print the JSON string representation of the object -print CheckedOSUpdate.to_json() - -# convert the object into a dict -checked_os_update_dict = checked_os_update_instance.to_dict() -# create an instance of CheckedOSUpdate from a dict -checked_os_update_form_dict = checked_os_update.from_dict(checked_os_update_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) +**updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional] +**percentage** | **float** | Optionally if the update is in progress you will recieve a download percent(from 0-100). | [optional] diff --git a/docs/Classification.md b/docs/Classification.md index 2f08d85..fcf97da 100644 --- a/docs/Classification.md +++ b/docs/Classification.md @@ -25,7 +25,7 @@ print Classification.to_json() # convert the object into a dict classification_dict = classification_instance.to_dict() # create an instance of Classification from a dict -classification_form_dict = classification.from_dict(classification_dict) +classification_from_dict = Classification.from_dict(classification_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/Classifications.md b/docs/Classifications.md index 039f733..be36de8 100644 --- a/docs/Classifications.md +++ b/docs/Classifications.md @@ -23,7 +23,7 @@ print Classifications.to_json() # convert the object into a dict classifications_dict = classifications_instance.to_dict() # create an instance of Classifications from a dict -classifications_form_dict = classifications.from_dict(classifications_dict) +classifications_from_dict = Classifications.from_dict(classifications_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/CodeAnalyses.md b/docs/CodeAnalyses.md index e0e44f0..871778d 100644 --- a/docs/CodeAnalyses.md +++ b/docs/CodeAnalyses.md @@ -22,7 +22,7 @@ print CodeAnalyses.to_json() # convert the object into a dict code_analyses_dict = code_analyses_instance.to_dict() # create an instance of CodeAnalyses from a dict -code_analyses_form_dict = code_analyses.from_dict(code_analyses_dict) +code_analyses_from_dict = CodeAnalyses.from_dict(code_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/CodeAnalysis.md b/docs/CodeAnalysis.md index d763dda..378b5b4 100644 --- a/docs/CodeAnalysis.md +++ b/docs/CodeAnalysis.md @@ -32,7 +32,7 @@ print CodeAnalysis.to_json() # convert the object into a dict code_analysis_dict = code_analysis_instance.to_dict() # create an instance of CodeAnalysis from a dict -code_analysis_form_dict = code_analysis.from_dict(code_analysis_dict) +code_analysis_from_dict = CodeAnalysis.from_dict(code_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/Context.md b/docs/Context.md index 5c34a01..b17eaef 100644 --- a/docs/Context.md +++ b/docs/Context.md @@ -26,7 +26,7 @@ print Context.to_json() # convert the object into a dict context_dict = context_instance.to_dict() # create an instance of Context from a dict -context_form_dict = context.from_dict(context_dict) +context_from_dict = Context.from_dict(context_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/Conversation.md b/docs/Conversation.md index 3c3fc43..fe8cbd9 100644 --- a/docs/Conversation.md +++ b/docs/Conversation.md @@ -41,7 +41,7 @@ print Conversation.to_json() # convert the object into a dict conversation_dict = conversation_instance.to_dict() # create an instance of Conversation from a dict -conversation_form_dict = conversation.from_dict(conversation_dict) +conversation_from_dict = Conversation.from_dict(conversation_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/ConversationApi.md b/docs/ConversationApi.md index 2e685c7..f6d6878 100644 --- a/docs/ConversationApi.md +++ b/docs/ConversationApi.md @@ -9,8 +9,8 @@ Method | HTTP request | Description [**conversation_associate_grounding_temporal_range_workstream**](ConversationApi.md#conversation_associate_grounding_temporal_range_workstream) | **POST** /conversation/{conversation}/grounding/temporal_range/workstreams/associate/{range} | /conversation/{conversation}/grounding/temporal/ranges/associate/{range} [POST] [**conversation_associate_website**](ConversationApi.md#conversation_associate_website) | **POST** /conversation/{conversation}/websites/associate/{website} | /conversation/{conversation}/websites/associate/{website} [POST] [**conversation_associate_workstream_summary**](ConversationApi.md#conversation_associate_workstream_summary) | **POST** /conversation/{conversation}/workstream_summaries/associate/{workstream_summary} | /conversation/{conversation}/workstream_summaries/associate/{workstream_summary} [POST] -[**conversation_disassociate_anchor**](ConversationApi.md#conversation_disassociate_anchor) | **POST** /conversation/{conversation}/anchors/delete/{anchor} | /conversation/{conversation}/anchors/delete/{anchor} [POST] -[**conversation_disassociate_asset**](ConversationApi.md#conversation_disassociate_asset) | **POST** /conversation/{conversation}/assets/delete/{asset} | /conversation/{conversation}/assets/delete/{asset} [POST] +[**conversation_disassociate_anchor**](ConversationApi.md#conversation_disassociate_anchor) | **POST** /conversation/{conversation}/anchors/disassociate/{anchor} | /conversation/{conversation}/anchors/disassociate/{anchor} [POST] +[**conversation_disassociate_asset**](ConversationApi.md#conversation_disassociate_asset) | **POST** /conversation/{conversation}/assets/disassociate/{asset} | /conversation/{conversation}/assets/disassociate/{asset} [POST] [**conversation_disassociate_grounding_temporal_range_workstream**](ConversationApi.md#conversation_disassociate_grounding_temporal_range_workstream) | **POST** /conversation/{conversation}/grounding/temporal_range/workstreams/disassociate/{range} | /conversation/{conversation}/grounding/temporal_range/workstreams/disassociate/{range} [POST] [**conversation_disassociate_website**](ConversationApi.md#conversation_disassociate_website) | **POST** /conversation/{conversation}/websites/disassociate/{website} | /website/{website}/websites/disassociate/{website} [POST] [**conversation_disassociate_workstream_summary**](ConversationApi.md#conversation_disassociate_workstream_summary) | **POST** /conversation/{conversation}/workstream_summaries/disassociate/{workstream_summary} | /conversation/{conversation}/workstream_summaries/disassociate/{workstream_summary} [POST] @@ -22,6 +22,7 @@ Method | HTTP request | Description [**conversation_specific_conversation_rename**](ConversationApi.md#conversation_specific_conversation_rename) | **POST** /conversation/{conversation}/rename | /conversation/{conversation}/rename [POST] [**conversation_summarize**](ConversationApi.md#conversation_summarize) | **POST** /conversation/{conversation}/summarize | /conversation/{conversation}/summarize [POST] [**conversation_update**](ConversationApi.md#conversation_update) | **POST** /conversation/update | /conversation/update [POST] +[**search_conversation_specific_messages**](ConversationApi.md#search_conversation_specific_messages) | **POST** /conversation/{conversation}/search | /conversation/{conversation}/search [POST] # **conversation_associate_anchor** @@ -362,7 +363,7 @@ No authorization required # **conversation_disassociate_anchor** > conversation_disassociate_anchor(conversation, anchor) -/conversation/{conversation}/anchors/delete/{anchor} [POST] +/conversation/{conversation}/anchors/disassociate/{anchor} [POST] Updates both the anchor and the conversation, deleting (disassociating) them simultaneously. @@ -390,7 +391,7 @@ with pieces_os_client.ApiClient(configuration) as api_client: anchor = 'anchor_example' # str | This is the specific uuid of an anchor. try: - # /conversation/{conversation}/anchors/delete/{anchor} [POST] + # /conversation/{conversation}/anchors/disassociate/{anchor} [POST] api_instance.conversation_disassociate_anchor(conversation, anchor) except Exception as e: print("Exception when calling ConversationApi->conversation_disassociate_anchor: %s\n" % e) @@ -429,7 +430,7 @@ No authorization required # **conversation_disassociate_asset** > conversation_disassociate_asset(conversation, asset) -/conversation/{conversation}/assets/delete/{asset} [POST] +/conversation/{conversation}/assets/disassociate/{asset} [POST] Updates both the asset and the conversation, effectively disassociating them. @@ -457,7 +458,7 @@ with pieces_os_client.ApiClient(configuration) as api_client: asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. try: - # /conversation/{conversation}/assets/delete/{asset} [POST] + # /conversation/{conversation}/assets/disassociate/{asset} [POST] api_instance.conversation_disassociate_asset(conversation, asset) except Exception as e: print("Exception when calling ConversationApi->conversation_disassociate_asset: %s\n" % e) @@ -1247,3 +1248,76 @@ 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) +# **search_conversation_specific_messages** +> SearchedConversationMessages search_conversation_specific_messages(conversation, transferables=transferables, search_input=search_input) + +/conversation/{conversation}/search [POST] + +This will search a specific conversation for a match note: here we will only search the conversationMessages for this given Conversation + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages +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.ConversationApi(api_client) + conversation = 'conversation_example' # str | This is the uuid of a conversation. + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /conversation/{conversation}/search [POST] + api_response = api_instance.search_conversation_specific_messages(conversation, transferables=transferables, search_input=search_input) + print("The response of ConversationApi->search_conversation_specific_messages:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConversationApi->search_conversation_specific_messages: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **conversation** | **str**| This is the uuid of a conversation. | + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedConversationMessages**](SearchedConversationMessages.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/ConversationGrounding.md b/docs/ConversationGrounding.md index b23d20e..acfd59a 100644 --- a/docs/ConversationGrounding.md +++ b/docs/ConversationGrounding.md @@ -24,7 +24,7 @@ print ConversationGrounding.to_json() # convert the object into a dict conversation_grounding_dict = conversation_grounding_instance.to_dict() # create an instance of ConversationGrounding from a dict -conversation_grounding_form_dict = conversation_grounding.from_dict(conversation_grounding_dict) +conversation_grounding_from_dict = ConversationGrounding.from_dict(conversation_grounding_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/ConversationMessage.md b/docs/ConversationMessage.md index 8f9a9a5..99298a7 100644 --- a/docs/ConversationMessage.md +++ b/docs/ConversationMessage.md @@ -33,7 +33,7 @@ print ConversationMessage.to_json() # convert the object into a dict conversation_message_dict = conversation_message_instance.to_dict() # create an instance of ConversationMessage from a dict -conversation_message_form_dict = conversation_message.from_dict(conversation_message_dict) +conversation_message_from_dict = ConversationMessage.from_dict(conversation_message_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/ConversationMessages.md b/docs/ConversationMessages.md index a82ec1f..750fcd9 100644 --- a/docs/ConversationMessages.md +++ b/docs/ConversationMessages.md @@ -25,7 +25,7 @@ print ConversationMessages.to_json() # convert the object into a dict conversation_messages_dict = conversation_messages_instance.to_dict() # create an instance of ConversationMessages from a dict -conversation_messages_form_dict = conversation_messages.from_dict(conversation_messages_dict) +conversation_messages_from_dict = ConversationMessages.from_dict(conversation_messages_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/ConversationMessagesApi.md b/docs/ConversationMessagesApi.md index 52e771c..95859b0 100644 --- a/docs/ConversationMessagesApi.md +++ b/docs/ConversationMessagesApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**messages_create_specific_message**](ConversationMessagesApi.md#messages_create_specific_message) | **POST** /messages/create | /messages/create [POST] [**messages_delete_specific_message**](ConversationMessagesApi.md#messages_delete_specific_message) | **POST** /messages/{message}/delete | /messages/{message}/delete [POST] [**messages_snapshot**](ConversationMessagesApi.md#messages_snapshot) | **GET** /messages | /messages [GET] +[**search_messages**](ConversationMessagesApi.md#search_messages) | **POST** /messages/search | /messages/search [POST] # **messages_create_specific_message** @@ -213,3 +214,74 @@ 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) +# **search_messages** +> SearchedConversationMessages search_messages(transferables=transferables, search_input=search_input) + +/messages/search [POST] + +This will search your conversationMessages for a specific conversation_message note: we will just search the conversation message values + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages +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.ConversationMessagesApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /messages/search [POST] + api_response = api_instance.search_messages(transferables=transferables, search_input=search_input) + print("The response of ConversationMessagesApi->search_messages:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConversationMessagesApi->search_messages: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedConversationMessages**](SearchedConversationMessages.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/ConversationSummarizeInput.md b/docs/ConversationSummarizeInput.md index c597b7e..2a3a221 100644 --- a/docs/ConversationSummarizeInput.md +++ b/docs/ConversationSummarizeInput.md @@ -23,7 +23,7 @@ print ConversationSummarizeInput.to_json() # convert the object into a dict conversation_summarize_input_dict = conversation_summarize_input_instance.to_dict() # create an instance of ConversationSummarizeInput from a dict -conversation_summarize_input_form_dict = conversation_summarize_input.from_dict(conversation_summarize_input_dict) +conversation_summarize_input_from_dict = ConversationSummarizeInput.from_dict(conversation_summarize_input_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/ConversationSummarizeOutput.md b/docs/ConversationSummarizeOutput.md index a2b3ac4..574ed76 100644 --- a/docs/ConversationSummarizeOutput.md +++ b/docs/ConversationSummarizeOutput.md @@ -24,7 +24,7 @@ print ConversationSummarizeOutput.to_json() # convert the object into a dict conversation_summarize_output_dict = conversation_summarize_output_instance.to_dict() # create an instance of ConversationSummarizeOutput from a dict -conversation_summarize_output_form_dict = conversation_summarize_output.from_dict(conversation_summarize_output_dict) +conversation_summarize_output_from_dict = ConversationSummarizeOutput.from_dict(conversation_summarize_output_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/Conversations.md b/docs/Conversations.md index 67ef4a1..e43a521 100644 --- a/docs/Conversations.md +++ b/docs/Conversations.md @@ -25,7 +25,7 @@ print Conversations.to_json() # convert the object into a dict conversations_dict = conversations_instance.to_dict() # create an instance of Conversations from a dict -conversations_form_dict = conversations.from_dict(conversations_dict) +conversations_from_dict = Conversations.from_dict(conversations_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/ConversationsApi.md b/docs/ConversationsApi.md index d4218e0..d7d4307 100644 --- a/docs/ConversationsApi.md +++ b/docs/ConversationsApi.md @@ -10,6 +10,7 @@ Method | HTTP request | Description [**conversations_identifiers_snapshot**](ConversationsApi.md#conversations_identifiers_snapshot) | **GET** /conversations/identifiers | /conversations/identifiers [GET] [**conversations_snapshot**](ConversationsApi.md#conversations_snapshot) | **GET** /conversations | /conversations [GET] [**conversations_stream_identifiers**](ConversationsApi.md#conversations_stream_identifiers) | **GET** /conversations/stream/identifiers | /conversations/stream/identifiers [WS] +[**search_conversations**](ConversationsApi.md#search_conversations) | **POST** /conversations/search | /conversations/search [POST] # **conversations_create_from_asset** @@ -404,3 +405,74 @@ 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) +# **search_conversations** +> SearchedConversations search_conversations(transferables=transferables, search_input=search_input) + +/conversations/search [POST] + +This will search your conversations for a specific conversation note: we will search annotations, the name of the conversation, and the conversation messages + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversations import SearchedConversations +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.ConversationsApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /conversations/search [POST] + api_response = api_instance.search_conversations(transferables=transferables, search_input=search_input) + print("The response of ConversationsApi->search_conversations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConversationsApi->search_conversations: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedConversations**](SearchedConversations.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/ConversationsCreateFromAssetOutput.md b/docs/ConversationsCreateFromAssetOutput.md index 4a6c681..7a9d786 100644 --- a/docs/ConversationsCreateFromAssetOutput.md +++ b/docs/ConversationsCreateFromAssetOutput.md @@ -23,7 +23,7 @@ print ConversationsCreateFromAssetOutput.to_json() # convert the object into a dict conversations_create_from_asset_output_dict = conversations_create_from_asset_output_instance.to_dict() # create an instance of ConversationsCreateFromAssetOutput from a dict -conversations_create_from_asset_output_form_dict = conversations_create_from_asset_output.from_dict(conversations_create_from_asset_output_dict) +conversations_create_from_asset_output_from_dict = ConversationsCreateFromAssetOutput.from_dict(conversations_create_from_asset_output_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/CreatedExternalProviderApiKey.md b/docs/CreatedExternalProviderApiKey.md index a31b3a1..add8be1 100644 --- a/docs/CreatedExternalProviderApiKey.md +++ b/docs/CreatedExternalProviderApiKey.md @@ -23,7 +23,7 @@ print CreatedExternalProviderApiKey.to_json() # convert the object into a dict created_external_provider_api_key_dict = created_external_provider_api_key_instance.to_dict() # create an instance of CreatedExternalProviderApiKey from a dict -created_external_provider_api_key_form_dict = created_external_provider_api_key.from_dict(created_external_provider_api_key_dict) +created_external_provider_api_key_from_dict = CreatedExternalProviderApiKey.from_dict(created_external_provider_api_key_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/DeletedExternalProviderApiKey.md b/docs/DeletedExternalProviderApiKey.md index 16cd48a..79711d4 100644 --- a/docs/DeletedExternalProviderApiKey.md +++ b/docs/DeletedExternalProviderApiKey.md @@ -23,7 +23,7 @@ print DeletedExternalProviderApiKey.to_json() # convert the object into a dict deleted_external_provider_api_key_dict = deleted_external_provider_api_key_instance.to_dict() # create an instance of DeletedExternalProviderApiKey from a dict -deleted_external_provider_api_key_form_dict = deleted_external_provider_api_key.from_dict(deleted_external_provider_api_key_dict) +deleted_external_provider_api_key_from_dict = DeletedExternalProviderApiKey.from_dict(deleted_external_provider_api_key_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/DetectedExternalApplication.md b/docs/DetectedExternalApplication.md index f775cac..2b6ffd4 100644 --- a/docs/DetectedExternalApplication.md +++ b/docs/DetectedExternalApplication.md @@ -24,7 +24,7 @@ print DetectedExternalApplication.to_json() # convert the object into a dict detected_external_application_dict = detected_external_application_instance.to_dict() # create an instance of DetectedExternalApplication from a dict -detected_external_application_form_dict = detected_external_application.from_dict(detected_external_application_dict) +detected_external_application_from_dict = DetectedExternalApplication.from_dict(detected_external_application_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/DetectedExternalApplications.md b/docs/DetectedExternalApplications.md index c845514..01475de 100644 --- a/docs/DetectedExternalApplications.md +++ b/docs/DetectedExternalApplications.md @@ -23,7 +23,7 @@ print DetectedExternalApplications.to_json() # convert the object into a dict detected_external_applications_dict = detected_external_applications_instance.to_dict() # create an instance of DetectedExternalApplications from a dict -detected_external_applications_form_dict = detected_external_applications.from_dict(detected_external_applications_dict) +detected_external_applications_from_dict = DetectedExternalApplications.from_dict(detected_external_applications_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/DiscoveredAsset.md b/docs/DiscoveredAsset.md index 93ab25b..6df1898 100644 --- a/docs/DiscoveredAsset.md +++ b/docs/DiscoveredAsset.md @@ -27,7 +27,7 @@ print DiscoveredAsset.to_json() # convert the object into a dict discovered_asset_dict = discovered_asset_instance.to_dict() # create an instance of DiscoveredAsset from a dict -discovered_asset_form_dict = discovered_asset.from_dict(discovered_asset_dict) +discovered_asset_from_dict = DiscoveredAsset.from_dict(discovered_asset_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/DiscoveredAssets.md b/docs/DiscoveredAssets.md index 9f087b0..e024af2 100644 --- a/docs/DiscoveredAssets.md +++ b/docs/DiscoveredAssets.md @@ -24,7 +24,7 @@ print DiscoveredAssets.to_json() # convert the object into a dict discovered_assets_dict = discovered_assets_instance.to_dict() # create an instance of DiscoveredAssets from a dict -discovered_assets_form_dict = discovered_assets.from_dict(discovered_assets_dict) +discovered_assets_from_dict = DiscoveredAssets.from_dict(discovered_assets_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/DiscoveredHtmlWebpage.md b/docs/DiscoveredHtmlWebpage.md index 02600fb..2ecc3cb 100644 --- a/docs/DiscoveredHtmlWebpage.md +++ b/docs/DiscoveredHtmlWebpage.md @@ -24,7 +24,7 @@ print DiscoveredHtmlWebpage.to_json() # convert the object into a dict discovered_html_webpage_dict = discovered_html_webpage_instance.to_dict() # create an instance of DiscoveredHtmlWebpage from a dict -discovered_html_webpage_form_dict = discovered_html_webpage.from_dict(discovered_html_webpage_dict) +discovered_html_webpage_from_dict = DiscoveredHtmlWebpage.from_dict(discovered_html_webpage_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/DiscoveredHtmlWebpages.md b/docs/DiscoveredHtmlWebpages.md index 6683a37..b4b6770 100644 --- a/docs/DiscoveredHtmlWebpages.md +++ b/docs/DiscoveredHtmlWebpages.md @@ -24,7 +24,7 @@ print DiscoveredHtmlWebpages.to_json() # convert the object into a dict discovered_html_webpages_dict = discovered_html_webpages_instance.to_dict() # create an instance of DiscoveredHtmlWebpages from a dict -discovered_html_webpages_form_dict = discovered_html_webpages.from_dict(discovered_html_webpages_dict) +discovered_html_webpages_from_dict = DiscoveredHtmlWebpages.from_dict(discovered_html_webpages_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/DiscoveredRelatedTag.md b/docs/DiscoveredRelatedTag.md index 8e3445b..37ae0e4 100644 --- a/docs/DiscoveredRelatedTag.md +++ b/docs/DiscoveredRelatedTag.md @@ -22,7 +22,7 @@ print DiscoveredRelatedTag.to_json() # convert the object into a dict discovered_related_tag_dict = discovered_related_tag_instance.to_dict() # create an instance of DiscoveredRelatedTag from a dict -discovered_related_tag_form_dict = discovered_related_tag.from_dict(discovered_related_tag_dict) +discovered_related_tag_from_dict = DiscoveredRelatedTag.from_dict(discovered_related_tag_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/DiscoveredRelatedTags.md b/docs/DiscoveredRelatedTags.md index 09d08ec..0ab42a8 100644 --- a/docs/DiscoveredRelatedTags.md +++ b/docs/DiscoveredRelatedTags.md @@ -23,7 +23,7 @@ print DiscoveredRelatedTags.to_json() # convert the object into a dict discovered_related_tags_dict = discovered_related_tags_instance.to_dict() # create an instance of DiscoveredRelatedTags from a dict -discovered_related_tags_form_dict = discovered_related_tags.from_dict(discovered_related_tags_dict) +discovered_related_tags_from_dict = DiscoveredRelatedTags.from_dict(discovered_related_tags_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/DiscoveredSensitive.md b/docs/DiscoveredSensitive.md index 6cbbfff..76ff470 100644 --- a/docs/DiscoveredSensitive.md +++ b/docs/DiscoveredSensitive.md @@ -24,7 +24,7 @@ print DiscoveredSensitive.to_json() # convert the object into a dict discovered_sensitive_dict = discovered_sensitive_instance.to_dict() # create an instance of DiscoveredSensitive from a dict -discovered_sensitive_form_dict = discovered_sensitive.from_dict(discovered_sensitive_dict) +discovered_sensitive_from_dict = DiscoveredSensitive.from_dict(discovered_sensitive_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/DiscoveredSensitives.md b/docs/DiscoveredSensitives.md index fbe568f..92ddd10 100644 --- a/docs/DiscoveredSensitives.md +++ b/docs/DiscoveredSensitives.md @@ -24,7 +24,7 @@ print DiscoveredSensitives.to_json() # convert the object into a dict discovered_sensitives_dict = discovered_sensitives_instance.to_dict() # create an instance of DiscoveredSensitives from a dict -discovered_sensitives_form_dict = discovered_sensitives.from_dict(discovered_sensitives_dict) +discovered_sensitives_from_dict = DiscoveredSensitives.from_dict(discovered_sensitives_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/Distribution.md b/docs/Distribution.md index 5df7416..4b73fa3 100644 --- a/docs/Distribution.md +++ b/docs/Distribution.md @@ -29,7 +29,7 @@ print Distribution.to_json() # convert the object into a dict distribution_dict = distribution_instance.to_dict() # create an instance of Distribution from a dict -distribution_form_dict = distribution.from_dict(distribution_dict) +distribution_from_dict = Distribution.from_dict(distribution_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/Distributions.md b/docs/Distributions.md index ee584be..d4b7b37 100644 --- a/docs/Distributions.md +++ b/docs/Distributions.md @@ -23,7 +23,7 @@ print Distributions.to_json() # convert the object into a dict distributions_dict = distributions_instance.to_dict() # create an instance of Distributions from a dict -distributions_form_dict = distributions.from_dict(distributions_dict) +distributions_from_dict = Distributions.from_dict(distributions_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/DocumentContributor.md b/docs/DocumentContributor.md index f4adb69..32b7ff0 100644 --- a/docs/DocumentContributor.md +++ b/docs/DocumentContributor.md @@ -26,7 +26,7 @@ print DocumentContributor.to_json() # convert the object into a dict document_contributor_dict = document_contributor_instance.to_dict() # create an instance of DocumentContributor from a dict -document_contributor_form_dict = document_contributor.from_dict(document_contributor_dict) +document_contributor_from_dict = DocumentContributor.from_dict(document_contributor_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/DocumentContributors.md b/docs/DocumentContributors.md index 6e8c1e9..0df76ee 100644 --- a/docs/DocumentContributors.md +++ b/docs/DocumentContributors.md @@ -23,7 +23,7 @@ print DocumentContributors.to_json() # convert the object into a dict document_contributors_dict = document_contributors_instance.to_dict() # create an instance of DocumentContributors from a dict -document_contributors_form_dict = document_contributors.from_dict(document_contributors_dict) +document_contributors_from_dict = DocumentContributors.from_dict(document_contributors_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/Edges.md b/docs/Edges.md index 689d4c9..5bd74c0 100644 --- a/docs/Edges.md +++ b/docs/Edges.md @@ -21,7 +21,7 @@ print Edges.to_json() # convert the object into a dict edges_dict = edges_instance.to_dict() # create an instance of Edges from a dict -edges_form_dict = edges.from_dict(edges_dict) +edges_from_dict = Edges.from_dict(edges_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/EmbeddedModelSchema.md b/docs/EmbeddedModelSchema.md index 0c36b19..bac6474 100644 --- a/docs/EmbeddedModelSchema.md +++ b/docs/EmbeddedModelSchema.md @@ -23,7 +23,7 @@ print EmbeddedModelSchema.to_json() # convert the object into a dict embedded_model_schema_dict = embedded_model_schema_instance.to_dict() # create an instance of EmbeddedModelSchema from a dict -embedded_model_schema_form_dict = embedded_model_schema.from_dict(embedded_model_schema_dict) +embedded_model_schema_from_dict = EmbeddedModelSchema.from_dict(embedded_model_schema_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/Embedding.md b/docs/Embedding.md index 537c500..a7b8601 100644 --- a/docs/Embedding.md +++ b/docs/Embedding.md @@ -26,7 +26,7 @@ print Embedding.to_json() # convert the object into a dict embedding_dict = embedding_instance.to_dict() # create an instance of Embedding from a dict -embedding_form_dict = embedding.from_dict(embedding_dict) +embedding_from_dict = Embedding.from_dict(embedding_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/Embeddings.md b/docs/Embeddings.md index a35511a..d41ec48 100644 --- a/docs/Embeddings.md +++ b/docs/Embeddings.md @@ -21,7 +21,7 @@ print Embeddings.to_json() # convert the object into a dict embeddings_dict = embeddings_instance.to_dict() # create an instance of Embeddings from a dict -embeddings_form_dict = embeddings.from_dict(embeddings_dict) +embeddings_from_dict = Embeddings.from_dict(embeddings_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/EmbeddingsSearchOptions.md b/docs/EmbeddingsSearchOptions.md new file mode 100644 index 0000000..5f03dda --- /dev/null +++ b/docs/EmbeddingsSearchOptions.md @@ -0,0 +1,31 @@ +# EmbeddingsSearchOptions + +similarity: this is optional from 0 - 1, (where 1 is exact and 0 is everything) TODO consider a plural of types for running many embedding search scopes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**type** | [**EmbeddingsSearchOptionsEmbeddingTypeEnum**](EmbeddingsSearchOptionsEmbeddingTypeEnum.md) | | +**similarity** | **float** | | [optional] + +## Example + +```python +from pieces_os_client.models.embeddings_search_options import EmbeddingsSearchOptions + +# TODO update the JSON string below +json = "{}" +# create an instance of EmbeddingsSearchOptions from a JSON string +embeddings_search_options_instance = EmbeddingsSearchOptions.from_json(json) +# print the JSON string representation of the object +print EmbeddingsSearchOptions.to_json() + +# convert the object into a dict +embeddings_search_options_dict = embeddings_search_options_instance.to_dict() +# create an instance of EmbeddingsSearchOptions from a dict +embeddings_search_options_from_dict = EmbeddingsSearchOptions.from_dict(embeddings_search_options_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/EmbeddingsSearchOptionsEmbeddingTypeEnum.md b/docs/EmbeddingsSearchOptionsEmbeddingTypeEnum.md new file mode 100644 index 0000000..f980383 --- /dev/null +++ b/docs/EmbeddingsSearchOptionsEmbeddingTypeEnum.md @@ -0,0 +1,11 @@ +# EmbeddingsSearchOptionsEmbeddingTypeEnum + +TODO + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/ExistentMetadata.md b/docs/ExistentMetadata.md index a355f52..058456e 100644 --- a/docs/ExistentMetadata.md +++ b/docs/ExistentMetadata.md @@ -23,7 +23,7 @@ print ExistentMetadata.to_json() # convert the object into a dict existent_metadata_dict = existent_metadata_instance.to_dict() # create an instance of ExistentMetadata from a dict -existent_metadata_form_dict = existent_metadata.from_dict(existent_metadata_dict) +existent_metadata_from_dict = ExistentMetadata.from_dict(existent_metadata_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/ExistingMetadata.md b/docs/ExistingMetadata.md index f1be686..87cb5a3 100644 --- a/docs/ExistingMetadata.md +++ b/docs/ExistingMetadata.md @@ -24,7 +24,7 @@ print ExistingMetadata.to_json() # convert the object into a dict existing_metadata_dict = existing_metadata_instance.to_dict() # create an instance of ExistingMetadata from a dict -existing_metadata_form_dict = existing_metadata.from_dict(existing_metadata_dict) +existing_metadata_from_dict = ExistingMetadata.from_dict(existing_metadata_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/ExportedAsset.md b/docs/ExportedAsset.md index f11d29a..8ee5252 100644 --- a/docs/ExportedAsset.md +++ b/docs/ExportedAsset.md @@ -25,7 +25,7 @@ print ExportedAsset.to_json() # convert the object into a dict exported_asset_dict = exported_asset_instance.to_dict() # create an instance of ExportedAsset from a dict -exported_asset_form_dict = exported_asset.from_dict(exported_asset_dict) +exported_asset_from_dict = ExportedAsset.from_dict(exported_asset_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/ExportedDatabase.md b/docs/ExportedDatabase.md index 87872bd..89d3a4f 100644 --- a/docs/ExportedDatabase.md +++ b/docs/ExportedDatabase.md @@ -51,7 +51,7 @@ print ExportedDatabase.to_json() # convert the object into a dict exported_database_dict = exported_database_instance.to_dict() # create an instance of ExportedDatabase from a dict -exported_database_form_dict = exported_database.from_dict(exported_database_dict) +exported_database_from_dict = ExportedDatabase.from_dict(exported_database_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/ExportedDatabaseFormat.md b/docs/ExportedDatabaseFormat.md index b930538..30c278d 100644 --- a/docs/ExportedDatabaseFormat.md +++ b/docs/ExportedDatabaseFormat.md @@ -23,7 +23,7 @@ print ExportedDatabaseFormat.to_json() # convert the object into a dict exported_database_format_dict = exported_database_format_instance.to_dict() # create an instance of ExportedDatabaseFormat from a dict -exported_database_format_form_dict = exported_database_format.from_dict(exported_database_format_dict) +exported_database_format_from_dict = ExportedDatabaseFormat.from_dict(exported_database_format_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/ExportedDatabaseFormats.md b/docs/ExportedDatabaseFormats.md index e80aa7d..2844985 100644 --- a/docs/ExportedDatabaseFormats.md +++ b/docs/ExportedDatabaseFormats.md @@ -22,7 +22,7 @@ print ExportedDatabaseFormats.to_json() # convert the object into a dict exported_database_formats_dict = exported_database_formats_instance.to_dict() # create an instance of ExportedDatabaseFormats from a dict -exported_database_formats_form_dict = exported_database_formats.from_dict(exported_database_formats_dict) +exported_database_formats_from_dict = ExportedDatabaseFormats.from_dict(exported_database_formats_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/ExternalProvider.md b/docs/ExternalProvider.md index d174db6..f371014 100644 --- a/docs/ExternalProvider.md +++ b/docs/ExternalProvider.md @@ -31,7 +31,7 @@ print ExternalProvider.to_json() # convert the object into a dict external_provider_dict = external_provider_instance.to_dict() # create an instance of ExternalProvider from a dict -external_provider_form_dict = external_provider.from_dict(external_provider_dict) +external_provider_from_dict = ExternalProvider.from_dict(external_provider_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/ExternalProviderProfileData.md b/docs/ExternalProviderProfileData.md index f0df853..7ee6216 100644 --- a/docs/ExternalProviderProfileData.md +++ b/docs/ExternalProviderProfileData.md @@ -59,7 +59,7 @@ print ExternalProviderProfileData.to_json() # convert the object into a dict external_provider_profile_data_dict = external_provider_profile_data_instance.to_dict() # create an instance of ExternalProviderProfileData from a dict -external_provider_profile_data_form_dict = external_provider_profile_data.from_dict(external_provider_profile_data_dict) +external_provider_profile_data_from_dict = ExternalProviderProfileData.from_dict(external_provider_profile_data_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/ExternalProviders.md b/docs/ExternalProviders.md index 41d718a..035833a 100644 --- a/docs/ExternalProviders.md +++ b/docs/ExternalProviders.md @@ -22,7 +22,7 @@ print ExternalProviders.to_json() # convert the object into a dict external_providers_dict = external_providers_instance.to_dict() # create an instance of ExternalProviders from a dict -external_providers_form_dict = external_providers.from_dict(external_providers_dict) +external_providers_from_dict = ExternalProviders.from_dict(external_providers_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/FileFormat.md b/docs/FileFormat.md index 2fb2545..3ccfe71 100644 --- a/docs/FileFormat.md +++ b/docs/FileFormat.md @@ -24,7 +24,7 @@ print FileFormat.to_json() # convert the object into a dict file_format_dict = file_format_instance.to_dict() # create an instance of FileFormat from a dict -file_format_form_dict = file_format.from_dict(file_format_dict) +file_format_from_dict = FileFormat.from_dict(file_format_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/FileMetadata.md b/docs/FileMetadata.md index cf497eb..9e7844b 100644 --- a/docs/FileMetadata.md +++ b/docs/FileMetadata.md @@ -25,7 +25,7 @@ print FileMetadata.to_json() # convert the object into a dict file_metadata_dict = file_metadata_instance.to_dict() # create an instance of FileMetadata from a dict -file_metadata_form_dict = file_metadata.from_dict(file_metadata_dict) +file_metadata_from_dict = FileMetadata.from_dict(file_metadata_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/FilePickerInput.md b/docs/FilePickerInput.md index 36e166e..08b5d6b 100644 --- a/docs/FilePickerInput.md +++ b/docs/FilePickerInput.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] **allowed_extensions** | **List[str]** | | [optional] +**allow_multiple** | **bool** | default behavior is set to true | [optional] ## Example @@ -23,7 +24,7 @@ print FilePickerInput.to_json() # convert the object into a dict file_picker_input_dict = file_picker_input_instance.to_dict() # create an instance of FilePickerInput from a dict -file_picker_input_form_dict = file_picker_input.from_dict(file_picker_input_dict) +file_picker_input_from_dict = FilePickerInput.from_dict(file_picker_input_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/FlattenedActivities.md b/docs/FlattenedActivities.md index 0bfc1c2..d54ccc8 100644 --- a/docs/FlattenedActivities.md +++ b/docs/FlattenedActivities.md @@ -22,7 +22,7 @@ print FlattenedActivities.to_json() # convert the object into a dict flattened_activities_dict = flattened_activities_instance.to_dict() # create an instance of FlattenedActivities from a dict -flattened_activities_form_dict = flattened_activities.from_dict(flattened_activities_dict) +flattened_activities_from_dict = FlattenedActivities.from_dict(flattened_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/FlattenedActivity.md b/docs/FlattenedActivity.md index 51b02ca..39ac8e1 100644 --- a/docs/FlattenedActivity.md +++ b/docs/FlattenedActivity.md @@ -33,7 +33,7 @@ print FlattenedActivity.to_json() # convert the object into a dict flattened_activity_dict = flattened_activity_instance.to_dict() # create an instance of FlattenedActivity from a dict -flattened_activity_form_dict = flattened_activity.from_dict(flattened_activity_dict) +flattened_activity_from_dict = FlattenedActivity.from_dict(flattened_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/FlattenedAnalysis.md b/docs/FlattenedAnalysis.md index d5ae252..29267f4 100644 --- a/docs/FlattenedAnalysis.md +++ b/docs/FlattenedAnalysis.md @@ -25,7 +25,7 @@ print FlattenedAnalysis.to_json() # convert the object into a dict flattened_analysis_dict = flattened_analysis_instance.to_dict() # create an instance of FlattenedAnalysis from a dict -flattened_analysis_form_dict = flattened_analysis.from_dict(flattened_analysis_dict) +flattened_analysis_from_dict = FlattenedAnalysis.from_dict(flattened_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/FlattenedAnchor.md b/docs/FlattenedAnchor.md index 897d73e..886eec9 100644 --- a/docs/FlattenedAnchor.md +++ b/docs/FlattenedAnchor.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 FlattenedAnchor.to_json() # convert the object into a dict flattened_anchor_dict = flattened_anchor_instance.to_dict() # create an instance of FlattenedAnchor from a dict -flattened_anchor_form_dict = flattened_anchor.from_dict(flattened_anchor_dict) +flattened_anchor_from_dict = FlattenedAnchor.from_dict(flattened_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/FlattenedAnchorPoint.md b/docs/FlattenedAnchorPoint.md index 59849e7..6c11155 100644 --- a/docs/FlattenedAnchorPoint.md +++ b/docs/FlattenedAnchorPoint.md @@ -30,7 +30,7 @@ print FlattenedAnchorPoint.to_json() # convert the object into a dict flattened_anchor_point_dict = flattened_anchor_point_instance.to_dict() # create an instance of FlattenedAnchorPoint from a dict -flattened_anchor_point_form_dict = flattened_anchor_point.from_dict(flattened_anchor_point_dict) +flattened_anchor_point_from_dict = FlattenedAnchorPoint.from_dict(flattened_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/FlattenedAnchorPoints.md b/docs/FlattenedAnchorPoints.md index 039b708..aa147b6 100644 --- a/docs/FlattenedAnchorPoints.md +++ b/docs/FlattenedAnchorPoints.md @@ -24,7 +24,7 @@ print FlattenedAnchorPoints.to_json() # convert the object into a dict flattened_anchor_points_dict = flattened_anchor_points_instance.to_dict() # create an instance of FlattenedAnchorPoints from a dict -flattened_anchor_points_form_dict = flattened_anchor_points.from_dict(flattened_anchor_points_dict) +flattened_anchor_points_from_dict = FlattenedAnchorPoints.from_dict(flattened_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) diff --git a/docs/FlattenedAnchors.md b/docs/FlattenedAnchors.md index fec04b2..c173b6c 100644 --- a/docs/FlattenedAnchors.md +++ b/docs/FlattenedAnchors.md @@ -24,7 +24,7 @@ print FlattenedAnchors.to_json() # convert the object into a dict flattened_anchors_dict = flattened_anchors_instance.to_dict() # create an instance of FlattenedAnchors from a dict -flattened_anchors_form_dict = flattened_anchors.from_dict(flattened_anchors_dict) +flattened_anchors_from_dict = FlattenedAnchors.from_dict(flattened_anchors_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/FlattenedAnnotation.md b/docs/FlattenedAnnotation.md index f3f1d51..797aa20 100644 --- a/docs/FlattenedAnnotation.md +++ b/docs/FlattenedAnnotation.md @@ -39,7 +39,7 @@ print FlattenedAnnotation.to_json() # convert the object into a dict flattened_annotation_dict = flattened_annotation_instance.to_dict() # create an instance of FlattenedAnnotation from a dict -flattened_annotation_form_dict = flattened_annotation.from_dict(flattened_annotation_dict) +flattened_annotation_from_dict = FlattenedAnnotation.from_dict(flattened_annotation_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/FlattenedAnnotations.md b/docs/FlattenedAnnotations.md index 4dfcf93..bbc70c4 100644 --- a/docs/FlattenedAnnotations.md +++ b/docs/FlattenedAnnotations.md @@ -25,7 +25,7 @@ print FlattenedAnnotations.to_json() # convert the object into a dict flattened_annotations_dict = flattened_annotations_instance.to_dict() # create an instance of FlattenedAnnotations from a dict -flattened_annotations_form_dict = flattened_annotations.from_dict(flattened_annotations_dict) +flattened_annotations_from_dict = FlattenedAnnotations.from_dict(flattened_annotations_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/FlattenedAsset.md b/docs/FlattenedAsset.md index d610880..fdd6524 100644 --- a/docs/FlattenedAsset.md +++ b/docs/FlattenedAsset.md @@ -51,7 +51,7 @@ print FlattenedAsset.to_json() # convert the object into a dict flattened_asset_dict = flattened_asset_instance.to_dict() # create an instance of FlattenedAsset from a dict -flattened_asset_form_dict = flattened_asset.from_dict(flattened_asset_dict) +flattened_asset_from_dict = FlattenedAsset.from_dict(flattened_asset_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/FlattenedAssets.md b/docs/FlattenedAssets.md index 6a64ad0..2529d41 100644 --- a/docs/FlattenedAssets.md +++ b/docs/FlattenedAssets.md @@ -25,7 +25,7 @@ print FlattenedAssets.to_json() # convert the object into a dict flattened_assets_dict = flattened_assets_instance.to_dict() # create an instance of FlattenedAssets from a dict -flattened_assets_form_dict = flattened_assets.from_dict(flattened_assets_dict) +flattened_assets_from_dict = FlattenedAssets.from_dict(flattened_assets_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/FlattenedConversation.md b/docs/FlattenedConversation.md index 0b552ac..94886a8 100644 --- a/docs/FlattenedConversation.md +++ b/docs/FlattenedConversation.md @@ -41,7 +41,7 @@ print FlattenedConversation.to_json() # convert the object into a dict flattened_conversation_dict = flattened_conversation_instance.to_dict() # create an instance of FlattenedConversation from a dict -flattened_conversation_form_dict = flattened_conversation.from_dict(flattened_conversation_dict) +flattened_conversation_from_dict = FlattenedConversation.from_dict(flattened_conversation_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/FlattenedConversationMessage.md b/docs/FlattenedConversationMessage.md index e821df8..2717804 100644 --- a/docs/FlattenedConversationMessage.md +++ b/docs/FlattenedConversationMessage.md @@ -33,7 +33,7 @@ print FlattenedConversationMessage.to_json() # convert the object into a dict flattened_conversation_message_dict = flattened_conversation_message_instance.to_dict() # create an instance of FlattenedConversationMessage from a dict -flattened_conversation_message_form_dict = flattened_conversation_message.from_dict(flattened_conversation_message_dict) +flattened_conversation_message_from_dict = FlattenedConversationMessage.from_dict(flattened_conversation_message_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/FlattenedConversationMessages.md b/docs/FlattenedConversationMessages.md index fbe4ac1..749cb0b 100644 --- a/docs/FlattenedConversationMessages.md +++ b/docs/FlattenedConversationMessages.md @@ -25,7 +25,7 @@ print FlattenedConversationMessages.to_json() # convert the object into a dict flattened_conversation_messages_dict = flattened_conversation_messages_instance.to_dict() # create an instance of FlattenedConversationMessages from a dict -flattened_conversation_messages_form_dict = flattened_conversation_messages.from_dict(flattened_conversation_messages_dict) +flattened_conversation_messages_from_dict = FlattenedConversationMessages.from_dict(flattened_conversation_messages_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/FlattenedConversations.md b/docs/FlattenedConversations.md index 3c929da..94c7e3c 100644 --- a/docs/FlattenedConversations.md +++ b/docs/FlattenedConversations.md @@ -25,7 +25,7 @@ print FlattenedConversations.to_json() # convert the object into a dict flattened_conversations_dict = flattened_conversations_instance.to_dict() # create an instance of FlattenedConversations from a dict -flattened_conversations_form_dict = flattened_conversations.from_dict(flattened_conversations_dict) +flattened_conversations_from_dict = FlattenedConversations.from_dict(flattened_conversations_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/FlattenedDistribution.md b/docs/FlattenedDistribution.md index 039d3e6..9163232 100644 --- a/docs/FlattenedDistribution.md +++ b/docs/FlattenedDistribution.md @@ -28,7 +28,7 @@ print FlattenedDistribution.to_json() # convert the object into a dict flattened_distribution_dict = flattened_distribution_instance.to_dict() # create an instance of FlattenedDistribution from a dict -flattened_distribution_form_dict = flattened_distribution.from_dict(flattened_distribution_dict) +flattened_distribution_from_dict = FlattenedDistribution.from_dict(flattened_distribution_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/FlattenedDistributions.md b/docs/FlattenedDistributions.md index 6abd199..dc60899 100644 --- a/docs/FlattenedDistributions.md +++ b/docs/FlattenedDistributions.md @@ -22,7 +22,7 @@ print FlattenedDistributions.to_json() # convert the object into a dict flattened_distributions_dict = flattened_distributions_instance.to_dict() # create an instance of FlattenedDistributions from a dict -flattened_distributions_form_dict = flattened_distributions.from_dict(flattened_distributions_dict) +flattened_distributions_from_dict = FlattenedDistributions.from_dict(flattened_distributions_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/FlattenedFormat.md b/docs/FlattenedFormat.md index ac3498b..1a13136 100644 --- a/docs/FlattenedFormat.md +++ b/docs/FlattenedFormat.md @@ -40,7 +40,7 @@ print FlattenedFormat.to_json() # convert the object into a dict flattened_format_dict = flattened_format_instance.to_dict() # create an instance of FlattenedFormat from a dict -flattened_format_form_dict = flattened_format.from_dict(flattened_format_dict) +flattened_format_from_dict = FlattenedFormat.from_dict(flattened_format_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/FlattenedFormats.md b/docs/FlattenedFormats.md index c10c066..0015cb3 100644 --- a/docs/FlattenedFormats.md +++ b/docs/FlattenedFormats.md @@ -23,7 +23,7 @@ print FlattenedFormats.to_json() # convert the object into a dict flattened_formats_dict = flattened_formats_instance.to_dict() # create an instance of FlattenedFormats from a dict -flattened_formats_form_dict = flattened_formats.from_dict(flattened_formats_dict) +flattened_formats_from_dict = FlattenedFormats.from_dict(flattened_formats_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/FlattenedHint.md b/docs/FlattenedHint.md index b40ea29..9a26631 100644 --- a/docs/FlattenedHint.md +++ b/docs/FlattenedHint.md @@ -10,8 +10,8 @@ Name | Type | Description | Notes **created** | [**GroupedTimestamp**](GroupedTimestamp.md) | | **updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | | **deleted** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional] -**mechanism** | [**MechanismEnum**](MechanismEnum.md) | | [optional] -**asset** | [**ReferencedAsset**](ReferencedAsset.md) | | [optional] +**mechanisms** | [**Dict[str, MechanismEnum]**](MechanismEnum.md) | This is a Map<String, MechanismEnum> where the the key is an asset id. | [optional] +**assets** | [**FlattenedAssets**](FlattenedAssets.md) | | [optional] **type** | [**HintTypeEnum**](HintTypeEnum.md) | | **text** | **str** | This is the text of the hint. | **model** | [**ReferencedModel**](ReferencedModel.md) | | [optional] @@ -32,7 +32,7 @@ print FlattenedHint.to_json() # convert the object into a dict flattened_hint_dict = flattened_hint_instance.to_dict() # create an instance of FlattenedHint from a dict -flattened_hint_form_dict = flattened_hint.from_dict(flattened_hint_dict) +flattened_hint_from_dict = FlattenedHint.from_dict(flattened_hint_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/FlattenedHints.md b/docs/FlattenedHints.md index a148870..5da3f24 100644 --- a/docs/FlattenedHints.md +++ b/docs/FlattenedHints.md @@ -25,7 +25,7 @@ print FlattenedHints.to_json() # convert the object into a dict flattened_hints_dict = flattened_hints_instance.to_dict() # create an instance of FlattenedHints from a dict -flattened_hints_form_dict = flattened_hints.from_dict(flattened_hints_dict) +flattened_hints_from_dict = FlattenedHints.from_dict(flattened_hints_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/FlattenedImageAnalysis.md b/docs/FlattenedImageAnalysis.md index 9d6ff88..12a270c 100644 --- a/docs/FlattenedImageAnalysis.md +++ b/docs/FlattenedImageAnalysis.md @@ -24,7 +24,7 @@ print FlattenedImageAnalysis.to_json() # convert the object into a dict flattened_image_analysis_dict = flattened_image_analysis_instance.to_dict() # create an instance of FlattenedImageAnalysis from a dict -flattened_image_analysis_form_dict = flattened_image_analysis.from_dict(flattened_image_analysis_dict) +flattened_image_analysis_from_dict = FlattenedImageAnalysis.from_dict(flattened_image_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/FlattenedOCRAnalysis.md b/docs/FlattenedOCRAnalysis.md index a9dcf58..489ff94 100644 --- a/docs/FlattenedOCRAnalysis.md +++ b/docs/FlattenedOCRAnalysis.md @@ -27,7 +27,7 @@ print FlattenedOCRAnalysis.to_json() # convert the object into a dict flattened_ocr_analysis_dict = flattened_ocr_analysis_instance.to_dict() # create an instance of FlattenedOCRAnalysis from a dict -flattened_ocr_analysis_form_dict = flattened_ocr_analysis.from_dict(flattened_ocr_analysis_dict) +flattened_ocr_analysis_from_dict = FlattenedOCRAnalysis.from_dict(flattened_ocr_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/FlattenedPerson.md b/docs/FlattenedPerson.md index ac474eb..3ab8987 100644 --- a/docs/FlattenedPerson.md +++ b/docs/FlattenedPerson.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **annotations** | [**FlattenedAnnotations**](FlattenedAnnotations.md) | | [optional] **score** | [**Score**](Score.md) | | [optional] **summaries** | [**FlattenedWorkstreamSummaries**](FlattenedWorkstreamSummaries.md) | | [optional] +**anchors** | [**FlattenedAnchors**](FlattenedAnchors.md) | | [optional] ## Example @@ -37,7 +38,7 @@ print FlattenedPerson.to_json() # convert the object into a dict flattened_person_dict = flattened_person_instance.to_dict() # create an instance of FlattenedPerson from a dict -flattened_person_form_dict = flattened_person.from_dict(flattened_person_dict) +flattened_person_from_dict = FlattenedPerson.from_dict(flattened_person_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/FlattenedPersons.md b/docs/FlattenedPersons.md index 8175c59..9adc74a 100644 --- a/docs/FlattenedPersons.md +++ b/docs/FlattenedPersons.md @@ -25,7 +25,7 @@ print FlattenedPersons.to_json() # convert the object into a dict flattened_persons_dict = flattened_persons_instance.to_dict() # create an instance of FlattenedPersons from a dict -flattened_persons_form_dict = flattened_persons.from_dict(flattened_persons_dict) +flattened_persons_from_dict = FlattenedPersons.from_dict(flattened_persons_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/FlattenedPreview.md b/docs/FlattenedPreview.md index b57ab46..fdbc377 100644 --- a/docs/FlattenedPreview.md +++ b/docs/FlattenedPreview.md @@ -24,7 +24,7 @@ print FlattenedPreview.to_json() # convert the object into a dict flattened_preview_dict = flattened_preview_instance.to_dict() # create an instance of FlattenedPreview from a dict -flattened_preview_form_dict = flattened_preview.from_dict(flattened_preview_dict) +flattened_preview_from_dict = FlattenedPreview.from_dict(flattened_preview_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/FlattenedRange.md b/docs/FlattenedRange.md index c48269c..f3fa096 100644 --- a/docs/FlattenedRange.md +++ b/docs/FlattenedRange.md @@ -31,7 +31,7 @@ print FlattenedRange.to_json() # convert the object into a dict flattened_range_dict = flattened_range_instance.to_dict() # create an instance of FlattenedRange from a dict -flattened_range_form_dict = flattened_range.from_dict(flattened_range_dict) +flattened_range_from_dict = FlattenedRange.from_dict(flattened_range_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/FlattenedRanges.md b/docs/FlattenedRanges.md index 2fc247e..dea03a2 100644 --- a/docs/FlattenedRanges.md +++ b/docs/FlattenedRanges.md @@ -26,7 +26,7 @@ print FlattenedRanges.to_json() # convert the object into a dict flattened_ranges_dict = flattened_ranges_instance.to_dict() # create an instance of FlattenedRanges from a dict -flattened_ranges_form_dict = flattened_ranges.from_dict(flattened_ranges_dict) +flattened_ranges_from_dict = FlattenedRanges.from_dict(flattened_ranges_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/FlattenedSensitive.md b/docs/FlattenedSensitive.md index fbcec1a..3ac373f 100644 --- a/docs/FlattenedSensitive.md +++ b/docs/FlattenedSensitive.md @@ -36,7 +36,7 @@ print FlattenedSensitive.to_json() # convert the object into a dict flattened_sensitive_dict = flattened_sensitive_instance.to_dict() # create an instance of FlattenedSensitive from a dict -flattened_sensitive_form_dict = flattened_sensitive.from_dict(flattened_sensitive_dict) +flattened_sensitive_from_dict = FlattenedSensitive.from_dict(flattened_sensitive_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/FlattenedSensitives.md b/docs/FlattenedSensitives.md index bc97a54..2765469 100644 --- a/docs/FlattenedSensitives.md +++ b/docs/FlattenedSensitives.md @@ -24,7 +24,7 @@ print FlattenedSensitives.to_json() # convert the object into a dict flattened_sensitives_dict = flattened_sensitives_instance.to_dict() # create an instance of FlattenedSensitives from a dict -flattened_sensitives_form_dict = flattened_sensitives.from_dict(flattened_sensitives_dict) +flattened_sensitives_from_dict = FlattenedSensitives.from_dict(flattened_sensitives_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/FlattenedShare.md b/docs/FlattenedShare.md index 29bcd2e..beab88d 100644 --- a/docs/FlattenedShare.md +++ b/docs/FlattenedShare.md @@ -34,7 +34,7 @@ print FlattenedShare.to_json() # convert the object into a dict flattened_share_dict = flattened_share_instance.to_dict() # create an instance of FlattenedShare from a dict -flattened_share_form_dict = flattened_share.from_dict(flattened_share_dict) +flattened_share_from_dict = FlattenedShare.from_dict(flattened_share_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/FlattenedShares.md b/docs/FlattenedShares.md index 446c112..36f3f44 100644 --- a/docs/FlattenedShares.md +++ b/docs/FlattenedShares.md @@ -24,7 +24,7 @@ print FlattenedShares.to_json() # convert the object into a dict flattened_shares_dict = flattened_shares_instance.to_dict() # create an instance of FlattenedShares from a dict -flattened_shares_form_dict = flattened_shares.from_dict(flattened_shares_dict) +flattened_shares_from_dict = FlattenedShares.from_dict(flattened_shares_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/FlattenedTag.md b/docs/FlattenedTag.md index cdc19f9..ab1c309 100644 --- a/docs/FlattenedTag.md +++ b/docs/FlattenedTag.md @@ -34,7 +34,7 @@ print FlattenedTag.to_json() # convert the object into a dict flattened_tag_dict = flattened_tag_instance.to_dict() # create an instance of FlattenedTag from a dict -flattened_tag_form_dict = flattened_tag.from_dict(flattened_tag_dict) +flattened_tag_from_dict = FlattenedTag.from_dict(flattened_tag_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/FlattenedTags.md b/docs/FlattenedTags.md index dc9bb22..beda8cf 100644 --- a/docs/FlattenedTags.md +++ b/docs/FlattenedTags.md @@ -25,7 +25,7 @@ print FlattenedTags.to_json() # convert the object into a dict flattened_tags_dict = flattened_tags_instance.to_dict() # create an instance of FlattenedTags from a dict -flattened_tags_form_dict = flattened_tags.from_dict(flattened_tags_dict) +flattened_tags_from_dict = FlattenedTags.from_dict(flattened_tags_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/FlattenedUserProfile.md b/docs/FlattenedUserProfile.md index d38e13d..81f2b2e 100644 --- a/docs/FlattenedUserProfile.md +++ b/docs/FlattenedUserProfile.md @@ -28,7 +28,7 @@ print FlattenedUserProfile.to_json() # convert the object into a dict flattened_user_profile_dict = flattened_user_profile_instance.to_dict() # create an instance of FlattenedUserProfile from a dict -flattened_user_profile_form_dict = flattened_user_profile.from_dict(flattened_user_profile_dict) +flattened_user_profile_from_dict = FlattenedUserProfile.from_dict(flattened_user_profile_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/FlattenedWebsite.md b/docs/FlattenedWebsite.md index a8b55ba..ef8c552 100644 --- a/docs/FlattenedWebsite.md +++ b/docs/FlattenedWebsite.md @@ -35,7 +35,7 @@ print FlattenedWebsite.to_json() # convert the object into a dict flattened_website_dict = flattened_website_instance.to_dict() # create an instance of FlattenedWebsite from a dict -flattened_website_form_dict = flattened_website.from_dict(flattened_website_dict) +flattened_website_from_dict = FlattenedWebsite.from_dict(flattened_website_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/FlattenedWebsites.md b/docs/FlattenedWebsites.md index 63458e2..bac880b 100644 --- a/docs/FlattenedWebsites.md +++ b/docs/FlattenedWebsites.md @@ -25,7 +25,7 @@ print FlattenedWebsites.to_json() # convert the object into a dict flattened_websites_dict = flattened_websites_instance.to_dict() # create an instance of FlattenedWebsites from a dict -flattened_websites_form_dict = flattened_websites.from_dict(flattened_websites_dict) +flattened_websites_from_dict = FlattenedWebsites.from_dict(flattened_websites_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/FlattenedWorkstreamEvent.md b/docs/FlattenedWorkstreamEvent.md index a28b2ae..7ffca93 100644 --- a/docs/FlattenedWorkstreamEvent.md +++ b/docs/FlattenedWorkstreamEvent.md @@ -30,7 +30,7 @@ print FlattenedWorkstreamEvent.to_json() # convert the object into a dict flattened_workstream_event_dict = flattened_workstream_event_instance.to_dict() # create an instance of FlattenedWorkstreamEvent from a dict -flattened_workstream_event_form_dict = flattened_workstream_event.from_dict(flattened_workstream_event_dict) +flattened_workstream_event_from_dict = FlattenedWorkstreamEvent.from_dict(flattened_workstream_event_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/FlattenedWorkstreamEvents.md b/docs/FlattenedWorkstreamEvents.md index b18e631..214c9b9 100644 --- a/docs/FlattenedWorkstreamEvents.md +++ b/docs/FlattenedWorkstreamEvents.md @@ -25,7 +25,7 @@ print FlattenedWorkstreamEvents.to_json() # convert the object into a dict flattened_workstream_events_dict = flattened_workstream_events_instance.to_dict() # create an instance of FlattenedWorkstreamEvents from a dict -flattened_workstream_events_form_dict = flattened_workstream_events.from_dict(flattened_workstream_events_dict) +flattened_workstream_events_from_dict = FlattenedWorkstreamEvents.from_dict(flattened_workstream_events_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/FlattenedWorkstreamPatternEngineVisionEvent.md b/docs/FlattenedWorkstreamPatternEngineVisionEvent.md new file mode 100644 index 0000000..83c3e5f --- /dev/null +++ b/docs/FlattenedWorkstreamPatternEngineVisionEvent.md @@ -0,0 +1,31 @@ +# FlattenedWorkstreamPatternEngineVisionEvent + +This is a flattened version of the WorkstreamPatternEngineVisionEvent, where the referenced to other materials are also flattened(DAG Safe) Note: TODO later add textual and need to correspond w/ both transferables as well as the FlattenedMaterial + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**id** | **str** | | +**created** | [**GroupedTimestamp**](GroupedTimestamp.md) | | + +## Example + +```python +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_event import FlattenedWorkstreamPatternEngineVisionEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of FlattenedWorkstreamPatternEngineVisionEvent from a JSON string +flattened_workstream_pattern_engine_vision_event_instance = FlattenedWorkstreamPatternEngineVisionEvent.from_json(json) +# print the JSON string representation of the object +print FlattenedWorkstreamPatternEngineVisionEvent.to_json() + +# convert the object into a dict +flattened_workstream_pattern_engine_vision_event_dict = flattened_workstream_pattern_engine_vision_event_instance.to_dict() +# create an instance of FlattenedWorkstreamPatternEngineVisionEvent from a dict +flattened_workstream_pattern_engine_vision_event_from_dict = FlattenedWorkstreamPatternEngineVisionEvent.from_dict(flattened_workstream_pattern_engine_vision_event_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/FlattenedWorkstreamPatternEngineVisionEvents.md b/docs/FlattenedWorkstreamPatternEngineVisionEvents.md new file mode 100644 index 0000000..4ad0a3c --- /dev/null +++ b/docs/FlattenedWorkstreamPatternEngineVisionEvents.md @@ -0,0 +1,30 @@ +# FlattenedWorkstreamPatternEngineVisionEvents + +This is a plural snapshot of all of the events within WPE qdrant(Referenced) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[ReferencedWorkstreamPatternEngineVisionEvent]**](ReferencedWorkstreamPatternEngineVisionEvent.md) | | + +## Example + +```python +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents + +# TODO update the JSON string below +json = "{}" +# create an instance of FlattenedWorkstreamPatternEngineVisionEvents from a JSON string +flattened_workstream_pattern_engine_vision_events_instance = FlattenedWorkstreamPatternEngineVisionEvents.from_json(json) +# print the JSON string representation of the object +print FlattenedWorkstreamPatternEngineVisionEvents.to_json() + +# convert the object into a dict +flattened_workstream_pattern_engine_vision_events_dict = flattened_workstream_pattern_engine_vision_events_instance.to_dict() +# create an instance of FlattenedWorkstreamPatternEngineVisionEvents from a dict +flattened_workstream_pattern_engine_vision_events_from_dict = FlattenedWorkstreamPatternEngineVisionEvents.from_dict(flattened_workstream_pattern_engine_vision_events_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/FlattenedWorkstreamSummaries.md b/docs/FlattenedWorkstreamSummaries.md index 21d9f28..3c2845e 100644 --- a/docs/FlattenedWorkstreamSummaries.md +++ b/docs/FlattenedWorkstreamSummaries.md @@ -25,7 +25,7 @@ print FlattenedWorkstreamSummaries.to_json() # convert the object into a dict flattened_workstream_summaries_dict = flattened_workstream_summaries_instance.to_dict() # create an instance of FlattenedWorkstreamSummaries from a dict -flattened_workstream_summaries_form_dict = flattened_workstream_summaries.from_dict(flattened_workstream_summaries_dict) +flattened_workstream_summaries_from_dict = FlattenedWorkstreamSummaries.from_dict(flattened_workstream_summaries_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/FlattenedWorkstreamSummary.md b/docs/FlattenedWorkstreamSummary.md index 69a0aaf..649a1fb 100644 --- a/docs/FlattenedWorkstreamSummary.md +++ b/docs/FlattenedWorkstreamSummary.md @@ -37,7 +37,7 @@ print FlattenedWorkstreamSummary.to_json() # convert the object into a dict flattened_workstream_summary_dict = flattened_workstream_summary_instance.to_dict() # create an instance of FlattenedWorkstreamSummary from a dict -flattened_workstream_summary_form_dict = flattened_workstream_summary.from_dict(flattened_workstream_summary_dict) +flattened_workstream_summary_from_dict = FlattenedWorkstreamSummary.from_dict(flattened_workstream_summary_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/Font.md b/docs/Font.md index c372216..d980360 100644 --- a/docs/Font.md +++ b/docs/Font.md @@ -23,7 +23,7 @@ print Font.to_json() # convert the object into a dict font_dict = font_instance.to_dict() # create an instance of Font from a dict -font_form_dict = font.from_dict(font_dict) +font_from_dict = Font.from_dict(font_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/Format.md b/docs/Format.md index aefe24e..5799eb9 100644 --- a/docs/Format.md +++ b/docs/Format.md @@ -40,7 +40,7 @@ print Format.to_json() # convert the object into a dict format_dict = format_instance.to_dict() # create an instance of Format from a dict -format_form_dict = format.from_dict(format_dict) +format_from_dict = Format.from_dict(format_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/FormatMetric.md b/docs/FormatMetric.md index 920673c..f537685 100644 --- a/docs/FormatMetric.md +++ b/docs/FormatMetric.md @@ -25,7 +25,7 @@ print FormatMetric.to_json() # convert the object into a dict format_metric_dict = format_metric_instance.to_dict() # create an instance of FormatMetric from a dict -format_metric_form_dict = format_metric.from_dict(format_metric_dict) +format_metric_from_dict = FormatMetric.from_dict(format_metric_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/FormatReclassification.md b/docs/FormatReclassification.md index 484e0e4..f5333a9 100644 --- a/docs/FormatReclassification.md +++ b/docs/FormatReclassification.md @@ -24,7 +24,7 @@ print FormatReclassification.to_json() # convert the object into a dict format_reclassification_dict = format_reclassification_instance.to_dict() # create an instance of FormatReclassification from a dict -format_reclassification_form_dict = format_reclassification.from_dict(format_reclassification_dict) +format_reclassification_from_dict = FormatReclassification.from_dict(format_reclassification_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/Formats.md b/docs/Formats.md index b7bcae3..4f52cad 100644 --- a/docs/Formats.md +++ b/docs/Formats.md @@ -23,7 +23,7 @@ print Formats.to_json() # convert the object into a dict formats_dict = formats_instance.to_dict() # create an instance of Formats from a dict -formats_form_dict = formats.from_dict(formats_dict) +formats_from_dict = Formats.from_dict(formats_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/FormatsMetrics.md b/docs/FormatsMetrics.md index 9e29fef..6c4a201 100644 --- a/docs/FormatsMetrics.md +++ b/docs/FormatsMetrics.md @@ -23,7 +23,7 @@ print FormatsMetrics.to_json() # convert the object into a dict formats_metrics_dict = formats_metrics_instance.to_dict() # create an instance of FormatsMetrics from a dict -formats_metrics_form_dict = formats_metrics.from_dict(formats_metrics_dict) +formats_metrics_from_dict = FormatsMetrics.from_dict(formats_metrics_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/FragmentFormat.md b/docs/FragmentFormat.md index 41e7454..551ad22 100644 --- a/docs/FragmentFormat.md +++ b/docs/FragmentFormat.md @@ -25,7 +25,7 @@ print FragmentFormat.to_json() # convert the object into a dict fragment_format_dict = fragment_format_instance.to_dict() # create an instance of FragmentFormat from a dict -fragment_format_form_dict = fragment_format.from_dict(fragment_format_dict) +fragment_format_from_dict = FragmentFormat.from_dict(fragment_format_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/FragmentMetadata.md b/docs/FragmentMetadata.md index 297b2b8..d4cb72c 100644 --- a/docs/FragmentMetadata.md +++ b/docs/FragmentMetadata.md @@ -23,7 +23,7 @@ print FragmentMetadata.to_json() # convert the object into a dict fragment_metadata_dict = fragment_metadata_instance.to_dict() # create an instance of FragmentMetadata from a dict -fragment_metadata_form_dict = fragment_metadata.from_dict(fragment_metadata_dict) +fragment_metadata_from_dict = FragmentMetadata.from_dict(fragment_metadata_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/FullTextSearchOptions.md b/docs/FullTextSearchOptions.md new file mode 100644 index 0000000..f8f4aa5 --- /dev/null +++ b/docs/FullTextSearchOptions.md @@ -0,0 +1,31 @@ +# FullTextSearchOptions + +similarity: you will want to pass in a value from 0-1. (where 1 is exact and 0 is everything) exact: (optional) this will default to false, which will run a fuzzy search, unless set to true. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**similarity** | **float** | | [optional] +**exact** | **bool** | | [optional] + +## Example + +```python +from pieces_os_client.models.full_text_search_options import FullTextSearchOptions + +# TODO update the JSON string below +json = "{}" +# create an instance of FullTextSearchOptions from a JSON string +full_text_search_options_instance = FullTextSearchOptions.from_json(json) +# print the JSON string representation of the object +print FullTextSearchOptions.to_json() + +# convert the object into a dict +full_text_search_options_dict = full_text_search_options_instance.to_dict() +# create an instance of FullTextSearchOptions from a dict +full_text_search_options_from_dict = FullTextSearchOptions.from_dict(full_text_search_options_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/GitHubDistribution.md b/docs/GitHubDistribution.md index 36f7bbc..46bfe81 100644 --- a/docs/GitHubDistribution.md +++ b/docs/GitHubDistribution.md @@ -22,7 +22,7 @@ print GitHubDistribution.to_json() # convert the object into a dict git_hub_distribution_dict = git_hub_distribution_instance.to_dict() # create an instance of GitHubDistribution from a dict -git_hub_distribution_form_dict = git_hub_distribution.from_dict(git_hub_distribution_dict) +git_hub_distribution_from_dict = GitHubDistribution.from_dict(git_hub_distribution_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/GitHubGistDistribution.md b/docs/GitHubGistDistribution.md index 1b163ff..0faa940 100644 --- a/docs/GitHubGistDistribution.md +++ b/docs/GitHubGistDistribution.md @@ -31,7 +31,7 @@ print GitHubGistDistribution.to_json() # convert the object into a dict git_hub_gist_distribution_dict = git_hub_gist_distribution_instance.to_dict() # create an instance of GitHubGistDistribution from a dict -git_hub_gist_distribution_form_dict = git_hub_gist_distribution.from_dict(git_hub_gist_distribution_dict) +git_hub_gist_distribution_from_dict = GitHubGistDistribution.from_dict(git_hub_gist_distribution_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/GraphicalImageDescriptiveStatistics.md b/docs/GraphicalImageDescriptiveStatistics.md index af3c3a1..4d8b90e 100644 --- a/docs/GraphicalImageDescriptiveStatistics.md +++ b/docs/GraphicalImageDescriptiveStatistics.md @@ -29,7 +29,7 @@ print GraphicalImageDescriptiveStatistics.to_json() # convert the object into a dict graphical_image_descriptive_statistics_dict = graphical_image_descriptive_statistics_instance.to_dict() # create an instance of GraphicalImageDescriptiveStatistics from a dict -graphical_image_descriptive_statistics_form_dict = graphical_image_descriptive_statistics.from_dict(graphical_image_descriptive_statistics_dict) +graphical_image_descriptive_statistics_from_dict = GraphicalImageDescriptiveStatistics.from_dict(graphical_image_descriptive_statistics_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/GraphicalImageProcessing.md b/docs/GraphicalImageProcessing.md index f157c03..b83db7a 100644 --- a/docs/GraphicalImageProcessing.md +++ b/docs/GraphicalImageProcessing.md @@ -22,7 +22,7 @@ print GraphicalImageProcessing.to_json() # convert the object into a dict graphical_image_processing_dict = graphical_image_processing_instance.to_dict() # create an instance of GraphicalImageProcessing from a dict -graphical_image_processing_form_dict = graphical_image_processing.from_dict(graphical_image_processing_dict) +graphical_image_processing_from_dict = GraphicalImageProcessing.from_dict(graphical_image_processing_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/GraphicalImageStatistics.md b/docs/GraphicalImageStatistics.md index 10afe23..a64cd14 100644 --- a/docs/GraphicalImageStatistics.md +++ b/docs/GraphicalImageStatistics.md @@ -22,7 +22,7 @@ print GraphicalImageStatistics.to_json() # convert the object into a dict graphical_image_statistics_dict = graphical_image_statistics_instance.to_dict() # create an instance of GraphicalImageStatistics from a dict -graphical_image_statistics_form_dict = graphical_image_statistics.from_dict(graphical_image_statistics_dict) +graphical_image_statistics_from_dict = GraphicalImageStatistics.from_dict(graphical_image_statistics_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/GraphicalMachineLearningProcessingEvent.md b/docs/GraphicalMachineLearningProcessingEvent.md index 4e3cf56..0ed0f9d 100644 --- a/docs/GraphicalMachineLearningProcessingEvent.md +++ b/docs/GraphicalMachineLearningProcessingEvent.md @@ -24,7 +24,7 @@ print GraphicalMachineLearningProcessingEvent.to_json() # convert the object into a dict graphical_machine_learning_processing_event_dict = graphical_machine_learning_processing_event_instance.to_dict() # create an instance of GraphicalMachineLearningProcessingEvent from a dict -graphical_machine_learning_processing_event_form_dict = graphical_machine_learning_processing_event.from_dict(graphical_machine_learning_processing_event_dict) +graphical_machine_learning_processing_event_from_dict = GraphicalMachineLearningProcessingEvent.from_dict(graphical_machine_learning_processing_event_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/GraphicalOCRDescriptiveStatistics.md b/docs/GraphicalOCRDescriptiveStatistics.md index 340c7b2..bc46401 100644 --- a/docs/GraphicalOCRDescriptiveStatistics.md +++ b/docs/GraphicalOCRDescriptiveStatistics.md @@ -29,7 +29,7 @@ print GraphicalOCRDescriptiveStatistics.to_json() # convert the object into a dict graphical_ocr_descriptive_statistics_dict = graphical_ocr_descriptive_statistics_instance.to_dict() # create an instance of GraphicalOCRDescriptiveStatistics from a dict -graphical_ocr_descriptive_statistics_form_dict = graphical_ocr_descriptive_statistics.from_dict(graphical_ocr_descriptive_statistics_dict) +graphical_ocr_descriptive_statistics_from_dict = GraphicalOCRDescriptiveStatistics.from_dict(graphical_ocr_descriptive_statistics_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/GraphicalOCRDescriptiveStatisticsConfidence.md b/docs/GraphicalOCRDescriptiveStatisticsConfidence.md index cbc6b36..9e277a1 100644 --- a/docs/GraphicalOCRDescriptiveStatisticsConfidence.md +++ b/docs/GraphicalOCRDescriptiveStatisticsConfidence.md @@ -21,7 +21,7 @@ print GraphicalOCRDescriptiveStatisticsConfidence.to_json() # convert the object into a dict graphical_ocr_descriptive_statistics_confidence_dict = graphical_ocr_descriptive_statistics_confidence_instance.to_dict() # create an instance of GraphicalOCRDescriptiveStatisticsConfidence from a dict -graphical_ocr_descriptive_statistics_confidence_form_dict = graphical_ocr_descriptive_statistics_confidence.from_dict(graphical_ocr_descriptive_statistics_confidence_dict) +graphical_ocr_descriptive_statistics_confidence_from_dict = GraphicalOCRDescriptiveStatisticsConfidence.from_dict(graphical_ocr_descriptive_statistics_confidence_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/GraphicalOCRProcessing.md b/docs/GraphicalOCRProcessing.md index eede6f5..0a336bd 100644 --- a/docs/GraphicalOCRProcessing.md +++ b/docs/GraphicalOCRProcessing.md @@ -22,7 +22,7 @@ print GraphicalOCRProcessing.to_json() # convert the object into a dict graphical_ocr_processing_dict = graphical_ocr_processing_instance.to_dict() # create an instance of GraphicalOCRProcessing from a dict -graphical_ocr_processing_form_dict = graphical_ocr_processing.from_dict(graphical_ocr_processing_dict) +graphical_ocr_processing_from_dict = GraphicalOCRProcessing.from_dict(graphical_ocr_processing_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/GraphicalOCRStatistics.md b/docs/GraphicalOCRStatistics.md index 2a1a7ab..2e63630 100644 --- a/docs/GraphicalOCRStatistics.md +++ b/docs/GraphicalOCRStatistics.md @@ -22,7 +22,7 @@ print GraphicalOCRStatistics.to_json() # convert the object into a dict graphical_ocr_statistics_dict = graphical_ocr_statistics_instance.to_dict() # create an instance of GraphicalOCRStatistics from a dict -graphical_ocr_statistics_form_dict = graphical_ocr_statistics.from_dict(graphical_ocr_statistics_dict) +graphical_ocr_statistics_from_dict = GraphicalOCRStatistics.from_dict(graphical_ocr_statistics_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/GraphicalSVGStatistics.md b/docs/GraphicalSVGStatistics.md index de5edc6..905eb86 100644 --- a/docs/GraphicalSVGStatistics.md +++ b/docs/GraphicalSVGStatistics.md @@ -22,7 +22,7 @@ print GraphicalSVGStatistics.to_json() # convert the object into a dict graphical_svg_statistics_dict = graphical_svg_statistics_instance.to_dict() # create an instance of GraphicalSVGStatistics from a dict -graphical_svg_statistics_form_dict = graphical_svg_statistics.from_dict(graphical_svg_statistics_dict) +graphical_svg_statistics_from_dict = GraphicalSVGStatistics.from_dict(graphical_svg_statistics_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/GroupedTimestamp.md b/docs/GroupedTimestamp.md index 256858d..20dc428 100644 --- a/docs/GroupedTimestamp.md +++ b/docs/GroupedTimestamp.md @@ -24,7 +24,7 @@ print GroupedTimestamp.to_json() # convert the object into a dict grouped_timestamp_dict = grouped_timestamp_instance.to_dict() # create an instance of GroupedTimestamp from a dict -grouped_timestamp_form_dict = grouped_timestamp.from_dict(grouped_timestamp_dict) +grouped_timestamp_from_dict = GroupedTimestamp.from_dict(grouped_timestamp_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/Health.md b/docs/Health.md index 55107f3..c6670b8 100644 --- a/docs/Health.md +++ b/docs/Health.md @@ -23,7 +23,7 @@ print Health.to_json() # convert the object into a dict health_dict = health_instance.to_dict() # create an instance of Health from a dict -health_form_dict = health.from_dict(health_dict) +health_from_dict = Health.from_dict(health_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/Hint.md b/docs/Hint.md index 44acacf..9234353 100644 --- a/docs/Hint.md +++ b/docs/Hint.md @@ -10,8 +10,8 @@ Name | Type | Description | Notes **created** | [**GroupedTimestamp**](GroupedTimestamp.md) | | **updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | | **deleted** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional] -**mechanism** | [**MechanismEnum**](MechanismEnum.md) | | [optional] -**asset** | [**ReferencedAsset**](ReferencedAsset.md) | | [optional] +**mechanisms** | [**Dict[str, MechanismEnum]**](MechanismEnum.md) | This is a Map<String, MechanismEnum> where the the key is an asset id. | [optional] +**assets** | [**FlattenedAssets**](FlattenedAssets.md) | | [optional] **type** | [**HintTypeEnum**](HintTypeEnum.md) | | **text** | **str** | This is the text of the hint. | **model** | [**ReferencedModel**](ReferencedModel.md) | | [optional] @@ -32,7 +32,7 @@ print Hint.to_json() # convert the object into a dict hint_dict = hint_instance.to_dict() # create an instance of Hint from a dict -hint_form_dict = hint.from_dict(hint_dict) +hint_from_dict = Hint.from_dict(hint_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/HintApi.md b/docs/HintApi.md index 4012ecf..6b10fe5 100644 --- a/docs/HintApi.md +++ b/docs/HintApi.md @@ -4,11 +4,147 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**hint_associate_asset**](HintApi.md#hint_associate_asset) | **POST** /hint/{hint}/assets/associate/{asset} | /hint/{hint}/assets/associate/{asset} [POST] +[**hint_disassociate_asset**](HintApi.md#hint_disassociate_asset) | **POST** /hint/{hint}/assets/disassociate/{asset} | /hint/{hint}/assets/disassociate/{asset} [POST] [**hint_scores_increment**](HintApi.md#hint_scores_increment) | **POST** /hint/{hint}/scores/increment | '/hint/{hint}/scores/increment' [POST] [**hint_specific_hint_snapshot**](HintApi.md#hint_specific_hint_snapshot) | **GET** /hint/{hint} | /hint/{hint} [POST] [**hint_update**](HintApi.md#hint_update) | **POST** /hint/update | /hint/update [POST] +# **hint_associate_asset** +> hint_associate_asset(hint, asset) + +/hint/{hint}/assets/associate/{asset} [POST] + +associates a hint and an asset. It performs the same action as the asset 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.HintApi(api_client) + hint = 'hint_example' # str | This is a specific hint uuid + asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + + try: + # /hint/{hint}/assets/associate/{asset} [POST] + api_instance.hint_associate_asset(hint, asset) + except Exception as e: + print("Exception when calling HintApi->hint_associate_asset: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **hint** | **str**| This is a specific hint uuid | + **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + +### 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) + +# **hint_disassociate_asset** +> hint_disassociate_asset(hint, asset) + +/hint/{hint}/assets/disassociate/{asset} [POST] + +Disassociates a hint from an asset. It performs the same action as the asset 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.HintApi(api_client) + hint = 'hint_example' # str | This is a specific hint uuid + asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + + try: + # /hint/{hint}/assets/disassociate/{asset} [POST] + api_instance.hint_disassociate_asset(hint, asset) + except Exception as e: + print("Exception when calling HintApi->hint_disassociate_asset: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **hint** | **str**| This is a specific hint uuid | + **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + +### 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) + # **hint_scores_increment** > hint_scores_increment(hint, seeded_score_increment=seeded_score_increment) diff --git a/docs/Hints.md b/docs/Hints.md index 94d73b1..1b5309f 100644 --- a/docs/Hints.md +++ b/docs/Hints.md @@ -25,7 +25,7 @@ print Hints.to_json() # convert the object into a dict hints_dict = hints_instance.to_dict() # create an instance of Hints from a dict -hints_form_dict = hints.from_dict(hints_dict) +hints_from_dict = Hints.from_dict(hints_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/HintsApi.md b/docs/HintsApi.md index 51a401e..e8e905c 100644 --- a/docs/HintsApi.md +++ b/docs/HintsApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**hints_create_new_hint**](HintsApi.md#hints_create_new_hint) | **POST** /hints/create | /hints/create [POST] [**hints_delete_specific_hint**](HintsApi.md#hints_delete_specific_hint) | **POST** /hints/{hint}/delete | /hints/{hint}/delete [POST] [**hints_snapshot**](HintsApi.md#hints_snapshot) | **GET** /hints | /hints [GET] +[**search_hints**](HintsApi.md#search_hints) | **POST** /hints/search | /hints/search [POST] # **hints_create_new_hint** @@ -207,3 +208,74 @@ 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) +# **search_hints** +> SearchedHints search_hints(transferables=transferables, search_input=search_input) + +/hints/search [POST] + +This will search your hints for a specific hint note: we will just search the hint value + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_hints import SearchedHints +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.HintsApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /hints/search [POST] + api_response = api_instance.search_hints(transferables=transferables, search_input=search_input) + print("The response of HintsApi->search_hints:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling HintsApi->search_hints: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedHints**](SearchedHints.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/IDESelection.md b/docs/IDESelection.md index 20ac619..b21e486 100644 --- a/docs/IDESelection.md +++ b/docs/IDESelection.md @@ -25,7 +25,7 @@ print IDESelection.to_json() # convert the object into a dict ide_selection_dict = ide_selection_instance.to_dict() # create an instance of IDESelection from a dict -ide_selection_form_dict = ide_selection.from_dict(ide_selection_dict) +ide_selection_from_dict = IDESelection.from_dict(ide_selection_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/IDESelections.md b/docs/IDESelections.md index 7c87478..0ec5128 100644 --- a/docs/IDESelections.md +++ b/docs/IDESelections.md @@ -23,7 +23,7 @@ print IDESelections.to_json() # convert the object into a dict ide_selections_dict = ide_selections_instance.to_dict() # create an instance of IDESelections from a dict -ide_selections_form_dict = ide_selections.from_dict(ide_selections_dict) +ide_selections_from_dict = IDESelections.from_dict(ide_selections_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/IDETab.md b/docs/IDETab.md index bc08e43..0ae2c8a 100644 --- a/docs/IDETab.md +++ b/docs/IDETab.md @@ -30,7 +30,7 @@ print IDETab.to_json() # convert the object into a dict ide_tab_dict = ide_tab_instance.to_dict() # create an instance of IDETab from a dict -ide_tab_form_dict = ide_tab.from_dict(ide_tab_dict) +ide_tab_from_dict = IDETab.from_dict(ide_tab_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/IDETabs.md b/docs/IDETabs.md index 3ddce97..6961d36 100644 --- a/docs/IDETabs.md +++ b/docs/IDETabs.md @@ -23,7 +23,7 @@ print IDETabs.to_json() # convert the object into a dict ide_tabs_dict = ide_tabs_instance.to_dict() # create an instance of IDETabs from a dict -ide_tabs_form_dict = ide_tabs.from_dict(ide_tabs_dict) +ide_tabs_from_dict = IDETabs.from_dict(ide_tabs_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/ImageAnalyses.md b/docs/ImageAnalyses.md index de57771..f26cb95 100644 --- a/docs/ImageAnalyses.md +++ b/docs/ImageAnalyses.md @@ -22,7 +22,7 @@ print ImageAnalyses.to_json() # convert the object into a dict image_analyses_dict = image_analyses_instance.to_dict() # create an instance of ImageAnalyses from a dict -image_analyses_form_dict = image_analyses.from_dict(image_analyses_dict) +image_analyses_from_dict = ImageAnalyses.from_dict(image_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/ImageAnalysis.md b/docs/ImageAnalysis.md index 4d017ad..41683d4 100644 --- a/docs/ImageAnalysis.md +++ b/docs/ImageAnalysis.md @@ -25,7 +25,7 @@ print ImageAnalysis.to_json() # convert the object into a dict image_analysis_dict = image_analysis_instance.to_dict() # create an instance of ImageAnalysis from a dict -image_analysis_form_dict = image_analysis.from_dict(image_analysis_dict) +image_analysis_from_dict = ImageAnalysis.from_dict(image_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/InactiveOSServerApplet.md b/docs/InactiveOSServerApplet.md new file mode 100644 index 0000000..e6b246d --- /dev/null +++ b/docs/InactiveOSServerApplet.md @@ -0,0 +1,32 @@ +# InactiveOSServerApplet + +Note: parent is optional here in the case that (parent here is the integration that wants the module launched(VSCode)) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**parent** | [**Application**](Application.md) | | [optional] +**port** | **int** | This is the port number in which we want to serve the copilot at. | [optional] +**type** | [**OSAppletEnum**](OSAppletEnum.md) | | + +## Example + +```python +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet + +# TODO update the JSON string below +json = "{}" +# create an instance of InactiveOSServerApplet from a JSON string +inactive_os_server_applet_instance = InactiveOSServerApplet.from_json(json) +# print the JSON string representation of the object +print InactiveOSServerApplet.to_json() + +# convert the object into a dict +inactive_os_server_applet_dict = inactive_os_server_applet_instance.to_dict() +# create an instance of InactiveOSServerApplet from a dict +inactive_os_server_applet_from_dict = InactiveOSServerApplet.from_dict(inactive_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/InteractedAsset.md b/docs/InteractedAsset.md index 0d23785..940cd50 100644 --- a/docs/InteractedAsset.md +++ b/docs/InteractedAsset.md @@ -23,7 +23,7 @@ print InteractedAsset.to_json() # convert the object into a dict interacted_asset_dict = interacted_asset_instance.to_dict() # create an instance of InteractedAsset from a dict -interacted_asset_form_dict = interacted_asset.from_dict(interacted_asset_dict) +interacted_asset_from_dict = InteractedAsset.from_dict(interacted_asset_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/InteractedAssetInteractions.md b/docs/InteractedAssetInteractions.md index 42c81ca..fe55086 100644 --- a/docs/InteractedAssetInteractions.md +++ b/docs/InteractedAssetInteractions.md @@ -23,7 +23,7 @@ print InteractedAssetInteractions.to_json() # convert the object into a dict interacted_asset_interactions_dict = interacted_asset_interactions_instance.to_dict() # create an instance of InteractedAssetInteractions from a dict -interacted_asset_interactions_form_dict = interacted_asset_interactions.from_dict(interacted_asset_interactions_dict) +interacted_asset_interactions_from_dict = InteractedAssetInteractions.from_dict(interacted_asset_interactions_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/InteractedAssets.md b/docs/InteractedAssets.md index 61c1727..0583ecf 100644 --- a/docs/InteractedAssets.md +++ b/docs/InteractedAssets.md @@ -23,7 +23,7 @@ print InteractedAssets.to_json() # convert the object into a dict interacted_assets_dict = interacted_assets_instance.to_dict() # create an instance of InteractedAssets from a dict -interacted_assets_form_dict = interacted_assets.from_dict(interacted_assets_dict) +interacted_assets_from_dict = InteractedAssets.from_dict(interacted_assets_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/LanguageServerProtocol.md b/docs/LanguageServerProtocol.md index 329ad88..cdc1e19 100644 --- a/docs/LanguageServerProtocol.md +++ b/docs/LanguageServerProtocol.md @@ -23,7 +23,7 @@ print LanguageServerProtocol.to_json() # convert the object into a dict language_server_protocol_dict = language_server_protocol_instance.to_dict() # create an instance of LanguageServerProtocol from a dict -language_server_protocol_form_dict = language_server_protocol.from_dict(language_server_protocol_dict) +language_server_protocol_from_dict = LanguageServerProtocol.from_dict(language_server_protocol_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/LanguageServerProtocolCode.md b/docs/LanguageServerProtocolCode.md index e5435f5..7b73b1a 100644 --- a/docs/LanguageServerProtocolCode.md +++ b/docs/LanguageServerProtocolCode.md @@ -25,7 +25,7 @@ print LanguageServerProtocolCode.to_json() # convert the object into a dict language_server_protocol_code_dict = language_server_protocol_code_instance.to_dict() # create an instance of LanguageServerProtocolCode from a dict -language_server_protocol_code_form_dict = language_server_protocol_code.from_dict(language_server_protocol_code_dict) +language_server_protocol_code_from_dict = LanguageServerProtocolCode.from_dict(language_server_protocol_code_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/LanguageServerProtocolCodeDescription.md b/docs/LanguageServerProtocolCodeDescription.md index 4988788..4b5b6f0 100644 --- a/docs/LanguageServerProtocolCodeDescription.md +++ b/docs/LanguageServerProtocolCodeDescription.md @@ -23,7 +23,7 @@ print LanguageServerProtocolCodeDescription.to_json() # convert the object into a dict language_server_protocol_code_description_dict = language_server_protocol_code_description_instance.to_dict() # create an instance of LanguageServerProtocolCodeDescription from a dict -language_server_protocol_code_description_form_dict = language_server_protocol_code_description.from_dict(language_server_protocol_code_description_dict) +language_server_protocol_code_description_from_dict = LanguageServerProtocolCodeDescription.from_dict(language_server_protocol_code_description_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/LanguageServerProtocolDiagnostic.md b/docs/LanguageServerProtocolDiagnostic.md index 894698a..1a42df7 100644 --- a/docs/LanguageServerProtocolDiagnostic.md +++ b/docs/LanguageServerProtocolDiagnostic.md @@ -28,7 +28,7 @@ print LanguageServerProtocolDiagnostic.to_json() # convert the object into a dict language_server_protocol_diagnostic_dict = language_server_protocol_diagnostic_instance.to_dict() # create an instance of LanguageServerProtocolDiagnostic from a dict -language_server_protocol_diagnostic_form_dict = language_server_protocol_diagnostic.from_dict(language_server_protocol_diagnostic_dict) +language_server_protocol_diagnostic_from_dict = LanguageServerProtocolDiagnostic.from_dict(language_server_protocol_diagnostic_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/LanguageServerProtocolDiagnostics.md b/docs/LanguageServerProtocolDiagnostics.md index 7ac2c22..4edc01c 100644 --- a/docs/LanguageServerProtocolDiagnostics.md +++ b/docs/LanguageServerProtocolDiagnostics.md @@ -23,7 +23,7 @@ print LanguageServerProtocolDiagnostics.to_json() # convert the object into a dict language_server_protocol_diagnostics_dict = language_server_protocol_diagnostics_instance.to_dict() # create an instance of LanguageServerProtocolDiagnostics from a dict -language_server_protocol_diagnostics_form_dict = language_server_protocol_diagnostics.from_dict(language_server_protocol_diagnostics_dict) +language_server_protocol_diagnostics_from_dict = LanguageServerProtocolDiagnostics.from_dict(language_server_protocol_diagnostics_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/LanguageServerProtocolLocation.md b/docs/LanguageServerProtocolLocation.md index a43af96..c417064 100644 --- a/docs/LanguageServerProtocolLocation.md +++ b/docs/LanguageServerProtocolLocation.md @@ -24,7 +24,7 @@ print LanguageServerProtocolLocation.to_json() # convert the object into a dict language_server_protocol_location_dict = language_server_protocol_location_instance.to_dict() # create an instance of LanguageServerProtocolLocation from a dict -language_server_protocol_location_form_dict = language_server_protocol_location.from_dict(language_server_protocol_location_dict) +language_server_protocol_location_from_dict = LanguageServerProtocolLocation.from_dict(language_server_protocol_location_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/LanguageServerProtocolLocationRange.md b/docs/LanguageServerProtocolLocationRange.md index 908bc19..71d92c2 100644 --- a/docs/LanguageServerProtocolLocationRange.md +++ b/docs/LanguageServerProtocolLocationRange.md @@ -24,7 +24,7 @@ print LanguageServerProtocolLocationRange.to_json() # convert the object into a dict language_server_protocol_location_range_dict = language_server_protocol_location_range_instance.to_dict() # create an instance of LanguageServerProtocolLocationRange from a dict -language_server_protocol_location_range_form_dict = language_server_protocol_location_range.from_dict(language_server_protocol_location_range_dict) +language_server_protocol_location_range_from_dict = LanguageServerProtocolLocationRange.from_dict(language_server_protocol_location_range_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/LanguageServerProtocolLocationRangePosition.md b/docs/LanguageServerProtocolLocationRangePosition.md index 339df10..98fa00e 100644 --- a/docs/LanguageServerProtocolLocationRangePosition.md +++ b/docs/LanguageServerProtocolLocationRangePosition.md @@ -24,7 +24,7 @@ print LanguageServerProtocolLocationRangePosition.to_json() # convert the object into a dict language_server_protocol_location_range_position_dict = language_server_protocol_location_range_position_instance.to_dict() # create an instance of LanguageServerProtocolLocationRangePosition from a dict -language_server_protocol_location_range_position_form_dict = language_server_protocol_location_range_position.from_dict(language_server_protocol_location_range_position_dict) +language_server_protocol_location_range_position_from_dict = LanguageServerProtocolLocationRangePosition.from_dict(language_server_protocol_location_range_position_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/Linkify.md b/docs/Linkify.md index 63eda05..6d5de7a 100644 --- a/docs/Linkify.md +++ b/docs/Linkify.md @@ -27,7 +27,7 @@ print Linkify.to_json() # convert the object into a dict linkify_dict = linkify_instance.to_dict() # create an instance of Linkify from a dict -linkify_form_dict = linkify.from_dict(linkify_dict) +linkify_from_dict = Linkify.from_dict(linkify_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/LinkifyMultiple.md b/docs/LinkifyMultiple.md index 647d436..3aba0ff 100644 --- a/docs/LinkifyMultiple.md +++ b/docs/LinkifyMultiple.md @@ -26,7 +26,7 @@ print LinkifyMultiple.to_json() # convert the object into a dict linkify_multiple_dict = linkify_multiple_instance.to_dict() # create an instance of LinkifyMultiple from a dict -linkify_multiple_form_dict = linkify_multiple.from_dict(linkify_multiple_dict) +linkify_multiple_from_dict = LinkifyMultiple.from_dict(linkify_multiple_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/MailgunDistribution.md b/docs/MailgunDistribution.md index 149e693..ccd16f8 100644 --- a/docs/MailgunDistribution.md +++ b/docs/MailgunDistribution.md @@ -23,7 +23,7 @@ print MailgunDistribution.to_json() # convert the object into a dict mailgun_distribution_dict = mailgun_distribution_instance.to_dict() # create an instance of MailgunDistribution from a dict -mailgun_distribution_form_dict = mailgun_distribution.from_dict(mailgun_distribution_dict) +mailgun_distribution_from_dict = MailgunDistribution.from_dict(mailgun_distribution_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/MailgunMetadata.md b/docs/MailgunMetadata.md index e00c3ad..f36989c 100644 --- a/docs/MailgunMetadata.md +++ b/docs/MailgunMetadata.md @@ -23,7 +23,7 @@ print MailgunMetadata.to_json() # convert the object into a dict mailgun_metadata_dict = mailgun_metadata_instance.to_dict() # create an instance of MailgunMetadata from a dict -mailgun_metadata_form_dict = mailgun_metadata.from_dict(mailgun_metadata_dict) +mailgun_metadata_from_dict = MailgunMetadata.from_dict(mailgun_metadata_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/Model.md b/docs/Model.md index 0f5e6d5..be6a618 100644 --- a/docs/Model.md +++ b/docs/Model.md @@ -43,7 +43,7 @@ print Model.to_json() # convert the object into a dict model_dict = model_instance.to_dict() # create an instance of Model from a dict -model_form_dict = model.from_dict(model_dict) +model_from_dict = Model.from_dict(model_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/ModelDeleteCacheInput.md b/docs/ModelDeleteCacheInput.md index 07526e4..c50e94a 100644 --- a/docs/ModelDeleteCacheInput.md +++ b/docs/ModelDeleteCacheInput.md @@ -22,7 +22,7 @@ print ModelDeleteCacheInput.to_json() # convert the object into a dict model_delete_cache_input_dict = model_delete_cache_input_instance.to_dict() # create an instance of ModelDeleteCacheInput from a dict -model_delete_cache_input_form_dict = model_delete_cache_input.from_dict(model_delete_cache_input_dict) +model_delete_cache_input_from_dict = ModelDeleteCacheInput.from_dict(model_delete_cache_input_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/ModelDeleteCacheOutput.md b/docs/ModelDeleteCacheOutput.md index a53124c..ab2b42e 100644 --- a/docs/ModelDeleteCacheOutput.md +++ b/docs/ModelDeleteCacheOutput.md @@ -23,7 +23,7 @@ print ModelDeleteCacheOutput.to_json() # convert the object into a dict model_delete_cache_output_dict = model_delete_cache_output_instance.to_dict() # create an instance of ModelDeleteCacheOutput from a dict -model_delete_cache_output_form_dict = model_delete_cache_output.from_dict(model_delete_cache_output_dict) +model_delete_cache_output_from_dict = ModelDeleteCacheOutput.from_dict(model_delete_cache_output_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/ModelDownloadProgress.md b/docs/ModelDownloadProgress.md index 38ddd42..3d925a2 100644 --- a/docs/ModelDownloadProgress.md +++ b/docs/ModelDownloadProgress.md @@ -24,7 +24,7 @@ print ModelDownloadProgress.to_json() # convert the object into a dict model_download_progress_dict = model_download_progress_instance.to_dict() # create an instance of ModelDownloadProgress from a dict -model_download_progress_form_dict = model_download_progress.from_dict(model_download_progress_dict) +model_download_progress_from_dict = ModelDownloadProgress.from_dict(model_download_progress_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/ModelFoundationEnum.md b/docs/ModelFoundationEnum.md index ec3c304..ce03392 100644 --- a/docs/ModelFoundationEnum.md +++ b/docs/ModelFoundationEnum.md @@ -1,6 +1,6 @@ # ModelFoundationEnum -This is used to describe the foundational models used within POS. +This is used to describe the foundational models used within POS. Note: LATEST models could be used as the latests of these and then could use a system to either(check a file) or we could add and endpoint to click out to the cloud to get the latest models and update these locally so that our users can always have the latest without having to update the application.(not used for now) ## Properties Name | Type | Description | Notes diff --git a/docs/ModelMaxTokens.md b/docs/ModelMaxTokens.md index 43eff1c..373aafd 100644 --- a/docs/ModelMaxTokens.md +++ b/docs/ModelMaxTokens.md @@ -25,7 +25,7 @@ print ModelMaxTokens.to_json() # convert the object into a dict model_max_tokens_dict = model_max_tokens_instance.to_dict() # create an instance of ModelMaxTokens from a dict -model_max_tokens_form_dict = model_max_tokens.from_dict(model_max_tokens_dict) +model_max_tokens_from_dict = ModelMaxTokens.from_dict(model_max_tokens_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/Models.md b/docs/Models.md index e311aaa..1b4d881 100644 --- a/docs/Models.md +++ b/docs/Models.md @@ -23,7 +23,7 @@ print Models.to_json() # convert the object into a dict models_dict = models_instance.to_dict() # create an instance of Models from a dict -models_form_dict = models.from_dict(models_dict) +models_from_dict = Models.from_dict(models_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/Node.md b/docs/Node.md index 2ef2ea0..71fda1a 100644 --- a/docs/Node.md +++ b/docs/Node.md @@ -25,7 +25,7 @@ print Node.to_json() # convert the object into a dict node_dict = node_instance.to_dict() # create an instance of Node from a dict -node_form_dict = node.from_dict(node_dict) +node_from_dict = Node.from_dict(node_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/Notification.md b/docs/Notification.md index 940a418..070693a 100644 --- a/docs/Notification.md +++ b/docs/Notification.md @@ -26,7 +26,7 @@ print Notification.to_json() # convert the object into a dict notification_dict = notification_instance.to_dict() # create an instance of Notification from a dict -notification_form_dict = notification.from_dict(notification_dict) +notification_from_dict = Notification.from_dict(notification_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/OAuthAccount.md b/docs/OAuthAccount.md index 79ce3c5..d7cc52f 100644 --- a/docs/OAuthAccount.md +++ b/docs/OAuthAccount.md @@ -30,7 +30,7 @@ print OAuthAccount.to_json() # convert the object into a dict o_auth_account_dict = o_auth_account_instance.to_dict() # create an instance of OAuthAccount from a dict -o_auth_account_form_dict = o_auth_account.from_dict(o_auth_account_dict) +o_auth_account_from_dict = OAuthAccount.from_dict(o_auth_account_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/OAuthGroup.md b/docs/OAuthGroup.md index 921c349..bee26cb 100644 --- a/docs/OAuthGroup.md +++ b/docs/OAuthGroup.md @@ -23,7 +23,7 @@ print OAuthGroup.to_json() # convert the object into a dict o_auth_group_dict = o_auth_group_instance.to_dict() # create an instance of OAuthGroup from a dict -o_auth_group_form_dict = o_auth_group.from_dict(o_auth_group_dict) +o_auth_group_from_dict = OAuthGroup.from_dict(o_auth_group_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/OAuthToken.md b/docs/OAuthToken.md index d3138b1..febcc2a 100644 --- a/docs/OAuthToken.md +++ b/docs/OAuthToken.md @@ -28,7 +28,7 @@ print OAuthToken.to_json() # convert the object into a dict o_auth_token_dict = o_auth_token_instance.to_dict() # create an instance of OAuthToken from a dict -o_auth_token_form_dict = o_auth_token.from_dict(o_auth_token_dict) +o_auth_token_from_dict = OAuthToken.from_dict(o_auth_token_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/OCRAnalyses.md b/docs/OCRAnalyses.md index 50bfabc..c87a4f9 100644 --- a/docs/OCRAnalyses.md +++ b/docs/OCRAnalyses.md @@ -22,7 +22,7 @@ print OCRAnalyses.to_json() # convert the object into a dict ocr_analyses_dict = ocr_analyses_instance.to_dict() # create an instance of OCRAnalyses from a dict -ocr_analyses_form_dict = ocr_analyses.from_dict(ocr_analyses_dict) +ocr_analyses_from_dict = OCRAnalyses.from_dict(ocr_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/OCRAnalysis.md b/docs/OCRAnalysis.md index 922f869..eba0262 100644 --- a/docs/OCRAnalysis.md +++ b/docs/OCRAnalysis.md @@ -27,7 +27,7 @@ print OCRAnalysis.to_json() # convert the object into a dict ocr_analysis_dict = ocr_analysis_instance.to_dict() # create an instance of OCRAnalysis from a dict -ocr_analysis_form_dict = ocr_analysis.from_dict(ocr_analysis_dict) +ocr_analysis_from_dict = OCRAnalysis.from_dict(ocr_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/OSApi.md b/docs/OSApi.md index 57c5b8e..eba7ffe 100644 --- a/docs/OSApi.md +++ b/docs/OSApi.md @@ -5,13 +5,27 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- [**link_provider**](OSApi.md#link_provider) | **POST** /os/link_provider | /os/link_provider [POST] +[**os_applet_launch**](OSApi.md#os_applet_launch) | **POST** /os/applet/launch | /os/applet/launch [POST] +[**os_applet_restart**](OSApi.md#os_applet_restart) | **POST** /os/applet/restart | /os/applet/restart [POST] +[**os_applet_terminate**](OSApi.md#os_applet_terminate) | **POST** /os/applet/terminate | /os/applet/terminate [POST] +[**os_browser_url_open**](OSApi.md#os_browser_url_open) | **POST** /os/browser/url/open | /os/browser/url/open [POST] [**os_device_information**](OSApi.md#os_device_information) | **GET** /os/device/information | /os/device/information [GET] +[**os_filesystem_file_open**](OSApi.md#os_filesystem_file_open) | **POST** /os/filesystem/file/open | /os/filesystem/file/open [POST] +[**os_filesystem_file_read_streamed**](OSApi.md#os_filesystem_file_read_streamed) | **GET** /os/filesystem/file/read/streamed | /os/filesystem/file/read/streamed [WS] +[**os_filesystem_path_verify**](OSApi.md#os_filesystem_path_verify) | **POST** /os/filesystem/path/verify | /os/filesystem/path/verify [POST] +[**os_filesystem_pick_files**](OSApi.md#os_filesystem_pick_files) | **POST** /os/filesystem/files/pick | /os/filesystem/files/pick [POST] +[**os_filesystem_pick_folders**](OSApi.md#os_filesystem_pick_folders) | **POST** /os/filesystem/folders/pick | /os/filesystem/folders/pick [POST] +[**os_memory_optimize**](OSApi.md#os_memory_optimize) | **POST** /os/memory/optimize | /os/memory/optimize [POST] +[**os_metadata**](OSApi.md#os_metadata) | **GET** /os/metadata | /os/metadata [GET] [**os_permissions**](OSApi.md#os_permissions) | **GET** /os/permissions | /os/permissions [GET] [**os_permissions_request**](OSApi.md#os_permissions_request) | **POST** /os/permissions/request | /os/permissions/request [POST] [**os_restart**](OSApi.md#os_restart) | **GET** /os/restart | Your GET endpoint +[**os_settings_snapshot**](OSApi.md#os_settings_snapshot) | **GET** /os/settings | /os/settings [GET] +[**os_settings_stream**](OSApi.md#os_settings_stream) | **GET** /os/settings/stream | /os/settings/stream [WS] +[**os_settings_update**](OSApi.md#os_settings_update) | **POST** /os/settings/update | /os/settings/update [POST] +[**os_terminate**](OSApi.md#os_terminate) | **POST** /os/terminate | /os/terminate [POST] [**os_update_check**](OSApi.md#os_update_check) | **POST** /os/update/check | /os/update/check [POST] -[**pick_files**](OSApi.md#pick_files) | **POST** /os/files/pick | /os/files/pick [POST] -[**pick_folders**](OSApi.md#pick_folders) | **POST** /os/folders/pick | /os/folders/pick [POST] +[**os_update_check_stream**](OSApi.md#os_update_check_stream) | **GET** /os/update/check/stream | /os/update/check/stream [WS] [**sign_into_os**](OSApi.md#sign_into_os) | **POST** /os/sign_in | [**sign_out_of_os**](OSApi.md#sign_out_of_os) | **POST** /os/sign_out | /os/sign_out [POST] @@ -86,12 +100,678 @@ 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) +# **os_applet_launch** +> ActiveOSServerApplet os_applet_launch(inactive_os_server_applet=inactive_os_server_applet) + +/os/applet/launch [POST] + +This will attempt to launch(serve) a micro_application. If one is already spun up we will just return the port number. TODO: take in an application and return a port number at minimum. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet +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.OSApi(api_client) + inactive_os_server_applet = pieces_os_client.InactiveOSServerApplet() # InactiveOSServerApplet | (optional) + + try: + # /os/applet/launch [POST] + api_response = api_instance.os_applet_launch(inactive_os_server_applet=inactive_os_server_applet) + print("The response of OSApi->os_applet_launch:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_applet_launch: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **inactive_os_server_applet** | [**InactiveOSServerApplet**](InactiveOSServerApplet.md)| | [optional] + +### Return type + +[**ActiveOSServerApplet**](ActiveOSServerApplet.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_applet_restart** +> ActiveOSServerApplet os_applet_restart(inactive_os_server_applet=inactive_os_server_applet) + +/os/applet/restart [POST] + +This will attempt to restart a micro_application.(this will shut down the copilot and then rehost it) + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet +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.OSApi(api_client) + inactive_os_server_applet = pieces_os_client.InactiveOSServerApplet() # InactiveOSServerApplet | (optional) + + try: + # /os/applet/restart [POST] + api_response = api_instance.os_applet_restart(inactive_os_server_applet=inactive_os_server_applet) + print("The response of OSApi->os_applet_restart:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_applet_restart: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **inactive_os_server_applet** | [**InactiveOSServerApplet**](InactiveOSServerApplet.md)| | [optional] + +### Return type + +[**ActiveOSServerApplet**](ActiveOSServerApplet.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_applet_terminate** +> os_applet_terminate(terminating_os_server_applet=terminating_os_server_applet) + +/os/applet/terminate [POST] + +This will attempt to shutdown or terminate a specified micro_application. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.terminating_os_server_applet import TerminatingOSServerApplet +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.OSApi(api_client) + terminating_os_server_applet = pieces_os_client.TerminatingOSServerApplet() # TerminatingOSServerApplet | (optional) + + try: + # /os/applet/terminate [POST] + api_instance.os_applet_terminate(terminating_os_server_applet=terminating_os_server_applet) + except Exception as e: + print("Exception when calling OSApi->os_applet_terminate: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **terminating_os_server_applet** | [**TerminatingOSServerApplet**](TerminatingOSServerApplet.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **os_browser_url_open** +> os_browser_url_open(body=body) + +/os/browser/url/open [POST] + +This will accept a url and launch this in an external browser. + +### 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.OSApi(api_client) + body = 'body_example' # str | (optional) + + try: + # /os/browser/url/open [POST] + api_instance.os_browser_url_open(body=body) + except Exception as e: + print("Exception when calling OSApi->os_browser_url_open: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + # **os_device_information** > OSDeviceInformationReturnable os_device_information() -/os/device/information [GET] +/os/device/information [GET] + +This will get information related to your specific device. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_device_information_returnable import OSDeviceInformationReturnable +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.OSApi(api_client) + + try: + # /os/device/information [GET] + api_response = api_instance.os_device_information() + print("The response of OSApi->os_device_information:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_device_information: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**OSDeviceInformationReturnable**](OSDeviceInformationReturnable.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_filesystem_file_open** +> os_filesystem_file_open(body=body) + +/os/filesystem/file/open [POST] + +This will accept a path and will launch a path in a given finder/file explorer window note: TODO in the future add an endpoint for open/in || open/with (browser,files,...etc) && if so we will want /os/open_with/file + +### 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.OSApi(api_client) + body = 'body_example' # str | (optional) + + try: + # /os/filesystem/file/open [POST] + api_instance.os_filesystem_file_open(body=body) + except Exception as e: + print("Exception when calling OSApi->os_filesystem_file_open: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **os_filesystem_file_read_streamed** +> OSFileStreamingRead os_filesystem_file_read_streamed(os_file_streaming_read_attempt=os_file_streaming_read_attempt) + +/os/filesystem/file/read/streamed [WS] + +This will stream(via a WS the contents of a file back to the client, given a file, it will read the contents and return to the client. NOTE: will NOT support relative paths. only ABSOLUTE paths. NOTE: needs to be a File.(will not stream a folder) NOTE: we might want to put a limit on the size of the file(IE no more than a GB or something like that??) TODO: would be nice to cancel stream NOTE: for v2 we could have two query params i.e. find which could take in a relative path and or file name and the other could be compress i.e. streaming a gzip vs the raw bytes.. the caveat here would be mack would need to decompress em. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_file_streaming_read import OSFileStreamingRead +from pieces_os_client.models.os_file_streaming_read_attempt import OSFileStreamingReadAttempt +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.OSApi(api_client) + os_file_streaming_read_attempt = pieces_os_client.OSFileStreamingReadAttempt() # OSFileStreamingReadAttempt | (optional) + + try: + # /os/filesystem/file/read/streamed [WS] + api_response = api_instance.os_filesystem_file_read_streamed(os_file_streaming_read_attempt=os_file_streaming_read_attempt) + print("The response of OSApi->os_filesystem_file_read_streamed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_filesystem_file_read_streamed: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **os_file_streaming_read_attempt** | [**OSFileStreamingReadAttempt**](OSFileStreamingReadAttempt.md)| | [optional] + +### Return type + +[**OSFileStreamingRead**](OSFileStreamingRead.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_filesystem_path_verify** +> VerifiedOSFilesystemPath os_filesystem_path_verify(body=body) + +/os/filesystem/path/verify [POST] + +This will determine in a given path is a file/a directory or invalid. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.verified_os_filesystem_path import VerifiedOSFilesystemPath +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.OSApi(api_client) + body = 'body_example' # str | (optional) + + try: + # /os/filesystem/path/verify [POST] + api_response = api_instance.os_filesystem_path_verify(body=body) + print("The response of OSApi->os_filesystem_path_verify:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_filesystem_path_verify: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **str**| | [optional] + +### Return type + +[**VerifiedOSFilesystemPath**](VerifiedOSFilesystemPath.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_filesystem_pick_files** +> List[str] os_filesystem_pick_files(file_picker_input=file_picker_input) + +/os/filesystem/files/pick [POST] + +This will trigger a filer picker and return the string paths of the files that were selected. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.file_picker_input import FilePickerInput +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.OSApi(api_client) + file_picker_input = pieces_os_client.FilePickerInput() # FilePickerInput | (optional) + + try: + # /os/filesystem/files/pick [POST] + api_response = api_instance.os_filesystem_pick_files(file_picker_input=file_picker_input) + print("The response of OSApi->os_filesystem_pick_files:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_filesystem_pick_files: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file_picker_input** | [**FilePickerInput**](FilePickerInput.md)| | [optional] + +### Return type + +**List[str]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_filesystem_pick_folders** +> List[str] os_filesystem_pick_folders() + +/os/filesystem/folders/pick [POST] + +This will trigger a folder picker and return the string paths of the folders that were selected. + +### 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.OSApi(api_client) + + try: + # /os/filesystem/folders/pick [POST] + api_response = api_instance.os_filesystem_pick_folders() + print("The response of OSApi->os_filesystem_pick_folders:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_filesystem_pick_folders: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**List[str]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain -This will get information related to your specific device. +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_memory_optimize** +> os_memory_optimize() + +/os/memory/optimize [POST] + +This will optimize memory across PiecesOS.(TODO in the future might want to accept a body, so this will be a POST) ### Example @@ -99,7 +779,6 @@ This will get information related to your specific device. import time import os import pieces_os_client -from pieces_os_client.models.os_device_information_returnable import OSDeviceInformationReturnable from pieces_os_client.rest import ApiException from pprint import pprint @@ -116,12 +795,74 @@ with pieces_os_client.ApiClient(configuration) as api_client: api_instance = pieces_os_client.OSApi(api_client) try: - # /os/device/information [GET] - api_response = api_instance.os_device_information() - print("The response of OSApi->os_device_information:\n") + # /os/memory/optimize [POST] + api_instance.os_memory_optimize() + except Exception as e: + print("Exception when calling OSApi->os_memory_optimize: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### 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) + +# **os_metadata** +> OSServerMetadata os_metadata() + +/os/metadata [GET] + +This will return metadata (total materials) in your pieces drive. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_server_metadata import OSServerMetadata +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.OSApi(api_client) + + try: + # /os/metadata [GET] + api_response = api_instance.os_metadata() + print("The response of OSApi->os_metadata:\n") pprint(api_response) except Exception as e: - print("Exception when calling OSApi->os_device_information: %s\n" % e) + print("Exception when calling OSApi->os_metadata: %s\n" % e) ``` @@ -131,7 +872,7 @@ This endpoint does not need any parameter. ### Return type -[**OSDeviceInformationReturnable**](OSDeviceInformationReturnable.md) +[**OSServerMetadata**](OSServerMetadata.md) ### Authorization @@ -343,12 +1084,12 @@ 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) -# **os_update_check** -> CheckedOSUpdate os_update_check(unchecked_os_update=unchecked_os_update) +# **os_settings_snapshot** +> OSServerSettings os_settings_snapshot() -/os/update/check [POST] +/os/settings [GET] -This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc +This is a snapshot of the piecesOS settings ### Example @@ -356,8 +1097,7 @@ This is a helper endpoint that will check the status of an update for PiecesOS. import time import os import pieces_os_client -from pieces_os_client.models.checked_os_update import CheckedOSUpdate -from pieces_os_client.models.unchecked_os_update import UncheckedOSUpdate +from pieces_os_client.models.os_server_settings import OSServerSettings from pieces_os_client.rest import ApiException from pprint import pprint @@ -372,15 +1112,143 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.OSApi(api_client) - unchecked_os_update = pieces_os_client.UncheckedOSUpdate() # UncheckedOSUpdate | (optional) try: - # /os/update/check [POST] - api_response = api_instance.os_update_check(unchecked_os_update=unchecked_os_update) - print("The response of OSApi->os_update_check:\n") + # /os/settings [GET] + api_response = api_instance.os_settings_snapshot() + print("The response of OSApi->os_settings_snapshot:\n") pprint(api_response) except Exception as e: - print("Exception when calling OSApi->os_update_check: %s\n" % e) + print("Exception when calling OSApi->os_settings_snapshot: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**OSServerSettings**](OSServerSettings.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_settings_stream** +> OSServerSettings os_settings_stream() + +/os/settings/stream [WS] + +This is a websocket that will emit a change on the update of the OSSettings. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_server_settings import OSServerSettings +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.OSApi(api_client) + + try: + # /os/settings/stream [WS] + api_response = api_instance.os_settings_stream() + print("The response of OSApi->os_settings_stream:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_settings_stream: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**OSServerSettings**](OSServerSettings.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **os_settings_update** +> OSServerSettings os_settings_update(os_server_settings=os_server_settings) + +/os/settings/update [POST] + +This will ensure that we update the os settings. This will emit a change via the setting stream as well. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_server_settings import OSServerSettings +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.OSApi(api_client) + os_server_settings = pieces_os_client.OSServerSettings() # OSServerSettings | (optional) + + try: + # /os/settings/update [POST] + api_response = api_instance.os_settings_update(os_server_settings=os_server_settings) + print("The response of OSApi->os_settings_update:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OSApi->os_settings_update: %s\n" % e) ``` @@ -389,11 +1257,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **unchecked_os_update** | [**UncheckedOSUpdate**](UncheckedOSUpdate.md)| | [optional] + **os_server_settings** | [**OSServerSettings**](OSServerSettings.md)| | [optional] ### Return type -[**CheckedOSUpdate**](CheckedOSUpdate.md) +[**OSServerSettings**](OSServerSettings.md) ### Authorization @@ -412,12 +1280,12 @@ 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) -# **pick_files** -> List[str] pick_files(file_picker_input=file_picker_input) +# **os_terminate** +> os_terminate() -/os/files/pick [POST] +/os/terminate [POST] -This will trigger a filer picker and return the string paths of the files that were selected. +This will force quit PiecesOS ### Example @@ -425,7 +1293,6 @@ This will trigger a filer picker and return the string paths of the files that w import time import os import pieces_os_client -from pieces_os_client.models.file_picker_input import FilePickerInput from pieces_os_client.rest import ApiException from pprint import pprint @@ -440,15 +1307,78 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.OSApi(api_client) - file_picker_input = pieces_os_client.FilePickerInput() # FilePickerInput | (optional) try: - # /os/files/pick [POST] - api_response = api_instance.pick_files(file_picker_input=file_picker_input) - print("The response of OSApi->pick_files:\n") + # /os/terminate [POST] + api_instance.os_terminate() + except Exception as e: + print("Exception when calling OSApi->os_terminate: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### 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) + +# **os_update_check** +> OSServerUpdateStatus os_update_check(unchecked_os_server_update=unchecked_os_server_update) + +/os/update/check [POST] + +This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus +from pieces_os_client.models.unchecked_os_server_update import UncheckedOSServerUpdate +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.OSApi(api_client) + unchecked_os_server_update = pieces_os_client.UncheckedOSServerUpdate() # UncheckedOSServerUpdate | (optional) + + try: + # /os/update/check [POST] + api_response = api_instance.os_update_check(unchecked_os_server_update=unchecked_os_server_update) + print("The response of OSApi->os_update_check:\n") pprint(api_response) except Exception as e: - print("Exception when calling OSApi->pick_files: %s\n" % e) + print("Exception when calling OSApi->os_update_check: %s\n" % e) ``` @@ -457,11 +1387,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **file_picker_input** | [**FilePickerInput**](FilePickerInput.md)| | [optional] + **unchecked_os_server_update** | [**UncheckedOSServerUpdate**](UncheckedOSServerUpdate.md)| | [optional] ### Return type -**List[str]** +[**OSServerUpdateStatus**](OSServerUpdateStatus.md) ### Authorization @@ -480,12 +1410,12 @@ 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) -# **pick_folders** -> List[str] pick_folders() +# **os_update_check_stream** +> OSServerUpdateStatus os_update_check_stream() -/os/folders/pick [POST] +/os/update/check/stream [WS] -This will trigger a folder picker and return the string paths of the folders that were selected. +This will first kick off the check. Then will stream the progress. **TODO lets think about if we want to have a closing NOTE: it is reccommended to use the stream instead of pulling(via the normal check endpoint). ### Example @@ -493,6 +1423,7 @@ This will trigger a folder picker and return the string paths of the folders tha import time import os import pieces_os_client +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus from pieces_os_client.rest import ApiException from pprint import pprint @@ -509,12 +1440,12 @@ with pieces_os_client.ApiClient(configuration) as api_client: api_instance = pieces_os_client.OSApi(api_client) try: - # /os/folders/pick [POST] - api_response = api_instance.pick_folders() - print("The response of OSApi->pick_folders:\n") + # /os/update/check/stream [WS] + api_response = api_instance.os_update_check_stream() + print("The response of OSApi->os_update_check_stream:\n") pprint(api_response) except Exception as e: - print("Exception when calling OSApi->pick_folders: %s\n" % e) + print("Exception when calling OSApi->os_update_check_stream: %s\n" % e) ``` @@ -524,7 +1455,7 @@ This endpoint does not need any parameter. ### Return type -**List[str]** +[**OSServerUpdateStatus**](OSServerUpdateStatus.md) ### Authorization diff --git a/docs/OSAppletEnum.md b/docs/OSAppletEnum.md new file mode 100644 index 0000000..486a44f --- /dev/null +++ b/docs/OSAppletEnum.md @@ -0,0 +1,11 @@ +# OSAppletEnum + +This is an enum specifically for the different types of micro_applications/experiences/feature module NOTE: TODO copilot_wasm or copilot_minimal NOTE: WORKSTREAM_ACTIVITY and WORKFLOW_ACTIVITY might be diff in the future(workflow is what we have today, workstream will be a v2) NOTE: PLACEHOLDERS here are here to buy some additional changes for enums that dont yet exist(JIC) if not used, then not used. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/OSDeviceCPUHardwareInformation.md b/docs/OSDeviceCPUHardwareInformation.md index 188cba6..dd05e8a 100644 --- a/docs/OSDeviceCPUHardwareInformation.md +++ b/docs/OSDeviceCPUHardwareInformation.md @@ -24,7 +24,7 @@ print OSDeviceCPUHardwareInformation.to_json() # convert the object into a dict os_device_cpu_hardware_information_dict = os_device_cpu_hardware_information_instance.to_dict() # create an instance of OSDeviceCPUHardwareInformation from a dict -os_device_cpu_hardware_information_form_dict = os_device_cpu_hardware_information.from_dict(os_device_cpu_hardware_information_dict) +os_device_cpu_hardware_information_from_dict = OSDeviceCPUHardwareInformation.from_dict(os_device_cpu_hardware_information_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/OSDeviceDependenciesInformation.md b/docs/OSDeviceDependenciesInformation.md index a563c60..d7e087d 100644 --- a/docs/OSDeviceDependenciesInformation.md +++ b/docs/OSDeviceDependenciesInformation.md @@ -23,7 +23,7 @@ print OSDeviceDependenciesInformation.to_json() # convert the object into a dict os_device_dependencies_information_dict = os_device_dependencies_information_instance.to_dict() # create an instance of OSDeviceDependenciesInformation from a dict -os_device_dependencies_information_form_dict = os_device_dependencies_information.from_dict(os_device_dependencies_information_dict) +os_device_dependencies_information_from_dict = OSDeviceDependenciesInformation.from_dict(os_device_dependencies_information_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/OSDeviceGPUHardwareCapabilitiesInformation.md b/docs/OSDeviceGPUHardwareCapabilitiesInformation.md index 7232161..5afdfb8 100644 --- a/docs/OSDeviceGPUHardwareCapabilitiesInformation.md +++ b/docs/OSDeviceGPUHardwareCapabilitiesInformation.md @@ -23,7 +23,7 @@ print OSDeviceGPUHardwareCapabilitiesInformation.to_json() # convert the object into a dict os_device_gpu_hardware_capabilities_information_dict = os_device_gpu_hardware_capabilities_information_instance.to_dict() # create an instance of OSDeviceGPUHardwareCapabilitiesInformation from a dict -os_device_gpu_hardware_capabilities_information_form_dict = os_device_gpu_hardware_capabilities_information.from_dict(os_device_gpu_hardware_capabilities_information_dict) +os_device_gpu_hardware_capabilities_information_from_dict = OSDeviceGPUHardwareCapabilitiesInformation.from_dict(os_device_gpu_hardware_capabilities_information_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/OSDeviceGPUHardwareInformation.md b/docs/OSDeviceGPUHardwareInformation.md index 42b84f0..347e008 100644 --- a/docs/OSDeviceGPUHardwareInformation.md +++ b/docs/OSDeviceGPUHardwareInformation.md @@ -25,7 +25,7 @@ print OSDeviceGPUHardwareInformation.to_json() # convert the object into a dict os_device_gpu_hardware_information_dict = os_device_gpu_hardware_information_instance.to_dict() # create an instance of OSDeviceGPUHardwareInformation from a dict -os_device_gpu_hardware_information_form_dict = os_device_gpu_hardware_information.from_dict(os_device_gpu_hardware_information_dict) +os_device_gpu_hardware_information_from_dict = OSDeviceGPUHardwareInformation.from_dict(os_device_gpu_hardware_information_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/OSDeviceHardwareInformation.md b/docs/OSDeviceHardwareInformation.md index bef9705..56e12c6 100644 --- a/docs/OSDeviceHardwareInformation.md +++ b/docs/OSDeviceHardwareInformation.md @@ -24,7 +24,7 @@ print OSDeviceHardwareInformation.to_json() # convert the object into a dict os_device_hardware_information_dict = os_device_hardware_information_instance.to_dict() # create an instance of OSDeviceHardwareInformation from a dict -os_device_hardware_information_form_dict = os_device_hardware_information.from_dict(os_device_hardware_information_dict) +os_device_hardware_information_from_dict = OSDeviceHardwareInformation.from_dict(os_device_hardware_information_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/OSDeviceInformationReturnable.md b/docs/OSDeviceInformationReturnable.md index a979ace..09ffce1 100644 --- a/docs/OSDeviceInformationReturnable.md +++ b/docs/OSDeviceInformationReturnable.md @@ -26,7 +26,7 @@ print OSDeviceInformationReturnable.to_json() # convert the object into a dict os_device_information_returnable_dict = os_device_information_returnable_instance.to_dict() # create an instance of OSDeviceInformationReturnable from a dict -os_device_information_returnable_form_dict = os_device_information_returnable.from_dict(os_device_information_returnable_dict) +os_device_information_returnable_from_dict = OSDeviceInformationReturnable.from_dict(os_device_information_returnable_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/OSFileReadStreamedProgress.md b/docs/OSFileReadStreamedProgress.md new file mode 100644 index 0000000..2be24d0 --- /dev/null +++ b/docs/OSFileReadStreamedProgress.md @@ -0,0 +1,35 @@ +# OSFileReadStreamedProgress + +This is a model to return stream progress for a file read. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**status** | [**ModelDownloadProgressStatusEnum**](ModelDownloadProgressStatusEnum.md) | | +**percentage** | **float** | Optionally if the download is in progress you will receive a download percent(from 0-100). | [optional] +**path** | **str** | | +**id** | **str** | This is a generated UUID that represents this current stream in progress(can be used to cancel this in the future) | +**bytes** | [**TransferableBytes**](TransferableBytes.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.os_file_read_streamed_progress import OSFileReadStreamedProgress + +# TODO update the JSON string below +json = "{}" +# create an instance of OSFileReadStreamedProgress from a JSON string +os_file_read_streamed_progress_instance = OSFileReadStreamedProgress.from_json(json) +# print the JSON string representation of the object +print OSFileReadStreamedProgress.to_json() + +# convert the object into a dict +os_file_read_streamed_progress_dict = os_file_read_streamed_progress_instance.to_dict() +# create an instance of OSFileReadStreamedProgress from a dict +os_file_read_streamed_progress_form_dict = os_file_read_streamed_progress.from_dict(os_file_read_streamed_progress_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/OSFileStreamingRead.md b/docs/OSFileStreamingRead.md new file mode 100644 index 0000000..b9b51a0 --- /dev/null +++ b/docs/OSFileStreamingRead.md @@ -0,0 +1,35 @@ +# OSFileStreamingRead + +This is a model to return stream progress for a file read. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**status** | [**ModelDownloadProgressStatusEnum**](ModelDownloadProgressStatusEnum.md) | | +**percentage** | **float** | Optionally if the download is in progress you will receive a download percent(from 0-100). | [optional] +**path** | **str** | | +**id** | **str** | This is a generated UUID that represents this current stream in progress(can be used to cancel this in the future) | +**bytes** | [**TransferableBytes**](TransferableBytes.md) | | [optional] +**progress** | [**OSFileStreamingReadProgress**](OSFileStreamingReadProgress.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.os_file_streaming_read import OSFileStreamingRead + +# TODO update the JSON string below +json = "{}" +# create an instance of OSFileStreamingRead from a JSON string +os_file_streaming_read_instance = OSFileStreamingRead.from_json(json) +# print the JSON string representation of the object +print OSFileStreamingRead.to_json() + +# convert the object into a dict +os_file_streaming_read_dict = os_file_streaming_read_instance.to_dict() +# create an instance of OSFileStreamingRead from a dict +os_file_streaming_read_from_dict = OSFileStreamingRead.from_dict(os_file_streaming_read_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/OSFileStreamingReadAttempt.md b/docs/OSFileStreamingReadAttempt.md new file mode 100644 index 0000000..500f324 --- /dev/null +++ b/docs/OSFileStreamingReadAttempt.md @@ -0,0 +1,29 @@ +# OSFileStreamingReadAttempt + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**path** | **str** | | + +## Example + +```python +from pieces_os_client.models.os_file_streaming_read_attempt import OSFileStreamingReadAttempt + +# TODO update the JSON string below +json = "{}" +# create an instance of OSFileStreamingReadAttempt from a JSON string +os_file_streaming_read_attempt_instance = OSFileStreamingReadAttempt.from_json(json) +# print the JSON string representation of the object +print OSFileStreamingReadAttempt.to_json() + +# convert the object into a dict +os_file_streaming_read_attempt_dict = os_file_streaming_read_attempt_instance.to_dict() +# create an instance of OSFileStreamingReadAttempt from a dict +os_file_streaming_read_attempt_from_dict = OSFileStreamingReadAttempt.from_dict(os_file_streaming_read_attempt_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/OSFileStreamingReadProgress.md b/docs/OSFileStreamingReadProgress.md new file mode 100644 index 0000000..1e02df9 --- /dev/null +++ b/docs/OSFileStreamingReadProgress.md @@ -0,0 +1,31 @@ +# OSFileStreamingReadProgress + +This is the progress for the OSFileStreamingRead + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**total** | [**ByteDescriptor**](ByteDescriptor.md) | | +**transferred** | [**ByteDescriptor**](ByteDescriptor.md) | | + +## Example + +```python +from pieces_os_client.models.os_file_streaming_read_progress import OSFileStreamingReadProgress + +# TODO update the JSON string below +json = "{}" +# create an instance of OSFileStreamingReadProgress from a JSON string +os_file_streaming_read_progress_instance = OSFileStreamingReadProgress.from_json(json) +# print the JSON string representation of the object +print OSFileStreamingReadProgress.to_json() + +# convert the object into a dict +os_file_streaming_read_progress_dict = os_file_streaming_read_progress_instance.to_dict() +# create an instance of OSFileStreamingReadProgress from a dict +os_file_streaming_read_progress_from_dict = OSFileStreamingReadProgress.from_dict(os_file_streaming_read_progress_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/OSHealth.md b/docs/OSHealth.md index 5340b96..7c0c3ac 100644 --- a/docs/OSHealth.md +++ b/docs/OSHealth.md @@ -24,7 +24,7 @@ print OSHealth.to_json() # convert the object into a dict os_health_dict = os_health_instance.to_dict() # create an instance of OSHealth from a dict -os_health_form_dict = os_health.from_dict(os_health_dict) +os_health_from_dict = OSHealth.from_dict(os_health_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/OSPermissions.md b/docs/OSPermissions.md index 08d27b2..4dc4ddc 100644 --- a/docs/OSPermissions.md +++ b/docs/OSPermissions.md @@ -23,7 +23,7 @@ print OSPermissions.to_json() # convert the object into a dict os_permissions_dict = os_permissions_instance.to_dict() # create an instance of OSPermissions from a dict -os_permissions_form_dict = os_permissions.from_dict(os_permissions_dict) +os_permissions_from_dict = OSPermissions.from_dict(os_permissions_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/OSProcessingPermissions.md b/docs/OSProcessingPermissions.md index 62c2c9f..9a27e0e 100644 --- a/docs/OSProcessingPermissions.md +++ b/docs/OSProcessingPermissions.md @@ -24,7 +24,7 @@ print OSProcessingPermissions.to_json() # convert the object into a dict os_processing_permissions_dict = os_processing_permissions_instance.to_dict() # create an instance of OSProcessingPermissions from a dict -os_processing_permissions_form_dict = os_processing_permissions.from_dict(os_processing_permissions_dict) +os_processing_permissions_from_dict = OSProcessingPermissions.from_dict(os_processing_permissions_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/OSServerMetadata.md b/docs/OSServerMetadata.md new file mode 100644 index 0000000..de52133 --- /dev/null +++ b/docs/OSServerMetadata.md @@ -0,0 +1,30 @@ +# OSServerMetadata + +This will return metadata (total materials) in your pieces drive. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**totals** | [**TrackedSummaryTotals**](TrackedSummaryTotals.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.os_server_metadata import OSServerMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of OSServerMetadata from a JSON string +os_server_metadata_instance = OSServerMetadata.from_json(json) +# print the JSON string representation of the object +print OSServerMetadata.to_json() + +# convert the object into a dict +os_server_metadata_dict = os_server_metadata_instance.to_dict() +# create an instance of OSServerMetadata from a dict +os_server_metadata_from_dict = OSServerMetadata.from_dict(os_server_metadata_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/OSServerSettings.md b/docs/OSServerSettings.md new file mode 100644 index 0000000..2a79ef9 --- /dev/null +++ b/docs/OSServerSettings.md @@ -0,0 +1,30 @@ +# OSServerSettings + +This is the model for the PiecesOS specific settings. autoboot: refers to both the bootup of POS on the system login, default is false + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**autoboot** | **bool** | | [optional] + +## Example + +```python +from pieces_os_client.models.os_server_settings import OSServerSettings + +# TODO update the JSON string below +json = "{}" +# create an instance of OSServerSettings from a JSON string +os_server_settings_instance = OSServerSettings.from_json(json) +# print the JSON string representation of the object +print OSServerSettings.to_json() + +# convert the object into a dict +os_server_settings_dict = os_server_settings_instance.to_dict() +# create an instance of OSServerSettings from a dict +os_server_settings_from_dict = OSServerSettings.from_dict(os_server_settings_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/OSServerUpdateStatus.md b/docs/OSServerUpdateStatus.md new file mode 100644 index 0000000..47d512c --- /dev/null +++ b/docs/OSServerUpdateStatus.md @@ -0,0 +1,32 @@ +# OSServerUpdateStatus + +This is the model for the progress of the current update of Pieces os. /os/update/check/stream && /os/update/check/ we will emit on a progress update updated: is an optional property that will let us know when the update was checked last. NOTE: it is reccommended to use the stream instead of pulling. NOTE: lets think about if we want to have a closing(as well as how we want to handle restarts) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**status** | [**UpdatingStatusEnum**](UpdatingStatusEnum.md) | | +**updated** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional] +**percentage** | **float** | Optionally if the update is in progress you will recieve a download percent(from 0-100). | [optional] + +## Example + +```python +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus + +# TODO update the JSON string below +json = "{}" +# create an instance of OSServerUpdateStatus from a JSON string +os_server_update_status_instance = OSServerUpdateStatus.from_json(json) +# print the JSON string representation of the object +print OSServerUpdateStatus.to_json() + +# convert the object into a dict +os_server_update_status_dict = os_server_update_status_instance.to_dict() +# create an instance of OSServerUpdateStatus from a dict +os_server_update_status_from_dict = OSServerUpdateStatus.from_dict(os_server_update_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/OnboardedPersonaDetails.md b/docs/OnboardedPersonaDetails.md index 61ceb80..e11c47d 100644 --- a/docs/OnboardedPersonaDetails.md +++ b/docs/OnboardedPersonaDetails.md @@ -23,7 +23,7 @@ print OnboardedPersonaDetails.to_json() # convert the object into a dict onboarded_persona_details_dict = onboarded_persona_details_instance.to_dict() # create an instance of OnboardedPersonaDetails from a dict -onboarded_persona_details_form_dict = onboarded_persona_details.from_dict(onboarded_persona_details_dict) +onboarded_persona_details_from_dict = OnboardedPersonaDetails.from_dict(onboarded_persona_details_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/OpenAIModelsListInput.md b/docs/OpenAIModelsListInput.md index e593bfb..3efc084 100644 --- a/docs/OpenAIModelsListInput.md +++ b/docs/OpenAIModelsListInput.md @@ -23,7 +23,7 @@ print OpenAIModelsListInput.to_json() # convert the object into a dict open_ai_models_list_input_dict = open_ai_models_list_input_instance.to_dict() # create an instance of OpenAIModelsListInput from a dict -open_ai_models_list_input_form_dict = open_ai_models_list_input.from_dict(open_ai_models_list_input_dict) +open_ai_models_list_input_from_dict = OpenAIModelsListInput.from_dict(open_ai_models_list_input_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/OpenAIModelsListOutput.md b/docs/OpenAIModelsListOutput.md index 64f90e2..bfb2ea5 100644 --- a/docs/OpenAIModelsListOutput.md +++ b/docs/OpenAIModelsListOutput.md @@ -23,7 +23,7 @@ print OpenAIModelsListOutput.to_json() # convert the object into a dict open_ai_models_list_output_dict = open_ai_models_list_output_instance.to_dict() # create an instance of OpenAIModelsListOutput from a dict -open_ai_models_list_output_form_dict = open_ai_models_list_output.from_dict(open_ai_models_list_output_dict) +open_ai_models_list_output_from_dict = OpenAIModelsListOutput.from_dict(open_ai_models_list_output_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/OrderedMetrics.md b/docs/OrderedMetrics.md index d8aa16b..0d908fe 100644 --- a/docs/OrderedMetrics.md +++ b/docs/OrderedMetrics.md @@ -23,7 +23,7 @@ print OrderedMetrics.to_json() # convert the object into a dict ordered_metrics_dict = ordered_metrics_instance.to_dict() # create an instance of OrderedMetrics from a dict -ordered_metrics_form_dict = ordered_metrics.from_dict(ordered_metrics_dict) +ordered_metrics_from_dict = OrderedMetrics.from_dict(ordered_metrics_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/PKCE.md b/docs/PKCE.md index 66333d5..43a52bc 100644 --- a/docs/PKCE.md +++ b/docs/PKCE.md @@ -28,7 +28,7 @@ print PKCE.to_json() # convert the object into a dict pkce_dict = pkce_instance.to_dict() # create an instance of PKCE from a dict -pkce_form_dict = pkce.from_dict(pkce_dict) +pkce_from_dict = PKCE.from_dict(pkce_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/Person.md b/docs/Person.md index 97760ae..edfed54 100644 --- a/docs/Person.md +++ b/docs/Person.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **annotations** | [**FlattenedAnnotations**](FlattenedAnnotations.md) | | [optional] **score** | [**Score**](Score.md) | | [optional] **summaries** | [**FlattenedWorkstreamSummaries**](FlattenedWorkstreamSummaries.md) | | [optional] +**anchors** | [**FlattenedAnchors**](FlattenedAnchors.md) | | [optional] ## Example @@ -37,7 +38,7 @@ print Person.to_json() # convert the object into a dict person_dict = person_instance.to_dict() # create an instance of Person from a dict -person_form_dict = person.from_dict(person_dict) +person_from_dict = Person.from_dict(person_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/PersonAccess.md b/docs/PersonAccess.md index 6761459..b0e827a 100644 --- a/docs/PersonAccess.md +++ b/docs/PersonAccess.md @@ -24,7 +24,7 @@ print PersonAccess.to_json() # convert the object into a dict person_access_dict = person_access_instance.to_dict() # create an instance of PersonAccess from a dict -person_access_form_dict = person_access.from_dict(person_access_dict) +person_access_from_dict = PersonAccess.from_dict(person_access_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/PersonApi.md b/docs/PersonApi.md index 8af7e78..4782c79 100644 --- a/docs/PersonApi.md +++ b/docs/PersonApi.md @@ -4,10 +4,12 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**person_associate_anchor**](PersonApi.md#person_associate_anchor) | **POST** /person/{person}/anchors/associate/{anchor} | /person/{person}/anchors/associate/{anchor} [POST] [**person_associate_asset**](PersonApi.md#person_associate_asset) | **POST** /person/{person}/assets/associate/{asset} | /person/{person}/assets/associate/{asset} [POST] [**person_associate_tag**](PersonApi.md#person_associate_tag) | **POST** /person/{person}/tags/associate/{tag} | /person/{person}/tags/associate/{tag} [POST] [**person_associate_website**](PersonApi.md#person_associate_website) | **POST** /person/{person}/websites/associate/{website} | /person/{person}/websites/associate/{website} [POST] [**person_associate_workstream_summary**](PersonApi.md#person_associate_workstream_summary) | **POST** /person/{person}/workstream_summaries/associate/{workstream_summary} | /person/{person}/workstream_summaries/associate/{workstream_summary} [POST] +[**person_disassociate_anchor**](PersonApi.md#person_disassociate_anchor) | **POST** /person/{person}/anchors/disassociate/{anchor} | /person/{person}/anchors/disassociate/{anchor} [POST] [**person_disassociate_asset**](PersonApi.md#person_disassociate_asset) | **POST** /person/{person}/assets/disassociate/{asset} | /person/{person}/assets/disassociate/{asset} [POST] [**person_disassociate_tag**](PersonApi.md#person_disassociate_tag) | **POST** /person/{person}/tags/disassociate/{tag} | /person/{person}/tags/disassociate/{tag} [POST] [**person_disassociate_website**](PersonApi.md#person_disassociate_website) | **POST** /person/{person}/websites/disassociate/{website} | /person/{person}/websites/disassociate/{website} [POST] @@ -17,6 +19,73 @@ Method | HTTP request | Description [**update_person**](PersonApi.md#update_person) | **POST** /person/update | /person/update [POST] +# **person_associate_anchor** +> person_associate_anchor(person, anchor) + +/person/{person}/anchors/associate/{anchor} [POST] + +associates a person and an anchor. It performs the same action as the anchor 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.PersonApi(api_client) + person = 'person_example' # str | This is a uuid that represents a person. + anchor = 'anchor_example' # str | This is the specific uuid of an anchor. + + try: + # /person/{person}/anchors/associate/{anchor} [POST] + api_instance.person_associate_anchor(person, anchor) + except Exception as e: + print("Exception when calling PersonApi->person_associate_anchor: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **person** | **str**| This is a uuid that represents a person. | + **anchor** | **str**| This is the specific uuid of an anchor. | + +### 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) + # **person_associate_asset** > person_associate_asset(person, asset) @@ -285,6 +354,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) +# **person_disassociate_anchor** +> person_disassociate_anchor(person, anchor) + +/person/{person}/anchors/disassociate/{anchor} [POST] + +Disassociates a person from an achor. It performs the same action as the anchor 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.PersonApi(api_client) + person = 'person_example' # str | This is a uuid that represents a person. + anchor = 'anchor_example' # str | This is the specific uuid of an anchor. + + try: + # /person/{person}/anchors/disassociate/{anchor} [POST] + api_instance.person_disassociate_anchor(person, anchor) + except Exception as e: + print("Exception when calling PersonApi->person_disassociate_anchor: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **person** | **str**| This is a uuid that represents a person. | + **anchor** | **str**| This is the specific uuid of an anchor. | + +### 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) + # **person_disassociate_asset** > person_disassociate_asset(person, asset) diff --git a/docs/PersonBasicType.md b/docs/PersonBasicType.md index b055db3..2e06f4c 100644 --- a/docs/PersonBasicType.md +++ b/docs/PersonBasicType.md @@ -29,7 +29,7 @@ print PersonBasicType.to_json() # convert the object into a dict person_basic_type_dict = person_basic_type_instance.to_dict() # create an instance of PersonBasicType from a dict -person_basic_type_form_dict = person_basic_type.from_dict(person_basic_type_dict) +person_basic_type_from_dict = PersonBasicType.from_dict(person_basic_type_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/PersonModel.md b/docs/PersonModel.md index cc441ec..fb93c42 100644 --- a/docs/PersonModel.md +++ b/docs/PersonModel.md @@ -25,7 +25,7 @@ print PersonModel.to_json() # convert the object into a dict person_model_dict = person_model_instance.to_dict() # create an instance of PersonModel from a dict -person_model_form_dict = person_model.from_dict(person_model_dict) +person_model_from_dict = PersonModel.from_dict(person_model_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/PersonType.md b/docs/PersonType.md index 95cb5c7..278b6fa 100644 --- a/docs/PersonType.md +++ b/docs/PersonType.md @@ -24,7 +24,7 @@ print PersonType.to_json() # convert the object into a dict person_type_dict = person_type_instance.to_dict() # create an instance of PersonType from a dict -person_type_form_dict = person_type.from_dict(person_type_dict) +person_type_from_dict = PersonType.from_dict(person_type_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/Persons.md b/docs/Persons.md index 9a7b0cf..6f9c680 100644 --- a/docs/Persons.md +++ b/docs/Persons.md @@ -25,7 +25,7 @@ print Persons.to_json() # convert the object into a dict persons_dict = persons_instance.to_dict() # create an instance of Persons from a dict -persons_form_dict = persons.from_dict(persons_dict) +persons_from_dict = Persons.from_dict(persons_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/PersonsApi.md b/docs/PersonsApi.md index 70af797..bd0cec5 100644 --- a/docs/PersonsApi.md +++ b/docs/PersonsApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**persons_create_new_person**](PersonsApi.md#persons_create_new_person) | **POST** /persons/create | /persons/create [POST] [**persons_delete_person**](PersonsApi.md#persons_delete_person) | **POST** /persons/{person}/delete | /persons/{person}/delete [POST] -[**persons_disassociate_asset**](PersonsApi.md#persons_disassociate_asset) | **POST** /persons/{person}/assets/delete/{asset} | /persons/{person}/assets/delete/{asset} [POST] [**persons_snapshot**](PersonsApi.md#persons_snapshot) | **GET** /persons | /persons [GET] +[**search_persons**](PersonsApi.md#search_persons) | **POST** /persons/search | /persons/search [POST] # **persons_create_new_person** @@ -146,12 +146,12 @@ 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) -# **persons_disassociate_asset** -> persons_disassociate_asset(person, asset) +# **persons_snapshot** +> Persons persons_snapshot(transferables=transferables) -/persons/{person}/assets/delete/{asset} [POST] +/persons [GET] -This will update both the asset and the person reference, that will remove a person from an asset(only the references). This will NOT remove the person. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will want to deprecate this at some point, please use the PersonAPI +This will get a snapshot of all of your people ### Example @@ -159,6 +159,7 @@ This will update both the asset and the person reference, that will remove a per import time import os import pieces_os_client +from pieces_os_client.models.persons import Persons from pieces_os_client.rest import ApiException from pprint import pprint @@ -173,14 +174,15 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.PersonsApi(api_client) - person = 'person_example' # str | This is a uuid that represents a person. - asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access. + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) try: - # /persons/{person}/assets/delete/{asset} [POST] - api_instance.persons_disassociate_asset(person, asset) + # /persons [GET] + api_response = api_instance.persons_snapshot(transferables=transferables) + print("The response of PersonsApi->persons_snapshot:\n") + pprint(api_response) except Exception as e: - print("Exception when calling PersonsApi->persons_disassociate_asset: %s\n" % e) + print("Exception when calling PersonsApi->persons_snapshot: %s\n" % e) ``` @@ -189,12 +191,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **person** | **str**| This is a uuid that represents a person. | - **asset** | **str**| The id (uuid) of the asset that you are trying to access. | + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] ### Return type -void (empty response body) +[**Persons**](Persons.md) ### Authorization @@ -203,22 +204,22 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain + - **Accept**: application/json, text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**200** | OK | - | **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) -# **persons_snapshot** -> Persons persons_snapshot(transferables=transferables) +# **search_persons** +> SearchedPersons search_persons(transferables=transferables, search_input=search_input) -/persons [GET] +/persons/search [POST] -This will get a snapshot of all of your people +This will search your persons for a specific person note: we will search, name, email, and username ### Example @@ -226,7 +227,8 @@ This will get a snapshot of all of your people import time import os import pieces_os_client -from pieces_os_client.models.persons import Persons +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_persons import SearchedPersons from pieces_os_client.rest import ApiException from pprint import pprint @@ -242,14 +244,15 @@ with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.PersonsApi(api_client) transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) try: - # /persons [GET] - api_response = api_instance.persons_snapshot(transferables=transferables) - print("The response of PersonsApi->persons_snapshot:\n") + # /persons/search [POST] + api_response = api_instance.search_persons(transferables=transferables, search_input=search_input) + print("The response of PersonsApi->search_persons:\n") pprint(api_response) except Exception as e: - print("Exception when calling PersonsApi->persons_snapshot: %s\n" % e) + print("Exception when calling PersonsApi->search_persons: %s\n" % e) ``` @@ -259,10 +262,11 @@ with pieces_os_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] ### Return type -[**Persons**](Persons.md) +[**SearchedPersons**](SearchedPersons.md) ### Authorization @@ -270,7 +274,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json, text/plain ### HTTP response details diff --git a/docs/PrecreatedExternalProviderApiKey.md b/docs/PrecreatedExternalProviderApiKey.md index 0bcd081..cb34d21 100644 --- a/docs/PrecreatedExternalProviderApiKey.md +++ b/docs/PrecreatedExternalProviderApiKey.md @@ -24,7 +24,7 @@ print PrecreatedExternalProviderApiKey.to_json() # convert the object into a dict precreated_external_provider_api_key_dict = precreated_external_provider_api_key_instance.to_dict() # create an instance of PrecreatedExternalProviderApiKey from a dict -precreated_external_provider_api_key_form_dict = precreated_external_provider_api_key.from_dict(precreated_external_provider_api_key_dict) +precreated_external_provider_api_key_from_dict = PrecreatedExternalProviderApiKey.from_dict(precreated_external_provider_api_key_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/PredeletedExternalProviderApiKey.md b/docs/PredeletedExternalProviderApiKey.md index a44ce98..d2aa171 100644 --- a/docs/PredeletedExternalProviderApiKey.md +++ b/docs/PredeletedExternalProviderApiKey.md @@ -24,7 +24,7 @@ print PredeletedExternalProviderApiKey.to_json() # convert the object into a dict predeleted_external_provider_api_key_dict = predeleted_external_provider_api_key_instance.to_dict() # create an instance of PredeletedExternalProviderApiKey from a dict -predeleted_external_provider_api_key_form_dict = predeleted_external_provider_api_key.from_dict(predeleted_external_provider_api_key_dict) +predeleted_external_provider_api_key_from_dict = PredeletedExternalProviderApiKey.from_dict(predeleted_external_provider_api_key_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/PreonboardedPersonaDetails.md b/docs/PreonboardedPersonaDetails.md index f2ed570..feab5b8 100644 --- a/docs/PreonboardedPersonaDetails.md +++ b/docs/PreonboardedPersonaDetails.md @@ -24,7 +24,7 @@ print PreonboardedPersonaDetails.to_json() # convert the object into a dict preonboarded_persona_details_dict = preonboarded_persona_details_instance.to_dict() # create an instance of PreonboardedPersonaDetails from a dict -preonboarded_persona_details_form_dict = preonboarded_persona_details.from_dict(preonboarded_persona_details_dict) +preonboarded_persona_details_from_dict = PreonboardedPersonaDetails.from_dict(preonboarded_persona_details_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/PreupdatedExternalProviderApiKey.md b/docs/PreupdatedExternalProviderApiKey.md index c932274..91bda61 100644 --- a/docs/PreupdatedExternalProviderApiKey.md +++ b/docs/PreupdatedExternalProviderApiKey.md @@ -24,7 +24,7 @@ print PreupdatedExternalProviderApiKey.to_json() # convert the object into a dict preupdated_external_provider_api_key_dict = preupdated_external_provider_api_key_instance.to_dict() # create an instance of PreupdatedExternalProviderApiKey from a dict -preupdated_external_provider_api_key_form_dict = preupdated_external_provider_api_key.from_dict(preupdated_external_provider_api_key_dict) +preupdated_external_provider_api_key_from_dict = PreupdatedExternalProviderApiKey.from_dict(preupdated_external_provider_api_key_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/Preview.md b/docs/Preview.md index 8b5fcb8..6fb272e 100644 --- a/docs/Preview.md +++ b/docs/Preview.md @@ -24,7 +24,7 @@ print Preview.to_json() # convert the object into a dict preview_dict = preview_instance.to_dict() # create an instance of Preview from a dict -preview_form_dict = preview.from_dict(preview_dict) +preview_from_dict = Preview.from_dict(preview_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/ProjectModule.md b/docs/ProjectModule.md index 1116466..3d3aa78 100644 --- a/docs/ProjectModule.md +++ b/docs/ProjectModule.md @@ -26,7 +26,7 @@ print ProjectModule.to_json() # convert the object into a dict project_module_dict = project_module_instance.to_dict() # create an instance of ProjectModule from a dict -project_module_form_dict = project_module.from_dict(project_module_dict) +project_module_from_dict = ProjectModule.from_dict(project_module_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/ProjectModules.md b/docs/ProjectModules.md index b65c037..0c1164b 100644 --- a/docs/ProjectModules.md +++ b/docs/ProjectModules.md @@ -23,7 +23,7 @@ print ProjectModules.to_json() # convert the object into a dict project_modules_dict = project_modules_instance.to_dict() # create an instance of ProjectModules from a dict -project_modules_form_dict = project_modules.from_dict(project_modules_dict) +project_modules_from_dict = ProjectModules.from_dict(project_modules_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/PseudoAssets.md b/docs/PseudoAssets.md index f2f1285..5aad593 100644 --- a/docs/PseudoAssets.md +++ b/docs/PseudoAssets.md @@ -23,7 +23,7 @@ print PseudoAssets.to_json() # convert the object into a dict pseudo_assets_dict = pseudo_assets_instance.to_dict() # create an instance of PseudoAssets from a dict -pseudo_assets_form_dict = pseudo_assets.from_dict(pseudo_assets_dict) +pseudo_assets_from_dict = PseudoAssets.from_dict(pseudo_assets_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/QGPTAgentRelatedRoutes.md b/docs/QGPTAgentRelatedRoutes.md index 07d439f..ba57982 100644 --- a/docs/QGPTAgentRelatedRoutes.md +++ b/docs/QGPTAgentRelatedRoutes.md @@ -23,7 +23,7 @@ print QGPTAgentRelatedRoutes.to_json() # convert the object into a dict qgpt_agent_related_routes_dict = qgpt_agent_related_routes_instance.to_dict() # create an instance of QGPTAgentRelatedRoutes from a dict -qgpt_agent_related_routes_form_dict = qgpt_agent_related_routes.from_dict(qgpt_agent_related_routes_dict) +qgpt_agent_related_routes_from_dict = QGPTAgentRelatedRoutes.from_dict(qgpt_agent_related_routes_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/QGPTAgentRoutes.md b/docs/QGPTAgentRoutes.md index 69e469b..2659bb5 100644 --- a/docs/QGPTAgentRoutes.md +++ b/docs/QGPTAgentRoutes.md @@ -23,7 +23,7 @@ print QGPTAgentRoutes.to_json() # convert the object into a dict qgpt_agent_routes_dict = qgpt_agent_routes_instance.to_dict() # create an instance of QGPTAgentRoutes from a dict -qgpt_agent_routes_form_dict = qgpt_agent_routes.from_dict(qgpt_agent_routes_dict) +qgpt_agent_routes_from_dict = QGPTAgentRoutes.from_dict(qgpt_agent_routes_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/QGPTConversation.md b/docs/QGPTConversation.md index 93bfb36..7ea5f9e 100644 --- a/docs/QGPTConversation.md +++ b/docs/QGPTConversation.md @@ -22,7 +22,7 @@ print QGPTConversation.to_json() # convert the object into a dict qgpt_conversation_dict = qgpt_conversation_instance.to_dict() # create an instance of QGPTConversation from a dict -qgpt_conversation_form_dict = qgpt_conversation.from_dict(qgpt_conversation_dict) +qgpt_conversation_from_dict = QGPTConversation.from_dict(qgpt_conversation_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/QGPTConversationMessage.md b/docs/QGPTConversationMessage.md index 2367bb1..31493f3 100644 --- a/docs/QGPTConversationMessage.md +++ b/docs/QGPTConversationMessage.md @@ -25,7 +25,7 @@ print QGPTConversationMessage.to_json() # convert the object into a dict qgpt_conversation_message_dict = qgpt_conversation_message_instance.to_dict() # create an instance of QGPTConversationMessage from a dict -qgpt_conversation_message_form_dict = qgpt_conversation_message.from_dict(qgpt_conversation_message_dict) +qgpt_conversation_message_from_dict = QGPTConversationMessage.from_dict(qgpt_conversation_message_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/QGPTConversationPipeline.md b/docs/QGPTConversationPipeline.md index eae8e0b..1af0818 100644 --- a/docs/QGPTConversationPipeline.md +++ b/docs/QGPTConversationPipeline.md @@ -26,7 +26,7 @@ print QGPTConversationPipeline.to_json() # convert the object into a dict qgpt_conversation_pipeline_dict = qgpt_conversation_pipeline_instance.to_dict() # create an instance of QGPTConversationPipeline from a dict -qgpt_conversation_pipeline_form_dict = qgpt_conversation_pipeline.from_dict(qgpt_conversation_pipeline_dict) +qgpt_conversation_pipeline_from_dict = QGPTConversationPipeline.from_dict(qgpt_conversation_pipeline_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/QGPTConversationPipelineForContextualizedCodeDialog.md b/docs/QGPTConversationPipelineForContextualizedCodeDialog.md index 1700442..e386854 100644 --- a/docs/QGPTConversationPipelineForContextualizedCodeDialog.md +++ b/docs/QGPTConversationPipelineForContextualizedCodeDialog.md @@ -22,7 +22,7 @@ print QGPTConversationPipelineForContextualizedCodeDialog.to_json() # convert the object into a dict qgpt_conversation_pipeline_for_contextualized_code_dialog_dict = qgpt_conversation_pipeline_for_contextualized_code_dialog_instance.to_dict() # create an instance of QGPTConversationPipelineForContextualizedCodeDialog from a dict -qgpt_conversation_pipeline_for_contextualized_code_dialog_form_dict = qgpt_conversation_pipeline_for_contextualized_code_dialog.from_dict(qgpt_conversation_pipeline_for_contextualized_code_dialog_dict) +qgpt_conversation_pipeline_for_contextualized_code_dialog_from_dict = QGPTConversationPipelineForContextualizedCodeDialog.from_dict(qgpt_conversation_pipeline_for_contextualized_code_dialog_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/QGPTConversationPipelineForContextualizedCodeGeneration.md b/docs/QGPTConversationPipelineForContextualizedCodeGeneration.md index f6e8763..183769a 100644 --- a/docs/QGPTConversationPipelineForContextualizedCodeGeneration.md +++ b/docs/QGPTConversationPipelineForContextualizedCodeGeneration.md @@ -22,7 +22,7 @@ print QGPTConversationPipelineForContextualizedCodeGeneration.to_json() # convert the object into a dict qgpt_conversation_pipeline_for_contextualized_code_generation_dict = qgpt_conversation_pipeline_for_contextualized_code_generation_instance.to_dict() # create an instance of QGPTConversationPipelineForContextualizedCodeGeneration from a dict -qgpt_conversation_pipeline_for_contextualized_code_generation_form_dict = qgpt_conversation_pipeline_for_contextualized_code_generation.from_dict(qgpt_conversation_pipeline_for_contextualized_code_generation_dict) +qgpt_conversation_pipeline_for_contextualized_code_generation_from_dict = QGPTConversationPipelineForContextualizedCodeGeneration.from_dict(qgpt_conversation_pipeline_for_contextualized_code_generation_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/QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.md b/docs/QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.md index 857ff3c..17549f4 100644 --- a/docs/QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.md +++ b/docs/QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.md @@ -22,7 +22,7 @@ print QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.to_json() # convert the object into a dict qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_dict = qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_instance.to_dict() # create an instance of QGPTConversationPipelineForContextualizedCodeWorkstreamDialog from a dict -qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_form_dict = qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog.from_dict(qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_dict) +qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_from_dict = QGPTConversationPipelineForContextualizedCodeWorkstreamDialog.from_dict(qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog_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/QGPTConversationPipelineForGeneralizedCodeDialog.md b/docs/QGPTConversationPipelineForGeneralizedCodeDialog.md index 4a9f5de..db23bbd 100644 --- a/docs/QGPTConversationPipelineForGeneralizedCodeDialog.md +++ b/docs/QGPTConversationPipelineForGeneralizedCodeDialog.md @@ -22,7 +22,7 @@ print QGPTConversationPipelineForGeneralizedCodeDialog.to_json() # convert the object into a dict qgpt_conversation_pipeline_for_generalized_code_dialog_dict = qgpt_conversation_pipeline_for_generalized_code_dialog_instance.to_dict() # create an instance of QGPTConversationPipelineForGeneralizedCodeDialog from a dict -qgpt_conversation_pipeline_for_generalized_code_dialog_form_dict = qgpt_conversation_pipeline_for_generalized_code_dialog.from_dict(qgpt_conversation_pipeline_for_generalized_code_dialog_dict) +qgpt_conversation_pipeline_for_generalized_code_dialog_from_dict = QGPTConversationPipelineForGeneralizedCodeDialog.from_dict(qgpt_conversation_pipeline_for_generalized_code_dialog_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/QGPTHintsInput.md b/docs/QGPTHintsInput.md index 5d4ced5..f971616 100644 --- a/docs/QGPTHintsInput.md +++ b/docs/QGPTHintsInput.md @@ -26,7 +26,7 @@ print QGPTHintsInput.to_json() # convert the object into a dict qgpt_hints_input_dict = qgpt_hints_input_instance.to_dict() # create an instance of QGPTHintsInput from a dict -qgpt_hints_input_form_dict = qgpt_hints_input.from_dict(qgpt_hints_input_dict) +qgpt_hints_input_from_dict = QGPTHintsInput.from_dict(qgpt_hints_input_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/QGPTPersonsRelatedInput.md b/docs/QGPTPersonsRelatedInput.md index 526fdd5..e37489d 100644 --- a/docs/QGPTPersonsRelatedInput.md +++ b/docs/QGPTPersonsRelatedInput.md @@ -26,7 +26,7 @@ print QGPTPersonsRelatedInput.to_json() # convert the object into a dict qgpt_persons_related_input_dict = qgpt_persons_related_input_instance.to_dict() # create an instance of QGPTPersonsRelatedInput from a dict -qgpt_persons_related_input_form_dict = qgpt_persons_related_input.from_dict(qgpt_persons_related_input_dict) +qgpt_persons_related_input_from_dict = QGPTPersonsRelatedInput.from_dict(qgpt_persons_related_input_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/QGPTPersonsRelatedOutput.md b/docs/QGPTPersonsRelatedOutput.md index 9cc609b..19c2ede 100644 --- a/docs/QGPTPersonsRelatedOutput.md +++ b/docs/QGPTPersonsRelatedOutput.md @@ -24,7 +24,7 @@ print QGPTPersonsRelatedOutput.to_json() # convert the object into a dict qgpt_persons_related_output_dict = qgpt_persons_related_output_instance.to_dict() # create an instance of QGPTPersonsRelatedOutput from a dict -qgpt_persons_related_output_form_dict = qgpt_persons_related_output.from_dict(qgpt_persons_related_output_dict) +qgpt_persons_related_output_from_dict = QGPTPersonsRelatedOutput.from_dict(qgpt_persons_related_output_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/QGPTPromptPipeline.md b/docs/QGPTPromptPipeline.md index 34a46fd..210c1e1 100644 --- a/docs/QGPTPromptPipeline.md +++ b/docs/QGPTPromptPipeline.md @@ -24,7 +24,7 @@ print QGPTPromptPipeline.to_json() # convert the object into a dict qgpt_prompt_pipeline_dict = qgpt_prompt_pipeline_instance.to_dict() # create an instance of QGPTPromptPipeline from a dict -qgpt_prompt_pipeline_form_dict = qgpt_prompt_pipeline.from_dict(qgpt_prompt_pipeline_dict) +qgpt_prompt_pipeline_from_dict = QGPTPromptPipeline.from_dict(qgpt_prompt_pipeline_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/QGPTQuestionAnswer.md b/docs/QGPTQuestionAnswer.md index 979f24f..87514a9 100644 --- a/docs/QGPTQuestionAnswer.md +++ b/docs/QGPTQuestionAnswer.md @@ -24,7 +24,7 @@ print QGPTQuestionAnswer.to_json() # convert the object into a dict qgpt_question_answer_dict = qgpt_question_answer_instance.to_dict() # create an instance of QGPTQuestionAnswer from a dict -qgpt_question_answer_form_dict = qgpt_question_answer.from_dict(qgpt_question_answer_dict) +qgpt_question_answer_from_dict = QGPTQuestionAnswer.from_dict(qgpt_question_answer_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/QGPTQuestionAnswers.md b/docs/QGPTQuestionAnswers.md index 69016d3..72538b3 100644 --- a/docs/QGPTQuestionAnswers.md +++ b/docs/QGPTQuestionAnswers.md @@ -23,7 +23,7 @@ print QGPTQuestionAnswers.to_json() # convert the object into a dict qgpt_question_answers_dict = qgpt_question_answers_instance.to_dict() # create an instance of QGPTQuestionAnswers from a dict -qgpt_question_answers_form_dict = qgpt_question_answers.from_dict(qgpt_question_answers_dict) +qgpt_question_answers_from_dict = QGPTQuestionAnswers.from_dict(qgpt_question_answers_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/QGPTQuestionInput.md b/docs/QGPTQuestionInput.md index b723751..3d407b3 100644 --- a/docs/QGPTQuestionInput.md +++ b/docs/QGPTQuestionInput.md @@ -29,7 +29,7 @@ print QGPTQuestionInput.to_json() # convert the object into a dict qgpt_question_input_dict = qgpt_question_input_instance.to_dict() # create an instance of QGPTQuestionInput from a dict -qgpt_question_input_form_dict = qgpt_question_input.from_dict(qgpt_question_input_dict) +qgpt_question_input_from_dict = QGPTQuestionInput.from_dict(qgpt_question_input_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/QGPTQuestionOutput.md b/docs/QGPTQuestionOutput.md index 2e12fde..fe2556b 100644 --- a/docs/QGPTQuestionOutput.md +++ b/docs/QGPTQuestionOutput.md @@ -23,7 +23,7 @@ print QGPTQuestionOutput.to_json() # convert the object into a dict qgpt_question_output_dict = qgpt_question_output_instance.to_dict() # create an instance of QGPTQuestionOutput from a dict -qgpt_question_output_form_dict = qgpt_question_output.from_dict(qgpt_question_output_dict) +qgpt_question_output_from_dict = QGPTQuestionOutput.from_dict(qgpt_question_output_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/QGPTRelevanceInput.md b/docs/QGPTRelevanceInput.md index fdd2333..917bbeb 100644 --- a/docs/QGPTRelevanceInput.md +++ b/docs/QGPTRelevanceInput.md @@ -31,7 +31,7 @@ print QGPTRelevanceInput.to_json() # convert the object into a dict qgpt_relevance_input_dict = qgpt_relevance_input_instance.to_dict() # create an instance of QGPTRelevanceInput from a dict -qgpt_relevance_input_form_dict = qgpt_relevance_input.from_dict(qgpt_relevance_input_dict) +qgpt_relevance_input_from_dict = QGPTRelevanceInput.from_dict(qgpt_relevance_input_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/QGPTRelevanceInputOptions.md b/docs/QGPTRelevanceInputOptions.md index 3efbc4d..0a2b93c 100644 --- a/docs/QGPTRelevanceInputOptions.md +++ b/docs/QGPTRelevanceInputOptions.md @@ -24,7 +24,7 @@ print QGPTRelevanceInputOptions.to_json() # convert the object into a dict qgpt_relevance_input_options_dict = qgpt_relevance_input_options_instance.to_dict() # create an instance of QGPTRelevanceInputOptions from a dict -qgpt_relevance_input_options_form_dict = qgpt_relevance_input_options.from_dict(qgpt_relevance_input_options_dict) +qgpt_relevance_input_options_from_dict = QGPTRelevanceInputOptions.from_dict(qgpt_relevance_input_options_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/QGPTRelevanceOutput.md b/docs/QGPTRelevanceOutput.md index 9b4de74..3474b66 100644 --- a/docs/QGPTRelevanceOutput.md +++ b/docs/QGPTRelevanceOutput.md @@ -24,7 +24,7 @@ print QGPTRelevanceOutput.to_json() # convert the object into a dict qgpt_relevance_output_dict = qgpt_relevance_output_instance.to_dict() # create an instance of QGPTRelevanceOutput from a dict -qgpt_relevance_output_form_dict = qgpt_relevance_output.from_dict(qgpt_relevance_output_dict) +qgpt_relevance_output_from_dict = QGPTRelevanceOutput.from_dict(qgpt_relevance_output_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/QGPTRepromptInput.md b/docs/QGPTRepromptInput.md index c3eab6d..ce3aef9 100644 --- a/docs/QGPTRepromptInput.md +++ b/docs/QGPTRepromptInput.md @@ -27,7 +27,7 @@ print QGPTRepromptInput.to_json() # convert the object into a dict qgpt_reprompt_input_dict = qgpt_reprompt_input_instance.to_dict() # create an instance of QGPTRepromptInput from a dict -qgpt_reprompt_input_form_dict = qgpt_reprompt_input.from_dict(qgpt_reprompt_input_dict) +qgpt_reprompt_input_from_dict = QGPTRepromptInput.from_dict(qgpt_reprompt_input_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/QGPTRepromptOutput.md b/docs/QGPTRepromptOutput.md index 2c650b8..c664f68 100644 --- a/docs/QGPTRepromptOutput.md +++ b/docs/QGPTRepromptOutput.md @@ -22,7 +22,7 @@ print QGPTRepromptOutput.to_json() # convert the object into a dict qgpt_reprompt_output_dict = qgpt_reprompt_output_instance.to_dict() # create an instance of QGPTRepromptOutput from a dict -qgpt_reprompt_output_form_dict = qgpt_reprompt_output.from_dict(qgpt_reprompt_output_dict) +qgpt_reprompt_output_from_dict = QGPTRepromptOutput.from_dict(qgpt_reprompt_output_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/QGPTStreamInput.md b/docs/QGPTStreamInput.md index f1581db..8ac6954 100644 --- a/docs/QGPTStreamInput.md +++ b/docs/QGPTStreamInput.md @@ -28,7 +28,7 @@ print QGPTStreamInput.to_json() # convert the object into a dict qgpt_stream_input_dict = qgpt_stream_input_instance.to_dict() # create an instance of QGPTStreamInput from a dict -qgpt_stream_input_form_dict = qgpt_stream_input.from_dict(qgpt_stream_input_dict) +qgpt_stream_input_from_dict = QGPTStreamInput.from_dict(qgpt_stream_input_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/QGPTStreamOutput.md b/docs/QGPTStreamOutput.md index 19ab722..4726c3a 100644 --- a/docs/QGPTStreamOutput.md +++ b/docs/QGPTStreamOutput.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **status_code** | **float** | This will be provided | [optional] **error_message** | **str** | optional error message is the status code is NOT 200 | [optional] **agent_routes** | [**QGPTAgentRoutes**](QGPTAgentRoutes.md) | | [optional] +**extracted** | [**QGPTStreamedOutputExtractedMaterials**](QGPTStreamedOutputExtractedMaterials.md) | | [optional] ## Example @@ -29,7 +30,7 @@ print QGPTStreamOutput.to_json() # convert the object into a dict qgpt_stream_output_dict = qgpt_stream_output_instance.to_dict() # create an instance of QGPTStreamOutput from a dict -qgpt_stream_output_form_dict = qgpt_stream_output.from_dict(qgpt_stream_output_dict) +qgpt_stream_output_from_dict = QGPTStreamOutput.from_dict(qgpt_stream_output_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/QGPTStreamedOutputExtractedMaterials.md b/docs/QGPTStreamedOutputExtractedMaterials.md new file mode 100644 index 0000000..e043532 --- /dev/null +++ b/docs/QGPTStreamedOutputExtractedMaterials.md @@ -0,0 +1,30 @@ +# QGPTStreamedOutputExtractedMaterials + +This is used as an object that will return some of the extracted materials from both the message w/ compeleted/ or stopped as well as the context(if using WorkstreamContext) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**textual** | [**QGPTStreamedOutputExtractedTextualMaterials**](QGPTStreamedOutputExtractedTextualMaterials.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.qgpt_streamed_output_extracted_materials import QGPTStreamedOutputExtractedMaterials + +# TODO update the JSON string below +json = "{}" +# create an instance of QGPTStreamedOutputExtractedMaterials from a JSON string +qgpt_streamed_output_extracted_materials_instance = QGPTStreamedOutputExtractedMaterials.from_json(json) +# print the JSON string representation of the object +print QGPTStreamedOutputExtractedMaterials.to_json() + +# convert the object into a dict +qgpt_streamed_output_extracted_materials_dict = qgpt_streamed_output_extracted_materials_instance.to_dict() +# create an instance of QGPTStreamedOutputExtractedMaterials from a dict +qgpt_streamed_output_extracted_materials_from_dict = QGPTStreamedOutputExtractedMaterials.from_dict(qgpt_streamed_output_extracted_materials_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/QGPTStreamedOutputExtractedTextualMaterials.md b/docs/QGPTStreamedOutputExtractedTextualMaterials.md new file mode 100644 index 0000000..777a966 --- /dev/null +++ b/docs/QGPTStreamedOutputExtractedTextualMaterials.md @@ -0,0 +1,31 @@ +# QGPTStreamedOutputExtractedTextualMaterials + +This is all the textually extracted materials from the QGPT stream + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**message** | [**TextuallyExtractedMaterials**](TextuallyExtractedMaterials.md) | | [optional] +**workstream** | [**TextuallyExtractedMaterials**](TextuallyExtractedMaterials.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.qgpt_streamed_output_extracted_textual_materials import QGPTStreamedOutputExtractedTextualMaterials + +# TODO update the JSON string below +json = "{}" +# create an instance of QGPTStreamedOutputExtractedTextualMaterials from a JSON string +qgpt_streamed_output_extracted_textual_materials_instance = QGPTStreamedOutputExtractedTextualMaterials.from_json(json) +# print the JSON string representation of the object +print QGPTStreamedOutputExtractedTextualMaterials.to_json() + +# convert the object into a dict +qgpt_streamed_output_extracted_textual_materials_dict = qgpt_streamed_output_extracted_textual_materials_instance.to_dict() +# create an instance of QGPTStreamedOutputExtractedTextualMaterials from a dict +qgpt_streamed_output_extracted_textual_materials_from_dict = QGPTStreamedOutputExtractedTextualMaterials.from_dict(qgpt_streamed_output_extracted_textual_materials_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/QGPTTaskPipeline.md b/docs/QGPTTaskPipeline.md index 1348d0b..997b667 100644 --- a/docs/QGPTTaskPipeline.md +++ b/docs/QGPTTaskPipeline.md @@ -27,7 +27,7 @@ print QGPTTaskPipeline.to_json() # convert the object into a dict qgpt_task_pipeline_dict = qgpt_task_pipeline_instance.to_dict() # create an instance of QGPTTaskPipeline from a dict -qgpt_task_pipeline_form_dict = qgpt_task_pipeline.from_dict(qgpt_task_pipeline_dict) +qgpt_task_pipeline_from_dict = QGPTTaskPipeline.from_dict(qgpt_task_pipeline_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/QGPTTaskPipelineForCodeCommentation.md b/docs/QGPTTaskPipelineForCodeCommentation.md index 4088b93..639bc80 100644 --- a/docs/QGPTTaskPipelineForCodeCommentation.md +++ b/docs/QGPTTaskPipelineForCodeCommentation.md @@ -22,7 +22,7 @@ print QGPTTaskPipelineForCodeCommentation.to_json() # convert the object into a dict qgpt_task_pipeline_for_code_commentation_dict = qgpt_task_pipeline_for_code_commentation_instance.to_dict() # create an instance of QGPTTaskPipelineForCodeCommentation from a dict -qgpt_task_pipeline_for_code_commentation_form_dict = qgpt_task_pipeline_for_code_commentation.from_dict(qgpt_task_pipeline_for_code_commentation_dict) +qgpt_task_pipeline_for_code_commentation_from_dict = QGPTTaskPipelineForCodeCommentation.from_dict(qgpt_task_pipeline_for_code_commentation_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/QGPTTaskPipelineForCodeCompletion.md b/docs/QGPTTaskPipelineForCodeCompletion.md index 9a53150..081a526 100644 --- a/docs/QGPTTaskPipelineForCodeCompletion.md +++ b/docs/QGPTTaskPipelineForCodeCompletion.md @@ -23,7 +23,7 @@ print QGPTTaskPipelineForCodeCompletion.to_json() # convert the object into a dict qgpt_task_pipeline_for_code_completion_dict = qgpt_task_pipeline_for_code_completion_instance.to_dict() # create an instance of QGPTTaskPipelineForCodeCompletion from a dict -qgpt_task_pipeline_for_code_completion_form_dict = qgpt_task_pipeline_for_code_completion.from_dict(qgpt_task_pipeline_for_code_completion_dict) +qgpt_task_pipeline_for_code_completion_from_dict = QGPTTaskPipelineForCodeCompletion.from_dict(qgpt_task_pipeline_for_code_completion_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/QGPTTaskPipelineForCodeExplanation.md b/docs/QGPTTaskPipelineForCodeExplanation.md index ce5ab1d..2ebc29b 100644 --- a/docs/QGPTTaskPipelineForCodeExplanation.md +++ b/docs/QGPTTaskPipelineForCodeExplanation.md @@ -22,7 +22,7 @@ print QGPTTaskPipelineForCodeExplanation.to_json() # convert the object into a dict qgpt_task_pipeline_for_code_explanation_dict = qgpt_task_pipeline_for_code_explanation_instance.to_dict() # create an instance of QGPTTaskPipelineForCodeExplanation from a dict -qgpt_task_pipeline_for_code_explanation_form_dict = qgpt_task_pipeline_for_code_explanation.from_dict(qgpt_task_pipeline_for_code_explanation_dict) +qgpt_task_pipeline_for_code_explanation_from_dict = QGPTTaskPipelineForCodeExplanation.from_dict(qgpt_task_pipeline_for_code_explanation_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/QGPTTaskPipelineForCodeFix.md b/docs/QGPTTaskPipelineForCodeFix.md index a5a9a13..87b4f51 100644 --- a/docs/QGPTTaskPipelineForCodeFix.md +++ b/docs/QGPTTaskPipelineForCodeFix.md @@ -23,7 +23,7 @@ print QGPTTaskPipelineForCodeFix.to_json() # convert the object into a dict qgpt_task_pipeline_for_code_fix_dict = qgpt_task_pipeline_for_code_fix_instance.to_dict() # create an instance of QGPTTaskPipelineForCodeFix from a dict -qgpt_task_pipeline_for_code_fix_form_dict = qgpt_task_pipeline_for_code_fix.from_dict(qgpt_task_pipeline_for_code_fix_dict) +qgpt_task_pipeline_for_code_fix_from_dict = QGPTTaskPipelineForCodeFix.from_dict(qgpt_task_pipeline_for_code_fix_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/QGPTTaskPipelineForCodeModification.md b/docs/QGPTTaskPipelineForCodeModification.md index 7bdb181..9829fcc 100644 --- a/docs/QGPTTaskPipelineForCodeModification.md +++ b/docs/QGPTTaskPipelineForCodeModification.md @@ -23,7 +23,7 @@ print QGPTTaskPipelineForCodeModification.to_json() # convert the object into a dict qgpt_task_pipeline_for_code_modification_dict = qgpt_task_pipeline_for_code_modification_instance.to_dict() # create an instance of QGPTTaskPipelineForCodeModification from a dict -qgpt_task_pipeline_for_code_modification_form_dict = qgpt_task_pipeline_for_code_modification.from_dict(qgpt_task_pipeline_for_code_modification_dict) +qgpt_task_pipeline_for_code_modification_from_dict = QGPTTaskPipelineForCodeModification.from_dict(qgpt_task_pipeline_for_code_modification_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/Range.md b/docs/Range.md index bf79bb9..c85b210 100644 --- a/docs/Range.md +++ b/docs/Range.md @@ -31,7 +31,7 @@ print Range.to_json() # convert the object into a dict range_dict = range_instance.to_dict() # create an instance of Range from a dict -range_form_dict = range.from_dict(range_dict) +range_from_dict = Range.from_dict(range_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/Ranges.md b/docs/Ranges.md index 6139505..f8fafe7 100644 --- a/docs/Ranges.md +++ b/docs/Ranges.md @@ -26,7 +26,7 @@ print Ranges.to_json() # convert the object into a dict ranges_dict = ranges_instance.to_dict() # create an instance of Ranges from a dict -ranges_form_dict = ranges.from_dict(ranges_dict) +ranges_from_dict = Ranges.from_dict(ranges_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/Reaction.md b/docs/Reaction.md index c207ae5..b86b239 100644 --- a/docs/Reaction.md +++ b/docs/Reaction.md @@ -25,7 +25,7 @@ print Reaction.to_json() # convert the object into a dict reaction_dict = reaction_instance.to_dict() # create an instance of Reaction from a dict -reaction_form_dict = reaction.from_dict(reaction_dict) +reaction_from_dict = Reaction.from_dict(reaction_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/Recipients.md b/docs/Recipients.md index bab60e6..b774ab9 100644 --- a/docs/Recipients.md +++ b/docs/Recipients.md @@ -23,7 +23,7 @@ print Recipients.to_json() # convert the object into a dict recipients_dict = recipients_instance.to_dict() # create an instance of Recipients from a dict -recipients_form_dict = recipients.from_dict(recipients_dict) +recipients_from_dict = Recipients.from_dict(recipients_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/ReferencedActivity.md b/docs/ReferencedActivity.md index e2b6292..42dc04d 100644 --- a/docs/ReferencedActivity.md +++ b/docs/ReferencedActivity.md @@ -23,7 +23,7 @@ print ReferencedActivity.to_json() # convert the object into a dict referenced_activity_dict = referenced_activity_instance.to_dict() # create an instance of ReferencedActivity from a dict -referenced_activity_form_dict = referenced_activity.from_dict(referenced_activity_dict) +referenced_activity_from_dict = ReferencedActivity.from_dict(referenced_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/ReferencedAnchor.md b/docs/ReferencedAnchor.md index d7c614d..c3018b2 100644 --- a/docs/ReferencedAnchor.md +++ b/docs/ReferencedAnchor.md @@ -24,7 +24,7 @@ print ReferencedAnchor.to_json() # convert the object into a dict referenced_anchor_dict = referenced_anchor_instance.to_dict() # create an instance of ReferencedAnchor from a dict -referenced_anchor_form_dict = referenced_anchor.from_dict(referenced_anchor_dict) +referenced_anchor_from_dict = ReferencedAnchor.from_dict(referenced_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/ReferencedAnchorPoint.md b/docs/ReferencedAnchorPoint.md index 91e470d..897538d 100644 --- a/docs/ReferencedAnchorPoint.md +++ b/docs/ReferencedAnchorPoint.md @@ -23,7 +23,7 @@ print ReferencedAnchorPoint.to_json() # convert the object into a dict referenced_anchor_point_dict = referenced_anchor_point_instance.to_dict() # create an instance of ReferencedAnchorPoint from a dict -referenced_anchor_point_form_dict = referenced_anchor_point.from_dict(referenced_anchor_point_dict) +referenced_anchor_point_from_dict = ReferencedAnchorPoint.from_dict(referenced_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/ReferencedAnnotation.md b/docs/ReferencedAnnotation.md index 3c72427..2fc67ad 100644 --- a/docs/ReferencedAnnotation.md +++ b/docs/ReferencedAnnotation.md @@ -24,7 +24,7 @@ print ReferencedAnnotation.to_json() # convert the object into a dict referenced_annotation_dict = referenced_annotation_instance.to_dict() # create an instance of ReferencedAnnotation from a dict -referenced_annotation_form_dict = referenced_annotation.from_dict(referenced_annotation_dict) +referenced_annotation_from_dict = ReferencedAnnotation.from_dict(referenced_annotation_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/ReferencedAsset.md b/docs/ReferencedAsset.md index 955f24c..d066dd1 100644 --- a/docs/ReferencedAsset.md +++ b/docs/ReferencedAsset.md @@ -24,7 +24,7 @@ print ReferencedAsset.to_json() # convert the object into a dict referenced_asset_dict = referenced_asset_instance.to_dict() # create an instance of ReferencedAsset from a dict -referenced_asset_form_dict = referenced_asset.from_dict(referenced_asset_dict) +referenced_asset_from_dict = ReferencedAsset.from_dict(referenced_asset_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/ReferencedConversation.md b/docs/ReferencedConversation.md index 73eec63..e68160b 100644 --- a/docs/ReferencedConversation.md +++ b/docs/ReferencedConversation.md @@ -24,7 +24,7 @@ print ReferencedConversation.to_json() # convert the object into a dict referenced_conversation_dict = referenced_conversation_instance.to_dict() # create an instance of ReferencedConversation from a dict -referenced_conversation_form_dict = referenced_conversation.from_dict(referenced_conversation_dict) +referenced_conversation_from_dict = ReferencedConversation.from_dict(referenced_conversation_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/ReferencedConversationMessage.md b/docs/ReferencedConversationMessage.md index 27368ef..be157c5 100644 --- a/docs/ReferencedConversationMessage.md +++ b/docs/ReferencedConversationMessage.md @@ -24,7 +24,7 @@ print ReferencedConversationMessage.to_json() # convert the object into a dict referenced_conversation_message_dict = referenced_conversation_message_instance.to_dict() # create an instance of ReferencedConversationMessage from a dict -referenced_conversation_message_form_dict = referenced_conversation_message.from_dict(referenced_conversation_message_dict) +referenced_conversation_message_from_dict = ReferencedConversationMessage.from_dict(referenced_conversation_message_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/ReferencedDistribution.md b/docs/ReferencedDistribution.md index 8dc3510..d8e3ef5 100644 --- a/docs/ReferencedDistribution.md +++ b/docs/ReferencedDistribution.md @@ -24,7 +24,7 @@ print ReferencedDistribution.to_json() # convert the object into a dict referenced_distribution_dict = referenced_distribution_instance.to_dict() # create an instance of ReferencedDistribution from a dict -referenced_distribution_form_dict = referenced_distribution.from_dict(referenced_distribution_dict) +referenced_distribution_from_dict = ReferencedDistribution.from_dict(referenced_distribution_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/ReferencedFormat.md b/docs/ReferencedFormat.md index 848af7c..059d810 100644 --- a/docs/ReferencedFormat.md +++ b/docs/ReferencedFormat.md @@ -24,7 +24,7 @@ print ReferencedFormat.to_json() # convert the object into a dict referenced_format_dict = referenced_format_instance.to_dict() # create an instance of ReferencedFormat from a dict -referenced_format_form_dict = referenced_format.from_dict(referenced_format_dict) +referenced_format_from_dict = ReferencedFormat.from_dict(referenced_format_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/ReferencedHint.md b/docs/ReferencedHint.md index 22deffd..e95cdb5 100644 --- a/docs/ReferencedHint.md +++ b/docs/ReferencedHint.md @@ -24,7 +24,7 @@ print ReferencedHint.to_json() # convert the object into a dict referenced_hint_dict = referenced_hint_instance.to_dict() # create an instance of ReferencedHint from a dict -referenced_hint_form_dict = referenced_hint.from_dict(referenced_hint_dict) +referenced_hint_from_dict = ReferencedHint.from_dict(referenced_hint_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/ReferencedModel.md b/docs/ReferencedModel.md index b3f52c9..a96191f 100644 --- a/docs/ReferencedModel.md +++ b/docs/ReferencedModel.md @@ -23,7 +23,7 @@ print ReferencedModel.to_json() # convert the object into a dict referenced_model_dict = referenced_model_instance.to_dict() # create an instance of ReferencedModel from a dict -referenced_model_form_dict = referenced_model.from_dict(referenced_model_dict) +referenced_model_from_dict = ReferencedModel.from_dict(referenced_model_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/ReferencedPerson.md b/docs/ReferencedPerson.md index f212c23..0d66c19 100644 --- a/docs/ReferencedPerson.md +++ b/docs/ReferencedPerson.md @@ -24,7 +24,7 @@ print ReferencedPerson.to_json() # convert the object into a dict referenced_person_dict = referenced_person_instance.to_dict() # create an instance of ReferencedPerson from a dict -referenced_person_form_dict = referenced_person.from_dict(referenced_person_dict) +referenced_person_from_dict = ReferencedPerson.from_dict(referenced_person_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/ReferencedRange.md b/docs/ReferencedRange.md index 311af44..8e8c4fe 100644 --- a/docs/ReferencedRange.md +++ b/docs/ReferencedRange.md @@ -24,7 +24,7 @@ print ReferencedRange.to_json() # convert the object into a dict referenced_range_dict = referenced_range_instance.to_dict() # create an instance of ReferencedRange from a dict -referenced_range_form_dict = referenced_range.from_dict(referenced_range_dict) +referenced_range_from_dict = ReferencedRange.from_dict(referenced_range_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/ReferencedSensitive.md b/docs/ReferencedSensitive.md index e94cdc6..96dc473 100644 --- a/docs/ReferencedSensitive.md +++ b/docs/ReferencedSensitive.md @@ -24,7 +24,7 @@ print ReferencedSensitive.to_json() # convert the object into a dict referenced_sensitive_dict = referenced_sensitive_instance.to_dict() # create an instance of ReferencedSensitive from a dict -referenced_sensitive_form_dict = referenced_sensitive.from_dict(referenced_sensitive_dict) +referenced_sensitive_from_dict = ReferencedSensitive.from_dict(referenced_sensitive_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/ReferencedShare.md b/docs/ReferencedShare.md index 1cc0896..42fddf5 100644 --- a/docs/ReferencedShare.md +++ b/docs/ReferencedShare.md @@ -24,7 +24,7 @@ print ReferencedShare.to_json() # convert the object into a dict referenced_share_dict = referenced_share_instance.to_dict() # create an instance of ReferencedShare from a dict -referenced_share_form_dict = referenced_share.from_dict(referenced_share_dict) +referenced_share_from_dict = ReferencedShare.from_dict(referenced_share_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/ReferencedTag.md b/docs/ReferencedTag.md index ad88c2e..d6109e8 100644 --- a/docs/ReferencedTag.md +++ b/docs/ReferencedTag.md @@ -24,7 +24,7 @@ print ReferencedTag.to_json() # convert the object into a dict referenced_tag_dict = referenced_tag_instance.to_dict() # create an instance of ReferencedTag from a dict -referenced_tag_form_dict = referenced_tag.from_dict(referenced_tag_dict) +referenced_tag_from_dict = ReferencedTag.from_dict(referenced_tag_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/ReferencedUser.md b/docs/ReferencedUser.md index 409910f..ffcf524 100644 --- a/docs/ReferencedUser.md +++ b/docs/ReferencedUser.md @@ -24,7 +24,7 @@ print ReferencedUser.to_json() # convert the object into a dict referenced_user_dict = referenced_user_instance.to_dict() # create an instance of ReferencedUser from a dict -referenced_user_form_dict = referenced_user.from_dict(referenced_user_dict) +referenced_user_from_dict = ReferencedUser.from_dict(referenced_user_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/ReferencedWebsite.md b/docs/ReferencedWebsite.md index 007b98e..3a218a0 100644 --- a/docs/ReferencedWebsite.md +++ b/docs/ReferencedWebsite.md @@ -23,7 +23,7 @@ print ReferencedWebsite.to_json() # convert the object into a dict referenced_website_dict = referenced_website_instance.to_dict() # create an instance of ReferencedWebsite from a dict -referenced_website_form_dict = referenced_website.from_dict(referenced_website_dict) +referenced_website_from_dict = ReferencedWebsite.from_dict(referenced_website_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/ReferencedWorkstreamEvent.md b/docs/ReferencedWorkstreamEvent.md index 6e080dc..e675f0e 100644 --- a/docs/ReferencedWorkstreamEvent.md +++ b/docs/ReferencedWorkstreamEvent.md @@ -24,7 +24,7 @@ print ReferencedWorkstreamEvent.to_json() # convert the object into a dict referenced_workstream_event_dict = referenced_workstream_event_instance.to_dict() # create an instance of ReferencedWorkstreamEvent from a dict -referenced_workstream_event_form_dict = referenced_workstream_event.from_dict(referenced_workstream_event_dict) +referenced_workstream_event_from_dict = ReferencedWorkstreamEvent.from_dict(referenced_workstream_event_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/ReferencedWorkstreamPatternEngineVisionEvent.md b/docs/ReferencedWorkstreamPatternEngineVisionEvent.md new file mode 100644 index 0000000..691de84 --- /dev/null +++ b/docs/ReferencedWorkstreamPatternEngineVisionEvent.md @@ -0,0 +1,31 @@ +# ReferencedWorkstreamPatternEngineVisionEvent + +This will return a specific event for the WPE. note: value is nullable here because we may want to pass in transferables:true/false + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**id** | **str** | | +**reference** | [**FlattenedWorkstreamPatternEngineVisionEvent**](FlattenedWorkstreamPatternEngineVisionEvent.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.referenced_workstream_pattern_engine_vision_event import ReferencedWorkstreamPatternEngineVisionEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of ReferencedWorkstreamPatternEngineVisionEvent from a JSON string +referenced_workstream_pattern_engine_vision_event_instance = ReferencedWorkstreamPatternEngineVisionEvent.from_json(json) +# print the JSON string representation of the object +print ReferencedWorkstreamPatternEngineVisionEvent.to_json() + +# convert the object into a dict +referenced_workstream_pattern_engine_vision_event_dict = referenced_workstream_pattern_engine_vision_event_instance.to_dict() +# create an instance of ReferencedWorkstreamPatternEngineVisionEvent from a dict +referenced_workstream_pattern_engine_vision_event_from_dict = ReferencedWorkstreamPatternEngineVisionEvent.from_dict(referenced_workstream_pattern_engine_vision_event_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/ReferencedWorkstreamSummary.md b/docs/ReferencedWorkstreamSummary.md index 725337d..9e89adf 100644 --- a/docs/ReferencedWorkstreamSummary.md +++ b/docs/ReferencedWorkstreamSummary.md @@ -24,7 +24,7 @@ print ReferencedWorkstreamSummary.to_json() # convert the object into a dict referenced_workstream_summary_dict = referenced_workstream_summary_instance.to_dict() # create an instance of ReferencedWorkstreamSummary from a dict -referenced_workstream_summary_form_dict = referenced_workstream_summary.from_dict(referenced_workstream_summary_dict) +referenced_workstream_summary_from_dict = ReferencedWorkstreamSummary.from_dict(referenced_workstream_summary_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/Relationship.md b/docs/Relationship.md index 1cff2ad..4fdbc21 100644 --- a/docs/Relationship.md +++ b/docs/Relationship.md @@ -28,7 +28,7 @@ print Relationship.to_json() # convert the object into a dict relationship_dict = relationship_instance.to_dict() # create an instance of Relationship from a dict -relationship_form_dict = relationship.from_dict(relationship_dict) +relationship_from_dict = Relationship.from_dict(relationship_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/Relationships.md b/docs/Relationships.md index 5ebd34c..a52cc7c 100644 --- a/docs/Relationships.md +++ b/docs/Relationships.md @@ -21,7 +21,7 @@ print Relationships.to_json() # convert the object into a dict relationships_dict = relationships_instance.to_dict() # create an instance of Relationships from a dict -relationships_form_dict = relationships.from_dict(relationships_dict) +relationships_from_dict = Relationships.from_dict(relationships_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/RelevantQGPTSeed.md b/docs/RelevantQGPTSeed.md index be490af..1f85cbb 100644 --- a/docs/RelevantQGPTSeed.md +++ b/docs/RelevantQGPTSeed.md @@ -26,7 +26,7 @@ print RelevantQGPTSeed.to_json() # convert the object into a dict relevant_qgpt_seed_dict = relevant_qgpt_seed_instance.to_dict() # create an instance of RelevantQGPTSeed from a dict -relevant_qgpt_seed_form_dict = relevant_qgpt_seed.from_dict(relevant_qgpt_seed_dict) +relevant_qgpt_seed_from_dict = RelevantQGPTSeed.from_dict(relevant_qgpt_seed_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/RelevantQGPTSeeds.md b/docs/RelevantQGPTSeeds.md index d4cb0f6..1661e2f 100644 --- a/docs/RelevantQGPTSeeds.md +++ b/docs/RelevantQGPTSeeds.md @@ -23,7 +23,7 @@ print RelevantQGPTSeeds.to_json() # convert the object into a dict relevant_qgpt_seeds_dict = relevant_qgpt_seeds_instance.to_dict() # create an instance of RelevantQGPTSeeds from a dict -relevant_qgpt_seeds_form_dict = relevant_qgpt_seeds.from_dict(relevant_qgpt_seeds_dict) +relevant_qgpt_seeds_from_dict = RelevantQGPTSeeds.from_dict(relevant_qgpt_seeds_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/ResultedPKCE.md b/docs/ResultedPKCE.md index d2af92c..d2c2376 100644 --- a/docs/ResultedPKCE.md +++ b/docs/ResultedPKCE.md @@ -24,7 +24,7 @@ print ResultedPKCE.to_json() # convert the object into a dict resulted_pkce_dict = resulted_pkce_instance.to_dict() # create an instance of ResultedPKCE from a dict -resulted_pkce_form_dict = resulted_pkce.from_dict(resulted_pkce_dict) +resulted_pkce_from_dict = ResultedPKCE.from_dict(resulted_pkce_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/ReturnedUserProfile.md b/docs/ReturnedUserProfile.md index ecd9caf..8792535 100644 --- a/docs/ReturnedUserProfile.md +++ b/docs/ReturnedUserProfile.md @@ -23,7 +23,7 @@ print ReturnedUserProfile.to_json() # convert the object into a dict returned_user_profile_dict = returned_user_profile_instance.to_dict() # create an instance of ReturnedUserProfile from a dict -returned_user_profile_form_dict = returned_user_profile.from_dict(returned_user_profile_dict) +returned_user_profile_from_dict = ReturnedUserProfile.from_dict(returned_user_profile_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/ReuseReaction.md b/docs/ReuseReaction.md index 92cea91..bb92205 100644 --- a/docs/ReuseReaction.md +++ b/docs/ReuseReaction.md @@ -23,7 +23,7 @@ print ReuseReaction.to_json() # convert the object into a dict reuse_reaction_dict = reuse_reaction_instance.to_dict() # create an instance of ReuseReaction from a dict -reuse_reaction_form_dict = reuse_reaction.from_dict(reuse_reaction_dict) +reuse_reaction_from_dict = ReuseReaction.from_dict(reuse_reaction_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/ReuseSuggestion.md b/docs/ReuseSuggestion.md index f5332a5..3baac14 100644 --- a/docs/ReuseSuggestion.md +++ b/docs/ReuseSuggestion.md @@ -24,7 +24,7 @@ print ReuseSuggestion.to_json() # convert the object into a dict reuse_suggestion_dict = reuse_suggestion_instance.to_dict() # create an instance of ReuseSuggestion from a dict -reuse_suggestion_form_dict = reuse_suggestion.from_dict(reuse_suggestion_dict) +reuse_suggestion_from_dict = ReuseSuggestion.from_dict(reuse_suggestion_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/RevokedPKCE.md b/docs/RevokedPKCE.md index e896227..512740e 100644 --- a/docs/RevokedPKCE.md +++ b/docs/RevokedPKCE.md @@ -24,7 +24,7 @@ print RevokedPKCE.to_json() # convert the object into a dict revoked_pkce_dict = revoked_pkce_instance.to_dict() # create an instance of RevokedPKCE from a dict -revoked_pkce_form_dict = revoked_pkce.from_dict(revoked_pkce_dict) +revoked_pkce_from_dict = RevokedPKCE.from_dict(revoked_pkce_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/SaveSuggestion.md b/docs/SaveSuggestion.md index 8896505..05ecfc0 100644 --- a/docs/SaveSuggestion.md +++ b/docs/SaveSuggestion.md @@ -23,7 +23,7 @@ print SaveSuggestion.to_json() # convert the object into a dict save_suggestion_dict = save_suggestion_instance.to_dict() # create an instance of SaveSuggestion from a dict -save_suggestion_form_dict = save_suggestion.from_dict(save_suggestion_dict) +save_suggestion_from_dict = SaveSuggestion.from_dict(save_suggestion_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/Score.md b/docs/Score.md index fa255b6..978ed70 100644 --- a/docs/Score.md +++ b/docs/Score.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **reuse** | **int** | | [optional] **update** | **int** | | [optional] **reference** | **int** | | [optional] +**searched** | **int** | | [optional] ## Example @@ -28,7 +29,7 @@ print Score.to_json() # convert the object into a dict score_dict = score_instance.to_dict() # create an instance of Score from a dict -score_form_dict = score.from_dict(score_dict) +score_from_dict = Score.from_dict(score_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/SearchEngine.md b/docs/SearchEngine.md new file mode 100644 index 0000000..e4486c3 --- /dev/null +++ b/docs/SearchEngine.md @@ -0,0 +1,35 @@ +# SearchEngine + +This will determine the type of search that will run These are all different searching methods all of which are exclusive. Meaning that you cannot mix & match types. operations: is here if you want to build complex searching behavior. (A || B) && (B || C) , note this can get very complex but can be as flexible as you need. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**query** | **str** | | [optional] +**embeddings** | [**EmbeddingsSearchOptions**](EmbeddingsSearchOptions.md) | | [optional] +**full_text** | [**FullTextSearchOptions**](FullTextSearchOptions.md) | | [optional] +**temporal** | [**TemporalSearchOptions**](TemporalSearchOptions.md) | | [optional] +**workstream** | [**WorkstreamSearchOptions**](WorkstreamSearchOptions.md) | | [optional] +**operations** | [**SearchEngines**](SearchEngines.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.search_engine import SearchEngine + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchEngine from a JSON string +search_engine_instance = SearchEngine.from_json(json) +# print the JSON string representation of the object +print SearchEngine.to_json() + +# convert the object into a dict +search_engine_dict = search_engine_instance.to_dict() +# create an instance of SearchEngine from a dict +search_engine_from_dict = SearchEngine.from_dict(search_engine_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/SearchEngines.md b/docs/SearchEngines.md new file mode 100644 index 0000000..3f0a328 --- /dev/null +++ b/docs/SearchEngines.md @@ -0,0 +1,31 @@ +# SearchEngines + +This is a model for plural Engine. This means that you can run multiple searches, this follow similar behavior to the Asset Filtering.where you can create you own complex operations: IE search a query in FTS, and filter all that have the create from here to here. note: each Engine will only represent 1 search operation, however you many pass in operations to create further nesting. IE Engine: [FTS + w/ operations: [created filter, updated filer, ncs Search] w/ a type of OR:::: This can be as nested as you want however will just increase the time till it returns results.] note: type: default behavior for the type is an AND operation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchEngine]**](SearchEngine.md) | | +**type** | [**FilterOperationTypeEnum**](FilterOperationTypeEnum.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.search_engines import SearchEngines + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchEngines from a JSON string +search_engines_instance = SearchEngines.from_json(json) +# print the JSON string representation of the object +print SearchEngines.to_json() + +# convert the object into a dict +search_engines_dict = search_engines_instance.to_dict() +# create an instance of SearchEngines from a dict +search_engines_from_dict = SearchEngines.from_dict(search_engines_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/SearchInput.md b/docs/SearchInput.md new file mode 100644 index 0000000..89f4c77 --- /dev/null +++ b/docs/SearchInput.md @@ -0,0 +1,30 @@ +# SearchInput + +generic endpoint body for the searching endpoints query: this is optional, but the query string you will use to find your material mode: this is the searching method/type that we will use to search your materials TODO: consider passing in a score here ie only return things that match references/reuse/updates/...etc > x TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials, this would be an input property of suggestions?:boolean that will say if they want suggested materials returned as well + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**engines** | [**SearchEngines**](SearchEngines.md) | | + +## Example + +```python +from pieces_os_client.models.search_input import SearchInput + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchInput from a JSON string +search_input_instance = SearchInput.from_json(json) +# print the JSON string representation of the object +print SearchInput.to_json() + +# convert the object into a dict +search_input_dict = search_input_instance.to_dict() +# create an instance of SearchInput from a dict +search_input_from_dict = SearchInput.from_dict(search_input_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/SearchedAnchor.md b/docs/SearchedAnchor.md new file mode 100644 index 0000000..3c7edcf --- /dev/null +++ b/docs/SearchedAnchor.md @@ -0,0 +1,35 @@ +# SearchedAnchor + +This is used for the Anchors searching endpoint. anchor here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions note: if we match a specific anchorPoint we will provide this as well. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**anchor** | [**Anchor**](Anchor.md) | | [optional] +**points** | [**SearchedAnchorPoints**](SearchedAnchorPoints.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the anchor. | + +## Example + +```python +from pieces_os_client.models.searched_anchor import SearchedAnchor + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnchor from a JSON string +searched_anchor_instance = SearchedAnchor.from_json(json) +# print the JSON string representation of the object +print SearchedAnchor.to_json() + +# convert the object into a dict +searched_anchor_dict = searched_anchor_instance.to_dict() +# create an instance of SearchedAnchor from a dict +searched_anchor_from_dict = SearchedAnchor.from_dict(searched_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/SearchedAnchorPoint.md b/docs/SearchedAnchorPoint.md new file mode 100644 index 0000000..6f8aa28 --- /dev/null +++ b/docs/SearchedAnchorPoint.md @@ -0,0 +1,34 @@ +# SearchedAnchorPoint + +This is used for the AnchorPoints searching endpoint. point here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**point** | [**AnchorPoint**](AnchorPoint.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the anchorPoint. | + +## Example + +```python +from pieces_os_client.models.searched_anchor_point import SearchedAnchorPoint + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnchorPoint from a JSON string +searched_anchor_point_instance = SearchedAnchorPoint.from_json(json) +# print the JSON string representation of the object +print SearchedAnchorPoint.to_json() + +# convert the object into a dict +searched_anchor_point_dict = searched_anchor_point_instance.to_dict() +# create an instance of SearchedAnchorPoint from a dict +searched_anchor_point_from_dict = SearchedAnchorPoint.from_dict(searched_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/SearchedAnchorPoints.md b/docs/SearchedAnchorPoints.md new file mode 100644 index 0000000..0b6e0fd --- /dev/null +++ b/docs/SearchedAnchorPoints.md @@ -0,0 +1,30 @@ +# SearchedAnchorPoints + +This is the plural Model used to return many SearchedAnchorPoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedAnchorPoint]**](SearchedAnchorPoint.md) | | + +## Example + +```python +from pieces_os_client.models.searched_anchor_points import SearchedAnchorPoints + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnchorPoints from a JSON string +searched_anchor_points_instance = SearchedAnchorPoints.from_json(json) +# print the JSON string representation of the object +print SearchedAnchorPoints.to_json() + +# convert the object into a dict +searched_anchor_points_dict = searched_anchor_points_instance.to_dict() +# create an instance of SearchedAnchorPoints from a dict +searched_anchor_points_from_dict = SearchedAnchorPoints.from_dict(searched_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) + + diff --git a/docs/SearchedAnchors.md b/docs/SearchedAnchors.md new file mode 100644 index 0000000..a18ef9c --- /dev/null +++ b/docs/SearchedAnchors.md @@ -0,0 +1,30 @@ +# SearchedAnchors + +This is the plural Model used to return many SearchedAnchor. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedAnchor]**](SearchedAnchor.md) | | + +## Example + +```python +from pieces_os_client.models.searched_anchors import SearchedAnchors + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnchors from a JSON string +searched_anchors_instance = SearchedAnchors.from_json(json) +# print the JSON string representation of the object +print SearchedAnchors.to_json() + +# convert the object into a dict +searched_anchors_dict = searched_anchors_instance.to_dict() +# create an instance of SearchedAnchors from a dict +searched_anchors_from_dict = SearchedAnchors.from_dict(searched_anchors_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/SearchedAnnotation.md b/docs/SearchedAnnotation.md new file mode 100644 index 0000000..1060cb0 --- /dev/null +++ b/docs/SearchedAnnotation.md @@ -0,0 +1,34 @@ +# SearchedAnnotation + +This is used for the Annotation searching endpoint annotation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**annotation** | [**Annotation**](Annotation.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the annotation. | + +## Example + +```python +from pieces_os_client.models.searched_annotation import SearchedAnnotation + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnnotation from a JSON string +searched_annotation_instance = SearchedAnnotation.from_json(json) +# print the JSON string representation of the object +print SearchedAnnotation.to_json() + +# convert the object into a dict +searched_annotation_dict = searched_annotation_instance.to_dict() +# create an instance of SearchedAnnotation from a dict +searched_annotation_from_dict = SearchedAnnotation.from_dict(searched_annotation_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/SearchedAnnotations.md b/docs/SearchedAnnotations.md new file mode 100644 index 0000000..3ea7a25 --- /dev/null +++ b/docs/SearchedAnnotations.md @@ -0,0 +1,30 @@ +# SearchedAnnotations + +This is the plural Model used to return many SearchedAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedAnnotation]**](SearchedAnnotation.md) | | + +## Example + +```python +from pieces_os_client.models.searched_annotations import SearchedAnnotations + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedAnnotations from a JSON string +searched_annotations_instance = SearchedAnnotations.from_json(json) +# print the JSON string representation of the object +print SearchedAnnotations.to_json() + +# convert the object into a dict +searched_annotations_dict = searched_annotations_instance.to_dict() +# create an instance of SearchedAnnotations from a dict +searched_annotations_from_dict = SearchedAnnotations.from_dict(searched_annotations_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/SearchedAsset.md b/docs/SearchedAsset.md index b204c73..40eb766 100644 --- a/docs/SearchedAsset.md +++ b/docs/SearchedAsset.md @@ -28,7 +28,7 @@ print SearchedAsset.to_json() # convert the object into a dict searched_asset_dict = searched_asset_instance.to_dict() # create an instance of SearchedAsset from a dict -searched_asset_form_dict = searched_asset.from_dict(searched_asset_dict) +searched_asset_from_dict = SearchedAsset.from_dict(searched_asset_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/SearchedAssets.md b/docs/SearchedAssets.md index d97dcd2..806c313 100644 --- a/docs/SearchedAssets.md +++ b/docs/SearchedAssets.md @@ -25,7 +25,7 @@ print SearchedAssets.to_json() # convert the object into a dict searched_assets_dict = searched_assets_instance.to_dict() # create an instance of SearchedAssets from a dict -searched_assets_form_dict = searched_assets.from_dict(searched_assets_dict) +searched_assets_from_dict = SearchedAssets.from_dict(searched_assets_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/SearchedConversation.md b/docs/SearchedConversation.md new file mode 100644 index 0000000..82baf6d --- /dev/null +++ b/docs/SearchedConversation.md @@ -0,0 +1,36 @@ +# SearchedConversation + +This is used for the Conversations searching endpoint. conversation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**conversation** | [**Conversation**](Conversation.md) | | [optional] +**messages** | [**SearchedConversationMessages**](SearchedConversationMessages.md) | | [optional] +**annotations** | [**SearchedAnnotations**](SearchedAnnotations.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the conversation. | + +## Example + +```python +from pieces_os_client.models.searched_conversation import SearchedConversation + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedConversation from a JSON string +searched_conversation_instance = SearchedConversation.from_json(json) +# print the JSON string representation of the object +print SearchedConversation.to_json() + +# convert the object into a dict +searched_conversation_dict = searched_conversation_instance.to_dict() +# create an instance of SearchedConversation from a dict +searched_conversation_from_dict = SearchedConversation.from_dict(searched_conversation_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/SearchedConversationMessage.md b/docs/SearchedConversationMessage.md new file mode 100644 index 0000000..172a391 --- /dev/null +++ b/docs/SearchedConversationMessage.md @@ -0,0 +1,34 @@ +# SearchedConversationMessage + +This is used for the ConversationMessages searching endpoint && the specific Conversation search && ConversationsSearch conversation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the ConversationMessage. | + +## Example + +```python +from pieces_os_client.models.searched_conversation_message import SearchedConversationMessage + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedConversationMessage from a JSON string +searched_conversation_message_instance = SearchedConversationMessage.from_json(json) +# print the JSON string representation of the object +print SearchedConversationMessage.to_json() + +# convert the object into a dict +searched_conversation_message_dict = searched_conversation_message_instance.to_dict() +# create an instance of SearchedConversationMessage from a dict +searched_conversation_message_from_dict = SearchedConversationMessage.from_dict(searched_conversation_message_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/SearchedConversationMessages.md b/docs/SearchedConversationMessages.md new file mode 100644 index 0000000..ddbc9b3 --- /dev/null +++ b/docs/SearchedConversationMessages.md @@ -0,0 +1,30 @@ +# SearchedConversationMessages + +This is the plural Model used to return many SearchedConversationMessage. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedConversationMessage]**](SearchedConversationMessage.md) | | + +## Example + +```python +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedConversationMessages from a JSON string +searched_conversation_messages_instance = SearchedConversationMessages.from_json(json) +# print the JSON string representation of the object +print SearchedConversationMessages.to_json() + +# convert the object into a dict +searched_conversation_messages_dict = searched_conversation_messages_instance.to_dict() +# create an instance of SearchedConversationMessages from a dict +searched_conversation_messages_from_dict = SearchedConversationMessages.from_dict(searched_conversation_messages_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/SearchedConversations.md b/docs/SearchedConversations.md new file mode 100644 index 0000000..4322867 --- /dev/null +++ b/docs/SearchedConversations.md @@ -0,0 +1,30 @@ +# SearchedConversations + +This is the plural Model used to return many SearchedConversation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedConversation]**](SearchedConversation.md) | | + +## Example + +```python +from pieces_os_client.models.searched_conversations import SearchedConversations + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedConversations from a JSON string +searched_conversations_instance = SearchedConversations.from_json(json) +# print the JSON string representation of the object +print SearchedConversations.to_json() + +# convert the object into a dict +searched_conversations_dict = searched_conversations_instance.to_dict() +# create an instance of SearchedConversations from a dict +searched_conversations_from_dict = SearchedConversations.from_dict(searched_conversations_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/SearchedHint.md b/docs/SearchedHint.md new file mode 100644 index 0000000..b06a4f6 --- /dev/null +++ b/docs/SearchedHint.md @@ -0,0 +1,34 @@ +# SearchedHint + +This is used for the Hint searching endpoint hint here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**hint** | [**Hint**](Hint.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the hint. | + +## Example + +```python +from pieces_os_client.models.searched_hint import SearchedHint + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedHint from a JSON string +searched_hint_instance = SearchedHint.from_json(json) +# print the JSON string representation of the object +print SearchedHint.to_json() + +# convert the object into a dict +searched_hint_dict = searched_hint_instance.to_dict() +# create an instance of SearchedHint from a dict +searched_hint_from_dict = SearchedHint.from_dict(searched_hint_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/SearchedHints.md b/docs/SearchedHints.md new file mode 100644 index 0000000..5e18888 --- /dev/null +++ b/docs/SearchedHints.md @@ -0,0 +1,30 @@ +# SearchedHints + +This is the plural Model used to return many SearchedHint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedHint]**](SearchedHint.md) | | + +## Example + +```python +from pieces_os_client.models.searched_hints import SearchedHints + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedHints from a JSON string +searched_hints_instance = SearchedHints.from_json(json) +# print the JSON string representation of the object +print SearchedHints.to_json() + +# convert the object into a dict +searched_hints_dict = searched_hints_instance.to_dict() +# create an instance of SearchedHints from a dict +searched_hints_from_dict = SearchedHints.from_dict(searched_hints_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/SearchedPerson.md b/docs/SearchedPerson.md new file mode 100644 index 0000000..52ee45c --- /dev/null +++ b/docs/SearchedPerson.md @@ -0,0 +1,34 @@ +# SearchedPerson + +This is used for the Persons searching endpoint. person here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**person** | [**Person**](Person.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the person. | + +## Example + +```python +from pieces_os_client.models.searched_person import SearchedPerson + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedPerson from a JSON string +searched_person_instance = SearchedPerson.from_json(json) +# print the JSON string representation of the object +print SearchedPerson.to_json() + +# convert the object into a dict +searched_person_dict = searched_person_instance.to_dict() +# create an instance of SearchedPerson from a dict +searched_person_from_dict = SearchedPerson.from_dict(searched_person_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/SearchedPersons.md b/docs/SearchedPersons.md new file mode 100644 index 0000000..3426b76 --- /dev/null +++ b/docs/SearchedPersons.md @@ -0,0 +1,30 @@ +# SearchedPersons + +This is the plural Model used to return many SearchedPerson. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedPerson]**](SearchedPerson.md) | | + +## Example + +```python +from pieces_os_client.models.searched_persons import SearchedPersons + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedPersons from a JSON string +searched_persons_instance = SearchedPersons.from_json(json) +# print the JSON string representation of the object +print SearchedPersons.to_json() + +# convert the object into a dict +searched_persons_dict = searched_persons_instance.to_dict() +# create an instance of SearchedPersons from a dict +searched_persons_from_dict = SearchedPersons.from_dict(searched_persons_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/SearchedSensitive.md b/docs/SearchedSensitive.md new file mode 100644 index 0000000..7f4e72a --- /dev/null +++ b/docs/SearchedSensitive.md @@ -0,0 +1,34 @@ +# SearchedSensitive + +This is used for the Sensitives searching endpoint. sensitive here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**sensitive** | [**Sensitive**](Sensitive.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the sensitive. | + +## Example + +```python +from pieces_os_client.models.searched_sensitive import SearchedSensitive + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedSensitive from a JSON string +searched_sensitive_instance = SearchedSensitive.from_json(json) +# print the JSON string representation of the object +print SearchedSensitive.to_json() + +# convert the object into a dict +searched_sensitive_dict = searched_sensitive_instance.to_dict() +# create an instance of SearchedSensitive from a dict +searched_sensitive_from_dict = SearchedSensitive.from_dict(searched_sensitive_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/SearchedSensitives.md b/docs/SearchedSensitives.md new file mode 100644 index 0000000..a6643df --- /dev/null +++ b/docs/SearchedSensitives.md @@ -0,0 +1,30 @@ +# SearchedSensitives + +This is the plural Model used to return many SearchedSensitive. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedSensitive]**](SearchedSensitive.md) | | + +## Example + +```python +from pieces_os_client.models.searched_sensitives import SearchedSensitives + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedSensitives from a JSON string +searched_sensitives_instance = SearchedSensitives.from_json(json) +# print the JSON string representation of the object +print SearchedSensitives.to_json() + +# convert the object into a dict +searched_sensitives_dict = searched_sensitives_instance.to_dict() +# create an instance of SearchedSensitives from a dict +searched_sensitives_from_dict = SearchedSensitives.from_dict(searched_sensitives_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/SearchedTag.md b/docs/SearchedTag.md new file mode 100644 index 0000000..b26a471 --- /dev/null +++ b/docs/SearchedTag.md @@ -0,0 +1,34 @@ +# SearchedTag + +This is used for the Tags searching endpoint. tag here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**tag** | [**Tag**](Tag.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the tag. | + +## Example + +```python +from pieces_os_client.models.searched_tag import SearchedTag + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedTag from a JSON string +searched_tag_instance = SearchedTag.from_json(json) +# print the JSON string representation of the object +print SearchedTag.to_json() + +# convert the object into a dict +searched_tag_dict = searched_tag_instance.to_dict() +# create an instance of SearchedTag from a dict +searched_tag_from_dict = SearchedTag.from_dict(searched_tag_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/SearchedTags.md b/docs/SearchedTags.md new file mode 100644 index 0000000..6b645be --- /dev/null +++ b/docs/SearchedTags.md @@ -0,0 +1,30 @@ +# SearchedTags + +This is the plural Model used to return many searchedTags. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedTag]**](SearchedTag.md) | | + +## Example + +```python +from pieces_os_client.models.searched_tags import SearchedTags + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedTags from a JSON string +searched_tags_instance = SearchedTags.from_json(json) +# print the JSON string representation of the object +print SearchedTags.to_json() + +# convert the object into a dict +searched_tags_dict = searched_tags_instance.to_dict() +# create an instance of SearchedTags from a dict +searched_tags_from_dict = SearchedTags.from_dict(searched_tags_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/SearchedWebsite.md b/docs/SearchedWebsite.md new file mode 100644 index 0000000..ad75686 --- /dev/null +++ b/docs/SearchedWebsite.md @@ -0,0 +1,34 @@ +# SearchedWebsite + +This is used for the Websites searching endpoint. website here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**website** | [**Website**](Website.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the website. | + +## Example + +```python +from pieces_os_client.models.searched_website import SearchedWebsite + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWebsite from a JSON string +searched_website_instance = SearchedWebsite.from_json(json) +# print the JSON string representation of the object +print SearchedWebsite.to_json() + +# convert the object into a dict +searched_website_dict = searched_website_instance.to_dict() +# create an instance of SearchedWebsite from a dict +searched_website_from_dict = SearchedWebsite.from_dict(searched_website_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/SearchedWebsites.md b/docs/SearchedWebsites.md new file mode 100644 index 0000000..5df46e9 --- /dev/null +++ b/docs/SearchedWebsites.md @@ -0,0 +1,30 @@ +# SearchedWebsites + +This is the plural Model used to return many SearchedWebsite. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedWebsite]**](SearchedWebsite.md) | | + +## Example + +```python +from pieces_os_client.models.searched_websites import SearchedWebsites + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWebsites from a JSON string +searched_websites_instance = SearchedWebsites.from_json(json) +# print the JSON string representation of the object +print SearchedWebsites.to_json() + +# convert the object into a dict +searched_websites_dict = searched_websites_instance.to_dict() +# create an instance of SearchedWebsites from a dict +searched_websites_from_dict = SearchedWebsites.from_dict(searched_websites_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/SearchedWorkstreamPatternEngineVisionEvent.md b/docs/SearchedWorkstreamPatternEngineVisionEvent.md new file mode 100644 index 0000000..92196fc --- /dev/null +++ b/docs/SearchedWorkstreamPatternEngineVisionEvent.md @@ -0,0 +1,35 @@ +# SearchedWorkstreamPatternEngineVisionEvent + +This will return a list of the returned events. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**event** | [**WorkstreamPatternEngineVisionEvent**](WorkstreamPatternEngineVisionEvent.md) | | [optional] +**exact** | **bool** | | [optional] +**similarity** | **float** | | [optional] +**temporal** | **bool** | | [optional] +**application** | **str** | | [optional] +**identifier** | **str** | This is the uuid of the event. | + +## Example + +```python +from pieces_os_client.models.searched_workstream_pattern_engine_vision_event import SearchedWorkstreamPatternEngineVisionEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWorkstreamPatternEngineVisionEvent from a JSON string +searched_workstream_pattern_engine_vision_event_instance = SearchedWorkstreamPatternEngineVisionEvent.from_json(json) +# print the JSON string representation of the object +print SearchedWorkstreamPatternEngineVisionEvent.to_json() + +# convert the object into a dict +searched_workstream_pattern_engine_vision_event_dict = searched_workstream_pattern_engine_vision_event_instance.to_dict() +# create an instance of SearchedWorkstreamPatternEngineVisionEvent from a dict +searched_workstream_pattern_engine_vision_event_from_dict = SearchedWorkstreamPatternEngineVisionEvent.from_dict(searched_workstream_pattern_engine_vision_event_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/SearchedWorkstreamPatternEngineVisionEvents.md b/docs/SearchedWorkstreamPatternEngineVisionEvents.md new file mode 100644 index 0000000..89300e0 --- /dev/null +++ b/docs/SearchedWorkstreamPatternEngineVisionEvents.md @@ -0,0 +1,30 @@ +# SearchedWorkstreamPatternEngineVisionEvents + +This will return a list of the returned events. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedWorkstreamPatternEngineVisionEvent]**](SearchedWorkstreamPatternEngineVisionEvent.md) | | + +## Example + +```python +from pieces_os_client.models.searched_workstream_pattern_engine_vision_events import SearchedWorkstreamPatternEngineVisionEvents + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWorkstreamPatternEngineVisionEvents from a JSON string +searched_workstream_pattern_engine_vision_events_instance = SearchedWorkstreamPatternEngineVisionEvents.from_json(json) +# print the JSON string representation of the object +print SearchedWorkstreamPatternEngineVisionEvents.to_json() + +# convert the object into a dict +searched_workstream_pattern_engine_vision_events_dict = searched_workstream_pattern_engine_vision_events_instance.to_dict() +# create an instance of SearchedWorkstreamPatternEngineVisionEvents from a dict +searched_workstream_pattern_engine_vision_events_from_dict = SearchedWorkstreamPatternEngineVisionEvents.from_dict(searched_workstream_pattern_engine_vision_events_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/SearchedWorkstreamSummaries.md b/docs/SearchedWorkstreamSummaries.md new file mode 100644 index 0000000..e59d12d --- /dev/null +++ b/docs/SearchedWorkstreamSummaries.md @@ -0,0 +1,30 @@ +# SearchedWorkstreamSummaries + +This is the plural Model used to return many SearchedWorkstreamSummary. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[SearchedWorkstreamSummary]**](SearchedWorkstreamSummary.md) | | + +## Example + +```python +from pieces_os_client.models.searched_workstream_summaries import SearchedWorkstreamSummaries + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWorkstreamSummaries from a JSON string +searched_workstream_summaries_instance = SearchedWorkstreamSummaries.from_json(json) +# print the JSON string representation of the object +print SearchedWorkstreamSummaries.to_json() + +# convert the object into a dict +searched_workstream_summaries_dict = searched_workstream_summaries_instance.to_dict() +# create an instance of SearchedWorkstreamSummaries from a dict +searched_workstream_summaries_from_dict = SearchedWorkstreamSummaries.from_dict(searched_workstream_summaries_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/SearchedWorkstreamSummary.md b/docs/SearchedWorkstreamSummary.md new file mode 100644 index 0000000..4d2d16c --- /dev/null +++ b/docs/SearchedWorkstreamSummary.md @@ -0,0 +1,35 @@ +# SearchedWorkstreamSummary + +This is used for the WorkstreamSummaries searching endpoint WorkstreamSummary here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions annotations: this is provided if we match a specific annotation on a WorkstreamSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**summary** | [**WorkstreamSummary**](WorkstreamSummary.md) | | [optional] +**annotations** | [**SearchedAnnotations**](SearchedAnnotations.md) | | [optional] +**exact** | **bool** | | +**similarity** | **float** | | +**temporal** | **bool** | | [optional] +**identifier** | **str** | This is the uuid of the WorkstreamSummary. | + +## Example + +```python +from pieces_os_client.models.searched_workstream_summary import SearchedWorkstreamSummary + +# TODO update the JSON string below +json = "{}" +# create an instance of SearchedWorkstreamSummary from a JSON string +searched_workstream_summary_instance = SearchedWorkstreamSummary.from_json(json) +# print the JSON string representation of the object +print SearchedWorkstreamSummary.to_json() + +# convert the object into a dict +searched_workstream_summary_dict = searched_workstream_summary_instance.to_dict() +# create an instance of SearchedWorkstreamSummary from a dict +searched_workstream_summary_from_dict = SearchedWorkstreamSummary.from_dict(searched_workstream_summary_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/Seed.md b/docs/Seed.md index 198df33..79d0af7 100644 --- a/docs/Seed.md +++ b/docs/Seed.md @@ -1,13 +1,16 @@ # Seed -A seed Model used to wrap a format or asset +A seed Model used to wrap a format or asset Note: we will expand this now to support additional paramerters. Note: however if create an asset, only pass in the asset, not passing in an asset in this case will cause the endpoint to fail. TODO: for a breaking change update the type enum here to add support for the additional materials or remove it entirely. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] **asset** | [**SeededAsset**](SeededAsset.md) | | [optional] -**type** | **str** | | +**person** | [**SeededPerson**](SeededPerson.md) | | [optional] +**anchor** | [**SeededAnchor**](SeededAnchor.md) | | [optional] +**website** | [**SeededWebsite**](SeededWebsite.md) | | [optional] +**type** | **str** | | [optional] ## Example @@ -24,7 +27,7 @@ print Seed.to_json() # convert the object into a dict seed_dict = seed_instance.to_dict() # create an instance of Seed from a dict -seed_form_dict = seed.from_dict(seed_dict) +seed_from_dict = Seed.from_dict(seed_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/SeededAccessor.md b/docs/SeededAccessor.md index 6763d30..d3d93a0 100644 --- a/docs/SeededAccessor.md +++ b/docs/SeededAccessor.md @@ -25,7 +25,7 @@ print SeededAccessor.to_json() # convert the object into a dict seeded_accessor_dict = seeded_accessor_instance.to_dict() # create an instance of SeededAccessor from a dict -seeded_accessor_form_dict = seeded_accessor.from_dict(seeded_accessor_dict) +seeded_accessor_from_dict = SeededAccessor.from_dict(seeded_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/SeededActivity.md b/docs/SeededActivity.md index 2dfb4b2..dbb0b30 100644 --- a/docs/SeededActivity.md +++ b/docs/SeededActivity.md @@ -28,7 +28,7 @@ print SeededActivity.to_json() # convert the object into a dict seeded_activity_dict = seeded_activity_instance.to_dict() # create an instance of SeededActivity from a dict -seeded_activity_form_dict = seeded_activity.from_dict(seeded_activity_dict) +seeded_activity_from_dict = SeededActivity.from_dict(seeded_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/SeededAnchor.md b/docs/SeededAnchor.md index 7661a1c..b6ab5f3 100644 --- a/docs/SeededAnchor.md +++ b/docs/SeededAnchor.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **name** | **str** | | [optional] **annotations** | [**List[SeededAnnotation]**](SeededAnnotation.md) | | [optional] **conversation** | **str** | | [optional] +**persons** | [**FlattenedPersons**](FlattenedPersons.md) | | [optional] ## Example @@ -29,7 +30,7 @@ print SeededAnchor.to_json() # convert the object into a dict seeded_anchor_dict = seeded_anchor_instance.to_dict() # create an instance of SeededAnchor from a dict -seeded_anchor_form_dict = seeded_anchor.from_dict(seeded_anchor_dict) +seeded_anchor_from_dict = SeededAnchor.from_dict(seeded_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/SeededAnchorPoint.md b/docs/SeededAnchorPoint.md index e136f47..c9cb641 100644 --- a/docs/SeededAnchorPoint.md +++ b/docs/SeededAnchorPoint.md @@ -26,7 +26,7 @@ print SeededAnchorPoint.to_json() # convert the object into a dict seeded_anchor_point_dict = seeded_anchor_point_instance.to_dict() # create an instance of SeededAnchorPoint from a dict -seeded_anchor_point_form_dict = seeded_anchor_point.from_dict(seeded_anchor_point_dict) +seeded_anchor_point_from_dict = SeededAnchorPoint.from_dict(seeded_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/SeededAnnotation.md b/docs/SeededAnnotation.md index f51f726..d60e241 100644 --- a/docs/SeededAnnotation.md +++ b/docs/SeededAnnotation.md @@ -33,7 +33,7 @@ print SeededAnnotation.to_json() # convert the object into a dict seeded_annotation_dict = seeded_annotation_instance.to_dict() # create an instance of SeededAnnotation from a dict -seeded_annotation_form_dict = seeded_annotation.from_dict(seeded_annotation_dict) +seeded_annotation_from_dict = SeededAnnotation.from_dict(seeded_annotation_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/SeededAsset.md b/docs/SeededAsset.md index ea8b8d9..8babb68 100644 --- a/docs/SeededAsset.md +++ b/docs/SeededAsset.md @@ -30,7 +30,7 @@ print SeededAsset.to_json() # convert the object into a dict seeded_asset_dict = seeded_asset_instance.to_dict() # create an instance of SeededAsset from a dict -seeded_asset_form_dict = seeded_asset.from_dict(seeded_asset_dict) +seeded_asset_from_dict = SeededAsset.from_dict(seeded_asset_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/SeededAssetEnrichment.md b/docs/SeededAssetEnrichment.md index ff3615e..8f0b6b3 100644 --- a/docs/SeededAssetEnrichment.md +++ b/docs/SeededAssetEnrichment.md @@ -26,7 +26,7 @@ print SeededAssetEnrichment.to_json() # convert the object into a dict seeded_asset_enrichment_dict = seeded_asset_enrichment_instance.to_dict() # create an instance of SeededAssetEnrichment from a dict -seeded_asset_enrichment_form_dict = seeded_asset_enrichment.from_dict(seeded_asset_enrichment_dict) +seeded_asset_enrichment_from_dict = SeededAssetEnrichment.from_dict(seeded_asset_enrichment_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/SeededAssetMetadata.md b/docs/SeededAssetMetadata.md index 2d6f0f9..fac799c 100644 --- a/docs/SeededAssetMetadata.md +++ b/docs/SeededAssetMetadata.md @@ -31,7 +31,7 @@ print SeededAssetMetadata.to_json() # convert the object into a dict seeded_asset_metadata_dict = seeded_asset_metadata_instance.to_dict() # create an instance of SeededAssetMetadata from a dict -seeded_asset_metadata_form_dict = seeded_asset_metadata.from_dict(seeded_asset_metadata_dict) +seeded_asset_metadata_from_dict = SeededAssetMetadata.from_dict(seeded_asset_metadata_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/SeededAssetSensitive.md b/docs/SeededAssetSensitive.md index f457615..841a6c4 100644 --- a/docs/SeededAssetSensitive.md +++ b/docs/SeededAssetSensitive.md @@ -29,7 +29,7 @@ print SeededAssetSensitive.to_json() # convert the object into a dict seeded_asset_sensitive_dict = seeded_asset_sensitive_instance.to_dict() # create an instance of SeededAssetSensitive from a dict -seeded_asset_sensitive_form_dict = seeded_asset_sensitive.from_dict(seeded_asset_sensitive_dict) +seeded_asset_sensitive_from_dict = SeededAssetSensitive.from_dict(seeded_asset_sensitive_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/SeededAssetTag.md b/docs/SeededAssetTag.md index a9c5116..a80548f 100644 --- a/docs/SeededAssetTag.md +++ b/docs/SeededAssetTag.md @@ -25,7 +25,7 @@ print SeededAssetTag.to_json() # convert the object into a dict seeded_asset_tag_dict = seeded_asset_tag_instance.to_dict() # create an instance of SeededAssetTag from a dict -seeded_asset_tag_form_dict = seeded_asset_tag.from_dict(seeded_asset_tag_dict) +seeded_asset_tag_from_dict = SeededAssetTag.from_dict(seeded_asset_tag_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/SeededAssetTags.md b/docs/SeededAssetTags.md index cf90d79..f91ca94 100644 --- a/docs/SeededAssetTags.md +++ b/docs/SeededAssetTags.md @@ -21,7 +21,7 @@ print SeededAssetTags.to_json() # convert the object into a dict seeded_asset_tags_dict = seeded_asset_tags_instance.to_dict() # create an instance of SeededAssetTags from a dict -seeded_asset_tags_form_dict = seeded_asset_tags.from_dict(seeded_asset_tags_dict) +seeded_asset_tags_from_dict = SeededAssetTags.from_dict(seeded_asset_tags_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/SeededAssetWebsite.md b/docs/SeededAssetWebsite.md index 739e27f..57b7974 100644 --- a/docs/SeededAssetWebsite.md +++ b/docs/SeededAssetWebsite.md @@ -25,7 +25,7 @@ print SeededAssetWebsite.to_json() # convert the object into a dict seeded_asset_website_dict = seeded_asset_website_instance.to_dict() # create an instance of SeededAssetWebsite from a dict -seeded_asset_website_form_dict = seeded_asset_website.from_dict(seeded_asset_website_dict) +seeded_asset_website_from_dict = SeededAssetWebsite.from_dict(seeded_asset_website_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/SeededAssetsRecommendation.md b/docs/SeededAssetsRecommendation.md index ca9879a..5f84f7e 100644 --- a/docs/SeededAssetsRecommendation.md +++ b/docs/SeededAssetsRecommendation.md @@ -24,7 +24,7 @@ print SeededAssetsRecommendation.to_json() # convert the object into a dict seeded_assets_recommendation_dict = seeded_assets_recommendation_instance.to_dict() # create an instance of SeededAssetsRecommendation from a dict -seeded_assets_recommendation_form_dict = seeded_assets_recommendation.from_dict(seeded_assets_recommendation_dict) +seeded_assets_recommendation_from_dict = SeededAssetsRecommendation.from_dict(seeded_assets_recommendation_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/SeededBackup.md b/docs/SeededBackup.md index aef265f..afdfa7b 100644 --- a/docs/SeededBackup.md +++ b/docs/SeededBackup.md @@ -22,7 +22,7 @@ print SeededBackup.to_json() # convert the object into a dict seeded_backup_dict = seeded_backup_instance.to_dict() # create an instance of SeededBackup from a dict -seeded_backup_form_dict = seeded_backup.from_dict(seeded_backup_dict) +seeded_backup_from_dict = SeededBackup.from_dict(seeded_backup_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/SeededClassification.md b/docs/SeededClassification.md index 18e0908..db75842 100644 --- a/docs/SeededClassification.md +++ b/docs/SeededClassification.md @@ -25,7 +25,7 @@ print SeededClassification.to_json() # convert the object into a dict seeded_classification_dict = seeded_classification_instance.to_dict() # create an instance of SeededClassification from a dict -seeded_classification_form_dict = seeded_classification.from_dict(seeded_classification_dict) +seeded_classification_from_dict = SeededClassification.from_dict(seeded_classification_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/SeededConnectorAsset.md b/docs/SeededConnectorAsset.md index 5f40204..68e2c96 100644 --- a/docs/SeededConnectorAsset.md +++ b/docs/SeededConnectorAsset.md @@ -24,7 +24,7 @@ print SeededConnectorAsset.to_json() # convert the object into a dict seeded_connector_asset_dict = seeded_connector_asset_instance.to_dict() # create an instance of SeededConnectorAsset from a dict -seeded_connector_asset_form_dict = seeded_connector_asset.from_dict(seeded_connector_asset_dict) +seeded_connector_asset_from_dict = SeededConnectorAsset.from_dict(seeded_connector_asset_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/SeededConnectorConnection.md b/docs/SeededConnectorConnection.md index 6748bd1..38a7ed9 100644 --- a/docs/SeededConnectorConnection.md +++ b/docs/SeededConnectorConnection.md @@ -23,7 +23,7 @@ print SeededConnectorConnection.to_json() # convert the object into a dict seeded_connector_connection_dict = seeded_connector_connection_instance.to_dict() # create an instance of SeededConnectorConnection from a dict -seeded_connector_connection_form_dict = seeded_connector_connection.from_dict(seeded_connector_connection_dict) +seeded_connector_connection_from_dict = SeededConnectorConnection.from_dict(seeded_connector_connection_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/SeededConnectorCreation.md b/docs/SeededConnectorCreation.md index 693c448..1f24732 100644 --- a/docs/SeededConnectorCreation.md +++ b/docs/SeededConnectorCreation.md @@ -23,7 +23,7 @@ print SeededConnectorCreation.to_json() # convert the object into a dict seeded_connector_creation_dict = seeded_connector_creation_instance.to_dict() # create an instance of SeededConnectorCreation from a dict -seeded_connector_creation_form_dict = seeded_connector_creation.from_dict(seeded_connector_creation_dict) +seeded_connector_creation_from_dict = SeededConnectorCreation.from_dict(seeded_connector_creation_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/SeededConnectorTracking.md b/docs/SeededConnectorTracking.md index 6105f11..75398f2 100644 --- a/docs/SeededConnectorTracking.md +++ b/docs/SeededConnectorTracking.md @@ -31,7 +31,7 @@ print SeededConnectorTracking.to_json() # convert the object into a dict seeded_connector_tracking_dict = seeded_connector_tracking_instance.to_dict() # create an instance of SeededConnectorTracking from a dict -seeded_connector_tracking_form_dict = seeded_connector_tracking.from_dict(seeded_connector_tracking_dict) +seeded_connector_tracking_from_dict = SeededConnectorTracking.from_dict(seeded_connector_tracking_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/SeededConversation.md b/docs/SeededConversation.md index 61fef8d..ca37895 100644 --- a/docs/SeededConversation.md +++ b/docs/SeededConversation.md @@ -34,7 +34,7 @@ print SeededConversation.to_json() # convert the object into a dict seeded_conversation_dict = seeded_conversation_instance.to_dict() # create an instance of SeededConversation from a dict -seeded_conversation_form_dict = seeded_conversation.from_dict(seeded_conversation_dict) +seeded_conversation_from_dict = SeededConversation.from_dict(seeded_conversation_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/SeededConversationMessage.md b/docs/SeededConversationMessage.md index 4b07bdc..ecc82a9 100644 --- a/docs/SeededConversationMessage.md +++ b/docs/SeededConversationMessage.md @@ -28,7 +28,7 @@ print SeededConversationMessage.to_json() # convert the object into a dict seeded_conversation_message_dict = seeded_conversation_message_instance.to_dict() # create an instance of SeededConversationMessage from a dict -seeded_conversation_message_form_dict = seeded_conversation_message.from_dict(seeded_conversation_message_dict) +seeded_conversation_message_from_dict = SeededConversationMessage.from_dict(seeded_conversation_message_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/SeededDiscoverableAsset.md b/docs/SeededDiscoverableAsset.md index c23ac85..6a6c678 100644 --- a/docs/SeededDiscoverableAsset.md +++ b/docs/SeededDiscoverableAsset.md @@ -26,7 +26,7 @@ print SeededDiscoverableAsset.to_json() # convert the object into a dict seeded_discoverable_asset_dict = seeded_discoverable_asset_instance.to_dict() # create an instance of SeededDiscoverableAsset from a dict -seeded_discoverable_asset_form_dict = seeded_discoverable_asset.from_dict(seeded_discoverable_asset_dict) +seeded_discoverable_asset_from_dict = SeededDiscoverableAsset.from_dict(seeded_discoverable_asset_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/SeededDiscoverableAssets.md b/docs/SeededDiscoverableAssets.md index 470ec00..7d78c46 100644 --- a/docs/SeededDiscoverableAssets.md +++ b/docs/SeededDiscoverableAssets.md @@ -25,7 +25,7 @@ print SeededDiscoverableAssets.to_json() # convert the object into a dict seeded_discoverable_assets_dict = seeded_discoverable_assets_instance.to_dict() # create an instance of SeededDiscoverableAssets from a dict -seeded_discoverable_assets_form_dict = seeded_discoverable_assets.from_dict(seeded_discoverable_assets_dict) +seeded_discoverable_assets_from_dict = SeededDiscoverableAssets.from_dict(seeded_discoverable_assets_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/SeededDiscoverableHtmlWebpage.md b/docs/SeededDiscoverableHtmlWebpage.md index fffe78d..1362d54 100644 --- a/docs/SeededDiscoverableHtmlWebpage.md +++ b/docs/SeededDiscoverableHtmlWebpage.md @@ -23,7 +23,7 @@ print SeededDiscoverableHtmlWebpage.to_json() # convert the object into a dict seeded_discoverable_html_webpage_dict = seeded_discoverable_html_webpage_instance.to_dict() # create an instance of SeededDiscoverableHtmlWebpage from a dict -seeded_discoverable_html_webpage_form_dict = seeded_discoverable_html_webpage.from_dict(seeded_discoverable_html_webpage_dict) +seeded_discoverable_html_webpage_from_dict = SeededDiscoverableHtmlWebpage.from_dict(seeded_discoverable_html_webpage_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/SeededDiscoverableHtmlWebpages.md b/docs/SeededDiscoverableHtmlWebpages.md index 7e068f3..d1e9b8c 100644 --- a/docs/SeededDiscoverableHtmlWebpages.md +++ b/docs/SeededDiscoverableHtmlWebpages.md @@ -23,7 +23,7 @@ print SeededDiscoverableHtmlWebpages.to_json() # convert the object into a dict seeded_discoverable_html_webpages_dict = seeded_discoverable_html_webpages_instance.to_dict() # create an instance of SeededDiscoverableHtmlWebpages from a dict -seeded_discoverable_html_webpages_form_dict = seeded_discoverable_html_webpages.from_dict(seeded_discoverable_html_webpages_dict) +seeded_discoverable_html_webpages_from_dict = SeededDiscoverableHtmlWebpages.from_dict(seeded_discoverable_html_webpages_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/SeededDiscoverableRelatedTag.md b/docs/SeededDiscoverableRelatedTag.md index 3e8be13..2fd1093 100644 --- a/docs/SeededDiscoverableRelatedTag.md +++ b/docs/SeededDiscoverableRelatedTag.md @@ -27,7 +27,7 @@ print SeededDiscoverableRelatedTag.to_json() # convert the object into a dict seeded_discoverable_related_tag_dict = seeded_discoverable_related_tag_instance.to_dict() # create an instance of SeededDiscoverableRelatedTag from a dict -seeded_discoverable_related_tag_form_dict = seeded_discoverable_related_tag.from_dict(seeded_discoverable_related_tag_dict) +seeded_discoverable_related_tag_from_dict = SeededDiscoverableRelatedTag.from_dict(seeded_discoverable_related_tag_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/SeededDiscoverableRelatedTags.md b/docs/SeededDiscoverableRelatedTags.md index 86a862c..0fcce9e 100644 --- a/docs/SeededDiscoverableRelatedTags.md +++ b/docs/SeededDiscoverableRelatedTags.md @@ -23,7 +23,7 @@ print SeededDiscoverableRelatedTags.to_json() # convert the object into a dict seeded_discoverable_related_tags_dict = seeded_discoverable_related_tags_instance.to_dict() # create an instance of SeededDiscoverableRelatedTags from a dict -seeded_discoverable_related_tags_form_dict = seeded_discoverable_related_tags.from_dict(seeded_discoverable_related_tags_dict) +seeded_discoverable_related_tags_from_dict = SeededDiscoverableRelatedTags.from_dict(seeded_discoverable_related_tags_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/SeededDiscoverableSensitive.md b/docs/SeededDiscoverableSensitive.md index c0506b8..5612ec3 100644 --- a/docs/SeededDiscoverableSensitive.md +++ b/docs/SeededDiscoverableSensitive.md @@ -30,7 +30,7 @@ print SeededDiscoverableSensitive.to_json() # convert the object into a dict seeded_discoverable_sensitive_dict = seeded_discoverable_sensitive_instance.to_dict() # create an instance of SeededDiscoverableSensitive from a dict -seeded_discoverable_sensitive_form_dict = seeded_discoverable_sensitive.from_dict(seeded_discoverable_sensitive_dict) +seeded_discoverable_sensitive_from_dict = SeededDiscoverableSensitive.from_dict(seeded_discoverable_sensitive_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/SeededDiscoverableSensitives.md b/docs/SeededDiscoverableSensitives.md index 0952b1d..5d2ac83 100644 --- a/docs/SeededDiscoverableSensitives.md +++ b/docs/SeededDiscoverableSensitives.md @@ -23,7 +23,7 @@ print SeededDiscoverableSensitives.to_json() # convert the object into a dict seeded_discoverable_sensitives_dict = seeded_discoverable_sensitives_instance.to_dict() # create an instance of SeededDiscoverableSensitives from a dict -seeded_discoverable_sensitives_form_dict = seeded_discoverable_sensitives.from_dict(seeded_discoverable_sensitives_dict) +seeded_discoverable_sensitives_from_dict = SeededDiscoverableSensitives.from_dict(seeded_discoverable_sensitives_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/SeededDistribution.md b/docs/SeededDistribution.md index f91c94b..ad8ca1e 100644 --- a/docs/SeededDistribution.md +++ b/docs/SeededDistribution.md @@ -24,7 +24,7 @@ print SeededDistribution.to_json() # convert the object into a dict seeded_distribution_dict = seeded_distribution_instance.to_dict() # create an instance of SeededDistribution from a dict -seeded_distribution_form_dict = seeded_distribution.from_dict(seeded_distribution_dict) +seeded_distribution_from_dict = SeededDistribution.from_dict(seeded_distribution_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/SeededDistributions.md b/docs/SeededDistributions.md index 96971e9..d8e37ad 100644 --- a/docs/SeededDistributions.md +++ b/docs/SeededDistributions.md @@ -23,7 +23,7 @@ print SeededDistributions.to_json() # convert the object into a dict seeded_distributions_dict = seeded_distributions_instance.to_dict() # create an instance of SeededDistributions from a dict -seeded_distributions_form_dict = seeded_distributions.from_dict(seeded_distributions_dict) +seeded_distributions_from_dict = SeededDistributions.from_dict(seeded_distributions_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/SeededExternalProvider.md b/docs/SeededExternalProvider.md index 0308395..3240d7c 100644 --- a/docs/SeededExternalProvider.md +++ b/docs/SeededExternalProvider.md @@ -22,7 +22,7 @@ print SeededExternalProvider.to_json() # convert the object into a dict seeded_external_provider_dict = seeded_external_provider_instance.to_dict() # create an instance of SeededExternalProvider from a dict -seeded_external_provider_form_dict = seeded_external_provider.from_dict(seeded_external_provider_dict) +seeded_external_provider_from_dict = SeededExternalProvider.from_dict(seeded_external_provider_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/SeededFile.md b/docs/SeededFile.md index b7cb8a2..5cf8790 100644 --- a/docs/SeededFile.md +++ b/docs/SeededFile.md @@ -25,7 +25,7 @@ print SeededFile.to_json() # convert the object into a dict seeded_file_dict = seeded_file_instance.to_dict() # create an instance of SeededFile from a dict -seeded_file_form_dict = seeded_file.from_dict(seeded_file_dict) +seeded_file_from_dict = SeededFile.from_dict(seeded_file_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/SeededFormat.md b/docs/SeededFormat.md index 79be3d4..b2c5957 100644 --- a/docs/SeededFormat.md +++ b/docs/SeededFormat.md @@ -25,7 +25,7 @@ print SeededFormat.to_json() # convert the object into a dict seeded_format_dict = seeded_format_instance.to_dict() # create an instance of SeededFormat from a dict -seeded_format_form_dict = seeded_format.from_dict(seeded_format_dict) +seeded_format_from_dict = SeededFormat.from_dict(seeded_format_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/SeededFragment.md b/docs/SeededFragment.md index 3d9496f..135032e 100644 --- a/docs/SeededFragment.md +++ b/docs/SeededFragment.md @@ -25,7 +25,7 @@ print SeededFragment.to_json() # convert the object into a dict seeded_fragment_dict = seeded_fragment_instance.to_dict() # create an instance of SeededFragment from a dict -seeded_fragment_form_dict = seeded_fragment.from_dict(seeded_fragment_dict) +seeded_fragment_from_dict = SeededFragment.from_dict(seeded_fragment_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/SeededGitHubDistribution.md b/docs/SeededGitHubDistribution.md index 39ba0d0..6163f57 100644 --- a/docs/SeededGitHubDistribution.md +++ b/docs/SeededGitHubDistribution.md @@ -22,7 +22,7 @@ print SeededGitHubDistribution.to_json() # convert the object into a dict seeded_git_hub_distribution_dict = seeded_git_hub_distribution_instance.to_dict() # create an instance of SeededGitHubDistribution from a dict -seeded_git_hub_distribution_form_dict = seeded_git_hub_distribution.from_dict(seeded_git_hub_distribution_dict) +seeded_git_hub_distribution_from_dict = SeededGitHubDistribution.from_dict(seeded_git_hub_distribution_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/SeededGitHubGistDistribution.md b/docs/SeededGitHubGistDistribution.md index dd9d372..ab24851 100644 --- a/docs/SeededGitHubGistDistribution.md +++ b/docs/SeededGitHubGistDistribution.md @@ -26,7 +26,7 @@ print SeededGitHubGistDistribution.to_json() # convert the object into a dict seeded_git_hub_gist_distribution_dict = seeded_git_hub_gist_distribution_instance.to_dict() # create an instance of SeededGitHubGistDistribution from a dict -seeded_git_hub_gist_distribution_form_dict = seeded_git_hub_gist_distribution.from_dict(seeded_git_hub_gist_distribution_dict) +seeded_git_hub_gist_distribution_from_dict = SeededGitHubGistDistribution.from_dict(seeded_git_hub_gist_distribution_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/SeededGithubGistsImport.md b/docs/SeededGithubGistsImport.md index a5c4d39..1c22c06 100644 --- a/docs/SeededGithubGistsImport.md +++ b/docs/SeededGithubGistsImport.md @@ -24,7 +24,7 @@ print SeededGithubGistsImport.to_json() # convert the object into a dict seeded_github_gists_import_dict = seeded_github_gists_import_instance.to_dict() # create an instance of SeededGithubGistsImport from a dict -seeded_github_gists_import_form_dict = seeded_github_gists_import.from_dict(seeded_github_gists_import_dict) +seeded_github_gists_import_from_dict = SeededGithubGistsImport.from_dict(seeded_github_gists_import_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/SeededHint.md b/docs/SeededHint.md index cc5cb9c..a3ecb37 100644 --- a/docs/SeededHint.md +++ b/docs/SeededHint.md @@ -26,7 +26,7 @@ print SeededHint.to_json() # convert the object into a dict seeded_hint_dict = seeded_hint_instance.to_dict() # create an instance of SeededHint from a dict -seeded_hint_form_dict = seeded_hint.from_dict(seeded_hint_dict) +seeded_hint_from_dict = SeededHint.from_dict(seeded_hint_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/SeededMacOSAsset.md b/docs/SeededMacOSAsset.md index 4e8c310..40f5f6b 100644 --- a/docs/SeededMacOSAsset.md +++ b/docs/SeededMacOSAsset.md @@ -24,7 +24,7 @@ print SeededMacOSAsset.to_json() # convert the object into a dict seeded_mac_os_asset_dict = seeded_mac_os_asset_instance.to_dict() # create an instance of SeededMacOSAsset from a dict -seeded_mac_os_asset_form_dict = seeded_mac_os_asset.from_dict(seeded_mac_os_asset_dict) +seeded_mac_os_asset_from_dict = SeededMacOSAsset.from_dict(seeded_mac_os_asset_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/SeededModel.md b/docs/SeededModel.md index a0cfb07..faa0173 100644 --- a/docs/SeededModel.md +++ b/docs/SeededModel.md @@ -40,7 +40,7 @@ print SeededModel.to_json() # convert the object into a dict seeded_model_dict = seeded_model_instance.to_dict() # create an instance of SeededModel from a dict -seeded_model_form_dict = seeded_model.from_dict(seeded_model_dict) +seeded_model_from_dict = SeededModel.from_dict(seeded_model_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/SeededModels.md b/docs/SeededModels.md index 7d5fbb9..172bc93 100644 --- a/docs/SeededModels.md +++ b/docs/SeededModels.md @@ -23,7 +23,7 @@ print SeededModels.to_json() # convert the object into a dict seeded_models_dict = seeded_models_instance.to_dict() # create an instance of SeededModels from a dict -seeded_models_form_dict = seeded_models.from_dict(seeded_models_dict) +seeded_models_from_dict = SeededModels.from_dict(seeded_models_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/SeededPKCE.md b/docs/SeededPKCE.md index 21c3a9c..1c546a0 100644 --- a/docs/SeededPKCE.md +++ b/docs/SeededPKCE.md @@ -38,7 +38,7 @@ print SeededPKCE.to_json() # convert the object into a dict seeded_pkce_dict = seeded_pkce_instance.to_dict() # create an instance of SeededPKCE from a dict -seeded_pkce_form_dict = seeded_pkce.from_dict(seeded_pkce_dict) +seeded_pkce_from_dict = SeededPKCE.from_dict(seeded_pkce_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/SeededPKCEADDITIONALPARAMETERS.md b/docs/SeededPKCEADDITIONALPARAMETERS.md index df66a85..587595c 100644 --- a/docs/SeededPKCEADDITIONALPARAMETERS.md +++ b/docs/SeededPKCEADDITIONALPARAMETERS.md @@ -23,7 +23,7 @@ print SeededPKCEADDITIONALPARAMETERS.to_json() # convert the object into a dict seeded_pkceadditionalparameters_dict = seeded_pkceadditionalparameters_instance.to_dict() # create an instance of SeededPKCEADDITIONALPARAMETERS from a dict -seeded_pkceadditionalparameters_form_dict = seeded_pkceadditionalparameters.from_dict(seeded_pkceadditionalparameters_dict) +seeded_pkceadditionalparameters_from_dict = SeededPKCEADDITIONALPARAMETERS.from_dict(seeded_pkceadditionalparameters_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/SeededPerson.md b/docs/SeededPerson.md index 7ae87dc..6129402 100644 --- a/docs/SeededPerson.md +++ b/docs/SeededPerson.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **type** | [**PersonType**](PersonType.md) | | **model** | [**PersonModel**](PersonModel.md) | | [optional] **annotations** | [**List[SeededAnnotation]**](SeededAnnotation.md) | | [optional] +**anchors** | [**FlattenedAnchors**](FlattenedAnchors.md) | | [optional] ## Example @@ -28,7 +29,7 @@ print SeededPerson.to_json() # convert the object into a dict seeded_person_dict = seeded_person_instance.to_dict() # create an instance of SeededPerson from a dict -seeded_person_form_dict = seeded_person.from_dict(seeded_person_dict) +seeded_person_from_dict = SeededPerson.from_dict(seeded_person_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/SeededRange.md b/docs/SeededRange.md index e73b37b..ac74606 100644 --- a/docs/SeededRange.md +++ b/docs/SeededRange.md @@ -27,7 +27,7 @@ print SeededRange.to_json() # convert the object into a dict seeded_range_dict = seeded_range_instance.to_dict() # create an instance of SeededRange from a dict -seeded_range_form_dict = seeded_range.from_dict(seeded_range_dict) +seeded_range_from_dict = SeededRange.from_dict(seeded_range_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/SeededRangeConversationAssociation.md b/docs/SeededRangeConversationAssociation.md index f4d22aa..8fa4aaf 100644 --- a/docs/SeededRangeConversationAssociation.md +++ b/docs/SeededRangeConversationAssociation.md @@ -23,7 +23,7 @@ print SeededRangeConversationAssociation.to_json() # convert the object into a dict seeded_range_conversation_association_dict = seeded_range_conversation_association_instance.to_dict() # create an instance of SeededRangeConversationAssociation from a dict -seeded_range_conversation_association_form_dict = seeded_range_conversation_association.from_dict(seeded_range_conversation_association_dict) +seeded_range_conversation_association_from_dict = SeededRangeConversationAssociation.from_dict(seeded_range_conversation_association_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/SeededRangeConversationGroundingAssociation.md b/docs/SeededRangeConversationGroundingAssociation.md index 7b39c70..a447bb3 100644 --- a/docs/SeededRangeConversationGroundingAssociation.md +++ b/docs/SeededRangeConversationGroundingAssociation.md @@ -22,7 +22,7 @@ print SeededRangeConversationGroundingAssociation.to_json() # convert the object into a dict seeded_range_conversation_grounding_association_dict = seeded_range_conversation_grounding_association_instance.to_dict() # create an instance of SeededRangeConversationGroundingAssociation from a dict -seeded_range_conversation_grounding_association_form_dict = seeded_range_conversation_grounding_association.from_dict(seeded_range_conversation_grounding_association_dict) +seeded_range_conversation_grounding_association_from_dict = SeededRangeConversationGroundingAssociation.from_dict(seeded_range_conversation_grounding_association_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/SeededRangeConversationGroundingTemporalAssociation.md b/docs/SeededRangeConversationGroundingTemporalAssociation.md index a6342d7..9f03802 100644 --- a/docs/SeededRangeConversationGroundingTemporalAssociation.md +++ b/docs/SeededRangeConversationGroundingTemporalAssociation.md @@ -22,7 +22,7 @@ print SeededRangeConversationGroundingTemporalAssociation.to_json() # convert the object into a dict seeded_range_conversation_grounding_temporal_association_dict = seeded_range_conversation_grounding_temporal_association_instance.to_dict() # create an instance of SeededRangeConversationGroundingTemporalAssociation from a dict -seeded_range_conversation_grounding_temporal_association_form_dict = seeded_range_conversation_grounding_temporal_association.from_dict(seeded_range_conversation_grounding_temporal_association_dict) +seeded_range_conversation_grounding_temporal_association_from_dict = SeededRangeConversationGroundingTemporalAssociation.from_dict(seeded_range_conversation_grounding_temporal_association_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/SeededScore.md b/docs/SeededScore.md index 8b5cc54..76b675c 100644 --- a/docs/SeededScore.md +++ b/docs/SeededScore.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **update** | **bool** | | [optional] **reference** | **bool** | | [optional] **priority** | **bool** | | [optional] +**searched** | **bool** | | [optional] ## Example @@ -26,7 +27,7 @@ print SeededScore.to_json() # convert the object into a dict seeded_score_dict = seeded_score_instance.to_dict() # create an instance of SeededScore from a dict -seeded_score_form_dict = seeded_score.from_dict(seeded_score_dict) +seeded_score_from_dict = SeededScore.from_dict(seeded_score_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/SeededScoreIncrement.md b/docs/SeededScoreIncrement.md index 6761c0c..79c8a48 100644 --- a/docs/SeededScoreIncrement.md +++ b/docs/SeededScoreIncrement.md @@ -52,7 +52,7 @@ print SeededScoreIncrement.to_json() # convert the object into a dict seeded_score_increment_dict = seeded_score_increment_instance.to_dict() # create an instance of SeededScoreIncrement from a dict -seeded_score_increment_form_dict = seeded_score_increment.from_dict(seeded_score_increment_dict) +seeded_score_increment_from_dict = SeededScoreIncrement.from_dict(seeded_score_increment_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/SeededSensitive.md b/docs/SeededSensitive.md index 3d81ca2..7fb902f 100644 --- a/docs/SeededSensitive.md +++ b/docs/SeededSensitive.md @@ -30,7 +30,7 @@ print SeededSensitive.to_json() # convert the object into a dict seeded_sensitive_dict = seeded_sensitive_instance.to_dict() # create an instance of SeededSensitive from a dict -seeded_sensitive_form_dict = seeded_sensitive.from_dict(seeded_sensitive_dict) +seeded_sensitive_from_dict = SeededSensitive.from_dict(seeded_sensitive_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/SeededShare.md b/docs/SeededShare.md index a0b9c11..9676d23 100644 --- a/docs/SeededShare.md +++ b/docs/SeededShare.md @@ -27,7 +27,7 @@ print SeededShare.to_json() # convert the object into a dict seeded_share_dict = seeded_share_instance.to_dict() # create an instance of SeededShare from a dict -seeded_share_form_dict = seeded_share.from_dict(seeded_share_dict) +seeded_share_from_dict = SeededShare.from_dict(seeded_share_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/SeededTag.md b/docs/SeededTag.md index 9363bbf..4623837 100644 --- a/docs/SeededTag.md +++ b/docs/SeededTag.md @@ -27,7 +27,7 @@ print SeededTag.to_json() # convert the object into a dict seeded_tag_dict = seeded_tag_instance.to_dict() # create an instance of SeededTag from a dict -seeded_tag_form_dict = seeded_tag.from_dict(seeded_tag_dict) +seeded_tag_from_dict = SeededTag.from_dict(seeded_tag_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/SeededTrackedAdoptionEvent.md b/docs/SeededTrackedAdoptionEvent.md index 960f634..adaef8a 100644 --- a/docs/SeededTrackedAdoptionEvent.md +++ b/docs/SeededTrackedAdoptionEvent.md @@ -22,7 +22,7 @@ print SeededTrackedAdoptionEvent.to_json() # convert the object into a dict seeded_tracked_adoption_event_dict = seeded_tracked_adoption_event_instance.to_dict() # create an instance of SeededTrackedAdoptionEvent from a dict -seeded_tracked_adoption_event_form_dict = seeded_tracked_adoption_event.from_dict(seeded_tracked_adoption_event_dict) +seeded_tracked_adoption_event_from_dict = SeededTrackedAdoptionEvent.from_dict(seeded_tracked_adoption_event_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/SeededTrackedApplication.md b/docs/SeededTrackedApplication.md index 4cb11a0..f40cb65 100644 --- a/docs/SeededTrackedApplication.md +++ b/docs/SeededTrackedApplication.md @@ -28,7 +28,7 @@ print SeededTrackedApplication.to_json() # convert the object into a dict seeded_tracked_application_dict = seeded_tracked_application_instance.to_dict() # create an instance of SeededTrackedApplication from a dict -seeded_tracked_application_form_dict = seeded_tracked_application.from_dict(seeded_tracked_application_dict) +seeded_tracked_application_from_dict = SeededTrackedApplication.from_dict(seeded_tracked_application_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/SeededTrackedAssetEvent.md b/docs/SeededTrackedAssetEvent.md index 36bbc35..12d2b4f 100644 --- a/docs/SeededTrackedAssetEvent.md +++ b/docs/SeededTrackedAssetEvent.md @@ -25,7 +25,7 @@ print SeededTrackedAssetEvent.to_json() # convert the object into a dict seeded_tracked_asset_event_dict = seeded_tracked_asset_event_instance.to_dict() # create an instance of SeededTrackedAssetEvent from a dict -seeded_tracked_asset_event_form_dict = seeded_tracked_asset_event.from_dict(seeded_tracked_asset_event_dict) +seeded_tracked_asset_event_from_dict = SeededTrackedAssetEvent.from_dict(seeded_tracked_asset_event_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/SeededTrackedAssetsEvent.md b/docs/SeededTrackedAssetsEvent.md index fafb0d4..1b8e986 100644 --- a/docs/SeededTrackedAssetsEvent.md +++ b/docs/SeededTrackedAssetsEvent.md @@ -24,7 +24,7 @@ print SeededTrackedAssetsEvent.to_json() # convert the object into a dict seeded_tracked_assets_event_dict = seeded_tracked_assets_event_instance.to_dict() # create an instance of SeededTrackedAssetsEvent from a dict -seeded_tracked_assets_event_form_dict = seeded_tracked_assets_event.from_dict(seeded_tracked_assets_event_dict) +seeded_tracked_assets_event_from_dict = SeededTrackedAssetsEvent.from_dict(seeded_tracked_assets_event_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/SeededTrackedAssetsEventMetadata.md b/docs/SeededTrackedAssetsEventMetadata.md index 04e04f7..72e70ff 100644 --- a/docs/SeededTrackedAssetsEventMetadata.md +++ b/docs/SeededTrackedAssetsEventMetadata.md @@ -22,7 +22,7 @@ print SeededTrackedAssetsEventMetadata.to_json() # convert the object into a dict seeded_tracked_assets_event_metadata_dict = seeded_tracked_assets_event_metadata_instance.to_dict() # create an instance of SeededTrackedAssetsEventMetadata from a dict -seeded_tracked_assets_event_metadata_form_dict = seeded_tracked_assets_event_metadata.from_dict(seeded_tracked_assets_event_metadata_dict) +seeded_tracked_assets_event_metadata_from_dict = SeededTrackedAssetsEventMetadata.from_dict(seeded_tracked_assets_event_metadata_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/SeededTrackedConversationEvent.md b/docs/SeededTrackedConversationEvent.md index 77d54a0..b4f3395 100644 --- a/docs/SeededTrackedConversationEvent.md +++ b/docs/SeededTrackedConversationEvent.md @@ -25,7 +25,7 @@ print SeededTrackedConversationEvent.to_json() # convert the object into a dict seeded_tracked_conversation_event_dict = seeded_tracked_conversation_event_instance.to_dict() # create an instance of SeededTrackedConversationEvent from a dict -seeded_tracked_conversation_event_form_dict = seeded_tracked_conversation_event.from_dict(seeded_tracked_conversation_event_dict) +seeded_tracked_conversation_event_from_dict = SeededTrackedConversationEvent.from_dict(seeded_tracked_conversation_event_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/SeededTrackedFormatEvent.md b/docs/SeededTrackedFormatEvent.md index 48dcd21..ad4b398 100644 --- a/docs/SeededTrackedFormatEvent.md +++ b/docs/SeededTrackedFormatEvent.md @@ -25,7 +25,7 @@ print SeededTrackedFormatEvent.to_json() # convert the object into a dict seeded_tracked_format_event_dict = seeded_tracked_format_event_instance.to_dict() # create an instance of SeededTrackedFormatEvent from a dict -seeded_tracked_format_event_form_dict = seeded_tracked_format_event.from_dict(seeded_tracked_format_event_dict) +seeded_tracked_format_event_from_dict = SeededTrackedFormatEvent.from_dict(seeded_tracked_format_event_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/SeededTrackedInteractionEvent.md b/docs/SeededTrackedInteractionEvent.md index e93053f..02fe4b3 100644 --- a/docs/SeededTrackedInteractionEvent.md +++ b/docs/SeededTrackedInteractionEvent.md @@ -25,7 +25,7 @@ print SeededTrackedInteractionEvent.to_json() # convert the object into a dict seeded_tracked_interaction_event_dict = seeded_tracked_interaction_event_instance.to_dict() # create an instance of SeededTrackedInteractionEvent from a dict -seeded_tracked_interaction_event_form_dict = seeded_tracked_interaction_event.from_dict(seeded_tracked_interaction_event_dict) +seeded_tracked_interaction_event_from_dict = SeededTrackedInteractionEvent.from_dict(seeded_tracked_interaction_event_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/SeededTrackedInteractionEventIdentifierDescriptionPairs.md b/docs/SeededTrackedInteractionEventIdentifierDescriptionPairs.md index 594107e..9a0cd3c 100644 --- a/docs/SeededTrackedInteractionEventIdentifierDescriptionPairs.md +++ b/docs/SeededTrackedInteractionEventIdentifierDescriptionPairs.md @@ -22,7 +22,7 @@ print SeededTrackedInteractionEventIdentifierDescriptionPairs.to_json() # convert the object into a dict seeded_tracked_interaction_event_identifier_description_pairs_dict = seeded_tracked_interaction_event_identifier_description_pairs_instance.to_dict() # create an instance of SeededTrackedInteractionEventIdentifierDescriptionPairs from a dict -seeded_tracked_interaction_event_identifier_description_pairs_form_dict = seeded_tracked_interaction_event_identifier_description_pairs.from_dict(seeded_tracked_interaction_event_identifier_description_pairs_dict) +seeded_tracked_interaction_event_identifier_description_pairs_from_dict = SeededTrackedInteractionEventIdentifierDescriptionPairs.from_dict(seeded_tracked_interaction_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/SeededTrackedKeyboardEvent.md b/docs/SeededTrackedKeyboardEvent.md index 35ce0ee..334ee9d 100644 --- a/docs/SeededTrackedKeyboardEvent.md +++ b/docs/SeededTrackedKeyboardEvent.md @@ -25,7 +25,7 @@ print SeededTrackedKeyboardEvent.to_json() # convert the object into a dict seeded_tracked_keyboard_event_dict = seeded_tracked_keyboard_event_instance.to_dict() # create an instance of SeededTrackedKeyboardEvent from a dict -seeded_tracked_keyboard_event_form_dict = seeded_tracked_keyboard_event.from_dict(seeded_tracked_keyboard_event_dict) +seeded_tracked_keyboard_event_from_dict = SeededTrackedKeyboardEvent.from_dict(seeded_tracked_keyboard_event_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/SeededTrackedKeyboardEventIdentifierDescriptionPairs.md b/docs/SeededTrackedKeyboardEventIdentifierDescriptionPairs.md index 9e4ff54..16f4e5e 100644 --- a/docs/SeededTrackedKeyboardEventIdentifierDescriptionPairs.md +++ b/docs/SeededTrackedKeyboardEventIdentifierDescriptionPairs.md @@ -22,7 +22,7 @@ print SeededTrackedKeyboardEventIdentifierDescriptionPairs.to_json() # convert the object into a dict seeded_tracked_keyboard_event_identifier_description_pairs_dict = seeded_tracked_keyboard_event_identifier_description_pairs_instance.to_dict() # create an instance of SeededTrackedKeyboardEventIdentifierDescriptionPairs from a dict -seeded_tracked_keyboard_event_identifier_description_pairs_form_dict = seeded_tracked_keyboard_event_identifier_description_pairs.from_dict(seeded_tracked_keyboard_event_identifier_description_pairs_dict) +seeded_tracked_keyboard_event_identifier_description_pairs_from_dict = SeededTrackedKeyboardEventIdentifierDescriptionPairs.from_dict(seeded_tracked_keyboard_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/SeededTrackedMachineLearningEvent.md b/docs/SeededTrackedMachineLearningEvent.md index 206e3c6..7c2ce2b 100644 --- a/docs/SeededTrackedMachineLearningEvent.md +++ b/docs/SeededTrackedMachineLearningEvent.md @@ -23,7 +23,7 @@ print SeededTrackedMachineLearningEvent.to_json() # convert the object into a dict seeded_tracked_machine_learning_event_dict = seeded_tracked_machine_learning_event_instance.to_dict() # create an instance of SeededTrackedMachineLearningEvent from a dict -seeded_tracked_machine_learning_event_form_dict = seeded_tracked_machine_learning_event.from_dict(seeded_tracked_machine_learning_event_dict) +seeded_tracked_machine_learning_event_from_dict = SeededTrackedMachineLearningEvent.from_dict(seeded_tracked_machine_learning_event_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/SeededTrackedSessionEvent.md b/docs/SeededTrackedSessionEvent.md index 70ae656..e47c2d7 100644 --- a/docs/SeededTrackedSessionEvent.md +++ b/docs/SeededTrackedSessionEvent.md @@ -23,7 +23,7 @@ print SeededTrackedSessionEvent.to_json() # convert the object into a dict seeded_tracked_session_event_dict = seeded_tracked_session_event_instance.to_dict() # create an instance of SeededTrackedSessionEvent from a dict -seeded_tracked_session_event_form_dict = seeded_tracked_session_event.from_dict(seeded_tracked_session_event_dict) +seeded_tracked_session_event_from_dict = SeededTrackedSessionEvent.from_dict(seeded_tracked_session_event_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/SeededUltraSuiteAsset.md b/docs/SeededUltraSuiteAsset.md index a8f2619..1c0c515 100644 --- a/docs/SeededUltraSuiteAsset.md +++ b/docs/SeededUltraSuiteAsset.md @@ -26,7 +26,7 @@ print SeededUltraSuiteAsset.to_json() # convert the object into a dict seeded_ultra_suite_asset_dict = seeded_ultra_suite_asset_instance.to_dict() # create an instance of SeededUltraSuiteAsset from a dict -seeded_ultra_suite_asset_form_dict = seeded_ultra_suite_asset.from_dict(seeded_ultra_suite_asset_dict) +seeded_ultra_suite_asset_from_dict = SeededUltraSuiteAsset.from_dict(seeded_ultra_suite_asset_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/SeededUser.md b/docs/SeededUser.md index 1798d4d..16dcb37 100644 --- a/docs/SeededUser.md +++ b/docs/SeededUser.md @@ -23,7 +23,7 @@ print SeededUser.to_json() # convert the object into a dict seeded_user_dict = seeded_user_instance.to_dict() # create an instance of SeededUser from a dict -seeded_user_form_dict = seeded_user.from_dict(seeded_user_dict) +seeded_user_from_dict = SeededUser.from_dict(seeded_user_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/SeededWebsite.md b/docs/SeededWebsite.md index b87647d..ecfa971 100644 --- a/docs/SeededWebsite.md +++ b/docs/SeededWebsite.md @@ -28,7 +28,7 @@ print SeededWebsite.to_json() # convert the object into a dict seeded_website_dict = seeded_website_instance.to_dict() # create an instance of SeededWebsite from a dict -seeded_website_form_dict = seeded_website.from_dict(seeded_website_dict) +seeded_website_from_dict = SeededWebsite.from_dict(seeded_website_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/SeededWorkstreamEvent.md b/docs/SeededWorkstreamEvent.md index 2d356bb..19814f8 100644 --- a/docs/SeededWorkstreamEvent.md +++ b/docs/SeededWorkstreamEvent.md @@ -28,7 +28,7 @@ print SeededWorkstreamEvent.to_json() # convert the object into a dict seeded_workstream_event_dict = seeded_workstream_event_instance.to_dict() # create an instance of SeededWorkstreamEvent from a dict -seeded_workstream_event_form_dict = seeded_workstream_event.from_dict(seeded_workstream_event_dict) +seeded_workstream_event_from_dict = SeededWorkstreamEvent.from_dict(seeded_workstream_event_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/SeededWorkstreamIngestion.md b/docs/SeededWorkstreamIngestion.md index 0bd0673..d58ff11 100644 --- a/docs/SeededWorkstreamIngestion.md +++ b/docs/SeededWorkstreamIngestion.md @@ -23,7 +23,7 @@ print SeededWorkstreamIngestion.to_json() # convert the object into a dict seeded_workstream_ingestion_dict = seeded_workstream_ingestion_instance.to_dict() # create an instance of SeededWorkstreamIngestion from a dict -seeded_workstream_ingestion_form_dict = seeded_workstream_ingestion.from_dict(seeded_workstream_ingestion_dict) +seeded_workstream_ingestion_from_dict = SeededWorkstreamIngestion.from_dict(seeded_workstream_ingestion_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/SeededWorkstreamSuggestionsRefresh.md b/docs/SeededWorkstreamSuggestionsRefresh.md index 6e2957a..4b8f487 100644 --- a/docs/SeededWorkstreamSuggestionsRefresh.md +++ b/docs/SeededWorkstreamSuggestionsRefresh.md @@ -24,7 +24,7 @@ print SeededWorkstreamSuggestionsRefresh.to_json() # convert the object into a dict seeded_workstream_suggestions_refresh_dict = seeded_workstream_suggestions_refresh_instance.to_dict() # create an instance of SeededWorkstreamSuggestionsRefresh from a dict -seeded_workstream_suggestions_refresh_form_dict = seeded_workstream_suggestions_refresh.from_dict(seeded_workstream_suggestions_refresh_dict) +seeded_workstream_suggestions_refresh_from_dict = SeededWorkstreamSuggestionsRefresh.from_dict(seeded_workstream_suggestions_refresh_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/SeededWorkstreamSummary.md b/docs/SeededWorkstreamSummary.md index f346d0d..efc2e3b 100644 --- a/docs/SeededWorkstreamSummary.md +++ b/docs/SeededWorkstreamSummary.md @@ -33,7 +33,7 @@ print SeededWorkstreamSummary.to_json() # convert the object into a dict seeded_workstream_summary_dict = seeded_workstream_summary_instance.to_dict() # create an instance of SeededWorkstreamSummary from a dict -seeded_workstream_summary_form_dict = seeded_workstream_summary.from_dict(seeded_workstream_summary_dict) +seeded_workstream_summary_from_dict = SeededWorkstreamSummary.from_dict(seeded_workstream_summary_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/Seeds.md b/docs/Seeds.md index 105feb7..2b0ee12 100644 --- a/docs/Seeds.md +++ b/docs/Seeds.md @@ -23,7 +23,7 @@ print Seeds.to_json() # convert the object into a dict seeds_dict = seeds_instance.to_dict() # create an instance of Seeds from a dict -seeds_form_dict = seeds.from_dict(seeds_dict) +seeds_from_dict = Seeds.from_dict(seeds_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/SegmentedTechnicalLanguage.md b/docs/SegmentedTechnicalLanguage.md index d48eb71..6d86a6f 100644 --- a/docs/SegmentedTechnicalLanguage.md +++ b/docs/SegmentedTechnicalLanguage.md @@ -23,7 +23,7 @@ print SegmentedTechnicalLanguage.to_json() # convert the object into a dict segmented_technical_language_dict = segmented_technical_language_instance.to_dict() # create an instance of SegmentedTechnicalLanguage from a dict -segmented_technical_language_form_dict = segmented_technical_language.from_dict(segmented_technical_language_dict) +segmented_technical_language_from_dict = SegmentedTechnicalLanguage.from_dict(segmented_technical_language_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/SegmentedTechnicalLanguageFragment.md b/docs/SegmentedTechnicalLanguageFragment.md index d44bd47..746ff2e 100644 --- a/docs/SegmentedTechnicalLanguageFragment.md +++ b/docs/SegmentedTechnicalLanguageFragment.md @@ -25,7 +25,7 @@ print SegmentedTechnicalLanguageFragment.to_json() # convert the object into a dict segmented_technical_language_fragment_dict = segmented_technical_language_fragment_instance.to_dict() # create an instance of SegmentedTechnicalLanguageFragment from a dict -segmented_technical_language_fragment_form_dict = segmented_technical_language_fragment.from_dict(segmented_technical_language_fragment_dict) +segmented_technical_language_fragment_from_dict = SegmentedTechnicalLanguageFragment.from_dict(segmented_technical_language_fragment_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/Sensitive.md b/docs/Sensitive.md index f21a3b5..d132392 100644 --- a/docs/Sensitive.md +++ b/docs/Sensitive.md @@ -36,7 +36,7 @@ print Sensitive.to_json() # convert the object into a dict sensitive_dict = sensitive_instance.to_dict() # create an instance of Sensitive from a dict -sensitive_form_dict = sensitive.from_dict(sensitive_dict) +sensitive_from_dict = Sensitive.from_dict(sensitive_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/SensitiveMetadata.md b/docs/SensitiveMetadata.md index da74067..bfdb57b 100644 --- a/docs/SensitiveMetadata.md +++ b/docs/SensitiveMetadata.md @@ -24,7 +24,7 @@ print SensitiveMetadata.to_json() # convert the object into a dict sensitive_metadata_dict = sensitive_metadata_instance.to_dict() # create an instance of SensitiveMetadata from a dict -sensitive_metadata_form_dict = sensitive_metadata.from_dict(sensitive_metadata_dict) +sensitive_metadata_from_dict = SensitiveMetadata.from_dict(sensitive_metadata_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/Sensitives.md b/docs/Sensitives.md index 36eec15..71f457e 100644 --- a/docs/Sensitives.md +++ b/docs/Sensitives.md @@ -24,7 +24,7 @@ print Sensitives.to_json() # convert the object into a dict sensitives_dict = sensitives_instance.to_dict() # create an instance of Sensitives from a dict -sensitives_form_dict = sensitives.from_dict(sensitives_dict) +sensitives_from_dict = Sensitives.from_dict(sensitives_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/SensitivesApi.md b/docs/SensitivesApi.md index aca256a..d3347d5 100644 --- a/docs/SensitivesApi.md +++ b/docs/SensitivesApi.md @@ -4,11 +4,83 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**search_sensitives**](SensitivesApi.md#search_sensitives) | **POST** /sensitives/search | /sensitives/search [POST] [**sensitives_create_new_sensitive**](SensitivesApi.md#sensitives_create_new_sensitive) | **POST** /sensitives/create | /sensitives/create [POST] [**sensitives_delete_sensitive**](SensitivesApi.md#sensitives_delete_sensitive) | **POST** /sensitives/{sensitive}/delete | /sensitives/{sensitive}/delete [POST] [**sensitives_snapshot**](SensitivesApi.md#sensitives_snapshot) | **GET** /sensitives | /sensitives [GET] +# **search_sensitives** +> SearchedSensitives search_sensitives(transferables=transferables, search_input=search_input) + +/sensitives/search [POST] + +This will search your sensitives for a specific sensitive note: we will search the value of the sensitive + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_sensitives import SearchedSensitives +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.SensitivesApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /sensitives/search [POST] + api_response = api_instance.search_sensitives(transferables=transferables, search_input=search_input) + print("The response of SensitivesApi->search_sensitives:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SensitivesApi->search_sensitives: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedSensitives**](SearchedSensitives.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **sensitives_create_new_sensitive** > Sensitive sensitives_create_new_sensitive(seeded_sensitive=seeded_sensitive) diff --git a/docs/Session.md b/docs/Session.md index d0485c4..287a723 100644 --- a/docs/Session.md +++ b/docs/Session.md @@ -24,7 +24,7 @@ print Session.to_json() # convert the object into a dict session_dict = session_instance.to_dict() # create an instance of Session from a dict -session_form_dict = session.from_dict(session_dict) +session_from_dict = Session.from_dict(session_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/Share.md b/docs/Share.md index 8095fa9..39c1734 100644 --- a/docs/Share.md +++ b/docs/Share.md @@ -34,7 +34,7 @@ print Share.to_json() # convert the object into a dict share_dict = share_instance.to_dict() # create an instance of Share from a dict -share_form_dict = share.from_dict(share_dict) +share_from_dict = Share.from_dict(share_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/Shares.md b/docs/Shares.md index 6c2a712..5ea2bc2 100644 --- a/docs/Shares.md +++ b/docs/Shares.md @@ -24,7 +24,7 @@ print Shares.to_json() # convert the object into a dict shares_dict = shares_instance.to_dict() # create an instance of Shares from a dict -shares_form_dict = shares.from_dict(shares_dict) +shares_from_dict = Shares.from_dict(shares_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/Space.md b/docs/Space.md index 4cdbefb..e3ebd55 100644 --- a/docs/Space.md +++ b/docs/Space.md @@ -23,7 +23,7 @@ print Space.to_json() # convert the object into a dict space_dict = space_instance.to_dict() # create an instance of Space from a dict -space_form_dict = space.from_dict(space_dict) +space_from_dict = Space.from_dict(space_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/StreamedIdentifier.md b/docs/StreamedIdentifier.md index c2ad132..33bb838 100644 --- a/docs/StreamedIdentifier.md +++ b/docs/StreamedIdentifier.md @@ -24,7 +24,7 @@ print StreamedIdentifier.to_json() # convert the object into a dict streamed_identifier_dict = streamed_identifier_instance.to_dict() # create an instance of StreamedIdentifier from a dict -streamed_identifier_form_dict = streamed_identifier.from_dict(streamed_identifier_dict) +streamed_identifier_from_dict = StreamedIdentifier.from_dict(streamed_identifier_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/StreamedIdentifiers.md b/docs/StreamedIdentifiers.md index ff04412..8eec791 100644 --- a/docs/StreamedIdentifiers.md +++ b/docs/StreamedIdentifiers.md @@ -23,7 +23,7 @@ print StreamedIdentifiers.to_json() # convert the object into a dict streamed_identifiers_dict = streamed_identifiers_instance.to_dict() # create an instance of StreamedIdentifiers from a dict -streamed_identifiers_form_dict = streamed_identifiers.from_dict(streamed_identifiers_dict) +streamed_identifiers_from_dict = StreamedIdentifiers.from_dict(streamed_identifiers_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/Suggestion.md b/docs/Suggestion.md index 21a1457..eb22ec7 100644 --- a/docs/Suggestion.md +++ b/docs/Suggestion.md @@ -27,7 +27,7 @@ print Suggestion.to_json() # convert the object into a dict suggestion_dict = suggestion_instance.to_dict() # create an instance of Suggestion from a dict -suggestion_form_dict = suggestion.from_dict(suggestion_dict) +suggestion_from_dict = Suggestion.from_dict(suggestion_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/SuggestionTarget.md b/docs/SuggestionTarget.md index fc4a64c..b8d71de 100644 --- a/docs/SuggestionTarget.md +++ b/docs/SuggestionTarget.md @@ -24,7 +24,7 @@ print SuggestionTarget.to_json() # convert the object into a dict suggestion_target_dict = suggestion_target_instance.to_dict() # create an instance of SuggestionTarget from a dict -suggestion_target_form_dict = suggestion_target.from_dict(suggestion_target_dict) +suggestion_target_from_dict = SuggestionTarget.from_dict(suggestion_target_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/SystemExecutionCpuInformation.md b/docs/SystemExecutionCpuInformation.md index d8dc2e9..5e1a558 100644 --- a/docs/SystemExecutionCpuInformation.md +++ b/docs/SystemExecutionCpuInformation.md @@ -23,7 +23,7 @@ print SystemExecutionCpuInformation.to_json() # convert the object into a dict system_execution_cpu_information_dict = system_execution_cpu_information_instance.to_dict() # create an instance of SystemExecutionCpuInformation from a dict -system_execution_cpu_information_form_dict = system_execution_cpu_information.from_dict(system_execution_cpu_information_dict) +system_execution_cpu_information_from_dict = SystemExecutionCpuInformation.from_dict(system_execution_cpu_information_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/SystemExecutionInformation.md b/docs/SystemExecutionInformation.md index 5e0c078..c6cacbb 100644 --- a/docs/SystemExecutionInformation.md +++ b/docs/SystemExecutionInformation.md @@ -25,7 +25,7 @@ print SystemExecutionInformation.to_json() # convert the object into a dict system_execution_information_dict = system_execution_information_instance.to_dict() # create an instance of SystemExecutionInformation from a dict -system_execution_information_form_dict = system_execution_information.from_dict(system_execution_information_dict) +system_execution_information_from_dict = SystemExecutionInformation.from_dict(system_execution_information_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/TLPCodeDirectoryAnalytics.md b/docs/TLPCodeDirectoryAnalytics.md index f086e4a..9d037a1 100644 --- a/docs/TLPCodeDirectoryAnalytics.md +++ b/docs/TLPCodeDirectoryAnalytics.md @@ -22,7 +22,7 @@ print TLPCodeDirectoryAnalytics.to_json() # convert the object into a dict tlp_code_directory_analytics_dict = tlp_code_directory_analytics_instance.to_dict() # create an instance of TLPCodeDirectoryAnalytics from a dict -tlp_code_directory_analytics_form_dict = tlp_code_directory_analytics.from_dict(tlp_code_directory_analytics_dict) +tlp_code_directory_analytics_from_dict = TLPCodeDirectoryAnalytics.from_dict(tlp_code_directory_analytics_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/TLPCodeFileAnalytics.md b/docs/TLPCodeFileAnalytics.md index 1827b7a..c670696 100644 --- a/docs/TLPCodeFileAnalytics.md +++ b/docs/TLPCodeFileAnalytics.md @@ -22,7 +22,7 @@ print TLPCodeFileAnalytics.to_json() # convert the object into a dict tlp_code_file_analytics_dict = tlp_code_file_analytics_instance.to_dict() # create an instance of TLPCodeFileAnalytics from a dict -tlp_code_file_analytics_form_dict = tlp_code_file_analytics.from_dict(tlp_code_file_analytics_dict) +tlp_code_file_analytics_from_dict = TLPCodeFileAnalytics.from_dict(tlp_code_file_analytics_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/TLPCodeFragmentClassification.md b/docs/TLPCodeFragmentClassification.md index 8eddccc..d0d46f8 100644 --- a/docs/TLPCodeFragmentClassification.md +++ b/docs/TLPCodeFragmentClassification.md @@ -33,7 +33,7 @@ print TLPCodeFragmentClassification.to_json() # convert the object into a dict tlp_code_fragment_classification_dict = tlp_code_fragment_classification_instance.to_dict() # create an instance of TLPCodeFragmentClassification from a dict -tlp_code_fragment_classification_form_dict = tlp_code_fragment_classification.from_dict(tlp_code_fragment_classification_dict) +tlp_code_fragment_classification_from_dict = TLPCodeFragmentClassification.from_dict(tlp_code_fragment_classification_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/TLPCodeFragmentClassificationMetadata.md b/docs/TLPCodeFragmentClassificationMetadata.md index 0f1e185..31eb202 100644 --- a/docs/TLPCodeFragmentClassificationMetadata.md +++ b/docs/TLPCodeFragmentClassificationMetadata.md @@ -23,7 +23,7 @@ print TLPCodeFragmentClassificationMetadata.to_json() # convert the object into a dict tlp_code_fragment_classification_metadata_dict = tlp_code_fragment_classification_metadata_instance.to_dict() # create an instance of TLPCodeFragmentClassificationMetadata from a dict -tlp_code_fragment_classification_metadata_form_dict = tlp_code_fragment_classification_metadata.from_dict(tlp_code_fragment_classification_metadata_dict) +tlp_code_fragment_classification_metadata_from_dict = TLPCodeFragmentClassificationMetadata.from_dict(tlp_code_fragment_classification_metadata_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/TLPCodeFragmentDescription.md b/docs/TLPCodeFragmentDescription.md index 6ae195d..96ea446 100644 --- a/docs/TLPCodeFragmentDescription.md +++ b/docs/TLPCodeFragmentDescription.md @@ -29,7 +29,7 @@ print TLPCodeFragmentDescription.to_json() # convert the object into a dict tlp_code_fragment_description_dict = tlp_code_fragment_description_instance.to_dict() # create an instance of TLPCodeFragmentDescription from a dict -tlp_code_fragment_description_form_dict = tlp_code_fragment_description.from_dict(tlp_code_fragment_description_dict) +tlp_code_fragment_description_from_dict = TLPCodeFragmentDescription.from_dict(tlp_code_fragment_description_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/TLPCodeFragmentDescriptiveStatistics.md b/docs/TLPCodeFragmentDescriptiveStatistics.md index 3f5fb63..efbac26 100644 --- a/docs/TLPCodeFragmentDescriptiveStatistics.md +++ b/docs/TLPCodeFragmentDescriptiveStatistics.md @@ -31,7 +31,7 @@ print TLPCodeFragmentDescriptiveStatistics.to_json() # convert the object into a dict tlp_code_fragment_descriptive_statistics_dict = tlp_code_fragment_descriptive_statistics_instance.to_dict() # create an instance of TLPCodeFragmentDescriptiveStatistics from a dict -tlp_code_fragment_descriptive_statistics_form_dict = tlp_code_fragment_descriptive_statistics.from_dict(tlp_code_fragment_descriptive_statistics_dict) +tlp_code_fragment_descriptive_statistics_from_dict = TLPCodeFragmentDescriptiveStatistics.from_dict(tlp_code_fragment_descriptive_statistics_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/TLPCodeFragmentReclassification.md b/docs/TLPCodeFragmentReclassification.md index c89fa08..39c63ea 100644 --- a/docs/TLPCodeFragmentReclassification.md +++ b/docs/TLPCodeFragmentReclassification.md @@ -28,7 +28,7 @@ print TLPCodeFragmentReclassification.to_json() # convert the object into a dict tlp_code_fragment_reclassification_dict = tlp_code_fragment_reclassification_instance.to_dict() # create an instance of TLPCodeFragmentReclassification from a dict -tlp_code_fragment_reclassification_form_dict = tlp_code_fragment_reclassification.from_dict(tlp_code_fragment_reclassification_dict) +tlp_code_fragment_reclassification_from_dict = TLPCodeFragmentReclassification.from_dict(tlp_code_fragment_reclassification_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/TLPCodeFragmentReclassificationUpdates.md b/docs/TLPCodeFragmentReclassificationUpdates.md index 624a492..706dcf7 100644 --- a/docs/TLPCodeFragmentReclassificationUpdates.md +++ b/docs/TLPCodeFragmentReclassificationUpdates.md @@ -23,7 +23,7 @@ print TLPCodeFragmentReclassificationUpdates.to_json() # convert the object into a dict tlp_code_fragment_reclassification_updates_dict = tlp_code_fragment_reclassification_updates_instance.to_dict() # create an instance of TLPCodeFragmentReclassificationUpdates from a dict -tlp_code_fragment_reclassification_updates_form_dict = tlp_code_fragment_reclassification_updates.from_dict(tlp_code_fragment_reclassification_updates_dict) +tlp_code_fragment_reclassification_updates_from_dict = TLPCodeFragmentReclassificationUpdates.from_dict(tlp_code_fragment_reclassification_updates_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/TLPCodeFragmentStatistics.md b/docs/TLPCodeFragmentStatistics.md index 52ea868..c4cd901 100644 --- a/docs/TLPCodeFragmentStatistics.md +++ b/docs/TLPCodeFragmentStatistics.md @@ -22,7 +22,7 @@ print TLPCodeFragmentStatistics.to_json() # convert the object into a dict tlp_code_fragment_statistics_dict = tlp_code_fragment_statistics_instance.to_dict() # create an instance of TLPCodeFragmentStatistics from a dict -tlp_code_fragment_statistics_form_dict = tlp_code_fragment_statistics.from_dict(tlp_code_fragment_statistics_dict) +tlp_code_fragment_statistics_from_dict = TLPCodeFragmentStatistics.from_dict(tlp_code_fragment_statistics_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/TLPCodeFragmentSuggestedReuse.md b/docs/TLPCodeFragmentSuggestedReuse.md index 6287390..232d532 100644 --- a/docs/TLPCodeFragmentSuggestedReuse.md +++ b/docs/TLPCodeFragmentSuggestedReuse.md @@ -22,7 +22,7 @@ print TLPCodeFragmentSuggestedReuse.to_json() # convert the object into a dict tlp_code_fragment_suggested_reuse_dict = tlp_code_fragment_suggested_reuse_instance.to_dict() # create an instance of TLPCodeFragmentSuggestedReuse from a dict -tlp_code_fragment_suggested_reuse_form_dict = tlp_code_fragment_suggested_reuse.from_dict(tlp_code_fragment_suggested_reuse_dict) +tlp_code_fragment_suggested_reuse_from_dict = TLPCodeFragmentSuggestedReuse.from_dict(tlp_code_fragment_suggested_reuse_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/TLPCodeFragmentSuggestedSave.md b/docs/TLPCodeFragmentSuggestedSave.md index 2b3f72a..17dcaf1 100644 --- a/docs/TLPCodeFragmentSuggestedSave.md +++ b/docs/TLPCodeFragmentSuggestedSave.md @@ -30,7 +30,7 @@ print TLPCodeFragmentSuggestedSave.to_json() # convert the object into a dict tlp_code_fragment_suggested_save_dict = tlp_code_fragment_suggested_save_instance.to_dict() # create an instance of TLPCodeFragmentSuggestedSave from a dict -tlp_code_fragment_suggested_save_form_dict = tlp_code_fragment_suggested_save.from_dict(tlp_code_fragment_suggested_save_dict) +tlp_code_fragment_suggested_save_from_dict = TLPCodeFragmentSuggestedSave.from_dict(tlp_code_fragment_suggested_save_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/TLPCodeFragmentTagify.md b/docs/TLPCodeFragmentTagify.md index 9a4dabf..e12693b 100644 --- a/docs/TLPCodeFragmentTagify.md +++ b/docs/TLPCodeFragmentTagify.md @@ -22,7 +22,7 @@ print TLPCodeFragmentTagify.to_json() # convert the object into a dict tlp_code_fragment_tagify_dict = tlp_code_fragment_tagify_instance.to_dict() # create an instance of TLPCodeFragmentTagify from a dict -tlp_code_fragment_tagify_form_dict = tlp_code_fragment_tagify.from_dict(tlp_code_fragment_tagify_dict) +tlp_code_fragment_tagify_from_dict = TLPCodeFragmentTagify.from_dict(tlp_code_fragment_tagify_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/TLPCodeProcessing.md b/docs/TLPCodeProcessing.md index 9bcc6a2..c546137 100644 --- a/docs/TLPCodeProcessing.md +++ b/docs/TLPCodeProcessing.md @@ -25,7 +25,7 @@ print TLPCodeProcessing.to_json() # convert the object into a dict tlp_code_processing_dict = tlp_code_processing_instance.to_dict() # create an instance of TLPCodeProcessing from a dict -tlp_code_processing_form_dict = tlp_code_processing.from_dict(tlp_code_processing_dict) +tlp_code_processing_from_dict = TLPCodeProcessing.from_dict(tlp_code_processing_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/TLPCodeRepositoryAnalytics.md b/docs/TLPCodeRepositoryAnalytics.md index 400d37a..f5c2d73 100644 --- a/docs/TLPCodeRepositoryAnalytics.md +++ b/docs/TLPCodeRepositoryAnalytics.md @@ -22,7 +22,7 @@ print TLPCodeRepositoryAnalytics.to_json() # convert the object into a dict tlp_code_repository_analytics_dict = tlp_code_repository_analytics_instance.to_dict() # create an instance of TLPCodeRepositoryAnalytics from a dict -tlp_code_repository_analytics_form_dict = tlp_code_repository_analytics.from_dict(tlp_code_repository_analytics_dict) +tlp_code_repository_analytics_from_dict = TLPCodeRepositoryAnalytics.from_dict(tlp_code_repository_analytics_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/TLPCodeSnippetAnalytics.md b/docs/TLPCodeSnippetAnalytics.md index 3464015..d602997 100644 --- a/docs/TLPCodeSnippetAnalytics.md +++ b/docs/TLPCodeSnippetAnalytics.md @@ -27,7 +27,7 @@ print TLPCodeSnippetAnalytics.to_json() # convert the object into a dict tlp_code_snippet_analytics_dict = tlp_code_snippet_analytics_instance.to_dict() # create an instance of TLPCodeSnippetAnalytics from a dict -tlp_code_snippet_analytics_form_dict = tlp_code_snippet_analytics.from_dict(tlp_code_snippet_analytics_dict) +tlp_code_snippet_analytics_from_dict = TLPCodeSnippetAnalytics.from_dict(tlp_code_snippet_analytics_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/TLPCodeSnippetSuggestedInteractions.md b/docs/TLPCodeSnippetSuggestedInteractions.md index c2ac894..e82f3f8 100644 --- a/docs/TLPCodeSnippetSuggestedInteractions.md +++ b/docs/TLPCodeSnippetSuggestedInteractions.md @@ -23,7 +23,7 @@ print TLPCodeSnippetSuggestedInteractions.to_json() # convert the object into a dict tlp_code_snippet_suggested_interactions_dict = tlp_code_snippet_suggested_interactions_instance.to_dict() # create an instance of TLPCodeSnippetSuggestedInteractions from a dict -tlp_code_snippet_suggested_interactions_form_dict = tlp_code_snippet_suggested_interactions.from_dict(tlp_code_snippet_suggested_interactions_dict) +tlp_code_snippet_suggested_interactions_from_dict = TLPCodeSnippetSuggestedInteractions.from_dict(tlp_code_snippet_suggested_interactions_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/TLPCodeSnippetTagifyCode.md b/docs/TLPCodeSnippetTagifyCode.md index a7948af..e375441 100644 --- a/docs/TLPCodeSnippetTagifyCode.md +++ b/docs/TLPCodeSnippetTagifyCode.md @@ -32,7 +32,7 @@ print TLPCodeSnippetTagifyCode.to_json() # convert the object into a dict tlp_code_snippet_tagify_code_dict = tlp_code_snippet_tagify_code_instance.to_dict() # create an instance of TLPCodeSnippetTagifyCode from a dict -tlp_code_snippet_tagify_code_form_dict = tlp_code_snippet_tagify_code.from_dict(tlp_code_snippet_tagify_code_dict) +tlp_code_snippet_tagify_code_from_dict = TLPCodeSnippetTagifyCode.from_dict(tlp_code_snippet_tagify_code_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/TLPDirectedDiscoveryFilter.md b/docs/TLPDirectedDiscoveryFilter.md index 1dfcd82..e904167 100644 --- a/docs/TLPDirectedDiscoveryFilter.md +++ b/docs/TLPDirectedDiscoveryFilter.md @@ -22,7 +22,7 @@ print TLPDirectedDiscoveryFilter.to_json() # convert the object into a dict tlp_directed_discovery_filter_dict = tlp_directed_discovery_filter_instance.to_dict() # create an instance of TLPDirectedDiscoveryFilter from a dict -tlp_directed_discovery_filter_form_dict = tlp_directed_discovery_filter.from_dict(tlp_directed_discovery_filter_dict) +tlp_directed_discovery_filter_from_dict = TLPDirectedDiscoveryFilter.from_dict(tlp_directed_discovery_filter_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/TLPDirectedDiscoveryFilters.md b/docs/TLPDirectedDiscoveryFilters.md index e07ba51..2fac000 100644 --- a/docs/TLPDirectedDiscoveryFilters.md +++ b/docs/TLPDirectedDiscoveryFilters.md @@ -22,7 +22,7 @@ print TLPDirectedDiscoveryFilters.to_json() # convert the object into a dict tlp_directed_discovery_filters_dict = tlp_directed_discovery_filters_instance.to_dict() # create an instance of TLPDirectedDiscoveryFilters from a dict -tlp_directed_discovery_filters_form_dict = tlp_directed_discovery_filters.from_dict(tlp_directed_discovery_filters_dict) +tlp_directed_discovery_filters_from_dict = TLPDirectedDiscoveryFilters.from_dict(tlp_directed_discovery_filters_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/TLPMachineLearningProcessingEvent.md b/docs/TLPMachineLearningProcessingEvent.md index aa243e8..75438ff 100644 --- a/docs/TLPMachineLearningProcessingEvent.md +++ b/docs/TLPMachineLearningProcessingEvent.md @@ -22,7 +22,7 @@ print TLPMachineLearningProcessingEvent.to_json() # convert the object into a dict tlp_machine_learning_processing_event_dict = tlp_machine_learning_processing_event_instance.to_dict() # create an instance of TLPMachineLearningProcessingEvent from a dict -tlp_machine_learning_processing_event_form_dict = tlp_machine_learning_processing_event.from_dict(tlp_machine_learning_processing_event_dict) +tlp_machine_learning_processing_event_from_dict = TLPMachineLearningProcessingEvent.from_dict(tlp_machine_learning_processing_event_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/Tag.md b/docs/Tag.md index eca1a4c..0ca7943 100644 --- a/docs/Tag.md +++ b/docs/Tag.md @@ -34,7 +34,7 @@ print Tag.to_json() # convert the object into a dict tag_dict = tag_instance.to_dict() # create an instance of Tag from a dict -tag_form_dict = tag.from_dict(tag_dict) +tag_from_dict = Tag.from_dict(tag_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/Tags.md b/docs/Tags.md index 31ce89f..1c1ed11 100644 --- a/docs/Tags.md +++ b/docs/Tags.md @@ -25,7 +25,7 @@ print Tags.to_json() # convert the object into a dict tags_dict = tags_instance.to_dict() # create an instance of Tags from a dict -tags_form_dict = tags.from_dict(tags_dict) +tags_from_dict = Tags.from_dict(tags_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/TagsApi.md b/docs/TagsApi.md index 4a5a3f2..ac88a2e 100644 --- a/docs/TagsApi.md +++ b/docs/TagsApi.md @@ -4,12 +4,84 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**search_tags**](TagsApi.md#search_tags) | **POST** /tags/search | /tags/search [POST] [**tags_create_new_tag**](TagsApi.md#tags_create_new_tag) | **POST** /tags/create | /tags/create [POST] [**tags_delete_specific_tag**](TagsApi.md#tags_delete_specific_tag) | **POST** /tags/{tag}/delete | /tags/{tag}/delete [POST] [**tags_exists**](TagsApi.md#tags_exists) | **POST** /tags/exists | /tags/exists [POST] [**tags_snapshot**](TagsApi.md#tags_snapshot) | **GET** /tags | /tags [GET] +# **search_tags** +> SearchedTags search_tags(transferables=transferables, search_input=search_input) + +/tags/search [POST] + +This will search your tags for a specific tag + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_tags import SearchedTags +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.TagsApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /tags/search [POST] + api_response = api_instance.search_tags(transferables=transferables, search_input=search_input) + print("The response of TagsApi->search_tags:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->search_tags: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedTags**](SearchedTags.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **tags_create_new_tag** > Tag tags_create_new_tag(transferables=transferables, seeded_tag=seeded_tag) diff --git a/docs/TemporalRangeGrounding.md b/docs/TemporalRangeGrounding.md index 3147905..0a9829c 100644 --- a/docs/TemporalRangeGrounding.md +++ b/docs/TemporalRangeGrounding.md @@ -22,7 +22,7 @@ print TemporalRangeGrounding.to_json() # convert the object into a dict temporal_range_grounding_dict = temporal_range_grounding_instance.to_dict() # create an instance of TemporalRangeGrounding from a dict -temporal_range_grounding_form_dict = temporal_range_grounding.from_dict(temporal_range_grounding_dict) +temporal_range_grounding_from_dict = TemporalRangeGrounding.from_dict(temporal_range_grounding_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/TemporalSearchOptions.md b/docs/TemporalSearchOptions.md new file mode 100644 index 0000000..0b09532 --- /dev/null +++ b/docs/TemporalSearchOptions.md @@ -0,0 +1,31 @@ +# TemporalSearchOptions + +created: will return the materials based on if the range is satisfied w/ this created timestamp ** same goes for updated + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**created** | [**AnonymousTemporalRange**](AnonymousTemporalRange.md) | | [optional] +**updated** | [**AnonymousTemporalRange**](AnonymousTemporalRange.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.temporal_search_options import TemporalSearchOptions + +# TODO update the JSON string below +json = "{}" +# create an instance of TemporalSearchOptions from a JSON string +temporal_search_options_instance = TemporalSearchOptions.from_json(json) +# print the JSON string representation of the object +print TemporalSearchOptions.to_json() + +# convert the object into a dict +temporal_search_options_dict = temporal_search_options_instance.to_dict() +# create an instance of TemporalSearchOptions from a dict +temporal_search_options_from_dict = TemporalSearchOptions.from_dict(temporal_search_options_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/TerminatingOSServerApplet.md b/docs/TerminatingOSServerApplet.md new file mode 100644 index 0000000..e827e84 --- /dev/null +++ b/docs/TerminatingOSServerApplet.md @@ -0,0 +1,32 @@ +# TerminatingOSServerApplet + +TODO + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**parent** | [**Application**](Application.md) | | [optional] +**port** | **int** | Validation check if the port is passed in. | [optional] +**type** | [**OSAppletEnum**](OSAppletEnum.md) | | + +## Example + +```python +from pieces_os_client.models.terminating_os_server_applet import TerminatingOSServerApplet + +# TODO update the JSON string below +json = "{}" +# create an instance of TerminatingOSServerApplet from a JSON string +terminating_os_server_applet_instance = TerminatingOSServerApplet.from_json(json) +# print the JSON string representation of the object +print TerminatingOSServerApplet.to_json() + +# convert the object into a dict +terminating_os_server_applet_dict = terminating_os_server_applet_instance.to_dict() +# create an instance of TerminatingOSServerApplet from a dict +terminating_os_server_applet_from_dict = TerminatingOSServerApplet.from_dict(terminating_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/TextLocation.md b/docs/TextLocation.md index 89624b9..4345e52 100644 --- a/docs/TextLocation.md +++ b/docs/TextLocation.md @@ -25,7 +25,7 @@ print TextLocation.to_json() # convert the object into a dict text_location_dict = text_location_instance.to_dict() # create an instance of TextLocation from a dict -text_location_form_dict = text_location.from_dict(text_location_dict) +text_location_from_dict = TextLocation.from_dict(text_location_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/TextMatch.md b/docs/TextMatch.md index 31ace2c..ab6a3a1 100644 --- a/docs/TextMatch.md +++ b/docs/TextMatch.md @@ -24,7 +24,7 @@ print TextMatch.to_json() # convert the object into a dict text_match_dict = text_match_instance.to_dict() # create an instance of TextMatch from a dict -text_match_form_dict = text_match.from_dict(text_match_dict) +text_match_from_dict = TextMatch.from_dict(text_match_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/TextuallyExtractedMaterial.md b/docs/TextuallyExtractedMaterial.md new file mode 100644 index 0000000..d1fbf19 --- /dev/null +++ b/docs/TextuallyExtractedMaterial.md @@ -0,0 +1,34 @@ +# TextuallyExtractedMaterial + +This is an extraction, this was a person/website/anchor that was extracted this will return the text location where this was found within the extraction. as well return the material itself that was extracted. Note: - seeds: will only be extracted people if provided, because the website/anchors will be created if extracted. - basically only thing that is different about the extracted people, if that if we extract a person that was not already saved, then we will not save them, however if there are related people then we will add them as well. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**match** | [**TextLocation**](TextLocation.md) | | +**websites** | [**FlattenedWebsites**](FlattenedWebsites.md) | | [optional] +**anchors** | [**FlattenedAnchors**](FlattenedAnchors.md) | | [optional] +**persons** | [**FlattenedPersons**](FlattenedPersons.md) | | [optional] +**seeds** | [**Seeds**](Seeds.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.textually_extracted_material import TextuallyExtractedMaterial + +# TODO update the JSON string below +json = "{}" +# create an instance of TextuallyExtractedMaterial from a JSON string +textually_extracted_material_instance = TextuallyExtractedMaterial.from_json(json) +# print the JSON string representation of the object +print TextuallyExtractedMaterial.to_json() + +# convert the object into a dict +textually_extracted_material_dict = textually_extracted_material_instance.to_dict() +# create an instance of TextuallyExtractedMaterial from a dict +textually_extracted_material_from_dict = TextuallyExtractedMaterial.from_dict(textually_extracted_material_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/TextuallyExtractedMaterials.md b/docs/TextuallyExtractedMaterials.md new file mode 100644 index 0000000..2227b32 --- /dev/null +++ b/docs/TextuallyExtractedMaterials.md @@ -0,0 +1,30 @@ +# TextuallyExtractedMaterials + +This is a plural of an Extraction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[TextuallyExtractedMaterial]**](TextuallyExtractedMaterial.md) | | + +## Example + +```python +from pieces_os_client.models.textually_extracted_materials import TextuallyExtractedMaterials + +# TODO update the JSON string below +json = "{}" +# create an instance of TextuallyExtractedMaterials from a JSON string +textually_extracted_materials_instance = TextuallyExtractedMaterials.from_json(json) +# print the JSON string representation of the object +print TextuallyExtractedMaterials.to_json() + +# convert the object into a dict +textually_extracted_materials_dict = textually_extracted_materials_instance.to_dict() +# create an instance of TextuallyExtractedMaterials from a dict +textually_extracted_materials_from_dict = TextuallyExtractedMaterials.from_dict(textually_extracted_materials_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/Theme.md b/docs/Theme.md index 34fd3f7..fab9682 100644 --- a/docs/Theme.md +++ b/docs/Theme.md @@ -23,7 +23,7 @@ print Theme.to_json() # convert the object into a dict theme_dict = theme_instance.to_dict() # create an instance of Theme from a dict -theme_form_dict = theme.from_dict(theme_dict) +theme_from_dict = Theme.from_dict(theme_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/TokenizedPKCE.md b/docs/TokenizedPKCE.md index c60980b..c1c1eca 100644 --- a/docs/TokenizedPKCE.md +++ b/docs/TokenizedPKCE.md @@ -28,7 +28,7 @@ print TokenizedPKCE.to_json() # convert the object into a dict tokenized_pkce_dict = tokenized_pkce_instance.to_dict() # create an instance of TokenizedPKCE from a dict -tokenized_pkce_form_dict = tokenized_pkce.from_dict(tokenized_pkce_dict) +tokenized_pkce_from_dict = TokenizedPKCE.from_dict(tokenized_pkce_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/TrackedApplicationInstall.md b/docs/TrackedApplicationInstall.md index f13f52a..ac56753 100644 --- a/docs/TrackedApplicationInstall.md +++ b/docs/TrackedApplicationInstall.md @@ -24,7 +24,7 @@ print TrackedApplicationInstall.to_json() # convert the object into a dict tracked_application_install_dict = tracked_application_install_instance.to_dict() # create an instance of TrackedApplicationInstall from a dict -tracked_application_install_form_dict = tracked_application_install.from_dict(tracked_application_install_dict) +tracked_application_install_from_dict = TrackedApplicationInstall.from_dict(tracked_application_install_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/TrackedApplicationUpdate.md b/docs/TrackedApplicationUpdate.md index 794afc4..2cd1f11 100644 --- a/docs/TrackedApplicationUpdate.md +++ b/docs/TrackedApplicationUpdate.md @@ -25,7 +25,7 @@ print TrackedApplicationUpdate.to_json() # convert the object into a dict tracked_application_update_dict = tracked_application_update_instance.to_dict() # create an instance of TrackedApplicationUpdate from a dict -tracked_application_update_form_dict = tracked_application_update.from_dict(tracked_application_update_dict) +tracked_application_update_from_dict = TrackedApplicationUpdate.from_dict(tracked_application_update_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/TrackedAssetEventCreationMetadata.md b/docs/TrackedAssetEventCreationMetadata.md index cfbbd0e..5c3bff0 100644 --- a/docs/TrackedAssetEventCreationMetadata.md +++ b/docs/TrackedAssetEventCreationMetadata.md @@ -24,7 +24,7 @@ print TrackedAssetEventCreationMetadata.to_json() # convert the object into a dict tracked_asset_event_creation_metadata_dict = tracked_asset_event_creation_metadata_instance.to_dict() # create an instance of TrackedAssetEventCreationMetadata from a dict -tracked_asset_event_creation_metadata_form_dict = tracked_asset_event_creation_metadata.from_dict(tracked_asset_event_creation_metadata_dict) +tracked_asset_event_creation_metadata_from_dict = TrackedAssetEventCreationMetadata.from_dict(tracked_asset_event_creation_metadata_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/TrackedAssetEventCreationMetadataClipboard.md b/docs/TrackedAssetEventCreationMetadataClipboard.md index 4199625..1033377 100644 --- a/docs/TrackedAssetEventCreationMetadataClipboard.md +++ b/docs/TrackedAssetEventCreationMetadataClipboard.md @@ -24,7 +24,7 @@ print TrackedAssetEventCreationMetadataClipboard.to_json() # convert the object into a dict tracked_asset_event_creation_metadata_clipboard_dict = tracked_asset_event_creation_metadata_clipboard_instance.to_dict() # create an instance of TrackedAssetEventCreationMetadataClipboard from a dict -tracked_asset_event_creation_metadata_clipboard_form_dict = tracked_asset_event_creation_metadata_clipboard.from_dict(tracked_asset_event_creation_metadata_clipboard_dict) +tracked_asset_event_creation_metadata_clipboard_from_dict = TrackedAssetEventCreationMetadataClipboard.from_dict(tracked_asset_event_creation_metadata_clipboard_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/TrackedAssetEventCreationMetadataFile.md b/docs/TrackedAssetEventCreationMetadataFile.md index c71d5b0..f43f2c4 100644 --- a/docs/TrackedAssetEventCreationMetadataFile.md +++ b/docs/TrackedAssetEventCreationMetadataFile.md @@ -24,7 +24,7 @@ print TrackedAssetEventCreationMetadataFile.to_json() # convert the object into a dict tracked_asset_event_creation_metadata_file_dict = tracked_asset_event_creation_metadata_file_instance.to_dict() # create an instance of TrackedAssetEventCreationMetadataFile from a dict -tracked_asset_event_creation_metadata_file_form_dict = tracked_asset_event_creation_metadata_file.from_dict(tracked_asset_event_creation_metadata_file_dict) +tracked_asset_event_creation_metadata_file_from_dict = TrackedAssetEventCreationMetadataFile.from_dict(tracked_asset_event_creation_metadata_file_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/TrackedAssetEventFormatReclassificationMetadata.md b/docs/TrackedAssetEventFormatReclassificationMetadata.md index 261eb30..02d3489 100644 --- a/docs/TrackedAssetEventFormatReclassificationMetadata.md +++ b/docs/TrackedAssetEventFormatReclassificationMetadata.md @@ -24,7 +24,7 @@ print TrackedAssetEventFormatReclassificationMetadata.to_json() # convert the object into a dict tracked_asset_event_format_reclassification_metadata_dict = tracked_asset_event_format_reclassification_metadata_instance.to_dict() # create an instance of TrackedAssetEventFormatReclassificationMetadata from a dict -tracked_asset_event_format_reclassification_metadata_form_dict = tracked_asset_event_format_reclassification_metadata.from_dict(tracked_asset_event_format_reclassification_metadata_dict) +tracked_asset_event_format_reclassification_metadata_from_dict = TrackedAssetEventFormatReclassificationMetadata.from_dict(tracked_asset_event_format_reclassification_metadata_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/TrackedAssetEventIdentifierDescriptionPairs.md b/docs/TrackedAssetEventIdentifierDescriptionPairs.md index fa4e799..a503e09 100644 --- a/docs/TrackedAssetEventIdentifierDescriptionPairs.md +++ b/docs/TrackedAssetEventIdentifierDescriptionPairs.md @@ -58,7 +58,7 @@ print TrackedAssetEventIdentifierDescriptionPairs.to_json() # convert the object into a dict tracked_asset_event_identifier_description_pairs_dict = tracked_asset_event_identifier_description_pairs_instance.to_dict() # create an instance of TrackedAssetEventIdentifierDescriptionPairs from a dict -tracked_asset_event_identifier_description_pairs_form_dict = tracked_asset_event_identifier_description_pairs.from_dict(tracked_asset_event_identifier_description_pairs_dict) +tracked_asset_event_identifier_description_pairs_from_dict = TrackedAssetEventIdentifierDescriptionPairs.from_dict(tracked_asset_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/TrackedAssetEventMetadata.md b/docs/TrackedAssetEventMetadata.md index 48d53d1..53ca7db 100644 --- a/docs/TrackedAssetEventMetadata.md +++ b/docs/TrackedAssetEventMetadata.md @@ -32,7 +32,7 @@ print TrackedAssetEventMetadata.to_json() # convert the object into a dict tracked_asset_event_metadata_dict = tracked_asset_event_metadata_instance.to_dict() # create an instance of TrackedAssetEventMetadata from a dict -tracked_asset_event_metadata_form_dict = tracked_asset_event_metadata.from_dict(tracked_asset_event_metadata_dict) +tracked_asset_event_metadata_from_dict = TrackedAssetEventMetadata.from_dict(tracked_asset_event_metadata_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/TrackedAssetEventRenameMetadata.md b/docs/TrackedAssetEventRenameMetadata.md index 5968ed0..d19ec2b 100644 --- a/docs/TrackedAssetEventRenameMetadata.md +++ b/docs/TrackedAssetEventRenameMetadata.md @@ -24,7 +24,7 @@ print TrackedAssetEventRenameMetadata.to_json() # convert the object into a dict tracked_asset_event_rename_metadata_dict = tracked_asset_event_rename_metadata_instance.to_dict() # create an instance of TrackedAssetEventRenameMetadata from a dict -tracked_asset_event_rename_metadata_form_dict = tracked_asset_event_rename_metadata.from_dict(tracked_asset_event_rename_metadata_dict) +tracked_asset_event_rename_metadata_from_dict = TrackedAssetEventRenameMetadata.from_dict(tracked_asset_event_rename_metadata_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/TrackedAssetsEventIdentifierDescriptionPairs.md b/docs/TrackedAssetsEventIdentifierDescriptionPairs.md index 57e8d26..140c4c1 100644 --- a/docs/TrackedAssetsEventIdentifierDescriptionPairs.md +++ b/docs/TrackedAssetsEventIdentifierDescriptionPairs.md @@ -23,7 +23,7 @@ print TrackedAssetsEventIdentifierDescriptionPairs.to_json() # convert the object into a dict tracked_assets_event_identifier_description_pairs_dict = tracked_assets_event_identifier_description_pairs_instance.to_dict() # create an instance of TrackedAssetsEventIdentifierDescriptionPairs from a dict -tracked_assets_event_identifier_description_pairs_form_dict = tracked_assets_event_identifier_description_pairs.from_dict(tracked_assets_event_identifier_description_pairs_dict) +tracked_assets_event_identifier_description_pairs_from_dict = TrackedAssetsEventIdentifierDescriptionPairs.from_dict(tracked_assets_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/TrackedAssetsEventSearchMetadata.md b/docs/TrackedAssetsEventSearchMetadata.md index 54aa4e8..3c17c7f 100644 --- a/docs/TrackedAssetsEventSearchMetadata.md +++ b/docs/TrackedAssetsEventSearchMetadata.md @@ -24,7 +24,7 @@ print TrackedAssetsEventSearchMetadata.to_json() # convert the object into a dict tracked_assets_event_search_metadata_dict = tracked_assets_event_search_metadata_instance.to_dict() # create an instance of TrackedAssetsEventSearchMetadata from a dict -tracked_assets_event_search_metadata_form_dict = tracked_assets_event_search_metadata.from_dict(tracked_assets_event_search_metadata_dict) +tracked_assets_event_search_metadata_from_dict = TrackedAssetsEventSearchMetadata.from_dict(tracked_assets_event_search_metadata_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/TrackedAssetsEventSearchMetadataResults.md b/docs/TrackedAssetsEventSearchMetadataResults.md index 7d6ce4d..1b21e2f 100644 --- a/docs/TrackedAssetsEventSearchMetadataResults.md +++ b/docs/TrackedAssetsEventSearchMetadataResults.md @@ -25,7 +25,7 @@ print TrackedAssetsEventSearchMetadataResults.to_json() # convert the object into a dict tracked_assets_event_search_metadata_results_dict = tracked_assets_event_search_metadata_results_instance.to_dict() # create an instance of TrackedAssetsEventSearchMetadataResults from a dict -tracked_assets_event_search_metadata_results_form_dict = tracked_assets_event_search_metadata_results.from_dict(tracked_assets_event_search_metadata_results_dict) +tracked_assets_event_search_metadata_results_from_dict = TrackedAssetsEventSearchMetadataResults.from_dict(tracked_assets_event_search_metadata_results_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/TrackedConversationEventIdentifierDescriptionPairs.md b/docs/TrackedConversationEventIdentifierDescriptionPairs.md index d26c5c7..e7a4a33 100644 --- a/docs/TrackedConversationEventIdentifierDescriptionPairs.md +++ b/docs/TrackedConversationEventIdentifierDescriptionPairs.md @@ -29,7 +29,7 @@ print TrackedConversationEventIdentifierDescriptionPairs.to_json() # convert the object into a dict tracked_conversation_event_identifier_description_pairs_dict = tracked_conversation_event_identifier_description_pairs_instance.to_dict() # create an instance of TrackedConversationEventIdentifierDescriptionPairs from a dict -tracked_conversation_event_identifier_description_pairs_form_dict = tracked_conversation_event_identifier_description_pairs.from_dict(tracked_conversation_event_identifier_description_pairs_dict) +tracked_conversation_event_identifier_description_pairs_from_dict = TrackedConversationEventIdentifierDescriptionPairs.from_dict(tracked_conversation_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/TrackedConversationEventMetadata.md b/docs/TrackedConversationEventMetadata.md index 5298c5d..b734c4d 100644 --- a/docs/TrackedConversationEventMetadata.md +++ b/docs/TrackedConversationEventMetadata.md @@ -23,7 +23,7 @@ print TrackedConversationEventMetadata.to_json() # convert the object into a dict tracked_conversation_event_metadata_dict = tracked_conversation_event_metadata_instance.to_dict() # create an instance of TrackedConversationEventMetadata from a dict -tracked_conversation_event_metadata_form_dict = tracked_conversation_event_metadata.from_dict(tracked_conversation_event_metadata_dict) +tracked_conversation_event_metadata_from_dict = TrackedConversationEventMetadata.from_dict(tracked_conversation_event_metadata_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/TrackedConversationEventRenameMetadata.md b/docs/TrackedConversationEventRenameMetadata.md index 26918f5..2146d22 100644 --- a/docs/TrackedConversationEventRenameMetadata.md +++ b/docs/TrackedConversationEventRenameMetadata.md @@ -24,7 +24,7 @@ print TrackedConversationEventRenameMetadata.to_json() # convert the object into a dict tracked_conversation_event_rename_metadata_dict = tracked_conversation_event_rename_metadata_instance.to_dict() # create an instance of TrackedConversationEventRenameMetadata from a dict -tracked_conversation_event_rename_metadata_form_dict = tracked_conversation_event_rename_metadata.from_dict(tracked_conversation_event_rename_metadata_dict) +tracked_conversation_event_rename_metadata_from_dict = TrackedConversationEventRenameMetadata.from_dict(tracked_conversation_event_rename_metadata_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/TrackedFormat.md b/docs/TrackedFormat.md index feb806f..bab7e0a 100644 --- a/docs/TrackedFormat.md +++ b/docs/TrackedFormat.md @@ -28,7 +28,7 @@ print TrackedFormat.to_json() # convert the object into a dict tracked_format_dict = tracked_format_instance.to_dict() # create an instance of TrackedFormat from a dict -tracked_format_form_dict = tracked_format.from_dict(tracked_format_dict) +tracked_format_from_dict = TrackedFormat.from_dict(tracked_format_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/TrackedFormatEvent.md b/docs/TrackedFormatEvent.md index 89e0e0f..bb38cdf 100644 --- a/docs/TrackedFormatEvent.md +++ b/docs/TrackedFormatEvent.md @@ -25,7 +25,7 @@ print TrackedFormatEvent.to_json() # convert the object into a dict tracked_format_event_dict = tracked_format_event_instance.to_dict() # create an instance of TrackedFormatEvent from a dict -tracked_format_event_form_dict = tracked_format_event.from_dict(tracked_format_event_dict) +tracked_format_event_from_dict = TrackedFormatEvent.from_dict(tracked_format_event_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/TrackedFormatEventIdentifierDescriptionPairs.md b/docs/TrackedFormatEventIdentifierDescriptionPairs.md index 39fac4c..23a2862 100644 --- a/docs/TrackedFormatEventIdentifierDescriptionPairs.md +++ b/docs/TrackedFormatEventIdentifierDescriptionPairs.md @@ -32,7 +32,7 @@ print TrackedFormatEventIdentifierDescriptionPairs.to_json() # convert the object into a dict tracked_format_event_identifier_description_pairs_dict = tracked_format_event_identifier_description_pairs_instance.to_dict() # create an instance of TrackedFormatEventIdentifierDescriptionPairs from a dict -tracked_format_event_identifier_description_pairs_form_dict = tracked_format_event_identifier_description_pairs.from_dict(tracked_format_event_identifier_description_pairs_dict) +tracked_format_event_identifier_description_pairs_from_dict = TrackedFormatEventIdentifierDescriptionPairs.from_dict(tracked_format_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/TrackedFormatEventMetadata.md b/docs/TrackedFormatEventMetadata.md index 5daa704..e45dc57 100644 --- a/docs/TrackedFormatEventMetadata.md +++ b/docs/TrackedFormatEventMetadata.md @@ -21,7 +21,7 @@ print TrackedFormatEventMetadata.to_json() # convert the object into a dict tracked_format_event_metadata_dict = tracked_format_event_metadata_instance.to_dict() # create an instance of TrackedFormatEventMetadata from a dict -tracked_format_event_metadata_form_dict = tracked_format_event_metadata.from_dict(tracked_format_event_metadata_dict) +tracked_format_event_metadata_from_dict = TrackedFormatEventMetadata.from_dict(tracked_format_event_metadata_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/TrackedInteractionEvent.md b/docs/TrackedInteractionEvent.md index a677e71..92a26d2 100644 --- a/docs/TrackedInteractionEvent.md +++ b/docs/TrackedInteractionEvent.md @@ -24,7 +24,7 @@ print TrackedInteractionEvent.to_json() # convert the object into a dict tracked_interaction_event_dict = tracked_interaction_event_instance.to_dict() # create an instance of TrackedInteractionEvent from a dict -tracked_interaction_event_form_dict = tracked_interaction_event.from_dict(tracked_interaction_event_dict) +tracked_interaction_event_from_dict = TrackedInteractionEvent.from_dict(tracked_interaction_event_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/TrackedKeyboardEvent.md b/docs/TrackedKeyboardEvent.md index 45a1dc8..65533f2 100644 --- a/docs/TrackedKeyboardEvent.md +++ b/docs/TrackedKeyboardEvent.md @@ -24,7 +24,7 @@ print TrackedKeyboardEvent.to_json() # convert the object into a dict tracked_keyboard_event_dict = tracked_keyboard_event_instance.to_dict() # create an instance of TrackedKeyboardEvent from a dict -tracked_keyboard_event_form_dict = tracked_keyboard_event.from_dict(tracked_keyboard_event_dict) +tracked_keyboard_event_from_dict = TrackedKeyboardEvent.from_dict(tracked_keyboard_event_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/TrackedSessionEventIdentifierDescriptionPairs.md b/docs/TrackedSessionEventIdentifierDescriptionPairs.md index 0165d1a..9e6923f 100644 --- a/docs/TrackedSessionEventIdentifierDescriptionPairs.md +++ b/docs/TrackedSessionEventIdentifierDescriptionPairs.md @@ -34,7 +34,7 @@ print TrackedSessionEventIdentifierDescriptionPairs.to_json() # convert the object into a dict tracked_session_event_identifier_description_pairs_dict = tracked_session_event_identifier_description_pairs_instance.to_dict() # create an instance of TrackedSessionEventIdentifierDescriptionPairs from a dict -tracked_session_event_identifier_description_pairs_form_dict = tracked_session_event_identifier_description_pairs.from_dict(tracked_session_event_identifier_description_pairs_dict) +tracked_session_event_identifier_description_pairs_from_dict = TrackedSessionEventIdentifierDescriptionPairs.from_dict(tracked_session_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/TrackedSummaryTotals.md b/docs/TrackedSummaryTotals.md new file mode 100644 index 0000000..6806004 --- /dev/null +++ b/docs/TrackedSummaryTotals.md @@ -0,0 +1,45 @@ +# TrackedSummaryTotals + +This is the counts of things that users can add. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | **int** | | +**tags** | **int** | | +**websites** | **int** | | +**persons** | **int** | | +**sensitives** | **int** | | +**shares** | **int** | | +**copilot_sends** | **int** | | +**copilot_receives** | **int** | | +**copilot_sessions** | **int** | | +**copilot_conversations** | **int** | | +**productivity_score** | **int** | | +**searches** | **int** | | +**references** | **int** | | +**reuses** | **int** | | +**anchor_files** | **int** | | +**anchor_folders** | **int** | | +**isr_reports** | **int** | | + +## Example + +```python +from pieces_os_client.models.tracked_summary_totals import TrackedSummaryTotals + +# TODO update the JSON string below +json = "{}" +# create an instance of TrackedSummaryTotals from a JSON string +tracked_summary_totals_instance = TrackedSummaryTotals.from_json(json) +# print the JSON string representation of the object +print TrackedSummaryTotals.to_json() + +# convert the object into a dict +tracked_summary_totals_dict = tracked_summary_totals_instance.to_dict() +# create an instance of TrackedSummaryTotals from a dict +tracked_summary_totals_from_dict = TrackedSummaryTotals.from_dict(tracked_summary_totals_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/TrackedUserProfile.md b/docs/TrackedUserProfile.md index 7b64d49..7ad3b33 100644 --- a/docs/TrackedUserProfile.md +++ b/docs/TrackedUserProfile.md @@ -26,7 +26,7 @@ print TrackedUserProfile.to_json() # convert the object into a dict tracked_user_profile_dict = tracked_user_profile_instance.to_dict() # create an instance of TrackedUserProfile from a dict -tracked_user_profile_form_dict = tracked_user_profile.from_dict(tracked_user_profile_dict) +tracked_user_profile_from_dict = TrackedUserProfile.from_dict(tracked_user_profile_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/TransferableBytes.md b/docs/TransferableBytes.md index 5729c97..038b99f 100644 --- a/docs/TransferableBytes.md +++ b/docs/TransferableBytes.md @@ -26,7 +26,7 @@ print TransferableBytes.to_json() # convert the object into a dict transferable_bytes_dict = transferable_bytes_instance.to_dict() # create an instance of TransferableBytes from a dict -transferable_bytes_form_dict = transferable_bytes.from_dict(transferable_bytes_dict) +transferable_bytes_from_dict = TransferableBytes.from_dict(transferable_bytes_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/TransferableString.md b/docs/TransferableString.md index 245ce92..3bd865c 100644 --- a/docs/TransferableString.md +++ b/docs/TransferableString.md @@ -26,7 +26,7 @@ print TransferableString.to_json() # convert the object into a dict transferable_string_dict = transferable_string_instance.to_dict() # create an instance of TransferableString from a dict -transferable_string_form_dict = transferable_string.from_dict(transferable_string_dict) +transferable_string_from_dict = TransferableString.from_dict(transferable_string_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/UncheckedOSUpdate.md b/docs/UncheckedOSServerUpdate.md similarity index 52% rename from docs/UncheckedOSUpdate.md rename to docs/UncheckedOSServerUpdate.md index 4dba058..6978faa 100644 --- a/docs/UncheckedOSUpdate.md +++ b/docs/UncheckedOSServerUpdate.md @@ -1,4 +1,4 @@ -# UncheckedOSUpdate +# UncheckedOSServerUpdate This is the input body for /os/update/check, just a placeholder for now. @@ -10,19 +10,19 @@ Name | Type | Description | Notes ## Example ```python -from pieces_os_client.models.unchecked_os_update import UncheckedOSUpdate +from pieces_os_client.models.unchecked_os_server_update import UncheckedOSServerUpdate # TODO update the JSON string below json = "{}" -# create an instance of UncheckedOSUpdate from a JSON string -unchecked_os_update_instance = UncheckedOSUpdate.from_json(json) +# create an instance of UncheckedOSServerUpdate from a JSON string +unchecked_os_server_update_instance = UncheckedOSServerUpdate.from_json(json) # print the JSON string representation of the object -print UncheckedOSUpdate.to_json() +print UncheckedOSServerUpdate.to_json() # convert the object into a dict -unchecked_os_update_dict = unchecked_os_update_instance.to_dict() -# create an instance of UncheckedOSUpdate from a dict -unchecked_os_update_form_dict = unchecked_os_update.from_dict(unchecked_os_update_dict) +unchecked_os_server_update_dict = unchecked_os_server_update_instance.to_dict() +# create an instance of UncheckedOSServerUpdate from a dict +unchecked_os_server_update_from_dict = UncheckedOSServerUpdate.from_dict(unchecked_os_server_update_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/UnsegmentedTechnicalLanguage.md b/docs/UnsegmentedTechnicalLanguage.md index 9257a71..b1c4d32 100644 --- a/docs/UnsegmentedTechnicalLanguage.md +++ b/docs/UnsegmentedTechnicalLanguage.md @@ -23,7 +23,7 @@ print UnsegmentedTechnicalLanguage.to_json() # convert the object into a dict unsegmented_technical_language_dict = unsegmented_technical_language_instance.to_dict() # create an instance of UnsegmentedTechnicalLanguage from a dict -unsegmented_technical_language_form_dict = unsegmented_technical_language.from_dict(unsegmented_technical_language_dict) +unsegmented_technical_language_from_dict = UnsegmentedTechnicalLanguage.from_dict(unsegmented_technical_language_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/UpdatedExternalProviderApiKey.md b/docs/UpdatedExternalProviderApiKey.md index 2955927..a5044c0 100644 --- a/docs/UpdatedExternalProviderApiKey.md +++ b/docs/UpdatedExternalProviderApiKey.md @@ -23,7 +23,7 @@ print UpdatedExternalProviderApiKey.to_json() # convert the object into a dict updated_external_provider_api_key_dict = updated_external_provider_api_key_instance.to_dict() # create an instance of UpdatedExternalProviderApiKey from a dict -updated_external_provider_api_key_form_dict = updated_external_provider_api_key.from_dict(updated_external_provider_api_key_dict) +updated_external_provider_api_key_from_dict = UpdatedExternalProviderApiKey.from_dict(updated_external_provider_api_key_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/UserBetaStatus.md b/docs/UserBetaStatus.md index e894c4f..89412ab 100644 --- a/docs/UserBetaStatus.md +++ b/docs/UserBetaStatus.md @@ -24,7 +24,7 @@ print UserBetaStatus.to_json() # convert the object into a dict user_beta_status_dict = user_beta_status_instance.to_dict() # create an instance of UserBetaStatus from a dict -user_beta_status_form_dict = user_beta_status.from_dict(user_beta_status_dict) +user_beta_status_from_dict = UserBetaStatus.from_dict(user_beta_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/UserProfile.md b/docs/UserProfile.md index 38f7a59..c0046dd 100644 --- a/docs/UserProfile.md +++ b/docs/UserProfile.md @@ -34,7 +34,7 @@ print UserProfile.to_json() # convert the object into a dict user_profile_dict = user_profile_instance.to_dict() # create an instance of UserProfile from a dict -user_profile_form_dict = user_profile.from_dict(user_profile_dict) +user_profile_from_dict = UserProfile.from_dict(user_profile_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/Users.md b/docs/Users.md index a139fe7..40bd269 100644 --- a/docs/Users.md +++ b/docs/Users.md @@ -23,7 +23,7 @@ print Users.to_json() # convert the object into a dict users_dict = users_instance.to_dict() # create an instance of Users from a dict -users_form_dict = users.from_dict(users_dict) +users_from_dict = Users.from_dict(users_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/VerifiedOSFilesystemPath.md b/docs/VerifiedOSFilesystemPath.md new file mode 100644 index 0000000..5ffb4a6 --- /dev/null +++ b/docs/VerifiedOSFilesystemPath.md @@ -0,0 +1,35 @@ +# VerifiedOSFilesystemPath + +This will return is the given path was verified/ or it was invalid. and if it is valid if it is a file/folder note: file/directory are both null. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**path** | **str** | | +**file** | **bool** | | [optional] +**directory** | **bool** | | [optional] +**verified** | **bool** | This means if the path(file/folder) exists on the machine. | +**denied** | **bool** | This means that attempting to access the file was not aloud(ie no permission) | [optional] +**bytes** | [**ByteDescriptor**](ByteDescriptor.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.verified_os_filesystem_path import VerifiedOSFilesystemPath + +# TODO update the JSON string below +json = "{}" +# create an instance of VerifiedOSFilesystemPath from a JSON string +verified_os_filesystem_path_instance = VerifiedOSFilesystemPath.from_json(json) +# print the JSON string representation of the object +print VerifiedOSFilesystemPath.to_json() + +# convert the object into a dict +verified_os_filesystem_path_dict = verified_os_filesystem_path_instance.to_dict() +# create an instance of VerifiedOSFilesystemPath from a dict +verified_os_filesystem_path_from_dict = VerifiedOSFilesystemPath.from_dict(verified_os_filesystem_path_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/Website.md b/docs/Website.md index 525e7c0..fd5cbff 100644 --- a/docs/Website.md +++ b/docs/Website.md @@ -35,7 +35,7 @@ print Website.to_json() # convert the object into a dict website_dict = website_instance.to_dict() # create an instance of Website from a dict -website_form_dict = website.from_dict(website_dict) +website_from_dict = Website.from_dict(website_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/Websites.md b/docs/Websites.md index fb654d8..6209bf2 100644 --- a/docs/Websites.md +++ b/docs/Websites.md @@ -25,7 +25,7 @@ print Websites.to_json() # convert the object into a dict websites_dict = websites_instance.to_dict() # create an instance of Websites from a dict -websites_form_dict = websites.from_dict(websites_dict) +websites_from_dict = Websites.from_dict(websites_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/WebsitesApi.md b/docs/WebsitesApi.md index f86201f..863b647 100644 --- a/docs/WebsitesApi.md +++ b/docs/WebsitesApi.md @@ -4,12 +4,84 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**search_websites**](WebsitesApi.md#search_websites) | **POST** /websites/search | /websites/search [POST] [**websites_create_new_website**](WebsitesApi.md#websites_create_new_website) | **POST** /websites/create | /websites/create [POST] [**websites_delete_specific_website**](WebsitesApi.md#websites_delete_specific_website) | **POST** /websites/{website}/delete | /websites/{website}/delete [POST] [**websites_exists**](WebsitesApi.md#websites_exists) | **POST** /websites/exists | /websites/exists [POST] [**websites_snapshot**](WebsitesApi.md#websites_snapshot) | **GET** /websites | /websites [GET] +# **search_websites** +> SearchedWebsites search_websites(transferables=transferables, search_input=search_input) + +/websites/search [POST] + +This will search your websites for a specific website note: we will search the url, and search the name of the website + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_websites import SearchedWebsites +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.WebsitesApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /websites/search [POST] + api_response = api_instance.search_websites(transferables=transferables, search_input=search_input) + print("The response of WebsitesApi->search_websites:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WebsitesApi->search_websites: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedWebsites**](SearchedWebsites.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **websites_create_new_website** > Website websites_create_new_website(transferables=transferables, seeded_website=seeded_website) diff --git a/docs/WindowDimensions.md b/docs/WindowDimensions.md new file mode 100644 index 0000000..957e7d5 --- /dev/null +++ b/docs/WindowDimensions.md @@ -0,0 +1,37 @@ +# WindowDimensions + +note: this is modeled off of the browsers bounding box DOMRect https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**bottom** | **float** | | +**height** | **float** | | +**left** | **float** | | +**right** | **float** | | +**top** | **float** | | +**width** | **float** | | +**x** | **float** | | +**y** | **float** | | + +## Example + +```python +from pieces_os_client.models.window_dimensions import WindowDimensions + +# TODO update the JSON string below +json = "{}" +# create an instance of WindowDimensions from a JSON string +window_dimensions_instance = WindowDimensions.from_json(json) +# print the JSON string representation of the object +print WindowDimensions.to_json() + +# convert the object into a dict +window_dimensions_dict = window_dimensions_instance.to_dict() +# create an instance of WindowDimensions from a dict +window_dimensions_from_dict = WindowDimensions.from_dict(window_dimensions_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/WorkstreamApi.md b/docs/WorkstreamApi.md index be36ec4..81461f7 100644 --- a/docs/WorkstreamApi.md +++ b/docs/WorkstreamApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- [**workstream_suggestions_refresh**](WorkstreamApi.md#workstream_suggestions_refresh) | **POST** /workstream/suggestions/refresh | /workstream/suggestions/refresh [POST] +[**workstream_suggestions_stream**](WorkstreamApi.md#workstream_suggestions_stream) | **GET** /workstream/suggestions/stream | /workstream/suggestions/stream [WS] # **workstream_suggestions_refresh** @@ -76,3 +77,67 @@ 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) +# **workstream_suggestions_stream** +> WorkstreamSuggestions workstream_suggestions_stream() + +/workstream/suggestions/stream [WS] + +Provides a WebSocket connection that emits changes to your workstream suggestions. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions +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.WorkstreamApi(api_client) + + try: + # /workstream/suggestions/stream [WS] + api_response = api_instance.workstream_suggestions_stream() + print("The response of WorkstreamApi->workstream_suggestions_stream:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamApi->workstream_suggestions_stream: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamSuggestions**](WorkstreamSuggestions.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + diff --git a/docs/WorkstreamEvent.md b/docs/WorkstreamEvent.md index 82d8bc3..6aca210 100644 --- a/docs/WorkstreamEvent.md +++ b/docs/WorkstreamEvent.md @@ -30,7 +30,7 @@ print WorkstreamEvent.to_json() # convert the object into a dict workstream_event_dict = workstream_event_instance.to_dict() # create an instance of WorkstreamEvent from a dict -workstream_event_form_dict = workstream_event.from_dict(workstream_event_dict) +workstream_event_from_dict = WorkstreamEvent.from_dict(workstream_event_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/WorkstreamEventContext.md b/docs/WorkstreamEventContext.md index 90354cc..4039dd5 100644 --- a/docs/WorkstreamEventContext.md +++ b/docs/WorkstreamEventContext.md @@ -24,7 +24,7 @@ print WorkstreamEventContext.to_json() # convert the object into a dict workstream_event_context_dict = workstream_event_context_instance.to_dict() # create an instance of WorkstreamEventContext from a dict -workstream_event_context_form_dict = workstream_event_context.from_dict(workstream_event_context_dict) +workstream_event_context_from_dict = WorkstreamEventContext.from_dict(workstream_event_context_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/WorkstreamEventTrigger.md b/docs/WorkstreamEventTrigger.md index 0dd217c..5e88efe 100644 --- a/docs/WorkstreamEventTrigger.md +++ b/docs/WorkstreamEventTrigger.md @@ -6,7 +6,7 @@ This is the specific event that represent the Shadow Activity ie the copy/paste Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] -**check_in** | **bool** | this is a sort of check-in event(ie when ever your application is in the forground on there is an interaction) | [optional] +**check_in** | **bool** | this is a sort of check-in event(ie when ever your application is in the foreground on there is an interaction) | [optional] **copy** | **bool** | | [optional] **paste** | **bool** | | [optional] **file_open** | **bool** | | [optional] @@ -36,7 +36,7 @@ print WorkstreamEventTrigger.to_json() # convert the object into a dict workstream_event_trigger_dict = workstream_event_trigger_instance.to_dict() # create an instance of WorkstreamEventTrigger from a dict -workstream_event_trigger_form_dict = workstream_event_trigger.from_dict(workstream_event_trigger_dict) +workstream_event_trigger_from_dict = WorkstreamEventTrigger.from_dict(workstream_event_trigger_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/WorkstreamEventTriggerContextBrowser.md b/docs/WorkstreamEventTriggerContextBrowser.md index ad0d958..a0e5da2 100644 --- a/docs/WorkstreamEventTriggerContextBrowser.md +++ b/docs/WorkstreamEventTriggerContextBrowser.md @@ -23,7 +23,7 @@ print WorkstreamEventTriggerContextBrowser.to_json() # convert the object into a dict workstream_event_trigger_context_browser_dict = workstream_event_trigger_context_browser_instance.to_dict() # create an instance of WorkstreamEventTriggerContextBrowser from a dict -workstream_event_trigger_context_browser_form_dict = workstream_event_trigger_context_browser.from_dict(workstream_event_trigger_context_browser_dict) +workstream_event_trigger_context_browser_from_dict = WorkstreamEventTriggerContextBrowser.from_dict(workstream_event_trigger_context_browser_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/WorkstreamEventTriggerContextIDE.md b/docs/WorkstreamEventTriggerContextIDE.md index 50edad3..a899a7e 100644 --- a/docs/WorkstreamEventTriggerContextIDE.md +++ b/docs/WorkstreamEventTriggerContextIDE.md @@ -25,7 +25,7 @@ print WorkstreamEventTriggerContextIDE.to_json() # convert the object into a dict workstream_event_trigger_context_ide_dict = workstream_event_trigger_context_ide_instance.to_dict() # create an instance of WorkstreamEventTriggerContextIDE from a dict -workstream_event_trigger_context_ide_form_dict = workstream_event_trigger_context_ide.from_dict(workstream_event_trigger_context_ide_dict) +workstream_event_trigger_context_ide_from_dict = WorkstreamEventTriggerContextIDE.from_dict(workstream_event_trigger_context_ide_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/WorkstreamEvents.md b/docs/WorkstreamEvents.md index 82577d1..d05d862 100644 --- a/docs/WorkstreamEvents.md +++ b/docs/WorkstreamEvents.md @@ -25,7 +25,7 @@ print WorkstreamEvents.to_json() # convert the object into a dict workstream_events_dict = workstream_events_instance.to_dict() # create an instance of WorkstreamEvents from a dict -workstream_events_form_dict = workstream_events.from_dict(workstream_events_dict) +workstream_events_from_dict = WorkstreamEvents.from_dict(workstream_events_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/WorkstreamIngestion.md b/docs/WorkstreamIngestion.md index 59bd018..0cc9c6d 100644 --- a/docs/WorkstreamIngestion.md +++ b/docs/WorkstreamIngestion.md @@ -22,7 +22,7 @@ print WorkstreamIngestion.to_json() # convert the object into a dict workstream_ingestion_dict = workstream_ingestion_instance.to_dict() # create an instance of WorkstreamIngestion from a dict -workstream_ingestion_form_dict = workstream_ingestion.from_dict(workstream_ingestion_dict) +workstream_ingestion_from_dict = WorkstreamIngestion.from_dict(workstream_ingestion_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/WorkstreamPatternEngineApi.md b/docs/WorkstreamPatternEngineApi.md index b168e0e..1125b7d 100644 --- a/docs/WorkstreamPatternEngineApi.md +++ b/docs/WorkstreamPatternEngineApi.md @@ -5,10 +5,21 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- [**workstream_pattern_engine_create_ingestion**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_create_ingestion) | **POST** /workstream_pattern_engine/ingestions/create | /workstream_pattern_engine/ingestions/create [POST] +[**workstream_pattern_engine_processors_sources**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_sources) | **GET** /workstream_pattern_engine/processors/sources | /workstream_pattern_engine/processors/sources [GET] [**workstream_pattern_engine_processors_vision_activate**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_activate) | **POST** /workstream_pattern_engine/processors/vision/activate | /workstream_pattern_engine/processors/vision/activate [POST] +[**workstream_pattern_engine_processors_vision_calibration_capture**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_calibration_capture) | **POST** /workstream_pattern_engine/processors/vision/calibration/capture | /workstream_pattern_engine/processors/vision/calibration/capture [POST] +[**workstream_pattern_engine_processors_vision_calibrations_focused**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_calibrations_focused) | **GET** /workstream_pattern_engine/processors/vision/calibrations/focused | /workstream_pattern_engine/processors/vision/calibrations/focused [GET] +[**workstream_pattern_engine_processors_vision_calibrations_snapshot**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_calibrations_snapshot) | **GET** /workstream_pattern_engine/processors/vision/calibrations | /workstream_pattern_engine/processors/vision/calibrations [GET] [**workstream_pattern_engine_processors_vision_data_clear**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_data_clear) | **POST** /workstream_pattern_engine/processors/vision/data/clear | /workstream_pattern_engine/processors/vision/data/clear [POST] [**workstream_pattern_engine_processors_vision_deactivate**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_deactivate) | **POST** /workstream_pattern_engine/processors/vision/deactivate | /workstream_pattern_engine/processors/vision/deactivate [POST] +[**workstream_pattern_engine_processors_vision_event_delete_specific_vision_event**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_event_delete_specific_vision_event) | **POST** /workstream_pattern_engine/processors/vision/data/events/{vision_event}/delete | /workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST] +[**workstream_pattern_engine_processors_vision_events_scoped_delete**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_events_scoped_delete) | **POST** /workstream_pattern_engine/processors/vision/data/events/scoped_delete | /workstream_pattern_engine/processors/vision/events/scoped_delete [POST] +[**workstream_pattern_engine_processors_vision_events_search**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_events_search) | **POST** /workstream_pattern_engine/processors/vision/data/events/search | /workstream_pattern_engine/processors/vision/data/events/search [POST] +[**workstream_pattern_engine_processors_vision_events_snapshot**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_events_snapshot) | **GET** /workstream_pattern_engine/processors/vision/data/events | /workstream_pattern_engine/processors/vision/data/events [GET] +[**workstream_pattern_engine_processors_vision_events_specific_snapshot**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_events_specific_snapshot) | **GET** /workstream_pattern_engine/processors/vision/data/events/{vision_event} | /workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET] +[**workstream_pattern_engine_processors_vision_metadata**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_metadata) | **GET** /workstream_pattern_engine/processors/vision/metadata | /workstream_pattern_engine/processors/vision/metadata [GET] [**workstream_pattern_engine_processors_vision_status**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_status) | **GET** /workstream_pattern_engine/processors/vision/status | /workstream_pattern_engine/processors/vision/status [GET] +[**workstream_pattern_engine_processors_vision_status_stream**](WorkstreamPatternEngineApi.md#workstream_pattern_engine_processors_vision_status_stream) | **GET** /workstream_pattern_engine/processors/vision/status/stream | /workstream_pattern_engine/processors/vision/status/steam [WS] # **workstream_pattern_engine_create_ingestion** @@ -80,6 +91,70 @@ 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) +# **workstream_pattern_engine_processors_sources** +> WorkstreamPatternEngineSources workstream_pattern_engine_processors_sources() + +/workstream_pattern_engine/processors/sources [GET] + +This will return all of the applications(focused windows) that have events saved within WPE qdrant collection. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/sources [GET] + api_response = api_instance.workstream_pattern_engine_processors_sources() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_sources: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineSources**](WorkstreamPatternEngineSources.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **workstream_pattern_engine_processors_vision_activate** > WorkstreamPatternEngineStatus workstream_pattern_engine_processors_vision_activate(workstream_pattern_engine_status=workstream_pattern_engine_status) @@ -149,6 +224,198 @@ 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) +# **workstream_pattern_engine_processors_vision_calibration_capture** +> WorkstreamPatternEngineVisionCalibration workstream_pattern_engine_processors_vision_calibration_capture() + +/workstream_pattern_engine/processors/vision/calibration/capture [POST] + +This will attempt to capture the copilot/feed/xyz dimensions of current focused window note: in the future we can make a differentiation of the dimensions based on the type of qrCode. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/calibration/capture [POST] + api_response = api_instance.workstream_pattern_engine_processors_vision_calibration_capture() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibration_capture:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibration_capture: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineVisionCalibration**](WorkstreamPatternEngineVisionCalibration.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_calibrations_focused** +> WorkstreamPatternEngineVisionCalibration workstream_pattern_engine_processors_vision_calibrations_focused() + +/workstream_pattern_engine/processors/vision/calibrations/focused [GET] + +This will get the copilot/feed/xyz dimensions of the focused window. This endpoint will attempt to do the following: 1. get the focus window 2. we will do a lookup to see if we have the copilot/feed/xyz dimension for this window if not we will return null if so we will return the dimensions as well as when the dimensions were taken note: in the future we can make a differentiation of the dimensions based on the type of qrCode. note: no need to pass in the window name: b/c we will just get the focused window note: we will also return the window name in the returnable so the dev can verify this is the window of the plugin. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/calibrations/focused [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_calibrations_focused() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibrations_focused:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibrations_focused: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineVisionCalibration**](WorkstreamPatternEngineVisionCalibration.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_calibrations_snapshot** +> WorkstreamPatternEngineVisionCalibrations workstream_pattern_engine_processors_vision_calibrations_snapshot() + +/workstream_pattern_engine/processors/vision/calibrations [GET] + +This will return a snapshot of all of our captured copilot window Dimensions note: this will return many captures note: will want to add type of calibration for this specific dimension(ie copilot/feed/xyz) note: in the future we can make a differentiation of the dimensions based on the type of qrCode. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_calibrations import WorkstreamPatternEngineVisionCalibrations +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/calibrations [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_calibrations_snapshot() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibrations_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_calibrations_snapshot: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineVisionCalibrations**](WorkstreamPatternEngineVisionCalibrations.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **workstream_pattern_engine_processors_vision_data_clear** > workstream_pattern_engine_processors_vision_data_clear(workstream_pattern_engine_data_cleanup_request=workstream_pattern_engine_data_cleanup_request) @@ -285,12 +552,12 @@ 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) -# **workstream_pattern_engine_processors_vision_status** -> WorkstreamPatternEngineStatus workstream_pattern_engine_processors_vision_status() +# **workstream_pattern_engine_processors_vision_event_delete_specific_vision_event** +> workstream_pattern_engine_processors_vision_event_delete_specific_vision_event(vision_event) -/workstream_pattern_engine/processors/vision/status [GET] +/workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST] -This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) +This will delete a single event. ### Example @@ -298,7 +565,6 @@ This will get a snapshot of the status your Workstream Pattern Engine. This is u import time import os import pieces_os_client -from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus from pieces_os_client.rest import ApiException from pprint import pprint @@ -313,24 +579,26 @@ configuration = pieces_os_client.Configuration( with pieces_os_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pieces_os_client.WorkstreamPatternEngineApi(api_client) + vision_event = 'vision_event_example' # str | This is a identifier that is used to identify a specific WPE_vision event. try: - # /workstream_pattern_engine/processors/vision/status [GET] - api_response = api_instance.workstream_pattern_engine_processors_vision_status() - print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status:\n") - pprint(api_response) + # /workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST] + api_instance.workstream_pattern_engine_processors_vision_event_delete_specific_vision_event(vision_event) except Exception as e: - print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status: %s\n" % e) + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_event_delete_specific_vision_event: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vision_event** | **str**| This is a identifier that is used to identify a specific WPE_vision event. | ### Return type -[**WorkstreamPatternEngineStatus**](WorkstreamPatternEngineStatus.md) +void (empty response body) ### Authorization @@ -339,13 +607,483 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, text/plain + - **Accept**: text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**403** | Forbidden, this is not available for non-beta used until mid to late April. | - | +**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) + +# **workstream_pattern_engine_processors_vision_events_scoped_delete** +> FlattenedWorkstreamPatternEngineVisionEvents workstream_pattern_engine_processors_vision_events_scoped_delete(workstream_pattern_engine_vision_event_deletions=workstream_pattern_engine_vision_event_deletions) + +/workstream_pattern_engine/processors/vision/events/scoped_delete [POST] + +This will remove the UUIDs that were removed from the qdrant event. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents +from pieces_os_client.models.workstream_pattern_engine_vision_event_deletions import WorkstreamPatternEngineVisionEventDeletions +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.WorkstreamPatternEngineApi(api_client) + workstream_pattern_engine_vision_event_deletions = pieces_os_client.WorkstreamPatternEngineVisionEventDeletions() # WorkstreamPatternEngineVisionEventDeletions | (optional) + + try: + # /workstream_pattern_engine/processors/vision/events/scoped_delete [POST] + api_response = api_instance.workstream_pattern_engine_processors_vision_events_scoped_delete(workstream_pattern_engine_vision_event_deletions=workstream_pattern_engine_vision_event_deletions) + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_scoped_delete:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_scoped_delete: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workstream_pattern_engine_vision_event_deletions** | [**WorkstreamPatternEngineVisionEventDeletions**](WorkstreamPatternEngineVisionEventDeletions.md)| | [optional] + +### Return type + +[**FlattenedWorkstreamPatternEngineVisionEvents**](FlattenedWorkstreamPatternEngineVisionEvents.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_events_search** +> SearchedWorkstreamPatternEngineVisionEvents workstream_pattern_engine_processors_vision_events_search(transferables=transferables, search_input=search_input) + +/workstream_pattern_engine/processors/vision/data/events/search [POST] + +This will search your WPE events and will return a list of events that match the query/timestamp range/list of applications + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_workstream_pattern_engine_vision_events import SearchedWorkstreamPatternEngineVisionEvents +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.WorkstreamPatternEngineApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /workstream_pattern_engine/processors/vision/data/events/search [POST] + api_response = api_instance.workstream_pattern_engine_processors_vision_events_search(transferables=transferables, search_input=search_input) + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_search: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedWorkstreamPatternEngineVisionEvents**](SearchedWorkstreamPatternEngineVisionEvents.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_events_snapshot** +> WorkstreamPatternEngineVisionEvents workstream_pattern_engine_processors_vision_events_snapshot(transferables=transferables) + +/workstream_pattern_engine/processors/vision/data/events [GET] + +This will return a snapshot of all of the WPE qdrant events note: if the transferables: are true then we will provide values for each of our events otherwise we will just provide basic metadata + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_events import WorkstreamPatternEngineVisionEvents +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.WorkstreamPatternEngineApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + + try: + # /workstream_pattern_engine/processors/vision/data/events [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_events_snapshot(transferables=transferables) + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_snapshot: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + +### Return type + +[**WorkstreamPatternEngineVisionEvents**](WorkstreamPatternEngineVisionEvents.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_events_specific_snapshot** +> WorkstreamPatternEngineVisionEvent workstream_pattern_engine_processors_vision_events_specific_snapshot(vision_event, transferables=transferables) + +/workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET] + +This will return a specific event from the WPE. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent +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.WorkstreamPatternEngineApi(api_client) + vision_event = 'vision_event_example' # str | This is a identifier that is used to identify a specific WPE_vision event. + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + + try: + # /workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_events_specific_snapshot(vision_event, transferables=transferables) + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_specific_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_events_specific_snapshot: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vision_event** | **str**| This is a identifier that is used to identify a specific WPE_vision event. | + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + +### Return type + +[**WorkstreamPatternEngineVisionEvent**](WorkstreamPatternEngineVisionEvent.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_metadata** +> WorkstreamPatternEngineVisionMetadata workstream_pattern_engine_processors_vision_metadata() + +/workstream_pattern_engine/processors/vision/metadata [GET] + +This is an endpoint that will return the metadata of the vision data (WPE qdrant size) + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_vision_metadata import WorkstreamPatternEngineVisionMetadata +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/metadata [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_metadata() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_metadata: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineVisionMetadata**](WorkstreamPatternEngineVisionMetadata.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + +# **workstream_pattern_engine_processors_vision_status** +> WorkstreamPatternEngineStatus workstream_pattern_engine_processors_vision_status() + +/workstream_pattern_engine/processors/vision/status [GET] + +This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/status [GET] + api_response = api_instance.workstream_pattern_engine_processors_vision_status() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineStatus**](WorkstreamPatternEngineStatus.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**403** | Forbidden, this is not available for non-beta used until mid to late April. | - | +**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) + +# **workstream_pattern_engine_processors_vision_status_stream** +> WorkstreamPatternEngineStatus workstream_pattern_engine_processors_vision_status_stream() + +/workstream_pattern_engine/processors/vision/status/steam [WS] + +This is a websocket for the status of the workstream pattern engine for vision. This will emit an event when this is first connected to, and will emit an event when every this value changes This will emit a \"WorkstreamPatternEngineStatus\" Model. + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus +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.WorkstreamPatternEngineApi(api_client) + + try: + # /workstream_pattern_engine/processors/vision/status/steam [WS] + api_response = api_instance.workstream_pattern_engine_processors_vision_status_stream() + print("The response of WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status_stream:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamPatternEngineApi->workstream_pattern_engine_processors_vision_status_stream: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**WorkstreamPatternEngineStatus**](WorkstreamPatternEngineStatus.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | **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) diff --git a/docs/WorkstreamPatternEngineDataCleanupRequest.md b/docs/WorkstreamPatternEngineDataCleanupRequest.md index f4443f0..bd0fe98 100644 --- a/docs/WorkstreamPatternEngineDataCleanupRequest.md +++ b/docs/WorkstreamPatternEngineDataCleanupRequest.md @@ -23,7 +23,7 @@ print WorkstreamPatternEngineDataCleanupRequest.to_json() # convert the object into a dict workstream_pattern_engine_data_cleanup_request_dict = workstream_pattern_engine_data_cleanup_request_instance.to_dict() # create an instance of WorkstreamPatternEngineDataCleanupRequest from a dict -workstream_pattern_engine_data_cleanup_request_form_dict = workstream_pattern_engine_data_cleanup_request.from_dict(workstream_pattern_engine_data_cleanup_request_dict) +workstream_pattern_engine_data_cleanup_request_from_dict = WorkstreamPatternEngineDataCleanupRequest.from_dict(workstream_pattern_engine_data_cleanup_request_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/WorkstreamPatternEngineSource.md b/docs/WorkstreamPatternEngineSource.md new file mode 100644 index 0000000..3bdc565 --- /dev/null +++ b/docs/WorkstreamPatternEngineSource.md @@ -0,0 +1,30 @@ +# WorkstreamPatternEngineSource + +This is a specific model for a given WPE qdrant source. note: application is optional b/c we may want a network sorce in the future TODO: think about adding an enum or something that will delimit the type of processor(vision/filewatcher/network/audio) TODO: in the future we can add tabs/filepaths to this model here. TODO: Enum for source/processor ? i.e. WorkstreamPatternEngineProcessorEnum.VISION, WorkstreamPatternEngineProcessorEnum.NETWORK, WorkstreamPatternEngineProcessorEnum.FILE_IO, WorkstreamPatternEngineProcessorEnum.AUDIO, etc. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**name** | **str** | This is the name of the window(foreground window)/application.(this will always be present) | + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_source import WorkstreamPatternEngineSource + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineSource from a JSON string +workstream_pattern_engine_source_instance = WorkstreamPatternEngineSource.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineSource.to_json() + +# convert the object into a dict +workstream_pattern_engine_source_dict = workstream_pattern_engine_source_instance.to_dict() +# create an instance of WorkstreamPatternEngineSource from a dict +workstream_pattern_engine_source_from_dict = WorkstreamPatternEngineSource.from_dict(workstream_pattern_engine_source_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/WorkstreamPatternEngineSources.md b/docs/WorkstreamPatternEngineSources.md new file mode 100644 index 0000000..b6ef37a --- /dev/null +++ b/docs/WorkstreamPatternEngineSources.md @@ -0,0 +1,30 @@ +# WorkstreamPatternEngineSources + +This is a plural version of the WPE qdrant applications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[WorkstreamPatternEngineSource]**](WorkstreamPatternEngineSource.md) | | + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineSources from a JSON string +workstream_pattern_engine_sources_instance = WorkstreamPatternEngineSources.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineSources.to_json() + +# convert the object into a dict +workstream_pattern_engine_sources_dict = workstream_pattern_engine_sources_instance.to_dict() +# create an instance of WorkstreamPatternEngineSources from a dict +workstream_pattern_engine_sources_from_dict = WorkstreamPatternEngineSources.from_dict(workstream_pattern_engine_sources_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/WorkstreamPatternEngineStatus.md b/docs/WorkstreamPatternEngineStatus.md index c91980c..5d93d6f 100644 --- a/docs/WorkstreamPatternEngineStatus.md +++ b/docs/WorkstreamPatternEngineStatus.md @@ -23,7 +23,7 @@ print WorkstreamPatternEngineStatus.to_json() # convert the object into a dict workstream_pattern_engine_status_dict = workstream_pattern_engine_status_instance.to_dict() # create an instance of WorkstreamPatternEngineStatus from a dict -workstream_pattern_engine_status_form_dict = workstream_pattern_engine_status.from_dict(workstream_pattern_engine_status_dict) +workstream_pattern_engine_status_from_dict = WorkstreamPatternEngineStatus.from_dict(workstream_pattern_engine_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/WorkstreamPatternEngineVisionCalibration.md b/docs/WorkstreamPatternEngineVisionCalibration.md new file mode 100644 index 0000000..1aedf2a --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionCalibration.md @@ -0,0 +1,32 @@ +# WorkstreamPatternEngineVisionCalibration + +This model is used for the dimensions of the copilot/feed/xyz window. if dimensions/captured are null this means we do not have the dimensions for this given window. TODO: consider adding 5 markers here for the qr codes(ie location of these as wel) NOTE: will want to add type of calibration for this specific dimension(ie copilot/feed/xyz) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**foreground** | **str** | This is the name of the window(foreground window).(this will always be present) | +**captured** | [**GroupedTimestamp**](GroupedTimestamp.md) | | [optional] +**dimensions** | [**WindowDimensions**](WindowDimensions.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionCalibration from a JSON string +workstream_pattern_engine_vision_calibration_instance = WorkstreamPatternEngineVisionCalibration.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionCalibration.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_calibration_dict = workstream_pattern_engine_vision_calibration_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionCalibration from a dict +workstream_pattern_engine_vision_calibration_from_dict = WorkstreamPatternEngineVisionCalibration.from_dict(workstream_pattern_engine_vision_calibration_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/WorkstreamPatternEngineVisionCalibrations.md b/docs/WorkstreamPatternEngineVisionCalibrations.md new file mode 100644 index 0000000..8850f2d --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionCalibrations.md @@ -0,0 +1,30 @@ +# WorkstreamPatternEngineVisionCalibrations + +TODO: description This the plural of a single copilot Capture. This will return all the the given copilot captures + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[WorkstreamPatternEngineVisionCalibration]**](WorkstreamPatternEngineVisionCalibration.md) | | + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_calibrations import WorkstreamPatternEngineVisionCalibrations + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionCalibrations from a JSON string +workstream_pattern_engine_vision_calibrations_instance = WorkstreamPatternEngineVisionCalibrations.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionCalibrations.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_calibrations_dict = workstream_pattern_engine_vision_calibrations_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionCalibrations from a dict +workstream_pattern_engine_vision_calibrations_from_dict = WorkstreamPatternEngineVisionCalibrations.from_dict(workstream_pattern_engine_vision_calibrations_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/WorkstreamPatternEngineVisionEvent.md b/docs/WorkstreamPatternEngineVisionEvent.md new file mode 100644 index 0000000..aab7171 --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionEvent.md @@ -0,0 +1,33 @@ +# WorkstreamPatternEngineVisionEvent + +This will return a specific event for the WPE. note: value is nullable here because we may want to pass in transferables:true/false + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**id** | **str** | | +**created** | [**GroupedTimestamp**](GroupedTimestamp.md) | | +**source** | [**WorkstreamPatternEngineSource**](WorkstreamPatternEngineSource.md) | | [optional] +**textual** | [**WorkstreamPatternEngineVisionEventTextualValue**](WorkstreamPatternEngineVisionEventTextualValue.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionEvent from a JSON string +workstream_pattern_engine_vision_event_instance = WorkstreamPatternEngineVisionEvent.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionEvent.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_event_dict = workstream_pattern_engine_vision_event_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionEvent from a dict +workstream_pattern_engine_vision_event_from_dict = WorkstreamPatternEngineVisionEvent.from_dict(workstream_pattern_engine_vision_event_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/WorkstreamPatternEngineVisionEventDeletions.md b/docs/WorkstreamPatternEngineVisionEventDeletions.md new file mode 100644 index 0000000..fe8bd7a --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionEventDeletions.md @@ -0,0 +1,31 @@ +# WorkstreamPatternEngineVisionEventDeletions + +note: recomended to use the search option here(where you can pass in workstream. note: \"scope\" here will run a search with the given scope and then remove these events. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**search_scope** | [**SearchInput**](SearchInput.md) | | [optional] +**identifiers** | [**FlattenedWorkstreamPatternEngineVisionEvents**](FlattenedWorkstreamPatternEngineVisionEvents.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_event_deletions import WorkstreamPatternEngineVisionEventDeletions + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionEventDeletions from a JSON string +workstream_pattern_engine_vision_event_deletions_instance = WorkstreamPatternEngineVisionEventDeletions.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionEventDeletions.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_event_deletions_dict = workstream_pattern_engine_vision_event_deletions_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionEventDeletions from a dict +workstream_pattern_engine_vision_event_deletions_from_dict = WorkstreamPatternEngineVisionEventDeletions.from_dict(workstream_pattern_engine_vision_event_deletions_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/WorkstreamPatternEngineVisionEventTextualValue.md b/docs/WorkstreamPatternEngineVisionEventTextualValue.md new file mode 100644 index 0000000..429326b --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionEventTextualValue.md @@ -0,0 +1,31 @@ +# WorkstreamPatternEngineVisionEventTextualValue + +note: we could add a summarize property. TODO: might need an extracted bool to say to aggregate the extracted + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**ocr** | [**TransferableString**](TransferableString.md) | | [optional] +**extracted** | [**TextuallyExtractedMaterial**](TextuallyExtractedMaterial.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_event_textual_value import WorkstreamPatternEngineVisionEventTextualValue + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionEventTextualValue from a JSON string +workstream_pattern_engine_vision_event_textual_value_instance = WorkstreamPatternEngineVisionEventTextualValue.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionEventTextualValue.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_event_textual_value_dict = workstream_pattern_engine_vision_event_textual_value_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionEventTextualValue from a dict +workstream_pattern_engine_vision_event_textual_value_from_dict = WorkstreamPatternEngineVisionEventTextualValue.from_dict(workstream_pattern_engine_vision_event_textual_value_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/WorkstreamPatternEngineVisionEvents.md b/docs/WorkstreamPatternEngineVisionEvents.md new file mode 100644 index 0000000..6f9a56e --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionEvents.md @@ -0,0 +1,30 @@ +# WorkstreamPatternEngineVisionEvents + +This is a plural snapshot of all of the events within WPE qdrant + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**iterable** | [**List[WorkstreamPatternEngineVisionEvent]**](WorkstreamPatternEngineVisionEvent.md) | | + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_events import WorkstreamPatternEngineVisionEvents + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionEvents from a JSON string +workstream_pattern_engine_vision_events_instance = WorkstreamPatternEngineVisionEvents.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionEvents.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_events_dict = workstream_pattern_engine_vision_events_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionEvents from a dict +workstream_pattern_engine_vision_events_from_dict = WorkstreamPatternEngineVisionEvents.from_dict(workstream_pattern_engine_vision_events_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/WorkstreamPatternEngineVisionEventsMetadata.md b/docs/WorkstreamPatternEngineVisionEventsMetadata.md new file mode 100644 index 0000000..27551d2 --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionEventsMetadata.md @@ -0,0 +1,33 @@ +# WorkstreamPatternEngineVisionEventsMetadata + +This is specific model that will return the size of the WPE in bytes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**bytes** | [**ByteDescriptor**](ByteDescriptor.md) | | +**total** | **int** | This is the total number of events. | +**oldest** | [**WorkstreamPatternEngineVisionEvent**](WorkstreamPatternEngineVisionEvent.md) | | [optional] +**newest** | [**WorkstreamPatternEngineVisionEvent**](WorkstreamPatternEngineVisionEvent.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_events_metadata import WorkstreamPatternEngineVisionEventsMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionEventsMetadata from a JSON string +workstream_pattern_engine_vision_events_metadata_instance = WorkstreamPatternEngineVisionEventsMetadata.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionEventsMetadata.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_events_metadata_dict = workstream_pattern_engine_vision_events_metadata_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionEventsMetadata from a dict +workstream_pattern_engine_vision_events_metadata_from_dict = WorkstreamPatternEngineVisionEventsMetadata.from_dict(workstream_pattern_engine_vision_events_metadata_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/WorkstreamPatternEngineVisionMetadata.md b/docs/WorkstreamPatternEngineVisionMetadata.md new file mode 100644 index 0000000..7ffed90 --- /dev/null +++ b/docs/WorkstreamPatternEngineVisionMetadata.md @@ -0,0 +1,30 @@ +# WorkstreamPatternEngineVisionMetadata + +This will return all the WPE vision specific metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**events** | [**WorkstreamPatternEngineVisionEventsMetadata**](WorkstreamPatternEngineVisionEventsMetadata.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_pattern_engine_vision_metadata import WorkstreamPatternEngineVisionMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamPatternEngineVisionMetadata from a JSON string +workstream_pattern_engine_vision_metadata_instance = WorkstreamPatternEngineVisionMetadata.from_json(json) +# print the JSON string representation of the object +print WorkstreamPatternEngineVisionMetadata.to_json() + +# convert the object into a dict +workstream_pattern_engine_vision_metadata_dict = workstream_pattern_engine_vision_metadata_instance.to_dict() +# create an instance of WorkstreamPatternEngineVisionMetadata from a dict +workstream_pattern_engine_vision_metadata_from_dict = WorkstreamPatternEngineVisionMetadata.from_dict(workstream_pattern_engine_vision_metadata_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/WorkstreamPatternEngineVisionStatus.md b/docs/WorkstreamPatternEngineVisionStatus.md index d4c38e4..50e6dbb 100644 --- a/docs/WorkstreamPatternEngineVisionStatus.md +++ b/docs/WorkstreamPatternEngineVisionStatus.md @@ -24,7 +24,7 @@ print WorkstreamPatternEngineVisionStatus.to_json() # convert the object into a dict workstream_pattern_engine_vision_status_dict = workstream_pattern_engine_vision_status_instance.to_dict() # create an instance of WorkstreamPatternEngineVisionStatus from a dict -workstream_pattern_engine_vision_status_form_dict = workstream_pattern_engine_vision_status.from_dict(workstream_pattern_engine_vision_status_dict) +workstream_pattern_engine_vision_status_from_dict = WorkstreamPatternEngineVisionStatus.from_dict(workstream_pattern_engine_vision_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/WorkstreamSearchOptions.md b/docs/WorkstreamSearchOptions.md new file mode 100644 index 0000000..7f99d19 --- /dev/null +++ b/docs/WorkstreamSearchOptions.md @@ -0,0 +1,30 @@ +# WorkstreamSearchOptions + +This is a search realted to the workstream pattern engine data, for instance in a WPE/vision/search we will want to be able to search via a WorkstreamPatternEngineSource. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_schema** | [**EmbeddedModelSchema**](EmbeddedModelSchema.md) | | [optional] +**sources** | [**WorkstreamPatternEngineSources**](WorkstreamPatternEngineSources.md) | | [optional] + +## Example + +```python +from pieces_os_client.models.workstream_search_options import WorkstreamSearchOptions + +# TODO update the JSON string below +json = "{}" +# create an instance of WorkstreamSearchOptions from a JSON string +workstream_search_options_instance = WorkstreamSearchOptions.from_json(json) +# print the JSON string representation of the object +print WorkstreamSearchOptions.to_json() + +# convert the object into a dict +workstream_search_options_dict = workstream_search_options_instance.to_dict() +# create an instance of WorkstreamSearchOptions from a dict +workstream_search_options_from_dict = WorkstreamSearchOptions.from_dict(workstream_search_options_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/WorkstreamSuggestion.md b/docs/WorkstreamSuggestion.md index 6ef6c27..e3f622e 100644 --- a/docs/WorkstreamSuggestion.md +++ b/docs/WorkstreamSuggestion.md @@ -13,6 +13,8 @@ Name | Type | Description | Notes **anchor** | [**ReferencedAnchor**](ReferencedAnchor.md) | | [optional] **conversation** | [**ReferencedConversation**](ReferencedConversation.md) | | [optional] **person** | [**ReferencedPerson**](ReferencedPerson.md) | | [optional] +**seed** | [**Seed**](Seed.md) | | [optional] +**seeds** | [**Seeds**](Seeds.md) | | [optional] **summaries** | [**FlattenedWorkstreamSummaries**](FlattenedWorkstreamSummaries.md) | | [optional] **assets** | [**FlattenedAssets**](FlattenedAssets.md) | | [optional] **tags** | [**FlattenedTags**](FlattenedTags.md) | | [optional] @@ -38,7 +40,7 @@ print WorkstreamSuggestion.to_json() # convert the object into a dict workstream_suggestion_dict = workstream_suggestion_instance.to_dict() # create an instance of WorkstreamSuggestion from a dict -workstream_suggestion_form_dict = workstream_suggestion.from_dict(workstream_suggestion_dict) +workstream_suggestion_from_dict = WorkstreamSuggestion.from_dict(workstream_suggestion_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/WorkstreamSuggestionType.md b/docs/WorkstreamSuggestionType.md index 801c1bf..135b11e 100644 --- a/docs/WorkstreamSuggestionType.md +++ b/docs/WorkstreamSuggestionType.md @@ -13,6 +13,8 @@ Name | Type | Description | Notes **anchor** | **bool** | | [optional] **conversation** | **bool** | | [optional] **person** | **bool** | | [optional] +**seed** | **bool** | | [optional] +**seeds** | **bool** | | [optional] **summaries** | **bool** | | [optional] **assets** | **bool** | | [optional] **tags** | **bool** | | [optional] @@ -36,7 +38,7 @@ print WorkstreamSuggestionType.to_json() # convert the object into a dict workstream_suggestion_type_dict = workstream_suggestion_type_instance.to_dict() # create an instance of WorkstreamSuggestionType from a dict -workstream_suggestion_type_form_dict = workstream_suggestion_type.from_dict(workstream_suggestion_type_dict) +workstream_suggestion_type_from_dict = WorkstreamSuggestionType.from_dict(workstream_suggestion_type_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/WorkstreamSuggestions.md b/docs/WorkstreamSuggestions.md index c4bd07e..5e6f6b0 100644 --- a/docs/WorkstreamSuggestions.md +++ b/docs/WorkstreamSuggestions.md @@ -24,7 +24,7 @@ print WorkstreamSuggestions.to_json() # convert the object into a dict workstream_suggestions_dict = workstream_suggestions_instance.to_dict() # create an instance of WorkstreamSuggestions from a dict -workstream_suggestions_form_dict = workstream_suggestions.from_dict(workstream_suggestions_dict) +workstream_suggestions_from_dict = WorkstreamSuggestions.from_dict(workstream_suggestions_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/WorkstreamSuggestionsRefresh.md b/docs/WorkstreamSuggestionsRefresh.md index a0084d1..086d5e2 100644 --- a/docs/WorkstreamSuggestionsRefresh.md +++ b/docs/WorkstreamSuggestionsRefresh.md @@ -23,7 +23,7 @@ print WorkstreamSuggestionsRefresh.to_json() # convert the object into a dict workstream_suggestions_refresh_dict = workstream_suggestions_refresh_instance.to_dict() # create an instance of WorkstreamSuggestionsRefresh from a dict -workstream_suggestions_refresh_form_dict = workstream_suggestions_refresh.from_dict(workstream_suggestions_refresh_dict) +workstream_suggestions_refresh_from_dict = WorkstreamSuggestionsRefresh.from_dict(workstream_suggestions_refresh_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/WorkstreamSummaries.md b/docs/WorkstreamSummaries.md index 3c6141f..b0191b6 100644 --- a/docs/WorkstreamSummaries.md +++ b/docs/WorkstreamSummaries.md @@ -25,7 +25,7 @@ print WorkstreamSummaries.to_json() # convert the object into a dict workstream_summaries_dict = workstream_summaries_instance.to_dict() # create an instance of WorkstreamSummaries from a dict -workstream_summaries_form_dict = workstream_summaries.from_dict(workstream_summaries_dict) +workstream_summaries_from_dict = WorkstreamSummaries.from_dict(workstream_summaries_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/WorkstreamSummariesApi.md b/docs/WorkstreamSummariesApi.md index 4e1901c..684d55c 100644 --- a/docs/WorkstreamSummariesApi.md +++ b/docs/WorkstreamSummariesApi.md @@ -4,11 +4,83 @@ All URIs are relative to *http://localhost:1000* Method | HTTP request | Description ------------- | ------------- | ------------- +[**search_workstream_summaries**](WorkstreamSummariesApi.md#search_workstream_summaries) | **POST** /workstream_summaries/search | /workstream_summaries/search [POST] [**workstream_summaries_create_new_workstream_summary**](WorkstreamSummariesApi.md#workstream_summaries_create_new_workstream_summary) | **POST** /workstream_summaries/create | /workstream_summaries/create [POST] [**workstream_summaries_delete_specific_workstream_summary**](WorkstreamSummariesApi.md#workstream_summaries_delete_specific_workstream_summary) | **POST** /workstream_summaries/{workstream_summary}/delete | /workstream_summaries/{workstream_summary}/delete [POST] [**workstream_summaries_snapshot**](WorkstreamSummariesApi.md#workstream_summaries_snapshot) | **GET** /workstream_summaries | /workstream_summaries [GET] +# **search_workstream_summaries** +> SearchedWorkstreamSummaries search_workstream_summaries(transferables=transferables, search_input=search_input) + +/workstream_summaries/search [POST] + +This will search your workstream_summaries for a specific workstream_summary note: we will just search the summary value(which is an annotation) + +### Example + +```python +import time +import os +import pieces_os_client +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_workstream_summaries import SearchedWorkstreamSummaries +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.WorkstreamSummariesApi(api_client) + transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) + search_input = pieces_os_client.SearchInput() # SearchInput | (optional) + + try: + # /workstream_summaries/search [POST] + api_response = api_instance.search_workstream_summaries(transferables=transferables, search_input=search_input) + print("The response of WorkstreamSummariesApi->search_workstream_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkstreamSummariesApi->search_workstream_summaries: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transferables** | **bool**| This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) | [optional] + **search_input** | [**SearchInput**](SearchInput.md)| | [optional] + +### Return type + +[**SearchedWorkstreamSummaries**](SearchedWorkstreamSummaries.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, text/plain + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**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) + # **workstream_summaries_create_new_workstream_summary** > WorkstreamSummary workstream_summaries_create_new_workstream_summary(transferables=transferables, seeded_workstream_summary=seeded_workstream_summary) diff --git a/docs/WorkstreamSummary.md b/docs/WorkstreamSummary.md index aea1a6c..76583b3 100644 --- a/docs/WorkstreamSummary.md +++ b/docs/WorkstreamSummary.md @@ -37,7 +37,7 @@ print WorkstreamSummary.to_json() # convert the object into a dict workstream_summary_dict = workstream_summary_instance.to_dict() # create an instance of WorkstreamSummary from a dict -workstream_summary_form_dict = workstream_summary.from_dict(workstream_summary_dict) +workstream_summary_from_dict = WorkstreamSummary.from_dict(workstream_summary_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/pyproject.toml b/pyproject.toml index 5f468fb..3e33a92 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pieces_os_client" -version = "2.2.0" +version = "2.3.0" description = "A powerful code engine package for writing applications on top of Pieces OS" authors = ["Pieces "] license = "MIT" diff --git a/src/pieces_os_client/__init__.py b/src/pieces_os_client/__init__.py index 3cc0b70..d58deba 100644 --- a/src/pieces_os_client/__init__.py +++ b/src/pieces_os_client/__init__.py @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "2.2.0" +__version__ = "2.3.0" # import apis into sdk package from pieces_os_client.api.activities_api import ActivitiesApi @@ -108,6 +108,7 @@ from pieces_os_client.models.access_enum import AccessEnum from pieces_os_client.models.accessor import Accessor from pieces_os_client.models.accessors import Accessors +from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet from pieces_os_client.models.activities import Activities from pieces_os_client.models.activity import Activity from pieces_os_client.models.aesthetics import Aesthetics @@ -165,7 +166,6 @@ from pieces_os_client.models.byte_descriptor import ByteDescriptor from pieces_os_client.models.capabilities_enum import CapabilitiesEnum from pieces_os_client.models.challenged_pkce import ChallengedPKCE -from pieces_os_client.models.checked_os_update import CheckedOSUpdate from pieces_os_client.models.classification import Classification from pieces_os_client.models.classification_generic_enum import ClassificationGenericEnum from pieces_os_client.models.classification_rendering_enum import ClassificationRenderingEnum @@ -205,6 +205,8 @@ from pieces_os_client.models.embedded_model_schema_semantic_version_enum import EmbeddedModelSchemaSemanticVersionEnum from pieces_os_client.models.embedding import Embedding from pieces_os_client.models.embeddings import Embeddings +from pieces_os_client.models.embeddings_search_options import EmbeddingsSearchOptions +from pieces_os_client.models.embeddings_search_options_embedding_type_enum import EmbeddingsSearchOptionsEmbeddingTypeEnum from pieces_os_client.models.existent_metadata import ExistentMetadata from pieces_os_client.models.existing_metadata import ExistingMetadata from pieces_os_client.models.exported_asset import ExportedAsset @@ -260,6 +262,8 @@ from pieces_os_client.models.flattened_websites import FlattenedWebsites from pieces_os_client.models.flattened_workstream_event import FlattenedWorkstreamEvent from pieces_os_client.models.flattened_workstream_events import FlattenedWorkstreamEvents +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_event import FlattenedWorkstreamPatternEngineVisionEvent +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents from pieces_os_client.models.flattened_workstream_summaries import FlattenedWorkstreamSummaries from pieces_os_client.models.flattened_workstream_summary import FlattenedWorkstreamSummary from pieces_os_client.models.font import Font @@ -270,6 +274,7 @@ from pieces_os_client.models.formats_metrics import FormatsMetrics from pieces_os_client.models.fragment_format import FragmentFormat from pieces_os_client.models.fragment_metadata import FragmentMetadata +from pieces_os_client.models.full_text_search_options import FullTextSearchOptions from pieces_os_client.models.git_hub_distribution import GitHubDistribution from pieces_os_client.models.git_hub_gist_distribution import GitHubGistDistribution from pieces_os_client.models.graphical_image_descriptive_statistics import GraphicalImageDescriptiveStatistics @@ -292,6 +297,7 @@ from pieces_os_client.models.ide_tabs import IDETabs from pieces_os_client.models.image_analyses import ImageAnalyses from pieces_os_client.models.image_analysis import ImageAnalysis +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet from pieces_os_client.models.interacted_asset import InteractedAsset from pieces_os_client.models.interacted_asset_interactions import InteractedAssetInteractions from pieces_os_client.models.interacted_assets import InteractedAssets @@ -327,15 +333,22 @@ from pieces_os_client.models.o_auth_token import OAuthToken from pieces_os_client.models.ocr_analyses import OCRAnalyses from pieces_os_client.models.ocr_analysis import OCRAnalysis +from pieces_os_client.models.os_applet_enum import OSAppletEnum from pieces_os_client.models.os_device_cpu_hardware_information import OSDeviceCPUHardwareInformation from pieces_os_client.models.os_device_dependencies_information import OSDeviceDependenciesInformation from pieces_os_client.models.os_device_gpu_hardware_capabilities_information import OSDeviceGPUHardwareCapabilitiesInformation from pieces_os_client.models.os_device_gpu_hardware_information import OSDeviceGPUHardwareInformation from pieces_os_client.models.os_device_hardware_information import OSDeviceHardwareInformation from pieces_os_client.models.os_device_information_returnable import OSDeviceInformationReturnable +from pieces_os_client.models.os_file_streaming_read import OSFileStreamingRead +from pieces_os_client.models.os_file_streaming_read_attempt import OSFileStreamingReadAttempt +from pieces_os_client.models.os_file_streaming_read_progress import OSFileStreamingReadProgress from pieces_os_client.models.os_health import OSHealth from pieces_os_client.models.os_permissions import OSPermissions from pieces_os_client.models.os_processing_permissions import OSProcessingPermissions +from pieces_os_client.models.os_server_metadata import OSServerMetadata +from pieces_os_client.models.os_server_settings import OSServerSettings +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus from pieces_os_client.models.onboarded_persona_details import OnboardedPersonaDetails from pieces_os_client.models.open_ai_models_list_input import OpenAIModelsListInput from pieces_os_client.models.open_ai_models_list_output import OpenAIModelsListOutput @@ -384,6 +397,8 @@ from pieces_os_client.models.qgpt_stream_enum import QGPTStreamEnum from pieces_os_client.models.qgpt_stream_input import QGPTStreamInput from pieces_os_client.models.qgpt_stream_output import QGPTStreamOutput +from pieces_os_client.models.qgpt_streamed_output_extracted_materials import QGPTStreamedOutputExtractedMaterials +from pieces_os_client.models.qgpt_streamed_output_extracted_textual_materials import QGPTStreamedOutputExtractedTextualMaterials from pieces_os_client.models.qgpt_task_pipeline import QGPTTaskPipeline from pieces_os_client.models.qgpt_task_pipeline_for_code_commentation import QGPTTaskPipelineForCodeCommentation from pieces_os_client.models.qgpt_task_pipeline_for_code_completion import QGPTTaskPipelineForCodeCompletion @@ -413,6 +428,7 @@ from pieces_os_client.models.referenced_user import ReferencedUser from pieces_os_client.models.referenced_website import ReferencedWebsite from pieces_os_client.models.referenced_workstream_event import ReferencedWorkstreamEvent +from pieces_os_client.models.referenced_workstream_pattern_engine_vision_event import ReferencedWorkstreamPatternEngineVisionEvent from pieces_os_client.models.referenced_workstream_summary import ReferencedWorkstreamSummary from pieces_os_client.models.relationship import Relationship from pieces_os_client.models.relationships import Relationships @@ -426,9 +442,36 @@ from pieces_os_client.models.role import Role from pieces_os_client.models.save_suggestion import SaveSuggestion from pieces_os_client.models.score import Score +from pieces_os_client.models.search_engine import SearchEngine +from pieces_os_client.models.search_engines import SearchEngines +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_anchor import SearchedAnchor +from pieces_os_client.models.searched_anchor_point import SearchedAnchorPoint +from pieces_os_client.models.searched_anchor_points import SearchedAnchorPoints +from pieces_os_client.models.searched_anchors import SearchedAnchors +from pieces_os_client.models.searched_annotation import SearchedAnnotation +from pieces_os_client.models.searched_annotations import SearchedAnnotations from pieces_os_client.models.searched_asset import SearchedAsset from pieces_os_client.models.searched_assets import SearchedAssets +from pieces_os_client.models.searched_conversation import SearchedConversation +from pieces_os_client.models.searched_conversation_message import SearchedConversationMessage +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages +from pieces_os_client.models.searched_conversations import SearchedConversations +from pieces_os_client.models.searched_hint import SearchedHint +from pieces_os_client.models.searched_hints import SearchedHints from pieces_os_client.models.searched_match_enum import SearchedMatchEnum +from pieces_os_client.models.searched_person import SearchedPerson +from pieces_os_client.models.searched_persons import SearchedPersons +from pieces_os_client.models.searched_sensitive import SearchedSensitive +from pieces_os_client.models.searched_sensitives import SearchedSensitives +from pieces_os_client.models.searched_tag import SearchedTag +from pieces_os_client.models.searched_tags import SearchedTags +from pieces_os_client.models.searched_website import SearchedWebsite +from pieces_os_client.models.searched_websites import SearchedWebsites +from pieces_os_client.models.searched_workstream_pattern_engine_vision_event import SearchedWorkstreamPatternEngineVisionEvent +from pieces_os_client.models.searched_workstream_pattern_engine_vision_events import SearchedWorkstreamPatternEngineVisionEvents +from pieces_os_client.models.searched_workstream_summaries import SearchedWorkstreamSummaries +from pieces_os_client.models.searched_workstream_summary import SearchedWorkstreamSummary from pieces_os_client.models.seed import Seed from pieces_os_client.models.seeded_accessor import SeededAccessor from pieces_os_client.models.seeded_activity import SeededActivity @@ -547,8 +590,12 @@ from pieces_os_client.models.tag_category_enum import TagCategoryEnum from pieces_os_client.models.tags import Tags from pieces_os_client.models.temporal_range_grounding import TemporalRangeGrounding +from pieces_os_client.models.temporal_search_options import TemporalSearchOptions +from pieces_os_client.models.terminating_os_server_applet import TerminatingOSServerApplet from pieces_os_client.models.text_location import TextLocation from pieces_os_client.models.text_match import TextMatch +from pieces_os_client.models.textually_extracted_material import TextuallyExtractedMaterial +from pieces_os_client.models.textually_extracted_materials import TextuallyExtractedMaterials from pieces_os_client.models.theme import Theme from pieces_os_client.models.tokenized_pkce import TokenizedPKCE from pieces_os_client.models.tracked_application_install import TrackedApplicationInstall @@ -573,18 +620,21 @@ from pieces_os_client.models.tracked_interaction_event import TrackedInteractionEvent from pieces_os_client.models.tracked_keyboard_event import TrackedKeyboardEvent from pieces_os_client.models.tracked_session_event_identifier_description_pairs import TrackedSessionEventIdentifierDescriptionPairs +from pieces_os_client.models.tracked_summary_totals import TrackedSummaryTotals from pieces_os_client.models.tracked_user_profile import TrackedUserProfile from pieces_os_client.models.transferable_bytes import TransferableBytes from pieces_os_client.models.transferable_string import TransferableString -from pieces_os_client.models.unchecked_os_update import UncheckedOSUpdate +from pieces_os_client.models.unchecked_os_server_update import UncheckedOSServerUpdate from pieces_os_client.models.unsegmented_technical_language import UnsegmentedTechnicalLanguage from pieces_os_client.models.updated_external_provider_api_key import UpdatedExternalProviderApiKey from pieces_os_client.models.updating_status_enum import UpdatingStatusEnum from pieces_os_client.models.user_beta_status import UserBetaStatus from pieces_os_client.models.user_profile import UserProfile from pieces_os_client.models.users import Users +from pieces_os_client.models.verified_os_filesystem_path import VerifiedOSFilesystemPath from pieces_os_client.models.website import Website from pieces_os_client.models.websites import Websites +from pieces_os_client.models.window_dimensions import WindowDimensions from pieces_os_client.models.workstream_event import WorkstreamEvent from pieces_os_client.models.workstream_event_context import WorkstreamEventContext from pieces_os_client.models.workstream_event_trigger import WorkstreamEventTrigger @@ -593,8 +643,19 @@ from pieces_os_client.models.workstream_events import WorkstreamEvents from pieces_os_client.models.workstream_ingestion import WorkstreamIngestion from pieces_os_client.models.workstream_pattern_engine_data_cleanup_request import WorkstreamPatternEngineDataCleanupRequest +from pieces_os_client.models.workstream_pattern_engine_source import WorkstreamPatternEngineSource +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration +from pieces_os_client.models.workstream_pattern_engine_vision_calibrations import WorkstreamPatternEngineVisionCalibrations +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent +from pieces_os_client.models.workstream_pattern_engine_vision_event_deletions import WorkstreamPatternEngineVisionEventDeletions +from pieces_os_client.models.workstream_pattern_engine_vision_event_textual_value import WorkstreamPatternEngineVisionEventTextualValue +from pieces_os_client.models.workstream_pattern_engine_vision_events import WorkstreamPatternEngineVisionEvents +from pieces_os_client.models.workstream_pattern_engine_vision_events_metadata import WorkstreamPatternEngineVisionEventsMetadata +from pieces_os_client.models.workstream_pattern_engine_vision_metadata import WorkstreamPatternEngineVisionMetadata from pieces_os_client.models.workstream_pattern_engine_vision_status import WorkstreamPatternEngineVisionStatus +from pieces_os_client.models.workstream_search_options import WorkstreamSearchOptions from pieces_os_client.models.workstream_suggestion import WorkstreamSuggestion from pieces_os_client.models.workstream_suggestion_type import WorkstreamSuggestionType from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions diff --git a/src/pieces_os_client/api/anchor_api.py b/src/pieces_os_client/api/anchor_api.py index f33be24..fb03871 100644 --- a/src/pieces_os_client/api/anchor_api.py +++ b/src/pieces_os_client/api/anchor_api.py @@ -339,6 +339,152 @@ def anchor_associate_conversation_with_http_info(self, anchor : Annotated[Strict collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def anchor_associate_person(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> None: # noqa: E501 + """/anchor/{anchor}/persons/associate/{person} [POST] # noqa: E501 + + associates an anchor and a person. It performs the same action as the person equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.anchor_associate_person(anchor, person, async_req=True) + >>> result = thread.get() + + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param person: This is a uuid that represents a person. (required) + :type person: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the anchor_associate_person_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.anchor_associate_person_with_http_info(anchor, person, **kwargs) # noqa: E501 + + @validate_arguments + def anchor_associate_person_with_http_info(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> ApiResponse: # noqa: E501 + """/anchor/{anchor}/persons/associate/{person} [POST] # noqa: E501 + + associates an anchor and a person. It performs the same action as the person equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.anchor_associate_person_with_http_info(anchor, person, async_req=True) + >>> result = thread.get() + + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param person: This is a uuid that represents a person. (required) + :type person: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'anchor', + 'person' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method anchor_associate_person" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['anchor'] is not None: + _path_params['anchor'] = _params['anchor'] + + if _params['person'] is not None: + _path_params['person'] = _params['person'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/anchor/{anchor}/persons/associate/{person}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def anchor_associate_workstream_summary(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], workstream_summary : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific workstream_summary.")], **kwargs) -> None: # noqa: E501 """/anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST] # noqa: E501 @@ -777,6 +923,152 @@ def anchor_disassociate_conversation_with_http_info(self, anchor : Annotated[Str collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def anchor_disassociate_person(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> None: # noqa: E501 + """/anchor/{anchor}/persons/disassociate/{person} [POST] # noqa: E501 + + Disassociates an anchor from a person. It performs the same action as the person equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.anchor_disassociate_person(anchor, person, async_req=True) + >>> result = thread.get() + + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param person: This is a uuid that represents a person. (required) + :type person: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the anchor_disassociate_person_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.anchor_disassociate_person_with_http_info(anchor, person, **kwargs) # noqa: E501 + + @validate_arguments + def anchor_disassociate_person_with_http_info(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> ApiResponse: # noqa: E501 + """/anchor/{anchor}/persons/disassociate/{person} [POST] # noqa: E501 + + Disassociates an anchor from a person. It performs the same action as the person equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.anchor_disassociate_person_with_http_info(anchor, person, async_req=True) + >>> result = thread.get() + + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param person: This is a uuid that represents a person. (required) + :type person: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'anchor', + 'person' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method anchor_disassociate_person" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['anchor'] is not None: + _path_params['anchor'] = _params['anchor'] + + if _params['person'] is not None: + _path_params['person'] = _params['person'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/anchor/{anchor}/persons/disassociate/{person}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def anchor_disassociate_workstream_summary(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], workstream_summary : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific workstream_summary.")], **kwargs) -> None: # noqa: E501 """/anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/anchors_api.py b/src/pieces_os_client/api/anchors_api.py index 5c55d6f..2da318e 100644 --- a/src/pieces_os_client/api/anchors_api.py +++ b/src/pieces_os_client/api/anchors_api.py @@ -26,6 +26,8 @@ from pieces_os_client.models.anchor import Anchor from pieces_os_client.models.anchors import Anchors +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_anchors import SearchedAnchors from pieces_os_client.models.seeded_anchor import SeededAnchor from pieces_os_client.api_client import ApiClient @@ -343,20 +345,18 @@ def anchors_delete_specific_anchor_with_http_info(self, anchor : Annotated[Stric _request_auth=_params.get('_request_auth')) @validate_arguments - def anchors_disassociate_asset(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 - """/anchors/{anchor}/assets/delete/{asset} [POST] # noqa: E501 + def anchors_snapshot(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> Anchors: # noqa: E501 + """/anchors [GET] # noqa: E501 - This will update both the asset and the anchor reference, that will remove a anchor from an asset(only the references). This will NOT remove the anchor. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will deprecate this at some point,(please use the AnchorAPI) # noqa: E501 + This will get a snapshot of all your anchors. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.anchors_disassociate_asset(anchor, asset, async_req=True) + >>> thread = api.anchors_snapshot(transferables, async_req=True) >>> result = thread.get() - :param anchor: This is the specific uuid of an anchor. (required) - :type anchor: str - :param asset: The id (uuid) of the asset that you are trying to access. (required) - :type asset: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -366,29 +366,27 @@ def anchors_disassociate_asset(self, anchor : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: Anchors """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the anchors_disassociate_asset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the anchors_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.anchors_disassociate_asset_with_http_info(anchor, asset, **kwargs) # noqa: E501 + return self.anchors_snapshot_with_http_info(transferables, **kwargs) # noqa: E501 @validate_arguments - def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> ApiResponse: # noqa: E501 - """/anchors/{anchor}/assets/delete/{asset} [POST] # noqa: E501 + def anchors_snapshot_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/anchors [GET] # noqa: E501 - This will update both the asset and the anchor reference, that will remove a anchor from an asset(only the references). This will NOT remove the anchor. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will deprecate this at some point,(please use the AnchorAPI) # noqa: E501 + This will get a snapshot of all your anchors. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.anchors_disassociate_asset_with_http_info(anchor, asset, async_req=True) + >>> thread = api.anchors_snapshot_with_http_info(transferables, async_req=True) >>> result = thread.get() - :param anchor: This is the specific uuid of an anchor. (required) - :type anchor: str - :param asset: The id (uuid) of the asset that you are trying to access. (required) - :type asset: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -411,14 +409,13 @@ def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(Anchors, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'anchor', - 'asset' + 'transferables' ] _all_params.extend( [ @@ -437,7 +434,7 @@ def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method anchors_disassociate_asset" % _key + " to method anchors_snapshot" % _key ) _params[_key] = _val del _params['kwargs'] @@ -446,15 +443,12 @@ def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['anchor'] is not None: - _path_params['anchor'] = _params['anchor'] - - if _params['asset'] is not None: - _path_params['asset'] = _params['asset'] - # process the query parameters _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -464,15 +458,18 @@ def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['text/plain']) # noqa: E501 + ['application/json', 'text/plain']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "Anchors", + '500': "str", + } return self.api_client.call_api( - '/anchors/{anchor}/assets/delete/{asset}', 'POST', + '/anchors', 'GET', _path_params, _query_params, _header_params, @@ -489,18 +486,20 @@ def anchors_disassociate_asset_with_http_info(self, anchor : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def anchors_snapshot(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> Anchors: # noqa: E501 - """/anchors [GET] # noqa: E501 + def search_anchors(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedAnchors: # noqa: E501 + """/anchors/search [POST] # noqa: E501 - This will get a snapshot of all your anchors. # noqa: E501 + This will search your anchors for a specific anchor note: we will search all the anchor points # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.anchors_snapshot(transferables, async_req=True) + >>> thread = api.search_anchors(transferables, search_input, async_req=True) >>> result = thread.get() :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) :type transferables: bool + :param search_input: + :type search_input: SearchInput :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -510,27 +509,29 @@ def anchors_snapshot(self, transferables : Annotated[Optional[StrictBool], Field :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: Anchors + :rtype: SearchedAnchors """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the anchors_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the search_anchors_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.anchors_snapshot_with_http_info(transferables, **kwargs) # noqa: E501 + return self.search_anchors_with_http_info(transferables, search_input, **kwargs) # noqa: E501 @validate_arguments - def anchors_snapshot_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/anchors [GET] # noqa: E501 + def search_anchors_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/anchors/search [POST] # noqa: E501 - This will get a snapshot of all your anchors. # noqa: E501 + This will search your anchors for a specific anchor note: we will search all the anchor points # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.anchors_snapshot_with_http_info(transferables, async_req=True) + >>> thread = api.search_anchors_with_http_info(transferables, search_input, async_req=True) >>> result = thread.get() :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) :type transferables: bool + :param search_input: + :type search_input: SearchInput :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -553,13 +554,14 @@ def anchors_snapshot_with_http_info(self, transferables : Annotated[Optional[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(Anchors, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(SearchedAnchors, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'transferables' + 'transferables', + 'search_input' ] _all_params.extend( [ @@ -578,7 +580,7 @@ def anchors_snapshot_with_http_info(self, transferables : Annotated[Optional[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method anchors_snapshot" % _key + " to method search_anchors" % _key ) _params[_key] = _val del _params['kwargs'] @@ -600,20 +602,30 @@ def anchors_snapshot_with_http_info(self, transferables : Annotated[Optional[Str _files = {} # process the body parameter _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "Anchors", + '200': "SearchedAnchors", '500': "str", } return self.api_client.call_api( - '/anchors', 'GET', + '/anchors/search', 'POST', _path_params, _query_params, _header_params, diff --git a/src/pieces_os_client/api/annotations_api.py b/src/pieces_os_client/api/annotations_api.py index 6d77865..99bd39d 100644 --- a/src/pieces_os_client/api/annotations_api.py +++ b/src/pieces_os_client/api/annotations_api.py @@ -20,12 +20,14 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import Field, StrictBool, StrictStr from typing import Optional from pieces_os_client.models.annotation import Annotation from pieces_os_client.models.annotations import Annotations +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_annotations import SearchedAnnotations from pieces_os_client.models.seeded_annotation import SeededAnnotation from pieces_os_client.api_client import ApiClient @@ -474,3 +476,159 @@ def annotations_snapshot_with_http_info(self, annotation_type_filter : Annotated _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def search_annotations(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedAnnotations: # noqa: E501 + """/annotations/search [POST] # noqa: E501 + + This will search your annotations for a specific annotation note: we will just search the annotation value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_annotations(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedAnnotations + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_annotations_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_annotations_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_annotations_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/annotations/search [POST] # noqa: E501 + + This will search your annotations for a specific annotation note: we will just search the annotation value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_annotations_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedAnnotations, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_annotations" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedAnnotations", + '500': "str", + } + + return self.api_client.call_api( + '/annotations/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/asset_api.py b/src/pieces_os_client/api/asset_api.py index daafe5f..4853854 100644 --- a/src/pieces_os_client/api/asset_api.py +++ b/src/pieces_os_client/api/asset_api.py @@ -345,6 +345,152 @@ def asset_associate_conversation_with_http_info(self, asset : Annotated[StrictSt collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def asset_associate_hint(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], **kwargs) -> None: # noqa: E501 + """/asset/{asset}/hints/associate/{hint} [POST] # noqa: E501 + + associates an asset and a hint. It performs the same action as the hint equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.asset_associate_hint(asset, hint, async_req=True) + >>> result = thread.get() + + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param hint: This is a specific hint uuid (required) + :type hint: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the asset_associate_hint_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.asset_associate_hint_with_http_info(asset, hint, **kwargs) # noqa: E501 + + @validate_arguments + def asset_associate_hint_with_http_info(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], **kwargs) -> ApiResponse: # noqa: E501 + """/asset/{asset}/hints/associate/{hint} [POST] # noqa: E501 + + associates an asset and a hint. It performs the same action as the hint equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.asset_associate_hint_with_http_info(asset, hint, async_req=True) + >>> result = thread.get() + + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param hint: This is a specific hint uuid (required) + :type hint: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'asset', + 'hint' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method asset_associate_hint" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['asset'] is not None: + _path_params['asset'] = _params['asset'] + + if _params['hint'] is not None: + _path_params['hint'] = _params['hint'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/asset/{asset}/hints/associate/{hint}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def asset_associate_person(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> None: # noqa: E501 """/asset/{asset}/persons/associate/{person} [POST] # noqa: E501 @@ -1221,6 +1367,152 @@ def asset_disassociate_conversation_with_http_info(self, asset : Annotated[Stric collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def asset_disassociate_hint(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], **kwargs) -> None: # noqa: E501 + """/asset/{asset}/hints/disassociate/{hint} [POST] # noqa: E501 + + Disassociates an asset from a hint. It performs the same action as the hint equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.asset_disassociate_hint(asset, hint, async_req=True) + >>> result = thread.get() + + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param hint: This is a specific hint uuid (required) + :type hint: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the asset_disassociate_hint_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.asset_disassociate_hint_with_http_info(asset, hint, **kwargs) # noqa: E501 + + @validate_arguments + def asset_disassociate_hint_with_http_info(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], **kwargs) -> ApiResponse: # noqa: E501 + """/asset/{asset}/hints/disassociate/{hint} [POST] # noqa: E501 + + Disassociates an asset from a hint. It performs the same action as the hint equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.asset_disassociate_hint_with_http_info(asset, hint, async_req=True) + >>> result = thread.get() + + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param hint: This is a specific hint uuid (required) + :type hint: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'asset', + 'hint' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method asset_disassociate_hint" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['asset'] is not None: + _path_params['asset'] = _params['asset'] + + if _params['hint'] is not None: + _path_params['hint'] = _params['hint'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/asset/{asset}/hints/disassociate/{hint}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def asset_disassociate_person(self, asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], **kwargs) -> None: # noqa: E501 """/asset/{asset}/persons/disassociate/{person} [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/assets_api.py b/src/pieces_os_client/api/assets_api.py index dcdb977..6f4fb6b 100644 --- a/src/pieces_os_client/api/assets_api.py +++ b/src/pieces_os_client/api/assets_api.py @@ -35,7 +35,6 @@ from pieces_os_client.models.seed import Seed from pieces_os_client.models.seeded_assets_recommendation import SeededAssetsRecommendation from pieces_os_client.models.streamed_identifiers import StreamedIdentifiers -from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions from pieces_os_client.api_client import ApiClient from pieces_os_client.api_response import ApiResponse @@ -1076,171 +1075,6 @@ def assets_pseudo_snapshot_with_http_info(self, **kwargs) -> ApiResponse: # noq collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) - @validate_arguments - def assets_search_assets(self, query : Annotated[Optional[StrictStr], Field(description="This is a string that you can use to search your assets.")] = None, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, searchable_tags : Annotated[Optional[StrictStr], Field(description="This is a comma separated value of tags used for search.")] = None, pseudo : Annotated[Optional[StrictBool], Field(description="This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.")] = None, **kwargs) -> SearchedAssets: # noqa: E501 - """/assets/search?query=string [GET] # noqa: E501 - - Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.assets_search_assets(query, transferables, searchable_tags, pseudo, async_req=True) - >>> result = thread.get() - - :param query: This is a string that you can use to search your assets. - :type query: str - :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) - :type transferables: bool - :param searchable_tags: This is a comma separated value of tags used for search. - :type searchable_tags: str - :param pseudo: This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. - :type pseudo: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SearchedAssets - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the assets_search_assets_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.assets_search_assets_with_http_info(query, transferables, searchable_tags, pseudo, **kwargs) # noqa: E501 - - @validate_arguments - def assets_search_assets_with_http_info(self, query : Annotated[Optional[StrictStr], Field(description="This is a string that you can use to search your assets.")] = None, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, searchable_tags : Annotated[Optional[StrictStr], Field(description="This is a comma separated value of tags used for search.")] = None, pseudo : Annotated[Optional[StrictBool], Field(description="This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/assets/search?query=string [GET] # noqa: E501 - - Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.assets_search_assets_with_http_info(query, transferables, searchable_tags, pseudo, async_req=True) - >>> result = thread.get() - - :param query: This is a string that you can use to search your assets. - :type query: str - :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) - :type transferables: bool - :param searchable_tags: This is a comma separated value of tags used for search. - :type searchable_tags: str - :param pseudo: This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. - :type pseudo: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SearchedAssets, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'query', - 'transferables', - 'searchable_tags', - 'pseudo' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method assets_search_assets" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - if _params.get('query') is not None: # noqa: E501 - _query_params.append(('query', _params['query'])) - - if _params.get('transferables') is not None: # noqa: E501 - _query_params.append(('transferables', _params['transferables'])) - - if _params.get('searchable_tags') is not None: # noqa: E501 - _query_params.append(('searchable_tags', _params['searchable_tags'])) - - if _params.get('pseudo') is not None: # noqa: E501 - _query_params.append(('pseudo', _params['pseudo'])) - - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'text/plain']) # noqa: E501 - - # authentication setting - _auth_settings = [] # noqa: E501 - - _response_types_map = { - '200': "SearchedAssets", - '500': "str", - } - - return self.api_client.call_api( - '/assets/search', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - @validate_arguments def assets_search_with_filters(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, pseudo : Annotated[Optional[StrictBool], Field(description="This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.")] = None, assets_search_with_filters_input : Optional[AssetsSearchWithFiltersInput] = None, **kwargs) -> AssetsSearchWithFiltersOutput: # noqa: E501 """/assets/search [POST] # noqa: E501 @@ -2123,16 +1957,24 @@ def get_assets_stream_transferables_with_http_info(self, **kwargs) -> ApiRespons _request_auth=_params.get('_request_auth')) @validate_arguments - def stream_assets(self, **kwargs) -> Assets: # noqa: E501 - """/assets/stream [WS] # noqa: E501 + def search_assets(self, query : Annotated[Optional[StrictStr], Field(description="This is a string that you can use to search your assets.")] = None, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, searchable_tags : Annotated[Optional[StrictStr], Field(description="This is a comma separated value of tags used for search.")] = None, pseudo : Annotated[Optional[StrictBool], Field(description="This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.")] = None, **kwargs) -> SearchedAssets: # noqa: E501 + """/assets/search?query=string [GET] # noqa: E501 - Provides a WebSocket connection that emits changes to your assets. # noqa: E501 + Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.stream_assets(async_req=True) + >>> thread = api.search_assets(query, transferables, searchable_tags, pseudo, async_req=True) >>> result = thread.get() + :param query: This is a string that you can use to search your assets. + :type query: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param searchable_tags: This is a comma separated value of tags used for search. + :type searchable_tags: str + :param pseudo: This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. + :type pseudo: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -2142,25 +1984,33 @@ def stream_assets(self, **kwargs) -> Assets: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: Assets + :rtype: SearchedAssets """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the stream_assets_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the search_assets_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.stream_assets_with_http_info(**kwargs) # noqa: E501 + return self.search_assets_with_http_info(query, transferables, searchable_tags, pseudo, **kwargs) # noqa: E501 @validate_arguments - def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/assets/stream [WS] # noqa: E501 + def search_assets_with_http_info(self, query : Annotated[Optional[StrictStr], Field(description="This is a string that you can use to search your assets.")] = None, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, searchable_tags : Annotated[Optional[StrictStr], Field(description="This is a comma separated value of tags used for search.")] = None, pseudo : Annotated[Optional[StrictBool], Field(description="This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/assets/search?query=string [GET] # noqa: E501 - Provides a WebSocket connection that emits changes to your assets. # noqa: E501 + Performs a search across your pieces and returns Assets (the results) based on your query. Presently, it only requires your query to be sent in the body. It is mandatory to include searchable_tags (comma-separated values of tags) or a query string. If a query is provided, a fuzzy search will be conducted. If searchable tags are provided, a tag-based search will be executed. If neither are included, a 500 error will be returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.stream_assets_with_http_info(async_req=True) + >>> thread = api.search_assets_with_http_info(query, transferables, searchable_tags, pseudo, async_req=True) >>> result = thread.get() + :param query: This is a string that you can use to search your assets. + :type query: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param searchable_tags: This is a comma separated value of tags used for search. + :type searchable_tags: str + :param pseudo: This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. + :type pseudo: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -2183,12 +2033,16 @@ def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(Assets, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(SearchedAssets, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'query', + 'transferables', + 'searchable_tags', + 'pseudo' ] _all_params.extend( [ @@ -2207,7 +2061,7 @@ def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method stream_assets" % _key + " to method search_assets" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2219,6 +2073,18 @@ def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 # process the query parameters _query_params = [] + if _params.get('query') is not None: # noqa: E501 + _query_params.append(('query', _params['query'])) + + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + if _params.get('searchable_tags') is not None: # noqa: E501 + _query_params.append(('searchable_tags', _params['searchable_tags'])) + + if _params.get('pseudo') is not None: # noqa: E501 + _query_params.append(('pseudo', _params['pseudo'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -2228,17 +2094,18 @@ def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + ['application/json', 'text/plain']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "Assets", + '200': "SearchedAssets", + '500': "str", } return self.api_client.call_api( - '/assets/stream', 'GET', + '/assets/search', 'GET', _path_params, _query_params, _header_params, @@ -2255,14 +2122,14 @@ def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _request_auth=_params.get('_request_auth')) @validate_arguments - def workstream_suggestions_stream(self, **kwargs) -> WorkstreamSuggestions: # noqa: E501 - """/workstream/suggestions/stream [WS] # noqa: E501 + def stream_assets(self, **kwargs) -> Assets: # noqa: E501 + """/assets/stream [WS] # noqa: E501 - Provides a WebSocket connection that emits changes to your workstream suggestions. # noqa: E501 + Provides a WebSocket connection that emits changes to your assets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_suggestions_stream(async_req=True) + >>> thread = api.stream_assets(async_req=True) >>> result = thread.get() :param async_req: Whether to execute the request asynchronously. @@ -2274,23 +2141,23 @@ def workstream_suggestions_stream(self, **kwargs) -> WorkstreamSuggestions: # n :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: WorkstreamSuggestions + :rtype: Assets """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the workstream_suggestions_stream_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the stream_assets_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.workstream_suggestions_stream_with_http_info(**kwargs) # noqa: E501 + return self.stream_assets_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def workstream_suggestions_stream_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/workstream/suggestions/stream [WS] # noqa: E501 + def stream_assets_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/assets/stream [WS] # noqa: E501 - Provides a WebSocket connection that emits changes to your workstream suggestions. # noqa: E501 + Provides a WebSocket connection that emits changes to your assets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_suggestions_stream_with_http_info(async_req=True) + >>> thread = api.stream_assets_with_http_info(async_req=True) >>> result = thread.get() :param async_req: Whether to execute the request asynchronously. @@ -2315,7 +2182,7 @@ def workstream_suggestions_stream_with_http_info(self, **kwargs) -> ApiResponse: :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(WorkstreamSuggestions, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(Assets, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() @@ -2339,7 +2206,7 @@ def workstream_suggestions_stream_with_http_info(self, **kwargs) -> ApiResponse: if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method workstream_suggestions_stream" % _key + " to method stream_assets" % _key ) _params[_key] = _val del _params['kwargs'] @@ -2360,18 +2227,17 @@ def workstream_suggestions_stream_with_http_info(self, **kwargs) -> ApiResponse: _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'text/plain']) # noqa: E501 + ['application/json']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "WorkstreamSuggestions", - '500': "str", + '200': "Assets", } return self.api_client.call_api( - '/workstream/suggestions/stream', 'GET', + '/assets/stream', 'GET', _path_params, _query_params, _header_params, diff --git a/src/pieces_os_client/api/conversation_api.py b/src/pieces_os_client/api/conversation_api.py index ef35d5a..62c969c 100644 --- a/src/pieces_os_client/api/conversation_api.py +++ b/src/pieces_os_client/api/conversation_api.py @@ -28,6 +28,8 @@ from pieces_os_client.models.conversation_messages import ConversationMessages from pieces_os_client.models.conversation_summarize_input import ConversationSummarizeInput from pieces_os_client.models.conversation_summarize_output import ConversationSummarizeOutput +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages from pieces_os_client.models.seeded_score_increment import SeededScoreIncrement from pieces_os_client.api_client import ApiClient @@ -782,7 +784,7 @@ def conversation_associate_workstream_summary_with_http_info(self, conversation @validate_arguments def conversation_disassociate_anchor(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> None: # noqa: E501 - """/conversation/{conversation}/anchors/delete/{anchor} [POST] # noqa: E501 + """/conversation/{conversation}/anchors/disassociate/{anchor} [POST] # noqa: E501 Updates both the anchor and the conversation, deleting (disassociating) them simultaneously. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -814,7 +816,7 @@ def conversation_disassociate_anchor(self, conversation : Annotated[StrictStr, F @validate_arguments def conversation_disassociate_anchor_with_http_info(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> ApiResponse: # noqa: E501 - """/conversation/{conversation}/anchors/delete/{anchor} [POST] # noqa: E501 + """/conversation/{conversation}/anchors/disassociate/{anchor} [POST] # noqa: E501 Updates both the anchor and the conversation, deleting (disassociating) them simultaneously. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -910,7 +912,7 @@ def conversation_disassociate_anchor_with_http_info(self, conversation : Annotat _response_types_map = {} return self.api_client.call_api( - '/conversation/{conversation}/anchors/delete/{anchor}', 'POST', + '/conversation/{conversation}/anchors/disassociate/{anchor}', 'POST', _path_params, _query_params, _header_params, @@ -928,7 +930,7 @@ def conversation_disassociate_anchor_with_http_info(self, conversation : Annotat @validate_arguments def conversation_disassociate_asset(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 - """/conversation/{conversation}/assets/delete/{asset} [POST] # noqa: E501 + """/conversation/{conversation}/assets/disassociate/{asset} [POST] # noqa: E501 Updates both the asset and the conversation, effectively disassociating them. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -960,7 +962,7 @@ def conversation_disassociate_asset(self, conversation : Annotated[StrictStr, Fi @validate_arguments def conversation_disassociate_asset_with_http_info(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> ApiResponse: # noqa: E501 - """/conversation/{conversation}/assets/delete/{asset} [POST] # noqa: E501 + """/conversation/{conversation}/assets/disassociate/{asset} [POST] # noqa: E501 Updates both the asset and the conversation, effectively disassociating them. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -1056,7 +1058,7 @@ def conversation_disassociate_asset_with_http_info(self, conversation : Annotate _response_types_map = {} return self.api_client.call_api( - '/conversation/{conversation}/assets/delete/{asset}', 'POST', + '/conversation/{conversation}/assets/disassociate/{asset}', 'POST', _path_params, _query_params, _header_params, @@ -2713,3 +2715,167 @@ def conversation_update_with_http_info(self, transferables : Annotated[Optional[ _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def search_conversation_specific_messages(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedConversationMessages: # noqa: E501 + """/conversation/{conversation}/search [POST] # noqa: E501 + + This will search a specific conversation for a match note: here we will only search the conversationMessages for this given Conversation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_conversation_specific_messages(conversation, transferables, search_input, async_req=True) + >>> result = thread.get() + + :param conversation: This is the uuid of a conversation. (required) + :type conversation: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedConversationMessages + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_conversation_specific_messages_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_conversation_specific_messages_with_http_info(conversation, transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_conversation_specific_messages_with_http_info(self, conversation : Annotated[StrictStr, Field(..., description="This is the uuid of a conversation.")], transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/conversation/{conversation}/search [POST] # noqa: E501 + + This will search a specific conversation for a match note: here we will only search the conversationMessages for this given Conversation # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_conversation_specific_messages_with_http_info(conversation, transferables, search_input, async_req=True) + >>> result = thread.get() + + :param conversation: This is the uuid of a conversation. (required) + :type conversation: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedConversationMessages, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'conversation', + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_conversation_specific_messages" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['conversation'] is not None: + _path_params['conversation'] = _params['conversation'] + + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedConversationMessages", + '500': "str", + } + + return self.api_client.call_api( + '/conversation/{conversation}/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/conversation_messages_api.py b/src/pieces_os_client/api/conversation_messages_api.py index 4b0b74e..19be7d5 100644 --- a/src/pieces_os_client/api/conversation_messages_api.py +++ b/src/pieces_os_client/api/conversation_messages_api.py @@ -26,6 +26,8 @@ from pieces_os_client.models.conversation_message import ConversationMessage from pieces_os_client.models.conversation_messages import ConversationMessages +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages from pieces_os_client.models.seeded_conversation_message import SeededConversationMessage from pieces_os_client.api_client import ApiClient @@ -482,3 +484,159 @@ def messages_snapshot_with_http_info(self, transferables : Annotated[Optional[St _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def search_messages(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedConversationMessages: # noqa: E501 + """/messages/search [POST] # noqa: E501 + + This will search your conversationMessages for a specific conversation_message note: we will just search the conversation message values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_messages(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedConversationMessages + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_messages_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_messages_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_messages_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/messages/search [POST] # noqa: E501 + + This will search your conversationMessages for a specific conversation_message note: we will just search the conversation message values # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_messages_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedConversationMessages, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_messages" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedConversationMessages", + '500': "str", + } + + return self.api_client.call_api( + '/messages/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/conversations_api.py b/src/pieces_os_client/api/conversations_api.py index 086cf32..58967d4 100644 --- a/src/pieces_os_client/api/conversations_api.py +++ b/src/pieces_os_client/api/conversations_api.py @@ -28,6 +28,8 @@ from pieces_os_client.models.conversations import Conversations from pieces_os_client.models.conversations_create_from_asset_output import ConversationsCreateFromAssetOutput from pieces_os_client.models.flattened_conversations import FlattenedConversations +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_conversations import SearchedConversations from pieces_os_client.models.seeded_conversation import SeededConversation from pieces_os_client.api_client import ApiClient @@ -884,3 +886,159 @@ def conversations_stream_identifiers_with_http_info(self, **kwargs) -> ApiRespon _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def search_conversations(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedConversations: # noqa: E501 + """/conversations/search [POST] # noqa: E501 + + This will search your conversations for a specific conversation note: we will search annotations, the name of the conversation, and the conversation messages # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_conversations(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedConversations + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_conversations_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_conversations_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_conversations_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/conversations/search [POST] # noqa: E501 + + This will search your conversations for a specific conversation note: we will search annotations, the name of the conversation, and the conversation messages # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_conversations_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedConversations, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_conversations" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedConversations", + '500': "str", + } + + return self.api_client.call_api( + '/conversations/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/hint_api.py b/src/pieces_os_client/api/hint_api.py index 4ed7fd0..70d2921 100644 --- a/src/pieces_os_client/api/hint_api.py +++ b/src/pieces_os_client/api/hint_api.py @@ -47,6 +47,298 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def hint_associate_asset(self, hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 + """/hint/{hint}/assets/associate/{asset} [POST] # noqa: E501 + + associates a hint and an asset. It performs the same action as the asset equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hint_associate_asset(hint, asset, async_req=True) + >>> result = thread.get() + + :param hint: This is a specific hint uuid (required) + :type hint: str + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the hint_associate_asset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.hint_associate_asset_with_http_info(hint, asset, **kwargs) # noqa: E501 + + @validate_arguments + def hint_associate_asset_with_http_info(self, hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> ApiResponse: # noqa: E501 + """/hint/{hint}/assets/associate/{asset} [POST] # noqa: E501 + + associates a hint and an asset. It performs the same action as the asset equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hint_associate_asset_with_http_info(hint, asset, async_req=True) + >>> result = thread.get() + + :param hint: This is a specific hint uuid (required) + :type hint: str + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'hint', + 'asset' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method hint_associate_asset" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['hint'] is not None: + _path_params['hint'] = _params['hint'] + + if _params['asset'] is not None: + _path_params['asset'] = _params['asset'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/hint/{hint}/assets/associate/{asset}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def hint_disassociate_asset(self, hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 + """/hint/{hint}/assets/disassociate/{asset} [POST] # noqa: E501 + + Disassociates a hint from an asset. It performs the same action as the asset equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hint_disassociate_asset(hint, asset, async_req=True) + >>> result = thread.get() + + :param hint: This is a specific hint uuid (required) + :type hint: str + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the hint_disassociate_asset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.hint_disassociate_asset_with_http_info(hint, asset, **kwargs) # noqa: E501 + + @validate_arguments + def hint_disassociate_asset_with_http_info(self, hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> ApiResponse: # noqa: E501 + """/hint/{hint}/assets/disassociate/{asset} [POST] # noqa: E501 + + Disassociates a hint from an asset. It performs the same action as the asset equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.hint_disassociate_asset_with_http_info(hint, asset, async_req=True) + >>> result = thread.get() + + :param hint: This is a specific hint uuid (required) + :type hint: str + :param asset: The id (uuid) of the asset that you are trying to access. (required) + :type asset: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'hint', + 'asset' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method hint_disassociate_asset" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['hint'] is not None: + _path_params['hint'] = _params['hint'] + + if _params['asset'] is not None: + _path_params['asset'] = _params['asset'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/hint/{hint}/assets/disassociate/{asset}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def hint_scores_increment(self, hint : Annotated[StrictStr, Field(..., description="This is a specific hint uuid")], seeded_score_increment : Optional[SeededScoreIncrement] = None, **kwargs) -> None: # noqa: E501 """'/hint/{hint}/scores/increment' [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/hints_api.py b/src/pieces_os_client/api/hints_api.py index f1c5ea7..a036acb 100644 --- a/src/pieces_os_client/api/hints_api.py +++ b/src/pieces_os_client/api/hints_api.py @@ -20,12 +20,14 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import Field, StrictBool, StrictStr from typing import Optional from pieces_os_client.models.hint import Hint from pieces_os_client.models.hints import Hints +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_hints import SearchedHints from pieces_os_client.models.seeded_hint import SeededHint from pieces_os_client.api_client import ApiClient @@ -466,3 +468,159 @@ def hints_snapshot_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def search_hints(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedHints: # noqa: E501 + """/hints/search [POST] # noqa: E501 + + This will search your hints for a specific hint note: we will just search the hint value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_hints(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedHints + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_hints_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_hints_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_hints_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/hints/search [POST] # noqa: E501 + + This will search your hints for a specific hint note: we will just search the hint value # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_hints_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedHints, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_hints" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedHints", + '500': "str", + } + + return self.api_client.call_api( + '/hints/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/os_api.py b/src/pieces_os_client/api/os_api.py index ff5ac36..a0a0c5c 100644 --- a/src/pieces_os_client/api/os_api.py +++ b/src/pieces_os_client/api/os_api.py @@ -19,17 +19,27 @@ from pydantic import validate_arguments, ValidationError +from pydantic import StrictStr + from typing import List, Optional -from pieces_os_client.models.checked_os_update import CheckedOSUpdate +from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet from pieces_os_client.models.file_picker_input import FilePickerInput +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet from pieces_os_client.models.os_device_information_returnable import OSDeviceInformationReturnable +from pieces_os_client.models.os_file_streaming_read import OSFileStreamingRead +from pieces_os_client.models.os_file_streaming_read_attempt import OSFileStreamingReadAttempt from pieces_os_client.models.os_permissions import OSPermissions +from pieces_os_client.models.os_server_metadata import OSServerMetadata +from pieces_os_client.models.os_server_settings import OSServerSettings +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus from pieces_os_client.models.returned_user_profile import ReturnedUserProfile from pieces_os_client.models.seeded_external_provider import SeededExternalProvider -from pieces_os_client.models.unchecked_os_update import UncheckedOSUpdate +from pieces_os_client.models.terminating_os_server_applet import TerminatingOSServerApplet +from pieces_os_client.models.unchecked_os_server_update import UncheckedOSServerUpdate from pieces_os_client.models.user_profile import UserProfile from pieces_os_client.models.users import Users +from pieces_os_client.models.verified_os_filesystem_path import VerifiedOSFilesystemPath from pieces_os_client.api_client import ApiClient from pieces_os_client.api_response import ApiResponse @@ -201,16 +211,18 @@ def link_provider_with_http_info(self, seeded_external_provider : Optional[Seede _request_auth=_params.get('_request_auth')) @validate_arguments - def os_device_information(self, **kwargs) -> OSDeviceInformationReturnable: # noqa: E501 - """/os/device/information [GET] # noqa: E501 + def os_applet_launch(self, inactive_os_server_applet : Optional[InactiveOSServerApplet] = None, **kwargs) -> ActiveOSServerApplet: # noqa: E501 + """/os/applet/launch [POST] # noqa: E501 - This will get information related to your specific device. # noqa: E501 + This will attempt to launch(serve) a micro_application. If one is already spun up we will just return the port number. TODO: take in an application and return a port number at minimum. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_device_information(async_req=True) + >>> thread = api.os_applet_launch(inactive_os_server_applet, async_req=True) >>> result = thread.get() + :param inactive_os_server_applet: + :type inactive_os_server_applet: InactiveOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -220,25 +232,27 @@ def os_device_information(self, **kwargs) -> OSDeviceInformationReturnable: # n :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: OSDeviceInformationReturnable + :rtype: ActiveOSServerApplet """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the os_device_information_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_applet_launch_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.os_device_information_with_http_info(**kwargs) # noqa: E501 + return self.os_applet_launch_with_http_info(inactive_os_server_applet, **kwargs) # noqa: E501 @validate_arguments - def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/os/device/information [GET] # noqa: E501 + def os_applet_launch_with_http_info(self, inactive_os_server_applet : Optional[InactiveOSServerApplet] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/applet/launch [POST] # noqa: E501 - This will get information related to your specific device. # noqa: E501 + This will attempt to launch(serve) a micro_application. If one is already spun up we will just return the port number. TODO: take in an application and return a port number at minimum. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_device_information_with_http_info(async_req=True) + >>> thread = api.os_applet_launch_with_http_info(inactive_os_server_applet, async_req=True) >>> result = thread.get() + :param inactive_os_server_applet: + :type inactive_os_server_applet: InactiveOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -261,12 +275,13 @@ def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(OSDeviceInformationReturnable, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(ActiveOSServerApplet, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'inactive_os_server_applet' ] _all_params.extend( [ @@ -285,7 +300,7 @@ def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method os_device_information" % _key + " to method os_applet_launch" % _key ) _params[_key] = _val del _params['kwargs'] @@ -304,20 +319,30 @@ def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa _files = {} # process the body parameter _body_params = None + if _params['inactive_os_server_applet'] is not None: + _body_params = _params['inactive_os_server_applet'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "OSDeviceInformationReturnable", + '200': "ActiveOSServerApplet", '500': "str", } return self.api_client.call_api( - '/os/device/information', 'GET', + '/os/applet/launch', 'POST', _path_params, _query_params, _header_params, @@ -334,16 +359,18 @@ def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa _request_auth=_params.get('_request_auth')) @validate_arguments - def os_permissions(self, **kwargs) -> OSPermissions: # noqa: E501 - """/os/permissions [GET] # noqa: E501 + def os_applet_restart(self, inactive_os_server_applet : Optional[InactiveOSServerApplet] = None, **kwargs) -> ActiveOSServerApplet: # noqa: E501 + """/os/applet/restart [POST] # noqa: E501 - This will only work on Macos and Windows. And will get the permissions of the user's local machine w/ regard to anything needed to effectively run PiecesOS. Note: this will let us know if we need to tell them to take action to enable any given permissions # noqa: E501 + This will attempt to restart a micro_application.(this will shut down the copilot and then rehost it) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_permissions(async_req=True) + >>> thread = api.os_applet_restart(inactive_os_server_applet, async_req=True) >>> result = thread.get() + :param inactive_os_server_applet: + :type inactive_os_server_applet: InactiveOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -353,25 +380,27 @@ def os_permissions(self, **kwargs) -> OSPermissions: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: OSPermissions + :rtype: ActiveOSServerApplet """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the os_permissions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_applet_restart_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.os_permissions_with_http_info(**kwargs) # noqa: E501 + return self.os_applet_restart_with_http_info(inactive_os_server_applet, **kwargs) # noqa: E501 @validate_arguments - def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/os/permissions [GET] # noqa: E501 + def os_applet_restart_with_http_info(self, inactive_os_server_applet : Optional[InactiveOSServerApplet] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/applet/restart [POST] # noqa: E501 - This will only work on Macos and Windows. And will get the permissions of the user's local machine w/ regard to anything needed to effectively run PiecesOS. Note: this will let us know if we need to tell them to take action to enable any given permissions # noqa: E501 + This will attempt to restart a micro_application.(this will shut down the copilot and then rehost it) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_permissions_with_http_info(async_req=True) + >>> thread = api.os_applet_restart_with_http_info(inactive_os_server_applet, async_req=True) >>> result = thread.get() + :param inactive_os_server_applet: + :type inactive_os_server_applet: InactiveOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -394,12 +423,13 @@ def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(OSPermissions, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(ActiveOSServerApplet, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'inactive_os_server_applet' ] _all_params.extend( [ @@ -418,7 +448,7 @@ def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method os_permissions" % _key + " to method os_applet_restart" % _key ) _params[_key] = _val del _params['kwargs'] @@ -437,20 +467,30 @@ def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _files = {} # process the body parameter _body_params = None + if _params['inactive_os_server_applet'] is not None: + _body_params = _params['inactive_os_server_applet'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "OSPermissions", + '200': "ActiveOSServerApplet", '500': "str", } return self.api_client.call_api( - '/os/permissions', 'GET', + '/os/applet/restart', 'POST', _path_params, _query_params, _header_params, @@ -467,18 +507,18 @@ def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _request_auth=_params.get('_request_auth')) @validate_arguments - def os_permissions_request(self, os_permissions : Optional[OSPermissions] = None, **kwargs) -> OSPermissions: # noqa: E501 - """/os/permissions/request [POST] # noqa: E501 + def os_applet_terminate(self, terminating_os_server_applet : Optional[TerminatingOSServerApplet] = None, **kwargs) -> None: # noqa: E501 + """/os/applet/terminate [POST] # noqa: E501 - This will only work on Macos and Windows. This will request permissions for the given inputs # noqa: E501 + This will attempt to shutdown or terminate a specified micro_application. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_permissions_request(os_permissions, async_req=True) + >>> thread = api.os_applet_terminate(terminating_os_server_applet, async_req=True) >>> result = thread.get() - :param os_permissions: - :type os_permissions: OSPermissions + :param terminating_os_server_applet: + :type terminating_os_server_applet: TerminatingOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -488,27 +528,27 @@ def os_permissions_request(self, os_permissions : Optional[OSPermissions] = None :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: OSPermissions + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the os_permissions_request_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_applet_terminate_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.os_permissions_request_with_http_info(os_permissions, **kwargs) # noqa: E501 + return self.os_applet_terminate_with_http_info(terminating_os_server_applet, **kwargs) # noqa: E501 @validate_arguments - def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPermissions] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/os/permissions/request [POST] # noqa: E501 + def os_applet_terminate_with_http_info(self, terminating_os_server_applet : Optional[TerminatingOSServerApplet] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/applet/terminate [POST] # noqa: E501 - This will only work on Macos and Windows. This will request permissions for the given inputs # noqa: E501 + This will attempt to shutdown or terminate a specified micro_application. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_permissions_request_with_http_info(os_permissions, async_req=True) + >>> thread = api.os_applet_terminate_with_http_info(terminating_os_server_applet, async_req=True) >>> result = thread.get() - :param os_permissions: - :type os_permissions: OSPermissions + :param terminating_os_server_applet: + :type terminating_os_server_applet: TerminatingOSServerApplet :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -531,13 +571,13 @@ def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPerm :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(OSPermissions, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ - 'os_permissions' + 'terminating_os_server_applet' ] _all_params.extend( [ @@ -556,7 +596,7 @@ def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPerm if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method os_permissions_request" % _key + " to method os_applet_terminate" % _key ) _params[_key] = _val del _params['kwargs'] @@ -575,12 +615,12 @@ def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPerm _files = {} # process the body parameter _body_params = None - if _params['os_permissions'] is not None: - _body_params = _params['os_permissions'] + if _params['terminating_os_server_applet'] is not None: + _body_params = _params['terminating_os_server_applet'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'text/plain']) # noqa: E501 + ['text/plain']) # noqa: E501 # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', @@ -592,13 +632,10 @@ def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPerm # authentication setting _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "OSPermissions", - '500': "str", - } + _response_types_map = {} return self.api_client.call_api( - '/os/permissions/request', 'POST', + '/os/applet/terminate', 'POST', _path_params, _query_params, _header_params, @@ -615,16 +652,18 @@ def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPerm _request_auth=_params.get('_request_auth')) @validate_arguments - def os_restart(self, **kwargs) -> None: # noqa: E501 - """Your GET endpoint # noqa: E501 + def os_browser_url_open(self, body : Optional[StrictStr] = None, **kwargs) -> None: # noqa: E501 + """/os/browser/url/open [POST] # noqa: E501 - This will restart PiecesOS, if successfull with return a 204. This is a LOCALOS Only Endpoint. # noqa: E501 + This will accept a url and launch this in an external browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_restart(async_req=True) + >>> thread = api.os_browser_url_open(body, async_req=True) >>> result = thread.get() + :param body: + :type body: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -638,21 +677,23 @@ def os_restart(self, **kwargs) -> None: # noqa: E501 """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the os_restart_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_browser_url_open_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.os_restart_with_http_info(**kwargs) # noqa: E501 + return self.os_browser_url_open_with_http_info(body, **kwargs) # noqa: E501 @validate_arguments - def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Your GET endpoint # noqa: E501 + def os_browser_url_open_with_http_info(self, body : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/browser/url/open [POST] # noqa: E501 - This will restart PiecesOS, if successfull with return a 204. This is a LOCALOS Only Endpoint. # noqa: E501 + This will accept a url and launch this in an external browser. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_restart_with_http_info(async_req=True) + >>> thread = api.os_browser_url_open_with_http_info(body, async_req=True) >>> result = thread.get() + :param body: + :type body: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -681,6 +722,7 @@ def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _params = locals() _all_params = [ + 'body' ] _all_params.extend( [ @@ -699,7 +741,7 @@ def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method os_restart" % _key + " to method os_browser_url_open" % _key ) _params[_key] = _val del _params['kwargs'] @@ -718,17 +760,27 @@ def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _files = {} # process the body parameter _body_params = None + if _params['body'] is not None: + _body_params = _params['body'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = {} return self.api_client.call_api( - '/os/restart', 'GET', + '/os/browser/url/open', 'POST', _path_params, _query_params, _header_params, @@ -745,18 +797,16 @@ def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _request_auth=_params.get('_request_auth')) @validate_arguments - def os_update_check(self, unchecked_os_update : Optional[UncheckedOSUpdate] = None, **kwargs) -> CheckedOSUpdate: # noqa: E501 - """/os/update/check [POST] # noqa: E501 + def os_device_information(self, **kwargs) -> OSDeviceInformationReturnable: # noqa: E501 + """/os/device/information [GET] # noqa: E501 - This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc # noqa: E501 + This will get information related to your specific device. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_update_check(unchecked_os_update, async_req=True) + >>> thread = api.os_device_information(async_req=True) >>> result = thread.get() - :param unchecked_os_update: - :type unchecked_os_update: UncheckedOSUpdate :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -766,27 +816,25 @@ def os_update_check(self, unchecked_os_update : Optional[UncheckedOSUpdate] = No :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: CheckedOSUpdate + :rtype: OSDeviceInformationReturnable """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the os_update_check_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_device_information_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.os_update_check_with_http_info(unchecked_os_update, **kwargs) # noqa: E501 + return self.os_device_information_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def os_update_check_with_http_info(self, unchecked_os_update : Optional[UncheckedOSUpdate] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/os/update/check [POST] # noqa: E501 + def os_device_information_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/device/information [GET] # noqa: E501 - This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc # noqa: E501 + This will get information related to your specific device. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.os_update_check_with_http_info(unchecked_os_update, async_req=True) + >>> thread = api.os_device_information_with_http_info(async_req=True) >>> result = thread.get() - :param unchecked_os_update: - :type unchecked_os_update: UncheckedOSUpdate :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -809,13 +857,12 @@ def os_update_check_with_http_info(self, unchecked_os_update : Optional[Unchecke :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(CheckedOSUpdate, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(OSDeviceInformationReturnable, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'unchecked_os_update' ] _all_params.extend( [ @@ -834,7 +881,7 @@ def os_update_check_with_http_info(self, unchecked_os_update : Optional[Unchecke if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method os_update_check" % _key + " to method os_device_information" % _key ) _params[_key] = _val del _params['kwargs'] @@ -853,30 +900,20 @@ def os_update_check_with_http_info(self, unchecked_os_update : Optional[Unchecke _files = {} # process the body parameter _body_params = None - if _params['unchecked_os_update'] is not None: - _body_params = _params['unchecked_os_update'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "CheckedOSUpdate", + '200': "OSDeviceInformationReturnable", '500': "str", } return self.api_client.call_api( - '/os/update/check', 'POST', + '/os/device/information', 'GET', _path_params, _query_params, _header_params, @@ -893,18 +930,18 @@ def os_update_check_with_http_info(self, unchecked_os_update : Optional[Unchecke _request_auth=_params.get('_request_auth')) @validate_arguments - def pick_files(self, file_picker_input : Optional[FilePickerInput] = None, **kwargs) -> List[str]: # noqa: E501 - """/os/files/pick [POST] # noqa: E501 + def os_filesystem_file_open(self, body : Optional[StrictStr] = None, **kwargs) -> None: # noqa: E501 + """/os/filesystem/file/open [POST] # noqa: E501 - This will trigger a filer picker and return the string paths of the files that were selected. # noqa: E501 + This will accept a path and will launch a path in a given finder/file explorer window note: TODO in the future add an endpoint for open/in || open/with (browser,files,...etc) && if so we will want /os/open_with/file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.pick_files(file_picker_input, async_req=True) + >>> thread = api.os_filesystem_file_open(body, async_req=True) >>> result = thread.get() - :param file_picker_input: - :type file_picker_input: FilePickerInput + :param body: + :type body: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -914,27 +951,27 @@ def pick_files(self, file_picker_input : Optional[FilePickerInput] = None, **kwa :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: List[str] + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the pick_files_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_filesystem_file_open_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.pick_files_with_http_info(file_picker_input, **kwargs) # noqa: E501 + return self.os_filesystem_file_open_with_http_info(body, **kwargs) # noqa: E501 @validate_arguments - def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/os/files/pick [POST] # noqa: E501 + def os_filesystem_file_open_with_http_info(self, body : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/filesystem/file/open [POST] # noqa: E501 - This will trigger a filer picker and return the string paths of the files that were selected. # noqa: E501 + This will accept a path and will launch a path in a given finder/file explorer window note: TODO in the future add an endpoint for open/in || open/with (browser,files,...etc) && if so we will want /os/open_with/file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.pick_files_with_http_info(file_picker_input, async_req=True) + >>> thread = api.os_filesystem_file_open_with_http_info(body, async_req=True) >>> result = thread.get() - :param file_picker_input: - :type file_picker_input: FilePickerInput + :param body: + :type body: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -957,13 +994,13 @@ def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(List[str], status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ - 'file_picker_input' + 'body' ] _all_params.extend( [ @@ -982,7 +1019,7 @@ def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method pick_files" % _key + " to method os_filesystem_file_open" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1001,12 +1038,12 @@ def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput _files = {} # process the body parameter _body_params = None - if _params['file_picker_input'] is not None: - _body_params = _params['file_picker_input'] + if _params['body'] is not None: + _body_params = _params['body'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'text/plain']) # noqa: E501 + ['text/plain']) # noqa: E501 # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', @@ -1018,13 +1055,10 @@ def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput # authentication setting _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "List[str]", - '500': "str", - } + _response_types_map = {} return self.api_client.call_api( - '/os/files/pick', 'POST', + '/os/filesystem/file/open', 'POST', _path_params, _query_params, _header_params, @@ -1041,16 +1075,18 @@ def pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput _request_auth=_params.get('_request_auth')) @validate_arguments - def pick_folders(self, **kwargs) -> List[str]: # noqa: E501 - """/os/folders/pick [POST] # noqa: E501 + def os_filesystem_file_read_streamed(self, os_file_streaming_read_attempt : Optional[OSFileStreamingReadAttempt] = None, **kwargs) -> OSFileStreamingRead: # noqa: E501 + """/os/filesystem/file/read/streamed [WS] # noqa: E501 - This will trigger a folder picker and return the string paths of the folders that were selected. # noqa: E501 + This will stream(via a WS the contents of a file back to the client, given a file, it will read the contents and return to the client. NOTE: will NOT support relative paths. only ABSOLUTE paths. NOTE: needs to be a File.(will not stream a folder) NOTE: we might want to put a limit on the size of the file(IE no more than a GB or something like that??) TODO: would be nice to cancel stream NOTE: for v2 we could have two query params i.e. find which could take in a relative path and or file name and the other could be compress i.e. streaming a gzip vs the raw bytes.. the caveat here would be mack would need to decompress em. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.pick_folders(async_req=True) + >>> thread = api.os_filesystem_file_read_streamed(os_file_streaming_read_attempt, async_req=True) >>> result = thread.get() + :param os_file_streaming_read_attempt: + :type os_file_streaming_read_attempt: OSFileStreamingReadAttempt :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -1060,25 +1096,27 @@ def pick_folders(self, **kwargs) -> List[str]: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: List[str] + :rtype: OSFileStreamingRead """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the pick_folders_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the os_filesystem_file_read_streamed_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.pick_folders_with_http_info(**kwargs) # noqa: E501 + return self.os_filesystem_file_read_streamed_with_http_info(os_file_streaming_read_attempt, **kwargs) # noqa: E501 @validate_arguments - def pick_folders_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/os/folders/pick [POST] # noqa: E501 + def os_filesystem_file_read_streamed_with_http_info(self, os_file_streaming_read_attempt : Optional[OSFileStreamingReadAttempt] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/filesystem/file/read/streamed [WS] # noqa: E501 - This will trigger a folder picker and return the string paths of the folders that were selected. # noqa: E501 + This will stream(via a WS the contents of a file back to the client, given a file, it will read the contents and return to the client. NOTE: will NOT support relative paths. only ABSOLUTE paths. NOTE: needs to be a File.(will not stream a folder) NOTE: we might want to put a limit on the size of the file(IE no more than a GB or something like that??) TODO: would be nice to cancel stream NOTE: for v2 we could have two query params i.e. find which could take in a relative path and or file name and the other could be compress i.e. streaming a gzip vs the raw bytes.. the caveat here would be mack would need to decompress em. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.pick_folders_with_http_info(async_req=True) + >>> thread = api.os_filesystem_file_read_streamed_with_http_info(os_file_streaming_read_attempt, async_req=True) >>> result = thread.get() + :param os_file_streaming_read_attempt: + :type os_file_streaming_read_attempt: OSFileStreamingReadAttempt :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1101,12 +1139,13 @@ def pick_folders_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(List[str], status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(OSFileStreamingRead, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'os_file_streaming_read_attempt' ] _all_params.extend( [ @@ -1125,7 +1164,7 @@ def pick_folders_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method pick_folders" % _key + " to method os_filesystem_file_read_streamed" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1144,20 +1183,1958 @@ def pick_folders_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _files = {} # process the body parameter _body_params = None + if _params['os_file_streaming_read_attempt'] is not None: + _body_params = _params['os_file_streaming_read_attempt'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "List[str]", + '200': "OSFileStreamingRead", + '500': "str", + } + + return self.api_client.call_api( + '/os/filesystem/file/read/streamed', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_filesystem_path_verify(self, body : Optional[StrictStr] = None, **kwargs) -> VerifiedOSFilesystemPath: # noqa: E501 + """/os/filesystem/path/verify [POST] # noqa: E501 + + This will determine in a given path is a file/a directory or invalid. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_path_verify(body, async_req=True) + >>> result = thread.get() + + :param body: + :type body: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: VerifiedOSFilesystemPath + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_filesystem_path_verify_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_filesystem_path_verify_with_http_info(body, **kwargs) # noqa: E501 + + @validate_arguments + def os_filesystem_path_verify_with_http_info(self, body : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/filesystem/path/verify [POST] # noqa: E501 + + This will determine in a given path is a file/a directory or invalid. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_path_verify_with_http_info(body, async_req=True) + >>> result = thread.get() + + :param body: + :type body: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(VerifiedOSFilesystemPath, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'body' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_filesystem_path_verify" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['body'] is not None: + _body_params = _params['body'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "VerifiedOSFilesystemPath", + '500': "str", + } + + return self.api_client.call_api( + '/os/filesystem/path/verify', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_filesystem_pick_files(self, file_picker_input : Optional[FilePickerInput] = None, **kwargs) -> List[str]: # noqa: E501 + """/os/filesystem/files/pick [POST] # noqa: E501 + + This will trigger a filer picker and return the string paths of the files that were selected. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_pick_files(file_picker_input, async_req=True) + >>> result = thread.get() + + :param file_picker_input: + :type file_picker_input: FilePickerInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: List[str] + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_filesystem_pick_files_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_filesystem_pick_files_with_http_info(file_picker_input, **kwargs) # noqa: E501 + + @validate_arguments + def os_filesystem_pick_files_with_http_info(self, file_picker_input : Optional[FilePickerInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/filesystem/files/pick [POST] # noqa: E501 + + This will trigger a filer picker and return the string paths of the files that were selected. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_pick_files_with_http_info(file_picker_input, async_req=True) + >>> result = thread.get() + + :param file_picker_input: + :type file_picker_input: FilePickerInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(List[str], status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'file_picker_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_filesystem_pick_files" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['file_picker_input'] is not None: + _body_params = _params['file_picker_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "List[str]", + '500': "str", + } + + return self.api_client.call_api( + '/os/filesystem/files/pick', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_filesystem_pick_folders(self, **kwargs) -> List[str]: # noqa: E501 + """/os/filesystem/folders/pick [POST] # noqa: E501 + + This will trigger a folder picker and return the string paths of the folders that were selected. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_pick_folders(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: List[str] + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_filesystem_pick_folders_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_filesystem_pick_folders_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_filesystem_pick_folders_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/filesystem/folders/pick [POST] # noqa: E501 + + This will trigger a folder picker and return the string paths of the folders that were selected. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_filesystem_pick_folders_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(List[str], status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_filesystem_pick_folders" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "List[str]", + '500': "str", + } + + return self.api_client.call_api( + '/os/filesystem/folders/pick', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_memory_optimize(self, **kwargs) -> None: # noqa: E501 + """/os/memory/optimize [POST] # noqa: E501 + + This will optimize memory across PiecesOS.(TODO in the future might want to accept a body, so this will be a POST) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_memory_optimize(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_memory_optimize_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_memory_optimize_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_memory_optimize_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/memory/optimize [POST] # noqa: E501 + + This will optimize memory across PiecesOS.(TODO in the future might want to accept a body, so this will be a POST) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_memory_optimize_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_memory_optimize" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/os/memory/optimize', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_metadata(self, **kwargs) -> OSServerMetadata: # noqa: E501 + """/os/metadata [GET] # noqa: E501 + + This will return metadata (total materials) in your pieces drive. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_metadata(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerMetadata + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_metadata_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_metadata_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/metadata [GET] # noqa: E501 + + This will return metadata (total materials) in your pieces drive. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_metadata_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerMetadata, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_metadata" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerMetadata", + '500': "str", + } + + return self.api_client.call_api( + '/os/metadata', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_permissions(self, **kwargs) -> OSPermissions: # noqa: E501 + """/os/permissions [GET] # noqa: E501 + + This will only work on Macos and Windows. And will get the permissions of the user's local machine w/ regard to anything needed to effectively run PiecesOS. Note: this will let us know if we need to tell them to take action to enable any given permissions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_permissions(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSPermissions + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_permissions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_permissions_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_permissions_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/permissions [GET] # noqa: E501 + + This will only work on Macos and Windows. And will get the permissions of the user's local machine w/ regard to anything needed to effectively run PiecesOS. Note: this will let us know if we need to tell them to take action to enable any given permissions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_permissions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSPermissions, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_permissions" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSPermissions", + '500': "str", + } + + return self.api_client.call_api( + '/os/permissions', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_permissions_request(self, os_permissions : Optional[OSPermissions] = None, **kwargs) -> OSPermissions: # noqa: E501 + """/os/permissions/request [POST] # noqa: E501 + + This will only work on Macos and Windows. This will request permissions for the given inputs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_permissions_request(os_permissions, async_req=True) + >>> result = thread.get() + + :param os_permissions: + :type os_permissions: OSPermissions + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSPermissions + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_permissions_request_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_permissions_request_with_http_info(os_permissions, **kwargs) # noqa: E501 + + @validate_arguments + def os_permissions_request_with_http_info(self, os_permissions : Optional[OSPermissions] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/permissions/request [POST] # noqa: E501 + + This will only work on Macos and Windows. This will request permissions for the given inputs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_permissions_request_with_http_info(os_permissions, async_req=True) + >>> result = thread.get() + + :param os_permissions: + :type os_permissions: OSPermissions + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSPermissions, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'os_permissions' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_permissions_request" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['os_permissions'] is not None: + _body_params = _params['os_permissions'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSPermissions", + '500': "str", + } + + return self.api_client.call_api( + '/os/permissions/request', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_restart(self, **kwargs) -> None: # noqa: E501 + """Your GET endpoint # noqa: E501 + + This will restart PiecesOS, if successfull with return a 204. This is a LOCALOS Only Endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_restart(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_restart_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_restart_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_restart_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """Your GET endpoint # noqa: E501 + + This will restart PiecesOS, if successfull with return a 204. This is a LOCALOS Only Endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_restart_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_restart" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/os/restart', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_settings_snapshot(self, **kwargs) -> OSServerSettings: # noqa: E501 + """/os/settings [GET] # noqa: E501 + + This is a snapshot of the piecesOS settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_snapshot(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerSettings + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_settings_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_settings_snapshot_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_settings_snapshot_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/settings [GET] # noqa: E501 + + This is a snapshot of the piecesOS settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_snapshot_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerSettings, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_settings_snapshot" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerSettings", + '500': "str", + } + + return self.api_client.call_api( + '/os/settings', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_settings_stream(self, **kwargs) -> OSServerSettings: # noqa: E501 + """/os/settings/stream [WS] # noqa: E501 + + This is a websocket that will emit a change on the update of the OSSettings. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_stream(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerSettings + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_settings_stream_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_settings_stream_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_settings_stream_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/settings/stream [WS] # noqa: E501 + + This is a websocket that will emit a change on the update of the OSSettings. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_stream_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerSettings, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_settings_stream" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerSettings", + '500': "str", + } + + return self.api_client.call_api( + '/os/settings/stream', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_settings_update(self, os_server_settings : Optional[OSServerSettings] = None, **kwargs) -> OSServerSettings: # noqa: E501 + """/os/settings/update [POST] # noqa: E501 + + This will ensure that we update the os settings. This will emit a change via the setting stream as well. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_update(os_server_settings, async_req=True) + >>> result = thread.get() + + :param os_server_settings: + :type os_server_settings: OSServerSettings + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerSettings + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_settings_update_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_settings_update_with_http_info(os_server_settings, **kwargs) # noqa: E501 + + @validate_arguments + def os_settings_update_with_http_info(self, os_server_settings : Optional[OSServerSettings] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/settings/update [POST] # noqa: E501 + + This will ensure that we update the os settings. This will emit a change via the setting stream as well. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_settings_update_with_http_info(os_server_settings, async_req=True) + >>> result = thread.get() + + :param os_server_settings: + :type os_server_settings: OSServerSettings + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerSettings, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'os_server_settings' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_settings_update" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['os_server_settings'] is not None: + _body_params = _params['os_server_settings'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerSettings", + '500': "str", + } + + return self.api_client.call_api( + '/os/settings/update', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_terminate(self, **kwargs) -> None: # noqa: E501 + """/os/terminate [POST] # noqa: E501 + + This will force quit PiecesOS # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_terminate(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_terminate_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_terminate_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_terminate_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/terminate [POST] # noqa: E501 + + This will force quit PiecesOS # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_terminate_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_terminate" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/os/terminate', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_update_check(self, unchecked_os_server_update : Optional[UncheckedOSServerUpdate] = None, **kwargs) -> OSServerUpdateStatus: # noqa: E501 + """/os/update/check [POST] # noqa: E501 + + This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_update_check(unchecked_os_server_update, async_req=True) + >>> result = thread.get() + + :param unchecked_os_server_update: + :type unchecked_os_server_update: UncheckedOSServerUpdate + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerUpdateStatus + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_update_check_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_update_check_with_http_info(unchecked_os_server_update, **kwargs) # noqa: E501 + + @validate_arguments + def os_update_check_with_http_info(self, unchecked_os_server_update : Optional[UncheckedOSServerUpdate] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/os/update/check [POST] # noqa: E501 + + This is a helper endpoint that will check the status of an update for PiecesOS. IE if there is an update downloading, if there is one available, but the downloading has not started... etc # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_update_check_with_http_info(unchecked_os_server_update, async_req=True) + >>> result = thread.get() + + :param unchecked_os_server_update: + :type unchecked_os_server_update: UncheckedOSServerUpdate + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerUpdateStatus, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'unchecked_os_server_update' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_update_check" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['unchecked_os_server_update'] is not None: + _body_params = _params['unchecked_os_server_update'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerUpdateStatus", + '500': "str", + } + + return self.api_client.call_api( + '/os/update/check', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def os_update_check_stream(self, **kwargs) -> OSServerUpdateStatus: # noqa: E501 + """/os/update/check/stream [WS] # noqa: E501 + + This will first kick off the check. Then will stream the progress. **TODO lets think about if we want to have a closing NOTE: it is reccommended to use the stream instead of pulling(via the normal check endpoint). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_update_check_stream(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: OSServerUpdateStatus + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the os_update_check_stream_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.os_update_check_stream_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def os_update_check_stream_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/os/update/check/stream [WS] # noqa: E501 + + This will first kick off the check. Then will stream the progress. **TODO lets think about if we want to have a closing NOTE: it is reccommended to use the stream instead of pulling(via the normal check endpoint). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.os_update_check_stream_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(OSServerUpdateStatus, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method os_update_check_stream" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "OSServerUpdateStatus", '500': "str", } return self.api_client.call_api( - '/os/folders/pick', 'POST', + '/os/update/check/stream', 'GET', _path_params, _query_params, _header_params, diff --git a/src/pieces_os_client/api/person_api.py b/src/pieces_os_client/api/person_api.py index 3e5e9e8..4c86ae9 100644 --- a/src/pieces_os_client/api/person_api.py +++ b/src/pieces_os_client/api/person_api.py @@ -47,6 +47,152 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def person_associate_anchor(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> None: # noqa: E501 + """/person/{person}/anchors/associate/{anchor} [POST] # noqa: E501 + + associates a person and an anchor. It performs the same action as the anchor equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.person_associate_anchor(person, anchor, async_req=True) + >>> result = thread.get() + + :param person: This is a uuid that represents a person. (required) + :type person: str + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the person_associate_anchor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.person_associate_anchor_with_http_info(person, anchor, **kwargs) # noqa: E501 + + @validate_arguments + def person_associate_anchor_with_http_info(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> ApiResponse: # noqa: E501 + """/person/{person}/anchors/associate/{anchor} [POST] # noqa: E501 + + associates a person and an anchor. It performs the same action as the anchor equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.person_associate_anchor_with_http_info(person, anchor, async_req=True) + >>> result = thread.get() + + :param person: This is a uuid that represents a person. (required) + :type person: str + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'person', + 'anchor' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method person_associate_anchor" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['person'] is not None: + _path_params['person'] = _params['person'] + + if _params['anchor'] is not None: + _path_params['anchor'] = _params['anchor'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/person/{person}/anchors/associate/{anchor}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def person_associate_asset(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 """/person/{person}/assets/associate/{asset} [POST] # noqa: E501 @@ -631,6 +777,152 @@ def person_associate_workstream_summary_with_http_info(self, person : Annotated[ collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def person_disassociate_anchor(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> None: # noqa: E501 + """/person/{person}/anchors/disassociate/{anchor} [POST] # noqa: E501 + + Disassociates a person from an achor. It performs the same action as the anchor equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.person_disassociate_anchor(person, anchor, async_req=True) + >>> result = thread.get() + + :param person: This is a uuid that represents a person. (required) + :type person: str + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the person_disassociate_anchor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.person_disassociate_anchor_with_http_info(person, anchor, **kwargs) # noqa: E501 + + @validate_arguments + def person_disassociate_anchor_with_http_info(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], anchor : Annotated[StrictStr, Field(..., description="This is the specific uuid of an anchor.")], **kwargs) -> ApiResponse: # noqa: E501 + """/person/{person}/anchors/disassociate/{anchor} [POST] # noqa: E501 + + Disassociates a person from an achor. It performs the same action as the anchor equivalent. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.person_disassociate_anchor_with_http_info(person, anchor, async_req=True) + >>> result = thread.get() + + :param person: This is a uuid that represents a person. (required) + :type person: str + :param anchor: This is the specific uuid of an anchor. (required) + :type anchor: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'person', + 'anchor' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method person_disassociate_anchor" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['person'] is not None: + _path_params['person'] = _params['person'] + + if _params['anchor'] is not None: + _path_params['anchor'] = _params['anchor'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/person/{person}/anchors/disassociate/{anchor}', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def person_disassociate_asset(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 """/person/{person}/assets/disassociate/{asset} [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/persons_api.py b/src/pieces_os_client/api/persons_api.py index a5a0136..39763a9 100644 --- a/src/pieces_os_client/api/persons_api.py +++ b/src/pieces_os_client/api/persons_api.py @@ -26,6 +26,8 @@ from pieces_os_client.models.person import Person from pieces_os_client.models.persons import Persons +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_persons import SearchedPersons from pieces_os_client.models.seeded_person import SeededPerson from pieces_os_client.api_client import ApiClient @@ -343,20 +345,18 @@ def persons_delete_person_with_http_info(self, person : Annotated[StrictStr, Fie _request_auth=_params.get('_request_auth')) @validate_arguments - def persons_disassociate_asset(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> None: # noqa: E501 - """/persons/{person}/assets/delete/{asset} [POST] # noqa: E501 + def persons_snapshot(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> Persons: # noqa: E501 + """/persons [GET] # noqa: E501 - This will update both the asset and the person reference, that will remove a person from an asset(only the references). This will NOT remove the person. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will want to deprecate this at some point, please use the PersonAPI # noqa: E501 + This will get a snapshot of all of your people # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.persons_disassociate_asset(person, asset, async_req=True) + >>> thread = api.persons_snapshot(transferables, async_req=True) >>> result = thread.get() - :param person: This is a uuid that represents a person. (required) - :type person: str - :param asset: The id (uuid) of the asset that you are trying to access. (required) - :type asset: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -366,29 +366,27 @@ def persons_disassociate_asset(self, person : Annotated[StrictStr, Field(..., de :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: Persons """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the persons_disassociate_asset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the persons_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.persons_disassociate_asset_with_http_info(person, asset, **kwargs) # noqa: E501 + return self.persons_snapshot_with_http_info(transferables, **kwargs) # noqa: E501 @validate_arguments - def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr, Field(..., description="This is a uuid that represents a person.")], asset : Annotated[StrictStr, Field(..., description="The id (uuid) of the asset that you are trying to access.")], **kwargs) -> ApiResponse: # noqa: E501 - """/persons/{person}/assets/delete/{asset} [POST] # noqa: E501 + def persons_snapshot_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/persons [GET] # noqa: E501 - This will update both the asset and the person reference, that will remove a person from an asset(only the references). This will NOT remove the person. This will NOT remove the asset. This will only update the references so that they are disconnected from one another. NOTE: we will want to deprecate this at some point, please use the PersonAPI # noqa: E501 + This will get a snapshot of all of your people # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.persons_disassociate_asset_with_http_info(person, asset, async_req=True) + >>> thread = api.persons_snapshot_with_http_info(transferables, async_req=True) >>> result = thread.get() - :param person: This is a uuid that represents a person. (required) - :type person: str - :param asset: The id (uuid) of the asset that you are trying to access. (required) - :type asset: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -411,14 +409,13 @@ def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(Persons, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'person', - 'asset' + 'transferables' ] _all_params.extend( [ @@ -437,7 +434,7 @@ def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method persons_disassociate_asset" % _key + " to method persons_snapshot" % _key ) _params[_key] = _val del _params['kwargs'] @@ -446,15 +443,12 @@ def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr # process the path parameters _path_params = {} - if _params['person'] is not None: - _path_params['person'] = _params['person'] - - if _params['asset'] is not None: - _path_params['asset'] = _params['asset'] - # process the query parameters _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -464,15 +458,18 @@ def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['text/plain']) # noqa: E501 + ['application/json', 'text/plain']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "Persons", + '500': "str", + } return self.api_client.call_api( - '/persons/{person}/assets/delete/{asset}', 'POST', + '/persons', 'GET', _path_params, _query_params, _header_params, @@ -489,18 +486,20 @@ def persons_disassociate_asset_with_http_info(self, person : Annotated[StrictStr _request_auth=_params.get('_request_auth')) @validate_arguments - def persons_snapshot(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> Persons: # noqa: E501 - """/persons [GET] # noqa: E501 + def search_persons(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedPersons: # noqa: E501 + """/persons/search [POST] # noqa: E501 - This will get a snapshot of all of your people # noqa: E501 + This will search your persons for a specific person note: we will search, name, email, and username # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.persons_snapshot(transferables, async_req=True) + >>> thread = api.search_persons(transferables, search_input, async_req=True) >>> result = thread.get() :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) :type transferables: bool + :param search_input: + :type search_input: SearchInput :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -510,27 +509,29 @@ def persons_snapshot(self, transferables : Annotated[Optional[StrictBool], Field :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: Persons + :rtype: SearchedPersons """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the persons_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the search_persons_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.persons_snapshot_with_http_info(transferables, **kwargs) # noqa: E501 + return self.search_persons_with_http_info(transferables, search_input, **kwargs) # noqa: E501 @validate_arguments - def persons_snapshot_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/persons [GET] # noqa: E501 + def search_persons_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/persons/search [POST] # noqa: E501 - This will get a snapshot of all of your people # noqa: E501 + This will search your persons for a specific person note: we will search, name, email, and username # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.persons_snapshot_with_http_info(transferables, async_req=True) + >>> thread = api.search_persons_with_http_info(transferables, search_input, async_req=True) >>> result = thread.get() :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) :type transferables: bool + :param search_input: + :type search_input: SearchInput :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -553,13 +554,14 @@ def persons_snapshot_with_http_info(self, transferables : Annotated[Optional[Str :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(Persons, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(SearchedPersons, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'transferables' + 'transferables', + 'search_input' ] _all_params.extend( [ @@ -578,7 +580,7 @@ def persons_snapshot_with_http_info(self, transferables : Annotated[Optional[Str if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method persons_snapshot" % _key + " to method search_persons" % _key ) _params[_key] = _val del _params['kwargs'] @@ -600,20 +602,30 @@ def persons_snapshot_with_http_info(self, transferables : Annotated[Optional[Str _files = {} # process the body parameter _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "Persons", + '200': "SearchedPersons", '500': "str", } return self.api_client.call_api( - '/persons', 'GET', + '/persons/search', 'POST', _path_params, _query_params, _header_params, diff --git a/src/pieces_os_client/api/sensitives_api.py b/src/pieces_os_client/api/sensitives_api.py index 719f90d..c92d91f 100644 --- a/src/pieces_os_client/api/sensitives_api.py +++ b/src/pieces_os_client/api/sensitives_api.py @@ -20,10 +20,12 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import Field, StrictBool, StrictStr from typing import Optional +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_sensitives import SearchedSensitives from pieces_os_client.models.seeded_sensitive import SeededSensitive from pieces_os_client.models.sensitive import Sensitive from pieces_os_client.models.sensitives import Sensitives @@ -48,6 +50,162 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def search_sensitives(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedSensitives: # noqa: E501 + """/sensitives/search [POST] # noqa: E501 + + This will search your sensitives for a specific sensitive note: we will search the value of the sensitive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_sensitives(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedSensitives + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_sensitives_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_sensitives_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_sensitives_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/sensitives/search [POST] # noqa: E501 + + This will search your sensitives for a specific sensitive note: we will search the value of the sensitive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_sensitives_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedSensitives, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_sensitives" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedSensitives", + '500': "str", + } + + return self.api_client.call_api( + '/sensitives/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def sensitives_create_new_sensitive(self, seeded_sensitive : Optional[SeededSensitive] = None, **kwargs) -> Sensitive: # noqa: E501 """/sensitives/create [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/tags_api.py b/src/pieces_os_client/api/tags_api.py index a2a76e3..2b19643 100644 --- a/src/pieces_os_client/api/tags_api.py +++ b/src/pieces_os_client/api/tags_api.py @@ -26,6 +26,8 @@ from pieces_os_client.models.existent_metadata import ExistentMetadata from pieces_os_client.models.existing_metadata import ExistingMetadata +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_tags import SearchedTags from pieces_os_client.models.seeded_tag import SeededTag from pieces_os_client.models.tag import Tag from pieces_os_client.models.tags import Tags @@ -50,6 +52,162 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def search_tags(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedTags: # noqa: E501 + """/tags/search [POST] # noqa: E501 + + This will search your tags for a specific tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_tags(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedTags + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_tags_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_tags_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_tags_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/tags/search [POST] # noqa: E501 + + This will search your tags for a specific tag # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_tags_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedTags, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_tags" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedTags", + '500': "str", + } + + return self.api_client.call_api( + '/tags/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def tags_create_new_tag(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, seeded_tag : Optional[SeededTag] = None, **kwargs) -> Tag: # noqa: E501 """/tags/create [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/websites_api.py b/src/pieces_os_client/api/websites_api.py index 0c45eeb..361f849 100644 --- a/src/pieces_os_client/api/websites_api.py +++ b/src/pieces_os_client/api/websites_api.py @@ -26,6 +26,8 @@ from pieces_os_client.models.existent_metadata import ExistentMetadata from pieces_os_client.models.existing_metadata import ExistingMetadata +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_websites import SearchedWebsites from pieces_os_client.models.seeded_website import SeededWebsite from pieces_os_client.models.website import Website from pieces_os_client.models.websites import Websites @@ -50,6 +52,162 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def search_websites(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedWebsites: # noqa: E501 + """/websites/search [POST] # noqa: E501 + + This will search your websites for a specific website note: we will search the url, and search the name of the website # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_websites(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedWebsites + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_websites_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_websites_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_websites_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/websites/search [POST] # noqa: E501 + + This will search your websites for a specific website note: we will search the url, and search the name of the website # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_websites_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedWebsites, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_websites" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedWebsites", + '500': "str", + } + + return self.api_client.call_api( + '/websites/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def websites_create_new_website(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, seeded_website : Optional[SeededWebsite] = None, **kwargs) -> Website: # noqa: E501 """/websites/create [POST] # noqa: E501 diff --git a/src/pieces_os_client/api/workstream_api.py b/src/pieces_os_client/api/workstream_api.py index 7f6d3fd..c23b9a9 100644 --- a/src/pieces_os_client/api/workstream_api.py +++ b/src/pieces_os_client/api/workstream_api.py @@ -22,6 +22,7 @@ from typing import Optional from pieces_os_client.models.seeded_workstream_suggestions_refresh import SeededWorkstreamSuggestionsRefresh +from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions from pieces_os_client.models.workstream_suggestions_refresh import WorkstreamSuggestionsRefresh from pieces_os_client.api_client import ApiClient @@ -191,3 +192,136 @@ def workstream_suggestions_refresh_with_http_info(self, seeded_workstream_sugges _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_suggestions_stream(self, **kwargs) -> WorkstreamSuggestions: # noqa: E501 + """/workstream/suggestions/stream [WS] # noqa: E501 + + Provides a WebSocket connection that emits changes to your workstream suggestions. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_suggestions_stream(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamSuggestions + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_suggestions_stream_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_suggestions_stream_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def workstream_suggestions_stream_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream/suggestions/stream [WS] # noqa: E501 + + Provides a WebSocket connection that emits changes to your workstream suggestions. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_suggestions_stream_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamSuggestions, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_suggestions_stream" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamSuggestions", + '500': "str", + } + + return self.api_client.call_api( + '/workstream/suggestions/stream', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/src/pieces_os_client/api/workstream_pattern_engine_api.py b/src/pieces_os_client/api/workstream_pattern_engine_api.py index b8010e4..910d480 100644 --- a/src/pieces_os_client/api/workstream_pattern_engine_api.py +++ b/src/pieces_os_client/api/workstream_pattern_engine_api.py @@ -19,12 +19,25 @@ from pydantic import validate_arguments, ValidationError +from typing_extensions import Annotated +from pydantic import Field, StrictBool, StrictStr + from typing import Optional +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_workstream_pattern_engine_vision_events import SearchedWorkstreamPatternEngineVisionEvents from pieces_os_client.models.seeded_workstream_ingestion import SeededWorkstreamIngestion from pieces_os_client.models.workstream_ingestion import WorkstreamIngestion from pieces_os_client.models.workstream_pattern_engine_data_cleanup_request import WorkstreamPatternEngineDataCleanupRequest +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration +from pieces_os_client.models.workstream_pattern_engine_vision_calibrations import WorkstreamPatternEngineVisionCalibrations +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent +from pieces_os_client.models.workstream_pattern_engine_vision_event_deletions import WorkstreamPatternEngineVisionEventDeletions +from pieces_os_client.models.workstream_pattern_engine_vision_events import WorkstreamPatternEngineVisionEvents +from pieces_os_client.models.workstream_pattern_engine_vision_metadata import WorkstreamPatternEngineVisionMetadata from pieces_os_client.api_client import ApiClient from pieces_os_client.api_response import ApiResponse @@ -194,6 +207,139 @@ def workstream_pattern_engine_create_ingestion_with_http_info(self, seeded_works collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def workstream_pattern_engine_processors_sources(self, **kwargs) -> WorkstreamPatternEngineSources: # noqa: E501 + """/workstream_pattern_engine/processors/sources [GET] # noqa: E501 + + This will return all of the applications(focused windows) that have events saved within WPE qdrant collection. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_sources(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineSources + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_sources_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_sources_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_sources_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/sources [GET] # noqa: E501 + + This will return all of the applications(focused windows) that have events saved within WPE qdrant collection. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_sources_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineSources, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_sources" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineSources", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/sources', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def workstream_pattern_engine_processors_vision_activate(self, workstream_pattern_engine_status : Optional[WorkstreamPatternEngineStatus] = None, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 """/workstream_pattern_engine/processors/vision/activate [POST] # noqa: E501 @@ -344,18 +490,16 @@ def workstream_pattern_engine_processors_vision_activate_with_http_info(self, wo _request_auth=_params.get('_request_auth')) @validate_arguments - def workstream_pattern_engine_processors_vision_data_clear(self, workstream_pattern_engine_data_cleanup_request : Optional[WorkstreamPatternEngineDataCleanupRequest] = None, **kwargs) -> None: # noqa: E501 - """/workstream_pattern_engine/processors/vision/data/clear [POST] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibration_capture(self, **kwargs) -> WorkstreamPatternEngineVisionCalibration: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibration/capture [POST] # noqa: E501 - This will clear the data for the Workstream Pattern Engine, specifically for our vision data. This boy will accept ranges of time that the user wants to remove the processing from. # noqa: E501 + This will attempt to capture the copilot/feed/xyz dimensions of current focused window note: in the future we can make a differentiation of the dimensions based on the type of qrCode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_data_clear(workstream_pattern_engine_data_cleanup_request, async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibration_capture(async_req=True) >>> result = thread.get() - :param workstream_pattern_engine_data_cleanup_request: - :type workstream_pattern_engine_data_cleanup_request: WorkstreamPatternEngineDataCleanupRequest :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -365,27 +509,25 @@ def workstream_pattern_engine_processors_vision_data_clear(self, workstream_patt :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: WorkstreamPatternEngineVisionCalibration """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the workstream_pattern_engine_processors_vision_data_clear_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the workstream_pattern_engine_processors_vision_calibration_capture_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.workstream_pattern_engine_processors_vision_data_clear_with_http_info(workstream_pattern_engine_data_cleanup_request, **kwargs) # noqa: E501 + return self.workstream_pattern_engine_processors_vision_calibration_capture_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, workstream_pattern_engine_data_cleanup_request : Optional[WorkstreamPatternEngineDataCleanupRequest] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/workstream_pattern_engine/processors/vision/data/clear [POST] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibration_capture_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibration/capture [POST] # noqa: E501 - This will clear the data for the Workstream Pattern Engine, specifically for our vision data. This boy will accept ranges of time that the user wants to remove the processing from. # noqa: E501 + This will attempt to capture the copilot/feed/xyz dimensions of current focused window note: in the future we can make a differentiation of the dimensions based on the type of qrCode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_data_clear_with_http_info(workstream_pattern_engine_data_cleanup_request, async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibration_capture_with_http_info(async_req=True) >>> result = thread.get() - :param workstream_pattern_engine_data_cleanup_request: - :type workstream_pattern_engine_data_cleanup_request: WorkstreamPatternEngineDataCleanupRequest :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -408,13 +550,12 @@ def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(WorkstreamPatternEngineVisionCalibration, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'workstream_pattern_engine_data_cleanup_request' ] _all_params.extend( [ @@ -433,7 +574,7 @@ def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method workstream_pattern_engine_processors_vision_data_clear" % _key + " to method workstream_pattern_engine_processors_vision_calibration_capture" % _key ) _params[_key] = _val del _params['kwargs'] @@ -452,27 +593,20 @@ def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, _files = {} # process the body parameter _body_params = None - if _params['workstream_pattern_engine_data_cleanup_request'] is not None: - _body_params = _params['workstream_pattern_engine_data_cleanup_request'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['text/plain']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + ['application/json', 'text/plain']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "WorkstreamPatternEngineVisionCalibration", + '500': "str", + } return self.api_client.call_api( - '/workstream_pattern_engine/processors/vision/data/clear', 'POST', + '/workstream_pattern_engine/processors/vision/calibration/capture', 'POST', _path_params, _query_params, _header_params, @@ -489,18 +623,16 @@ def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, _request_auth=_params.get('_request_auth')) @validate_arguments - def workstream_pattern_engine_processors_vision_deactivate(self, workstream_pattern_engine_status : Optional[WorkstreamPatternEngineStatus] = None, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 - """/workstream_pattern_engine/processors/vision/deactivate [POST] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibrations_focused(self, **kwargs) -> WorkstreamPatternEngineVisionCalibration: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibrations/focused [GET] # noqa: E501 - This will deactivate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This will get the copilot/feed/xyz dimensions of the focused window. This endpoint will attempt to do the following: 1. get the focus window 2. we will do a lookup to see if we have the copilot/feed/xyz dimension for this window if not we will return null if so we will return the dimensions as well as when the dimensions were taken note: in the future we can make a differentiation of the dimensions based on the type of qrCode. note: no need to pass in the window name: b/c we will just get the focused window note: we will also return the window name in the returnable so the dev can verify this is the window of the plugin. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_deactivate(workstream_pattern_engine_status, async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibrations_focused(async_req=True) >>> result = thread.get() - :param workstream_pattern_engine_status: - :type workstream_pattern_engine_status: WorkstreamPatternEngineStatus :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. @@ -510,27 +642,25 @@ def workstream_pattern_engine_processors_vision_deactivate(self, workstream_patt :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: WorkstreamPatternEngineStatus + :rtype: WorkstreamPatternEngineVisionCalibration """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the workstream_pattern_engine_processors_vision_deactivate_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the workstream_pattern_engine_processors_vision_calibrations_focused_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.workstream_pattern_engine_processors_vision_deactivate_with_http_info(workstream_pattern_engine_status, **kwargs) # noqa: E501 + return self.workstream_pattern_engine_processors_vision_calibrations_focused_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, workstream_pattern_engine_status : Optional[WorkstreamPatternEngineStatus] = None, **kwargs) -> ApiResponse: # noqa: E501 - """/workstream_pattern_engine/processors/vision/deactivate [POST] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibrations_focused_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibrations/focused [GET] # noqa: E501 - This will deactivate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This will get the copilot/feed/xyz dimensions of the focused window. This endpoint will attempt to do the following: 1. get the focus window 2. we will do a lookup to see if we have the copilot/feed/xyz dimension for this window if not we will return null if so we will return the dimensions as well as when the dimensions were taken note: in the future we can make a differentiation of the dimensions based on the type of qrCode. note: no need to pass in the window name: b/c we will just get the focused window note: we will also return the window name in the returnable so the dev can verify this is the window of the plugin. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_deactivate_with_http_info(workstream_pattern_engine_status, async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibrations_focused_with_http_info(async_req=True) >>> result = thread.get() - :param workstream_pattern_engine_status: - :type workstream_pattern_engine_status: WorkstreamPatternEngineStatus :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -553,13 +683,12 @@ def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(WorkstreamPatternEngineStatus, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(WorkstreamPatternEngineVisionCalibration, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'workstream_pattern_engine_status' ] _all_params.extend( [ @@ -578,7 +707,7 @@ def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method workstream_pattern_engine_processors_vision_deactivate" % _key + " to method workstream_pattern_engine_processors_vision_calibrations_focused" % _key ) _params[_key] = _val del _params['kwargs'] @@ -597,31 +726,20 @@ def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, _files = {} # process the body parameter _body_params = None - if _params['workstream_pattern_engine_status'] is not None: - _body_params = _params['workstream_pattern_engine_status'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json', 'text/plain']) # noqa: E501 - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "WorkstreamPatternEngineStatus", - '403': "str", + '200': "WorkstreamPatternEngineVisionCalibration", '500': "str", } return self.api_client.call_api( - '/workstream_pattern_engine/processors/vision/deactivate', 'POST', + '/workstream_pattern_engine/processors/vision/calibrations/focused', 'GET', _path_params, _query_params, _header_params, @@ -638,14 +756,14 @@ def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, _request_auth=_params.get('_request_auth')) @validate_arguments - def workstream_pattern_engine_processors_vision_status(self, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 - """/workstream_pattern_engine/processors/vision/status [GET] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibrations_snapshot(self, **kwargs) -> WorkstreamPatternEngineVisionCalibrations: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibrations [GET] # noqa: E501 - This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This will return a snapshot of all of our captured copilot window Dimensions note: this will return many captures note: will want to add type of calibration for this specific dimension(ie copilot/feed/xyz) note: in the future we can make a differentiation of the dimensions based on the type of qrCode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_status(async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibrations_snapshot(async_req=True) >>> result = thread.get() :param async_req: Whether to execute the request asynchronously. @@ -657,23 +775,23 @@ def workstream_pattern_engine_processors_vision_status(self, **kwargs) -> Workst :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: WorkstreamPatternEngineStatus + :rtype: WorkstreamPatternEngineVisionCalibrations """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - message = "Error! Please call the workstream_pattern_engine_processors_vision_status_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + message = "Error! Please call the workstream_pattern_engine_processors_vision_calibrations_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 raise ValueError(message) - return self.workstream_pattern_engine_processors_vision_status_with_http_info(**kwargs) # noqa: E501 + return self.workstream_pattern_engine_processors_vision_calibrations_snapshot_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def workstream_pattern_engine_processors_vision_status_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """/workstream_pattern_engine/processors/vision/status [GET] # noqa: E501 + def workstream_pattern_engine_processors_vision_calibrations_snapshot_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/calibrations [GET] # noqa: E501 - This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This will return a snapshot of all of our captured copilot window Dimensions note: this will return many captures note: will want to add type of calibration for this specific dimension(ie copilot/feed/xyz) note: in the future we can make a differentiation of the dimensions based on the type of qrCode. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.workstream_pattern_engine_processors_vision_status_with_http_info(async_req=True) + >>> thread = api.workstream_pattern_engine_processors_vision_calibrations_snapshot_with_http_info(async_req=True) >>> result = thread.get() :param async_req: Whether to execute the request asynchronously. @@ -698,7 +816,7 @@ def workstream_pattern_engine_processors_vision_status_with_http_info(self, **kw :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(WorkstreamPatternEngineStatus, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(WorkstreamPatternEngineVisionCalibrations, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() @@ -722,7 +840,7 @@ def workstream_pattern_engine_processors_vision_status_with_http_info(self, **kw if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method workstream_pattern_engine_processors_vision_status" % _key + " to method workstream_pattern_engine_processors_vision_calibrations_snapshot" % _key ) _params[_key] = _val del _params['kwargs'] @@ -749,13 +867,1438 @@ def workstream_pattern_engine_processors_vision_status_with_http_info(self, **kw _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "WorkstreamPatternEngineStatus", - '403': "str", + '200': "WorkstreamPatternEngineVisionCalibrations", '500': "str", } return self.api_client.call_api( - '/workstream_pattern_engine/processors/vision/status', 'GET', + '/workstream_pattern_engine/processors/vision/calibrations', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_data_clear(self, workstream_pattern_engine_data_cleanup_request : Optional[WorkstreamPatternEngineDataCleanupRequest] = None, **kwargs) -> None: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/clear [POST] # noqa: E501 + + This will clear the data for the Workstream Pattern Engine, specifically for our vision data. This boy will accept ranges of time that the user wants to remove the processing from. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_data_clear(workstream_pattern_engine_data_cleanup_request, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_data_cleanup_request: + :type workstream_pattern_engine_data_cleanup_request: WorkstreamPatternEngineDataCleanupRequest + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_data_clear_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_data_clear_with_http_info(workstream_pattern_engine_data_cleanup_request, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_data_clear_with_http_info(self, workstream_pattern_engine_data_cleanup_request : Optional[WorkstreamPatternEngineDataCleanupRequest] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/clear [POST] # noqa: E501 + + This will clear the data for the Workstream Pattern Engine, specifically for our vision data. This boy will accept ranges of time that the user wants to remove the processing from. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_data_clear_with_http_info(workstream_pattern_engine_data_cleanup_request, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_data_cleanup_request: + :type workstream_pattern_engine_data_cleanup_request: WorkstreamPatternEngineDataCleanupRequest + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'workstream_pattern_engine_data_cleanup_request' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_data_clear" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['workstream_pattern_engine_data_cleanup_request'] is not None: + _body_params = _params['workstream_pattern_engine_data_cleanup_request'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/clear', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_deactivate(self, workstream_pattern_engine_status : Optional[WorkstreamPatternEngineStatus] = None, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 + """/workstream_pattern_engine/processors/vision/deactivate [POST] # noqa: E501 + + This will deactivate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_deactivate(workstream_pattern_engine_status, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_status: + :type workstream_pattern_engine_status: WorkstreamPatternEngineStatus + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineStatus + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_deactivate_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_deactivate_with_http_info(workstream_pattern_engine_status, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_deactivate_with_http_info(self, workstream_pattern_engine_status : Optional[WorkstreamPatternEngineStatus] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/deactivate [POST] # noqa: E501 + + This will deactivate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_deactivate_with_http_info(workstream_pattern_engine_status, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_status: + :type workstream_pattern_engine_status: WorkstreamPatternEngineStatus + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineStatus, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'workstream_pattern_engine_status' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_deactivate" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['workstream_pattern_engine_status'] is not None: + _body_params = _params['workstream_pattern_engine_status'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineStatus", + '403': "str", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/deactivate', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_event_delete_specific_vision_event(self, vision_event : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific WPE_vision event.")], **kwargs) -> None: # noqa: E501 + """/workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST] # noqa: E501 + + This will delete a single event. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_event_delete_specific_vision_event(vision_event, async_req=True) + >>> result = thread.get() + + :param vision_event: This is a identifier that is used to identify a specific WPE_vision event. (required) + :type vision_event: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_event_delete_specific_vision_event_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_event_delete_specific_vision_event_with_http_info(vision_event, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_event_delete_specific_vision_event_with_http_info(self, vision_event : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific WPE_vision event.")], **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST] # noqa: E501 + + This will delete a single event. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_event_delete_specific_vision_event_with_http_info(vision_event, async_req=True) + >>> result = thread.get() + + :param vision_event: This is a identifier that is used to identify a specific WPE_vision event. (required) + :type vision_event: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'vision_event' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_event_delete_specific_vision_event" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['vision_event'] is not None: + _path_params['vision_event'] = _params['vision_event'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/events/{vision_event}/delete', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_scoped_delete(self, workstream_pattern_engine_vision_event_deletions : Optional[WorkstreamPatternEngineVisionEventDeletions] = None, **kwargs) -> FlattenedWorkstreamPatternEngineVisionEvents: # noqa: E501 + """/workstream_pattern_engine/processors/vision/events/scoped_delete [POST] # noqa: E501 + + This will remove the UUIDs that were removed from the qdrant event. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_scoped_delete(workstream_pattern_engine_vision_event_deletions, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_vision_event_deletions: + :type workstream_pattern_engine_vision_event_deletions: WorkstreamPatternEngineVisionEventDeletions + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: FlattenedWorkstreamPatternEngineVisionEvents + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_events_scoped_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_events_scoped_delete_with_http_info(workstream_pattern_engine_vision_event_deletions, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_scoped_delete_with_http_info(self, workstream_pattern_engine_vision_event_deletions : Optional[WorkstreamPatternEngineVisionEventDeletions] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/events/scoped_delete [POST] # noqa: E501 + + This will remove the UUIDs that were removed from the qdrant event. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_scoped_delete_with_http_info(workstream_pattern_engine_vision_event_deletions, async_req=True) + >>> result = thread.get() + + :param workstream_pattern_engine_vision_event_deletions: + :type workstream_pattern_engine_vision_event_deletions: WorkstreamPatternEngineVisionEventDeletions + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(FlattenedWorkstreamPatternEngineVisionEvents, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'workstream_pattern_engine_vision_event_deletions' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_events_scoped_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['workstream_pattern_engine_vision_event_deletions'] is not None: + _body_params = _params['workstream_pattern_engine_vision_event_deletions'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "FlattenedWorkstreamPatternEngineVisionEvents", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/events/scoped_delete', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_search(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedWorkstreamPatternEngineVisionEvents: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events/search [POST] # noqa: E501 + + This will search your WPE events and will return a list of events that match the query/timestamp range/list of applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_search(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedWorkstreamPatternEngineVisionEvents + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_events_search_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_events_search_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_search_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events/search [POST] # noqa: E501 + + This will search your WPE events and will return a list of events that match the query/timestamp range/list of applications # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_search_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedWorkstreamPatternEngineVisionEvents, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_events_search" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedWorkstreamPatternEngineVisionEvents", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/events/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_snapshot(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> WorkstreamPatternEngineVisionEvents: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events [GET] # noqa: E501 + + This will return a snapshot of all of the WPE qdrant events note: if the transferables: are true then we will provide values for each of our events otherwise we will just provide basic metadata # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_snapshot(transferables, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineVisionEvents + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_events_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_events_snapshot_with_http_info(transferables, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_snapshot_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events [GET] # noqa: E501 + + This will return a snapshot of all of the WPE qdrant events note: if the transferables: are true then we will provide values for each of our events otherwise we will just provide basic metadata # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_snapshot_with_http_info(transferables, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineVisionEvents, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_events_snapshot" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineVisionEvents", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/events', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_specific_snapshot(self, vision_event : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific WPE_vision event.")], transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> WorkstreamPatternEngineVisionEvent: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET] # noqa: E501 + + This will return a specific event from the WPE. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_specific_snapshot(vision_event, transferables, async_req=True) + >>> result = thread.get() + + :param vision_event: This is a identifier that is used to identify a specific WPE_vision event. (required) + :type vision_event: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineVisionEvent + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_events_specific_snapshot_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_events_specific_snapshot_with_http_info(vision_event, transferables, **kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_events_specific_snapshot_with_http_info(self, vision_event : Annotated[StrictStr, Field(..., description="This is a identifier that is used to identify a specific WPE_vision event.")], transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET] # noqa: E501 + + This will return a specific event from the WPE. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_events_specific_snapshot_with_http_info(vision_event, transferables, async_req=True) + >>> result = thread.get() + + :param vision_event: This is a identifier that is used to identify a specific WPE_vision event. (required) + :type vision_event: str + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineVisionEvent, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'vision_event', + 'transferables' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_events_specific_snapshot" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['vision_event'] is not None: + _path_params['vision_event'] = _params['vision_event'] + + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineVisionEvent", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/data/events/{vision_event}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_metadata(self, **kwargs) -> WorkstreamPatternEngineVisionMetadata: # noqa: E501 + """/workstream_pattern_engine/processors/vision/metadata [GET] # noqa: E501 + + This is an endpoint that will return the metadata of the vision data (WPE qdrant size) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_metadata(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineVisionMetadata + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_metadata_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_metadata_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/metadata [GET] # noqa: E501 + + This is an endpoint that will return the metadata of the vision data (WPE qdrant size) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_metadata_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineVisionMetadata, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_metadata" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineVisionMetadata", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/metadata', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_status(self, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 + """/workstream_pattern_engine/processors/vision/status [GET] # noqa: E501 + + This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_status(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineStatus + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_status_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_status_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_status_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/status [GET] # noqa: E501 + + This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_status_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineStatus, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_status" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineStatus", + '403': "str", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/status', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def workstream_pattern_engine_processors_vision_status_stream(self, **kwargs) -> WorkstreamPatternEngineStatus: # noqa: E501 + """/workstream_pattern_engine/processors/vision/status/steam [WS] # noqa: E501 + + This is a websocket for the status of the workstream pattern engine for vision. This will emit an event when this is first connected to, and will emit an event when every this value changes This will emit a \"WorkstreamPatternEngineStatus\" Model. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_status_stream(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: WorkstreamPatternEngineStatus + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the workstream_pattern_engine_processors_vision_status_stream_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.workstream_pattern_engine_processors_vision_status_stream_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def workstream_pattern_engine_processors_vision_status_stream_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_pattern_engine/processors/vision/status/steam [WS] # noqa: E501 + + This is a websocket for the status of the workstream pattern engine for vision. This will emit an event when this is first connected to, and will emit an event when every this value changes This will emit a \"WorkstreamPatternEngineStatus\" Model. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workstream_pattern_engine_processors_vision_status_stream_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(WorkstreamPatternEngineStatus, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method workstream_pattern_engine_processors_vision_status_stream" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "WorkstreamPatternEngineStatus", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_pattern_engine/processors/vision/status/stream', 'GET', _path_params, _query_params, _header_params, diff --git a/src/pieces_os_client/api/workstream_summaries_api.py b/src/pieces_os_client/api/workstream_summaries_api.py index f93532e..0e3a248 100644 --- a/src/pieces_os_client/api/workstream_summaries_api.py +++ b/src/pieces_os_client/api/workstream_summaries_api.py @@ -24,6 +24,8 @@ from typing import Optional +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_workstream_summaries import SearchedWorkstreamSummaries from pieces_os_client.models.seeded_workstream_summary import SeededWorkstreamSummary from pieces_os_client.models.workstream_summaries import WorkstreamSummaries from pieces_os_client.models.workstream_summary import WorkstreamSummary @@ -48,6 +50,162 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client + @validate_arguments + def search_workstream_summaries(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> SearchedWorkstreamSummaries: # noqa: E501 + """/workstream_summaries/search [POST] # noqa: E501 + + This will search your workstream_summaries for a specific workstream_summary note: we will just search the summary value(which is an annotation) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_workstream_summaries(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: SearchedWorkstreamSummaries + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the search_workstream_summaries_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.search_workstream_summaries_with_http_info(transferables, search_input, **kwargs) # noqa: E501 + + @validate_arguments + def search_workstream_summaries_with_http_info(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, search_input : Optional[SearchInput] = None, **kwargs) -> ApiResponse: # noqa: E501 + """/workstream_summaries/search [POST] # noqa: E501 + + This will search your workstream_summaries for a specific workstream_summary note: we will just search the summary value(which is an annotation) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_workstream_summaries_with_http_info(transferables, search_input, async_req=True) + >>> result = thread.get() + + :param transferables: This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) + :type transferables: bool + :param search_input: + :type search_input: SearchInput + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(SearchedWorkstreamSummaries, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'transferables', + 'search_input' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method search_workstream_summaries" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('transferables') is not None: # noqa: E501 + _query_params.append(('transferables', _params['transferables'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['search_input'] is not None: + _body_params = _params['search_input'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json', 'text/plain']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "SearchedWorkstreamSummaries", + '500': "str", + } + + return self.api_client.call_api( + '/workstream_summaries/search', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def workstream_summaries_create_new_workstream_summary(self, transferables : Annotated[Optional[StrictBool], Field(description="This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)")] = None, seeded_workstream_summary : Optional[SeededWorkstreamSummary] = None, **kwargs) -> WorkstreamSummary: # noqa: E501 """/workstream_summaries/create [POST] # noqa: E501 diff --git a/src/pieces_os_client/api_client.py b/src/pieces_os_client/api_client.py index 31664ae..f35ca20 100644 --- a/src/pieces_os_client/api_client.py +++ b/src/pieces_os_client/api_client.py @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2.2.0/python' + self.user_agent = 'OpenAPI-Generator/2.3.0/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/src/pieces_os_client/configuration.py b/src/pieces_os_client/configuration.py index c51e159..30b2f95 100644 --- a/src/pieces_os_client/configuration.py +++ b/src/pieces_os_client/configuration.py @@ -412,7 +412,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 1.0\n"\ - "SDK Package Version: 2.2.0".\ + "SDK Package Version: 2.3.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/src/pieces_os_client/models/__init__.py b/src/pieces_os_client/models/__init__.py index 4e579b5..c3df70b 100644 --- a/src/pieces_os_client/models/__init__.py +++ b/src/pieces_os_client/models/__init__.py @@ -18,6 +18,7 @@ from pieces_os_client.models.access_enum import AccessEnum from pieces_os_client.models.accessor import Accessor from pieces_os_client.models.accessors import Accessors +from pieces_os_client.models.active_os_server_applet import ActiveOSServerApplet from pieces_os_client.models.activities import Activities from pieces_os_client.models.activity import Activity from pieces_os_client.models.aesthetics import Aesthetics @@ -75,7 +76,6 @@ from pieces_os_client.models.byte_descriptor import ByteDescriptor from pieces_os_client.models.capabilities_enum import CapabilitiesEnum from pieces_os_client.models.challenged_pkce import ChallengedPKCE -from pieces_os_client.models.checked_os_update import CheckedOSUpdate from pieces_os_client.models.classification import Classification from pieces_os_client.models.classification_generic_enum import ClassificationGenericEnum from pieces_os_client.models.classification_rendering_enum import ClassificationRenderingEnum @@ -115,6 +115,8 @@ from pieces_os_client.models.embedded_model_schema_semantic_version_enum import EmbeddedModelSchemaSemanticVersionEnum from pieces_os_client.models.embedding import Embedding from pieces_os_client.models.embeddings import Embeddings +from pieces_os_client.models.embeddings_search_options import EmbeddingsSearchOptions +from pieces_os_client.models.embeddings_search_options_embedding_type_enum import EmbeddingsSearchOptionsEmbeddingTypeEnum from pieces_os_client.models.existent_metadata import ExistentMetadata from pieces_os_client.models.existing_metadata import ExistingMetadata from pieces_os_client.models.exported_asset import ExportedAsset @@ -170,6 +172,8 @@ from pieces_os_client.models.flattened_websites import FlattenedWebsites from pieces_os_client.models.flattened_workstream_event import FlattenedWorkstreamEvent from pieces_os_client.models.flattened_workstream_events import FlattenedWorkstreamEvents +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_event import FlattenedWorkstreamPatternEngineVisionEvent +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents from pieces_os_client.models.flattened_workstream_summaries import FlattenedWorkstreamSummaries from pieces_os_client.models.flattened_workstream_summary import FlattenedWorkstreamSummary from pieces_os_client.models.font import Font @@ -180,6 +184,7 @@ from pieces_os_client.models.formats_metrics import FormatsMetrics from pieces_os_client.models.fragment_format import FragmentFormat from pieces_os_client.models.fragment_metadata import FragmentMetadata +from pieces_os_client.models.full_text_search_options import FullTextSearchOptions from pieces_os_client.models.git_hub_distribution import GitHubDistribution from pieces_os_client.models.git_hub_gist_distribution import GitHubGistDistribution from pieces_os_client.models.graphical_image_descriptive_statistics import GraphicalImageDescriptiveStatistics @@ -202,6 +207,7 @@ from pieces_os_client.models.ide_tabs import IDETabs from pieces_os_client.models.image_analyses import ImageAnalyses from pieces_os_client.models.image_analysis import ImageAnalysis +from pieces_os_client.models.inactive_os_server_applet import InactiveOSServerApplet from pieces_os_client.models.interacted_asset import InteractedAsset from pieces_os_client.models.interacted_asset_interactions import InteractedAssetInteractions from pieces_os_client.models.interacted_assets import InteractedAssets @@ -237,15 +243,22 @@ from pieces_os_client.models.o_auth_token import OAuthToken from pieces_os_client.models.ocr_analyses import OCRAnalyses from pieces_os_client.models.ocr_analysis import OCRAnalysis +from pieces_os_client.models.os_applet_enum import OSAppletEnum from pieces_os_client.models.os_device_cpu_hardware_information import OSDeviceCPUHardwareInformation from pieces_os_client.models.os_device_dependencies_information import OSDeviceDependenciesInformation from pieces_os_client.models.os_device_gpu_hardware_capabilities_information import OSDeviceGPUHardwareCapabilitiesInformation from pieces_os_client.models.os_device_gpu_hardware_information import OSDeviceGPUHardwareInformation from pieces_os_client.models.os_device_hardware_information import OSDeviceHardwareInformation from pieces_os_client.models.os_device_information_returnable import OSDeviceInformationReturnable +from pieces_os_client.models.os_file_streaming_read import OSFileStreamingRead +from pieces_os_client.models.os_file_streaming_read_attempt import OSFileStreamingReadAttempt +from pieces_os_client.models.os_file_streaming_read_progress import OSFileStreamingReadProgress from pieces_os_client.models.os_health import OSHealth from pieces_os_client.models.os_permissions import OSPermissions from pieces_os_client.models.os_processing_permissions import OSProcessingPermissions +from pieces_os_client.models.os_server_metadata import OSServerMetadata +from pieces_os_client.models.os_server_settings import OSServerSettings +from pieces_os_client.models.os_server_update_status import OSServerUpdateStatus from pieces_os_client.models.onboarded_persona_details import OnboardedPersonaDetails from pieces_os_client.models.open_ai_models_list_input import OpenAIModelsListInput from pieces_os_client.models.open_ai_models_list_output import OpenAIModelsListOutput @@ -294,6 +307,8 @@ from pieces_os_client.models.qgpt_stream_enum import QGPTStreamEnum from pieces_os_client.models.qgpt_stream_input import QGPTStreamInput from pieces_os_client.models.qgpt_stream_output import QGPTStreamOutput +from pieces_os_client.models.qgpt_streamed_output_extracted_materials import QGPTStreamedOutputExtractedMaterials +from pieces_os_client.models.qgpt_streamed_output_extracted_textual_materials import QGPTStreamedOutputExtractedTextualMaterials from pieces_os_client.models.qgpt_task_pipeline import QGPTTaskPipeline from pieces_os_client.models.qgpt_task_pipeline_for_code_commentation import QGPTTaskPipelineForCodeCommentation from pieces_os_client.models.qgpt_task_pipeline_for_code_completion import QGPTTaskPipelineForCodeCompletion @@ -323,6 +338,7 @@ from pieces_os_client.models.referenced_user import ReferencedUser from pieces_os_client.models.referenced_website import ReferencedWebsite from pieces_os_client.models.referenced_workstream_event import ReferencedWorkstreamEvent +from pieces_os_client.models.referenced_workstream_pattern_engine_vision_event import ReferencedWorkstreamPatternEngineVisionEvent from pieces_os_client.models.referenced_workstream_summary import ReferencedWorkstreamSummary from pieces_os_client.models.relationship import Relationship from pieces_os_client.models.relationships import Relationships @@ -336,9 +352,36 @@ from pieces_os_client.models.role import Role from pieces_os_client.models.save_suggestion import SaveSuggestion from pieces_os_client.models.score import Score +from pieces_os_client.models.search_engine import SearchEngine +from pieces_os_client.models.search_engines import SearchEngines +from pieces_os_client.models.search_input import SearchInput +from pieces_os_client.models.searched_anchor import SearchedAnchor +from pieces_os_client.models.searched_anchor_point import SearchedAnchorPoint +from pieces_os_client.models.searched_anchor_points import SearchedAnchorPoints +from pieces_os_client.models.searched_anchors import SearchedAnchors +from pieces_os_client.models.searched_annotation import SearchedAnnotation +from pieces_os_client.models.searched_annotations import SearchedAnnotations from pieces_os_client.models.searched_asset import SearchedAsset from pieces_os_client.models.searched_assets import SearchedAssets +from pieces_os_client.models.searched_conversation import SearchedConversation +from pieces_os_client.models.searched_conversation_message import SearchedConversationMessage +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages +from pieces_os_client.models.searched_conversations import SearchedConversations +from pieces_os_client.models.searched_hint import SearchedHint +from pieces_os_client.models.searched_hints import SearchedHints from pieces_os_client.models.searched_match_enum import SearchedMatchEnum +from pieces_os_client.models.searched_person import SearchedPerson +from pieces_os_client.models.searched_persons import SearchedPersons +from pieces_os_client.models.searched_sensitive import SearchedSensitive +from pieces_os_client.models.searched_sensitives import SearchedSensitives +from pieces_os_client.models.searched_tag import SearchedTag +from pieces_os_client.models.searched_tags import SearchedTags +from pieces_os_client.models.searched_website import SearchedWebsite +from pieces_os_client.models.searched_websites import SearchedWebsites +from pieces_os_client.models.searched_workstream_pattern_engine_vision_event import SearchedWorkstreamPatternEngineVisionEvent +from pieces_os_client.models.searched_workstream_pattern_engine_vision_events import SearchedWorkstreamPatternEngineVisionEvents +from pieces_os_client.models.searched_workstream_summaries import SearchedWorkstreamSummaries +from pieces_os_client.models.searched_workstream_summary import SearchedWorkstreamSummary from pieces_os_client.models.seed import Seed from pieces_os_client.models.seeded_accessor import SeededAccessor from pieces_os_client.models.seeded_activity import SeededActivity @@ -457,8 +500,12 @@ from pieces_os_client.models.tag_category_enum import TagCategoryEnum from pieces_os_client.models.tags import Tags from pieces_os_client.models.temporal_range_grounding import TemporalRangeGrounding +from pieces_os_client.models.temporal_search_options import TemporalSearchOptions +from pieces_os_client.models.terminating_os_server_applet import TerminatingOSServerApplet from pieces_os_client.models.text_location import TextLocation from pieces_os_client.models.text_match import TextMatch +from pieces_os_client.models.textually_extracted_material import TextuallyExtractedMaterial +from pieces_os_client.models.textually_extracted_materials import TextuallyExtractedMaterials from pieces_os_client.models.theme import Theme from pieces_os_client.models.tokenized_pkce import TokenizedPKCE from pieces_os_client.models.tracked_application_install import TrackedApplicationInstall @@ -483,18 +530,21 @@ from pieces_os_client.models.tracked_interaction_event import TrackedInteractionEvent from pieces_os_client.models.tracked_keyboard_event import TrackedKeyboardEvent from pieces_os_client.models.tracked_session_event_identifier_description_pairs import TrackedSessionEventIdentifierDescriptionPairs +from pieces_os_client.models.tracked_summary_totals import TrackedSummaryTotals from pieces_os_client.models.tracked_user_profile import TrackedUserProfile from pieces_os_client.models.transferable_bytes import TransferableBytes from pieces_os_client.models.transferable_string import TransferableString -from pieces_os_client.models.unchecked_os_update import UncheckedOSUpdate +from pieces_os_client.models.unchecked_os_server_update import UncheckedOSServerUpdate from pieces_os_client.models.unsegmented_technical_language import UnsegmentedTechnicalLanguage from pieces_os_client.models.updated_external_provider_api_key import UpdatedExternalProviderApiKey from pieces_os_client.models.updating_status_enum import UpdatingStatusEnum from pieces_os_client.models.user_beta_status import UserBetaStatus from pieces_os_client.models.user_profile import UserProfile from pieces_os_client.models.users import Users +from pieces_os_client.models.verified_os_filesystem_path import VerifiedOSFilesystemPath from pieces_os_client.models.website import Website from pieces_os_client.models.websites import Websites +from pieces_os_client.models.window_dimensions import WindowDimensions from pieces_os_client.models.workstream_event import WorkstreamEvent from pieces_os_client.models.workstream_event_context import WorkstreamEventContext from pieces_os_client.models.workstream_event_trigger import WorkstreamEventTrigger @@ -503,8 +553,19 @@ from pieces_os_client.models.workstream_events import WorkstreamEvents from pieces_os_client.models.workstream_ingestion import WorkstreamIngestion from pieces_os_client.models.workstream_pattern_engine_data_cleanup_request import WorkstreamPatternEngineDataCleanupRequest +from pieces_os_client.models.workstream_pattern_engine_source import WorkstreamPatternEngineSource +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources from pieces_os_client.models.workstream_pattern_engine_status import WorkstreamPatternEngineStatus +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration +from pieces_os_client.models.workstream_pattern_engine_vision_calibrations import WorkstreamPatternEngineVisionCalibrations +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent +from pieces_os_client.models.workstream_pattern_engine_vision_event_deletions import WorkstreamPatternEngineVisionEventDeletions +from pieces_os_client.models.workstream_pattern_engine_vision_event_textual_value import WorkstreamPatternEngineVisionEventTextualValue +from pieces_os_client.models.workstream_pattern_engine_vision_events import WorkstreamPatternEngineVisionEvents +from pieces_os_client.models.workstream_pattern_engine_vision_events_metadata import WorkstreamPatternEngineVisionEventsMetadata +from pieces_os_client.models.workstream_pattern_engine_vision_metadata import WorkstreamPatternEngineVisionMetadata from pieces_os_client.models.workstream_pattern_engine_vision_status import WorkstreamPatternEngineVisionStatus +from pieces_os_client.models.workstream_search_options import WorkstreamSearchOptions from pieces_os_client.models.workstream_suggestion import WorkstreamSuggestion from pieces_os_client.models.workstream_suggestion_type import WorkstreamSuggestionType from pieces_os_client.models.workstream_suggestions import WorkstreamSuggestions diff --git a/src/pieces_os_client/models/accessor.py b/src/pieces_os_client/models/accessor.py index 4a96a8d..00bffd1 100644 --- a/src/pieces_os_client/models/accessor.py +++ b/src/pieces_os_client/models/accessor.py @@ -28,11 +28,11 @@ class Accessor(BaseModel): """ This is used to determine who has accessed a share. and how many times. The user here is the user that accessed this Piece.(optional) if undefined then this user was not logged in yet. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) - os: StrictStr = Field(..., description="this is an os id.") + os: StrictStr = Field(default=..., description="this is an os id.") share: StrictStr = Field(...) - count: StrictInt = Field(..., description="how many times this user accessed this piece.") + count: StrictInt = Field(default=..., description="how many times this user accessed this piece.") user: Optional[FlattenedUserProfile] = None __properties = ["schema", "id", "os", "share", "count", "user"] diff --git a/src/pieces_os_client/models/accessors.py b/src/pieces_os_client/models/accessors.py index e20d478..9ec1ec2 100644 --- a/src/pieces_os_client/models/accessors.py +++ b/src/pieces_os_client/models/accessors.py @@ -28,7 +28,7 @@ class Accessors(BaseModel): """ Accessors """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Accessor) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/active_os_server_applet.py b/src/pieces_os_client/models/active_os_server_applet.py new file mode 100644 index 0000000..fce6443 --- /dev/null +++ b/src/pieces_os_client/models/active_os_server_applet.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictInt +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.os_applet_enum import OSAppletEnum + +class ActiveOSServerApplet(BaseModel): + """ + TODO # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + port: StrictInt = Field(...) + type: OSAppletEnum = Field(...) + __properties = ["schema", "port", "type"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> ActiveOSServerApplet: + """Create an instance of ActiveOSServerApplet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> ActiveOSServerApplet: + """Create an instance of ActiveOSServerApplet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return ActiveOSServerApplet.parse_obj(obj) + + _obj = ActiveOSServerApplet.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "port": obj.get("port"), + "type": obj.get("type") + }) + return _obj + + diff --git a/src/pieces_os_client/models/activities.py b/src/pieces_os_client/models/activities.py index 7affcc2..de072f6 100644 --- a/src/pieces_os_client/models/activities.py +++ b/src/pieces_os_client/models/activities.py @@ -28,7 +28,7 @@ class Activities(BaseModel): """ This is the plural of activity # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Activity) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/activity.py b/src/pieces_os_client/models/activity.py index 36128f6..1e87271 100644 --- a/src/pieces_os_client/models/activity.py +++ b/src/pieces_os_client/models/activity.py @@ -32,9 +32,9 @@ class Activity(BaseModel): """ - 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. - # noqa: E501 + # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) @@ -45,7 +45,7 @@ class Activity(BaseModel): user: Optional[FlattenedUserProfile] = None format: Optional[FlattenedFormat] = None mechanism: MechanismEnum = Field(...) - rank: Optional[StrictInt] = Field(None, description="This is the numeric value assigned for this activity event. This number is based off the the type of activity event calcaulated on the server side.DO NOT MODIFY. To see what the value qualilates to, please refer to the function within the common sdk. The number here is based on the fib series. from 0 -> infinity but rn there arnt any value over 8.") + rank: Optional[StrictInt] = Field(default=None, description="This is the numeric value assigned for this activity event. This number is based off the the type of activity event calcaulated on the server side.DO NOT MODIFY. To see what the value qualilates to, please refer to the function within the common sdk. The number here is based on the fib series. from 0 -> infinity but rn there arnt any value over 8.") __properties = ["schema", "id", "created", "updated", "event", "application", "deleted", "asset", "user", "format", "mechanism", "rank"] class Config: diff --git a/src/pieces_os_client/models/aesthetics.py b/src/pieces_os_client/models/aesthetics.py index e1bac58..7e1e1e5 100644 --- a/src/pieces_os_client/models/aesthetics.py +++ b/src/pieces_os_client/models/aesthetics.py @@ -29,7 +29,7 @@ class Aesthetics(BaseModel): """ These are aesthetics properties that will ensure the darkmode + font size and other aesthetics properties persist:) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") theme: Theme = Field(...) font: Font = Field(...) __properties = ["schema", "theme", "font"] diff --git a/src/pieces_os_client/models/allocation_cloud.py b/src/pieces_os_client/models/allocation_cloud.py index 39cfda2..6f1b971 100644 --- a/src/pieces_os_client/models/allocation_cloud.py +++ b/src/pieces_os_client/models/allocation_cloud.py @@ -30,15 +30,15 @@ class AllocationCloud(BaseModel): """ update && version: will be present only if your cloud was successfully spun up && running. updated: is the last time this was updated. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="This is a uuid that represents this cloud.(this is the same as the userid)") - user: StrictStr = Field(..., description="this is your useruuid.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="This is a uuid that represents this cloud.(this is the same as the userid)") + user: StrictStr = Field(default=..., description="this is your useruuid.") urls: AllocationCloudUrls = Field(...) status: AllocationCloudStatus = Field(...) - project: StrictStr = Field(..., description="This is the project that this is attached to.") + project: StrictStr = Field(default=..., description="This is the project that this is attached to.") updated: Optional[GroupedTimestamp] = None - version: Optional[StrictStr] = Field(None, description="this is the current version of the server.") - region: Optional[StrictStr] = Field(None, description="this is the region where the project is defined.") + version: Optional[StrictStr] = Field(default=None, description="this is the current version of the server.") + region: Optional[StrictStr] = Field(default=None, description="this is the region where the project is defined.") __properties = ["schema", "id", "user", "urls", "status", "project", "updated", "version", "region"] class Config: diff --git a/src/pieces_os_client/models/allocation_cloud_status.py b/src/pieces_os_client/models/allocation_cloud_status.py index df7cfa7..533c7ca 100644 --- a/src/pieces_os_client/models/allocation_cloud_status.py +++ b/src/pieces_os_client/models/allocation_cloud_status.py @@ -28,7 +28,7 @@ class AllocationCloudStatus(BaseModel): """ AllocationCloudStatus """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") cloud: AllocationStatusEnum = Field(...) __properties = ["schema", "cloud"] diff --git a/src/pieces_os_client/models/allocation_cloud_url.py b/src/pieces_os_client/models/allocation_cloud_url.py index 992b9ae..8578559 100644 --- a/src/pieces_os_client/models/allocation_cloud_url.py +++ b/src/pieces_os_client/models/allocation_cloud_url.py @@ -28,9 +28,9 @@ class AllocationCloudUrl(BaseModel): """ This is one of the 3 possible urls that will route to your cloud :). # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") status: AllocationStatusEnum = Field(...) - url: StrictStr = Field(..., description="this is the base url that is used to communicat with your vpc.") + url: StrictStr = Field(default=..., description="this is the base url that is used to communicat with your vpc.") __properties = ["schema", "status", "url"] class Config: diff --git a/src/pieces_os_client/models/allocation_cloud_urls.py b/src/pieces_os_client/models/allocation_cloud_urls.py index e63f720..660ac7e 100644 --- a/src/pieces_os_client/models/allocation_cloud_urls.py +++ b/src/pieces_os_client/models/allocation_cloud_urls.py @@ -28,7 +28,7 @@ class AllocationCloudUrls(BaseModel): """ you will have at minimum 2 urls, base: is the default url of your cloud. id: is the branded url, uuid.pieces.cloud. (optional) vanity: is the custom branded url, mark.pieces.cloud # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") base: AllocationCloudUrl = Field(...) id: AllocationCloudUrl = Field(...) vanity: Optional[AllocationCloudUrl] = None diff --git a/src/pieces_os_client/models/allocations.py b/src/pieces_os_client/models/allocations.py index 11682a9..73924d5 100644 --- a/src/pieces_os_client/models/allocations.py +++ b/src/pieces_os_client/models/allocations.py @@ -28,7 +28,7 @@ class Allocations(BaseModel): """ Allocations """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(AllocationCloud) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/analyses.py b/src/pieces_os_client/models/analyses.py index 76ff03c..5e3ae4f 100644 --- a/src/pieces_os_client/models/analyses.py +++ b/src/pieces_os_client/models/analyses.py @@ -28,7 +28,7 @@ class Analyses(BaseModel): """ Analyses """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Analysis) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/analysis.py b/src/pieces_os_client/models/analysis.py index c6a1b72..a075ff5 100644 --- a/src/pieces_os_client/models/analysis.py +++ b/src/pieces_os_client/models/analysis.py @@ -28,10 +28,10 @@ class Analysis(BaseModel): """ This the the MlAnalysis Object, that will go on a format. this will hold all the different analysis models! ** keep format just a uuid for now ** # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code: Optional[CodeAnalysis] = None id: StrictStr = Field(...) - format: StrictStr = Field(..., description="this is a reference to the format that it belongs too.") + format: StrictStr = Field(default=..., description="this is a reference to the format that it belongs too.") image: Optional[ImageAnalysis] = None __properties = ["schema", "code", "id", "format", "image"] diff --git a/src/pieces_os_client/models/analytics_tracked_adoption_event_identifier_description_pairs.py b/src/pieces_os_client/models/analytics_tracked_adoption_event_identifier_description_pairs.py index 0024e26..80f557f 100644 --- a/src/pieces_os_client/models/analytics_tracked_adoption_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/analytics_tracked_adoption_event_identifier_description_pairs.py @@ -27,7 +27,7 @@ class AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs(BaseModel): """ AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") adoption_install: Optional[StrictStr] = None adoption_uninstall: Optional[StrictStr] = None __properties = ["schema", "adoption_install", "adoption_uninstall"] diff --git a/src/pieces_os_client/models/anchor.py b/src/pieces_os_client/models/anchor.py index ca01b60..f41e1d5 100644 --- a/src/pieces_os_client/models/anchor.py +++ b/src/pieces_os_client/models/anchor.py @@ -27,6 +27,7 @@ from pieces_os_client.models.flattened_annotations import FlattenedAnnotations from pieces_os_client.models.flattened_assets import FlattenedAssets from pieces_os_client.models.flattened_conversations import FlattenedConversations +from pieces_os_client.models.flattened_persons import FlattenedPersons from pieces_os_client.models.flattened_workstream_summaries import FlattenedWorkstreamSummaries from pieces_os_client.models.grouped_timestamp import GroupedTimestamp from pieces_os_client.models.score import Score @@ -35,7 +36,7 @@ class Anchor(BaseModel): """ Anchor """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) name: Optional[StrictStr] = None type: AnchorTypeEnum = Field(...) @@ -49,7 +50,8 @@ class Anchor(BaseModel): conversations: Optional[FlattenedConversations] = None score: Optional[Score] = None summaries: Optional[FlattenedWorkstreamSummaries] = None - __properties = ["schema", "id", "name", "type", "watch", "points", "created", "updated", "deleted", "assets", "annotations", "conversations", "score", "summaries"] + persons: Optional[FlattenedPersons] = None + __properties = ["schema", "id", "name", "type", "watch", "points", "created", "updated", "deleted", "assets", "annotations", "conversations", "score", "summaries", "persons"] class Config: """Pydantic configuration""" @@ -105,6 +107,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of summaries if self.summaries: _dict['summaries'] = self.summaries.to_dict() + # override the default output from pydantic by calling `to_dict()` of persons + if self.persons: + _dict['persons'] = self.persons.to_dict() return _dict @classmethod @@ -130,7 +135,8 @@ def from_dict(cls, obj: dict) -> Anchor: "annotations": FlattenedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, "conversations": FlattenedConversations.from_dict(obj.get("conversations")) if obj.get("conversations") is not None else None, "score": Score.from_dict(obj.get("score")) if obj.get("score") is not None else None, - "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None + "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None, + "persons": FlattenedPersons.from_dict(obj.get("persons")) if obj.get("persons") is not None else None }) return _obj diff --git a/src/pieces_os_client/models/anchor_point.py b/src/pieces_os_client/models/anchor_point.py index 56c3656..0eeb687 100644 --- a/src/pieces_os_client/models/anchor_point.py +++ b/src/pieces_os_client/models/anchor_point.py @@ -31,10 +31,10 @@ class AnchorPoint(BaseModel): """ AnchorPoint """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) verified: Optional[StrictBool] = None - fullpath: StrictStr = Field(..., description="This is the text of the path.") + fullpath: StrictStr = Field(default=..., description="This is the text of the path.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None diff --git a/src/pieces_os_client/models/anchor_points.py b/src/pieces_os_client/models/anchor_points.py index e2672f9..ee55b70 100644 --- a/src/pieces_os_client/models/anchor_points.py +++ b/src/pieces_os_client/models/anchor_points.py @@ -29,9 +29,9 @@ class AnchorPoints(BaseModel): """ This is the plural of AnchorPoint. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(AnchorPoint) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an AnchorPoint id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an AnchorPoint id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/anchors.py b/src/pieces_os_client/models/anchors.py index 454ef39..41480a6 100644 --- a/src/pieces_os_client/models/anchors.py +++ b/src/pieces_os_client/models/anchors.py @@ -29,9 +29,9 @@ class Anchors(BaseModel): """ This is the plural of Anchor. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Anchor) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an Anchor id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an Anchor id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/annotation.py b/src/pieces_os_client/models/annotation.py index 0ad1886..c7535a9 100644 --- a/src/pieces_os_client/models/annotation.py +++ b/src/pieces_os_client/models/annotation.py @@ -38,7 +38,7 @@ class Annotation(BaseModel): """ An Annotation is the replacement for descriptions, this will enable comments, description, summaries and many more. person on here is a reference to the description/comment/annotation about a person NOTE: person here is NOT the creator of the annotaion. but rather the descriptions of the person. NOTE****: if we want to add \"who\" wrote the annotation, we will want to add a new field on here called author && will need to also layer in behavior the enable an author(person) and an asset both being referenced(ensure you check the side effect in the AssetsFacade.delete) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) @@ -47,7 +47,7 @@ class Annotation(BaseModel): asset: Optional[ReferencedAsset] = None person: Optional[ReferencedPerson] = None type: AnnotationTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the annotation.") + text: StrictStr = Field(default=..., description="This is the text of the annotation.") model: Optional[ReferencedModel] = None pseudo: Optional[StrictBool] = None favorited: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/annotations.py b/src/pieces_os_client/models/annotations.py index d63e7b2..431c9bd 100644 --- a/src/pieces_os_client/models/annotations.py +++ b/src/pieces_os_client/models/annotations.py @@ -29,9 +29,9 @@ class Annotations(BaseModel): """ This is the plural of Annotation # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Annotation) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an annotation id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an annotation id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/anonymous_temporal_range.py b/src/pieces_os_client/models/anonymous_temporal_range.py index bbad226..d2e8afe 100644 --- a/src/pieces_os_client/models/anonymous_temporal_range.py +++ b/src/pieces_os_client/models/anonymous_temporal_range.py @@ -28,8 +28,8 @@ class AnonymousTemporalRange(BaseModel): """ if you want a range between you can use from && to. if you want anything before, use to and NO from. if you want anything after, use from and NO to. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - var_from: Optional[GroupedTimestamp] = Field(None, alias="from") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + var_from: Optional[GroupedTimestamp] = Field(default=None, alias="from") to: Optional[GroupedTimestamp] = None between: Optional[StrictBool] = None continuous: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/application.py b/src/pieces_os_client/models/application.py index 8182a94..f95f2d9 100644 --- a/src/pieces_os_client/models/application.py +++ b/src/pieces_os_client/models/application.py @@ -32,16 +32,16 @@ class Application(BaseModel): """ A Model to describe what application a format/analytics event originated. mechanism: This will let us know where this came from. ie.only 2 enums are used here or else throw and error. default mechanism here is MANUAL- meaning that this came from our user Connecting an application. INTERNAL - means that this came from a shareable link # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The ID of the application at the device level") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The ID of the application at the device level") name: ApplicationNameEnum = Field(...) - version: StrictStr = Field(..., description="This is the specific version number 0.0.0") + version: StrictStr = Field(default=..., description="This is the specific version number 0.0.0") platform: PlatformEnum = Field(...) onboarded: StrictBool = Field(...) privacy: PrivacyEnum = Field(...) capabilities: Optional[CapabilitiesEnum] = None mechanism: Optional[MechanismEnum] = None - automatic_unload: Optional[StrictBool] = Field(None, alias="automaticUnload", description="This is a proper that will let us know if we will proactivity unload all of your machine learning models.by default this is false.") + automatic_unload: Optional[StrictBool] = Field(default=None, alias="automaticUnload", description="This is a proper that will let us know if we will proactivity unload all of your machine learning models.by default this is false.") __properties = ["schema", "id", "name", "version", "platform", "onboarded", "privacy", "capabilities", "mechanism", "automaticUnload"] class Config: diff --git a/src/pieces_os_client/models/application_name_enum.py b/src/pieces_os_client/models/application_name_enum.py index 557089c..3ab11bf 100644 --- a/src/pieces_os_client/models/application_name_enum.py +++ b/src/pieces_os_client/models/application_name_enum.py @@ -67,6 +67,9 @@ class ApplicationNameEnum(str, Enum): SKETCH = 'SKETCH' ADOBE_ILLUSTRATOR = 'ADOBE_ILLUSTRATOR' NOTEPAD_PLUS_PLUS = 'NOTEPAD_PLUS_PLUS' + EMBEETLE = 'EMBEETLE' + ECLIPSE = 'ECLIPSE' + X_CODE = 'X_CODE' UNKNOWN = 'UNKNOWN' @classmethod diff --git a/src/pieces_os_client/models/applications.py b/src/pieces_os_client/models/applications.py index 5b314cf..d4573f3 100644 --- a/src/pieces_os_client/models/applications.py +++ b/src/pieces_os_client/models/applications.py @@ -28,7 +28,7 @@ class Applications(BaseModel): """ A list of all the applications # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Application) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/asset.py b/src/pieces_os_client/models/asset.py index 590ad11..0be439c 100644 --- a/src/pieces_os_client/models/asset.py +++ b/src/pieces_os_client/models/asset.py @@ -44,8 +44,8 @@ class Asset(BaseModel): """ An Asset Model representing data extracted from an Application connecting a group of data containing one or more Formats. Below formats, preview, and original CAN to be pollinated (DAG Unsafe) because it is a root node and it's child leaf nodes will prevent cycles agressively. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The globally available UID representing the asset in the Database, both locally and in the cloud.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The globally available UID representing the asset in the Database, both locally and in the cloud.") name: Optional[StrictStr] = None creator: StrictStr = Field(...) created: GroupedTimestamp = Field(...) @@ -62,18 +62,18 @@ class Asset(BaseModel): tags: Optional[Tags] = None sensitives: Optional[Sensitives] = None persons: Optional[Persons] = None - curated: Optional[StrictBool] = Field(None, description="This is an optional boolean that will flag that this asset came from a currated collection.") + curated: Optional[StrictBool] = Field(default=None, description="This is an optional boolean that will flag that this asset came from a currated collection.") discovered: Optional[StrictBool] = None activities: Optional[Activities] = None score: Optional[Score] = None favorited: Optional[StrictBool] = None - pseudo: Optional[StrictBool] = Field(None, description="This will determine if this is a asset that the user did not explicitly save.") + pseudo: Optional[StrictBool] = Field(default=None, description="This will determine if this is a asset that the user did not explicitly save.") annotations: Optional[Annotations] = None hints: Optional[Hints] = None anchors: Optional[Anchors] = None conversations: Optional[Conversations] = None summaries: Optional[WorkstreamSummaries] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this asset was generated as a 'demo' snippet") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this asset was generated as a 'demo' snippet") __properties = ["schema", "id", "name", "creator", "created", "updated", "synced", "deleted", "formats", "preview", "original", "shares", "mechanism", "websites", "interacted", "tags", "sensitives", "persons", "curated", "discovered", "activities", "score", "favorited", "pseudo", "annotations", "hints", "anchors", "conversations", "summaries", "demo"] class Config: diff --git a/src/pieces_os_client/models/asset_filter.py b/src/pieces_os_client/models/asset_filter.py index f367aa8..f8b2fe0 100644 --- a/src/pieces_os_client/models/asset_filter.py +++ b/src/pieces_os_client/models/asset_filter.py @@ -30,7 +30,7 @@ class AssetFilter(BaseModel): """ ** in the future, consider adding an optional bool's called nextAnd, nextOr which will say that the next filter will be AND behavor or OR behavior. \"operations\": here is is an optional property to allow or behavior,(we will only allow 1 level deep of or's), if or is not passed in then it is just simply ignored. If or is passed in then we will be or'd together with the top level filter and considered extras. default behavior for operations is and, however yoour can specifiy OR operations as well. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") classification: Optional[ClassificationSpecificEnum] = None tags: Optional[conlist(StrictStr)] = None websites: Optional[conlist(StrictStr)] = None diff --git a/src/pieces_os_client/models/asset_filter_phrase.py b/src/pieces_os_client/models/asset_filter_phrase.py index bedde85..ce27e45 100644 --- a/src/pieces_os_client/models/asset_filter_phrase.py +++ b/src/pieces_os_client/models/asset_filter_phrase.py @@ -28,7 +28,7 @@ class AssetFilterPhrase(BaseModel): """ AssetFilterPhrase """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: Optional[StrictStr] = None annotation: Optional[StrictBool] = None title: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/asset_filter_phrase_options.py b/src/pieces_os_client/models/asset_filter_phrase_options.py index 2104de7..0c12669 100644 --- a/src/pieces_os_client/models/asset_filter_phrase_options.py +++ b/src/pieces_os_client/models/asset_filter_phrase_options.py @@ -28,7 +28,7 @@ class AssetFilterPhraseOptions(BaseModel): """ AssetFilterPhraseOptions """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") annotation: Optional[AnnotationTypeEnum] = None __properties = ["schema", "annotation"] diff --git a/src/pieces_os_client/models/asset_filter_timestamp.py b/src/pieces_os_client/models/asset_filter_timestamp.py index e5907c0..ba77dc9 100644 --- a/src/pieces_os_client/models/asset_filter_timestamp.py +++ b/src/pieces_os_client/models/asset_filter_timestamp.py @@ -28,8 +28,8 @@ class AssetFilterTimestamp(BaseModel): """ if you want a range between you can use from && to. if you want anything before, use to and NO from. if you want anything after, use from and NO to. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - var_from: Optional[GroupedTimestamp] = Field(None, alias="from") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + var_from: Optional[GroupedTimestamp] = Field(default=None, alias="from") to: Optional[GroupedTimestamp] = None between: Optional[StrictBool] = None __properties = ["schema", "from", "to", "between"] diff --git a/src/pieces_os_client/models/asset_filters.py b/src/pieces_os_client/models/asset_filters.py index 177d3ac..255b8e4 100644 --- a/src/pieces_os_client/models/asset_filters.py +++ b/src/pieces_os_client/models/asset_filters.py @@ -28,7 +28,7 @@ class AssetFilters(BaseModel): """ AssetFilters """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(AssetFilter) = Field(...) type: Optional[FilterOperationTypeEnum] = None __properties = ["schema", "iterable", "type"] diff --git a/src/pieces_os_client/models/asset_reclassification.py b/src/pieces_os_client/models/asset_reclassification.py index d63c14e..2740773 100644 --- a/src/pieces_os_client/models/asset_reclassification.py +++ b/src/pieces_os_client/models/asset_reclassification.py @@ -29,7 +29,7 @@ class AssetReclassification(BaseModel): """ This is a model that will represent the miminum properties required to update the classification of this asset. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ext: ClassificationSpecificEnum = Field(...) asset: Asset = Field(...) __properties = ["schema", "ext", "asset"] diff --git a/src/pieces_os_client/models/asset_search_space.py b/src/pieces_os_client/models/asset_search_space.py index 6894e1d..7782037 100644 --- a/src/pieces_os_client/models/asset_search_space.py +++ b/src/pieces_os_client/models/asset_search_space.py @@ -28,7 +28,7 @@ class AssetSearchSpace(BaseModel): """ This is provided search spaces, This is a provided assets, TODO in the future we might want to add seeds. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifers: FlattenedAssets = Field(...) __properties = ["schema", "identifers"] diff --git a/src/pieces_os_client/models/assets.py b/src/pieces_os_client/models/assets.py index a3611cc..5e422f5 100644 --- a/src/pieces_os_client/models/assets.py +++ b/src/pieces_os_client/models/assets.py @@ -29,9 +29,9 @@ class Assets(BaseModel): """ A base class for a collection of assets and some additional meta properties. Fully Populated with Formats internally (not just uuid's). # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Asset) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an asset id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an asset id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/assets_search_with_filters_input.py b/src/pieces_os_client/models/assets_search_with_filters_input.py index c52e136..a1cda5b 100644 --- a/src/pieces_os_client/models/assets_search_with_filters_input.py +++ b/src/pieces_os_client/models/assets_search_with_filters_input.py @@ -29,11 +29,11 @@ class AssetsSearchWithFiltersInput(BaseModel): """ AssetsSearchWithFiltersInput """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") query: Optional[StrictStr] = None space: Optional[AssetSearchSpace] = None filters: Optional[AssetFilters] = None - casing: Optional[StrictBool] = Field(None, description="This is an optional bool that will let us know, if we want to ignore case or not.(default is to allow casing)ie casing:true.") + casing: Optional[StrictBool] = Field(default=None, description="This is an optional bool that will let us know, if we want to ignore case or not.(default is to allow casing)ie casing:true.") __properties = ["schema", "query", "space", "filters", "casing"] class Config: diff --git a/src/pieces_os_client/models/assets_search_with_filters_output.py b/src/pieces_os_client/models/assets_search_with_filters_output.py index 1d6313a..9cf4a4e 100644 --- a/src/pieces_os_client/models/assets_search_with_filters_output.py +++ b/src/pieces_os_client/models/assets_search_with_filters_output.py @@ -28,7 +28,7 @@ class AssetsSearchWithFiltersOutput(BaseModel): """ output for the /assets/search [POST] # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") results: SearchedAssets = Field(...) __properties = ["schema", "results"] diff --git a/src/pieces_os_client/models/auth0.py b/src/pieces_os_client/models/auth0.py index d1c7948..f127804 100644 --- a/src/pieces_os_client/models/auth0.py +++ b/src/pieces_os_client/models/auth0.py @@ -34,12 +34,12 @@ class Auth0(BaseModel): identity: Optional[Auth0Identity] = None user: Optional[Auth0User] = None metadata: Optional[Auth0UserMetadata] = None - domain: StrictStr = Field(..., description="The domain of your Auth 0 Service") - client: StrictStr = Field(..., description="The Client ID for your Auth0 Service") - audience: StrictStr = Field(..., description="The Server Audience of your Auth0 Service") + domain: StrictStr = Field(default=..., description="The domain of your Auth 0 Service") + client: StrictStr = Field(default=..., description="The Client ID for your Auth0 Service") + audience: StrictStr = Field(default=..., description="The Server Audience of your Auth0 Service") redirects: Auth0Redirects = Field(...) - o_auth: OAuthGroup = Field(..., alias="oAuth") - namespace: Optional[StrictStr] = Field(None, description="An optional namespace parameter to add an additional namespace") + o_auth: OAuthGroup = Field(default=..., alias="oAuth") + namespace: Optional[StrictStr] = Field(default=None, description="An optional namespace parameter to add an additional namespace") __properties = ["identity", "user", "metadata", "domain", "client", "audience", "redirects", "oAuth", "namespace"] class Config: diff --git a/src/pieces_os_client/models/auth0_identity.py b/src/pieces_os_client/models/auth0_identity.py index 8323d4c..0183cc1 100644 --- a/src/pieces_os_client/models/auth0_identity.py +++ b/src/pieces_os_client/models/auth0_identity.py @@ -26,10 +26,10 @@ class Auth0Identity(BaseModel): """ Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider, but it will typically include the following. Link: [https://auth0.com/docs/rules/user-object-in-rules] Currently left out: - profile_data: (Object) User information associated with the connection. When profiles are linked, it is populated with the associated user info for secondary accounts. # noqa: E501 """ - connection: Optional[StrictStr] = Field(None, description="Name of the Auth0 connection used to authenticate the user. ") - is_social: Optional[StrictBool] = Field(None, alias="isSocial", description="Indicates whether the connection is a social one. ") - provider: Optional[StrictStr] = Field(None, description="mapped from user_id -> id") - user_id: Optional[StrictStr] = Field(None, description="User's unique identifier for this connection/provider.") + connection: Optional[StrictStr] = Field(default=None, description="Name of the Auth0 connection used to authenticate the user. ") + is_social: Optional[StrictBool] = Field(default=None, alias="isSocial", description="Indicates whether the connection is a social one. ") + provider: Optional[StrictStr] = Field(default=None, description="mapped from user_id -> id") + user_id: Optional[StrictStr] = Field(default=None, description="User's unique identifier for this connection/provider.") access_token: Optional[StrictStr] = None expires_in: Optional[StrictInt] = None __properties = ["connection", "isSocial", "provider", "user_id", "access_token", "expires_in"] diff --git a/src/pieces_os_client/models/auth0_open_ai_user_metadata.py b/src/pieces_os_client/models/auth0_open_ai_user_metadata.py index 9e95aff..7451382 100644 --- a/src/pieces_os_client/models/auth0_open_ai_user_metadata.py +++ b/src/pieces_os_client/models/auth0_open_ai_user_metadata.py @@ -27,7 +27,7 @@ class Auth0OpenAIUserMetadata(BaseModel): """ Only supporting a single api key per user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") api_key: Optional[StrictStr] = None api_key_name: Optional[StrictStr] = None organization_key: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/auth0_redirects.py b/src/pieces_os_client/models/auth0_redirects.py index 3cb92d5..e7ccc76 100644 --- a/src/pieces_os_client/models/auth0_redirects.py +++ b/src/pieces_os_client/models/auth0_redirects.py @@ -26,8 +26,8 @@ class Auth0Redirects(BaseModel): """ The redirect URI for you Auth 0 Service # noqa: E501 """ - authenticated: Optional[StrictStr] = Field(None, description="Where the Auth0 redirects after the user is authorized") - unauthenticated: Optional[StrictStr] = Field(None, description="The redirect where a user returns once unauthenticated") + authenticated: Optional[StrictStr] = Field(default=None, description="Where the Auth0 redirects after the user is authorized") + unauthenticated: Optional[StrictStr] = Field(default=None, description="The redirect where a user returns once unauthenticated") __properties = ["authenticated", "unauthenticated"] class Config: diff --git a/src/pieces_os_client/models/auth0_user.py b/src/pieces_os_client/models/auth0_user.py index 0053f3d..f31254a 100644 --- a/src/pieces_os_client/models/auth0_user.py +++ b/src/pieces_os_client/models/auth0_user.py @@ -28,17 +28,17 @@ class Auth0User(BaseModel): """ # noqa: E501 """ - name: Optional[StrictStr] = Field(None, description=" User's full name.") - picture: Optional[StrictStr] = Field(None, description="mapped from picture.URL pointing to the user's profile picture. ") + name: Optional[StrictStr] = Field(default=None, description=" User's full name.") + picture: Optional[StrictStr] = Field(default=None, description="mapped from picture.URL pointing to the user's profile picture. ") email: Optional[StrictStr] = None created_at: Optional[datetime] = None - email_verified: Optional[StrictBool] = Field(None, description="Indicates whether the user has verified their email address. Mapped from email_verified -> emailVerified.") - family_name: Optional[StrictStr] = Field(None, description="User's family name.") - given_name: Optional[StrictStr] = Field(None, description="User's given name. ") - identities: Optional[conlist(Auth0Identity)] = Field(None, description="Contains info retrieved from the identity provider with which the user originally authenticates.") - nickname: Optional[StrictStr] = Field(None, description="User's nickname. ") + email_verified: Optional[StrictBool] = Field(default=None, description="Indicates whether the user has verified their email address. Mapped from email_verified -> emailVerified.") + family_name: Optional[StrictStr] = Field(default=None, description="User's family name.") + given_name: Optional[StrictStr] = Field(default=None, description="User's given name. ") + identities: Optional[conlist(Auth0Identity)] = Field(default=None, description="Contains info retrieved from the identity provider with which the user originally authenticates.") + nickname: Optional[StrictStr] = Field(default=None, description="User's nickname. ") updated_at: Optional[datetime] = None - username: Optional[StrictStr] = Field(None, description=" (unique) User's username. ") + username: Optional[StrictStr] = Field(default=None, description=" (unique) User's username. ") user_metadata: Optional[Auth0UserMetadata] = None locale: Optional[StrictStr] = None user_id: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/auth0_user_beta_status.py b/src/pieces_os_client/models/auth0_user_beta_status.py index d78651f..3fa4640 100644 --- a/src/pieces_os_client/models/auth0_user_beta_status.py +++ b/src/pieces_os_client/models/auth0_user_beta_status.py @@ -28,7 +28,7 @@ class Auth0UserBetaStatus(BaseModel): """ Note: continuous: this means that from this moment in time, the user is continuously opted into beta otherwise we will use the from/to values provided. Note: in order to opt out of vision, you will just end their beta w/ the updated with a to property that is effectively right now in time. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") vision: Optional[AnonymousTemporalRange] = None __properties = ["schema", "vision"] diff --git a/src/pieces_os_client/models/auth0_user_metadata.py b/src/pieces_os_client/models/auth0_user_metadata.py index 18ad94d..b48d911 100644 --- a/src/pieces_os_client/models/auth0_user_metadata.py +++ b/src/pieces_os_client/models/auth0_user_metadata.py @@ -30,13 +30,13 @@ class Auth0UserMetadata(BaseModel): """ User Metadata from Auth0 # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") global_id: StrictStr = Field(...) cloud_key: Optional[StrictStr] = None - stripe_customer_id: Optional[StrictStr] = Field(None, description="A customer ID that is added to the user in the case of payments") - vanityname: Optional[StrictStr] = Field(None, description="this is the vanityname of the user.(set from their custom CNAME dns record.) ie mark.pieces.cloud where \"mark\" is the vanityname.") + stripe_customer_id: Optional[StrictStr] = Field(default=None, description="A customer ID that is added to the user in the case of payments") + vanityname: Optional[StrictStr] = Field(default=None, description="this is the vanityname of the user.(set from their custom CNAME dns record.) ie mark.pieces.cloud where \"mark\" is the vanityname.") allocation: Optional[Auth0UserAllocationMetadata] = None - open_ai: Optional[Auth0OpenAIUserMetadata] = Field(None, alias="open_AI") + open_ai: Optional[Auth0OpenAIUserMetadata] = Field(default=None, alias="open_AI") beta: Optional[AnonymousTemporalRange] = None __properties = ["schema", "global_id", "cloud_key", "stripe_customer_id", "vanityname", "allocation", "open_AI", "beta"] diff --git a/src/pieces_os_client/models/available_formats.py b/src/pieces_os_client/models/available_formats.py index a80e358..7b1c26c 100644 --- a/src/pieces_os_client/models/available_formats.py +++ b/src/pieces_os_client/models/available_formats.py @@ -28,7 +28,7 @@ class AvailableFormats(BaseModel): """ This is a specific model here used within the SeededAsset that enables us to return all the available formats on a specific seed that was passed as an input within the '/assets/draft' endpoint # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Classification) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/backup.py b/src/pieces_os_client/models/backup.py index 8b3207c..02c04f7 100644 --- a/src/pieces_os_client/models/backup.py +++ b/src/pieces_os_client/models/backup.py @@ -29,7 +29,7 @@ class Backup(BaseModel): """ This is a cloud Backup. This is specific metadata needed inorder to retrieve a Backup. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) version: StrictStr = Field(...) timestamp: StrictStr = Field(...) diff --git a/src/pieces_os_client/models/backup_status.py b/src/pieces_os_client/models/backup_status.py index 103358f..293c235 100644 --- a/src/pieces_os_client/models/backup_status.py +++ b/src/pieces_os_client/models/backup_status.py @@ -29,9 +29,9 @@ class BackupStatus(BaseModel): """ TODO add more description to this. can eventually add a number that display the percent downloaded an so on.(this is called percent 0-100) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: Optional[BackupStatusEnum] = None - percentage: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Optionally if the download is in progress you will receive a download percent(from 0-100).") + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the download is in progress you will receive a download percent(from 0-100).") backup: Backup = Field(...) __properties = ["schema", "value", "percentage", "backup"] diff --git a/src/pieces_os_client/models/backup_streamed_progress.py b/src/pieces_os_client/models/backup_streamed_progress.py index 58d30d5..614a1d0 100644 --- a/src/pieces_os_client/models/backup_streamed_progress.py +++ b/src/pieces_os_client/models/backup_streamed_progress.py @@ -29,9 +29,9 @@ class BackupStreamedProgress(BaseModel): """ This is a specific model to the /backups/create/streamed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") status: Optional[ModelDownloadProgressStatusEnum] = None - percentage: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Optionally if the download is in progress you will recieve a download percent(from 0-100).") + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the download is in progress you will recieve a download percent(from 0-100).") backup: Optional[Backup] = None __properties = ["schema", "status", "percentage", "backup"] diff --git a/src/pieces_os_client/models/backups.py b/src/pieces_os_client/models/backups.py index 706cb89..dec3687 100644 --- a/src/pieces_os_client/models/backups.py +++ b/src/pieces_os_client/models/backups.py @@ -29,9 +29,9 @@ class Backups(BaseModel): """ This is a plural model of many Cloud Backups. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Backup) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an website id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an website id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/browser_selection.py b/src/pieces_os_client/models/browser_selection.py index ced2c62..640b7d7 100644 --- a/src/pieces_os_client/models/browser_selection.py +++ b/src/pieces_os_client/models/browser_selection.py @@ -29,7 +29,7 @@ class BrowserSelection(BaseModel): """ This is a given bit of text/code that is selected in the browser, this can be a copy/paste/selection # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") classification: Classification = Field(...) value: TransferableString = Field(...) __properties = ["schema", "classification", "value"] diff --git a/src/pieces_os_client/models/browser_tab.py b/src/pieces_os_client/models/browser_tab.py index fb13fd1..7d6439a 100644 --- a/src/pieces_os_client/models/browser_tab.py +++ b/src/pieces_os_client/models/browser_tab.py @@ -31,7 +31,7 @@ class BrowserTab(BaseModel): """ a tab can have many values because you might want to pass in a value that represents the code_blocks(snippets) or a md represenet note: please only pass 1 representation, I will clean on POS side tho (txt || md || html) anchor: can be defined in the browser if view a local file website: this is the given url of the tab range: this is the amount of time this user is current on this given tab current: means that this is the current tab that is open contributors: these are all the extracted people from this given tab # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") values: Optional[BrowserTabValues] = None anchor: Optional[SeededAnchor] = None website: Optional[SeededWebsite] = None diff --git a/src/pieces_os_client/models/browser_tab_value.py b/src/pieces_os_client/models/browser_tab_value.py index 1cfeefd..fbe7465 100644 --- a/src/pieces_os_client/models/browser_tab_value.py +++ b/src/pieces_os_client/models/browser_tab_value.py @@ -29,7 +29,7 @@ class BrowserTabValue(BaseModel): """ snippet: these are extracted code blocks selection: here is a copy/paste/selection note: recommended that you pass in the md version of the webpage note: please dont pass in all three html,md,text, just pass in 1. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") html: Optional[TransferableString] = None md: Optional[TransferableString] = None text: Optional[TransferableString] = None diff --git a/src/pieces_os_client/models/browser_tab_values.py b/src/pieces_os_client/models/browser_tab_values.py index 6392ef0..a259575 100644 --- a/src/pieces_os_client/models/browser_tab_values.py +++ b/src/pieces_os_client/models/browser_tab_values.py @@ -28,7 +28,7 @@ class BrowserTabValues(BaseModel): """ Plural model that represent many tabs # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(BrowserTabValue) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/browser_tabs.py b/src/pieces_os_client/models/browser_tabs.py index 3158251..5334507 100644 --- a/src/pieces_os_client/models/browser_tabs.py +++ b/src/pieces_os_client/models/browser_tabs.py @@ -27,7 +27,7 @@ class BrowserTabs(BaseModel): """ This is a plural representation of the BrowserTab # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(BrowserTab) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/byte_descriptor.py b/src/pieces_os_client/models/byte_descriptor.py index 9733f25..5cf715c 100644 --- a/src/pieces_os_client/models/byte_descriptor.py +++ b/src/pieces_os_client/models/byte_descriptor.py @@ -27,7 +27,7 @@ class ByteDescriptor(BaseModel): """ This is a nice microclass to help with managing the size of a File or Fragment in a readable way for UI's # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: StrictInt = Field(...) readable: StrictStr = Field(...) __properties = ["schema", "value", "readable"] diff --git a/src/pieces_os_client/models/challenged_pkce.py b/src/pieces_os_client/models/challenged_pkce.py index 2cb9fe9..ccf2545 100644 --- a/src/pieces_os_client/models/challenged_pkce.py +++ b/src/pieces_os_client/models/challenged_pkce.py @@ -27,12 +27,12 @@ class ChallengedPKCE(BaseModel): """ A model that Generates A PKCE Challenge Object with the needed requirements. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - state: StrictStr = Field(..., description="An opaque value the clients adds to the initial request that Auth0 includes when redirecting the back to the client. This value must be used by the client to prevent CSRF attacks.") - nonce: StrictStr = Field(..., description="A local key that is held as the comparator to state, thus they should be the same.") - challenge: StrictStr = Field(..., description="Generated challenge from the code_verifier.") - method: StrictStr = Field(..., description="Method used to generate the challenge. The PKCE spec defines two methods, S256 and plain, however, Auth0 supports only S256 since the latter is discouraged.") - verifier: StrictStr = Field(..., description="Cryptographically random key that was used to generate the code_challenge passed to /authorize.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + state: StrictStr = Field(default=..., description="An opaque value the clients adds to the initial request that Auth0 includes when redirecting the back to the client. This value must be used by the client to prevent CSRF attacks.") + nonce: StrictStr = Field(default=..., description="A local key that is held as the comparator to state, thus they should be the same.") + challenge: StrictStr = Field(default=..., description="Generated challenge from the code_verifier.") + method: StrictStr = Field(default=..., description="Method used to generate the challenge. The PKCE spec defines two methods, S256 and plain, however, Auth0 supports only S256 since the latter is discouraged.") + verifier: StrictStr = Field(default=..., description="Cryptographically random key that was used to generate the code_challenge passed to /authorize.") __properties = ["schema", "state", "nonce", "challenge", "method", "verifier"] @validator('method') diff --git a/src/pieces_os_client/models/checked_os_update.py b/src/pieces_os_client/models/checked_os_update.py index 3dc2fce..54a8ced 100644 --- a/src/pieces_os_client/models/checked_os_update.py +++ b/src/pieces_os_client/models/checked_os_update.py @@ -18,61 +18,90 @@ import re # noqa: F401 import json - -from typing import Optional -from pydantic import BaseModel, Field +from pydantic import BaseModel, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Optional, Union from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.grouped_timestamp import GroupedTimestamp from pieces_os_client.models.updating_status_enum import UpdatingStatusEnum +from typing import Optional, Set +from typing_extensions import Self class CheckedOSUpdate(BaseModel): """ - This is the returnable for /os/update/check # noqa: E501 - """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - status: UpdatingStatusEnum = Field(...) - __properties = ["schema", "status"] + This is the model for the progress of the current update of Pieces os. /os/update/check/stream && /os/update/check/ we will emit on a progress update updated: is an optional property that will let us know when the update was checked last. NOTE: it is reccommended to use the stream instead of pulling. NOTE: lets think about if we want to have a closing(as well as how we want to handle restarts) + """ # noqa: E501 + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + status: UpdatingStatusEnum + updated: Optional[GroupedTimestamp] = None + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the update is in progress you will recieve a download percent(from 0-100).") + __properties: ClassVar[List[str]] = ["schema", "status", "updated", "percentage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CheckedOSUpdate: + def from_json(cls, json_str: str) -> Optional[Self]: """Create an instance of CheckedOSUpdate from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of var_schema if self.var_schema: _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of updated + if self.updated: + _dict['updated'] = self.updated.to_dict() + # set to None if percentage (nullable) is None + # and model_fields_set contains the field + if self.percentage is None and "percentage" in self.model_fields_set: + _dict['percentage'] = None + return _dict @classmethod - def from_dict(cls, obj: dict) -> CheckedOSUpdate: + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: """Create an instance of CheckedOSUpdate from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CheckedOSUpdate.parse_obj(obj) + return cls.model_validate(obj) - _obj = CheckedOSUpdate.parse_obj({ - "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, - "status": obj.get("status") + _obj = cls.model_validate({ + "schema": EmbeddedModelSchema.from_dict(obj["schema"]) if obj.get("schema") is not None else None, + "status": obj.get("status"), + "updated": GroupedTimestamp.from_dict(obj["updated"]) if obj.get("updated") is not None else None, + "percentage": obj.get("percentage") }) return _obj diff --git a/src/pieces_os_client/models/classification.py b/src/pieces_os_client/models/classification.py index 26271d1..0bbc894 100644 --- a/src/pieces_os_client/models/classification.py +++ b/src/pieces_os_client/models/classification.py @@ -30,7 +30,7 @@ class Classification(BaseModel): """ This is the specific classification of an Asset's Format.(This is on a per format basis b/c an asset could have different formats that are different format representations of the Asset.) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") generic: ClassificationGenericEnum = Field(...) specific: ClassificationSpecificEnum = Field(...) rendering: Optional[ClassificationRenderingEnum] = None diff --git a/src/pieces_os_client/models/classification_specific_enum.py b/src/pieces_os_client/models/classification_specific_enum.py index 7f4a5ca..9b550b2 100644 --- a/src/pieces_os_client/models/classification_specific_enum.py +++ b/src/pieces_os_client/models/classification_specific_enum.py @@ -530,6 +530,8 @@ class ClassificationSpecificEnum(str, Enum): FEATURE = 'feature' INI = 'ini' FTL = 'ftl' + HCL = 'hcl' + ABAP = 'abap' @classmethod def from_json(cls, json_str: str) -> ClassificationSpecificEnum: diff --git a/src/pieces_os_client/models/classifications.py b/src/pieces_os_client/models/classifications.py index c32f36f..96e78ea 100644 --- a/src/pieces_os_client/models/classifications.py +++ b/src/pieces_os_client/models/classifications.py @@ -28,7 +28,7 @@ class Classifications(BaseModel): """ This is a plural representation of a Classification # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Classification) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/code_analyses.py b/src/pieces_os_client/models/code_analyses.py index 05ae86a..75240d1 100644 --- a/src/pieces_os_client/models/code_analyses.py +++ b/src/pieces_os_client/models/code_analyses.py @@ -28,7 +28,7 @@ class CodeAnalyses(BaseModel): """ CodeAnalyses """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(CodeAnalysis) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/code_analysis.py b/src/pieces_os_client/models/code_analysis.py index b10bf8c..33ed700 100644 --- a/src/pieces_os_client/models/code_analysis.py +++ b/src/pieces_os_client/models/code_analysis.py @@ -29,16 +29,16 @@ class CodeAnalysis(BaseModel): """ This is the ML Analysis object Specific to code. prediction and similarity are custom types. ** please dont not modify ** # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") tokenized: Optional[conlist(StrictStr)] = None language: Optional[StrictStr] = None type: ClassificationGenericEnum = Field(...) prediction: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = None similarity: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = None - top5_colors: Optional[conlist(StrictInt)] = Field(None, alias="top5Colors") - top5_sorted: Optional[conlist(StrictStr)] = Field(None, alias="top5Sorted") + top5_colors: Optional[conlist(StrictInt)] = Field(default=None, alias="top5Colors") + top5_sorted: Optional[conlist(StrictStr)] = Field(default=None, alias="top5Sorted") id: StrictStr = Field(...) - analysis: StrictStr = Field(..., description="this is just a reference to the analysis parent object.") + analysis: StrictStr = Field(default=..., description="this is just a reference to the analysis parent object.") model: Model = Field(...) __properties = ["schema", "tokenized", "language", "type", "prediction", "similarity", "top5Colors", "top5Sorted", "id", "analysis", "model"] diff --git a/src/pieces_os_client/models/context.py b/src/pieces_os_client/models/context.py index a061848..4a7c13b 100644 --- a/src/pieces_os_client/models/context.py +++ b/src/pieces_os_client/models/context.py @@ -30,8 +30,8 @@ class Context(BaseModel): """ A Context that is returned from almost all calls to the ContextAPI # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - os: StrictStr = Field(..., description="This is th UUID of the OS that this context is currently connected to. This attempts to be the same as Segment's anonmyousId feild. It is attempted to be set at initial installation at Pieces/.identity/.os") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + os: StrictStr = Field(default=..., description="This is th UUID of the OS that this context is currently connected to. This attempts to be the same as Segment's anonmyousId feild. It is attempted to be set at initial installation at Pieces/.identity/.os") application: Application = Field(...) health: Health = Field(...) user: Optional[UserProfile] = None diff --git a/src/pieces_os_client/models/conversation.py b/src/pieces_os_client/models/conversation.py index fd3fb32..5ea2560 100644 --- a/src/pieces_os_client/models/conversation.py +++ b/src/pieces_os_client/models/conversation.py @@ -40,9 +40,9 @@ class Conversation(BaseModel): """ This is a fully referenced Conversation. This will hold together a conversation. Ie allthe message within a conversation. All the additional properties on here used on here like(anchors/assets) are used for context that will seed the conversation. model is a calculated property, and will be the model of the last message sent if applicable. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) - name: Optional[StrictStr] = Field(None, description="This is a name that is customized.") + name: Optional[StrictStr] = Field(default=None, description="This is a name that is customized.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None @@ -58,7 +58,7 @@ class Conversation(BaseModel): grounding: Optional[ConversationGrounding] = None score: Optional[Score] = None pipeline: Optional[QGPTPromptPipeline] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this conversation was generated as a 'demo' conversation") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this conversation was generated as a 'demo' conversation") summaries: Optional[FlattenedWorkstreamSummaries] = None __properties = ["schema", "id", "name", "created", "updated", "deleted", "favorited", "application", "annotations", "messages", "model", "assets", "websites", "anchors", "type", "grounding", "score", "pipeline", "demo", "summaries"] diff --git a/src/pieces_os_client/models/conversation_grounding.py b/src/pieces_os_client/models/conversation_grounding.py index 1e9928a..3398786 100644 --- a/src/pieces_os_client/models/conversation_grounding.py +++ b/src/pieces_os_client/models/conversation_grounding.py @@ -27,7 +27,7 @@ class ConversationGrounding(BaseModel): """ This is the context used for grounding the ml models with reguard to a conversation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") messages: Optional[FlattenedConversationMessages] = None temporal: Optional[TemporalRangeGrounding] = None __properties = ["schema", "messages", "temporal"] diff --git a/src/pieces_os_client/models/conversation_message.py b/src/pieces_os_client/models/conversation_message.py index e6ecb15..df3f147 100644 --- a/src/pieces_os_client/models/conversation_message.py +++ b/src/pieces_os_client/models/conversation_message.py @@ -35,7 +35,7 @@ class ConversationMessage(BaseModel): """ This is a fully referenced ConversationMessage. This has the minimum amount of properties to keep this light weight (will consider additional properties in the future like people/tags/links xyz) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/conversation_messages.py b/src/pieces_os_client/models/conversation_messages.py index d5bb6a2..b90171d 100644 --- a/src/pieces_os_client/models/conversation_messages.py +++ b/src/pieces_os_client/models/conversation_messages.py @@ -29,9 +29,9 @@ class ConversationMessages(BaseModel): """ This is a plural version of ConversationMessage. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ConversationMessage) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an ConversationMessage id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an ConversationMessage id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/conversation_summarize_input.py b/src/pieces_os_client/models/conversation_summarize_input.py index 9fcbc1c..d5865fa 100644 --- a/src/pieces_os_client/models/conversation_summarize_input.py +++ b/src/pieces_os_client/models/conversation_summarize_input.py @@ -28,7 +28,7 @@ class ConversationSummarizeInput(BaseModel): """ Optionally you may pass in a list of conversation message that you would like to use for the summary. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") messages: Optional[FlattenedConversationMessages] = None __properties = ["schema", "messages"] diff --git a/src/pieces_os_client/models/conversation_summarize_output.py b/src/pieces_os_client/models/conversation_summarize_output.py index 84aa237..68a01c6 100644 --- a/src/pieces_os_client/models/conversation_summarize_output.py +++ b/src/pieces_os_client/models/conversation_summarize_output.py @@ -29,7 +29,7 @@ class ConversationSummarizeOutput(BaseModel): """ This is the output model for \"/conversation/{conversation}/summarize # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") conversation: ReferencedConversation = Field(...) annotation: ReferencedAnnotation = Field(...) __properties = ["schema", "conversation", "annotation"] diff --git a/src/pieces_os_client/models/conversations.py b/src/pieces_os_client/models/conversations.py index fed9216..529eb8d 100644 --- a/src/pieces_os_client/models/conversations.py +++ b/src/pieces_os_client/models/conversations.py @@ -29,9 +29,9 @@ class Conversations(BaseModel): """ This is a plural version of a Conversation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Conversation) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an Conversation id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an Conversation id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/conversations_create_from_asset_output.py b/src/pieces_os_client/models/conversations_create_from_asset_output.py index d1af110..7dd5eee 100644 --- a/src/pieces_os_client/models/conversations_create_from_asset_output.py +++ b/src/pieces_os_client/models/conversations_create_from_asset_output.py @@ -28,7 +28,7 @@ class ConversationsCreateFromAssetOutput(BaseModel): """ This is the model for the output for the \"/conversations/create/from_asset/{asset}\" endpoints. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") conversation: ReferencedConversation = Field(...) __properties = ["schema", "conversation"] diff --git a/src/pieces_os_client/models/created_external_provider_api_key.py b/src/pieces_os_client/models/created_external_provider_api_key.py index 6ca7a54..95f775c 100644 --- a/src/pieces_os_client/models/created_external_provider_api_key.py +++ b/src/pieces_os_client/models/created_external_provider_api_key.py @@ -28,7 +28,7 @@ class CreatedExternalProviderApiKey(BaseModel): """ This is the outputmodel for /external_provider/api_key/create # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") metadata: Auth0UserMetadata = Field(...) __properties = ["schema", "metadata"] diff --git a/src/pieces_os_client/models/deleted_external_provider_api_key.py b/src/pieces_os_client/models/deleted_external_provider_api_key.py index d37f9ed..0a1b5fa 100644 --- a/src/pieces_os_client/models/deleted_external_provider_api_key.py +++ b/src/pieces_os_client/models/deleted_external_provider_api_key.py @@ -28,7 +28,7 @@ class DeletedExternalProviderApiKey(BaseModel): """ This is the returnable for the \"\"/external_provider/api_key/delete\" endpoint # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") metadata: Auth0UserMetadata = Field(...) __properties = ["schema", "metadata"] diff --git a/src/pieces_os_client/models/detected_external_application.py b/src/pieces_os_client/models/detected_external_application.py index 421fd18..d9b30dc 100644 --- a/src/pieces_os_client/models/detected_external_application.py +++ b/src/pieces_os_client/models/detected_external_application.py @@ -27,8 +27,8 @@ class DetectedExternalApplication(BaseModel): """ This is a detected External Application that comes from our endpoint that will get a snapshot of the installed applications on your machine. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - name: StrictStr = Field(..., description="this is the name of the application") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: StrictStr = Field(default=..., description="this is the name of the application") version: Optional[StrictStr] = None __properties = ["schema", "name", "version"] diff --git a/src/pieces_os_client/models/detected_external_applications.py b/src/pieces_os_client/models/detected_external_applications.py index 0398c94..fde0f5d 100644 --- a/src/pieces_os_client/models/detected_external_applications.py +++ b/src/pieces_os_client/models/detected_external_applications.py @@ -28,7 +28,7 @@ class DetectedExternalApplications(BaseModel): """ This is used as the returnable for the /applications/external && /applications/external/related endpoints. This will return an iterable of Deteched Application a detected Application is an application that is currently installed on your machine. the /applications/external/related endpoint, will return a subset of the applications returned mainly applications that we detect are Pieces Applications that you have yet to install + names of applications where Pieces is coming soon. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(DetectedExternalApplication) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/discovered_asset.py b/src/pieces_os_client/models/discovered_asset.py index 6453349..127e729 100644 --- a/src/pieces_os_client/models/discovered_asset.py +++ b/src/pieces_os_client/models/discovered_asset.py @@ -31,7 +31,7 @@ class DiscoveredAsset(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") file: Optional[SeededFile] = None fragment: Optional[SeededFragment] = None directory: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/discovered_assets.py b/src/pieces_os_client/models/discovered_assets.py index 8b9eb61..20ba884 100644 --- a/src/pieces_os_client/models/discovered_assets.py +++ b/src/pieces_os_client/models/discovered_assets.py @@ -28,9 +28,9 @@ class DiscoveredAssets(BaseModel): """ This is a plural Model that is used within the bulk upload flow in both cases of a file(&& needing snippitization) as well as if the fragments are passed in and they only need to be clustered. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - application: StrictStr = Field(..., description="application id.") - iterable: conlist(DiscoveredAsset) = Field(..., description="This is an iterable of already snippitized snippets that have been clustered.(These are assets that are going to be uploaded or at minimum the assets that we reccommend to upload)") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + application: StrictStr = Field(default=..., description="application id.") + iterable: conlist(DiscoveredAsset) = Field(default=..., description="This is an iterable of already snippitized snippets that have been clustered.(These are assets that are going to be uploaded or at minimum the assets that we reccommend to upload)") __properties = ["schema", "application", "iterable"] class Config: diff --git a/src/pieces_os_client/models/discovered_html_webpage.py b/src/pieces_os_client/models/discovered_html_webpage.py index 88f8b95..1f413e9 100644 --- a/src/pieces_os_client/models/discovered_html_webpage.py +++ b/src/pieces_os_client/models/discovered_html_webpage.py @@ -28,7 +28,7 @@ class DiscoveredHtmlWebpage(BaseModel): """ This will return assets that were extracted from the html webpage. This will contain the original url so you can double check the results wtih the results you passed in, but it will remain in the same order that it was passed in if used within the /discover/discover/html/webpage endpoint. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") assets: DiscoveredAssets = Field(...) url: StrictStr = Field(...) __properties = ["schema", "assets", "url"] diff --git a/src/pieces_os_client/models/discovered_html_webpages.py b/src/pieces_os_client/models/discovered_html_webpages.py index 6328c50..41ce967 100644 --- a/src/pieces_os_client/models/discovered_html_webpages.py +++ b/src/pieces_os_client/models/discovered_html_webpages.py @@ -28,7 +28,7 @@ class DiscoveredHtmlWebpages(BaseModel): """ Assumption: The iterable will be in the exact same order as it was passed in within the seededDiscoveredHtmlWebpages # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(DiscoveredHtmlWebpage) = Field(...) application: StrictStr = Field(...) __properties = ["schema", "iterable", "application"] diff --git a/src/pieces_os_client/models/discovered_related_tag.py b/src/pieces_os_client/models/discovered_related_tag.py index 3308328..1507a23 100644 --- a/src/pieces_os_client/models/discovered_related_tag.py +++ b/src/pieces_os_client/models/discovered_related_tag.py @@ -28,7 +28,7 @@ class DiscoveredRelatedTag(BaseModel): """ DiscoveredRelatedTag """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seed: SeededTag = Field(...) __properties = ["schema", "seed"] diff --git a/src/pieces_os_client/models/discovered_related_tags.py b/src/pieces_os_client/models/discovered_related_tags.py index 2ef8680..e38efc3 100644 --- a/src/pieces_os_client/models/discovered_related_tags.py +++ b/src/pieces_os_client/models/discovered_related_tags.py @@ -28,7 +28,7 @@ class DiscoveredRelatedTags(BaseModel): """ DiscoveredRelatedTags """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") application: StrictStr = Field(...) iterable: conlist(DiscoveredRelatedTag) = Field(...) __properties = ["schema", "application", "iterable"] diff --git a/src/pieces_os_client/models/discovered_sensitive.py b/src/pieces_os_client/models/discovered_sensitive.py index 4536014..0f0e0a8 100644 --- a/src/pieces_os_client/models/discovered_sensitive.py +++ b/src/pieces_os_client/models/discovered_sensitive.py @@ -28,7 +28,7 @@ class DiscoveredSensitive(BaseModel): """ This will return a discoveredSensitive, with a seed that can be used to create if automatic is set to false. and will provide the original text provided. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seed: SeededSensitive = Field(...) text: StrictStr = Field(...) __properties = ["schema", "seed", "text"] diff --git a/src/pieces_os_client/models/discovered_sensitives.py b/src/pieces_os_client/models/discovered_sensitives.py index adaad4e..4b93f8a 100644 --- a/src/pieces_os_client/models/discovered_sensitives.py +++ b/src/pieces_os_client/models/discovered_sensitives.py @@ -28,7 +28,7 @@ class DiscoveredSensitives(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(DiscoveredSensitive) = Field(...) application: StrictStr = Field(...) __properties = ["schema", "iterable", "application"] diff --git a/src/pieces_os_client/models/distribution.py b/src/pieces_os_client/models/distribution.py index 0d42925..09ece3d 100644 --- a/src/pieces_os_client/models/distribution.py +++ b/src/pieces_os_client/models/distribution.py @@ -31,7 +31,7 @@ class Distribution(BaseModel): """ This is a fully referenced version of a Distribution. TODO add additional distributions such as slack, google_chat, ...etc # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) share: FlattenedShare = Field(...) created: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/distributions.py b/src/pieces_os_client/models/distributions.py index 82a5686..b7ca659 100644 --- a/src/pieces_os_client/models/distributions.py +++ b/src/pieces_os_client/models/distributions.py @@ -29,7 +29,7 @@ class Distributions(BaseModel): This is the plural Model of a Distribution. # noqa: E501 """ iterable: conlist(Distribution) = Field(...) - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["iterable", "schema"] class Config: diff --git a/src/pieces_os_client/models/document_contributor.py b/src/pieces_os_client/models/document_contributor.py index 639b28e..0e6f5c8 100644 --- a/src/pieces_os_client/models/document_contributor.py +++ b/src/pieces_os_client/models/document_contributor.py @@ -31,7 +31,7 @@ class DocumentContributor(BaseModel): """ A DocumentContributor is a preseeded representation of a Person This can be used in the case of the browser, or in the IDE If they are apart of an IDE, we can in the future provide git information (IE add a Git object for their commits) person: this is most important part which is the email/name xyz # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") classification: Optional[Classification] = None value: Optional[TransferableString] = None person: PersonBasicType = Field(...) diff --git a/src/pieces_os_client/models/document_contributors.py b/src/pieces_os_client/models/document_contributors.py index bf00ffb..6d6f5d4 100644 --- a/src/pieces_os_client/models/document_contributors.py +++ b/src/pieces_os_client/models/document_contributors.py @@ -28,7 +28,7 @@ class DocumentContributors(BaseModel): """ This is a plural representation of the DocumentContributor # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(DocumentContributor) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/embedded_model_schema.py b/src/pieces_os_client/models/embedded_model_schema.py index bda751b..3674f2e 100644 --- a/src/pieces_os_client/models/embedded_model_schema.py +++ b/src/pieces_os_client/models/embedded_model_schema.py @@ -27,7 +27,7 @@ class EmbeddedModelSchema(BaseModel): """ This is a model that will keep track of all of our version related to our models. ie (1) the database migration and (2) the global semantic version of the api. # noqa: E501 """ - migration: StrictInt = Field(..., description="this is the current database version that this model was used for.") + migration: StrictInt = Field(default=..., description="this is the current database version that this model was used for.") semantic: EmbeddedModelSchemaSemanticVersionEnum = Field(...) __properties = ["migration", "semantic"] diff --git a/src/pieces_os_client/models/embedding.py b/src/pieces_os_client/models/embedding.py index 2e97727..9cc0f6b 100644 --- a/src/pieces_os_client/models/embedding.py +++ b/src/pieces_os_client/models/embedding.py @@ -28,7 +28,7 @@ class Embedding(BaseModel): """ # noqa: E501 """ - raw: conlist(Union[StrictFloat, StrictInt]) = Field(..., description="this is the raw value of the embedding") + raw: conlist(Union[StrictFloat, StrictInt]) = Field(default=..., description="this is the raw value of the embedding") model: Model = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/embeddings_search_options.py b/src/pieces_os_client/models/embeddings_search_options.py new file mode 100644 index 0000000..bd2f11c --- /dev/null +++ b/src/pieces_os_client/models/embeddings_search_options.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictFloat, StrictInt +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.embeddings_search_options_embedding_type_enum import EmbeddingsSearchOptionsEmbeddingTypeEnum + +class EmbeddingsSearchOptions(BaseModel): + """ + similarity: this is optional from 0 - 1, (where 1 is exact and 0 is everything) TODO consider a plural of types for running many embedding search scopes # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + type: EmbeddingsSearchOptionsEmbeddingTypeEnum = Field(...) + similarity: Optional[Union[StrictFloat, StrictInt]] = None + __properties = ["schema", "type", "similarity"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> EmbeddingsSearchOptions: + """Create an instance of EmbeddingsSearchOptions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> EmbeddingsSearchOptions: + """Create an instance of EmbeddingsSearchOptions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return EmbeddingsSearchOptions.parse_obj(obj) + + _obj = EmbeddingsSearchOptions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "type": obj.get("type"), + "similarity": obj.get("similarity") + }) + return _obj + + diff --git a/src/pieces_os_client/models/embeddings_search_options_embedding_type_enum.py b/src/pieces_os_client/models/embeddings_search_options_embedding_type_enum.py new file mode 100644 index 0000000..4bed8e1 --- /dev/null +++ b/src/pieces_os_client/models/embeddings_search_options_embedding_type_enum.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import json +import pprint +import re # noqa: F401 +from aenum import Enum, no_arg + + + + + +class EmbeddingsSearchOptionsEmbeddingTypeEnum(str, Enum): + """ + TODO + """ + + """ + allowed enum values + """ + JINA = 'JINA' + NCS = 'NCS' + + @classmethod + def from_json(cls, json_str: str) -> EmbeddingsSearchOptionsEmbeddingTypeEnum: + """Create an instance of EmbeddingsSearchOptionsEmbeddingTypeEnum from a JSON string""" + return EmbeddingsSearchOptionsEmbeddingTypeEnum(json.loads(json_str)) + + diff --git a/src/pieces_os_client/models/existent_metadata.py b/src/pieces_os_client/models/existent_metadata.py index 2f244ad..4e0e641 100644 --- a/src/pieces_os_client/models/existent_metadata.py +++ b/src/pieces_os_client/models/existent_metadata.py @@ -27,7 +27,7 @@ class ExistentMetadata(BaseModel): """ This is a shared output model for all the exists endpoints: /tags/exists : value here is the tag that you want to see if it exists. /websites/exists: value here is the url you want to see if it exists # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: StrictStr = Field(...) __properties = ["schema", "value"] diff --git a/src/pieces_os_client/models/existing_metadata.py b/src/pieces_os_client/models/existing_metadata.py index 15092a6..6de9040 100644 --- a/src/pieces_os_client/models/existing_metadata.py +++ b/src/pieces_os_client/models/existing_metadata.py @@ -29,7 +29,7 @@ class ExistingMetadata(BaseModel): """ This is a shared input model for all the exists endpoints: /tags/exists : if the tag exists you will have a defined tag:ReferencedTag, if not then it doesnt exist. /websites/exists: if the url exists you will have a defined website:ReferencedWebsite, if not then it doesnt exist. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") website: Optional[ReferencedWebsite] = None tag: Optional[ReferencedTag] = None __properties = ["schema", "website", "tag"] diff --git a/src/pieces_os_client/models/exported_asset.py b/src/pieces_os_client/models/exported_asset.py index 63f8fd9..fd4d35a 100644 --- a/src/pieces_os_client/models/exported_asset.py +++ b/src/pieces_os_client/models/exported_asset.py @@ -28,8 +28,8 @@ class ExportedAsset(BaseModel): """ This is a model for a minimum exported version of an asset. # noqa: E501 """ - name: StrictStr = Field(..., description="this is the title of the asset ") - description: StrictStr = Field(..., description="this is the description of the asset") + name: StrictStr = Field(default=..., description="this is the title of the asset ") + description: StrictStr = Field(default=..., description="this is the description of the asset") created: GroupedTimestamp = Field(...) raw: FileFormat = Field(...) __properties = ["name", "description", "created", "raw"] diff --git a/src/pieces_os_client/models/exported_database.py b/src/pieces_os_client/models/exported_database.py index a9e27e5..b9a6309 100644 --- a/src/pieces_os_client/models/exported_database.py +++ b/src/pieces_os_client/models/exported_database.py @@ -31,34 +31,34 @@ class ExportedDatabase(BaseModel): analyses: conlist(StrictInt) = Field(...) applications: conlist(StrictInt) = Field(...) assets: conlist(StrictInt) = Field(...) - code_analyses: conlist(StrictInt) = Field(..., alias="codeAnalyses") + code_analyses: conlist(StrictInt) = Field(default=..., alias="codeAnalyses") files: conlist(StrictInt) = Field(...) - format_metrics: conlist(StrictInt) = Field(..., alias="formatMetrics") + format_metrics: conlist(StrictInt) = Field(default=..., alias="formatMetrics") formats: conlist(StrictInt) = Field(...) fragments: conlist(StrictInt) = Field(...) - image_analyses: conlist(StrictInt) = Field(..., alias="imageAnalyses") + image_analyses: conlist(StrictInt) = Field(default=..., alias="imageAnalyses") models: conlist(StrictInt) = Field(...) - ocr_analyses: conlist(StrictInt) = Field(..., alias="ocrAnalyses") + ocr_analyses: conlist(StrictInt) = Field(default=..., alias="ocrAnalyses") persons: conlist(StrictInt) = Field(...) sensitives: conlist(StrictInt) = Field(...) tags: conlist(StrictInt) = Field(...) websites: conlist(StrictInt) = Field(...) values: ExportedDatabaseFormats = Field(...) - version: StrictStr = Field(..., description="This is the version of your os_server or cloud_server that we we exporting from.") - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + version: StrictStr = Field(default=..., description="This is the version of your os_server or cloud_server that we we exporting from.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") relationships: Optional[conlist(StrictInt)] = None activities: Optional[conlist(StrictInt)] = None annotations: Optional[conlist(StrictInt)] = None hints: Optional[conlist(StrictInt)] = None anchors: Optional[conlist(StrictInt)] = None - anchor_points: Optional[conlist(StrictInt)] = Field(None, alias="anchorPoints") + anchor_points: Optional[conlist(StrictInt)] = Field(default=None, alias="anchorPoints") conversations: Optional[conlist(StrictInt)] = None - conversation_messages: Optional[conlist(StrictInt)] = Field(None, alias="conversationMessages") - workstream_events: Optional[conlist(StrictInt)] = Field(None, alias="workstreamEvents") + conversation_messages: Optional[conlist(StrictInt)] = Field(default=None, alias="conversationMessages") + workstream_events: Optional[conlist(StrictInt)] = Field(default=None, alias="workstreamEvents") ranges: Optional[conlist(StrictInt)] = None - workstream_summaries: Optional[conlist(StrictInt)] = Field(None, alias="workstreamSummaries") - message_values: Optional[ExportedDatabaseFormats] = Field(None, alias="messageValues") - workstream_event_values: Optional[ExportedDatabaseFormats] = Field(None, alias="workstreamEventValues") + workstream_summaries: Optional[conlist(StrictInt)] = Field(default=None, alias="workstreamSummaries") + message_values: Optional[ExportedDatabaseFormats] = Field(default=None, alias="messageValues") + workstream_event_values: Optional[ExportedDatabaseFormats] = Field(default=None, alias="workstreamEventValues") __properties = ["analyses", "applications", "assets", "codeAnalyses", "files", "formatMetrics", "formats", "fragments", "imageAnalyses", "models", "ocrAnalyses", "persons", "sensitives", "tags", "websites", "values", "version", "schema", "relationships", "activities", "annotations", "hints", "anchors", "anchorPoints", "conversations", "conversationMessages", "workstreamEvents", "ranges", "workstreamSummaries", "messageValues", "workstreamEventValues"] class Config: diff --git a/src/pieces_os_client/models/exported_database_format.py b/src/pieces_os_client/models/exported_database_format.py index 75c80e3..fb2dd84 100644 --- a/src/pieces_os_client/models/exported_database_format.py +++ b/src/pieces_os_client/models/exported_database_format.py @@ -27,9 +27,9 @@ class ExportedDatabaseFormat(BaseModel): """ ExportedDatabaseFormat """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="this is the id of the format") - raw: conlist(StrictInt) = Field(..., description="these are bytes.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="this is the id of the format") + raw: conlist(StrictInt) = Field(default=..., description="these are bytes.") __properties = ["schema", "id", "raw"] class Config: diff --git a/src/pieces_os_client/models/exported_database_formats.py b/src/pieces_os_client/models/exported_database_formats.py index 7aaac39..33e2a4f 100644 --- a/src/pieces_os_client/models/exported_database_formats.py +++ b/src/pieces_os_client/models/exported_database_formats.py @@ -28,7 +28,7 @@ class ExportedDatabaseFormats(BaseModel): """ ExportedDatabaseFormats """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ExportedDatabaseFormat) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/external_ml_provider_enum.py b/src/pieces_os_client/models/external_ml_provider_enum.py index 51f13e3..7c75875 100644 --- a/src/pieces_os_client/models/external_ml_provider_enum.py +++ b/src/pieces_os_client/models/external_ml_provider_enum.py @@ -53,6 +53,9 @@ class ExternalMLProviderEnum(str, Enum): BIGCODE = 'BIGCODE' JINA = 'JINA' PIECES = 'PIECES' + ANTHROPIC = 'ANTHROPIC' + IBM = 'IBM' + SNOWFLAKE = 'SNOWFLAKE' @classmethod def from_json(cls, json_str: str) -> ExternalMLProviderEnum: diff --git a/src/pieces_os_client/models/external_provider.py b/src/pieces_os_client/models/external_provider.py index 5de68d4..94fe720 100644 --- a/src/pieces_os_client/models/external_provider.py +++ b/src/pieces_os_client/models/external_provider.py @@ -30,16 +30,16 @@ class ExternalProvider(BaseModel): """ I know that profileData and user_id have differeing casing but they are done because they map to Auth0's projeecties. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") type: ExternalProviderTypeEnum = Field(...) - user_id: StrictStr = Field(..., description="This is the user_id within the provider.") - access_token: Optional[StrictStr] = Field(None, description="This is optional here, but will be present for BB, Github, and google.") - expires_in: Optional[StrictInt] = Field(None, description="Some providers have an expiration on their access token. IE BB, Google, NOT Github.") + user_id: StrictStr = Field(default=..., description="This is the user_id within the provider.") + access_token: Optional[StrictStr] = Field(default=None, description="This is optional here, but will be present for BB, Github, and google.") + expires_in: Optional[StrictInt] = Field(default=None, description="Some providers have an expiration on their access token. IE BB, Google, NOT Github.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) - profile_data: Optional[ExternalProviderProfileData] = Field(None, alias="profileData") - connection: Optional[StrictStr] = Field(None, description="This is an optional field that will be provided onentreprise connections. ie is type == waad then connection might be PiecesApp. However is other cases,you my find your provider and connection is the exact same string. To decifer between the two, you can use the isSocial bool.") - is_social: Optional[StrictBool] = Field(None, alias="isSocial") + profile_data: Optional[ExternalProviderProfileData] = Field(default=None, alias="profileData") + connection: Optional[StrictStr] = Field(default=None, description="This is an optional field that will be provided onentreprise connections. ie is type == waad then connection might be PiecesApp. However is other cases,you my find your provider and connection is the exact same string. To decifer between the two, you can use the isSocial bool.") + is_social: Optional[StrictBool] = Field(default=None, alias="isSocial") __properties = ["schema", "type", "user_id", "access_token", "expires_in", "created", "updated", "profileData", "connection", "isSocial"] class Config: diff --git a/src/pieces_os_client/models/external_providers.py b/src/pieces_os_client/models/external_providers.py index b84487e..5ee746b 100644 --- a/src/pieces_os_client/models/external_providers.py +++ b/src/pieces_os_client/models/external_providers.py @@ -28,7 +28,7 @@ class ExternalProviders(BaseModel): """ ExternalProviders """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ExternalProvider) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/file_format.py b/src/pieces_os_client/models/file_format.py index 07d7fed..35433e2 100644 --- a/src/pieces_os_client/models/file_format.py +++ b/src/pieces_os_client/models/file_format.py @@ -29,7 +29,7 @@ class FileFormat(BaseModel): """ This describes a FileFormat. If you need meta data you can get all of that from your format wrapper. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") bytes: Optional[TransferableBytes] = None string: Optional[TransferableString] = None __properties = ["schema", "bytes", "string"] diff --git a/src/pieces_os_client/models/file_metadata.py b/src/pieces_os_client/models/file_metadata.py index e166bc4..44e9e8d 100644 --- a/src/pieces_os_client/models/file_metadata.py +++ b/src/pieces_os_client/models/file_metadata.py @@ -28,10 +28,10 @@ class FileMetadata(BaseModel): """ This is a model for metadata of a file! # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - name: Optional[StrictStr] = Field(None, description="This is the name of your file.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: Optional[StrictStr] = Field(default=None, description="This is the name of your file.") ext: Optional[ClassificationSpecificEnum] = None - size: Optional[StrictInt] = Field(None, description="This is the size(in bytes)") + size: Optional[StrictInt] = Field(default=None, description="This is the size(in bytes)") __properties = ["schema", "name", "ext", "size"] class Config: diff --git a/src/pieces_os_client/models/file_picker_input.py b/src/pieces_os_client/models/file_picker_input.py index bd1f4e1..11e42b1 100644 --- a/src/pieces_os_client/models/file_picker_input.py +++ b/src/pieces_os_client/models/file_picker_input.py @@ -20,16 +20,17 @@ from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conlist +from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema class FilePickerInput(BaseModel): """ This is the input model for the FilePicker # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - allowed_extensions: Optional[conlist(StrictStr)] = Field(None, alias="allowedExtensions") - __properties = ["schema", "allowedExtensions"] + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + allowed_extensions: Optional[conlist(StrictStr)] = Field(default=None, alias="allowedExtensions") + allow_multiple: Optional[StrictBool] = Field(default=None, alias="allowMultiple", description="default behavior is set to true") + __properties = ["schema", "allowedExtensions", "allowMultiple"] class Config: """Pydantic configuration""" @@ -71,7 +72,8 @@ def from_dict(cls, obj: dict) -> FilePickerInput: _obj = FilePickerInput.parse_obj({ "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, - "allowed_extensions": obj.get("allowedExtensions") + "allowed_extensions": obj.get("allowedExtensions"), + "allow_multiple": obj.get("allowMultiple") }) return _obj diff --git a/src/pieces_os_client/models/flattened_activities.py b/src/pieces_os_client/models/flattened_activities.py index 8412a40..49b620b 100644 --- a/src/pieces_os_client/models/flattened_activities.py +++ b/src/pieces_os_client/models/flattened_activities.py @@ -27,7 +27,7 @@ class FlattenedActivities(BaseModel): """ FlattenedActivities """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedActivity) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/flattened_activity.py b/src/pieces_os_client/models/flattened_activity.py index 8ad9f8a..4286269 100644 --- a/src/pieces_os_client/models/flattened_activity.py +++ b/src/pieces_os_client/models/flattened_activity.py @@ -31,7 +31,7 @@ class FlattenedActivity(BaseModel): """ Note: - if mechanism == internal we will not display to the user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/flattened_analysis.py b/src/pieces_os_client/models/flattened_analysis.py index b50bfbf..bcbc0d1 100644 --- a/src/pieces_os_client/models/flattened_analysis.py +++ b/src/pieces_os_client/models/flattened_analysis.py @@ -28,10 +28,10 @@ class FlattenedAnalysis(BaseModel): """ FlattenedAnalysis """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code: Optional[CodeAnalysis] = None id: StrictStr = Field(...) - format: StrictStr = Field(..., description="this is a reference to the format that it belongs too.") + format: StrictStr = Field(default=..., description="this is a reference to the format that it belongs too.") image: Optional[FlattenedImageAnalysis] = None __properties = ["schema", "code", "id", "format", "image"] diff --git a/src/pieces_os_client/models/flattened_anchor.py b/src/pieces_os_client/models/flattened_anchor.py index 2e7b501..e4b3ad9 100644 --- a/src/pieces_os_client/models/flattened_anchor.py +++ b/src/pieces_os_client/models/flattened_anchor.py @@ -30,7 +30,7 @@ class FlattenedAnchor(BaseModel): """ FlattenedAnchor """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) type: AnchorTypeEnum = Field(...) watch: Optional[StrictBool] = None @@ -44,7 +44,8 @@ class FlattenedAnchor(BaseModel): conversations: Optional[FlattenedConversations] = None score: Optional[Score] = None summaries: Optional[FlattenedWorkstreamSummaries] = None - __properties = ["schema", "id", "type", "watch", "points", "created", "updated", "deleted", "assets", "name", "annotations", "conversations", "score", "summaries"] + persons: Optional[FlattenedPersons] = None + __properties = ["schema", "id", "type", "watch", "points", "created", "updated", "deleted", "assets", "name", "annotations", "conversations", "score", "summaries", "persons"] class Config: """Pydantic configuration""" @@ -100,6 +101,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of summaries if self.summaries: _dict['summaries'] = self.summaries.to_dict() + # override the default output from pydantic by calling `to_dict()` of persons + if self.persons: + _dict['persons'] = self.persons.to_dict() return _dict @classmethod @@ -125,7 +129,8 @@ def from_dict(cls, obj: dict) -> FlattenedAnchor: "annotations": FlattenedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, "conversations": FlattenedConversations.from_dict(obj.get("conversations")) if obj.get("conversations") is not None else None, "score": Score.from_dict(obj.get("score")) if obj.get("score") is not None else None, - "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None + "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None, + "persons": FlattenedPersons.from_dict(obj.get("persons")) if obj.get("persons") is not None else None }) return _obj @@ -133,6 +138,7 @@ def from_dict(cls, obj: dict) -> FlattenedAnchor: from pieces_os_client.models.flattened_annotations import FlattenedAnnotations from pieces_os_client.models.flattened_assets import FlattenedAssets from pieces_os_client.models.flattened_conversations import FlattenedConversations +from pieces_os_client.models.flattened_persons import FlattenedPersons from pieces_os_client.models.flattened_workstream_summaries import FlattenedWorkstreamSummaries FlattenedAnchor.update_forward_refs() diff --git a/src/pieces_os_client/models/flattened_anchor_point.py b/src/pieces_os_client/models/flattened_anchor_point.py index 2406208..3d59933 100644 --- a/src/pieces_os_client/models/flattened_anchor_point.py +++ b/src/pieces_os_client/models/flattened_anchor_point.py @@ -30,10 +30,10 @@ class FlattenedAnchorPoint(BaseModel): """ FlattenedAnchorPoint """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) verified: Optional[StrictBool] = None - fullpath: StrictStr = Field(..., description="This is the text of the path.") + fullpath: StrictStr = Field(default=..., description="This is the text of the path.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None diff --git a/src/pieces_os_client/models/flattened_anchor_points.py b/src/pieces_os_client/models/flattened_anchor_points.py index b542f2d..86477a9 100644 --- a/src/pieces_os_client/models/flattened_anchor_points.py +++ b/src/pieces_os_client/models/flattened_anchor_points.py @@ -28,9 +28,9 @@ class FlattenedAnchorPoints(BaseModel): """ FlattenedAnchorPoints """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedAnchorPoint) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an AnchorPoint id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an AnchorPoint id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_anchors.py b/src/pieces_os_client/models/flattened_anchors.py index 0a83083..1f73a31 100644 --- a/src/pieces_os_client/models/flattened_anchors.py +++ b/src/pieces_os_client/models/flattened_anchors.py @@ -28,9 +28,9 @@ class FlattenedAnchors(BaseModel): """ FlattenedAnchors """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedAnchor) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an Anchor id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an Anchor id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_annotation.py b/src/pieces_os_client/models/flattened_annotation.py index 1cc7123..eaaa931 100644 --- a/src/pieces_os_client/models/flattened_annotation.py +++ b/src/pieces_os_client/models/flattened_annotation.py @@ -32,7 +32,7 @@ class FlattenedAnnotation(BaseModel): """ This is the flattened Version of the annotation, IMPORTANT: when referencing these, ONLY Take the UUID, do NOT polinate(ie w/ asset/person/model) the FlattenedAnnotation as it can create an infinite loop. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) @@ -41,7 +41,7 @@ class FlattenedAnnotation(BaseModel): asset: Optional[ReferencedAsset] = None person: Optional[ReferencedPerson] = None type: AnnotationTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the annotation.") + text: StrictStr = Field(default=..., description="This is the text of the annotation.") model: Optional[ReferencedModel] = None pseudo: Optional[StrictBool] = None favorited: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/flattened_annotations.py b/src/pieces_os_client/models/flattened_annotations.py index f2e4eb3..6ad1018 100644 --- a/src/pieces_os_client/models/flattened_annotations.py +++ b/src/pieces_os_client/models/flattened_annotations.py @@ -28,9 +28,9 @@ class FlattenedAnnotations(BaseModel): """ This is a flattened plural of Annotation, typically this will just be a list of uuids. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedAnnotation) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an annotation id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an annotation id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_asset.py b/src/pieces_os_client/models/flattened_asset.py index 47f08a5..6c58bcd 100644 --- a/src/pieces_os_client/models/flattened_asset.py +++ b/src/pieces_os_client/models/flattened_asset.py @@ -31,8 +31,8 @@ class FlattenedAsset(BaseModel): """ An Asset Model representing data extracted from an Application connecting a group of data containing one or more Formats. [DAG Compatible - Directed Acyclic Graph Data Structure] FlattenedAsset prevent Cycles in Reference because all outbound references are strings as opposed to crosspollinated objects. i.e. FlattenedFormat.preview is Type String, and FlattenedFormat.original is Type String # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The globally available UID representing the asset in the Database, both locally and in the cloud.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The globally available UID representing the asset in the Database, both locally and in the cloud.") name: Optional[StrictStr] = None creator: StrictStr = Field(...) created: GroupedTimestamp = Field(...) @@ -41,7 +41,7 @@ class FlattenedAsset(BaseModel): deleted: Optional[GroupedTimestamp] = None formats: FlattenedFormats = Field(...) preview: FlattenedPreview = Field(...) - original: StrictStr = Field(..., description="An identifier of the format that is a reference to the original.") + original: StrictStr = Field(default=..., description="An identifier of the format that is a reference to the original.") shares: Optional[FlattenedShares] = None mechanism: MechanismEnum = Field(...) websites: Optional[FlattenedWebsites] = None @@ -49,7 +49,7 @@ class FlattenedAsset(BaseModel): tags: Optional[FlattenedTags] = None sensitives: Optional[FlattenedSensitives] = None persons: Optional[FlattenedPersons] = None - curated: Optional[StrictBool] = Field(None, description="This is an optional boolean that will flag that this asset came from a currated collection.") + curated: Optional[StrictBool] = Field(default=None, description="This is an optional boolean that will flag that this asset came from a currated collection.") discovered: Optional[StrictBool] = None activities: Optional[FlattenedActivities] = None score: Optional[Score] = None @@ -59,7 +59,7 @@ class FlattenedAsset(BaseModel): hints: Optional[FlattenedHints] = None anchors: Optional[FlattenedAnchors] = None conversations: Optional[FlattenedConversations] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this asset was generated as a 'demo' snippet") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this asset was generated as a 'demo' snippet") summaries: Optional[FlattenedWorkstreamSummaries] = None __properties = ["schema", "id", "name", "creator", "created", "updated", "synced", "deleted", "formats", "preview", "original", "shares", "mechanism", "websites", "interacted", "tags", "sensitives", "persons", "curated", "discovered", "activities", "score", "favorited", "pseudo", "annotations", "hints", "anchors", "conversations", "demo", "summaries"] diff --git a/src/pieces_os_client/models/flattened_assets.py b/src/pieces_os_client/models/flattened_assets.py index d34bf86..42f0f82 100644 --- a/src/pieces_os_client/models/flattened_assets.py +++ b/src/pieces_os_client/models/flattened_assets.py @@ -28,9 +28,9 @@ class FlattenedAssets(BaseModel): """ A collection of Assets specific to the authenticated user. [DAG Compatible - Directed Acyclic Graph Data Structure] FlattenedAssets prevent Cycles in Reference because all outbound references are strings as opposed to crosspollinated objects. i.e. Asset asset = FlattenedAssets.iterable[0] => Format format = asset.preview => String id = format.asset => String id # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: Optional[conlist(ReferencedAsset)] = None - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an asset id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an asset id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_conversation.py b/src/pieces_os_client/models/flattened_conversation.py index 498fa82..ae108c3 100644 --- a/src/pieces_os_client/models/flattened_conversation.py +++ b/src/pieces_os_client/models/flattened_conversation.py @@ -33,9 +33,9 @@ class FlattenedConversation(BaseModel): """ This is a flattend version of the Convsersation for DAG-Safety. This will hold together a conversation. Ie allthe message within a conversation. All the additional properties on here used on here like(anchors/assets) are used for context that will seed the conversation. model is a calculated property, and will be the model of the last message sent if applicable. summaries: on the top level here will simply be used to associate a conversation and a summary(this is not used for grounding), grounding.summaries will be used for this.(TODO) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) - name: Optional[StrictStr] = Field(None, description="This is a name that is customized.") + name: Optional[StrictStr] = Field(default=None, description="This is a name that is customized.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None @@ -51,7 +51,7 @@ class FlattenedConversation(BaseModel): grounding: Optional[ConversationGrounding] = None score: Optional[Score] = None pipeline: Optional[QGPTPromptPipeline] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this conversation was generated as a 'demo' conversation") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this conversation was generated as a 'demo' conversation") summaries: Optional[FlattenedWorkstreamSummaries] = None __properties = ["schema", "id", "name", "created", "updated", "deleted", "favorited", "application", "annotations", "messages", "model", "assets", "websites", "anchors", "type", "grounding", "score", "pipeline", "demo", "summaries"] diff --git a/src/pieces_os_client/models/flattened_conversation_message.py b/src/pieces_os_client/models/flattened_conversation_message.py index 90bf863..c235b79 100644 --- a/src/pieces_os_client/models/flattened_conversation_message.py +++ b/src/pieces_os_client/models/flattened_conversation_message.py @@ -33,7 +33,7 @@ class FlattenedConversationMessage(BaseModel): """ This is a flattened DAG safe version of a ConversationMessage. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/flattened_conversation_messages.py b/src/pieces_os_client/models/flattened_conversation_messages.py index db5c982..6c1e57f 100644 --- a/src/pieces_os_client/models/flattened_conversation_messages.py +++ b/src/pieces_os_client/models/flattened_conversation_messages.py @@ -28,9 +28,9 @@ class FlattenedConversationMessages(BaseModel): """ This is a flattened plural version of ConversationMessages # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedConversationMessage) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an ConversationMessage id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an ConversationMessage id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_conversations.py b/src/pieces_os_client/models/flattened_conversations.py index 36fa51f..ba5821b 100644 --- a/src/pieces_os_client/models/flattened_conversations.py +++ b/src/pieces_os_client/models/flattened_conversations.py @@ -28,9 +28,9 @@ class FlattenedConversations(BaseModel): """ Flattened version of conversations. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedConversation) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an Conversation id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an Conversation id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_distribution.py b/src/pieces_os_client/models/flattened_distribution.py index dbf3ed9..822da57 100644 --- a/src/pieces_os_client/models/flattened_distribution.py +++ b/src/pieces_os_client/models/flattened_distribution.py @@ -30,9 +30,9 @@ class FlattenedDistribution(BaseModel): """ FlattenedDistribution """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) - share: StrictStr = Field(..., description="This is the UUId of the share.") + share: StrictStr = Field(default=..., description="This is the UUId of the share.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None diff --git a/src/pieces_os_client/models/flattened_distributions.py b/src/pieces_os_client/models/flattened_distributions.py index 7761d0b..844a1a3 100644 --- a/src/pieces_os_client/models/flattened_distributions.py +++ b/src/pieces_os_client/models/flattened_distributions.py @@ -28,7 +28,7 @@ class FlattenedDistributions(BaseModel): """ FlattenedDistributions """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedDistribution) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/flattened_format.py b/src/pieces_os_client/models/flattened_format.py index 266269e..2d88944 100644 --- a/src/pieces_os_client/models/flattened_format.py +++ b/src/pieces_os_client/models/flattened_format.py @@ -35,20 +35,20 @@ class FlattenedFormat(BaseModel): """ A representation of Data for a particular Form Factor of an Asset.[DAG Compatible - Directed Acyclic Graph Data Structure] FlattenedFormats prevent Cycles in Reference because all outbound references are strings as opposed to crosspollinated objects. i.e. FlattenedFormat.asset is Type String fragment or file will always be defined. Even thought they are both optional. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) creator: StrictStr = Field(...) classification: Classification = Field(...) icon: Optional[StrictStr] = None role: Role = Field(...) application: Application = Field(...) - asset: constr(strict=True, max_length=36, min_length=36) = Field(..., description="A uuid model. 36 Characters (4 Dashes, 32 Numbers/Letters) ") + asset: constr(strict=True, max_length=36, min_length=36) = Field(default=..., description="A uuid model. 36 Characters (4 Dashes, 32 Numbers/Letters) ") bytes: ByteDescriptor = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None synced: Optional[GroupedTimestamp] = None - cloud: Optional[StrictStr] = Field(None, description="This is a path used to determine what path this format lives at within the cloud.") + cloud: Optional[StrictStr] = Field(default=None, description="This is a path used to determine what path this format lives at within the cloud.") fragment: Optional[FragmentFormat] = None file: Optional[FileFormat] = None analysis: Optional[FlattenedAnalysis] = None diff --git a/src/pieces_os_client/models/flattened_formats.py b/src/pieces_os_client/models/flattened_formats.py index 87837a2..5ee0737 100644 --- a/src/pieces_os_client/models/flattened_formats.py +++ b/src/pieces_os_client/models/flattened_formats.py @@ -27,7 +27,7 @@ class FlattenedFormats(BaseModel): """ A collection of Formats specific to the authenticated user. [DAG Compatible - Directed Acyclic Graph Data Structure] FlattenedFormats prevent Cycles in Reference because all outbound references are strings as opposed to crosspollinated objects. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedFormat) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/flattened_hint.py b/src/pieces_os_client/models/flattened_hint.py index 89de3d7..d1aa5bd 100644 --- a/src/pieces_os_client/models/flattened_hint.py +++ b/src/pieces_os_client/models/flattened_hint.py @@ -19,7 +19,7 @@ import json -from typing import Optional +from typing import Dict, Optional from pydantic import BaseModel, Field, StrictStr from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema from pieces_os_client.models.grouped_timestamp import GroupedTimestamp @@ -32,18 +32,18 @@ class FlattenedHint(BaseModel): """ This is the flattened version of a hint. Ensure that you DO NOT reference the Asset here as you can create an infinite loop within the packaging. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None - mechanism: Optional[MechanismEnum] = None - asset: Optional[ReferencedAsset] = None + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + assets: Optional[FlattenedAssets] = None type: HintTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the hint.") + text: StrictStr = Field(default=..., description="This is the text of the hint.") model: Optional[ReferencedModel] = None score: Optional[Score] = None - __properties = ["schema", "id", "created", "updated", "deleted", "mechanism", "asset", "type", "text", "model", "score"] + __properties = ["schema", "id", "created", "updated", "deleted", "mechanisms", "assets", "type", "text", "model", "score"] class Config: """Pydantic configuration""" @@ -81,9 +81,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of deleted if self.deleted: _dict['deleted'] = self.deleted.to_dict() - # override the default output from pydantic by calling `to_dict()` of asset - if self.asset: - _dict['asset'] = self.asset.to_dict() + # override the default output from pydantic by calling `to_dict()` of assets + if self.assets: + _dict['assets'] = self.assets.to_dict() # override the default output from pydantic by calling `to_dict()` of model if self.model: _dict['model'] = self.model.to_dict() @@ -107,8 +107,8 @@ def from_dict(cls, obj: dict) -> FlattenedHint: "created": GroupedTimestamp.from_dict(obj.get("created")) if obj.get("created") is not None else None, "updated": GroupedTimestamp.from_dict(obj.get("updated")) if obj.get("updated") is not None else None, "deleted": GroupedTimestamp.from_dict(obj.get("deleted")) if obj.get("deleted") is not None else None, - "mechanism": obj.get("mechanism"), - "asset": ReferencedAsset.from_dict(obj.get("asset")) if obj.get("asset") is not None else None, + "mechanisms": dict((_k, _v) for _k, _v in obj.get("mechanisms").items()), + "assets": FlattenedAssets.from_dict(obj.get("assets")) if obj.get("assets") is not None else None, "type": obj.get("type"), "text": obj.get("text"), "model": ReferencedModel.from_dict(obj.get("model")) if obj.get("model") is not None else None, @@ -116,6 +116,6 @@ def from_dict(cls, obj: dict) -> FlattenedHint: }) return _obj -from pieces_os_client.models.referenced_asset import ReferencedAsset +from pieces_os_client.models.flattened_assets import FlattenedAssets FlattenedHint.update_forward_refs() diff --git a/src/pieces_os_client/models/flattened_hints.py b/src/pieces_os_client/models/flattened_hints.py index 4f561f3..961a162 100644 --- a/src/pieces_os_client/models/flattened_hints.py +++ b/src/pieces_os_client/models/flattened_hints.py @@ -28,9 +28,9 @@ class FlattenedHints(BaseModel): """ This is the flattened Version of plural hints. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedHint) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an hint id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an hint id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_image_analysis.py b/src/pieces_os_client/models/flattened_image_analysis.py index 3c98310..b75fff4 100644 --- a/src/pieces_os_client/models/flattened_image_analysis.py +++ b/src/pieces_os_client/models/flattened_image_analysis.py @@ -27,10 +27,10 @@ class FlattenedImageAnalysis(BaseModel): """ FlattenedImageAnalysis """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) ocr: Optional[FlattenedOCRAnalysis] = None - analysis: StrictStr = Field(..., description="this is a reference to our (parent)analysis") + analysis: StrictStr = Field(default=..., description="this is a reference to our (parent)analysis") __properties = ["schema", "id", "ocr", "analysis"] class Config: diff --git a/src/pieces_os_client/models/flattened_ocr_analysis.py b/src/pieces_os_client/models/flattened_ocr_analysis.py index 6469f79..e9b3ee5 100644 --- a/src/pieces_os_client/models/flattened_ocr_analysis.py +++ b/src/pieces_os_client/models/flattened_ocr_analysis.py @@ -28,12 +28,12 @@ class FlattenedOCRAnalysis(BaseModel): """ [DAG Safe] Ocr Analysis that will reference FlattenedFormats. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) raw: ReferencedFormat = Field(...) hocr: ReferencedFormat = Field(...) model: Model = Field(...) - image: StrictStr = Field(..., description="this is a refernece to the image analysis.") + image: StrictStr = Field(default=..., description="this is a refernece to the image analysis.") __properties = ["schema", "id", "raw", "hocr", "model", "image"] class Config: diff --git a/src/pieces_os_client/models/flattened_person.py b/src/pieces_os_client/models/flattened_person.py index 50e4293..c2b603b 100644 --- a/src/pieces_os_client/models/flattened_person.py +++ b/src/pieces_os_client/models/flattened_person.py @@ -32,23 +32,24 @@ class FlattenedPerson(BaseModel): """ if expiration is add then, after the alloted expiration date the user will only have view && comment only permissions. Only present in the case there is a scope such as a defined collection/asset... if asset is passed then that means this person belongs to a scoped asset. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None type: PersonType = Field(...) assets: Optional[FlattenedAssets] = None - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") - access: Optional[Dict[str, PersonAccess]] = Field(None, description="This is a Map where the the key is an asset id.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + access: Optional[Dict[str, PersonAccess]] = Field(default=None, description="This is a Map where the the key is an asset id.") tags: Optional[FlattenedTags] = None websites: Optional[FlattenedWebsites] = None - models: Optional[Dict[str, PersonModel]] = Field(None, description="This is a Map, where the the key is an asset id.") + models: Optional[Dict[str, PersonModel]] = Field(default=None, description="This is a Map, where the the key is an asset id.") annotations: Optional[FlattenedAnnotations] = None score: Optional[Score] = None summaries: Optional[FlattenedWorkstreamSummaries] = None - __properties = ["schema", "id", "created", "updated", "deleted", "type", "assets", "mechanisms", "interactions", "access", "tags", "websites", "models", "annotations", "score", "summaries"] + anchors: Optional[FlattenedAnchors] = None + __properties = ["schema", "id", "created", "updated", "deleted", "type", "assets", "mechanisms", "interactions", "access", "tags", "websites", "models", "annotations", "score", "summaries", "anchors"] class Config: """Pydantic configuration""" @@ -121,6 +122,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of summaries if self.summaries: _dict['summaries'] = self.summaries.to_dict() + # override the default output from pydantic by calling `to_dict()` of anchors + if self.anchors: + _dict['anchors'] = self.anchors.to_dict() return _dict @classmethod @@ -158,10 +162,12 @@ def from_dict(cls, obj: dict) -> FlattenedPerson: else None, "annotations": FlattenedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, "score": Score.from_dict(obj.get("score")) if obj.get("score") is not None else None, - "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None + "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None, + "anchors": FlattenedAnchors.from_dict(obj.get("anchors")) if obj.get("anchors") is not None else None }) return _obj +from pieces_os_client.models.flattened_anchors import FlattenedAnchors from pieces_os_client.models.flattened_annotations import FlattenedAnnotations from pieces_os_client.models.flattened_assets import FlattenedAssets from pieces_os_client.models.flattened_tags import FlattenedTags diff --git a/src/pieces_os_client/models/flattened_persons.py b/src/pieces_os_client/models/flattened_persons.py index 9c51e77..743d96a 100644 --- a/src/pieces_os_client/models/flattened_persons.py +++ b/src/pieces_os_client/models/flattened_persons.py @@ -28,9 +28,9 @@ class FlattenedPersons(BaseModel): """ This is the plural of Person. will have top level meta about the person including an iterable of all the person. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedPerson) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an person id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an person id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_preview.py b/src/pieces_os_client/models/flattened_preview.py index 46ef90e..8e26c7b 100644 --- a/src/pieces_os_client/models/flattened_preview.py +++ b/src/pieces_os_client/models/flattened_preview.py @@ -27,9 +27,9 @@ class FlattenedPreview(BaseModel): """ These are the references of the formats **Only UUIDS** # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - base: StrictStr = Field(..., description="this is a reference(uuid) to the base format") - overlay: Optional[StrictStr] = Field(None, description="this is a reference(uuid) to the overlay format") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + base: StrictStr = Field(default=..., description="this is a reference(uuid) to the base format") + overlay: Optional[StrictStr] = Field(default=None, description="this is a reference(uuid) to the overlay format") __properties = ["schema", "base", "overlay"] class Config: diff --git a/src/pieces_os_client/models/flattened_range.py b/src/pieces_os_client/models/flattened_range.py index ecb75a7..2096136 100644 --- a/src/pieces_os_client/models/flattened_range.py +++ b/src/pieces_os_client/models/flattened_range.py @@ -29,13 +29,13 @@ class FlattenedRange(BaseModel): """ This is a DAG-Safe minimal representation of a Range. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) to: Optional[GroupedTimestamp] = None - var_from: Optional[GroupedTimestamp] = Field(None, alias="from") + var_from: Optional[GroupedTimestamp] = Field(default=None, alias="from") between: Optional[StrictBool] = None summaries: Optional[FlattenedWorkstreamSummaries] = None conversations: Optional[FlattenedConversations] = None diff --git a/src/pieces_os_client/models/flattened_ranges.py b/src/pieces_os_client/models/flattened_ranges.py index b1f4077..25834e0 100644 --- a/src/pieces_os_client/models/flattened_ranges.py +++ b/src/pieces_os_client/models/flattened_ranges.py @@ -28,9 +28,9 @@ class FlattenedRanges(BaseModel): """ This is a DAG-Safe minimal representation of many Ranges. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedRange) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an range id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an range id.") score: Optional[Score] = None continuous: Optional[StrictBool] = None __properties = ["schema", "iterable", "indices", "score", "continuous"] diff --git a/src/pieces_os_client/models/flattened_sensitive.py b/src/pieces_os_client/models/flattened_sensitive.py index b1414fe..93ad878 100644 --- a/src/pieces_os_client/models/flattened_sensitive.py +++ b/src/pieces_os_client/models/flattened_sensitive.py @@ -33,7 +33,7 @@ class FlattenedSensitive(BaseModel): """ This is a dereferenced representation of a sensitive pieces of data. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) @@ -46,7 +46,7 @@ class FlattenedSensitive(BaseModel): name: StrictStr = Field(...) description: StrictStr = Field(...) metadata: Optional[SensitiveMetadata] = None - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") score: Optional[Score] = None __properties = ["schema", "id", "created", "updated", "deleted", "asset", "text", "mechanism", "category", "severity", "name", "description", "metadata", "interactions", "score"] diff --git a/src/pieces_os_client/models/flattened_sensitives.py b/src/pieces_os_client/models/flattened_sensitives.py index 37a73f5..d3141c0 100644 --- a/src/pieces_os_client/models/flattened_sensitives.py +++ b/src/pieces_os_client/models/flattened_sensitives.py @@ -28,7 +28,7 @@ class FlattenedSensitives(BaseModel): """ This is a flattened representation of multiple sensitive pieces of data. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedSensitive) = Field(...) score: Optional[Score] = None __properties = ["schema", "iterable", "score"] diff --git a/src/pieces_os_client/models/flattened_share.py b/src/pieces_os_client/models/flattened_share.py index bbbcab8..9f7a45d 100644 --- a/src/pieces_os_client/models/flattened_share.py +++ b/src/pieces_os_client/models/flattened_share.py @@ -32,15 +32,15 @@ class FlattenedShare(BaseModel): """ This is a dag safe version of the Share. if user is undefined && access is public then we have an asset that is publicly available. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="This references the share it self.") - asset: Optional[StrictStr] = Field(None, description="this is the asset id on the flattened share.") - user: Optional[StrictStr] = Field(None, description="this is the uuid of the user that the share is created for.") - link: StrictStr = Field(..., description="this is the prebuilt link.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="This references the share it self.") + asset: Optional[StrictStr] = Field(default=None, description="this is the asset id on the flattened share.") + user: Optional[StrictStr] = Field(default=None, description="this is the uuid of the user that the share is created for.") + link: StrictStr = Field(default=..., description="this is the prebuilt link.") access: AccessEnum = Field(...) accessors: Accessors = Field(...) created: GroupedTimestamp = Field(...) - short: StrictStr = Field(..., description="This is a shortened version of our uuid.") + short: StrictStr = Field(default=..., description="This is a shortened version of our uuid.") name: Optional[StrictStr] = None assets: Optional[FlattenedAssets] = None distributions: Optional[FlattenedDistributions] = None diff --git a/src/pieces_os_client/models/flattened_shares.py b/src/pieces_os_client/models/flattened_shares.py index 12587bf..83b0caa 100644 --- a/src/pieces_os_client/models/flattened_shares.py +++ b/src/pieces_os_client/models/flattened_shares.py @@ -28,7 +28,7 @@ class FlattenedShares(BaseModel): """ This is just an iterable of our individual share models. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(FlattenedShare) = Field(...) score: Optional[Score] = None __properties = ["schema", "iterable", "score"] diff --git a/src/pieces_os_client/models/flattened_tag.py b/src/pieces_os_client/models/flattened_tag.py index a1142c6..7ea412c 100644 --- a/src/pieces_os_client/models/flattened_tag.py +++ b/src/pieces_os_client/models/flattened_tag.py @@ -32,17 +32,17 @@ class FlattenedTag(BaseModel): """ This is a Flattened Version of a Tag. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) text: StrictStr = Field(...) - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") assets: Optional[FlattenedAssets] = None created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None category: TagCategoryEnum = Field(...) relationship: Optional[Relationship] = None - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") persons: Optional[FlattenedPersons] = None score: Optional[Score] = None __properties = ["schema", "id", "text", "mechanisms", "assets", "created", "updated", "deleted", "category", "relationship", "interactions", "persons", "score"] diff --git a/src/pieces_os_client/models/flattened_tags.py b/src/pieces_os_client/models/flattened_tags.py index 1bb89ab..fe822f2 100644 --- a/src/pieces_os_client/models/flattened_tags.py +++ b/src/pieces_os_client/models/flattened_tags.py @@ -28,9 +28,9 @@ class FlattenedTags(BaseModel): """ This is multiple ReferencedTags(which includes an optional FlattenedTag Model within the reference model). # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedTag) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an tag id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an tag id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_user_profile.py b/src/pieces_os_client/models/flattened_user_profile.py index 64cd7ed..039cacc 100644 --- a/src/pieces_os_client/models/flattened_user_profile.py +++ b/src/pieces_os_client/models/flattened_user_profile.py @@ -27,8 +27,8 @@ class FlattenedUserProfile(BaseModel): """ This is a FlattenedUserProfile that includes information that is not sensative in relation to a user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="this is the uuid that identifies a user.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="this is the uuid that identifies a user.") email: Optional[StrictStr] = None name: Optional[StrictStr] = None username: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/flattened_website.py b/src/pieces_os_client/models/flattened_website.py index 64358c6..5b69078 100644 --- a/src/pieces_os_client/models/flattened_website.py +++ b/src/pieces_os_client/models/flattened_website.py @@ -30,16 +30,16 @@ class FlattenedWebsite(BaseModel): """ This is a specific model for related websites to an asset.[DAG SAFE] # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="this is aspecific uuid that represents") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="this is aspecific uuid that represents") assets: Optional[FlattenedAssets] = None - name: StrictStr = Field(..., description="A customizable name.") - url: StrictStr = Field(..., description="The true url or the website.") + name: StrictStr = Field(default=..., description="A customizable name.") + url: StrictStr = Field(default=..., description="The true url or the website.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") persons: Optional[FlattenedPersons] = None conversations: Optional[FlattenedConversations] = None score: Optional[Score] = None diff --git a/src/pieces_os_client/models/flattened_websites.py b/src/pieces_os_client/models/flattened_websites.py index 95c4bb4..c5cbd1f 100644 --- a/src/pieces_os_client/models/flattened_websites.py +++ b/src/pieces_os_client/models/flattened_websites.py @@ -28,9 +28,9 @@ class FlattenedWebsites(BaseModel): """ This is a specific model for related websites to an asset.[DAG SAFE] # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedWebsite) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an website id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an website id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_workstream_event.py b/src/pieces_os_client/models/flattened_workstream_event.py index b3a51e2..3825939 100644 --- a/src/pieces_os_client/models/flattened_workstream_event.py +++ b/src/pieces_os_client/models/flattened_workstream_event.py @@ -31,7 +31,7 @@ class FlattenedWorkstreamEvent(BaseModel): """ This is a singular (DAG Safe) version of a WorkstreamEvent. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None application: Application = Field(...) diff --git a/src/pieces_os_client/models/flattened_workstream_events.py b/src/pieces_os_client/models/flattened_workstream_events.py index b13ec50..cc6b870 100644 --- a/src/pieces_os_client/models/flattened_workstream_events.py +++ b/src/pieces_os_client/models/flattened_workstream_events.py @@ -28,9 +28,9 @@ class FlattenedWorkstreamEvents(BaseModel): """ This is a plural (DAG Safe) version of a WorkstreamEvents. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedWorkstreamEvent) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an activity id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an activity id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_event.py b/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_event.py new file mode 100644 index 0000000..f2afe93 --- /dev/null +++ b/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_event.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.grouped_timestamp import GroupedTimestamp + +class FlattenedWorkstreamPatternEngineVisionEvent(BaseModel): + """ + This is a flattened version of the WorkstreamPatternEngineVisionEvent, where the referenced to other materials are also flattened(DAG Safe) Note: TODO later add textual and need to correspond w/ both transferables as well as the FlattenedMaterial # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(...) + created: GroupedTimestamp = Field(...) + __properties = ["schema", "id", "created"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> FlattenedWorkstreamPatternEngineVisionEvent: + """Create an instance of FlattenedWorkstreamPatternEngineVisionEvent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of created + if self.created: + _dict['created'] = self.created.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> FlattenedWorkstreamPatternEngineVisionEvent: + """Create an instance of FlattenedWorkstreamPatternEngineVisionEvent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return FlattenedWorkstreamPatternEngineVisionEvent.parse_obj(obj) + + _obj = FlattenedWorkstreamPatternEngineVisionEvent.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "id": obj.get("id"), + "created": GroupedTimestamp.from_dict(obj.get("created")) if obj.get("created") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_events.py b/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_events.py new file mode 100644 index 0000000..410b26b --- /dev/null +++ b/src/pieces_os_client/models/flattened_workstream_pattern_engine_vision_events.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.referenced_workstream_pattern_engine_vision_event import ReferencedWorkstreamPatternEngineVisionEvent + +class FlattenedWorkstreamPatternEngineVisionEvents(BaseModel): + """ + This is a plural snapshot of all of the events within WPE qdrant(Referenced) # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(ReferencedWorkstreamPatternEngineVisionEvent) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> FlattenedWorkstreamPatternEngineVisionEvents: + """Create an instance of FlattenedWorkstreamPatternEngineVisionEvents from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> FlattenedWorkstreamPatternEngineVisionEvents: + """Create an instance of FlattenedWorkstreamPatternEngineVisionEvents from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return FlattenedWorkstreamPatternEngineVisionEvents.parse_obj(obj) + + _obj = FlattenedWorkstreamPatternEngineVisionEvents.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [ReferencedWorkstreamPatternEngineVisionEvent.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/flattened_workstream_summaries.py b/src/pieces_os_client/models/flattened_workstream_summaries.py index a1f565e..d0c0c2c 100644 --- a/src/pieces_os_client/models/flattened_workstream_summaries.py +++ b/src/pieces_os_client/models/flattened_workstream_summaries.py @@ -28,9 +28,9 @@ class FlattenedWorkstreamSummaries(BaseModel): """ This is a DAG-Safe plural model of workstreamsummaries # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ReferencedWorkstreamSummary) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an summary id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an summary id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/flattened_workstream_summary.py b/src/pieces_os_client/models/flattened_workstream_summary.py index e29c899..e2b65db 100644 --- a/src/pieces_os_client/models/flattened_workstream_summary.py +++ b/src/pieces_os_client/models/flattened_workstream_summary.py @@ -31,7 +31,7 @@ class FlattenedWorkstreamSummary(BaseModel): """ This is a DAG-Safe minimal representation of a workstream summary # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None created: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/font.py b/src/pieces_os_client/models/font.py index 9472787..67dfdf3 100644 --- a/src/pieces_os_client/models/font.py +++ b/src/pieces_os_client/models/font.py @@ -27,7 +27,7 @@ class Font(BaseModel): """ This will describe the font that the user sees. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") size: StrictInt = Field(...) __properties = ["schema", "size"] diff --git a/src/pieces_os_client/models/format.py b/src/pieces_os_client/models/format.py index 002e177..3071159 100644 --- a/src/pieces_os_client/models/format.py +++ b/src/pieces_os_client/models/format.py @@ -37,7 +37,7 @@ class Format(BaseModel): """ A representation of Data for a particular Form Factor of an Asset. Below asset HAS to be Flattened because it is a leaf node and must prevent cycles agressively. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) creator: StrictStr = Field(...) classification: Classification = Field(...) @@ -50,7 +50,7 @@ class Format(BaseModel): updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None synced: Optional[GroupedTimestamp] = None - cloud: Optional[StrictStr] = Field(None, description="This is a path used to determine what path this format lives at within the cloud.") + cloud: Optional[StrictStr] = Field(default=None, description="This is a path used to determine what path this format lives at within the cloud.") fragment: Optional[FragmentFormat] = None file: Optional[FileFormat] = None analysis: Optional[Analysis] = None diff --git a/src/pieces_os_client/models/format_metric.py b/src/pieces_os_client/models/format_metric.py index a8837f6..18b0ab5 100644 --- a/src/pieces_os_client/models/format_metric.py +++ b/src/pieces_os_client/models/format_metric.py @@ -29,10 +29,10 @@ class FormatMetric(BaseModel): """ FormatMetric This is a model that will represent the about of specific formats. ie Generic: 'CODE' specific: 'DART' identifiers: ['FormatUID1, 'FormatUID2'] # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") generic: ClassificationGenericEnum = Field(...) specific: ClassificationSpecificEnum = Field(...) - identifiers: conlist(StrictStr) = Field(..., description="this is a list of format ids") + identifiers: conlist(StrictStr) = Field(default=..., description="this is a list of format ids") __properties = ["schema", "generic", "specific", "identifiers"] class Config: diff --git a/src/pieces_os_client/models/format_reclassification.py b/src/pieces_os_client/models/format_reclassification.py index dcde75a..1e0d8a0 100644 --- a/src/pieces_os_client/models/format_reclassification.py +++ b/src/pieces_os_client/models/format_reclassification.py @@ -29,7 +29,7 @@ class FormatReclassification(BaseModel): """ This is a model that will represent the miminum properties required to update the classification of this format. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ext: ClassificationSpecificEnum = Field(...) format: Format = Field(...) __properties = ["schema", "ext", "format"] diff --git a/src/pieces_os_client/models/formats.py b/src/pieces_os_client/models/formats.py index b81e3a6..96eb24e 100644 --- a/src/pieces_os_client/models/formats.py +++ b/src/pieces_os_client/models/formats.py @@ -28,7 +28,7 @@ class Formats(BaseModel): """ A base class for a collection of formats and some additional meta properties. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Format) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/formats_metrics.py b/src/pieces_os_client/models/formats_metrics.py index 74f2cd6..c7de8e6 100644 --- a/src/pieces_os_client/models/formats_metrics.py +++ b/src/pieces_os_client/models/formats_metrics.py @@ -28,7 +28,7 @@ class FormatsMetrics(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(FormatMetric) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/fragment_format.py b/src/pieces_os_client/models/fragment_format.py index 0d2fc8c..df35162 100644 --- a/src/pieces_os_client/models/fragment_format.py +++ b/src/pieces_os_client/models/fragment_format.py @@ -30,7 +30,7 @@ class FragmentFormat(BaseModel): """ This will be either a TransferableString or TransferableBytes that represent your fragment. ONLY Pass one or the other DONT pass both or neither. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") string: Optional[TransferableString] = None bytes: Optional[TransferableBytes] = None metadata: Optional[FragmentMetadata] = None diff --git a/src/pieces_os_client/models/fragment_metadata.py b/src/pieces_os_client/models/fragment_metadata.py index 6a6e9ac..89bf4cb 100644 --- a/src/pieces_os_client/models/fragment_metadata.py +++ b/src/pieces_os_client/models/fragment_metadata.py @@ -28,7 +28,7 @@ class FragmentMetadata(BaseModel): """ This is a model for metadata of a file! # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ext: Optional[ClassificationSpecificEnum] = None __properties = ["schema", "ext"] diff --git a/src/pieces_os_client/models/full_text_search_options.py b/src/pieces_os_client/models/full_text_search_options.py new file mode 100644 index 0000000..f030d1e --- /dev/null +++ b/src/pieces_os_client/models/full_text_search_options.py @@ -0,0 +1,85 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class FullTextSearchOptions(BaseModel): + """ + similarity: you will want to pass in a value from 0-1. (where 1 is exact and 0 is everything) exact: (optional) this will default to false, which will run a fuzzy search, unless set to true. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + similarity: Optional[Union[StrictFloat, StrictInt]] = None + exact: Optional[StrictBool] = None + __properties = ["schema", "similarity", "exact"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> FullTextSearchOptions: + """Create an instance of FullTextSearchOptions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # set to None if similarity (nullable) is None + # and __fields_set__ contains the field + if self.similarity is None and "similarity" in self.__fields_set__: + _dict['similarity'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> FullTextSearchOptions: + """Create an instance of FullTextSearchOptions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return FullTextSearchOptions.parse_obj(obj) + + _obj = FullTextSearchOptions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "similarity": obj.get("similarity"), + "exact": obj.get("exact") + }) + return _obj + + diff --git a/src/pieces_os_client/models/git_hub_distribution.py b/src/pieces_os_client/models/git_hub_distribution.py index f733373..0d96926 100644 --- a/src/pieces_os_client/models/git_hub_distribution.py +++ b/src/pieces_os_client/models/git_hub_distribution.py @@ -28,7 +28,7 @@ class GitHubDistribution(BaseModel): """ GitHubDistribution """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") gist: Optional[GitHubGistDistribution] = None __properties = ["schema", "gist"] diff --git a/src/pieces_os_client/models/git_hub_gist_distribution.py b/src/pieces_os_client/models/git_hub_gist_distribution.py index 354e50a..3a6c310 100644 --- a/src/pieces_os_client/models/git_hub_gist_distribution.py +++ b/src/pieces_os_client/models/git_hub_gist_distribution.py @@ -29,16 +29,16 @@ class GitHubGistDistribution(BaseModel): """ This is a published Github Gist. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") recipients: Recipients = Field(...) - public: StrictBool = Field(..., description="This will let us know if the gist is public or private.") - description: Optional[StrictStr] = Field(None, description="This is the description of the Gist Distribution") - name: StrictStr = Field(..., description="This is the name of the gist you will add.") + public: StrictBool = Field(default=..., description="This will let us know if the gist is public or private.") + description: Optional[StrictStr] = Field(default=None, description="This is the description of the Gist Distribution") + name: StrictStr = Field(default=..., description="This is the name of the gist you will add.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None - github_id: StrictStr = Field(..., description="This is the id that github uses to represent the gist.") - url: StrictStr = Field(..., description="This is the url where the gist is.") + github_id: StrictStr = Field(default=..., description="This is the id that github uses to represent the gist.") + url: StrictStr = Field(default=..., description="This is the url where the gist is.") __properties = ["schema", "recipients", "public", "description", "name", "created", "updated", "deleted", "github_id", "url"] class Config: diff --git a/src/pieces_os_client/models/graphical_image_descriptive_statistics.py b/src/pieces_os_client/models/graphical_image_descriptive_statistics.py index c7e5911..21b59e6 100644 --- a/src/pieces_os_client/models/graphical_image_descriptive_statistics.py +++ b/src/pieces_os_client/models/graphical_image_descriptive_statistics.py @@ -27,7 +27,7 @@ class GraphicalImageDescriptiveStatistics(BaseModel): """ Model for collecting descriptive statistics of images uploaded to Pieces # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") width: StrictStr = Field(...) height: StrictStr = Field(...) channels: StrictStr = Field(...) diff --git a/src/pieces_os_client/models/graphical_image_processing.py b/src/pieces_os_client/models/graphical_image_processing.py index 32e2ae1..0e8be2e 100644 --- a/src/pieces_os_client/models/graphical_image_processing.py +++ b/src/pieces_os_client/models/graphical_image_processing.py @@ -28,7 +28,7 @@ class GraphicalImageProcessing(BaseModel): """ GraphicalImageProcessing """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") statistics: Optional[GraphicalImageStatistics] = None __properties = ["schema", "statistics"] diff --git a/src/pieces_os_client/models/graphical_image_statistics.py b/src/pieces_os_client/models/graphical_image_statistics.py index 0a4f022..fb31c91 100644 --- a/src/pieces_os_client/models/graphical_image_statistics.py +++ b/src/pieces_os_client/models/graphical_image_statistics.py @@ -28,7 +28,7 @@ class GraphicalImageStatistics(BaseModel): """ GraphicalImageStatistics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") descriptive: Optional[GraphicalImageDescriptiveStatistics] = None __properties = ["schema", "descriptive"] diff --git a/src/pieces_os_client/models/graphical_machine_learning_processing_event.py b/src/pieces_os_client/models/graphical_machine_learning_processing_event.py index 438ce1a..8f84aa2 100644 --- a/src/pieces_os_client/models/graphical_machine_learning_processing_event.py +++ b/src/pieces_os_client/models/graphical_machine_learning_processing_event.py @@ -30,7 +30,7 @@ class GraphicalMachineLearningProcessingEvent(BaseModel): """ GraphicalMachineLearningProcessingEvent """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ocr: Optional[GraphicalOCRProcessing] = None image: Optional[GraphicalImageProcessing] = None svg: Optional[GraphicalSVGStatistics] = None diff --git a/src/pieces_os_client/models/graphical_ocr_descriptive_statistics.py b/src/pieces_os_client/models/graphical_ocr_descriptive_statistics.py index 6ee16d8..f53df42 100644 --- a/src/pieces_os_client/models/graphical_ocr_descriptive_statistics.py +++ b/src/pieces_os_client/models/graphical_ocr_descriptive_statistics.py @@ -28,7 +28,7 @@ class GraphicalOCRDescriptiveStatistics(BaseModel): """ Model for monitoring and evaluating the OCR feature # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) user: StrictStr = Field(...) model: StrictStr = Field(...) diff --git a/src/pieces_os_client/models/graphical_ocr_processing.py b/src/pieces_os_client/models/graphical_ocr_processing.py index ce73900..c9b5f65 100644 --- a/src/pieces_os_client/models/graphical_ocr_processing.py +++ b/src/pieces_os_client/models/graphical_ocr_processing.py @@ -28,7 +28,7 @@ class GraphicalOCRProcessing(BaseModel): """ GraphicalOCRProcessing """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") statistics: Optional[GraphicalOCRStatistics] = None __properties = ["schema", "statistics"] diff --git a/src/pieces_os_client/models/graphical_ocr_statistics.py b/src/pieces_os_client/models/graphical_ocr_statistics.py index edb222d..6fb9b47 100644 --- a/src/pieces_os_client/models/graphical_ocr_statistics.py +++ b/src/pieces_os_client/models/graphical_ocr_statistics.py @@ -28,7 +28,7 @@ class GraphicalOCRStatistics(BaseModel): """ GraphicalOCRStatistics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") descriptive: Optional[GraphicalOCRDescriptiveStatistics] = None __properties = ["schema", "descriptive"] diff --git a/src/pieces_os_client/models/graphical_svg_statistics.py b/src/pieces_os_client/models/graphical_svg_statistics.py index 14abb00..5897a0c 100644 --- a/src/pieces_os_client/models/graphical_svg_statistics.py +++ b/src/pieces_os_client/models/graphical_svg_statistics.py @@ -27,7 +27,7 @@ class GraphicalSVGStatistics(BaseModel): """ GraphicalSVGStatistics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/grouped_timestamp.py b/src/pieces_os_client/models/grouped_timestamp.py index 6971921..09cf839 100644 --- a/src/pieces_os_client/models/grouped_timestamp.py +++ b/src/pieces_os_client/models/grouped_timestamp.py @@ -27,7 +27,7 @@ class GroupedTimestamp(BaseModel): """ A helper classs to wrap Date-Time Values with Useful Helper Properties # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: datetime = Field(...) readable: Optional[StrictStr] = None __properties = ["schema", "value", "readable"] diff --git a/src/pieces_os_client/models/health.py b/src/pieces_os_client/models/health.py index 48aa501..58ab8e2 100644 --- a/src/pieces_os_client/models/health.py +++ b/src/pieces_os_client/models/health.py @@ -28,7 +28,7 @@ class Health(BaseModel): """ This is a health model used to determine the \"health\" of the os server and cloud server(Coming Soon). READONLY Model. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") os: OSHealth = Field(...) __properties = ["schema", "os"] diff --git a/src/pieces_os_client/models/hint.py b/src/pieces_os_client/models/hint.py index 9a1edb7..25271ea 100644 --- a/src/pieces_os_client/models/hint.py +++ b/src/pieces_os_client/models/hint.py @@ -19,13 +19,13 @@ import json -from typing import Optional +from typing import Dict, Optional from pydantic import BaseModel, Field, StrictStr from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_assets import FlattenedAssets from pieces_os_client.models.grouped_timestamp import GroupedTimestamp from pieces_os_client.models.hint_type_enum import HintTypeEnum from pieces_os_client.models.mechanism_enum import MechanismEnum -from pieces_os_client.models.referenced_asset import ReferencedAsset from pieces_os_client.models.referenced_model import ReferencedModel from pieces_os_client.models.score import Score @@ -33,18 +33,18 @@ class Hint(BaseModel): """ This is a hint that is attached to an asset, used for suggested_queries, and hints given via the qgpt flow. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None - mechanism: Optional[MechanismEnum] = None - asset: Optional[ReferencedAsset] = None + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + assets: Optional[FlattenedAssets] = None type: HintTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the hint.") + text: StrictStr = Field(default=..., description="This is the text of the hint.") model: Optional[ReferencedModel] = None score: Optional[Score] = None - __properties = ["schema", "id", "created", "updated", "deleted", "mechanism", "asset", "type", "text", "model", "score"] + __properties = ["schema", "id", "created", "updated", "deleted", "mechanisms", "assets", "type", "text", "model", "score"] class Config: """Pydantic configuration""" @@ -82,9 +82,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of deleted if self.deleted: _dict['deleted'] = self.deleted.to_dict() - # override the default output from pydantic by calling `to_dict()` of asset - if self.asset: - _dict['asset'] = self.asset.to_dict() + # override the default output from pydantic by calling `to_dict()` of assets + if self.assets: + _dict['assets'] = self.assets.to_dict() # override the default output from pydantic by calling `to_dict()` of model if self.model: _dict['model'] = self.model.to_dict() @@ -108,8 +108,8 @@ def from_dict(cls, obj: dict) -> Hint: "created": GroupedTimestamp.from_dict(obj.get("created")) if obj.get("created") is not None else None, "updated": GroupedTimestamp.from_dict(obj.get("updated")) if obj.get("updated") is not None else None, "deleted": GroupedTimestamp.from_dict(obj.get("deleted")) if obj.get("deleted") is not None else None, - "mechanism": obj.get("mechanism"), - "asset": ReferencedAsset.from_dict(obj.get("asset")) if obj.get("asset") is not None else None, + "mechanisms": dict((_k, _v) for _k, _v in obj.get("mechanisms").items()), + "assets": FlattenedAssets.from_dict(obj.get("assets")) if obj.get("assets") is not None else None, "type": obj.get("type"), "text": obj.get("text"), "model": ReferencedModel.from_dict(obj.get("model")) if obj.get("model") is not None else None, diff --git a/src/pieces_os_client/models/hints.py b/src/pieces_os_client/models/hints.py index 851046d..af442dc 100644 --- a/src/pieces_os_client/models/hints.py +++ b/src/pieces_os_client/models/hints.py @@ -29,9 +29,9 @@ class Hints(BaseModel): """ This is the plural of a Hint. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Hint) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an hint id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an hint id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/ide_selection.py b/src/pieces_os_client/models/ide_selection.py index c6d64bb..13be0ee 100644 --- a/src/pieces_os_client/models/ide_selection.py +++ b/src/pieces_os_client/models/ide_selection.py @@ -30,7 +30,7 @@ class IDESelection(BaseModel): """ This is a given bit of text/code that is selected in the IDE, this can be a copy/paste/selection location: this is the given location provided by the LSP(might need to be a different object we will see) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") location: Optional[LanguageServerProtocolLocation] = None classification: Optional[Classification] = None value: Optional[TransferableString] = None diff --git a/src/pieces_os_client/models/ide_selections.py b/src/pieces_os_client/models/ide_selections.py index f1fa39c..db43157 100644 --- a/src/pieces_os_client/models/ide_selections.py +++ b/src/pieces_os_client/models/ide_selections.py @@ -28,7 +28,7 @@ class IDESelections(BaseModel): """ Plural model that represent many selections in the browser # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(IDESelection) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/ide_tab.py b/src/pieces_os_client/models/ide_tab.py index 70531d9..1d989e6 100644 --- a/src/pieces_os_client/models/ide_tab.py +++ b/src/pieces_os_client/models/ide_tab.py @@ -33,7 +33,7 @@ class IDETab(BaseModel): """ This is a representation of an IDE Tab value: is the value of the entire file(that being said we do not recomment passing this over as we can read this file on PieceOS side of things) classification: this is the classifcation of this file selection: this is a represention of a copy/paste/selection of a bit of code anchor: this is the file path range: this is the duration that this user has been on this Tab current: is a boolean that will let us know if this is the current active tab contributors: is the people that are extracted via git lsp: this is the languageserverprotocol this is used for may things such as error,stackstrces, mainly information extracted from the lang server # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: Optional[TransferableString] = None classification: Optional[Classification] = None selections: Optional[IDESelections] = None diff --git a/src/pieces_os_client/models/ide_tabs.py b/src/pieces_os_client/models/ide_tabs.py index 2397e8d..94b3afc 100644 --- a/src/pieces_os_client/models/ide_tabs.py +++ b/src/pieces_os_client/models/ide_tabs.py @@ -27,7 +27,7 @@ class IDETabs(BaseModel): """ This is a plural representation of a IDETab # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(IDETab) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/image_analyses.py b/src/pieces_os_client/models/image_analyses.py index d1cda95..946eaa6 100644 --- a/src/pieces_os_client/models/image_analyses.py +++ b/src/pieces_os_client/models/image_analyses.py @@ -28,7 +28,7 @@ class ImageAnalyses(BaseModel): """ ImageAnalyses """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ImageAnalysis) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/image_analysis.py b/src/pieces_os_client/models/image_analysis.py index 2b268dc..dd28268 100644 --- a/src/pieces_os_client/models/image_analysis.py +++ b/src/pieces_os_client/models/image_analysis.py @@ -27,9 +27,9 @@ class ImageAnalysis(BaseModel): """ This is a model that represents all the information collected during the processing of an image. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="this is a uuid that represents a imageAnalysis.") - analysis: StrictStr = Field(..., description="this is a reference to the analysis.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="this is a uuid that represents a imageAnalysis.") + analysis: StrictStr = Field(default=..., description="this is a reference to the analysis.") ocr: Optional[OCRAnalysis] = None __properties = ["schema", "id", "analysis", "ocr"] diff --git a/src/pieces_os_client/models/inactive_os_server_applet.py b/src/pieces_os_client/models/inactive_os_server_applet.py new file mode 100644 index 0000000..fefb900 --- /dev/null +++ b/src/pieces_os_client/models/inactive_os_server_applet.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictInt +from pieces_os_client.models.application import Application +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.os_applet_enum import OSAppletEnum + +class InactiveOSServerApplet(BaseModel): + """ + Note: parent is optional here in the case that (parent here is the integration that wants the module launched(VSCode)) # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + parent: Optional[Application] = None + port: Optional[StrictInt] = Field(default=None, description="This is the port number in which we want to serve the copilot at.") + type: OSAppletEnum = Field(...) + __properties = ["schema", "parent", "port", "type"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> InactiveOSServerApplet: + """Create an instance of InactiveOSServerApplet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of parent + if self.parent: + _dict['parent'] = self.parent.to_dict() + # set to None if port (nullable) is None + # and __fields_set__ contains the field + if self.port is None and "port" in self.__fields_set__: + _dict['port'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> InactiveOSServerApplet: + """Create an instance of InactiveOSServerApplet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return InactiveOSServerApplet.parse_obj(obj) + + _obj = InactiveOSServerApplet.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "parent": Application.from_dict(obj.get("parent")) if obj.get("parent") is not None else None, + "port": obj.get("port"), + "type": obj.get("type") + }) + return _obj + + diff --git a/src/pieces_os_client/models/interacted_asset.py b/src/pieces_os_client/models/interacted_asset.py index 99d6870..a664dae 100644 --- a/src/pieces_os_client/models/interacted_asset.py +++ b/src/pieces_os_client/models/interacted_asset.py @@ -27,7 +27,7 @@ class InteractedAsset(BaseModel): """ A model that represents an asset that has been interacted with. # noqa: E501 """ - asset: Optional[constr(strict=True, max_length=36, min_length=36)] = Field(None, description="A uuid model. 36 Characters (4 Dashes, 32 Numbers/Letters) ") + asset: Optional[constr(strict=True, max_length=36, min_length=36)] = Field(default=None, description="A uuid model. 36 Characters (4 Dashes, 32 Numbers/Letters) ") interactions: Optional[InteractedAssetInteractions] = None __properties = ["asset", "interactions"] diff --git a/src/pieces_os_client/models/interacted_asset_interactions.py b/src/pieces_os_client/models/interacted_asset_interactions.py index 9751cbe..64446fa 100644 --- a/src/pieces_os_client/models/interacted_asset_interactions.py +++ b/src/pieces_os_client/models/interacted_asset_interactions.py @@ -26,9 +26,9 @@ class InteractedAssetInteractions(BaseModel): """ InteractedAssetInteractions """ - viewed: constr(strict=True) = Field(..., description="https://en.wikipedia.org/wiki/ISO_8601#Time_intervals") - touched: Optional[StrictBool] = Field(False, description="If the user touched or panned over the asset.") - scrolled: Optional[StrictBool] = Field(False, description="If the user scrolled over the asset.") + viewed: constr(strict=True) = Field(default=..., description="https://en.wikipedia.org/wiki/ISO_8601#Time_intervals") + touched: Optional[StrictBool] = Field(default=False, description="If the user touched or panned over the asset.") + scrolled: Optional[StrictBool] = Field(default=False, description="If the user scrolled over the asset.") __properties = ["viewed", "touched", "scrolled"] @validator('viewed') diff --git a/src/pieces_os_client/models/interacted_assets.py b/src/pieces_os_client/models/interacted_assets.py index 0e1d62b..d737b94 100644 --- a/src/pieces_os_client/models/interacted_assets.py +++ b/src/pieces_os_client/models/interacted_assets.py @@ -28,7 +28,7 @@ class InteractedAssets(BaseModel): """ A model which contains a list of InteractedAssets with potentially additional properties. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(InteractedAsset) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/language_server_protocol.py b/src/pieces_os_client/models/language_server_protocol.py index e7938e6..3f335c1 100644 --- a/src/pieces_os_client/models/language_server_protocol.py +++ b/src/pieces_os_client/models/language_server_protocol.py @@ -28,7 +28,7 @@ class LanguageServerProtocol(BaseModel): """ TODO # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") diagnostics: Optional[LanguageServerProtocolDiagnostics] = None __properties = ["schema", "diagnostics"] diff --git a/src/pieces_os_client/models/language_server_protocol_code.py b/src/pieces_os_client/models/language_server_protocol_code.py index fe71589..d0645cc 100644 --- a/src/pieces_os_client/models/language_server_protocol_code.py +++ b/src/pieces_os_client/models/language_server_protocol_code.py @@ -27,10 +27,10 @@ class LanguageServerProtocolCode(BaseModel): """ NOTE: this can me a union type here.. (integer | string;) so we need to get a bit creative # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code_integer: Optional[StrictInt] = None code_string: Optional[StrictStr] = None - raw_json: Optional[Dict[str, StrictStr]] = Field(None, description="This is a Map, basically just a json object for additional data if int/string will not work") + raw_json: Optional[Dict[str, StrictStr]] = Field(default=None, description="This is a Map, basically just a json object for additional data if int/string will not work") __properties = ["schema", "code_integer", "code_string", "raw_json"] class Config: diff --git a/src/pieces_os_client/models/language_server_protocol_code_description.py b/src/pieces_os_client/models/language_server_protocol_code_description.py index 4bcb839..28dd58f 100644 --- a/src/pieces_os_client/models/language_server_protocol_code_description.py +++ b/src/pieces_os_client/models/language_server_protocol_code_description.py @@ -27,7 +27,7 @@ class LanguageServerProtocolCodeDescription(BaseModel): """ modeled off of (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#codeDescription) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") href: StrictStr = Field(...) __properties = ["schema", "href"] diff --git a/src/pieces_os_client/models/language_server_protocol_diagnostic.py b/src/pieces_os_client/models/language_server_protocol_diagnostic.py index 118fdf3..808d07e 100644 --- a/src/pieces_os_client/models/language_server_protocol_diagnostic.py +++ b/src/pieces_os_client/models/language_server_protocol_diagnostic.py @@ -31,11 +31,11 @@ class LanguageServerProtocolDiagnostic(BaseModel): """ TODO # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") range: LanguageServerProtocolLocationRange = Field(...) severity: Optional[LanguageServerProtocolSeverityEnum] = None code: Optional[LanguageServerProtocolCode] = None - code_description: Optional[LanguageServerProtocolCodeDescription] = Field(None, alias="codeDescription") + code_description: Optional[LanguageServerProtocolCodeDescription] = Field(default=None, alias="codeDescription") source: Optional[StrictStr] = None message: StrictStr = Field(...) __properties = ["schema", "range", "severity", "code", "codeDescription", "source", "message"] diff --git a/src/pieces_os_client/models/language_server_protocol_diagnostics.py b/src/pieces_os_client/models/language_server_protocol_diagnostics.py index 09c0a91..8ab39ca 100644 --- a/src/pieces_os_client/models/language_server_protocol_diagnostics.py +++ b/src/pieces_os_client/models/language_server_protocol_diagnostics.py @@ -28,7 +28,7 @@ class LanguageServerProtocolDiagnostics(BaseModel): """ TODO # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(LanguageServerProtocolDiagnostic) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/language_server_protocol_location.py b/src/pieces_os_client/models/language_server_protocol_location.py index cd5b630..4fb9288 100644 --- a/src/pieces_os_client/models/language_server_protocol_location.py +++ b/src/pieces_os_client/models/language_server_protocol_location.py @@ -28,7 +28,7 @@ class LanguageServerProtocolLocation(BaseModel): """ modeled after this (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#location) uri: is jsut a file path range: here is the location of where this item is within the file. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") uri: StrictStr = Field(...) range: LanguageServerProtocolLocationRange = Field(...) __properties = ["schema", "uri", "range"] diff --git a/src/pieces_os_client/models/language_server_protocol_location_range.py b/src/pieces_os_client/models/language_server_protocol_location_range.py index 2e21ee6..089c085 100644 --- a/src/pieces_os_client/models/language_server_protocol_location_range.py +++ b/src/pieces_os_client/models/language_server_protocol_location_range.py @@ -28,7 +28,7 @@ class LanguageServerProtocolLocationRange(BaseModel): """ modeled after this (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#range) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") start: LanguageServerProtocolLocationRangePosition = Field(...) end: LanguageServerProtocolLocationRangePosition = Field(...) __properties = ["schema", "start", "end"] diff --git a/src/pieces_os_client/models/language_server_protocol_location_range_position.py b/src/pieces_os_client/models/language_server_protocol_location_range_position.py index 051d270..87d4fcf 100644 --- a/src/pieces_os_client/models/language_server_protocol_location_range_position.py +++ b/src/pieces_os_client/models/language_server_protocol_location_range_position.py @@ -27,7 +27,7 @@ class LanguageServerProtocolLocationRangePosition(BaseModel): """ modeled after this (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") line: StrictInt = Field(...) character: StrictInt = Field(...) __properties = ["schema", "line", "character"] diff --git a/src/pieces_os_client/models/linkify.py b/src/pieces_os_client/models/linkify.py index 56981dd..b2c839b 100644 --- a/src/pieces_os_client/models/linkify.py +++ b/src/pieces_os_client/models/linkify.py @@ -32,10 +32,10 @@ class Linkify(BaseModel): """ This is the incoming linkify model. if access is PRIVATE then please provide and array of users to enable the link for. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seed: Optional[Seed] = None asset: Optional[Asset] = None - users: Optional[conlist(SeededUser)] = Field(None, description="this is an array of users.") + users: Optional[conlist(SeededUser)] = Field(default=None, description="this is an array of users.") access: AccessEnum = Field(...) distributions: Optional[SeededDistributions] = None __properties = ["schema", "seed", "asset", "users", "access", "distributions"] diff --git a/src/pieces_os_client/models/linkify_multiple.py b/src/pieces_os_client/models/linkify_multiple.py index c997570..af635e4 100644 --- a/src/pieces_os_client/models/linkify_multiple.py +++ b/src/pieces_os_client/models/linkify_multiple.py @@ -29,11 +29,11 @@ class LinkifyMultiple(BaseModel): """ This is the incoming linkify model. if access is PRIVATE then please provide and array of users to enable the link for. Assumption, all assets are already backed up to the cloud. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - assets: conlist(StrictStr) = Field(..., description="This is an array or string that represents an already backed up asset. That will be added to a collection.") - users: Optional[conlist(SeededUser)] = Field(None, description="this is an array of users.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + assets: conlist(StrictStr) = Field(default=..., description="This is an array or string that represents an already backed up asset. That will be added to a collection.") + users: Optional[conlist(SeededUser)] = Field(default=None, description="this is an array of users.") access: AccessEnum = Field(...) - name: Optional[StrictStr] = Field(None, description="optionally can give the collection a name if you want.") + name: Optional[StrictStr] = Field(default=None, description="optionally can give the collection a name if you want.") __properties = ["schema", "assets", "users", "access", "name"] class Config: diff --git a/src/pieces_os_client/models/mailgun_distribution.py b/src/pieces_os_client/models/mailgun_distribution.py index 62249ed..6f1230e 100644 --- a/src/pieces_os_client/models/mailgun_distribution.py +++ b/src/pieces_os_client/models/mailgun_distribution.py @@ -28,7 +28,7 @@ class MailgunDistribution(BaseModel): """ This is a specific Distribution for mailgun specific information. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") recipients: Recipients = Field(...) __properties = ["schema", "recipients"] diff --git a/src/pieces_os_client/models/mailgun_metadata.py b/src/pieces_os_client/models/mailgun_metadata.py index b718bb8..ce0c0b4 100644 --- a/src/pieces_os_client/models/mailgun_metadata.py +++ b/src/pieces_os_client/models/mailgun_metadata.py @@ -27,8 +27,8 @@ class MailgunMetadata(BaseModel): """ TODO add additional properties. TODO eventually modify this model to look like the response from Mailgun. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - message_id: StrictStr = Field(..., alias="messageId", description="This is the id given to us from mailgun when the email was sent successfully.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + message_id: StrictStr = Field(default=..., alias="messageId", description="This is the id given to us from mailgun when the email was sent successfully.") __properties = ["schema", "messageId"] class Config: diff --git a/src/pieces_os_client/models/model.py b/src/pieces_os_client/models/model.py index b732456..657b138 100644 --- a/src/pieces_os_client/models/model.py +++ b/src/pieces_os_client/models/model.py @@ -34,27 +34,27 @@ class Model(BaseModel): """ This is a Machine Learning Model, that will give readable information about the Machine Learning Model Used. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="uuid ") - version: StrictStr = Field(..., description="this is a version of the model.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="uuid ") + version: StrictStr = Field(default=..., description="this is a version of the model.") created: GroupedTimestamp = Field(...) - name: StrictStr = Field(..., description="This is an Optional Name of the Model.") - description: Optional[StrictStr] = Field(None, description="An Optional Description of the model itself.") - cloud: StrictBool = Field(..., description="This will inform the user if this was a model that is hosted in the cloud") + name: StrictStr = Field(default=..., description="This is an Optional Name of the Model.") + description: Optional[StrictStr] = Field(default=None, description="An Optional Description of the model itself.") + cloud: StrictBool = Field(default=..., description="This will inform the user if this was a model that is hosted in the cloud") type: ModelTypeEnum = Field(...) usage: ModelUsageEnum = Field(...) bytes: Optional[ByteDescriptor] = None ram: Optional[ByteDescriptor] = None - quantization: Optional[StrictStr] = Field(None, description="quantization is a string like: q8f16_0, q4f16_1, etc...") + quantization: Optional[StrictStr] = Field(default=None, description="quantization is a string like: q8f16_0, q4f16_1, etc...") foundation: Optional[ModelFoundationEnum] = None - downloaded: Optional[StrictBool] = Field(None, description="This is an optional bool to let us know if this model has been downloaded locally.") - loaded: Optional[StrictBool] = Field(None, description="This is a boolean that represents if the model is loaded into memory.(this is not persisted, and is calculated on the fly.)") - unique: Optional[StrictStr] = Field(None, description="This is the unique model name used to load the model.") - parameters: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="This is the number of parameters in terms of billions.") + downloaded: Optional[StrictBool] = Field(default=None, description="This is an optional bool to let us know if this model has been downloaded locally.") + loaded: Optional[StrictBool] = Field(default=None, description="This is a boolean that represents if the model is loaded into memory.(this is not persisted, and is calculated on the fly.)") + unique: Optional[StrictStr] = Field(default=None, description="This is the unique model name used to load the model.") + parameters: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="This is the number of parameters in terms of billions.") provider: Optional[ExternalMLProviderEnum] = None - cpu: Optional[StrictBool] = Field(None, description="This is an optional bool that is optimized for CPU usage.") - downloading: Optional[StrictBool] = Field(None, description="This is a calculated property, that will say if this is currently downloading.") - max_tokens: Optional[ModelMaxTokens] = Field(None, alias="maxTokens") + cpu: Optional[StrictBool] = Field(default=None, description="This is an optional bool that is optimized for CPU usage.") + downloading: Optional[StrictBool] = Field(default=None, description="This is a calculated property, that will say if this is currently downloading.") + max_tokens: Optional[ModelMaxTokens] = Field(default=None, alias="maxTokens") custom: Optional[StrictBool] = None __properties = ["schema", "id", "version", "created", "name", "description", "cloud", "type", "usage", "bytes", "ram", "quantization", "foundation", "downloaded", "loaded", "unique", "parameters", "provider", "cpu", "downloading", "maxTokens", "custom"] diff --git a/src/pieces_os_client/models/model_delete_cache_input.py b/src/pieces_os_client/models/model_delete_cache_input.py index 4b8fe53..2aedea1 100644 --- a/src/pieces_os_client/models/model_delete_cache_input.py +++ b/src/pieces_os_client/models/model_delete_cache_input.py @@ -27,7 +27,7 @@ class ModelDeleteCacheInput(BaseModel): """ This is the input model for '/model/{model}/delete/cache' # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/model_delete_cache_output.py b/src/pieces_os_client/models/model_delete_cache_output.py index 771f79c..316c5d9 100644 --- a/src/pieces_os_client/models/model_delete_cache_output.py +++ b/src/pieces_os_client/models/model_delete_cache_output.py @@ -28,7 +28,7 @@ class ModelDeleteCacheOutput(BaseModel): """ This is the output model for '/model/{model}/delete/cache' # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") model: ReferencedModel = Field(...) __properties = ["schema", "model"] diff --git a/src/pieces_os_client/models/model_download_progress.py b/src/pieces_os_client/models/model_download_progress.py index f067658..a40a18d 100644 --- a/src/pieces_os_client/models/model_download_progress.py +++ b/src/pieces_os_client/models/model_download_progress.py @@ -28,9 +28,9 @@ class ModelDownloadProgress(BaseModel): """ This is the model that is sent over our ws for streaming the progress of a model that is being downloaded. can eventually add a number that display the percent downloaded an so on.(this is called percent 0-100) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") status: Optional[ModelDownloadProgressStatusEnum] = None - percentage: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Optionally if the download is in progress you will recieve a download percent(from 0-100).") + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the download is in progress you will recieve a download percent(from 0-100).") __properties = ["schema", "status", "percentage"] class Config: diff --git a/src/pieces_os_client/models/model_foundation_enum.py b/src/pieces_os_client/models/model_foundation_enum.py index 43344f5..ca3bc24 100644 --- a/src/pieces_os_client/models/model_foundation_enum.py +++ b/src/pieces_os_client/models/model_foundation_enum.py @@ -24,7 +24,7 @@ class ModelFoundationEnum(str, Enum): """ - This is used to describe the foundational models used within POS. + This is used to describe the foundational models used within POS. Note: LATEST models could be used as the latests of these and then could use a system to either(check a file) or we could add and endpoint to click out to the cloud to get the latest models and update these locally so that our users can always have the latest without having to update the application.(not used for now) """ """ @@ -37,7 +37,6 @@ class ModelFoundationEnum(str, Enum): LLAMA_2_13_B = 'LLAMA_2_13B' LLAMA_2_70_B = 'LLAMA_2_70B' LLAMA_3_2_B = 'LLAMA_3_2B' - LLAMA_3_7_B = 'LLAMA_3_7B' LLAMA_3_13_B = 'LLAMA_3_13B' LLAMA_3_70_B = 'LLAMA_3_70B' CODE_LLAMA_2_7_B = 'CODE_LLAMA_2_7B' @@ -129,6 +128,25 @@ class ModelFoundationEnum(str, Enum): COMMAND_R_PLUS = 'COMMAND_R+' GEMMA_1_DOT_1_2_B = 'GEMMA_1.1_2B' GEMMA_1_DOT_1_7_B = 'GEMMA_1.1_7B' + GEMMA_2_9_B = 'GEMMA_2_9B' + PHI_3_MINI = 'PHI_3_MINI' + PHI_3_SMALL = 'PHI_3_SMALL' + GRANITE_3_B = 'GRANITE_3B' + GRANITE_8_B = 'GRANITE_8B' + LLAMA_3_8_B = 'LLAMA_3_8B' + CLAUDE_3_DOT_5 = 'CLAUDE_3.5' + CLAUDE_LATEST = 'CLAUDE_LATEST' + GRANITE_LATEST = 'GRANITE_LATEST' + LLAMA_LATEST = 'LLAMA_LATEST' + PHI_LATEST = 'PHI_LATEST' + GEMMA_LATEST = 'GEMMA_LATEST' + GEMINI_LATEST = 'GEMINI_LATEST' + GPT_LATEST = 'GPT_LATEST' + AZURE_LATEST = 'AZURE_LATEST' + AZURE_FAST = 'AZURE_FAST' + AZURE_BEST = 'AZURE_BEST' + AZURE_DEFAULT = 'AZURE_DEFAULT' + AZURE_CUSTOM = 'AZURE_CUSTOM' @classmethod def from_json(cls, json_str: str) -> ModelFoundationEnum: diff --git a/src/pieces_os_client/models/model_max_tokens.py b/src/pieces_os_client/models/model_max_tokens.py index 75af1f8..8682ad9 100644 --- a/src/pieces_os_client/models/model_max_tokens.py +++ b/src/pieces_os_client/models/model_max_tokens.py @@ -27,7 +27,7 @@ class ModelMaxTokens(BaseModel): """ This will describe the MaxTokens for an MLModel total is required. iff there is a differentiator with inputs/outputs, then we can also provide those as well. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") total: Optional[Union[StrictFloat, StrictInt]] = Field(...) input: Optional[Union[StrictFloat, StrictInt]] = None output: Optional[Union[StrictFloat, StrictInt]] = None diff --git a/src/pieces_os_client/models/model_usage_enum.py b/src/pieces_os_client/models/model_usage_enum.py index b475aee..35ffbea 100644 --- a/src/pieces_os_client/models/model_usage_enum.py +++ b/src/pieces_os_client/models/model_usage_enum.py @@ -51,6 +51,7 @@ class ModelUsageEnum(str, Enum): VIDEO_OCR = 'VIDEO_OCR' TEXT_VS_CODE_SEGMENTATION = 'TEXT_VS_CODE_SEGMENTATION' TEXT_EMBEDDING = 'TEXT_EMBEDDING' + TECHNICAL_ERROR = 'TECHNICAL_ERROR' @classmethod def from_json(cls, json_str: str) -> ModelUsageEnum: diff --git a/src/pieces_os_client/models/models.py b/src/pieces_os_client/models/models.py index 3937969..9bdebd6 100644 --- a/src/pieces_os_client/models/models.py +++ b/src/pieces_os_client/models/models.py @@ -28,7 +28,7 @@ class Models(BaseModel): """ This is a List of MachineLearning Models # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Model) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/node.py b/src/pieces_os_client/models/node.py index a6c3901..e1a6357 100644 --- a/src/pieces_os_client/models/node.py +++ b/src/pieces_os_client/models/node.py @@ -30,7 +30,7 @@ class Node(BaseModel): """ id: StrictStr = Field(...) type: NodeTypeEnum = Field(...) - root: StrictBool = Field(..., description="This is a boolean to let us know if this node is the root or origin of the relationship graph.") + root: StrictBool = Field(default=..., description="This is a boolean to let us know if this node is the root or origin of the relationship graph.") created: GroupedTimestamp = Field(...) __properties = ["id", "type", "root", "created"] diff --git a/src/pieces_os_client/models/notification.py b/src/pieces_os_client/models/notification.py index 644af4c..4fafe46 100644 --- a/src/pieces_os_client/models/notification.py +++ b/src/pieces_os_client/models/notification.py @@ -27,7 +27,7 @@ class Notification(BaseModel): """ config model for notification invoking # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictInt = Field(...) title: Optional[StrictStr] = None message: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/o_auth_account.py b/src/pieces_os_client/models/o_auth_account.py index 8901845..0ea75df 100644 --- a/src/pieces_os_client/models/o_auth_account.py +++ b/src/pieces_os_client/models/o_auth_account.py @@ -26,15 +26,15 @@ class OAuthAccount(BaseModel): """ A Model to support account creation to Auth0's Database. # noqa: E501 """ - client_id: constr(strict=True, min_length=1) = Field(..., description="The client_id of your client.") - email: constr(strict=True, min_length=1) = Field(..., description="The user's email address.") - connection: constr(strict=True, min_length=1) = Field(..., description="The name of the database configured to your client.") - username: constr(strict=True, min_length=1) = Field(..., description="The user's username. Only valid if the connection requires a username.") - given_name: constr(strict=True, min_length=1) = Field(..., description="The user's given name(s).") - family_name: constr(strict=True, min_length=1) = Field(..., description="The user's family name(s).") - name: constr(strict=True, min_length=1) = Field(..., description="The user's full name.") - picture: constr(strict=True, min_length=1) = Field(..., description="A URI pointing to the user's picture.") - nickname: constr(strict=True, min_length=1) = Field(..., description="The user's nickname.") + client_id: constr(strict=True, min_length=1) = Field(default=..., description="The client_id of your client.") + email: constr(strict=True, min_length=1) = Field(default=..., description="The user's email address.") + connection: constr(strict=True, min_length=1) = Field(default=..., description="The name of the database configured to your client.") + username: constr(strict=True, min_length=1) = Field(default=..., description="The user's username. Only valid if the connection requires a username.") + given_name: constr(strict=True, min_length=1) = Field(default=..., description="The user's given name(s).") + family_name: constr(strict=True, min_length=1) = Field(default=..., description="The user's family name(s).") + name: constr(strict=True, min_length=1) = Field(default=..., description="The user's full name.") + picture: constr(strict=True, min_length=1) = Field(default=..., description="A URI pointing to the user's picture.") + nickname: constr(strict=True, min_length=1) = Field(default=..., description="The user's nickname.") __properties = ["client_id", "email", "connection", "username", "given_name", "family_name", "name", "picture", "nickname"] class Config: diff --git a/src/pieces_os_client/models/o_auth_token.py b/src/pieces_os_client/models/o_auth_token.py index c47eb35..0afeaae 100644 --- a/src/pieces_os_client/models/o_auth_token.py +++ b/src/pieces_os_client/models/o_auth_token.py @@ -27,8 +27,8 @@ class OAuthToken(BaseModel): """ A model representing a returnable response for a OAuthGroup Token # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - access_token: StrictStr = Field(..., description="The Access Token") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + access_token: StrictStr = Field(default=..., description="The Access Token") token_type: StrictStr = Field(...) expires_in: StrictInt = Field(...) scope: StrictStr = Field(...) diff --git a/src/pieces_os_client/models/ocr_analyses.py b/src/pieces_os_client/models/ocr_analyses.py index 9bb702c..8bad0c6 100644 --- a/src/pieces_os_client/models/ocr_analyses.py +++ b/src/pieces_os_client/models/ocr_analyses.py @@ -28,7 +28,7 @@ class OCRAnalyses(BaseModel): """ OCRAnalyses """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(OCRAnalysis) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/ocr_analysis.py b/src/pieces_os_client/models/ocr_analysis.py index 0f5628f..0b39fa4 100644 --- a/src/pieces_os_client/models/ocr_analysis.py +++ b/src/pieces_os_client/models/ocr_analysis.py @@ -28,11 +28,11 @@ class OCRAnalysis(BaseModel): """ This is the data collected during the ocr analysis of an image. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) raw: Format = Field(...) hocr: Format = Field(...) - image: StrictStr = Field(..., description="this is a reference the the imageAnalysis.") + image: StrictStr = Field(default=..., description="this is a reference the the imageAnalysis.") model: Model = Field(...) __properties = ["schema", "id", "raw", "hocr", "image", "model"] diff --git a/src/pieces_os_client/models/onboarded_persona_details.py b/src/pieces_os_client/models/onboarded_persona_details.py index 633582a..f276feb 100644 --- a/src/pieces_os_client/models/onboarded_persona_details.py +++ b/src/pieces_os_client/models/onboarded_persona_details.py @@ -28,7 +28,7 @@ class OnboardedPersonaDetails(BaseModel): """ This is an out body for the /machine_learning/text/technical_processing/generators/personification endpoint. This will have accepted some of the personal details (in the input body) ie languages/personas && will transform this in to onbaording snippets that we will return with this model # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seeds: Seeds = Field(...) __properties = ["schema", "seeds"] diff --git a/src/pieces_os_client/models/open_ai_models_list_input.py b/src/pieces_os_client/models/open_ai_models_list_input.py index fe34dc0..b2bbe65 100644 --- a/src/pieces_os_client/models/open_ai_models_list_input.py +++ b/src/pieces_os_client/models/open_ai_models_list_input.py @@ -27,7 +27,7 @@ class OpenAIModelsListInput(BaseModel): """ This is the input model for the /open_ai/models/list endpoint. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") user: StrictStr = Field(...) __properties = ["schema", "user"] diff --git a/src/pieces_os_client/models/open_ai_models_list_output.py b/src/pieces_os_client/models/open_ai_models_list_output.py index 7058338..cf2abbb 100644 --- a/src/pieces_os_client/models/open_ai_models_list_output.py +++ b/src/pieces_os_client/models/open_ai_models_list_output.py @@ -28,7 +28,7 @@ class OpenAIModelsListOutput(BaseModel): """ This is the output model for the /open_ai/models/list endpoint. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") models: SeededModels = Field(...) __properties = ["schema", "models"] diff --git a/src/pieces_os_client/models/ordered_metrics.py b/src/pieces_os_client/models/ordered_metrics.py index 04de65d..eeaca91 100644 --- a/src/pieces_os_client/models/ordered_metrics.py +++ b/src/pieces_os_client/models/ordered_metrics.py @@ -27,7 +27,7 @@ class OrderedMetrics(BaseModel): """ This is a returnable for the metrics/formats/ordered # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ordered: conlist(StrictStr) = Field(...) __properties = ["schema", "ordered"] diff --git a/src/pieces_os_client/models/os_applet_enum.py b/src/pieces_os_client/models/os_applet_enum.py new file mode 100644 index 0000000..f3e2f79 --- /dev/null +++ b/src/pieces_os_client/models/os_applet_enum.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import json +import pprint +import re # noqa: F401 +from aenum import Enum, no_arg + + + + + +class OSAppletEnum(str, Enum): + """ + This is an enum specifically for the different types of micro_applications/experiences/feature module NOTE: TODO copilot_wasm or copilot_minimal NOTE: WORKSTREAM_ACTIVITY and WORKFLOW_ACTIVITY might be diff in the future(workflow is what we have today, workstream will be a v2) NOTE: PLACEHOLDERS here are here to buy some additional changes for enums that dont yet exist(JIC) if not used, then not used. + """ + + """ + allowed enum values + """ + COPILOT = 'COPILOT' + PIECES_OS_TOOLBAR = 'PIECES_OS_TOOLBAR' + WORKSTREAM_SUGGESTIONS = 'WORKSTREAM_SUGGESTIONS' + SAVED_MATERIALS = 'SAVED_MATERIALS' + WORKFLOW_ACTIVITY = 'WORKFLOW_ACTIVITY' + WORKSTREAM_ACTIVITY = 'WORKSTREAM_ACTIVITY' + GLOBAL_SEARCH = 'GLOBAL_SEARCH' + PIECES_SUITE_SETTINGS_AND_INTEGRATIONS_MANAGER = 'PIECES_SUITE_SETTINGS_AND_INTEGRATIONS_MANAGER' + CAPTURED_CONTEXT = 'CAPTURED_CONTEXT' + UPDATES_AND_UPCOMING = 'UPDATES_AND_UPCOMING' + NOTIFICATIONS_MANAGER = 'NOTIFICATIONS_MANAGER' + SHAREBLE_LINK_VIEWER = 'SHAREBLE_LINK_VIEWER' + FUTURE_APPLET_MODULE_PLACEHOLDER_A = 'FUTURE_APPLET_MODULE_PLACEHOLDER_A' + FUTURE_APPLET_MODULE_PLACEHOLDER_B = 'FUTURE_APPLET_MODULE_PLACEHOLDER_B' + FUTURE_APPLET_MODULE_PLACEHOLDER_C = 'FUTURE_APPLET_MODULE_PLACEHOLDER_C' + UNKNOWN_APPLET_MODULE = 'UNKNOWN_APPLET_MODULE' + + @classmethod + def from_json(cls, json_str: str) -> OSAppletEnum: + """Create an instance of OSAppletEnum from a JSON string""" + return OSAppletEnum(json.loads(json_str)) + + diff --git a/src/pieces_os_client/models/os_device_cpu_hardware_information.py b/src/pieces_os_client/models/os_device_cpu_hardware_information.py index 4754853..dc8668c 100644 --- a/src/pieces_os_client/models/os_device_cpu_hardware_information.py +++ b/src/pieces_os_client/models/os_device_cpu_hardware_information.py @@ -27,7 +27,7 @@ class OSDeviceCPUHardwareInformation(BaseModel): """ This will let us know specific hardware information related to the CPU. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") name: Optional[StrictStr] = None memory: Optional[Union[StrictFloat, StrictInt]] = None __properties = ["schema", "name", "memory"] diff --git a/src/pieces_os_client/models/os_device_dependencies_information.py b/src/pieces_os_client/models/os_device_dependencies_information.py index 67deb6b..91e1066 100644 --- a/src/pieces_os_client/models/os_device_dependencies_information.py +++ b/src/pieces_os_client/models/os_device_dependencies_information.py @@ -27,8 +27,8 @@ class OSDeviceDependenciesInformation(BaseModel): """ This will lets us know about specific dependencies that we are looking for on the device that are needed for specific tasks. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - vulkan: StrictBool = Field(..., description="This will let us know if vulkan is present = true or not there ==false") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + vulkan: StrictBool = Field(default=..., description="This will let us know if vulkan is present = true or not there ==false") __properties = ["schema", "vulkan"] class Config: diff --git a/src/pieces_os_client/models/os_device_gpu_hardware_capabilities_information.py b/src/pieces_os_client/models/os_device_gpu_hardware_capabilities_information.py index 273c57c..34bc8b8 100644 --- a/src/pieces_os_client/models/os_device_gpu_hardware_capabilities_information.py +++ b/src/pieces_os_client/models/os_device_gpu_hardware_capabilities_information.py @@ -27,8 +27,8 @@ class OSDeviceGPUHardwareCapabilitiesInformation(BaseModel): """ This will give specific information on task specific capibilites for GPU. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - llm: Optional[StrictBool] = Field(None, description="This will let us know if in the case we have a gpu and our gpu has the capabilities to use llms") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + llm: Optional[StrictBool] = Field(default=None, description="This will let us know if in the case we have a gpu and our gpu has the capabilities to use llms") __properties = ["schema", "llm"] class Config: diff --git a/src/pieces_os_client/models/os_device_gpu_hardware_information.py b/src/pieces_os_client/models/os_device_gpu_hardware_information.py index 7da6b78..d6e337a 100644 --- a/src/pieces_os_client/models/os_device_gpu_hardware_information.py +++ b/src/pieces_os_client/models/os_device_gpu_hardware_information.py @@ -28,7 +28,7 @@ class OSDeviceGPUHardwareInformation(BaseModel): """ This will let us know specific hardware information related to the GPU. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") name: Optional[StrictStr] = None memory: Optional[Union[StrictFloat, StrictInt]] = None capabilities: Optional[OSDeviceGPUHardwareCapabilitiesInformation] = None diff --git a/src/pieces_os_client/models/os_device_hardware_information.py b/src/pieces_os_client/models/os_device_hardware_information.py index d1db87f..32b6284 100644 --- a/src/pieces_os_client/models/os_device_hardware_information.py +++ b/src/pieces_os_client/models/os_device_hardware_information.py @@ -29,7 +29,7 @@ class OSDeviceHardwareInformation(BaseModel): """ this will let us know specific hardware information # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") cpu: Optional[OSDeviceCPUHardwareInformation] = None gpu: Optional[OSDeviceGPUHardwareInformation] = None __properties = ["schema", "cpu", "gpu"] diff --git a/src/pieces_os_client/models/os_device_information_returnable.py b/src/pieces_os_client/models/os_device_information_returnable.py index 4409f99..1128b2f 100644 --- a/src/pieces_os_client/models/os_device_information_returnable.py +++ b/src/pieces_os_client/models/os_device_information_returnable.py @@ -29,10 +29,10 @@ class OSDeviceInformationReturnable(BaseModel): """ This is the returnable model for the /os/device/information. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") dependencies: Optional[OSDeviceDependenciesInformation] = None - name: Optional[StrictStr] = Field(None, description="this is the name of the device") - version: Optional[StrictStr] = Field(None, description="this is the version of the device") + name: Optional[StrictStr] = Field(default=None, description="this is the name of the device") + version: Optional[StrictStr] = Field(default=None, description="this is the version of the device") hardware: Optional[OSDeviceHardwareInformation] = None __properties = ["schema", "dependencies", "name", "version", "hardware"] diff --git a/src/pieces_os_client/models/os_file_read_streamed_progress.py b/src/pieces_os_client/models/os_file_read_streamed_progress.py new file mode 100644 index 0000000..0ce8e75 --- /dev/null +++ b/src/pieces_os_client/models/os_file_read_streamed_progress.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.model_download_progress_status_enum import ModelDownloadProgressStatusEnum +from pieces_os_client.models.transferable_bytes import TransferableBytes +from typing import Optional, Set +from typing_extensions import Self + +class OSFileReadStreamedProgress(BaseModel): + """ + This is a model to return stream progress for a file read. + """ # noqa: E501 + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + status: ModelDownloadProgressStatusEnum + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the download is in progress you will receive a download percent(from 0-100).") + path: StrictStr + id: StrictStr = Field(description="This is a generated UUID that represents this current stream in progress(can be used to cancel this in the future)") + bytes: Optional[TransferableBytes] = None + __properties: ClassVar[List[str]] = ["schema", "status", "percentage", "path", "id", "bytes"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OSFileReadStreamedProgress from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of bytes + if self.bytes: + _dict['bytes'] = self.bytes.to_dict() + # set to None if percentage (nullable) is None + # and model_fields_set contains the field + if self.percentage is None and "percentage" in self.model_fields_set: + _dict['percentage'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OSFileReadStreamedProgress from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "schema": EmbeddedModelSchema.from_dict(obj["schema"]) if obj.get("schema") is not None else None, + "status": obj.get("status"), + "percentage": obj.get("percentage"), + "path": obj.get("path"), + "id": obj.get("id"), + "bytes": TransferableBytes.from_dict(obj["bytes"]) if obj.get("bytes") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_file_streaming_read.py b/src/pieces_os_client/models/os_file_streaming_read.py new file mode 100644 index 0000000..a9eda70 --- /dev/null +++ b/src/pieces_os_client/models/os_file_streaming_read.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.model_download_progress_status_enum import ModelDownloadProgressStatusEnum +from pieces_os_client.models.os_file_streaming_read_progress import OSFileStreamingReadProgress +from pieces_os_client.models.transferable_bytes import TransferableBytes + +class OSFileStreamingRead(BaseModel): + """ + This is a model to return stream progress for a file read. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + status: ModelDownloadProgressStatusEnum = Field(...) + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the download is in progress you will receive a download percent(from 0-100).") + path: StrictStr = Field(...) + id: StrictStr = Field(default=..., description="This is a generated UUID that represents this current stream in progress(can be used to cancel this in the future)") + bytes: Optional[TransferableBytes] = None + progress: Optional[OSFileStreamingReadProgress] = None + __properties = ["schema", "status", "percentage", "path", "id", "bytes", "progress"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSFileStreamingRead: + """Create an instance of OSFileStreamingRead from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of bytes + if self.bytes: + _dict['bytes'] = self.bytes.to_dict() + # override the default output from pydantic by calling `to_dict()` of progress + if self.progress: + _dict['progress'] = self.progress.to_dict() + # set to None if percentage (nullable) is None + # and __fields_set__ contains the field + if self.percentage is None and "percentage" in self.__fields_set__: + _dict['percentage'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSFileStreamingRead: + """Create an instance of OSFileStreamingRead from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSFileStreamingRead.parse_obj(obj) + + _obj = OSFileStreamingRead.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "status": obj.get("status"), + "percentage": obj.get("percentage"), + "path": obj.get("path"), + "id": obj.get("id"), + "bytes": TransferableBytes.from_dict(obj.get("bytes")) if obj.get("bytes") is not None else None, + "progress": OSFileStreamingReadProgress.from_dict(obj.get("progress")) if obj.get("progress") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_file_streaming_read_attempt.py b/src/pieces_os_client/models/os_file_streaming_read_attempt.py new file mode 100644 index 0000000..83349d0 --- /dev/null +++ b/src/pieces_os_client/models/os_file_streaming_read_attempt.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class OSFileStreamingReadAttempt(BaseModel): + """ + OSFileStreamingReadAttempt + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + path: StrictStr = Field(...) + __properties = ["schema", "path"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSFileStreamingReadAttempt: + """Create an instance of OSFileStreamingReadAttempt from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSFileStreamingReadAttempt: + """Create an instance of OSFileStreamingReadAttempt from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSFileStreamingReadAttempt.parse_obj(obj) + + _obj = OSFileStreamingReadAttempt.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "path": obj.get("path") + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_file_streaming_read_progress.py b/src/pieces_os_client/models/os_file_streaming_read_progress.py new file mode 100644 index 0000000..e3b7c9a --- /dev/null +++ b/src/pieces_os_client/models/os_file_streaming_read_progress.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.byte_descriptor import ByteDescriptor +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class OSFileStreamingReadProgress(BaseModel): + """ + This is the progress for the OSFileStreamingRead # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + total: ByteDescriptor = Field(...) + transferred: ByteDescriptor = Field(...) + __properties = ["schema", "total", "transferred"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSFileStreamingReadProgress: + """Create an instance of OSFileStreamingReadProgress from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of total + if self.total: + _dict['total'] = self.total.to_dict() + # override the default output from pydantic by calling `to_dict()` of transferred + if self.transferred: + _dict['transferred'] = self.transferred.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSFileStreamingReadProgress: + """Create an instance of OSFileStreamingReadProgress from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSFileStreamingReadProgress.parse_obj(obj) + + _obj = OSFileStreamingReadProgress.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "total": ByteDescriptor.from_dict(obj.get("total")) if obj.get("total") is not None else None, + "transferred": ByteDescriptor.from_dict(obj.get("transferred")) if obj.get("transferred") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_health.py b/src/pieces_os_client/models/os_health.py index 8ec3914..27a479d 100644 --- a/src/pieces_os_client/models/os_health.py +++ b/src/pieces_os_client/models/os_health.py @@ -27,9 +27,9 @@ class OSHealth(BaseModel): """ This is a specific model for the health of our OS Server. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="id of your OS") - version: StrictStr = Field(..., description="this is the current OS version") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="id of your OS") + version: StrictStr = Field(default=..., description="this is the current OS version") __properties = ["schema", "id", "version"] class Config: diff --git a/src/pieces_os_client/models/os_permissions.py b/src/pieces_os_client/models/os_permissions.py index f60246a..d6b786b 100644 --- a/src/pieces_os_client/models/os_permissions.py +++ b/src/pieces_os_client/models/os_permissions.py @@ -28,7 +28,7 @@ class OSPermissions(BaseModel): """ This will return the permission of this specific operating system w/ relation to given features. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") processing: Optional[OSProcessingPermissions] = None __properties = ["schema", "processing"] diff --git a/src/pieces_os_client/models/os_processing_permissions.py b/src/pieces_os_client/models/os_processing_permissions.py index e9bedaa..d3f5f1f 100644 --- a/src/pieces_os_client/models/os_processing_permissions.py +++ b/src/pieces_os_client/models/os_processing_permissions.py @@ -27,9 +27,9 @@ class OSProcessingPermissions(BaseModel): """ These are the permissions relating to the vision models. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - vision: Optional[StrictBool] = Field(None, description="if true it is granted, if not then it is not granted.") - accessibility: Optional[StrictBool] = Field(None, description="if true it is granted, if not then it is not granted.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + vision: Optional[StrictBool] = Field(default=None, description="if true it is granted, if not then it is not granted.") + accessibility: Optional[StrictBool] = Field(default=None, description="if true it is granted, if not then it is not granted.") __properties = ["schema", "vision", "accessibility"] class Config: diff --git a/src/pieces_os_client/models/os_server_metadata.py b/src/pieces_os_client/models/os_server_metadata.py new file mode 100644 index 0000000..878aa50 --- /dev/null +++ b/src/pieces_os_client/models/os_server_metadata.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.tracked_summary_totals import TrackedSummaryTotals + +class OSServerMetadata(BaseModel): + """ + This will return metadata (total materials) in your pieces drive. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + totals: Optional[TrackedSummaryTotals] = None + __properties = ["schema", "totals"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSServerMetadata: + """Create an instance of OSServerMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of totals + if self.totals: + _dict['totals'] = self.totals.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSServerMetadata: + """Create an instance of OSServerMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSServerMetadata.parse_obj(obj) + + _obj = OSServerMetadata.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "totals": TrackedSummaryTotals.from_dict(obj.get("totals")) if obj.get("totals") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_server_settings.py b/src/pieces_os_client/models/os_server_settings.py new file mode 100644 index 0000000..477b3cf --- /dev/null +++ b/src/pieces_os_client/models/os_server_settings.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictBool +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class OSServerSettings(BaseModel): + """ + This is the model for the PiecesOS specific settings. autoboot: refers to both the bootup of POS on the system login, default is false # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + autoboot: Optional[StrictBool] = None + __properties = ["schema", "autoboot"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSServerSettings: + """Create an instance of OSServerSettings from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSServerSettings: + """Create an instance of OSServerSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSServerSettings.parse_obj(obj) + + _obj = OSServerSettings.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "autoboot": obj.get("autoboot") + }) + return _obj + + diff --git a/src/pieces_os_client/models/os_server_update_status.py b/src/pieces_os_client/models/os_server_update_status.py new file mode 100644 index 0000000..587fd9b --- /dev/null +++ b/src/pieces_os_client/models/os_server_update_status.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictFloat, StrictInt +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.grouped_timestamp import GroupedTimestamp +from pieces_os_client.models.updating_status_enum import UpdatingStatusEnum + +class OSServerUpdateStatus(BaseModel): + """ + This is the model for the progress of the current update of Pieces os. /os/update/check/stream && /os/update/check/ we will emit on a progress update updated: is an optional property that will let us know when the update was checked last. NOTE: it is reccommended to use the stream instead of pulling. NOTE: lets think about if we want to have a closing(as well as how we want to handle restarts) # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + status: UpdatingStatusEnum = Field(...) + updated: Optional[GroupedTimestamp] = None + percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optionally if the update is in progress you will recieve a download percent(from 0-100).") + __properties = ["schema", "status", "updated", "percentage"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> OSServerUpdateStatus: + """Create an instance of OSServerUpdateStatus from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of updated + if self.updated: + _dict['updated'] = self.updated.to_dict() + # set to None if percentage (nullable) is None + # and __fields_set__ contains the field + if self.percentage is None and "percentage" in self.__fields_set__: + _dict['percentage'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> OSServerUpdateStatus: + """Create an instance of OSServerUpdateStatus from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return OSServerUpdateStatus.parse_obj(obj) + + _obj = OSServerUpdateStatus.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "status": obj.get("status"), + "updated": GroupedTimestamp.from_dict(obj.get("updated")) if obj.get("updated") is not None else None, + "percentage": obj.get("percentage") + }) + return _obj + + diff --git a/src/pieces_os_client/models/person.py b/src/pieces_os_client/models/person.py index b6b7128..328cbc7 100644 --- a/src/pieces_os_client/models/person.py +++ b/src/pieces_os_client/models/person.py @@ -22,6 +22,7 @@ from typing import Dict, Optional from pydantic import BaseModel, Field, StrictInt, StrictStr from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_anchors import FlattenedAnchors from pieces_os_client.models.flattened_annotations import FlattenedAnnotations from pieces_os_client.models.flattened_assets import FlattenedAssets from pieces_os_client.models.flattened_tags import FlattenedTags @@ -38,23 +39,24 @@ class Person(BaseModel): """ if expiration is add then, after the alloted expiration date the user will only have view && comment only permissions. Only present in the case there is a scope such as a defined collection/asset... if asset is passed then that means this person belongs to a scoped asset. NOTE****: annotations here are annotations to describe the person!!! if in the future we want to add who wrote an annotation on and asset or soemthing like that, we will want to add a new field on here called authorships. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None type: PersonType = Field(...) assets: Optional[FlattenedAssets] = None - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") - access: Optional[Dict[str, PersonAccess]] = Field(None, description="This is a Map where the the key is an asset id.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + access: Optional[Dict[str, PersonAccess]] = Field(default=None, description="This is a Map where the the key is an asset id.") tags: Optional[FlattenedTags] = None websites: Optional[FlattenedWebsites] = None - models: Optional[Dict[str, PersonModel]] = Field(None, description="This is a Map, where the the key is an asset id.") + models: Optional[Dict[str, PersonModel]] = Field(default=None, description="This is a Map, where the the key is an asset id.") annotations: Optional[FlattenedAnnotations] = None score: Optional[Score] = None summaries: Optional[FlattenedWorkstreamSummaries] = None - __properties = ["schema", "id", "created", "updated", "deleted", "type", "assets", "mechanisms", "interactions", "access", "tags", "websites", "models", "annotations", "score", "summaries"] + anchors: Optional[FlattenedAnchors] = None + __properties = ["schema", "id", "created", "updated", "deleted", "type", "assets", "mechanisms", "interactions", "access", "tags", "websites", "models", "annotations", "score", "summaries", "anchors"] class Config: """Pydantic configuration""" @@ -127,6 +129,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of summaries if self.summaries: _dict['summaries'] = self.summaries.to_dict() + # override the default output from pydantic by calling `to_dict()` of anchors + if self.anchors: + _dict['anchors'] = self.anchors.to_dict() return _dict @classmethod @@ -164,7 +169,8 @@ def from_dict(cls, obj: dict) -> Person: else None, "annotations": FlattenedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, "score": Score.from_dict(obj.get("score")) if obj.get("score") is not None else None, - "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None + "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None, + "anchors": FlattenedAnchors.from_dict(obj.get("anchors")) if obj.get("anchors") is not None else None }) return _obj diff --git a/src/pieces_os_client/models/person_access.py b/src/pieces_os_client/models/person_access.py index 142cd88..16b8544 100644 --- a/src/pieces_os_client/models/person_access.py +++ b/src/pieces_os_client/models/person_access.py @@ -29,7 +29,7 @@ class PersonAccess(BaseModel): """ if scoped is provided will let us know what level of permission(access) this specific person has in relation to what scope.(collection, asset,...etc) in the future will expand to global (with its own enumeration for a global entire project/cloud scope) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") scoped: Optional[PersonAccessScopedEnum] = None deleted: Optional[GroupedTimestamp] = None __properties = ["schema", "scoped", "deleted"] diff --git a/src/pieces_os_client/models/person_basic_type.py b/src/pieces_os_client/models/person_basic_type.py index 1e760f7..49a2ea0 100644 --- a/src/pieces_os_client/models/person_basic_type.py +++ b/src/pieces_os_client/models/person_basic_type.py @@ -29,13 +29,13 @@ class PersonBasicType(BaseModel): """ This is all optional properties around the most basic information around a non-pieces user. A Basic type will NOT have a scope as it is not an actual pieces user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - username: Optional[StrictStr] = Field(None, description="username or twitter handle...etc") - name: Optional[StrictStr] = Field(None, description="This is the name of the basic user.") - picture: Optional[StrictStr] = Field(None, description="this is a url picture representation of a user.") - email: Optional[StrictStr] = Field(None, description="an email that was extracted.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + username: Optional[StrictStr] = Field(default=None, description="username or twitter handle...etc") + name: Optional[StrictStr] = Field(default=None, description="This is the name of the basic user.") + picture: Optional[StrictStr] = Field(default=None, description="this is a url picture representation of a user.") + email: Optional[StrictStr] = Field(default=None, description="an email that was extracted.") sourced: Optional[ExternallySourcedEnum] = None - url: Optional[StrictStr] = Field(None, description="This is a specific url that this basic user came from.") + url: Optional[StrictStr] = Field(default=None, description="This is a specific url that this basic user came from.") mailgun: Optional[MailgunMetadata] = None __properties = ["schema", "username", "name", "picture", "email", "sourced", "url", "mailgun"] diff --git a/src/pieces_os_client/models/person_type.py b/src/pieces_os_client/models/person_type.py index cce661e..354d1fd 100644 --- a/src/pieces_os_client/models/person_type.py +++ b/src/pieces_os_client/models/person_type.py @@ -29,7 +29,7 @@ class PersonType(BaseModel): """ basic or platform is absolutely required here. basic: if provided is just information that has been either extracted from the piece or other wise added here. platform: is a real Pieces User.(this user will also exist within the user's users collection. && if not then we will just use the data we have.) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") basic: Optional[PersonBasicType] = None platform: Optional[UserProfile] = None __properties = ["schema", "basic", "platform"] diff --git a/src/pieces_os_client/models/persons.py b/src/pieces_os_client/models/persons.py index c9b56e4..a827c83 100644 --- a/src/pieces_os_client/models/persons.py +++ b/src/pieces_os_client/models/persons.py @@ -29,9 +29,9 @@ class Persons(BaseModel): """ This is the plural of Person. will have top level meta about the person including an iterable of all the person. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Person) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an person id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an person id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/pkce.py b/src/pieces_os_client/models/pkce.py index 8521123..b35a130 100644 --- a/src/pieces_os_client/models/pkce.py +++ b/src/pieces_os_client/models/pkce.py @@ -33,7 +33,7 @@ class PKCE(BaseModel): """ An object representing all of the properties involved in a PKCE Authentication Flow # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") result: Optional[ResultedPKCE] = None challenge: Optional[ChallengedPKCE] = None revocation: Optional[RevokedPKCE] = None diff --git a/src/pieces_os_client/models/precreated_external_provider_api_key.py b/src/pieces_os_client/models/precreated_external_provider_api_key.py index d11d658..fd06f52 100644 --- a/src/pieces_os_client/models/precreated_external_provider_api_key.py +++ b/src/pieces_os_client/models/precreated_external_provider_api_key.py @@ -28,9 +28,9 @@ class PrecreatedExternalProviderApiKey(BaseModel): """ This is the input model for /external_provider/api_key/create # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - user: StrictStr = Field(..., description="This is the ID of the User.") - open_ai: Optional[Auth0OpenAIUserMetadata] = Field(None, alias="open_AI") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + user: StrictStr = Field(default=..., description="This is the ID of the User.") + open_ai: Optional[Auth0OpenAIUserMetadata] = Field(default=None, alias="open_AI") __properties = ["schema", "user", "open_AI"] class Config: diff --git a/src/pieces_os_client/models/predeleted_external_provider_api_key.py b/src/pieces_os_client/models/predeleted_external_provider_api_key.py index 6e7910c..5b581a1 100644 --- a/src/pieces_os_client/models/predeleted_external_provider_api_key.py +++ b/src/pieces_os_client/models/predeleted_external_provider_api_key.py @@ -27,9 +27,9 @@ class PredeletedExternalProviderApiKey(BaseModel): """ This is a predeleted version relating to the /external_provider/api_key/delete endpoint. This will ensure we remove this specific provider.(anything that is set to true we will reset to null within the database.) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") user: StrictStr = Field(...) - open_ai: Optional[StrictBool] = Field(None, alias="open_AI") + open_ai: Optional[StrictBool] = Field(default=None, alias="open_AI") __properties = ["schema", "user", "open_AI"] class Config: diff --git a/src/pieces_os_client/models/preonboarded_persona_details.py b/src/pieces_os_client/models/preonboarded_persona_details.py index c8a8e6d..a6c569d 100644 --- a/src/pieces_os_client/models/preonboarded_persona_details.py +++ b/src/pieces_os_client/models/preonboarded_persona_details.py @@ -27,7 +27,7 @@ class PreonboardedPersonaDetails(BaseModel): """ This is an input body for the /machine_learning/text/technical_processing/generators/personification endpoint. This will accept some of the personal details ie languages/personas && will transform this in to onbaording snippets # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") languages: Optional[conlist(StrictStr)] = None personas: Optional[conlist(StrictStr)] = None __properties = ["schema", "languages", "personas"] diff --git a/src/pieces_os_client/models/preupdated_external_provider_api_key.py b/src/pieces_os_client/models/preupdated_external_provider_api_key.py index d5d443a..80c212f 100644 --- a/src/pieces_os_client/models/preupdated_external_provider_api_key.py +++ b/src/pieces_os_client/models/preupdated_external_provider_api_key.py @@ -28,9 +28,9 @@ class PreupdatedExternalProviderApiKey(BaseModel): """ This is the endput model for \"/external_provider/api_key/update\". everything but the uder will be optional, anything that is defined will get an update. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") user: StrictStr = Field(...) - open_ai: Optional[Auth0OpenAIUserMetadata] = Field(None, alias="open_AI") + open_ai: Optional[Auth0OpenAIUserMetadata] = Field(default=None, alias="open_AI") __properties = ["schema", "user", "open_AI"] class Config: diff --git a/src/pieces_os_client/models/preview.py b/src/pieces_os_client/models/preview.py index 235c45f..2eb6cfb 100644 --- a/src/pieces_os_client/models/preview.py +++ b/src/pieces_os_client/models/preview.py @@ -28,7 +28,7 @@ class Preview(BaseModel): """ This is a preview Model that will hold references to at minimum the base preview. which can be potentiall a base image, or also base text/code and then the oveylay is another format(image/text/code) that is 'overlayed' ontop of the base format. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") base: ReferencedFormat = Field(...) overlay: Optional[ReferencedFormat] = None __properties = ["schema", "base", "overlay"] diff --git a/src/pieces_os_client/models/project_module.py b/src/pieces_os_client/models/project_module.py index d571f5a..eb9ba4b 100644 --- a/src/pieces_os_client/models/project_module.py +++ b/src/pieces_os_client/models/project_module.py @@ -30,7 +30,7 @@ class ProjectModule(BaseModel): """ This is a representation of a Module or a Project anchor: is the folder path of this repo/module contributors: is a nice to have is all the contributors of this repo/module range: is the amount of time this user has been working on this repo classifications: if all the languages that are used within this repo/module # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") anchor: SeededAnchor = Field(...) range: Optional[AnonymousTemporalRange] = None contributors: Optional[DocumentContributors] = None diff --git a/src/pieces_os_client/models/project_modules.py b/src/pieces_os_client/models/project_modules.py index 60ca4f1..33b7e22 100644 --- a/src/pieces_os_client/models/project_modules.py +++ b/src/pieces_os_client/models/project_modules.py @@ -27,7 +27,7 @@ class ProjectModules(BaseModel): """ This is a plural representation of the ProjectModule # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(ProjectModule) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/pseudo_assets.py b/src/pieces_os_client/models/pseudo_assets.py index e8308a9..5c055a9 100644 --- a/src/pieces_os_client/models/pseudo_assets.py +++ b/src/pieces_os_client/models/pseudo_assets.py @@ -28,7 +28,7 @@ class PseudoAssets(BaseModel): """ This is a model of all optional properties, that will get returned from /assets/pseudo. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifiers: Optional[FlattenedAssets] = None __properties = ["schema", "identifiers"] diff --git a/src/pieces_os_client/models/qgpt_agent_related_routes.py b/src/pieces_os_client/models/qgpt_agent_related_routes.py index 52fae24..7968f2a 100644 --- a/src/pieces_os_client/models/qgpt_agent_related_routes.py +++ b/src/pieces_os_client/models/qgpt_agent_related_routes.py @@ -27,8 +27,8 @@ class QGPTAgentRelatedRoutes(BaseModel): """ This is specific for all the related materials, like people, tags, websites... xyz # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - people: Optional[StrictBool] = Field(None, description="optional bool, that will say if we reccomend to run related.people on this conversation, IFF set to TRUE.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + people: Optional[StrictBool] = Field(default=None, description="optional bool, that will say if we reccomend to run related.people on this conversation, IFF set to TRUE.") __properties = ["schema", "people"] class Config: diff --git a/src/pieces_os_client/models/qgpt_agent_routes.py b/src/pieces_os_client/models/qgpt_agent_routes.py index 868e0fa..2e32c1c 100644 --- a/src/pieces_os_client/models/qgpt_agent_routes.py +++ b/src/pieces_os_client/models/qgpt_agent_routes.py @@ -28,7 +28,7 @@ class QGPTAgentRoutes(BaseModel): """ This is apart of the Output and will let the plugin developer know if we reccomend to run specific agent functionality/routes. for instance, related.people, code classification...xyz, for now we start with relatedPeople. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") related: Optional[QGPTAgentRelatedRoutes] = None __properties = ["schema", "related"] diff --git a/src/pieces_os_client/models/qgpt_conversation.py b/src/pieces_os_client/models/qgpt_conversation.py index 9387d19..4613ceb 100644 --- a/src/pieces_os_client/models/qgpt_conversation.py +++ b/src/pieces_os_client/models/qgpt_conversation.py @@ -28,7 +28,7 @@ class QGPTConversation(BaseModel): """ QGPTConversation """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: Optional[conlist(QGPTConversationMessage)] = None __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/qgpt_conversation_message.py b/src/pieces_os_client/models/qgpt_conversation_message.py index a46ba83..dcda9d2 100644 --- a/src/pieces_os_client/models/qgpt_conversation_message.py +++ b/src/pieces_os_client/models/qgpt_conversation_message.py @@ -29,7 +29,7 @@ class QGPTConversationMessage(BaseModel): """ This will take a single message, and a role. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") text: StrictStr = Field(...) role: QGPTConversationMessageRoleEnum = Field(...) timestamp: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/qgpt_conversation_pipeline.py b/src/pieces_os_client/models/qgpt_conversation_pipeline.py index 864a1fe..b2b30c3 100644 --- a/src/pieces_os_client/models/qgpt_conversation_pipeline.py +++ b/src/pieces_os_client/models/qgpt_conversation_pipeline.py @@ -31,7 +31,7 @@ class QGPTConversationPipeline(BaseModel): """ This model is specifically for QGPT Conversation pipelines, the model is used to group conversational prompts for instance a conversation around generating code. here are some use cases- 1. contextualized_code_generation- This is for users that want to have conversations around generating code, when there is provided context. 2. generalized_code- This is for users that want to have conversations without context around code. 3. contextualized_code- This is for users that want to have conversation around code with Context. 4. contextualized_code_workstream: this is for the users that want to use context as well as WPE information in their chat (we wiil prioritize WPE infomration, but also support other info as well) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") contextualized_code_generation: Optional[QGPTConversationPipelineForContextualizedCodeGeneration] = None generalized_code_dialog: Optional[QGPTConversationPipelineForGeneralizedCodeDialog] = None contextualized_code_dialog: Optional[QGPTConversationPipelineForContextualizedCodeDialog] = None diff --git a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_dialog.py b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_dialog.py index 647cbf1..20950fb 100644 --- a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_dialog.py +++ b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_dialog.py @@ -27,7 +27,7 @@ class QGPTConversationPipelineForContextualizedCodeDialog(BaseModel): """ This is for the users that wants to have contextualized code conversations, meaning conversations around code with Context provided. This is a class so that we can add optional properties in the future. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_generation.py b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_generation.py index 5fe5116..18a61dd 100644 --- a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_generation.py +++ b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_generation.py @@ -27,7 +27,7 @@ class QGPTConversationPipelineForContextualizedCodeGeneration(BaseModel): """ This type of conversation is reccomended to be provided when a user want generate code w/ context provided. This is a class so that we can add optional properties in the future. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog.py b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog.py index ec0f85a..57ff7b4 100644 --- a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog.py +++ b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_contextualized_code_workstream_dialog.py @@ -27,7 +27,7 @@ class QGPTConversationPipelineForContextualizedCodeWorkstreamDialog(BaseModel): """ This is for the users that wants to have contextualized code conversations around their workstream materials, meaning conversations around code with Context provided, as well as workstream information ie information gathered from the WPE. This is a class so that we can add optional properties in the future. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_generalized_code_dialog.py b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_generalized_code_dialog.py index 44e5670..c968875 100644 --- a/src/pieces_os_client/models/qgpt_conversation_pipeline_for_generalized_code_dialog.py +++ b/src/pieces_os_client/models/qgpt_conversation_pipeline_for_generalized_code_dialog.py @@ -27,7 +27,7 @@ class QGPTConversationPipelineForGeneralizedCodeDialog(BaseModel): """ This is for the users that wants to have generalized code conversations without any context. This is a class so that we can add optional properties in the future. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_hints_input.py b/src/pieces_os_client/models/qgpt_hints_input.py index d9c196a..66d2939 100644 --- a/src/pieces_os_client/models/qgpt_hints_input.py +++ b/src/pieces_os_client/models/qgpt_hints_input.py @@ -31,8 +31,8 @@ class QGPTHintsInput(BaseModel): query: Optional[StrictStr] = None answer: Optional[QGPTQuestionAnswer] = None relevant: RelevantQGPTSeeds = Field(...) - application: Optional[StrictStr] = Field(None, description="optional application id") - model: Optional[StrictStr] = Field(None, description="optional model id") + application: Optional[StrictStr] = Field(default=None, description="optional application id") + model: Optional[StrictStr] = Field(default=None, description="optional model id") __properties = ["query", "answer", "relevant", "application", "model"] class Config: diff --git a/src/pieces_os_client/models/qgpt_persons_related_input.py b/src/pieces_os_client/models/qgpt_persons_related_input.py index aed5650..b200fa0 100644 --- a/src/pieces_os_client/models/qgpt_persons_related_input.py +++ b/src/pieces_os_client/models/qgpt_persons_related_input.py @@ -29,11 +29,11 @@ class QGPTPersonsRelatedInput(BaseModel): """ This is used for /qgpt/persons/related. will accept a seed, or conversation all optionally. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seed: Optional[Seed] = None conversation: Optional[QGPTConversation] = None - application: Optional[StrictStr] = Field(None, description="optional application id") - model: Optional[StrictStr] = Field(None, description="optional model id") + application: Optional[StrictStr] = Field(default=None, description="optional application id") + model: Optional[StrictStr] = Field(default=None, description="optional model id") __properties = ["schema", "seed", "conversation", "application", "model"] class Config: diff --git a/src/pieces_os_client/models/qgpt_persons_related_output.py b/src/pieces_os_client/models/qgpt_persons_related_output.py index f96116e..c58827d 100644 --- a/src/pieces_os_client/models/qgpt_persons_related_output.py +++ b/src/pieces_os_client/models/qgpt_persons_related_output.py @@ -28,9 +28,9 @@ class QGPTPersonsRelatedOutput(BaseModel): """ This model is used for the output of the /qgpt/related/persons endpoint. Explanations here is a custom object with key value pairs, when the key is the personUUId and the value is an explanation as to why this person was reccommended. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") persons: Persons = Field(...) - explanations: Optional[Dict[str, StrictStr]] = Field(None, description="This is a Map where the the key is a person id. and the value is the explanation.") + explanations: Optional[Dict[str, StrictStr]] = Field(default=None, description="This is a Map where the the key is a person id. and the value is the explanation.") __properties = ["schema", "persons", "explanations"] class Config: diff --git a/src/pieces_os_client/models/qgpt_prompt_pipeline.py b/src/pieces_os_client/models/qgpt_prompt_pipeline.py index 5f71be3..357e488 100644 --- a/src/pieces_os_client/models/qgpt_prompt_pipeline.py +++ b/src/pieces_os_client/models/qgpt_prompt_pipeline.py @@ -29,7 +29,7 @@ class QGPTPromptPipeline(BaseModel): """ This is a model related to switching between different prompts based on if we are dealing with various tasks or if we are attempting to converse with LLMs via conversation. You will have 2 options- 1) task- This is specifically for 1 off task operations for instance explaning a bit of code 2) conversation- This is specifically for conversing with our LLMs, will provide better results && high fedility responses for instance contextualize code conversations. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") task: Optional[QGPTTaskPipeline] = None conversation: Optional[QGPTConversationPipeline] = None __properties = ["schema", "task", "conversation"] diff --git a/src/pieces_os_client/models/qgpt_question_answer.py b/src/pieces_os_client/models/qgpt_question_answer.py index 135a2a9..b2c29f6 100644 --- a/src/pieces_os_client/models/qgpt_question_answer.py +++ b/src/pieces_os_client/models/qgpt_question_answer.py @@ -27,8 +27,8 @@ class QGPTQuestionAnswer(BaseModel): """ This will be a simple model with a score and a text value that will represent the value returned for this answer. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - score: Union[StrictFloat, StrictInt] = Field(..., description="This is the score from 0-1 on how good this answer is.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + score: Union[StrictFloat, StrictInt] = Field(default=..., description="This is the score from 0-1 on how good this answer is.") text: StrictStr = Field(...) __properties = ["schema", "score", "text"] diff --git a/src/pieces_os_client/models/qgpt_question_answers.py b/src/pieces_os_client/models/qgpt_question_answers.py index 4c8dce3..75873c0 100644 --- a/src/pieces_os_client/models/qgpt_question_answers.py +++ b/src/pieces_os_client/models/qgpt_question_answers.py @@ -28,7 +28,7 @@ class QGPTQuestionAnswers(BaseModel): """ This is the plural of QGPTQuestionAnswer # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(QGPTQuestionAnswer) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/qgpt_question_input.py b/src/pieces_os_client/models/qgpt_question_input.py index 5af4d58..1c7b7db 100644 --- a/src/pieces_os_client/models/qgpt_question_input.py +++ b/src/pieces_os_client/models/qgpt_question_input.py @@ -31,11 +31,11 @@ class QGPTQuestionInput(BaseModel): """ This is the body input for the /code_gpt/question. Note: - each relevant seed, must require at minimum a Seed or an id used from the /code_gpt/relevance endpoint or we will throw an error. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") relevant: RelevantQGPTSeeds = Field(...) - query: StrictStr = Field(..., description="This is the user asked question.") - application: Optional[StrictStr] = Field(None, description="optional application id") - model: Optional[StrictStr] = Field(None, description="optional model id") + query: StrictStr = Field(default=..., description="This is the user asked question.") + application: Optional[StrictStr] = Field(default=None, description="optional application id") + model: Optional[StrictStr] = Field(default=None, description="optional model id") messages: Optional[FlattenedConversationMessages] = None pipeline: Optional[QGPTPromptPipeline] = None temporal: Optional[TemporalRangeGrounding] = None diff --git a/src/pieces_os_client/models/qgpt_question_output.py b/src/pieces_os_client/models/qgpt_question_output.py index 1ab0c83..66fd0e6 100644 --- a/src/pieces_os_client/models/qgpt_question_output.py +++ b/src/pieces_os_client/models/qgpt_question_output.py @@ -28,7 +28,7 @@ class QGPTQuestionOutput(BaseModel): """ This is the output/returned value from the /qgpt/question endpoint. && /qgpt/followup This will just have a single required property. the possible answers to the question, with a score. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") answers: QGPTQuestionAnswers = Field(...) __properties = ["schema", "answers"] diff --git a/src/pieces_os_client/models/qgpt_relevance_input.py b/src/pieces_os_client/models/qgpt_relevance_input.py index 45bcc49..6736a93 100644 --- a/src/pieces_os_client/models/qgpt_relevance_input.py +++ b/src/pieces_os_client/models/qgpt_relevance_input.py @@ -32,15 +32,15 @@ class QGPTRelevanceInput(BaseModel): """ This is the input body for the /code_gpt/relevance endpoint. There are a couple different options that you may take with this Model. First we will talk about the space in which you will compare your query too. These are the following cases for the space. 1. provide an absolute path on the users machine that we can use locally. 2. provide Seeds that you want to compare to, which will be ONLY fragment/string values(all other values will be ignored) 3. provide assets, here you can provide an iterable of the asset id, and we will do the rest 4. you can set your database boolean to true which will tell us to use your entire DB as the query space. Note: - for ease of use, we have an additional boolean called 'question', which will also ask your question to gpt3.5, and compare to the relevant snippets that we found. That way you dont need to call /code_gpt/question. Otherwise the next step would be is to take the results and feed them into /code_gpt/question. to get your question answered. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - query: StrictStr = Field(..., description="This is the question that the user is asking.") - paths: Optional[conlist(StrictStr)] = Field(None, description="This is an optional list of file || folder paths.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + query: StrictStr = Field(default=..., description="This is the question that the user is asking.") + paths: Optional[conlist(StrictStr)] = Field(default=None, description="This is an optional list of file || folder paths.") seeds: Optional[Seeds] = None assets: Optional[FlattenedAssets] = None messages: Optional[FlattenedConversationMessages] = None options: Optional[QGPTRelevanceInputOptions] = None - application: Optional[StrictStr] = Field(None, description="optional application id") - model: Optional[StrictStr] = Field(None, description="optional model id") + application: Optional[StrictStr] = Field(default=None, description="optional application id") + model: Optional[StrictStr] = Field(default=None, description="optional model id") temporal: Optional[TemporalRangeGrounding] = None __properties = ["schema", "query", "paths", "seeds", "assets", "messages", "options", "application", "model", "temporal"] diff --git a/src/pieces_os_client/models/qgpt_relevance_input_options.py b/src/pieces_os_client/models/qgpt_relevance_input_options.py index f3c3f94..63df661 100644 --- a/src/pieces_os_client/models/qgpt_relevance_input_options.py +++ b/src/pieces_os_client/models/qgpt_relevance_input_options.py @@ -28,9 +28,9 @@ class QGPTRelevanceInputOptions(BaseModel): """ QGPTRelevanceInputOptions """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - database: Optional[StrictBool] = Field(None, description="This is an optional boolen that will tell us to use our entire snippet database as the sample.") - question: Optional[StrictBool] = Field(None, description="This is an optional boolean, that will let the serve know if you want to combine the 2 endpointsboth relevance && the Question endpoint to return the final results.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + database: Optional[StrictBool] = Field(default=None, description="This is an optional boolen that will tell us to use our entire snippet database as the sample.") + question: Optional[StrictBool] = Field(default=None, description="This is an optional boolean, that will let the serve know if you want to combine the 2 endpointsboth relevance && the Question endpoint to return the final results.") pipeline: Optional[QGPTPromptPipeline] = None __properties = ["schema", "database", "question", "pipeline"] diff --git a/src/pieces_os_client/models/qgpt_relevance_output.py b/src/pieces_os_client/models/qgpt_relevance_output.py index 21cd14e..00a4cbf 100644 --- a/src/pieces_os_client/models/qgpt_relevance_output.py +++ b/src/pieces_os_client/models/qgpt_relevance_output.py @@ -29,7 +29,7 @@ class QGPTRelevanceOutput(BaseModel): """ This is the returned value from /code_gpt/relevance. This will return the snippets that we found are relevant to the query you provided. (optional) answer: in the case you provided question: true, then we will also return to you the answer to your question. Note: - relevant: this is required property and will represent the relevant snippets, to your specific query.(NOTE: these snippet will all have respective id's and seed defined. even though id and seed are optional) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") answer: Optional[QGPTQuestionOutput] = None relevant: RelevantQGPTSeeds = Field(...) __properties = ["schema", "answer", "relevant"] diff --git a/src/pieces_os_client/models/qgpt_reprompt_input.py b/src/pieces_os_client/models/qgpt_reprompt_input.py index ccdd1fe..ffba46c 100644 --- a/src/pieces_os_client/models/qgpt_reprompt_input.py +++ b/src/pieces_os_client/models/qgpt_reprompt_input.py @@ -29,11 +29,11 @@ class QGPTRepromptInput(BaseModel): """ Query is your followup question. Conversation is a list of the back and fourth with the qgpt bot. where the first entry in the array was the last message sent. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") query: StrictStr = Field(...) conversation: QGPTConversation = Field(...) - application: Optional[StrictStr] = Field(None, description="optional application id") - model: Optional[StrictStr] = Field(None, description="optional model id") + application: Optional[StrictStr] = Field(default=None, description="optional application id") + model: Optional[StrictStr] = Field(default=None, description="optional model id") pipeline: Optional[QGPTPromptPipeline] = None __properties = ["schema", "query", "conversation", "application", "model", "pipeline"] diff --git a/src/pieces_os_client/models/qgpt_reprompt_output.py b/src/pieces_os_client/models/qgpt_reprompt_output.py index b00947f..6dec4eb 100644 --- a/src/pieces_os_client/models/qgpt_reprompt_output.py +++ b/src/pieces_os_client/models/qgpt_reprompt_output.py @@ -27,7 +27,7 @@ class QGPTRepromptOutput(BaseModel): """ QGPTRepromptOutput """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") query: StrictStr = Field(...) __properties = ["schema", "query"] diff --git a/src/pieces_os_client/models/qgpt_stream_input.py b/src/pieces_os_client/models/qgpt_stream_input.py index c50eb41..f9dffdb 100644 --- a/src/pieces_os_client/models/qgpt_stream_input.py +++ b/src/pieces_os_client/models/qgpt_stream_input.py @@ -30,11 +30,11 @@ class QGPTStreamInput(BaseModel): """ relevance: Optional[QGPTRelevanceInput] = None question: Optional[QGPTQuestionInput] = None - request: Optional[StrictStr] = Field(None, description="This is an optional Id you can use to identify the result from your request.") - conversation: Optional[StrictStr] = Field(None, description="This is the ID of a predefined persisted conversation, if this is not present we will create a new conversation for the input/output.(in the case of a question)") - stop: Optional[StrictBool] = Field(None, description="This will stop the output of the current LLM") - reset: Optional[StrictBool] = Field(None, description="This will fully reset all current Activity within the QGPT stream Flows.") - agent: Optional[StrictBool] = Field(None, description="This will let us know if we want to run the agent routing as well, this is default to true. However if set to false you will save on processing and you will recieve null for the agentRoutes class on the QGPTStreamOutput.") + request: Optional[StrictStr] = Field(default=None, description="This is an optional Id you can use to identify the result from your request.") + conversation: Optional[StrictStr] = Field(default=None, description="This is the ID of a predefined persisted conversation, if this is not present we will create a new conversation for the input/output.(in the case of a question)") + stop: Optional[StrictBool] = Field(default=None, description="This will stop the output of the current LLM") + reset: Optional[StrictBool] = Field(default=None, description="This will fully reset all current Activity within the QGPT stream Flows.") + agent: Optional[StrictBool] = Field(default=None, description="This will let us know if we want to run the agent routing as well, this is default to true. However if set to false you will save on processing and you will recieve null for the agentRoutes class on the QGPTStreamOutput.") __properties = ["relevance", "question", "request", "conversation", "stop", "reset", "agent"] class Config: diff --git a/src/pieces_os_client/models/qgpt_stream_output.py b/src/pieces_os_client/models/qgpt_stream_output.py index 8d8ac8d..f61b302 100644 --- a/src/pieces_os_client/models/qgpt_stream_output.py +++ b/src/pieces_os_client/models/qgpt_stream_output.py @@ -25,20 +25,22 @@ from pieces_os_client.models.qgpt_question_output import QGPTQuestionOutput from pieces_os_client.models.qgpt_relevance_output import QGPTRelevanceOutput from pieces_os_client.models.qgpt_stream_enum import QGPTStreamEnum +from pieces_os_client.models.qgpt_streamed_output_extracted_materials import QGPTStreamedOutputExtractedMaterials class QGPTStreamOutput(BaseModel): """ This is the out for the /qgpt/stream endpoint. 200: success 401: invalid authentication/api key 429: Rate limit/Quota exceeded 500: server had an error 503: the engine is currently overloaded # noqa: E501 """ - request: Optional[StrictStr] = Field(None, description="This is the id used to represent the stream of response. this will always be present. We will use the value passed inby the client, or we will generate one.") + request: Optional[StrictStr] = Field(default=None, description="This is the id used to represent the stream of response. this will always be present. We will use the value passed inby the client, or we will generate one.") relevance: Optional[QGPTRelevanceOutput] = None question: Optional[QGPTQuestionOutput] = None status: Optional[QGPTStreamEnum] = None - conversation: StrictStr = Field(..., description="This is the ID of a predefined persisted conversation, if this is not present we will create a new conversation for the input/output.(in the case of a question)") - status_code: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="statusCode", description="This will be provided") - error_message: Optional[StrictStr] = Field(None, alias="errorMessage", description="optional error message is the status code is NOT 200") - agent_routes: Optional[QGPTAgentRoutes] = Field(None, alias="agentRoutes") - __properties = ["request", "relevance", "question", "status", "conversation", "statusCode", "errorMessage", "agentRoutes"] + conversation: StrictStr = Field(default=..., description="This is the ID of a predefined persisted conversation, if this is not present we will create a new conversation for the input/output.(in the case of a question)") + status_code: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="statusCode", description="This will be provided") + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage", description="optional error message is the status code is NOT 200") + agent_routes: Optional[QGPTAgentRoutes] = Field(default=None, alias="agentRoutes") + extracted: Optional[QGPTStreamedOutputExtractedMaterials] = None + __properties = ["request", "relevance", "question", "status", "conversation", "statusCode", "errorMessage", "agentRoutes", "extracted"] class Config: """Pydantic configuration""" @@ -73,6 +75,9 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of agent_routes if self.agent_routes: _dict['agentRoutes'] = self.agent_routes.to_dict() + # override the default output from pydantic by calling `to_dict()` of extracted + if self.extracted: + _dict['extracted'] = self.extracted.to_dict() # set to None if status_code (nullable) is None # and __fields_set__ contains the field if self.status_code is None and "status_code" in self.__fields_set__: @@ -97,7 +102,8 @@ def from_dict(cls, obj: dict) -> QGPTStreamOutput: "conversation": obj.get("conversation"), "status_code": obj.get("statusCode"), "error_message": obj.get("errorMessage"), - "agent_routes": QGPTAgentRoutes.from_dict(obj.get("agentRoutes")) if obj.get("agentRoutes") is not None else None + "agent_routes": QGPTAgentRoutes.from_dict(obj.get("agentRoutes")) if obj.get("agentRoutes") is not None else None, + "extracted": QGPTStreamedOutputExtractedMaterials.from_dict(obj.get("extracted")) if obj.get("extracted") is not None else None }) return _obj diff --git a/src/pieces_os_client/models/qgpt_streamed_output_extracted_materials.py b/src/pieces_os_client/models/qgpt_streamed_output_extracted_materials.py new file mode 100644 index 0000000..237a154 --- /dev/null +++ b/src/pieces_os_client/models/qgpt_streamed_output_extracted_materials.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.qgpt_streamed_output_extracted_textual_materials import QGPTStreamedOutputExtractedTextualMaterials + +class QGPTStreamedOutputExtractedMaterials(BaseModel): + """ + This is used as an object that will return some of the extracted materials from both the message w/ compeleted/ or stopped as well as the context(if using WorkstreamContext) # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + textual: Optional[QGPTStreamedOutputExtractedTextualMaterials] = None + __properties = ["schema", "textual"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> QGPTStreamedOutputExtractedMaterials: + """Create an instance of QGPTStreamedOutputExtractedMaterials from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of textual + if self.textual: + _dict['textual'] = self.textual.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> QGPTStreamedOutputExtractedMaterials: + """Create an instance of QGPTStreamedOutputExtractedMaterials from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return QGPTStreamedOutputExtractedMaterials.parse_obj(obj) + + _obj = QGPTStreamedOutputExtractedMaterials.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "textual": QGPTStreamedOutputExtractedTextualMaterials.from_dict(obj.get("textual")) if obj.get("textual") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/qgpt_streamed_output_extracted_textual_materials.py b/src/pieces_os_client/models/qgpt_streamed_output_extracted_textual_materials.py new file mode 100644 index 0000000..57ea288 --- /dev/null +++ b/src/pieces_os_client/models/qgpt_streamed_output_extracted_textual_materials.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.textually_extracted_materials import TextuallyExtractedMaterials + +class QGPTStreamedOutputExtractedTextualMaterials(BaseModel): + """ + This is all the textually extracted materials from the QGPT stream # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + message: Optional[TextuallyExtractedMaterials] = None + workstream: Optional[TextuallyExtractedMaterials] = None + __properties = ["schema", "message", "workstream"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> QGPTStreamedOutputExtractedTextualMaterials: + """Create an instance of QGPTStreamedOutputExtractedTextualMaterials from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of message + if self.message: + _dict['message'] = self.message.to_dict() + # override the default output from pydantic by calling `to_dict()` of workstream + if self.workstream: + _dict['workstream'] = self.workstream.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> QGPTStreamedOutputExtractedTextualMaterials: + """Create an instance of QGPTStreamedOutputExtractedTextualMaterials from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return QGPTStreamedOutputExtractedTextualMaterials.parse_obj(obj) + + _obj = QGPTStreamedOutputExtractedTextualMaterials.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "message": TextuallyExtractedMaterials.from_dict(obj.get("message")) if obj.get("message") is not None else None, + "workstream": TextuallyExtractedMaterials.from_dict(obj.get("workstream")) if obj.get("workstream") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/qgpt_task_pipeline.py b/src/pieces_os_client/models/qgpt_task_pipeline.py index b26da9e..c9409d2 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline.py @@ -32,7 +32,7 @@ class QGPTTaskPipeline(BaseModel): """ This model is specifically for QGPT Task pipelines, the model is used to group one off tasks for instance fix/explaining/commenting that dont necessarily require a conversation form factor. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code_explanation: Optional[QGPTTaskPipelineForCodeExplanation] = None code_commentation: Optional[QGPTTaskPipelineForCodeCommentation] = None code_fix: Optional[QGPTTaskPipelineForCodeFix] = None diff --git a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_commentation.py b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_commentation.py index 1ce8fcd..6a7ee3d 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_commentation.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_commentation.py @@ -27,7 +27,7 @@ class QGPTTaskPipelineForCodeCommentation(BaseModel): """ This task is for commenting a bit of code. This is a class so that we can add optional properties in the future. Note: the snippet && language that needs to be commented should be within the QGPTQuestionInput.relevant # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_completion.py b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_completion.py index e281730..7eeae89 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_completion.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_completion.py @@ -27,7 +27,7 @@ class QGPTTaskPipelineForCodeCompletion(BaseModel): """ This task is for code_completion ie auto-complete. This is a class so that we can add optional properties in the future. context: This is additional snippet context within the file that will be useful for the autocompletion.(PLEASE ONLY pass in Seed.asset.format.fragment.string.raw for the context snippet values, and for the classificaiton pass in Seed.asset.format.classification) Note: the snippet && language that needs to be Actually AutoCompleted should be within the QGPTQuestionInput.relevant. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") context: Optional[conlist(StrictStr)] = None __properties = ["schema", "context"] diff --git a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_explanation.py b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_explanation.py index 3aedf82..a0e57c2 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_explanation.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_explanation.py @@ -27,7 +27,7 @@ class QGPTTaskPipelineForCodeExplanation(BaseModel): """ This task is for explaining a bit of code. This is a class so that we can add optional properties in the future. Note: the snippet && language that needs to be explaned should be within the QGPTQuestionInput.relevant # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_fix.py b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_fix.py index 638c497..cd3f16a 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_fix.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_fix.py @@ -27,8 +27,8 @@ class QGPTTaskPipelineForCodeFix(BaseModel): """ This task is for fixing a bit of code. This is a class so that we can add optional properties in the future. Note: the snippet && language that needs to be fixed should be within the QGPTQuestionInput.relevant. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - error: Optional[StrictStr] = Field(None, description="This is the error message provided from the IDE, that we can use to provide the solution.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + error: Optional[StrictStr] = Field(default=None, description="This is the error message provided from the IDE, that we can use to provide the solution.") __properties = ["schema", "error"] class Config: diff --git a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_modification.py b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_modification.py index e9bf7e2..8699f55 100644 --- a/src/pieces_os_client/models/qgpt_task_pipeline_for_code_modification.py +++ b/src/pieces_os_client/models/qgpt_task_pipeline_for_code_modification.py @@ -27,8 +27,8 @@ class QGPTTaskPipelineForCodeModification(BaseModel): """ This task is for modifying a bit of code, IE modify this code to do xyz. This is a class so that we can add optional properties in the future. Note: the snippet && language that needs to be modified should be within the QGPTQuestionInput.relevant # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - instruction: Optional[StrictStr] = Field(None, description="This is the instruction that we will use to modify this snippet.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + instruction: Optional[StrictStr] = Field(default=None, description="This is the instruction that we will use to modify this snippet.") __properties = ["schema", "instruction"] class Config: diff --git a/src/pieces_os_client/models/range.py b/src/pieces_os_client/models/range.py index ea91d3d..45da1f3 100644 --- a/src/pieces_os_client/models/range.py +++ b/src/pieces_os_client/models/range.py @@ -31,13 +31,13 @@ class Range(BaseModel): """ This is an identified Range, this is ONLY needed when using plural rangedTimestamps, in order to ensure granularity(add/modify/delete) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) to: Optional[GroupedTimestamp] = None - var_from: Optional[GroupedTimestamp] = Field(None, alias="from") + var_from: Optional[GroupedTimestamp] = Field(default=None, alias="from") between: Optional[StrictBool] = None summaries: Optional[FlattenedWorkstreamSummaries] = None conversations: Optional[FlattenedConversations] = None diff --git a/src/pieces_os_client/models/ranges.py b/src/pieces_os_client/models/ranges.py index 00ffb2b..f14007e 100644 --- a/src/pieces_os_client/models/ranges.py +++ b/src/pieces_os_client/models/ranges.py @@ -29,9 +29,9 @@ class Ranges(BaseModel): """ This is a collection of many Ranges # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Range) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an range id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an range id.") score: Optional[Score] = None continuous: Optional[StrictBool] = None __properties = ["schema", "iterable", "indices", "score", "continuous"] diff --git a/src/pieces_os_client/models/reaction.py b/src/pieces_os_client/models/reaction.py index a045604..35354c9 100644 --- a/src/pieces_os_client/models/reaction.py +++ b/src/pieces_os_client/models/reaction.py @@ -29,8 +29,8 @@ class Reaction(BaseModel): """ This will the the Request body of the Request Endpoint. Reuse will not be required here because we do NOT know if the user will choose to reuse what we have suggested. save will however be required because this will let us know if we should save the coppied asset that was first sent over or not. seed is required, because we will want to know 100% sure what the original suggestion was made against. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - save: StrictBool = Field(..., description="This will just be a simple boolean here that will say if the use should save the asset or not.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + save: StrictBool = Field(default=..., description="This will just be a simple boolean here that will say if the use should save the asset or not.") reuse: Optional[ReuseReaction] = None seed: SeededConnectorCreation = Field(...) __properties = ["schema", "save", "reuse", "seed"] diff --git a/src/pieces_os_client/models/recipients.py b/src/pieces_os_client/models/recipients.py index 1fee701..681e815 100644 --- a/src/pieces_os_client/models/recipients.py +++ b/src/pieces_os_client/models/recipients.py @@ -29,7 +29,7 @@ class Recipients(BaseModel): This an iterable of People that are attached to a specific distribution ie, slack, maigun, ...etc # noqa: E501 """ iterable: conlist(PersonBasicType) = Field(...) - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["iterable", "schema"] class Config: diff --git a/src/pieces_os_client/models/referenced_activity.py b/src/pieces_os_client/models/referenced_activity.py index a6dc972..93a90a5 100644 --- a/src/pieces_os_client/models/referenced_activity.py +++ b/src/pieces_os_client/models/referenced_activity.py @@ -27,7 +27,7 @@ class ReferencedActivity(BaseModel): """ ReferencedActivity """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedActivity] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_anchor.py b/src/pieces_os_client/models/referenced_anchor.py index 7517a25..84a230e 100644 --- a/src/pieces_os_client/models/referenced_anchor.py +++ b/src/pieces_os_client/models/referenced_anchor.py @@ -27,7 +27,7 @@ class ReferencedAnchor(BaseModel): """ This is the referenced version of a Anchor, main used for the uuid. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedAnchor] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_anchor_point.py b/src/pieces_os_client/models/referenced_anchor_point.py index 3f6983e..3290741 100644 --- a/src/pieces_os_client/models/referenced_anchor_point.py +++ b/src/pieces_os_client/models/referenced_anchor_point.py @@ -27,7 +27,7 @@ class ReferencedAnchorPoint(BaseModel): """ ReferencedAnchorPoint """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedAnchorPoint] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_annotation.py b/src/pieces_os_client/models/referenced_annotation.py index afd9ca5..7352bb7 100644 --- a/src/pieces_os_client/models/referenced_annotation.py +++ b/src/pieces_os_client/models/referenced_annotation.py @@ -27,7 +27,7 @@ class ReferencedAnnotation(BaseModel): """ This is the referenced version of a annotation, main used for the uuid. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedAnnotation] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_asset.py b/src/pieces_os_client/models/referenced_asset.py index d8036ab..b0a7ea2 100644 --- a/src/pieces_os_client/models/referenced_asset.py +++ b/src/pieces_os_client/models/referenced_asset.py @@ -27,7 +27,7 @@ class ReferencedAsset(BaseModel): """ A reference to a asset, which at minimum must have the asset's id. But in the case of a hydrated client API it may have a populated reference of type Asset. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedAsset] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_conversation.py b/src/pieces_os_client/models/referenced_conversation.py index 280cba8..c3794f4 100644 --- a/src/pieces_os_client/models/referenced_conversation.py +++ b/src/pieces_os_client/models/referenced_conversation.py @@ -27,7 +27,7 @@ class ReferencedConversation(BaseModel): """ This is a DAG-Safe Minimal version of a Conversation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedConversation] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_conversation_message.py b/src/pieces_os_client/models/referenced_conversation_message.py index ab936e0..c7f4c74 100644 --- a/src/pieces_os_client/models/referenced_conversation_message.py +++ b/src/pieces_os_client/models/referenced_conversation_message.py @@ -27,7 +27,7 @@ class ReferencedConversationMessage(BaseModel): """ This is a DAG-Safe Minimal version of a ConversationMessage. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedConversationMessage] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_distribution.py b/src/pieces_os_client/models/referenced_distribution.py index 1c028dd..a74c2bd 100644 --- a/src/pieces_os_client/models/referenced_distribution.py +++ b/src/pieces_os_client/models/referenced_distribution.py @@ -28,7 +28,7 @@ class ReferencedDistribution(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedDistribution] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_format.py b/src/pieces_os_client/models/referenced_format.py index a51dd8a..f3333a3 100644 --- a/src/pieces_os_client/models/referenced_format.py +++ b/src/pieces_os_client/models/referenced_format.py @@ -27,8 +27,8 @@ class ReferencedFormat(BaseModel): """ A reference to a format which at minimum must have the format's id. But in the case of a hydrated client API it may have a populated reference of type Format. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The id of the Format") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The id of the Format") reference: Optional[FlattenedFormat] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_hint.py b/src/pieces_os_client/models/referenced_hint.py index 95bc58e..7be95fe 100644 --- a/src/pieces_os_client/models/referenced_hint.py +++ b/src/pieces_os_client/models/referenced_hint.py @@ -27,7 +27,7 @@ class ReferencedHint(BaseModel): """ This is the referenced version of a hint, main used for the uuid. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedHint] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_model.py b/src/pieces_os_client/models/referenced_model.py index baa205b..60c5368 100644 --- a/src/pieces_os_client/models/referenced_model.py +++ b/src/pieces_os_client/models/referenced_model.py @@ -27,7 +27,7 @@ class ReferencedModel(BaseModel): """ *****NOTE:***** This is the basic referencedModel, for Now since we dont have a FlattenedModel, im going to simply not include the reference, because I do NOT want to attach a Model here (would cause breaking changes if we switched from a Model -> a flattenedModel). and (2) we are under going Model changes to the Model, so would cause issues. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/referenced_person.py b/src/pieces_os_client/models/referenced_person.py index 5860517..c8720da 100644 --- a/src/pieces_os_client/models/referenced_person.py +++ b/src/pieces_os_client/models/referenced_person.py @@ -27,7 +27,7 @@ class ReferencedPerson(BaseModel): """ [DAG Safe] version of a Person Model. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedPerson] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_range.py b/src/pieces_os_client/models/referenced_range.py index 00ab912..eb22607 100644 --- a/src/pieces_os_client/models/referenced_range.py +++ b/src/pieces_os_client/models/referenced_range.py @@ -27,7 +27,7 @@ class ReferencedRange(BaseModel): """ This is a minimal version of a Range, with mainly an Id. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedRange] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_sensitive.py b/src/pieces_os_client/models/referenced_sensitive.py index d54bb72..7d63f5e 100644 --- a/src/pieces_os_client/models/referenced_sensitive.py +++ b/src/pieces_os_client/models/referenced_sensitive.py @@ -27,7 +27,7 @@ class ReferencedSensitive(BaseModel): """ A reference to a sensitive which at minimum must have the Sensitive id. But in the case of a hydrated client API it may have a populated reference of type Sensitive. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedSensitive] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_share.py b/src/pieces_os_client/models/referenced_share.py index db249d4..b396fa9 100644 --- a/src/pieces_os_client/models/referenced_share.py +++ b/src/pieces_os_client/models/referenced_share.py @@ -27,7 +27,7 @@ class ReferencedShare(BaseModel): """ This is a [DAG SAFE] version of a share. with just a required share ID. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedShare] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_tag.py b/src/pieces_os_client/models/referenced_tag.py index 409e710..532d419 100644 --- a/src/pieces_os_client/models/referenced_tag.py +++ b/src/pieces_os_client/models/referenced_tag.py @@ -27,7 +27,7 @@ class ReferencedTag(BaseModel): """ [DAG Safe] version of a Tag Model. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedTag] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_user.py b/src/pieces_os_client/models/referenced_user.py index e0cc0bc..287ccf4 100644 --- a/src/pieces_os_client/models/referenced_user.py +++ b/src/pieces_os_client/models/referenced_user.py @@ -28,7 +28,7 @@ class ReferencedUser(BaseModel): """ A object to reference a user's ID and optionally a FlattenedUserProfile Instance # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedUserProfile] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_website.py b/src/pieces_os_client/models/referenced_website.py index 8bb80e8..b344809 100644 --- a/src/pieces_os_client/models/referenced_website.py +++ b/src/pieces_os_client/models/referenced_website.py @@ -27,7 +27,7 @@ class ReferencedWebsite(BaseModel): """ ReferencedWebsite """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedWebsite] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_workstream_event.py b/src/pieces_os_client/models/referenced_workstream_event.py index d072425..288f085 100644 --- a/src/pieces_os_client/models/referenced_workstream_event.py +++ b/src/pieces_os_client/models/referenced_workstream_event.py @@ -27,7 +27,7 @@ class ReferencedWorkstreamEvent(BaseModel): """ This is a minimal representation of a WorkstreamEvent event. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedWorkstreamEvent] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/referenced_workstream_pattern_engine_vision_event.py b/src/pieces_os_client/models/referenced_workstream_pattern_engine_vision_event.py new file mode 100644 index 0000000..a243136 --- /dev/null +++ b/src/pieces_os_client/models/referenced_workstream_pattern_engine_vision_event.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_event import FlattenedWorkstreamPatternEngineVisionEvent + +class ReferencedWorkstreamPatternEngineVisionEvent(BaseModel): + """ + This will return a specific event for the WPE. note: value is nullable here because we may want to pass in transferables:true/false # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(...) + reference: Optional[FlattenedWorkstreamPatternEngineVisionEvent] = None + __properties = ["schema", "id", "reference"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> ReferencedWorkstreamPatternEngineVisionEvent: + """Create an instance of ReferencedWorkstreamPatternEngineVisionEvent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of reference + if self.reference: + _dict['reference'] = self.reference.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> ReferencedWorkstreamPatternEngineVisionEvent: + """Create an instance of ReferencedWorkstreamPatternEngineVisionEvent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return ReferencedWorkstreamPatternEngineVisionEvent.parse_obj(obj) + + _obj = ReferencedWorkstreamPatternEngineVisionEvent.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "id": obj.get("id"), + "reference": FlattenedWorkstreamPatternEngineVisionEvent.from_dict(obj.get("reference")) if obj.get("reference") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/referenced_workstream_summary.py b/src/pieces_os_client/models/referenced_workstream_summary.py index 22ae52b..b02f3eb 100644 --- a/src/pieces_os_client/models/referenced_workstream_summary.py +++ b/src/pieces_os_client/models/referenced_workstream_summary.py @@ -27,7 +27,7 @@ class ReferencedWorkstreamSummary(BaseModel): """ this is a referenced minimal version of a WorkstreamSummary typically just our uuid. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) reference: Optional[FlattenedWorkstreamSummary] = None __properties = ["schema", "id", "reference"] diff --git a/src/pieces_os_client/models/relationship.py b/src/pieces_os_client/models/relationship.py index d67a782..6c4c919 100644 --- a/src/pieces_os_client/models/relationship.py +++ b/src/pieces_os_client/models/relationship.py @@ -31,7 +31,7 @@ class Relationship(BaseModel): A relationship expresses a graph of like types, to build a relationship graph. To get the type of relationship, this is for ie Asset, tag, website, format ...etc, you will need to iterate through the edges and get the root or you can just get the first edge's type as a relationship can only be expressed through same type # noqa: E501 """ id: StrictStr = Field(...) - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") embeddings: Embeddings = Field(...) edges: Edges = Field(...) created: GroupedTimestamp = Field(...) diff --git a/src/pieces_os_client/models/relevant_qgpt_seed.py b/src/pieces_os_client/models/relevant_qgpt_seed.py index 2c3bdb6..33f4dd5 100644 --- a/src/pieces_os_client/models/relevant_qgpt_seed.py +++ b/src/pieces_os_client/models/relevant_qgpt_seed.py @@ -29,10 +29,10 @@ class RelevantQGPTSeed(BaseModel): """ This is a generic model used, to wrap a seed, as well as give an identifier used to further identifiy this snippet. Seed is optional here because you may just want to provide the id, and not the original seed. id is also optional here as you may provide an id or not here.(however with specific endpoint this ID is a guarentee.) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None seed: Optional[Seed] = None - path: Optional[StrictStr] = Field(None, description="This is an optional file path") + path: Optional[StrictStr] = Field(default=None, description="This is an optional file path") asset: Optional[ReferencedAsset] = None __properties = ["schema", "id", "seed", "path", "asset"] diff --git a/src/pieces_os_client/models/relevant_qgpt_seeds.py b/src/pieces_os_client/models/relevant_qgpt_seeds.py index 5ec5366..9fe2deb 100644 --- a/src/pieces_os_client/models/relevant_qgpt_seeds.py +++ b/src/pieces_os_client/models/relevant_qgpt_seeds.py @@ -28,7 +28,7 @@ class RelevantQGPTSeeds(BaseModel): """ This is a plural of RelevantQGPTSeed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(RelevantQGPTSeed) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/resulted_pkce.py b/src/pieces_os_client/models/resulted_pkce.py index ed06c3d..a8e1684 100644 --- a/src/pieces_os_client/models/resulted_pkce.py +++ b/src/pieces_os_client/models/resulted_pkce.py @@ -27,9 +27,9 @@ class ResultedPKCE(BaseModel): """ A Model To Represent the Code Returned from a PKCE Response # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - code: StrictStr = Field(..., description="The PKCE Code to be used to access a Token.") - state: StrictStr = Field(..., description="Likely the state that will be returned which should match the requested state as well as the nonce") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + code: StrictStr = Field(default=..., description="The PKCE Code to be used to access a Token.") + state: StrictStr = Field(default=..., description="Likely the state that will be returned which should match the requested state as well as the nonce") __properties = ["schema", "code", "state"] class Config: diff --git a/src/pieces_os_client/models/returned_user_profile.py b/src/pieces_os_client/models/returned_user_profile.py index c63440c..a8ab5b0 100644 --- a/src/pieces_os_client/models/returned_user_profile.py +++ b/src/pieces_os_client/models/returned_user_profile.py @@ -28,7 +28,7 @@ class ReturnedUserProfile(BaseModel): """ This is a modle strictly for the purpose that when calling '/user' and other user related endpoints the UserProfile could potentially be null, so we needed a model to do that. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") user: Optional[UserProfile] = None __properties = ["schema", "user"] diff --git a/src/pieces_os_client/models/reuse_reaction.py b/src/pieces_os_client/models/reuse_reaction.py index 64957f6..8b0d2c6 100644 --- a/src/pieces_os_client/models/reuse_reaction.py +++ b/src/pieces_os_client/models/reuse_reaction.py @@ -27,7 +27,7 @@ class ReuseReaction(BaseModel): """ if reuse was used in the reaction then we can provide the uuid of the asset that was reused. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) __properties = ["schema", "asset"] diff --git a/src/pieces_os_client/models/reuse_suggestion.py b/src/pieces_os_client/models/reuse_suggestion.py index 4c1b6fd..0644891 100644 --- a/src/pieces_os_client/models/reuse_suggestion.py +++ b/src/pieces_os_client/models/reuse_suggestion.py @@ -28,8 +28,8 @@ class ReuseSuggestion(BaseModel): """ This is the ReuseSuggestion. Mainly creating an additional model here because I imagine that we will want to add some additional data to this in the future (potentially with more numerical data that is emitted from the ML Models) **Note: suggested is required here because we will want to say if we suggested to take this action of reuse or not. ** Thoughts here. We could potentially return Assets: which would be an iterable of assets in most relavent order for the user to reuse if they want. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - suggested: StrictBool = Field(..., description="This is a boolean, that will say if you should or should not take action.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + suggested: StrictBool = Field(default=..., description="This is a boolean, that will say if you should or should not take action.") assets: Assets = Field(...) __properties = ["schema", "suggested", "assets"] diff --git a/src/pieces_os_client/models/revoked_pkce.py b/src/pieces_os_client/models/revoked_pkce.py index d8ec2a0..a37e27b 100644 --- a/src/pieces_os_client/models/revoked_pkce.py +++ b/src/pieces_os_client/models/revoked_pkce.py @@ -27,9 +27,9 @@ class RevokedPKCE(BaseModel): """ A model to support revoking a Token Generated Through PKCE The behaviour of this endpoint depends on the state of the Refresh Token Revocation Deletes Grant toggle. If this toggle is enabled, then each revocation request invalidates not only the specific token, but all other tokens based on the same authorization grant. This means that all Refresh Tokens that have been issued for the same user, application, and audience will be revoked. If this toggle is disabled, then only the refresh token is revoked, while the grant is left intact # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - client_id: StrictStr = Field(..., description="Your application's Client ID. The application should match the one the Refresh Token was issued for.") - token: StrictStr = Field(..., description="The Refresh Token you want to revoke.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + client_id: StrictStr = Field(default=..., description="Your application's Client ID. The application should match the one the Refresh Token was issued for.") + token: StrictStr = Field(default=..., description="The Refresh Token you want to revoke.") __properties = ["schema", "client_id", "token"] class Config: diff --git a/src/pieces_os_client/models/save_suggestion.py b/src/pieces_os_client/models/save_suggestion.py index b8b8d43..f245a59 100644 --- a/src/pieces_os_client/models/save_suggestion.py +++ b/src/pieces_os_client/models/save_suggestion.py @@ -27,8 +27,8 @@ class SaveSuggestion(BaseModel): """ This is the SaveSuggestion. Mainly creating an additional model here because I imagine that we will want to add some additional data to this in the future (potentially with more numerical data that is emitted from the ML Models) **Note: suggested is required here because we will want to say if we reccomend to take this action of save or not. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - suggested: StrictBool = Field(..., description="This is a boolean, that will say if you should or should not take action.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + suggested: StrictBool = Field(default=..., description="This is a boolean, that will say if you should or should not take action.") __properties = ["schema", "suggested"] class Config: diff --git a/src/pieces_os_client/models/score.py b/src/pieces_os_client/models/score.py index bf799bc..f943c96 100644 --- a/src/pieces_os_client/models/score.py +++ b/src/pieces_os_client/models/score.py @@ -27,14 +27,15 @@ class Score(BaseModel): """ This is use as the score for an asset. Manual: will be the raw sum of the asset activity events ranks with mechanismEnum == manual Automatic: will be the raw sum of the asset activity events ranks with mechanismEnum == automatic # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - manual: StrictInt = Field(..., description="These are points assigned via manual user driven events.") - automatic: StrictInt = Field(..., description="These are point assigned via automatic activity events.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + manual: StrictInt = Field(default=..., description="These are points assigned via manual user driven events.") + automatic: StrictInt = Field(default=..., description="These are point assigned via automatic activity events.") priority: Optional[StrictInt] = None reuse: Optional[StrictInt] = None update: Optional[StrictInt] = None reference: Optional[StrictInt] = None - __properties = ["schema", "manual", "automatic", "priority", "reuse", "update", "reference"] + searched: Optional[StrictInt] = None + __properties = ["schema", "manual", "automatic", "priority", "reuse", "update", "reference", "searched"] class Config: """Pydantic configuration""" @@ -81,7 +82,8 @@ def from_dict(cls, obj: dict) -> Score: "priority": obj.get("priority"), "reuse": obj.get("reuse"), "update": obj.get("update"), - "reference": obj.get("reference") + "reference": obj.get("reference"), + "searched": obj.get("searched") }) return _obj diff --git a/src/pieces_os_client/models/search_engine.py b/src/pieces_os_client/models/search_engine.py new file mode 100644 index 0000000..123dd99 --- /dev/null +++ b/src/pieces_os_client/models/search_engine.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.embeddings_search_options import EmbeddingsSearchOptions +from pieces_os_client.models.full_text_search_options import FullTextSearchOptions +from pieces_os_client.models.temporal_search_options import TemporalSearchOptions +from pieces_os_client.models.workstream_search_options import WorkstreamSearchOptions + +class SearchEngine(BaseModel): + """ + This will determine the type of search that will run These are all different searching methods all of which are exclusive. Meaning that you cannot mix & match types. operations: is here if you want to build complex searching behavior. (A || B) && (B || C) , note this can get very complex but can be as flexible as you need. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + query: Optional[StrictStr] = None + embeddings: Optional[EmbeddingsSearchOptions] = None + full_text: Optional[FullTextSearchOptions] = None + temporal: Optional[TemporalSearchOptions] = None + workstream: Optional[WorkstreamSearchOptions] = None + operations: Optional[SearchEngines] = None + __properties = ["schema", "query", "embeddings", "full_text", "temporal", "workstream", "operations"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchEngine: + """Create an instance of SearchEngine from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of embeddings + if self.embeddings: + _dict['embeddings'] = self.embeddings.to_dict() + # override the default output from pydantic by calling `to_dict()` of full_text + if self.full_text: + _dict['full_text'] = self.full_text.to_dict() + # override the default output from pydantic by calling `to_dict()` of temporal + if self.temporal: + _dict['temporal'] = self.temporal.to_dict() + # override the default output from pydantic by calling `to_dict()` of workstream + if self.workstream: + _dict['workstream'] = self.workstream.to_dict() + # override the default output from pydantic by calling `to_dict()` of operations + if self.operations: + _dict['operations'] = self.operations.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchEngine: + """Create an instance of SearchEngine from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchEngine.parse_obj(obj) + + _obj = SearchEngine.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "query": obj.get("query"), + "embeddings": EmbeddingsSearchOptions.from_dict(obj.get("embeddings")) if obj.get("embeddings") is not None else None, + "full_text": FullTextSearchOptions.from_dict(obj.get("full_text")) if obj.get("full_text") is not None else None, + "temporal": TemporalSearchOptions.from_dict(obj.get("temporal")) if obj.get("temporal") is not None else None, + "workstream": WorkstreamSearchOptions.from_dict(obj.get("workstream")) if obj.get("workstream") is not None else None, + "operations": SearchEngines.from_dict(obj.get("operations")) if obj.get("operations") is not None else None + }) + return _obj + +from pieces_os_client.models.search_engines import SearchEngines +SearchEngine.update_forward_refs() + diff --git a/src/pieces_os_client/models/search_engines.py b/src/pieces_os_client/models/search_engines.py new file mode 100644 index 0000000..54f5313 --- /dev/null +++ b/src/pieces_os_client/models/search_engines.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.filter_operation_type_enum import FilterOperationTypeEnum + +class SearchEngines(BaseModel): + """ + This is a model for plural Engine. This means that you can run multiple searches, this follow similar behavior to the Asset Filtering.where you can create you own complex operations: IE search a query in FTS, and filter all that have the create from here to here. note: each Engine will only represent 1 search operation, however you many pass in operations to create further nesting. IE Engine: [FTS + w/ operations: [created filter, updated filer, ncs Search] w/ a type of OR:::: This can be as nested as you want however will just increase the time till it returns results.] note: type: default behavior for the type is an AND operation. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchEngine) = Field(...) + type: Optional[FilterOperationTypeEnum] = None + __properties = ["schema", "iterable", "type"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchEngines: + """Create an instance of SearchEngines from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchEngines: + """Create an instance of SearchEngines from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchEngines.parse_obj(obj) + + _obj = SearchEngines.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchEngine.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None, + "type": obj.get("type") + }) + return _obj + +from pieces_os_client.models.search_engine import SearchEngine +SearchEngines.update_forward_refs() + diff --git a/src/pieces_os_client/models/search_input.py b/src/pieces_os_client/models/search_input.py new file mode 100644 index 0000000..61230d6 --- /dev/null +++ b/src/pieces_os_client/models/search_input.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.search_engines import SearchEngines + +class SearchInput(BaseModel): + """ + generic endpoint body for the searching endpoints query: this is optional, but the query string you will use to find your material mode: this is the searching method/type that we will use to search your materials TODO: consider passing in a score here ie only return things that match references/reuse/updates/...etc > x TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials, this would be an input property of suggestions?:boolean that will say if they want suggested materials returned as well # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + engines: SearchEngines = Field(...) + __properties = ["schema", "engines"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchInput: + """Create an instance of SearchInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of engines + if self.engines: + _dict['engines'] = self.engines.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchInput: + """Create an instance of SearchInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchInput.parse_obj(obj) + + _obj = SearchInput.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "engines": SearchEngines.from_dict(obj.get("engines")) if obj.get("engines") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_anchor.py b/src/pieces_os_client/models/searched_anchor.py new file mode 100644 index 0000000..154d48d --- /dev/null +++ b/src/pieces_os_client/models/searched_anchor.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.anchor import Anchor +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_anchor_points import SearchedAnchorPoints + +class SearchedAnchor(BaseModel): + """ + This is used for the Anchors searching endpoint. anchor here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions note: if we match a specific anchorPoint we will provide this as well. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + anchor: Optional[Anchor] = None + points: Optional[SearchedAnchorPoints] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the anchor.") + __properties = ["schema", "anchor", "points", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnchor: + """Create an instance of SearchedAnchor from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of anchor + if self.anchor: + _dict['anchor'] = self.anchor.to_dict() + # override the default output from pydantic by calling `to_dict()` of points + if self.points: + _dict['points'] = self.points.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnchor: + """Create an instance of SearchedAnchor from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnchor.parse_obj(obj) + + _obj = SearchedAnchor.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "anchor": Anchor.from_dict(obj.get("anchor")) if obj.get("anchor") is not None else None, + "points": SearchedAnchorPoints.from_dict(obj.get("points")) if obj.get("points") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_anchor_point.py b/src/pieces_os_client/models/searched_anchor_point.py new file mode 100644 index 0000000..b575efb --- /dev/null +++ b/src/pieces_os_client/models/searched_anchor_point.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.anchor_point import AnchorPoint +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class SearchedAnchorPoint(BaseModel): + """ + This is used for the AnchorPoints searching endpoint. point here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + point: Optional[AnchorPoint] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the anchorPoint.") + __properties = ["schema", "point", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnchorPoint: + """Create an instance of SearchedAnchorPoint from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of point + if self.point: + _dict['point'] = self.point.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnchorPoint: + """Create an instance of SearchedAnchorPoint from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnchorPoint.parse_obj(obj) + + _obj = SearchedAnchorPoint.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "point": AnchorPoint.from_dict(obj.get("point")) if obj.get("point") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_anchor_points.py b/src/pieces_os_client/models/searched_anchor_points.py new file mode 100644 index 0000000..160bb3e --- /dev/null +++ b/src/pieces_os_client/models/searched_anchor_points.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_anchor_point import SearchedAnchorPoint + +class SearchedAnchorPoints(BaseModel): + """ + This is the plural Model used to return many SearchedAnchorPoint. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedAnchorPoint) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnchorPoints: + """Create an instance of SearchedAnchorPoints from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnchorPoints: + """Create an instance of SearchedAnchorPoints from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnchorPoints.parse_obj(obj) + + _obj = SearchedAnchorPoints.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedAnchorPoint.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_anchors.py b/src/pieces_os_client/models/searched_anchors.py new file mode 100644 index 0000000..cf5469c --- /dev/null +++ b/src/pieces_os_client/models/searched_anchors.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_anchor import SearchedAnchor + +class SearchedAnchors(BaseModel): + """ + This is the plural Model used to return many SearchedAnchor. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedAnchor) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnchors: + """Create an instance of SearchedAnchors from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnchors: + """Create an instance of SearchedAnchors from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnchors.parse_obj(obj) + + _obj = SearchedAnchors.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedAnchor.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_annotation.py b/src/pieces_os_client/models/searched_annotation.py new file mode 100644 index 0000000..6a7f828 --- /dev/null +++ b/src/pieces_os_client/models/searched_annotation.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.annotation import Annotation +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class SearchedAnnotation(BaseModel): + """ + This is used for the Annotation searching endpoint annotation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + annotation: Optional[Annotation] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the annotation.") + __properties = ["schema", "annotation", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnnotation: + """Create an instance of SearchedAnnotation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of annotation + if self.annotation: + _dict['annotation'] = self.annotation.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnnotation: + """Create an instance of SearchedAnnotation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnnotation.parse_obj(obj) + + _obj = SearchedAnnotation.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "annotation": Annotation.from_dict(obj.get("annotation")) if obj.get("annotation") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_annotations.py b/src/pieces_os_client/models/searched_annotations.py new file mode 100644 index 0000000..33a0518 --- /dev/null +++ b/src/pieces_os_client/models/searched_annotations.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_annotation import SearchedAnnotation + +class SearchedAnnotations(BaseModel): + """ + This is the plural Model used to return many SearchedAnnotation. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedAnnotation) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedAnnotations: + """Create an instance of SearchedAnnotations from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedAnnotations: + """Create an instance of SearchedAnnotations from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedAnnotations.parse_obj(obj) + + _obj = SearchedAnnotations.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedAnnotation.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_asset.py b/src/pieces_os_client/models/searched_asset.py index 6fb26a0..d78026e 100644 --- a/src/pieces_os_client/models/searched_asset.py +++ b/src/pieces_os_client/models/searched_asset.py @@ -29,13 +29,13 @@ class SearchedAsset(BaseModel): """ This is a modle that will represent a searched asset! # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[Asset] = None exact: StrictBool = Field(...) score: Union[StrictFloat, StrictInt] = Field(...) match: SearchedMatchEnum = Field(...) - identifier: StrictStr = Field(..., description="This is the uuid of the asset.") - pseudo: Optional[StrictBool] = Field(None, description="If this is a pseudo asset that was also returned.") + identifier: StrictStr = Field(default=..., description="This is the uuid of the asset.") + pseudo: Optional[StrictBool] = Field(default=None, description="If this is a pseudo asset that was also returned.") __properties = ["schema", "asset", "exact", "score", "match", "identifier", "pseudo"] class Config: diff --git a/src/pieces_os_client/models/searched_assets.py b/src/pieces_os_client/models/searched_assets.py index cce3b4b..c0ccfd2 100644 --- a/src/pieces_os_client/models/searched_assets.py +++ b/src/pieces_os_client/models/searched_assets.py @@ -28,10 +28,10 @@ class SearchedAssets(BaseModel): """ This is a modle that will return fro mthe search endpoint that will just contain an array of assets! # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SearchedAsset) = Field(...) - suggested: Union[StrictFloat, StrictInt] = Field(..., description="the number of fuzzy/suggested search results.") - exact: Union[StrictFloat, StrictInt] = Field(..., description="the number of exact results") + suggested: Union[StrictFloat, StrictInt] = Field(default=..., description="the number of fuzzy/suggested search results.") + exact: Union[StrictFloat, StrictInt] = Field(default=..., description="the number of exact results") __properties = ["schema", "iterable", "suggested", "exact"] class Config: diff --git a/src/pieces_os_client/models/searched_conversation.py b/src/pieces_os_client/models/searched_conversation.py new file mode 100644 index 0000000..4b371af --- /dev/null +++ b/src/pieces_os_client/models/searched_conversation.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.conversation import Conversation +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_annotations import SearchedAnnotations +from pieces_os_client.models.searched_conversation_messages import SearchedConversationMessages + +class SearchedConversation(BaseModel): + """ + This is used for the Conversations searching endpoint. conversation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + conversation: Optional[Conversation] = None + messages: Optional[SearchedConversationMessages] = None + annotations: Optional[SearchedAnnotations] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the conversation.") + __properties = ["schema", "conversation", "messages", "annotations", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedConversation: + """Create an instance of SearchedConversation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of conversation + if self.conversation: + _dict['conversation'] = self.conversation.to_dict() + # override the default output from pydantic by calling `to_dict()` of messages + if self.messages: + _dict['messages'] = self.messages.to_dict() + # override the default output from pydantic by calling `to_dict()` of annotations + if self.annotations: + _dict['annotations'] = self.annotations.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedConversation: + """Create an instance of SearchedConversation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedConversation.parse_obj(obj) + + _obj = SearchedConversation.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "conversation": Conversation.from_dict(obj.get("conversation")) if obj.get("conversation") is not None else None, + "messages": SearchedConversationMessages.from_dict(obj.get("messages")) if obj.get("messages") is not None else None, + "annotations": SearchedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_conversation_message.py b/src/pieces_os_client/models/searched_conversation_message.py new file mode 100644 index 0000000..4cff705 --- /dev/null +++ b/src/pieces_os_client/models/searched_conversation_message.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.conversation_message import ConversationMessage +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class SearchedConversationMessage(BaseModel): + """ + This is used for the ConversationMessages searching endpoint && the specific Conversation search && ConversationsSearch conversation here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + message: Optional[ConversationMessage] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the ConversationMessage.") + __properties = ["schema", "message", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedConversationMessage: + """Create an instance of SearchedConversationMessage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of message + if self.message: + _dict['message'] = self.message.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedConversationMessage: + """Create an instance of SearchedConversationMessage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedConversationMessage.parse_obj(obj) + + _obj = SearchedConversationMessage.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "message": ConversationMessage.from_dict(obj.get("message")) if obj.get("message") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_conversation_messages.py b/src/pieces_os_client/models/searched_conversation_messages.py new file mode 100644 index 0000000..418674f --- /dev/null +++ b/src/pieces_os_client/models/searched_conversation_messages.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_conversation_message import SearchedConversationMessage + +class SearchedConversationMessages(BaseModel): + """ + This is the plural Model used to return many SearchedConversationMessage. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedConversationMessage) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedConversationMessages: + """Create an instance of SearchedConversationMessages from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedConversationMessages: + """Create an instance of SearchedConversationMessages from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedConversationMessages.parse_obj(obj) + + _obj = SearchedConversationMessages.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedConversationMessage.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_conversations.py b/src/pieces_os_client/models/searched_conversations.py new file mode 100644 index 0000000..c29cf67 --- /dev/null +++ b/src/pieces_os_client/models/searched_conversations.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_conversation import SearchedConversation + +class SearchedConversations(BaseModel): + """ + This is the plural Model used to return many SearchedConversation. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedConversation) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedConversations: + """Create an instance of SearchedConversations from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedConversations: + """Create an instance of SearchedConversations from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedConversations.parse_obj(obj) + + _obj = SearchedConversations.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedConversation.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_hint.py b/src/pieces_os_client/models/searched_hint.py new file mode 100644 index 0000000..0d49ff8 --- /dev/null +++ b/src/pieces_os_client/models/searched_hint.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.hint import Hint + +class SearchedHint(BaseModel): + """ + This is used for the Hint searching endpoint hint here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + hint: Optional[Hint] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the hint.") + __properties = ["schema", "hint", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedHint: + """Create an instance of SearchedHint from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of hint + if self.hint: + _dict['hint'] = self.hint.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedHint: + """Create an instance of SearchedHint from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedHint.parse_obj(obj) + + _obj = SearchedHint.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "hint": Hint.from_dict(obj.get("hint")) if obj.get("hint") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_hints.py b/src/pieces_os_client/models/searched_hints.py new file mode 100644 index 0000000..f075622 --- /dev/null +++ b/src/pieces_os_client/models/searched_hints.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_hint import SearchedHint + +class SearchedHints(BaseModel): + """ + This is the plural Model used to return many SearchedHint. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedHint) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedHints: + """Create an instance of SearchedHints from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedHints: + """Create an instance of SearchedHints from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedHints.parse_obj(obj) + + _obj = SearchedHints.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedHint.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_person.py b/src/pieces_os_client/models/searched_person.py new file mode 100644 index 0000000..12b24f2 --- /dev/null +++ b/src/pieces_os_client/models/searched_person.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.person import Person + +class SearchedPerson(BaseModel): + """ + This is used for the Persons searching endpoint. person here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + person: Optional[Person] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the person.") + __properties = ["schema", "person", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedPerson: + """Create an instance of SearchedPerson from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of person + if self.person: + _dict['person'] = self.person.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedPerson: + """Create an instance of SearchedPerson from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedPerson.parse_obj(obj) + + _obj = SearchedPerson.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "person": Person.from_dict(obj.get("person")) if obj.get("person") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_persons.py b/src/pieces_os_client/models/searched_persons.py new file mode 100644 index 0000000..527b9bf --- /dev/null +++ b/src/pieces_os_client/models/searched_persons.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_person import SearchedPerson + +class SearchedPersons(BaseModel): + """ + This is the plural Model used to return many SearchedPerson. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedPerson) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedPersons: + """Create an instance of SearchedPersons from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedPersons: + """Create an instance of SearchedPersons from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedPersons.parse_obj(obj) + + _obj = SearchedPersons.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedPerson.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_sensitive.py b/src/pieces_os_client/models/searched_sensitive.py new file mode 100644 index 0000000..56016e1 --- /dev/null +++ b/src/pieces_os_client/models/searched_sensitive.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.sensitive import Sensitive + +class SearchedSensitive(BaseModel): + """ + This is used for the Sensitives searching endpoint. sensitive here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + sensitive: Optional[Sensitive] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the sensitive.") + __properties = ["schema", "sensitive", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedSensitive: + """Create an instance of SearchedSensitive from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of sensitive + if self.sensitive: + _dict['sensitive'] = self.sensitive.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedSensitive: + """Create an instance of SearchedSensitive from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedSensitive.parse_obj(obj) + + _obj = SearchedSensitive.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "sensitive": Sensitive.from_dict(obj.get("sensitive")) if obj.get("sensitive") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_sensitives.py b/src/pieces_os_client/models/searched_sensitives.py new file mode 100644 index 0000000..4b219a4 --- /dev/null +++ b/src/pieces_os_client/models/searched_sensitives.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_sensitive import SearchedSensitive + +class SearchedSensitives(BaseModel): + """ + This is the plural Model used to return many SearchedSensitive. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedSensitive) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedSensitives: + """Create an instance of SearchedSensitives from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedSensitives: + """Create an instance of SearchedSensitives from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedSensitives.parse_obj(obj) + + _obj = SearchedSensitives.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedSensitive.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_tag.py b/src/pieces_os_client/models/searched_tag.py new file mode 100644 index 0000000..8b830d3 --- /dev/null +++ b/src/pieces_os_client/models/searched_tag.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.tag import Tag + +class SearchedTag(BaseModel): + """ + This is used for the Tags searching endpoint. tag here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + tag: Optional[Tag] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the tag.") + __properties = ["schema", "tag", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedTag: + """Create an instance of SearchedTag from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of tag + if self.tag: + _dict['tag'] = self.tag.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedTag: + """Create an instance of SearchedTag from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedTag.parse_obj(obj) + + _obj = SearchedTag.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "tag": Tag.from_dict(obj.get("tag")) if obj.get("tag") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_tags.py b/src/pieces_os_client/models/searched_tags.py new file mode 100644 index 0000000..64695d6 --- /dev/null +++ b/src/pieces_os_client/models/searched_tags.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_tag import SearchedTag + +class SearchedTags(BaseModel): + """ + This is the plural Model used to return many searchedTags. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedTag) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedTags: + """Create an instance of SearchedTags from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedTags: + """Create an instance of SearchedTags from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedTags.parse_obj(obj) + + _obj = SearchedTags.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedTag.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_website.py b/src/pieces_os_client/models/searched_website.py new file mode 100644 index 0000000..d5371d4 --- /dev/null +++ b/src/pieces_os_client/models/searched_website.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.website import Website + +class SearchedWebsite(BaseModel): + """ + This is used for the Websites searching endpoint. website here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + website: Optional[Website] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the website.") + __properties = ["schema", "website", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWebsite: + """Create an instance of SearchedWebsite from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of website + if self.website: + _dict['website'] = self.website.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWebsite: + """Create an instance of SearchedWebsite from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWebsite.parse_obj(obj) + + _obj = SearchedWebsite.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "website": Website.from_dict(obj.get("website")) if obj.get("website") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_websites.py b/src/pieces_os_client/models/searched_websites.py new file mode 100644 index 0000000..2c819ab --- /dev/null +++ b/src/pieces_os_client/models/searched_websites.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_website import SearchedWebsite + +class SearchedWebsites(BaseModel): + """ + This is the plural Model used to return many SearchedWebsite. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedWebsite) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWebsites: + """Create an instance of SearchedWebsites from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWebsites: + """Create an instance of SearchedWebsites from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWebsites.parse_obj(obj) + + _obj = SearchedWebsites.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedWebsite.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_event.py b/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_event.py new file mode 100644 index 0000000..3729de2 --- /dev/null +++ b/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_event.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent + +class SearchedWorkstreamPatternEngineVisionEvent(BaseModel): + """ + This will return a list of the returned events. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + event: Optional[WorkstreamPatternEngineVisionEvent] = None + exact: Optional[StrictBool] = None + similarity: Optional[Union[StrictFloat, StrictInt]] = None + temporal: Optional[StrictBool] = None + application: Optional[StrictStr] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the event.") + __properties = ["schema", "event", "exact", "similarity", "temporal", "application", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWorkstreamPatternEngineVisionEvent: + """Create an instance of SearchedWorkstreamPatternEngineVisionEvent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of event + if self.event: + _dict['event'] = self.event.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWorkstreamPatternEngineVisionEvent: + """Create an instance of SearchedWorkstreamPatternEngineVisionEvent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWorkstreamPatternEngineVisionEvent.parse_obj(obj) + + _obj = SearchedWorkstreamPatternEngineVisionEvent.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "event": WorkstreamPatternEngineVisionEvent.from_dict(obj.get("event")) if obj.get("event") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "application": obj.get("application"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_events.py b/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_events.py new file mode 100644 index 0000000..2aa709e --- /dev/null +++ b/src/pieces_os_client/models/searched_workstream_pattern_engine_vision_events.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_workstream_pattern_engine_vision_event import SearchedWorkstreamPatternEngineVisionEvent + +class SearchedWorkstreamPatternEngineVisionEvents(BaseModel): + """ + This will return a list of the returned events. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedWorkstreamPatternEngineVisionEvent) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWorkstreamPatternEngineVisionEvents: + """Create an instance of SearchedWorkstreamPatternEngineVisionEvents from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWorkstreamPatternEngineVisionEvents: + """Create an instance of SearchedWorkstreamPatternEngineVisionEvents from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWorkstreamPatternEngineVisionEvents.parse_obj(obj) + + _obj = SearchedWorkstreamPatternEngineVisionEvents.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedWorkstreamPatternEngineVisionEvent.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_workstream_summaries.py b/src/pieces_os_client/models/searched_workstream_summaries.py new file mode 100644 index 0000000..0ac1557 --- /dev/null +++ b/src/pieces_os_client/models/searched_workstream_summaries.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_workstream_summary import SearchedWorkstreamSummary + +class SearchedWorkstreamSummaries(BaseModel): + """ + This is the plural Model used to return many SearchedWorkstreamSummary. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(SearchedWorkstreamSummary) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWorkstreamSummaries: + """Create an instance of SearchedWorkstreamSummaries from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWorkstreamSummaries: + """Create an instance of SearchedWorkstreamSummaries from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWorkstreamSummaries.parse_obj(obj) + + _obj = SearchedWorkstreamSummaries.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [SearchedWorkstreamSummary.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/searched_workstream_summary.py b/src/pieces_os_client/models/searched_workstream_summary.py new file mode 100644 index 0000000..6163a85 --- /dev/null +++ b/src/pieces_os_client/models/searched_workstream_summary.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.searched_annotations import SearchedAnnotations +from pieces_os_client.models.workstream_summary import WorkstreamSummary + +class SearchedWorkstreamSummary(BaseModel): + """ + This is used for the WorkstreamSummaries searching endpoint WorkstreamSummary here is only provided if transferables are set to true. temporal: if this is provided this means that their material matched the input via a timestamp. TODO will want to consider returning related materials to this material potentially both associated/ and not associated materials ie suggestion: WorkstreamSuggestions annotations: this is provided if we match a specific annotation on a WorkstreamSummary # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + summary: Optional[WorkstreamSummary] = None + annotations: Optional[SearchedAnnotations] = None + exact: StrictBool = Field(...) + similarity: Union[StrictFloat, StrictInt] = Field(...) + temporal: Optional[StrictBool] = None + identifier: StrictStr = Field(default=..., description="This is the uuid of the WorkstreamSummary.") + __properties = ["schema", "summary", "annotations", "exact", "similarity", "temporal", "identifier"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> SearchedWorkstreamSummary: + """Create an instance of SearchedWorkstreamSummary from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of summary + if self.summary: + _dict['summary'] = self.summary.to_dict() + # override the default output from pydantic by calling `to_dict()` of annotations + if self.annotations: + _dict['annotations'] = self.annotations.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> SearchedWorkstreamSummary: + """Create an instance of SearchedWorkstreamSummary from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return SearchedWorkstreamSummary.parse_obj(obj) + + _obj = SearchedWorkstreamSummary.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "summary": WorkstreamSummary.from_dict(obj.get("summary")) if obj.get("summary") is not None else None, + "annotations": SearchedAnnotations.from_dict(obj.get("annotations")) if obj.get("annotations") is not None else None, + "exact": obj.get("exact"), + "similarity": obj.get("similarity"), + "temporal": obj.get("temporal"), + "identifier": obj.get("identifier") + }) + return _obj + + diff --git a/src/pieces_os_client/models/seed.py b/src/pieces_os_client/models/seed.py index f815f6f..463af95 100644 --- a/src/pieces_os_client/models/seed.py +++ b/src/pieces_os_client/models/seed.py @@ -22,20 +22,29 @@ from typing import Optional from pydantic import BaseModel, Field, StrictStr, validator from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.seeded_anchor import SeededAnchor from pieces_os_client.models.seeded_asset import SeededAsset +from pieces_os_client.models.seeded_person import SeededPerson +from pieces_os_client.models.seeded_website import SeededWebsite class Seed(BaseModel): """ - A seed Model used to wrap a format or asset # noqa: E501 + A seed Model used to wrap a format or asset Note: we will expand this now to support additional paramerters. Note: however if create an asset, only pass in the asset, not passing in an asset in this case will cause the endpoint to fail. TODO: for a breaking change update the type enum here to add support for the additional materials or remove it entirely. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[SeededAsset] = None - type: StrictStr = Field(...) - __properties = ["schema", "asset", "type"] + person: Optional[SeededPerson] = None + anchor: Optional[SeededAnchor] = None + website: Optional[SeededWebsite] = None + type: Optional[StrictStr] = None + __properties = ["schema", "asset", "person", "anchor", "website", "type"] @validator('type') def type_validate_enum(cls, value): """Validates the enum""" + if value is None: + return value + if value not in ('SEEDED_FORMAT', 'SEEDED_ASSET'): raise ValueError("must be one of enum values ('SEEDED_FORMAT', 'SEEDED_ASSET')") return value @@ -70,6 +79,15 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of asset if self.asset: _dict['asset'] = self.asset.to_dict() + # override the default output from pydantic by calling `to_dict()` of person + if self.person: + _dict['person'] = self.person.to_dict() + # override the default output from pydantic by calling `to_dict()` of anchor + if self.anchor: + _dict['anchor'] = self.anchor.to_dict() + # override the default output from pydantic by calling `to_dict()` of website + if self.website: + _dict['website'] = self.website.to_dict() return _dict @classmethod @@ -84,6 +102,9 @@ def from_dict(cls, obj: dict) -> Seed: _obj = Seed.parse_obj({ "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, "asset": SeededAsset.from_dict(obj.get("asset")) if obj.get("asset") is not None else None, + "person": SeededPerson.from_dict(obj.get("person")) if obj.get("person") is not None else None, + "anchor": SeededAnchor.from_dict(obj.get("anchor")) if obj.get("anchor") is not None else None, + "website": SeededWebsite.from_dict(obj.get("website")) if obj.get("website") is not None else None, "type": obj.get("type") }) return _obj diff --git a/src/pieces_os_client/models/seeded_accessor.py b/src/pieces_os_client/models/seeded_accessor.py index 66f6b2f..dc4af49 100644 --- a/src/pieces_os_client/models/seeded_accessor.py +++ b/src/pieces_os_client/models/seeded_accessor.py @@ -28,10 +28,10 @@ class SeededAccessor(BaseModel): """ This is a pre-created accessor that simply takes an os id and an optional user(flattened) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - os: StrictStr = Field(..., description="this is an os id.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + os: StrictStr = Field(default=..., description="this is an os id.") user: Optional[FlattenedUserProfile] = None - share: StrictStr = Field(..., description="this is the share that the asset is apart of.") + share: StrictStr = Field(default=..., description="this is the share that the asset is apart of.") __properties = ["schema", "os", "user", "share"] class Config: diff --git a/src/pieces_os_client/models/seeded_anchor.py b/src/pieces_os_client/models/seeded_anchor.py index bf27e94..616eb5e 100644 --- a/src/pieces_os_client/models/seeded_anchor.py +++ b/src/pieces_os_client/models/seeded_anchor.py @@ -29,16 +29,17 @@ class SeededAnchor(BaseModel): """ SeededAnchor """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") type: AnchorTypeEnum = Field(...) watch: Optional[StrictBool] = None fullpath: StrictStr = Field(...) - asset: Optional[StrictStr] = Field(None, description="You may associate a SeededAnchor with an asset") + asset: Optional[StrictStr] = Field(default=None, description="You may associate a SeededAnchor with an asset") platform: Optional[PlatformEnum] = None name: Optional[StrictStr] = None annotations: Optional[conlist(SeededAnnotation)] = None conversation: Optional[StrictStr] = None - __properties = ["schema", "type", "watch", "fullpath", "asset", "platform", "name", "annotations", "conversation"] + persons: Optional[FlattenedPersons] = None + __properties = ["schema", "type", "watch", "fullpath", "asset", "platform", "name", "annotations", "conversation", "persons"] class Config: """Pydantic configuration""" @@ -74,6 +75,9 @@ def to_dict(self): if _item: _items.append(_item.to_dict()) _dict['annotations'] = _items + # override the default output from pydantic by calling `to_dict()` of persons + if self.persons: + _dict['persons'] = self.persons.to_dict() return _dict @classmethod @@ -94,10 +98,12 @@ def from_dict(cls, obj: dict) -> SeededAnchor: "platform": obj.get("platform"), "name": obj.get("name"), "annotations": [SeededAnnotation.from_dict(_item) for _item in obj.get("annotations")] if obj.get("annotations") is not None else None, - "conversation": obj.get("conversation") + "conversation": obj.get("conversation"), + "persons": FlattenedPersons.from_dict(obj.get("persons")) if obj.get("persons") is not None else None }) return _obj +from pieces_os_client.models.flattened_persons import FlattenedPersons from pieces_os_client.models.seeded_annotation import SeededAnnotation SeededAnchor.update_forward_refs() diff --git a/src/pieces_os_client/models/seeded_anchor_point.py b/src/pieces_os_client/models/seeded_anchor_point.py index f8c7854..292a04c 100644 --- a/src/pieces_os_client/models/seeded_anchor_point.py +++ b/src/pieces_os_client/models/seeded_anchor_point.py @@ -29,11 +29,11 @@ class SeededAnchorPoint(BaseModel): """ SeededAnchorPoint """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") type: AnchorTypeEnum = Field(...) watch: Optional[StrictBool] = None fullpath: StrictStr = Field(...) - anchor: StrictStr = Field(..., description="Cannot create an AnchorPoint w/o a Anchor.") + anchor: StrictStr = Field(default=..., description="Cannot create an AnchorPoint w/o a Anchor.") platform: Optional[PlatformEnum] = None __properties = ["schema", "type", "watch", "fullpath", "anchor", "platform"] diff --git a/src/pieces_os_client/models/seeded_annotation.py b/src/pieces_os_client/models/seeded_annotation.py index d1a1192..ab07a36 100644 --- a/src/pieces_os_client/models/seeded_annotation.py +++ b/src/pieces_os_client/models/seeded_annotation.py @@ -29,12 +29,12 @@ class SeededAnnotation(BaseModel): """ This is the percursor to a fully referenced Annotation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") mechanism: Optional[MechanismEnum] = None asset: Optional[StrictStr] = None person: Optional[StrictStr] = None type: AnnotationTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the annotation.") + text: StrictStr = Field(default=..., description="This is the text of the annotation.") model: Optional[StrictStr] = None pseudo: Optional[StrictBool] = None favorited: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/seeded_asset.py b/src/pieces_os_client/models/seeded_asset.py index 679db5c..81dc69c 100644 --- a/src/pieces_os_client/models/seeded_asset.py +++ b/src/pieces_os_client/models/seeded_asset.py @@ -32,7 +32,7 @@ class SeededAsset(BaseModel): """ This is seed data that will be come an asset. discovered: if set to true this seededAsset was discovered using one of our discovery endpoints. pseudo: if this is an asset that a user did NOT explicitly save. available: This is a model that is used within our '/assets/draft' endpoint that will emitt a seed with all the available format that one can generate based on the original seed that was passed in. ie if a png was passed in, we may say that there is a text/code format available. If available formats is passed into the '/assets/create' we will short curcuit certain operations to speed up the process, for instance, if we determine that there is no text within this image then there is no sense in running ocr. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") metadata: Optional[SeededAssetMetadata] = None application: Application = Field(...) format: SeededFormat = Field(...) @@ -40,7 +40,7 @@ class SeededAsset(BaseModel): available: Optional[AvailableFormats] = None pseudo: Optional[StrictBool] = None enrichment: Optional[SeededAssetEnrichment] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this asset was generated as a 'demo' snippet") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this asset was generated as a 'demo' snippet") __properties = ["schema", "metadata", "application", "format", "discovered", "available", "pseudo", "enrichment", "demo"] class Config: diff --git a/src/pieces_os_client/models/seeded_asset_enrichment.py b/src/pieces_os_client/models/seeded_asset_enrichment.py index 7a6b5ce..4e74f16 100644 --- a/src/pieces_os_client/models/seeded_asset_enrichment.py +++ b/src/pieces_os_client/models/seeded_asset_enrichment.py @@ -27,7 +27,7 @@ class SeededAssetEnrichment(BaseModel): """ This is a specific Model for the SeededAsset that will enable the developer to modify the enrichment levels of persons, tags, websites. These enrichment levels will guarentee that the # of people/tags/websites do not eceeed the provided value, but will not guarentee a minimum. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") tags: Optional[StrictInt] = None websites: Optional[StrictInt] = None persons: Optional[StrictInt] = None diff --git a/src/pieces_os_client/models/seeded_asset_metadata.py b/src/pieces_os_client/models/seeded_asset_metadata.py index 686a5af..7eab6ca 100644 --- a/src/pieces_os_client/models/seeded_asset_metadata.py +++ b/src/pieces_os_client/models/seeded_asset_metadata.py @@ -35,10 +35,10 @@ class SeededAssetMetadata(BaseModel): """ This is optional metadata sent with the SeededAsset and other SeededAssets ie (UE, Jetbrains...) Note: if a user/develop didnt explicitly state a mechanism we will default to manual(user Driven only) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - name: Optional[StrictStr] = Field(None, description="This is the name of the asset.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: Optional[StrictStr] = Field(default=None, description="This is the name of the asset.") mechanism: Optional[MechanismEnum] = None - tags: Optional[conlist(SeededAssetTag)] = Field(None, description="(optional) can add some tags to associate to this asset.") + tags: Optional[conlist(SeededAssetTag)] = Field(default=None, description="(optional) can add some tags to associate to this asset.") websites: Optional[conlist(SeededAssetWebsite)] = None sensitives: Optional[conlist(SeededAssetSensitive)] = None persons: Optional[conlist(SeededPerson)] = None diff --git a/src/pieces_os_client/models/seeded_asset_sensitive.py b/src/pieces_os_client/models/seeded_asset_sensitive.py index 1a3aadd..c7db464 100644 --- a/src/pieces_os_client/models/seeded_asset_sensitive.py +++ b/src/pieces_os_client/models/seeded_asset_sensitive.py @@ -31,8 +31,8 @@ class SeededAssetSensitive(BaseModel): """ This is the seededAssetSensitive, this does not have an id yet as we will add it on the server side. can optionally pass in our mechanism here, as the default will be manual unless specified. This is different that hte SeededSensitive as this is pre-before the asset has been created.(but added when the asset is created. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - text: StrictStr = Field(..., description="this is the string representative of the sensative piece of data.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + text: StrictStr = Field(default=..., description="this is the string representative of the sensative piece of data.") mechanism: Optional[MechanismEnum] = None category: SensitiveCategoryEnum = Field(...) severity: SensitiveSeverityEnum = Field(...) diff --git a/src/pieces_os_client/models/seeded_asset_tag.py b/src/pieces_os_client/models/seeded_asset_tag.py index c5d3625..34e96a6 100644 --- a/src/pieces_os_client/models/seeded_asset_tag.py +++ b/src/pieces_os_client/models/seeded_asset_tag.py @@ -29,8 +29,8 @@ class SeededAssetTag(BaseModel): """ This is similar to an SeededTag, where this is the minimum information of a tag, but this can get added to a seededAsset, where you may not yet have an asset id. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - text: StrictStr = Field(..., description="this is the text that represents the tag.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + text: StrictStr = Field(default=..., description="this is the text that represents the tag.") mechanism: Optional[MechanismEnum] = None category: Optional[TagCategoryEnum] = None __properties = ["schema", "text", "mechanism", "category"] diff --git a/src/pieces_os_client/models/seeded_asset_website.py b/src/pieces_os_client/models/seeded_asset_website.py index 7837840..74c7550 100644 --- a/src/pieces_os_client/models/seeded_asset_website.py +++ b/src/pieces_os_client/models/seeded_asset_website.py @@ -28,7 +28,7 @@ class SeededAssetWebsite(BaseModel): """ This is similar to an SeededWebsite, where this is the minimum information of a website, but this can get added to a seededAsset, where you may not yet have an asset id. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") url: StrictStr = Field(...) name: StrictStr = Field(...) mechanism: Optional[MechanismEnum] = None diff --git a/src/pieces_os_client/models/seeded_assets_recommendation.py b/src/pieces_os_client/models/seeded_assets_recommendation.py index e3d4057..5e803d5 100644 --- a/src/pieces_os_client/models/seeded_assets_recommendation.py +++ b/src/pieces_os_client/models/seeded_assets_recommendation.py @@ -29,7 +29,7 @@ class SeededAssetsRecommendation(BaseModel): """ This is the input data model for the /assets/recommend [GET] endpoint. It includes both a list of assets but also # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") assets: Assets = Field(...) interactions: InteractedAssets = Field(...) __properties = ["schema", "assets", "interactions"] diff --git a/src/pieces_os_client/models/seeded_backup.py b/src/pieces_os_client/models/seeded_backup.py index 68ac7db..70600ae 100644 --- a/src/pieces_os_client/models/seeded_backup.py +++ b/src/pieces_os_client/models/seeded_backup.py @@ -27,7 +27,7 @@ class SeededBackup(BaseModel): """ This is a precursor to a Backup, for now this will not need to take any properties. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/seeded_classification.py b/src/pieces_os_client/models/seeded_classification.py index 7cc618b..32b883c 100644 --- a/src/pieces_os_client/models/seeded_classification.py +++ b/src/pieces_os_client/models/seeded_classification.py @@ -30,7 +30,7 @@ class SeededClassification(BaseModel): """ This is the specific classification of an Asset's Format.(This is on a per format basis b/c an asset could have different formats that are different format representations of the Asset.) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") generic: Optional[ClassificationGenericEnum] = None specific: Optional[ClassificationSpecificEnum] = None rendering: Optional[ClassificationRenderingEnum] = None diff --git a/src/pieces_os_client/models/seeded_connector_asset.py b/src/pieces_os_client/models/seeded_connector_asset.py index 072a54e..3da1b06 100644 --- a/src/pieces_os_client/models/seeded_connector_asset.py +++ b/src/pieces_os_client/models/seeded_connector_asset.py @@ -29,7 +29,7 @@ class SeededConnectorAsset(BaseModel): """ A generic model to use with the Connector API that requires little to no additional information about the current application. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") metadata: Optional[SeededAssetMetadata] = None format: SeededFormat = Field(...) __properties = ["schema", "metadata", "format"] diff --git a/src/pieces_os_client/models/seeded_connector_connection.py b/src/pieces_os_client/models/seeded_connector_connection.py index 1115d03..fe7e1eb 100644 --- a/src/pieces_os_client/models/seeded_connector_connection.py +++ b/src/pieces_os_client/models/seeded_connector_connection.py @@ -28,7 +28,7 @@ class SeededConnectorConnection(BaseModel): """ A model that is passed to the context API at bootup # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") application: SeededTrackedApplication = Field(...) __properties = ["schema", "application"] diff --git a/src/pieces_os_client/models/seeded_connector_creation.py b/src/pieces_os_client/models/seeded_connector_creation.py index 152ecd0..0545cba 100644 --- a/src/pieces_os_client/models/seeded_connector_creation.py +++ b/src/pieces_os_client/models/seeded_connector_creation.py @@ -28,7 +28,7 @@ class SeededConnectorCreation(BaseModel): """ A encompasing creation object that can be utilized to create either an asset or a format. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[SeededConnectorAsset] = None __properties = ["schema", "asset"] diff --git a/src/pieces_os_client/models/seeded_connector_tracking.py b/src/pieces_os_client/models/seeded_connector_tracking.py index 45c96bb..ed1fdd2 100644 --- a/src/pieces_os_client/models/seeded_connector_tracking.py +++ b/src/pieces_os_client/models/seeded_connector_tracking.py @@ -32,7 +32,7 @@ class SeededConnectorTracking(BaseModel): """ This model is designed to be light weight and low friction while most of the heavy lifting will be happening inside of the context servers. This Model is important because this has references to our materials, instead of fully referenced materials.(very similar to our SeededTrackedEvent, consider consolidating and converting these to Referenced models instead of ID's) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") format: Optional[SeededTrackedFormatEvent] = None asset: Optional[SeededTrackedAssetEvent] = None interaction: Optional[SeededTrackedInteractionEvent] = None diff --git a/src/pieces_os_client/models/seeded_conversation.py b/src/pieces_os_client/models/seeded_conversation.py index 581223d..cbd420a 100644 --- a/src/pieces_os_client/models/seeded_conversation.py +++ b/src/pieces_os_client/models/seeded_conversation.py @@ -36,8 +36,8 @@ class SeededConversation(BaseModel): """ This is a pre-Conversation object. This will hold together a conversation. Ie allthe message within a conversation. All the additional properties on here used on here like(anchors/assets) are used for context that will seed the conversation. model is a calculated property, and will be the model of the last message sent if applicable. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - name: Optional[StrictStr] = Field(None, description="This is a name that is customized.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: Optional[StrictStr] = Field(default=None, description="This is a name that is customized.") favorited: Optional[StrictBool] = None application: Optional[Application] = None annotations: Optional[conlist(SeededAnnotation)] = None @@ -48,7 +48,7 @@ class SeededConversation(BaseModel): anchors: Optional[conlist(SeededAnchor)] = None type: ConversationTypeEnum = Field(...) pipeline: Optional[QGPTPromptPipeline] = None - demo: Optional[StrictBool] = Field(None, description="This will let us know if this conversation was generated as a 'demo' conversation") + demo: Optional[StrictBool] = Field(default=None, description="This will let us know if this conversation was generated as a 'demo' conversation") __properties = ["schema", "name", "favorited", "application", "annotations", "messages", "model", "assets", "websites", "anchors", "type", "pipeline", "demo"] class Config: diff --git a/src/pieces_os_client/models/seeded_conversation_message.py b/src/pieces_os_client/models/seeded_conversation_message.py index d8754c8..a172093 100644 --- a/src/pieces_os_client/models/seeded_conversation_message.py +++ b/src/pieces_os_client/models/seeded_conversation_message.py @@ -33,7 +33,7 @@ class SeededConversationMessage(BaseModel): """ This is a seeded version of a ConversationMessage. conversation is optional, this is because it can be used within the SeededConversation, however if this is passed into the /messages/create w/o a conversation uuid then we will throw an error. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") created: Optional[GroupedTimestamp] = None model: Optional[Model] = None fragment: FragmentFormat = Field(...) diff --git a/src/pieces_os_client/models/seeded_discoverable_asset.py b/src/pieces_os_client/models/seeded_discoverable_asset.py index 4785689..1dc27d4 100644 --- a/src/pieces_os_client/models/seeded_discoverable_asset.py +++ b/src/pieces_os_client/models/seeded_discoverable_asset.py @@ -30,7 +30,7 @@ class SeededDiscoverableAsset(BaseModel): """ Assumption: filters applied in this model will overwrite filters passed in SeededDiscoverableAssets # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") file: Optional[SeededFile] = None fragment: Optional[SeededFragment] = None directory: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/seeded_discoverable_assets.py b/src/pieces_os_client/models/seeded_discoverable_assets.py index 0982855..003d305 100644 --- a/src/pieces_os_client/models/seeded_discoverable_assets.py +++ b/src/pieces_os_client/models/seeded_discoverable_assets.py @@ -29,9 +29,9 @@ class SeededDiscoverableAssets(BaseModel): """ Assumption: filters imposed in this model can be overwritten by passing them in SeededDiscoverableAsset # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - application: StrictStr = Field(..., description="application id.") - iterable: conlist(SeededDiscoverableAsset) = Field(..., description="This is an iterable of already snippitized snippets that we will compare && cluster.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + application: StrictStr = Field(default=..., description="application id.") + iterable: conlist(SeededDiscoverableAsset) = Field(default=..., description="This is an iterable of already snippitized snippets that we will compare && cluster.") filters: Optional[TLPDirectedDiscoveryFilters] = None __properties = ["schema", "application", "iterable", "filters"] diff --git a/src/pieces_os_client/models/seeded_discoverable_html_webpage.py b/src/pieces_os_client/models/seeded_discoverable_html_webpage.py index a7d9089..6f0171b 100644 --- a/src/pieces_os_client/models/seeded_discoverable_html_webpage.py +++ b/src/pieces_os_client/models/seeded_discoverable_html_webpage.py @@ -27,9 +27,9 @@ class SeededDiscoverableHtmlWebpage(BaseModel): """ SeededDiscoverableHtmlWebpage """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - url: StrictStr = Field(..., description="The route of the page ") - page: StrictStr = Field(..., description="page's html as a string") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + url: StrictStr = Field(default=..., description="The route of the page ") + page: StrictStr = Field(default=..., description="page's html as a string") __properties = ["schema", "url", "page"] class Config: diff --git a/src/pieces_os_client/models/seeded_discoverable_html_webpages.py b/src/pieces_os_client/models/seeded_discoverable_html_webpages.py index 8c754f7..c72c388 100644 --- a/src/pieces_os_client/models/seeded_discoverable_html_webpages.py +++ b/src/pieces_os_client/models/seeded_discoverable_html_webpages.py @@ -28,9 +28,9 @@ class SeededDiscoverableHtmlWebpages(BaseModel): """ SeededDiscoverableHtmlWebpages """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SeededDiscoverableHtmlWebpage) = Field(...) - application: StrictStr = Field(..., description="This is the applicaiton Id used to connect to Pieces OS.") + application: StrictStr = Field(default=..., description="This is the applicaiton Id used to connect to Pieces OS.") __properties = ["schema", "iterable", "application"] class Config: diff --git a/src/pieces_os_client/models/seeded_discoverable_related_tag.py b/src/pieces_os_client/models/seeded_discoverable_related_tag.py index 3757a19..061e323 100644 --- a/src/pieces_os_client/models/seeded_discoverable_related_tag.py +++ b/src/pieces_os_client/models/seeded_discoverable_related_tag.py @@ -29,11 +29,11 @@ class SeededDiscoverableRelatedTag(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - text: StrictStr = Field(..., description="This is the description of the tag.") - asset: StrictStr = Field(..., description="this is a uuid that references an asset.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + text: StrictStr = Field(default=..., description="This is the description of the tag.") + asset: StrictStr = Field(default=..., description="this is a uuid that references an asset.") mechanism: Optional[MechanismEnum] = None - format: Optional[StrictStr] = Field(None, description="(optionally) you can attach a tag to a format. so when you delete a format this tag will get removed from the asset as well.") + format: Optional[StrictStr] = Field(default=None, description="(optionally) you can attach a tag to a format. so when you delete a format this tag will get removed from the asset as well.") category: Optional[TagCategoryEnum] = None __properties = ["schema", "text", "asset", "mechanism", "format", "category"] diff --git a/src/pieces_os_client/models/seeded_discoverable_related_tags.py b/src/pieces_os_client/models/seeded_discoverable_related_tags.py index c4e1464..097db9b 100644 --- a/src/pieces_os_client/models/seeded_discoverable_related_tags.py +++ b/src/pieces_os_client/models/seeded_discoverable_related_tags.py @@ -28,9 +28,9 @@ class SeededDiscoverableRelatedTags(BaseModel): """ SeededDiscoverableRelatedTags """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SeededDiscoverableRelatedTag) = Field(...) - application: StrictStr = Field(..., description="This is the application id that this request is sent from.") + application: StrictStr = Field(default=..., description="This is the application id that this request is sent from.") __properties = ["schema", "iterable", "application"] class Config: diff --git a/src/pieces_os_client/models/seeded_discoverable_sensitive.py b/src/pieces_os_client/models/seeded_discoverable_sensitive.py index 5baac3d..d72392f 100644 --- a/src/pieces_os_client/models/seeded_discoverable_sensitive.py +++ b/src/pieces_os_client/models/seeded_discoverable_sensitive.py @@ -31,9 +31,9 @@ class SeededDiscoverableSensitive(BaseModel): """ This is the SeededDiscoverableSensitive, this has every property that the seededSensitive has except this one is all optionally passed in. and will override our classification if provided. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) - text: StrictStr = Field(..., description="this is the string representative of the sensative piece of data.") + text: StrictStr = Field(default=..., description="this is the string representative of the sensative piece of data.") mechanism: Optional[MechanismEnum] = None category: Optional[SensitiveCategoryEnum] = None severity: Optional[SensitiveSeverityEnum] = None diff --git a/src/pieces_os_client/models/seeded_discoverable_sensitives.py b/src/pieces_os_client/models/seeded_discoverable_sensitives.py index f327e7e..360ee90 100644 --- a/src/pieces_os_client/models/seeded_discoverable_sensitives.py +++ b/src/pieces_os_client/models/seeded_discoverable_sensitives.py @@ -28,7 +28,7 @@ class SeededDiscoverableSensitives(BaseModel): """ SeededDiscoverableSensitives """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SeededDiscoverableSensitive) = Field(...) application: StrictStr = Field(...) __properties = ["schema", "iterable", "application"] diff --git a/src/pieces_os_client/models/seeded_distribution.py b/src/pieces_os_client/models/seeded_distribution.py index cc5e323..0010eee 100644 --- a/src/pieces_os_client/models/seeded_distribution.py +++ b/src/pieces_os_client/models/seeded_distribution.py @@ -29,7 +29,7 @@ class SeededDistribution(BaseModel): """ TODO if we add another distribution add to this, Distribution, and flattenedDistribution. can only use this Model with our Linkify Model. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") mailgun: Optional[MailgunDistribution] = None github: Optional[SeededGitHubDistribution] = None __properties = ["schema", "mailgun", "github"] diff --git a/src/pieces_os_client/models/seeded_distributions.py b/src/pieces_os_client/models/seeded_distributions.py index 0e597eb..2183a3a 100644 --- a/src/pieces_os_client/models/seeded_distributions.py +++ b/src/pieces_os_client/models/seeded_distributions.py @@ -28,7 +28,7 @@ class SeededDistributions(BaseModel): """ This is the plural version of a SeededDistribution that is not referenced just yet. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SeededDistribution) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/seeded_file.py b/src/pieces_os_client/models/seeded_file.py index 5780f33..3e1fd5f 100644 --- a/src/pieces_os_client/models/seeded_file.py +++ b/src/pieces_os_client/models/seeded_file.py @@ -30,7 +30,7 @@ class SeededFile(BaseModel): """ This is a base model for a File(Seeded). We will Throw an Error, if the text and the bytes properties are both null && if both the text and bytes properties are both defined. Ensure that you pass either a text or bytes property. bytes and string are both optionl but, if both are null or both are defined we will throw an error. So You will be required to pass one or the other, NOT both. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") bytes: Optional[TransferableBytes] = None string: Optional[TransferableString] = None metadata: Optional[FileMetadata] = None diff --git a/src/pieces_os_client/models/seeded_format.py b/src/pieces_os_client/models/seeded_format.py index ef6cb33..c50932f 100644 --- a/src/pieces_os_client/models/seeded_format.py +++ b/src/pieces_os_client/models/seeded_format.py @@ -30,7 +30,7 @@ class SeededFormat(BaseModel): """ This is seeded data that will be come a format. We will throw an Error if, 1) file and fragment are both defined, 2) file and fragment are both null. if this is being used within the /assets/create endpoint or the /{application}/create endpoint, we will not take the classificaiton into account, as it is only used in the syntax highlighting related endpoints.That being said if you do want to override your classification, please look at the metadata within the file or the fragment. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") file: Optional[SeededFile] = None fragment: Optional[SeededFragment] = None classification: Optional[SeededClassification] = None diff --git a/src/pieces_os_client/models/seeded_fragment.py b/src/pieces_os_client/models/seeded_fragment.py index 42e1f7a..c8d3049 100644 --- a/src/pieces_os_client/models/seeded_fragment.py +++ b/src/pieces_os_client/models/seeded_fragment.py @@ -30,7 +30,7 @@ class SeededFragment(BaseModel): """ This will be either a TransferableString or TransferableBytes that represent your fragment. ONLY Pass one or the other DONT pass both or neither. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") string: Optional[TransferableString] = None bytes: Optional[TransferableBytes] = None metadata: Optional[FragmentMetadata] = None diff --git a/src/pieces_os_client/models/seeded_git_hub_distribution.py b/src/pieces_os_client/models/seeded_git_hub_distribution.py index 02503ab..d7a2d16 100644 --- a/src/pieces_os_client/models/seeded_git_hub_distribution.py +++ b/src/pieces_os_client/models/seeded_git_hub_distribution.py @@ -28,7 +28,7 @@ class SeededGitHubDistribution(BaseModel): """ SeededGitHubDistribution """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") gist: Optional[SeededGitHubGistDistribution] = None __properties = ["schema", "gist"] diff --git a/src/pieces_os_client/models/seeded_git_hub_gist_distribution.py b/src/pieces_os_client/models/seeded_git_hub_gist_distribution.py index f400770..db0dd9e 100644 --- a/src/pieces_os_client/models/seeded_git_hub_gist_distribution.py +++ b/src/pieces_os_client/models/seeded_git_hub_gist_distribution.py @@ -28,11 +28,11 @@ class SeededGitHubGistDistribution(BaseModel): """ This is the minimum information needed to distribute a Piece to a Gist. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") recipients: Optional[Recipients] = None - public: Optional[StrictBool] = Field(None, description="we will default to true") - description: Optional[StrictStr] = Field(None, description="This is the description of the Gist Distribution") - name: StrictStr = Field(..., description="This is the name of the gist you will add.") + public: Optional[StrictBool] = Field(default=None, description="we will default to true") + description: Optional[StrictStr] = Field(default=None, description="This is the description of the Gist Distribution") + name: StrictStr = Field(default=..., description="This is the name of the gist you will add.") __properties = ["schema", "recipients", "public", "description", "name"] class Config: diff --git a/src/pieces_os_client/models/seeded_github_gists_import.py b/src/pieces_os_client/models/seeded_github_gists_import.py index 1f27a75..87f75da 100644 --- a/src/pieces_os_client/models/seeded_github_gists_import.py +++ b/src/pieces_os_client/models/seeded_github_gists_import.py @@ -27,9 +27,9 @@ class SeededGithubGistsImport(BaseModel): """ This is the body of the /github/gists/import, by default we will look for everything from your private gists, (TODO hook up public gists.)&& get clever currently we will not ensure that this is a good pieces for you but we will just get you the gist and let you do what you want with it(room for improvement, if we want to layer in advanced pieces discovery) For the future, we might want to add a max number of assets that are returned from this. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - application: StrictStr = Field(..., description="application id.") - public: Optional[StrictBool] = Field(None, description="This will default to false.(ie private), currently not supporting pulling public gists.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + application: StrictStr = Field(default=..., description="application id.") + public: Optional[StrictBool] = Field(default=None, description="This will default to false.(ie private), currently not supporting pulling public gists.") __properties = ["schema", "application", "public"] class Config: diff --git a/src/pieces_os_client/models/seeded_hint.py b/src/pieces_os_client/models/seeded_hint.py index fe6264d..ea811a1 100644 --- a/src/pieces_os_client/models/seeded_hint.py +++ b/src/pieces_os_client/models/seeded_hint.py @@ -29,12 +29,12 @@ class SeededHint(BaseModel): """ SeededHint """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") mechanism: Optional[MechanismEnum] = None - asset: Optional[StrictStr] = Field(None, description="This is an asset id that we are using to link this to an asset.") + asset: Optional[StrictStr] = Field(default=None, description="This is an asset id that we are using to link this to an asset.") type: HintTypeEnum = Field(...) - text: StrictStr = Field(..., description="This is the text of the hint.") - model: Optional[StrictStr] = Field(None, description="this is a model id. that we are using to link this to a model.") + text: StrictStr = Field(default=..., description="This is the text of the hint.") + model: Optional[StrictStr] = Field(default=None, description="this is a model id. that we are using to link this to a model.") __properties = ["schema", "mechanism", "asset", "type", "text", "model"] class Config: diff --git a/src/pieces_os_client/models/seeded_mac_os_asset.py b/src/pieces_os_client/models/seeded_mac_os_asset.py index 0877b0a..14eee12 100644 --- a/src/pieces_os_client/models/seeded_mac_os_asset.py +++ b/src/pieces_os_client/models/seeded_mac_os_asset.py @@ -28,9 +28,9 @@ class SeededMacOSAsset(BaseModel): """ An Seeded Asset specific to MacOS which takes in a Value, and Application # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") application: Optional[Application] = None - value: StrictStr = Field(..., description="The value of the text that you want to save as an asset.") + value: StrictStr = Field(default=..., description="The value of the text that you want to save as an asset.") __properties = ["schema", "application", "value"] class Config: diff --git a/src/pieces_os_client/models/seeded_model.py b/src/pieces_os_client/models/seeded_model.py index c535753..2a7dd33 100644 --- a/src/pieces_os_client/models/seeded_model.py +++ b/src/pieces_os_client/models/seeded_model.py @@ -34,25 +34,25 @@ class SeededModel(BaseModel): """ This is Precursor to a Model. bytes: here is the size of the model in a file local on your computer. ram: is the amount of ram usage when the model is loaded into memory. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - version: StrictStr = Field(..., description="this is a version of the model.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + version: StrictStr = Field(default=..., description="this is a version of the model.") created: GroupedTimestamp = Field(...) - name: StrictStr = Field(..., description="This is an Optional Name of the Model.") - description: Optional[StrictStr] = Field(None, description="An Optional Description of the model itself.") - cloud: StrictBool = Field(..., description="This will inform the user if this was a model that is hosted in the cloud") + name: StrictStr = Field(default=..., description="This is an Optional Name of the Model.") + description: Optional[StrictStr] = Field(default=None, description="An Optional Description of the model itself.") + cloud: StrictBool = Field(default=..., description="This will inform the user if this was a model that is hosted in the cloud") type: ModelTypeEnum = Field(...) usage: ModelUsageEnum = Field(...) bytes: Optional[ByteDescriptor] = None ram: Optional[ByteDescriptor] = None - quantization: Optional[StrictStr] = Field(None, description="quantization is a string like: q8f16_0, q4f16_1, etc...") + quantization: Optional[StrictStr] = Field(default=None, description="quantization is a string like: q8f16_0, q4f16_1, etc...") foundation: Optional[ModelFoundationEnum] = None - downloaded: Optional[StrictBool] = Field(None, description="This is an optional bool to let us know if this model has been downloaded locally.") - unique: Optional[StrictStr] = Field(None, description="This is the unique model name used to load the model.") - parameters: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="This is the number of parameters in terms of billions.") + downloaded: Optional[StrictBool] = Field(default=None, description="This is an optional bool to let us know if this model has been downloaded locally.") + unique: Optional[StrictStr] = Field(default=None, description="This is the unique model name used to load the model.") + parameters: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="This is the number of parameters in terms of billions.") provider: Optional[ExternalMLProviderEnum] = None - cpu: Optional[StrictBool] = Field(None, description="This is an optional bool that is optimized for CPU usage.") - max_tokens: Optional[ModelMaxTokens] = Field(None, alias="maxTokens") - custom: Optional[StrictBool] = Field(None, description="This is reserved to custommly registed models.") + cpu: Optional[StrictBool] = Field(default=None, description="This is an optional bool that is optimized for CPU usage.") + max_tokens: Optional[ModelMaxTokens] = Field(default=None, alias="maxTokens") + custom: Optional[StrictBool] = Field(default=None, description="This is reserved to custommly registed models.") __properties = ["schema", "version", "created", "name", "description", "cloud", "type", "usage", "bytes", "ram", "quantization", "foundation", "downloaded", "unique", "parameters", "provider", "cpu", "maxTokens", "custom"] class Config: diff --git a/src/pieces_os_client/models/seeded_models.py b/src/pieces_os_client/models/seeded_models.py index cb4d008..025e791 100644 --- a/src/pieces_os_client/models/seeded_models.py +++ b/src/pieces_os_client/models/seeded_models.py @@ -28,7 +28,7 @@ class SeededModels(BaseModel): """ This is a Model that will hold an iterable of SeededModels. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SeededModel) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/seeded_person.py b/src/pieces_os_client/models/seeded_person.py index ddf83e7..966c98c 100644 --- a/src/pieces_os_client/models/seeded_person.py +++ b/src/pieces_os_client/models/seeded_person.py @@ -22,6 +22,7 @@ from typing import List, Optional from pydantic import BaseModel, Field, StrictStr, conlist from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_anchors import FlattenedAnchors from pieces_os_client.models.mechanism_enum import MechanismEnum from pieces_os_client.models.person_access import PersonAccess from pieces_os_client.models.person_model import PersonModel @@ -32,14 +33,15 @@ class SeededPerson(BaseModel): """ This is a per-cursor to a full person. Will throw an error, if asset is passed in but acces.scope is undefined. can optionally pass in our mechanism here, as the default will be manual unless specified. TODO consider updating these asset, format to referenced Models Note: model, access, mechanism will only be added if the asset is passed in. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[StrictStr] = None mechanism: Optional[MechanismEnum] = None access: Optional[PersonAccess] = None type: PersonType = Field(...) model: Optional[PersonModel] = None annotations: Optional[conlist(SeededAnnotation)] = None - __properties = ["schema", "asset", "mechanism", "access", "type", "model", "annotations"] + anchors: Optional[FlattenedAnchors] = None + __properties = ["schema", "asset", "mechanism", "access", "type", "model", "annotations", "anchors"] class Config: """Pydantic configuration""" @@ -84,6 +86,9 @@ def to_dict(self): if _item: _items.append(_item.to_dict()) _dict['annotations'] = _items + # override the default output from pydantic by calling `to_dict()` of anchors + if self.anchors: + _dict['anchors'] = self.anchors.to_dict() return _dict @classmethod @@ -102,7 +107,8 @@ def from_dict(cls, obj: dict) -> SeededPerson: "access": PersonAccess.from_dict(obj.get("access")) if obj.get("access") is not None else None, "type": PersonType.from_dict(obj.get("type")) if obj.get("type") is not None else None, "model": PersonModel.from_dict(obj.get("model")) if obj.get("model") is not None else None, - "annotations": [SeededAnnotation.from_dict(_item) for _item in obj.get("annotations")] if obj.get("annotations") is not None else None + "annotations": [SeededAnnotation.from_dict(_item) for _item in obj.get("annotations")] if obj.get("annotations") is not None else None, + "anchors": FlattenedAnchors.from_dict(obj.get("anchors")) if obj.get("anchors") is not None else None }) return _obj diff --git a/src/pieces_os_client/models/seeded_pkce.py b/src/pieces_os_client/models/seeded_pkce.py index b195f06..0fc0c28 100644 --- a/src/pieces_os_client/models/seeded_pkce.py +++ b/src/pieces_os_client/models/seeded_pkce.py @@ -28,22 +28,22 @@ class SeededPKCE(BaseModel): """ A model that initialized a PKCE Authentication Flow. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - response_type: StrictStr = Field(..., description="Indicates to Auth0 which OAuth 2.0 Flow you want to perform. Use code for Authorization Code Grant (PKCE) Flow.") - state: StrictStr = Field(..., description="An opaque value the clients adds to the initial request that Auth0 includes when redirecting the back to the client. This value must be used by the client to prevent CSRF attacks.") - nonce: StrictStr = Field(..., description="A local key that is held as the comparator to state, thus they should be the same.") - redirect_uri: Optional[StrictStr] = Field(None, description="http://localhost:8080/authentication/response") - code_challenge: StrictStr = Field(..., description="Generated challenge from the code_verifier.") - code_challenge_method: StrictStr = Field(..., description="Method used to generate the challenge. The PKCE spec defines two methods, S256 and plain, however, Auth0 supports only S256 since the latter is discouraged.") - domain: Optional[StrictStr] = Field(None, description="https://auth.pieces.services/authorize") - audience: Optional[StrictStr] = Field(None, description="The unique identifier of the target API you want to access. i.e. https://pieces.us.auth0.com/api/v2/") - screen_hint: Optional[StrictStr] = Field(None, description="Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.") - prompt: Optional[StrictStr] = Field(None, description=" To initiate a silent authentication request, use prompt=none (see Remarks for more info).") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + response_type: StrictStr = Field(default=..., description="Indicates to Auth0 which OAuth 2.0 Flow you want to perform. Use code for Authorization Code Grant (PKCE) Flow.") + state: StrictStr = Field(default=..., description="An opaque value the clients adds to the initial request that Auth0 includes when redirecting the back to the client. This value must be used by the client to prevent CSRF attacks.") + nonce: StrictStr = Field(default=..., description="A local key that is held as the comparator to state, thus they should be the same.") + redirect_uri: Optional[StrictStr] = Field(default=None, description="http://localhost:8080/authentication/response") + code_challenge: StrictStr = Field(default=..., description="Generated challenge from the code_verifier.") + code_challenge_method: StrictStr = Field(default=..., description="Method used to generate the challenge. The PKCE spec defines two methods, S256 and plain, however, Auth0 supports only S256 since the latter is discouraged.") + domain: Optional[StrictStr] = Field(default=None, description="https://auth.pieces.services/authorize") + audience: Optional[StrictStr] = Field(default=None, description="The unique identifier of the target API you want to access. i.e. https://pieces.us.auth0.com/api/v2/") + screen_hint: Optional[StrictStr] = Field(default=None, description="Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.") + prompt: Optional[StrictStr] = Field(default=None, description=" To initiate a silent authentication request, use prompt=none (see Remarks for more info).") organization: Optional[StrictStr] = None invitation: Optional[StrictStr] = None - scope: conlist(StrictStr) = Field(..., description="The scopes which you want to request authorization for. These must be separated by a space. You can request any of the standard OpenID Connect (OIDC) scopes about users, such as profile and email, custom claims that must conform to a namespaced format, or any scopes supported by the target API (for example, read:contacts). Include offline_access to get a Refresh Token.") - client_id: StrictStr = Field(..., description="Your application's Client ID.") - additional_parameters: Optional[SeededPKCEADDITIONALPARAMETERS] = Field(None, alias="ADDITIONAL_PARAMETERS") + scope: conlist(StrictStr) = Field(default=..., description="The scopes which you want to request authorization for. These must be separated by a space. You can request any of the standard OpenID Connect (OIDC) scopes about users, such as profile and email, custom claims that must conform to a namespaced format, or any scopes supported by the target API (for example, read:contacts). Include offline_access to get a Refresh Token.") + client_id: StrictStr = Field(default=..., description="Your application's Client ID.") + additional_parameters: Optional[SeededPKCEADDITIONALPARAMETERS] = Field(default=None, alias="ADDITIONAL_PARAMETERS") response_mode: Optional[StrictStr] = None __properties = ["schema", "response_type", "state", "nonce", "redirect_uri", "code_challenge", "code_challenge_method", "domain", "audience", "screen_hint", "prompt", "organization", "invitation", "scope", "client_id", "ADDITIONAL_PARAMETERS", "response_mode"] diff --git a/src/pieces_os_client/models/seeded_range.py b/src/pieces_os_client/models/seeded_range.py index 0e3b9bb..d540c55 100644 --- a/src/pieces_os_client/models/seeded_range.py +++ b/src/pieces_os_client/models/seeded_range.py @@ -30,9 +30,9 @@ class SeededRange(BaseModel): """ This is a preIdentified version of a Range. conversation: this is here to specify the relationship that we want to set up with the Range. IE for this case we want to associate a Range with a Conversation.grounding.temporal.workstream. Otherwise, if this was a conversation we would have no way to know what relationship that we want to set up on the conversation w/ the range. (because this will be set up for many relationShip opportunities that have different functionalities) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") to: Optional[GroupedTimestamp] = None - var_from: Optional[GroupedTimestamp] = Field(None, alias="from") + var_from: Optional[GroupedTimestamp] = Field(default=None, alias="from") between: Optional[StrictBool] = None summary: Optional[ReferencedWorkstreamSummary] = None conversation: Optional[SeededRangeConversationAssociation] = None diff --git a/src/pieces_os_client/models/seeded_range_conversation_association.py b/src/pieces_os_client/models/seeded_range_conversation_association.py index 3188a9b..cc2dcf5 100644 --- a/src/pieces_os_client/models/seeded_range_conversation_association.py +++ b/src/pieces_os_client/models/seeded_range_conversation_association.py @@ -29,7 +29,7 @@ class SeededRangeConversationAssociation(BaseModel): """ SeededRangeConversationAssociation """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") reference: ReferencedConversation = Field(...) grounding: Optional[SeededRangeConversationGroundingAssociation] = None __properties = ["schema", "reference", "grounding"] diff --git a/src/pieces_os_client/models/seeded_range_conversation_grounding_association.py b/src/pieces_os_client/models/seeded_range_conversation_grounding_association.py index ccc05e1..a306d81 100644 --- a/src/pieces_os_client/models/seeded_range_conversation_grounding_association.py +++ b/src/pieces_os_client/models/seeded_range_conversation_grounding_association.py @@ -28,7 +28,7 @@ class SeededRangeConversationGroundingAssociation(BaseModel): """ SeededRangeConversationGroundingAssociation """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") temporal: Optional[SeededRangeConversationGroundingTemporalAssociation] = None __properties = ["schema", "temporal"] diff --git a/src/pieces_os_client/models/seeded_range_conversation_grounding_temporal_association.py b/src/pieces_os_client/models/seeded_range_conversation_grounding_temporal_association.py index ffd63d1..440c7d0 100644 --- a/src/pieces_os_client/models/seeded_range_conversation_grounding_temporal_association.py +++ b/src/pieces_os_client/models/seeded_range_conversation_grounding_temporal_association.py @@ -27,7 +27,7 @@ class SeededRangeConversationGroundingTemporalAssociation(BaseModel): """ SeededRangeConversationGroundingTemporalAssociation """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") workstream: Optional[StrictBool] = None __properties = ["schema", "workstream"] diff --git a/src/pieces_os_client/models/seeded_score.py b/src/pieces_os_client/models/seeded_score.py index 8ce1101..e4fec51 100644 --- a/src/pieces_os_client/models/seeded_score.py +++ b/src/pieces_os_client/models/seeded_score.py @@ -27,12 +27,13 @@ class SeededScore(BaseModel): """ This is the low level seeded score and will let us know what exactly we want to increment on our material. Note: ONLY include one of these, as we will only increment one of the following. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") reuse: Optional[StrictBool] = None update: Optional[StrictBool] = None reference: Optional[StrictBool] = None priority: Optional[StrictBool] = None - __properties = ["schema", "reuse", "update", "reference", "priority"] + searched: Optional[StrictBool] = None + __properties = ["schema", "reuse", "update", "reference", "priority", "searched"] class Config: """Pydantic configuration""" @@ -77,7 +78,8 @@ def from_dict(cls, obj: dict) -> SeededScore: "reuse": obj.get("reuse"), "update": obj.get("update"), "reference": obj.get("reference"), - "priority": obj.get("priority") + "priority": obj.get("priority"), + "searched": obj.get("searched") }) return _obj diff --git a/src/pieces_os_client/models/seeded_score_increment.py b/src/pieces_os_client/models/seeded_score_increment.py index ceb3d37..ca02084 100644 --- a/src/pieces_os_client/models/seeded_score_increment.py +++ b/src/pieces_os_client/models/seeded_score_increment.py @@ -28,21 +28,21 @@ class SeededScoreIncrement(BaseModel): """ This is the body for a respective scores increment, This will enable us to know what material we want to increment, all of which are optional, if it is defined we will attempt to increment the material. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[SeededScore] = None assets: Optional[SeededScore] = None website: Optional[SeededScore] = None websites: Optional[SeededScore] = None anchor: Optional[SeededScore] = None anchors: Optional[SeededScore] = None - anchor_point: Optional[SeededScore] = Field(None, alias="anchorPoint") - anchor_points: Optional[SeededScore] = Field(None, alias="anchorPoints") + anchor_point: Optional[SeededScore] = Field(default=None, alias="anchorPoint") + anchor_points: Optional[SeededScore] = Field(default=None, alias="anchorPoints") annotation: Optional[SeededScore] = None annotations: Optional[SeededScore] = None conversation: Optional[SeededScore] = None conversations: Optional[SeededScore] = None - conversation_message: Optional[SeededScore] = Field(None, alias="conversationMessage") - conversation_messages: Optional[SeededScore] = Field(None, alias="conversationMessages") + conversation_message: Optional[SeededScore] = Field(default=None, alias="conversationMessage") + conversation_messages: Optional[SeededScore] = Field(default=None, alias="conversationMessages") share: Optional[SeededScore] = None shares: Optional[SeededScore] = None sensitive: Optional[SeededScore] = None diff --git a/src/pieces_os_client/models/seeded_sensitive.py b/src/pieces_os_client/models/seeded_sensitive.py index 4681289..2a2ef46 100644 --- a/src/pieces_os_client/models/seeded_sensitive.py +++ b/src/pieces_os_client/models/seeded_sensitive.py @@ -31,9 +31,9 @@ class SeededSensitive(BaseModel): """ This is the seededSensitive, this does not have an id yet as we will add it on the server side. can optionally pass in our mechanism here, as the default will be manual unless specified. TODO consider updating these asset,format to referenced Models # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) - text: StrictStr = Field(..., description="this is the string representative of the sensative piece of data.") + text: StrictStr = Field(default=..., description="this is the string representative of the sensative piece of data.") mechanism: Optional[MechanismEnum] = None category: SensitiveCategoryEnum = Field(...) severity: SensitiveSeverityEnum = Field(...) diff --git a/src/pieces_os_client/models/seeded_share.py b/src/pieces_os_client/models/seeded_share.py index b99ac41..e5feeac 100644 --- a/src/pieces_os_client/models/seeded_share.py +++ b/src/pieces_os_client/models/seeded_share.py @@ -31,12 +31,12 @@ class SeededShare(BaseModel): """ required to pass in an asset or assets. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: Optional[Asset] = None - users: Optional[conlist(SeededUser)] = Field(None, description="if private please specificy some users you want to share this with.") + users: Optional[conlist(SeededUser)] = Field(default=None, description="if private please specificy some users you want to share this with.") access: AccessEnum = Field(...) assets: Optional[Assets] = None - name: Optional[StrictStr] = Field(None, description="optional name, if it is available. and must be unique.") + name: Optional[StrictStr] = Field(default=None, description="optional name, if it is available. and must be unique.") __properties = ["schema", "asset", "users", "access", "assets", "name"] class Config: diff --git a/src/pieces_os_client/models/seeded_tag.py b/src/pieces_os_client/models/seeded_tag.py index d1e8cda..7a255da 100644 --- a/src/pieces_os_client/models/seeded_tag.py +++ b/src/pieces_os_client/models/seeded_tag.py @@ -29,12 +29,12 @@ class SeededTag(BaseModel): """ This is the minimum information needed when creating a Tag. Default we will attach manual to a tag unless otherwise specified for mechanism. you can optionally add an asset, format, or person uuid to attach this tag directly to it TODO consider updating these asset,format to referenced Models # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - text: StrictStr = Field(..., description="This is the description of the tag.") - asset: Optional[StrictStr] = Field(None, description="this is a uuid that references an asset.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + text: StrictStr = Field(default=..., description="This is the description of the tag.") + asset: Optional[StrictStr] = Field(default=None, description="this is a uuid that references an asset.") mechanism: Optional[MechanismEnum] = None category: Optional[TagCategoryEnum] = None - person: Optional[StrictStr] = Field(None, description="uuid of the person, you want to add this tag too") + person: Optional[StrictStr] = Field(default=None, description="uuid of the person, you want to add this tag too") __properties = ["schema", "text", "asset", "mechanism", "category", "person"] class Config: diff --git a/src/pieces_os_client/models/seeded_tracked_adoption_event.py b/src/pieces_os_client/models/seeded_tracked_adoption_event.py index 8e90adc..3510e13 100644 --- a/src/pieces_os_client/models/seeded_tracked_adoption_event.py +++ b/src/pieces_os_client/models/seeded_tracked_adoption_event.py @@ -28,7 +28,7 @@ class SeededTrackedAdoptionEvent(BaseModel): """ SeededTrackedAdoptionEvent """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifier_description_pair: Optional[AnalyticsTrackedAdoptionEventIdentifierDescriptionPairs] = None __properties = ["schema", "identifier_description_pair"] diff --git a/src/pieces_os_client/models/seeded_tracked_application.py b/src/pieces_os_client/models/seeded_tracked_application.py index 1b97608..321202f 100644 --- a/src/pieces_os_client/models/seeded_tracked_application.py +++ b/src/pieces_os_client/models/seeded_tracked_application.py @@ -31,13 +31,13 @@ class SeededTrackedApplication(BaseModel): """ A Model to describe what application a format/analytics event originated - Specifically NOT requiring an ID # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") name: ApplicationNameEnum = Field(...) - version: StrictStr = Field(..., description="This is the specific version number 0.0.0") + version: StrictStr = Field(default=..., description="This is the specific version number 0.0.0") platform: PlatformEnum = Field(...) capabilities: Optional[CapabilitiesEnum] = None privacy: Optional[PrivacyEnum] = None - automatic_unload: Optional[StrictBool] = Field(None, alias="automaticUnload", description="This is a proper that will let us know if we will proactivity unload all of your machine learning models.by default this is false.") + automatic_unload: Optional[StrictBool] = Field(default=None, alias="automaticUnload", description="This is a proper that will let us know if we will proactivity unload all of your machine learning models.by default this is false.") __properties = ["schema", "name", "version", "platform", "capabilities", "privacy", "automaticUnload"] class Config: diff --git a/src/pieces_os_client/models/seeded_tracked_asset_event.py b/src/pieces_os_client/models/seeded_tracked_asset_event.py index 1504765..977d645 100644 --- a/src/pieces_os_client/models/seeded_tracked_asset_event.py +++ b/src/pieces_os_client/models/seeded_tracked_asset_event.py @@ -28,7 +28,7 @@ class SeededTrackedAssetEvent(BaseModel): """ This seeded tracked asset event will be recieved by a context on the OS Server side, which will then be able to look up the asset id and structure the asset for shipment to Segment aka a fully built TrackedAssetEvent # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: ReferencedAsset = Field(...) identifier_description_pair: TrackedAssetEventIdentifierDescriptionPairs = Field(...) metadata: Optional[TrackedAssetEventMetadata] = None diff --git a/src/pieces_os_client/models/seeded_tracked_assets_event.py b/src/pieces_os_client/models/seeded_tracked_assets_event.py index 93866c4..60a6f62 100644 --- a/src/pieces_os_client/models/seeded_tracked_assets_event.py +++ b/src/pieces_os_client/models/seeded_tracked_assets_event.py @@ -28,7 +28,7 @@ class SeededTrackedAssetsEvent(BaseModel): """ An seeded event model that can occur at the assets level i.e. search # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifier_description_pair: Optional[TrackedAssetsEventIdentifierDescriptionPairs] = None metadata: Optional[SeededTrackedAssetsEventMetadata] = None __properties = ["schema", "identifier_description_pair", "metadata"] diff --git a/src/pieces_os_client/models/seeded_tracked_conversation_event.py b/src/pieces_os_client/models/seeded_tracked_conversation_event.py index f89b141..4f40f5c 100644 --- a/src/pieces_os_client/models/seeded_tracked_conversation_event.py +++ b/src/pieces_os_client/models/seeded_tracked_conversation_event.py @@ -29,7 +29,7 @@ class SeededTrackedConversationEvent(BaseModel): """ This is a pre-created(seed) TrackedConversationEvent # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifier_description_pair: TrackedConversationEventIdentifierDescriptionPairs = Field(...) conversation: ReferencedConversation = Field(...) metadata: Optional[TrackedConversationEventMetadata] = None diff --git a/src/pieces_os_client/models/seeded_tracked_format_event.py b/src/pieces_os_client/models/seeded_tracked_format_event.py index bd9a34c..3004951 100644 --- a/src/pieces_os_client/models/seeded_tracked_format_event.py +++ b/src/pieces_os_client/models/seeded_tracked_format_event.py @@ -29,7 +29,7 @@ class SeededTrackedFormatEvent(BaseModel): """ Again this is a model designed to be sent over to a context server to be built and then sent along to segment. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifier_description_pair: TrackedFormatEventIdentifierDescriptionPairs = Field(...) format: ReferencedFormat = Field(...) metadata: Optional[TrackedFormatEventMetadata] = None diff --git a/src/pieces_os_client/models/seeded_tracked_interaction_event.py b/src/pieces_os_client/models/seeded_tracked_interaction_event.py index fddca46..256eb6d 100644 --- a/src/pieces_os_client/models/seeded_tracked_interaction_event.py +++ b/src/pieces_os_client/models/seeded_tracked_interaction_event.py @@ -28,8 +28,8 @@ class SeededTrackedInteractionEvent(BaseModel): """ This is a model that will hold relavent information in relation to an interaction(ONLY CLICK/TAP) analytics event(usage). If you want to register an event that relates to an interaction with the key then register a Keyboard Event. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - description: StrictStr = Field(..., description="These need structure") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + description: StrictStr = Field(default=..., description="These need structure") element: Optional[StrictStr] = None identifier_description_pair: Optional[SeededTrackedInteractionEventIdentifierDescriptionPairs] = None __properties = ["schema", "description", "element", "identifier_description_pair"] diff --git a/src/pieces_os_client/models/seeded_tracked_interaction_event_identifier_description_pairs.py b/src/pieces_os_client/models/seeded_tracked_interaction_event_identifier_description_pairs.py index 395cbd7..bd8d7df 100644 --- a/src/pieces_os_client/models/seeded_tracked_interaction_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/seeded_tracked_interaction_event_identifier_description_pairs.py @@ -27,7 +27,7 @@ class SeededTrackedInteractionEventIdentifierDescriptionPairs(BaseModel): """ SeededTrackedInteractionEventIdentifierDescriptionPairs """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") assets_list_refreshed: Optional[StrictStr] = None __properties = ["schema", "assets_list_refreshed"] diff --git a/src/pieces_os_client/models/seeded_tracked_keyboard_event.py b/src/pieces_os_client/models/seeded_tracked_keyboard_event.py index b227fd1..b2a2ba8 100644 --- a/src/pieces_os_client/models/seeded_tracked_keyboard_event.py +++ b/src/pieces_os_client/models/seeded_tracked_keyboard_event.py @@ -28,8 +28,8 @@ class SeededTrackedKeyboardEvent(BaseModel): """ This is a model that will hold relavent information in relation to a keyboard(including shortcuts) analytics event (usage). # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - description: StrictStr = Field(..., description="This also needs structure such as key vals or enums") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + description: StrictStr = Field(default=..., description="This also needs structure such as key vals or enums") shortcut: conlist(StrictInt) = Field(...) identifier_description_pair: Optional[SeededTrackedKeyboardEventIdentifierDescriptionPairs] = None __properties = ["schema", "description", "shortcut", "identifier_description_pair"] diff --git a/src/pieces_os_client/models/seeded_tracked_keyboard_event_identifier_description_pairs.py b/src/pieces_os_client/models/seeded_tracked_keyboard_event_identifier_description_pairs.py index e9b08ba..7765ae5 100644 --- a/src/pieces_os_client/models/seeded_tracked_keyboard_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/seeded_tracked_keyboard_event_identifier_description_pairs.py @@ -27,7 +27,7 @@ class SeededTrackedKeyboardEventIdentifierDescriptionPairs(BaseModel): """ SeededTrackedKeyboardEventIdentifierDescriptionPairs """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") assets_list_refreshed: Optional[StrictStr] = None __properties = ["schema", "assets_list_refreshed"] diff --git a/src/pieces_os_client/models/seeded_tracked_machine_learning_event.py b/src/pieces_os_client/models/seeded_tracked_machine_learning_event.py index 16da967..f5886de 100644 --- a/src/pieces_os_client/models/seeded_tracked_machine_learning_event.py +++ b/src/pieces_os_client/models/seeded_tracked_machine_learning_event.py @@ -29,7 +29,7 @@ class SeededTrackedMachineLearningEvent(BaseModel): """ SeededTrackedMachineLearningEvent """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") tlp: Optional[TLPMachineLearningProcessingEvent] = None graphical: Optional[GraphicalMachineLearningProcessingEvent] = None __properties = ["schema", "tlp", "graphical"] diff --git a/src/pieces_os_client/models/seeded_tracked_session_event.py b/src/pieces_os_client/models/seeded_tracked_session_event.py index fddeeb8..2cf91dc 100644 --- a/src/pieces_os_client/models/seeded_tracked_session_event.py +++ b/src/pieces_os_client/models/seeded_tracked_session_event.py @@ -28,7 +28,7 @@ class SeededTrackedSessionEvent(BaseModel): """ A simple model to capture a Tracked Session to be send to the Connection API # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") identifier_description_pair: TrackedSessionEventIdentifierDescriptionPairs = Field(...) __properties = ["schema", "identifier_description_pair"] diff --git a/src/pieces_os_client/models/seeded_ultra_suite_asset.py b/src/pieces_os_client/models/seeded_ultra_suite_asset.py index dad97df..4b1e67c 100644 --- a/src/pieces_os_client/models/seeded_ultra_suite_asset.py +++ b/src/pieces_os_client/models/seeded_ultra_suite_asset.py @@ -29,8 +29,8 @@ class SeededUltraSuiteAsset(BaseModel): """ A SeededUEAsset is the minimum data sent from UE required to create an asset within Pieces. Fragment & file are both optional properties however we will throw an internal error if both fragment and file are passed through or if both are undefined. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - name: Optional[StrictStr] = Field(None, description="(optional) name is the name of the file") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: Optional[StrictStr] = Field(default=None, description="(optional) name is the name of the file") ext: Optional[ClassificationSpecificEnum] = None format: SeededFormat = Field(...) description: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/seeded_user.py b/src/pieces_os_client/models/seeded_user.py index fe1ed1f..048c967 100644 --- a/src/pieces_os_client/models/seeded_user.py +++ b/src/pieces_os_client/models/seeded_user.py @@ -27,7 +27,7 @@ class SeededUser(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") emails: conlist(StrictStr) = Field(...) __properties = ["schema", "emails"] diff --git a/src/pieces_os_client/models/seeded_website.py b/src/pieces_os_client/models/seeded_website.py index 3d10aa5..ec32ec5 100644 --- a/src/pieces_os_client/models/seeded_website.py +++ b/src/pieces_os_client/models/seeded_website.py @@ -28,13 +28,13 @@ class SeededWebsite(BaseModel): """ This is the minimum information required to create a website for a specific asset. you can optionally add an asset, or person id to attach this website directly to it TODO consider updating these asset,format to referenced Models # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - asset: Optional[StrictStr] = Field(None, description="This is the specific asset that this website is going to get attached to!!") - conversation: Optional[StrictStr] = Field(None, description="This is the specific conversation that this website is going to get attached to!!") - url: StrictStr = Field(..., description="this is the url of the website.") - name: StrictStr = Field(..., description="name of the website.(customizable and updateable as well.)") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + asset: Optional[StrictStr] = Field(default=None, description="This is the specific asset that this website is going to get attached to!!") + conversation: Optional[StrictStr] = Field(default=None, description="This is the specific conversation that this website is going to get attached to!!") + url: StrictStr = Field(default=..., description="this is the url of the website.") + name: StrictStr = Field(default=..., description="name of the website.(customizable and updateable as well.)") mechanism: Optional[MechanismEnum] = None - person: Optional[StrictStr] = Field(None, description="this is a uuid of a person that we are going to add the website too.") + person: Optional[StrictStr] = Field(default=None, description="this is a uuid of a person that we are going to add the website too.") __properties = ["schema", "asset", "conversation", "url", "name", "mechanism", "person"] class Config: diff --git a/src/pieces_os_client/models/seeded_workstream_event.py b/src/pieces_os_client/models/seeded_workstream_event.py index 1957716..9785d51 100644 --- a/src/pieces_os_client/models/seeded_workstream_event.py +++ b/src/pieces_os_client/models/seeded_workstream_event.py @@ -32,13 +32,13 @@ class SeededWorkstreamEvent(BaseModel): """ This is a precreated version of a WorkstreamEvent event, this will be used ingested into PiecesOS and PiecesOS will do all the magic to transform this into relevant data show in the workstream feed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") score: Optional[Score] = None application: Application = Field(...) trigger: WorkstreamEventTrigger = Field(...) context: Optional[WorkstreamEventContext] = None summary: Optional[ReferencedWorkstreamSummary] = None - internal_identifier: Optional[StrictStr] = Field(None, description="This is used to override the event identifier, if this was an event that was originally in the internal events collection.") + internal_identifier: Optional[StrictStr] = Field(default=None, description="This is used to override the event identifier, if this was an event that was originally in the internal events collection.") __properties = ["schema", "score", "application", "trigger", "context", "summary", "internal_identifier"] class Config: diff --git a/src/pieces_os_client/models/seeded_workstream_ingestion.py b/src/pieces_os_client/models/seeded_workstream_ingestion.py index 6e878ea..25893b7 100644 --- a/src/pieces_os_client/models/seeded_workstream_ingestion.py +++ b/src/pieces_os_client/models/seeded_workstream_ingestion.py @@ -28,7 +28,7 @@ class SeededWorkstreamIngestion(BaseModel): """ This is used as the input in the Context ingestion endpoint for the feed. This will take in a required seed, this will get created as an internal WorkstreamEvent until we determine internally that this event is relevant and will then attach it to a WorkstreamSummary and it will get moved over to a WorkstreamEvent. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") event: SeededWorkstreamEvent = Field(...) __properties = ["schema", "event"] diff --git a/src/pieces_os_client/models/seeded_workstream_suggestions_refresh.py b/src/pieces_os_client/models/seeded_workstream_suggestions_refresh.py index c89e52d..04be1e1 100644 --- a/src/pieces_os_client/models/seeded_workstream_suggestions_refresh.py +++ b/src/pieces_os_client/models/seeded_workstream_suggestions_refresh.py @@ -29,7 +29,7 @@ class SeededWorkstreamSuggestionsRefresh(BaseModel): """ This is used in the input of the /workstream/feed/refresh The application here will let us know if what scope you would like to refresh the stream for. IE an Application will provide bias in the items that are displayed. note: context can be used here to provide further bias to the suggestions. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") application: Application = Field(...) context: Optional[WorkstreamEventContext] = None __properties = ["schema", "application", "context"] diff --git a/src/pieces_os_client/models/seeded_workstream_summary.py b/src/pieces_os_client/models/seeded_workstream_summary.py index ea0a66f..c118e3d 100644 --- a/src/pieces_os_client/models/seeded_workstream_summary.py +++ b/src/pieces_os_client/models/seeded_workstream_summary.py @@ -37,7 +37,7 @@ class SeededWorkstreamSummary(BaseModel): """ This is a seeded version of a WorkstreamSummary # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") events: Optional[FlattenedWorkstreamEvents] = None name: StrictStr = Field(...) annotations: Optional[conlist(SeededAnnotation)] = None diff --git a/src/pieces_os_client/models/seeds.py b/src/pieces_os_client/models/seeds.py index 9ad6d48..ffe7ded 100644 --- a/src/pieces_os_client/models/seeds.py +++ b/src/pieces_os_client/models/seeds.py @@ -28,7 +28,7 @@ class Seeds(BaseModel): """ This is a plural model for multiple Seed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Seed) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/segmented_technical_language.py b/src/pieces_os_client/models/segmented_technical_language.py index f0a25fd..e4b3761 100644 --- a/src/pieces_os_client/models/segmented_technical_language.py +++ b/src/pieces_os_client/models/segmented_technical_language.py @@ -28,7 +28,7 @@ class SegmentedTechnicalLanguage(BaseModel): """ This is the output model for '/machine_learning/text/technical_language/parsers/segmentation' This will have an iterable of the segmented Technical language text/code # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(SegmentedTechnicalLanguageFragment) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/segmented_technical_language_fragment.py b/src/pieces_os_client/models/segmented_technical_language_fragment.py index 3b67611..be3ab81 100644 --- a/src/pieces_os_client/models/segmented_technical_language_fragment.py +++ b/src/pieces_os_client/models/segmented_technical_language_fragment.py @@ -30,7 +30,7 @@ class SegmentedTechnicalLanguageFragment(BaseModel): """ This is the output iterable model for '/machine_learning/text/technical_language/parsers/segmentation' specific is optional here, however you can pass in classify: true to get the specific classificaiton in the case the generic is code. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") generic: ClassificationGenericEnum = Field(...) specific: Optional[ClassificationSpecificEnum] = None fragment: FragmentFormat = Field(...) diff --git a/src/pieces_os_client/models/sensitive.py b/src/pieces_os_client/models/sensitive.py index de368b8..db3bed7 100644 --- a/src/pieces_os_client/models/sensitive.py +++ b/src/pieces_os_client/models/sensitive.py @@ -34,7 +34,7 @@ class Sensitive(BaseModel): """ This is a fully referenced representation of a sensitive pieces of data. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) @@ -47,7 +47,7 @@ class Sensitive(BaseModel): name: StrictStr = Field(...) description: StrictStr = Field(...) metadata: Optional[SensitiveMetadata] = None - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") score: Optional[Score] = None __properties = ["schema", "id", "created", "updated", "deleted", "asset", "text", "mechanism", "category", "severity", "name", "description", "metadata", "interactions", "score"] diff --git a/src/pieces_os_client/models/sensitive_metadata.py b/src/pieces_os_client/models/sensitive_metadata.py index a3104b5..5b5684a 100644 --- a/src/pieces_os_client/models/sensitive_metadata.py +++ b/src/pieces_os_client/models/sensitive_metadata.py @@ -28,9 +28,9 @@ class SensitiveMetadata(BaseModel): """ This is optional metatdata attached to a sensitive piece of data. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") match: Optional[TextMatch] = None - entropy: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="entropy of the sensitive") + entropy: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="entropy of the sensitive") __properties = ["schema", "match", "entropy"] class Config: diff --git a/src/pieces_os_client/models/sensitives.py b/src/pieces_os_client/models/sensitives.py index c8eb6c4..3a22d06 100644 --- a/src/pieces_os_client/models/sensitives.py +++ b/src/pieces_os_client/models/sensitives.py @@ -29,7 +29,7 @@ class Sensitives(BaseModel): """ This is a model that represents many individual sensitive pieces of data. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Sensitive) = Field(...) score: Optional[Score] = None __properties = ["schema", "iterable", "score"] diff --git a/src/pieces_os_client/models/session.py b/src/pieces_os_client/models/session.py index 945b50c..d3908a9 100644 --- a/src/pieces_os_client/models/session.py +++ b/src/pieces_os_client/models/session.py @@ -27,7 +27,7 @@ class Session(BaseModel): """ This is a specific model that will let us know at what time this user was using the application. # noqa: E501 """ - id: StrictStr = Field(..., description="The UUID of the current Session") + id: StrictStr = Field(default=..., description="The UUID of the current Session") opened: GroupedTimestamp = Field(...) closed: Optional[GroupedTimestamp] = None __properties = ["id", "opened", "closed"] diff --git a/src/pieces_os_client/models/share.py b/src/pieces_os_client/models/share.py index 30f3385..344f193 100644 --- a/src/pieces_os_client/models/share.py +++ b/src/pieces_os_client/models/share.py @@ -34,17 +34,17 @@ class Share(BaseModel): """ This represents what information that is relavent to anything and every sharing related. v1 will look very bare and will add more and more data as we go! if user is undefined && access is public then we have an asset that is publicly available. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="This is the uuid that represents this share model.") - user: Optional[StrictStr] = Field(None, description="this is the uuid of the user that the share is created for.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="This is the uuid that represents this share model.") + user: Optional[StrictStr] = Field(default=None, description="this is the uuid of the user that the share is created for.") asset: Optional[FlattenedAsset] = None assets: Optional[FlattenedAssets] = None - link: StrictStr = Field(..., description="This is the prebuilt link.") + link: StrictStr = Field(default=..., description="This is the prebuilt link.") access: AccessEnum = Field(...) accessors: Accessors = Field(...) created: GroupedTimestamp = Field(...) - short: StrictStr = Field(..., description="This is a shortened version of our uuid.") - name: Optional[StrictStr] = Field(None, description="this is an optional name we can give to the link, ie ?p=JAVASCRIPT or what ever the user wants as long as it is available.") + short: StrictStr = Field(default=..., description="This is a shortened version of our uuid.") + name: Optional[StrictStr] = Field(default=None, description="this is an optional name we can give to the link, ie ?p=JAVASCRIPT or what ever the user wants as long as it is available.") distributions: Optional[Distributions] = None score: Optional[Score] = None __properties = ["schema", "id", "user", "asset", "assets", "link", "access", "accessors", "created", "short", "name", "distributions", "score"] diff --git a/src/pieces_os_client/models/shares.py b/src/pieces_os_client/models/shares.py index 974bd6a..dcbf8a1 100644 --- a/src/pieces_os_client/models/shares.py +++ b/src/pieces_os_client/models/shares.py @@ -29,8 +29,8 @@ class Shares(BaseModel): """ this is just an iterable of our individual share models. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - iterable: conlist(Share) = Field(..., description="this is just an iterable of our individual share models.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(Share) = Field(default=..., description="this is just an iterable of our individual share models.") score: Optional[Score] = None __properties = ["schema", "iterable", "score"] diff --git a/src/pieces_os_client/models/space.py b/src/pieces_os_client/models/space.py index 89514eb..0c65c25 100644 --- a/src/pieces_os_client/models/space.py +++ b/src/pieces_os_client/models/space.py @@ -26,8 +26,8 @@ class Space(BaseModel): """ This is used in the TrackedAssetsEventSearchMetadata # noqa: E501 """ - size: Optional[StrictInt] = Field(None, description="This is the size of your current catalog.(number of assets)") - duration: Optional[StrictInt] = Field(None, description="this is the number in ms it took to run search.") + size: Optional[StrictInt] = Field(default=None, description="This is the size of your current catalog.(number of assets)") + duration: Optional[StrictInt] = Field(default=None, description="this is the number in ms it took to run search.") __properties = ["size", "duration"] class Config: diff --git a/src/pieces_os_client/models/streamed_identifier.py b/src/pieces_os_client/models/streamed_identifier.py index 0d9c363..440c2d9 100644 --- a/src/pieces_os_client/models/streamed_identifier.py +++ b/src/pieces_os_client/models/streamed_identifier.py @@ -30,7 +30,7 @@ class StreamedIdentifier(BaseModel): """ asset: Optional[ReferencedAsset] = None conversation: Optional[ReferencedConversation] = None - deleted: Optional[StrictBool] = Field(None, description="This is a specific bool that will let us know if we deleted an Identifierfrom the db.") + deleted: Optional[StrictBool] = Field(default=None, description="This is a specific bool that will let us know if we deleted an Identifierfrom the db.") __properties = ["asset", "conversation", "deleted"] class Config: diff --git a/src/pieces_os_client/models/streamed_identifiers.py b/src/pieces_os_client/models/streamed_identifiers.py index 2164f8b..39a5bb5 100644 --- a/src/pieces_os_client/models/streamed_identifiers.py +++ b/src/pieces_os_client/models/streamed_identifiers.py @@ -28,7 +28,7 @@ class StreamedIdentifiers(BaseModel): """ This is currently only used within /assets/steam/identifiers && /conversations/steam/identifiers but can be used with other as well, if we want to expand this class. && expand the StreamedIdentifier class. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(StreamedIdentifier) = Field(...) __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/suggestion.py b/src/pieces_os_client/models/suggestion.py index bf7613b..171abb9 100644 --- a/src/pieces_os_client/models/suggestion.py +++ b/src/pieces_os_client/models/suggestion.py @@ -31,7 +31,7 @@ class Suggestion(BaseModel): """ This is the model return by the connector's suggest endpoint. Note: assets are the assets that this target was ran against. distribution is the distribution that we generated from comparing the target to the asset's vectors.(currently uuid(assetid) : value that is the difference between the asset and the target) **could potentially make an additional model here that is an array from most to least relevent. *** distribution is required but we are currently unable to reflect that with our current dart generation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") reuse: ReuseSuggestion = Field(...) save: SaveSuggestion = Field(...) target: SuggestionTarget = Field(...) diff --git a/src/pieces_os_client/models/suggestion_target.py b/src/pieces_os_client/models/suggestion_target.py index 7d30868..34a5c6a 100644 --- a/src/pieces_os_client/models/suggestion_target.py +++ b/src/pieces_os_client/models/suggestion_target.py @@ -28,9 +28,9 @@ class SuggestionTarget(BaseModel): """ This is the target that was sent to pieces. This will return the string that represents this coppied || pasted asset. This will also send along the SeededConnectorCreation and will send along the vector that we created based on the seed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") seed: SeededConnectorCreation = Field(...) - vector: StrictInt = Field(..., description="This is the vector representation of this target that we generated.") + vector: StrictInt = Field(default=..., description="This is the vector representation of this target that we generated.") __properties = ["schema", "seed", "vector"] class Config: diff --git a/src/pieces_os_client/models/system_execution_cpu_information.py b/src/pieces_os_client/models/system_execution_cpu_information.py index b117f0f..324efa2 100644 --- a/src/pieces_os_client/models/system_execution_cpu_information.py +++ b/src/pieces_os_client/models/system_execution_cpu_information.py @@ -26,8 +26,8 @@ class SystemExecutionCpuInformation(BaseModel): """ SystemExecutionCpuInformation """ - count: StrictInt = Field(..., description="this is the number of cpus") - brand: StrictStr = Field(..., description="this is the brand of cpu") + count: StrictInt = Field(default=..., description="this is the number of cpus") + brand: StrictStr = Field(default=..., description="this is the brand of cpu") frequency: StrictInt = Field(...) __properties = ["count", "brand", "frequency"] diff --git a/src/pieces_os_client/models/tag.py b/src/pieces_os_client/models/tag.py index bc4e1be..552be87 100644 --- a/src/pieces_os_client/models/tag.py +++ b/src/pieces_os_client/models/tag.py @@ -34,17 +34,17 @@ class Tag(BaseModel): """ This represents a fully polinated Tag, that is either attached to an asset or a format that adds additional information \"tags\" to describe itself.Helps improve Search and other contextual information that is useful for the user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="UUID that represents the tag.") - text: StrictStr = Field(..., description="represnts the value of a tag.") - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="UUID that represents the tag.") + text: StrictStr = Field(default=..., description="represnts the value of a tag.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") assets: Optional[FlattenedAssets] = None created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None category: TagCategoryEnum = Field(...) relationship: Optional[Relationship] = None - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") persons: Optional[FlattenedPersons] = None score: Optional[Score] = None __properties = ["schema", "id", "text", "mechanisms", "assets", "created", "updated", "deleted", "category", "relationship", "interactions", "persons", "score"] diff --git a/src/pieces_os_client/models/tags.py b/src/pieces_os_client/models/tags.py index 83275bb..93de463 100644 --- a/src/pieces_os_client/models/tags.py +++ b/src/pieces_os_client/models/tags.py @@ -29,9 +29,9 @@ class Tags(BaseModel): """ This is a model that represents multiple Tag Models # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Tag) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an tag id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an tag id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/temporal_search_options.py b/src/pieces_os_client/models/temporal_search_options.py new file mode 100644 index 0000000..0681051 --- /dev/null +++ b/src/pieces_os_client/models/temporal_search_options.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.anonymous_temporal_range import AnonymousTemporalRange +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class TemporalSearchOptions(BaseModel): + """ + created: will return the materials based on if the range is satisfied w/ this created timestamp ** same goes for updated # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + created: Optional[AnonymousTemporalRange] = None + updated: Optional[AnonymousTemporalRange] = None + __properties = ["schema", "created", "updated"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TemporalSearchOptions: + """Create an instance of TemporalSearchOptions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of created + if self.created: + _dict['created'] = self.created.to_dict() + # override the default output from pydantic by calling `to_dict()` of updated + if self.updated: + _dict['updated'] = self.updated.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TemporalSearchOptions: + """Create an instance of TemporalSearchOptions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TemporalSearchOptions.parse_obj(obj) + + _obj = TemporalSearchOptions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "created": AnonymousTemporalRange.from_dict(obj.get("created")) if obj.get("created") is not None else None, + "updated": AnonymousTemporalRange.from_dict(obj.get("updated")) if obj.get("updated") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/terminating_os_server_applet.py b/src/pieces_os_client/models/terminating_os_server_applet.py new file mode 100644 index 0000000..7aa37c3 --- /dev/null +++ b/src/pieces_os_client/models/terminating_os_server_applet.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictInt +from pieces_os_client.models.application import Application +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.os_applet_enum import OSAppletEnum + +class TerminatingOSServerApplet(BaseModel): + """ + TODO # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + parent: Optional[Application] = None + port: Optional[StrictInt] = Field(default=None, description="Validation check if the port is passed in.") + type: OSAppletEnum = Field(...) + __properties = ["schema", "parent", "port", "type"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TerminatingOSServerApplet: + """Create an instance of TerminatingOSServerApplet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of parent + if self.parent: + _dict['parent'] = self.parent.to_dict() + # set to None if port (nullable) is None + # and __fields_set__ contains the field + if self.port is None and "port" in self.__fields_set__: + _dict['port'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TerminatingOSServerApplet: + """Create an instance of TerminatingOSServerApplet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TerminatingOSServerApplet.parse_obj(obj) + + _obj = TerminatingOSServerApplet.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "parent": Application.from_dict(obj.get("parent")) if obj.get("parent") is not None else None, + "port": obj.get("port"), + "type": obj.get("type") + }) + return _obj + + diff --git a/src/pieces_os_client/models/text_location.py b/src/pieces_os_client/models/text_location.py index d6f69f6..99231de 100644 --- a/src/pieces_os_client/models/text_location.py +++ b/src/pieces_os_client/models/text_location.py @@ -27,10 +27,10 @@ class TextLocation(BaseModel): """ This is a generic model that is used for text location. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - text: StrictStr = Field(..., description="this is the value that was found.") - start: StrictInt = Field(..., description="this is the start index within the original string.") - end: StrictInt = Field(..., description="this is the end index within the original string.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + text: StrictStr = Field(default=..., description="this is the value that was found.") + start: StrictInt = Field(default=..., description="this is the start index within the original string.") + end: StrictInt = Field(default=..., description="this is the end index within the original string.") __properties = ["schema", "text", "start", "end"] class Config: diff --git a/src/pieces_os_client/models/text_match.py b/src/pieces_os_client/models/text_match.py index 9390966..a7b576d 100644 --- a/src/pieces_os_client/models/text_match.py +++ b/src/pieces_os_client/models/text_match.py @@ -28,7 +28,7 @@ class TextMatch(BaseModel): """ Thext Match currently used for sensitive for scales for people, and anything related to text matching. group: is the entire match subgroup is the inner match within the group.(optional) # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") group: TextLocation = Field(...) subgroup: Optional[TextLocation] = None __properties = ["schema", "group", "subgroup"] diff --git a/src/pieces_os_client/models/textually_extracted_material.py b/src/pieces_os_client/models/textually_extracted_material.py new file mode 100644 index 0000000..9688106 --- /dev/null +++ b/src/pieces_os_client/models/textually_extracted_material.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_anchors import FlattenedAnchors +from pieces_os_client.models.flattened_persons import FlattenedPersons +from pieces_os_client.models.flattened_websites import FlattenedWebsites +from pieces_os_client.models.seeds import Seeds +from pieces_os_client.models.text_location import TextLocation + +class TextuallyExtractedMaterial(BaseModel): + """ + This is an extraction, this was a person/website/anchor that was extracted this will return the text location where this was found within the extraction. as well return the material itself that was extracted. Note: - seeds: will only be extracted people if provided, because the website/anchors will be created if extracted. - basically only thing that is different about the extracted people, if that if we extract a person that was not already saved, then we will not save them, however if there are related people then we will add them as well. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + match: TextLocation = Field(...) + websites: Optional[FlattenedWebsites] = None + anchors: Optional[FlattenedAnchors] = None + persons: Optional[FlattenedPersons] = None + seeds: Optional[Seeds] = None + __properties = ["schema", "match", "websites", "anchors", "persons", "seeds"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TextuallyExtractedMaterial: + """Create an instance of TextuallyExtractedMaterial from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of match + if self.match: + _dict['match'] = self.match.to_dict() + # override the default output from pydantic by calling `to_dict()` of websites + if self.websites: + _dict['websites'] = self.websites.to_dict() + # override the default output from pydantic by calling `to_dict()` of anchors + if self.anchors: + _dict['anchors'] = self.anchors.to_dict() + # override the default output from pydantic by calling `to_dict()` of persons + if self.persons: + _dict['persons'] = self.persons.to_dict() + # override the default output from pydantic by calling `to_dict()` of seeds + if self.seeds: + _dict['seeds'] = self.seeds.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TextuallyExtractedMaterial: + """Create an instance of TextuallyExtractedMaterial from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TextuallyExtractedMaterial.parse_obj(obj) + + _obj = TextuallyExtractedMaterial.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "match": TextLocation.from_dict(obj.get("match")) if obj.get("match") is not None else None, + "websites": FlattenedWebsites.from_dict(obj.get("websites")) if obj.get("websites") is not None else None, + "anchors": FlattenedAnchors.from_dict(obj.get("anchors")) if obj.get("anchors") is not None else None, + "persons": FlattenedPersons.from_dict(obj.get("persons")) if obj.get("persons") is not None else None, + "seeds": Seeds.from_dict(obj.get("seeds")) if obj.get("seeds") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/textually_extracted_materials.py b/src/pieces_os_client/models/textually_extracted_materials.py new file mode 100644 index 0000000..0960b40 --- /dev/null +++ b/src/pieces_os_client/models/textually_extracted_materials.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.textually_extracted_material import TextuallyExtractedMaterial + +class TextuallyExtractedMaterials(BaseModel): + """ + This is a plural of an Extraction # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(TextuallyExtractedMaterial) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TextuallyExtractedMaterials: + """Create an instance of TextuallyExtractedMaterials from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TextuallyExtractedMaterials: + """Create an instance of TextuallyExtractedMaterials from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TextuallyExtractedMaterials.parse_obj(obj) + + _obj = TextuallyExtractedMaterials.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [TextuallyExtractedMaterial.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/theme.py b/src/pieces_os_client/models/theme.py index d075a78..88e37b8 100644 --- a/src/pieces_os_client/models/theme.py +++ b/src/pieces_os_client/models/theme.py @@ -27,7 +27,7 @@ class Theme(BaseModel): """ This will describe the theme that belongs to a user. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") dark: StrictBool = Field(...) __properties = ["schema", "dark"] diff --git a/src/pieces_os_client/models/tlp_code_directory_analytics.py b/src/pieces_os_client/models/tlp_code_directory_analytics.py index 13467c9..9bcc282 100644 --- a/src/pieces_os_client/models/tlp_code_directory_analytics.py +++ b/src/pieces_os_client/models/tlp_code_directory_analytics.py @@ -27,7 +27,7 @@ class TLPCodeDirectoryAnalytics(BaseModel): """ TLPCodeDirectoryAnalytics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/tlp_code_file_analytics.py b/src/pieces_os_client/models/tlp_code_file_analytics.py index c2025fd..5e9bac4 100644 --- a/src/pieces_os_client/models/tlp_code_file_analytics.py +++ b/src/pieces_os_client/models/tlp_code_file_analytics.py @@ -27,7 +27,7 @@ class TLPCodeFileAnalytics(BaseModel): """ TLPCodeFileAnalytics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_classification.py b/src/pieces_os_client/models/tlp_code_fragment_classification.py index 3faa7bf..a1f8b3f 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_classification.py +++ b/src/pieces_os_client/models/tlp_code_fragment_classification.py @@ -29,7 +29,7 @@ class TLPCodeFragmentClassification(BaseModel): """ Model for ML big query classification. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) model: StrictStr = Field(...) created: StrictStr = Field(...) @@ -38,8 +38,8 @@ class TLPCodeFragmentClassification(BaseModel): context: StrictStr = Field(...) distribution: Optional[StrictStr] = None metadata: Optional[TLPCodeFragmentClassificationMetadata] = None - user: StrictStr = Field(..., description="identifier for the user") - latency: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="this is the time it takes to run this model.") + user: StrictStr = Field(default=..., description="identifier for the user") + latency: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="this is the time it takes to run this model.") system: Optional[SystemExecutionInformation] = None __properties = ["schema", "asset", "model", "created", "classification", "probability", "context", "distribution", "metadata", "user", "latency", "system"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_classification_metadata.py b/src/pieces_os_client/models/tlp_code_fragment_classification_metadata.py index 03113aa..aef6211 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_classification_metadata.py +++ b/src/pieces_os_client/models/tlp_code_fragment_classification_metadata.py @@ -28,7 +28,7 @@ class TLPCodeFragmentClassificationMetadata(BaseModel): """ TLPCodeFragmentClassificationMetadata """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") context: Optional[Classification] = None prior: Optional[Classification] = None __properties = ["schema", "context", "prior"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_description.py b/src/pieces_os_client/models/tlp_code_fragment_description.py index 3ad97b0..a057b78 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_description.py +++ b/src/pieces_os_client/models/tlp_code_fragment_description.py @@ -26,14 +26,14 @@ class TLPCodeFragmentDescription(BaseModel): """ Model for ML big query Code Description. # noqa: E501 """ - description: Optional[StrictStr] = Field(None, description="This is the stringified json of a TLPDescription object") - asset: StrictStr = Field(..., description="This is the asset id.") - created: StrictStr = Field(..., description="timestamp of creation") - model: StrictStr = Field(..., description="this is the model version") - latency: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="the time it takes to run this model.") - user: StrictStr = Field(..., description="the uuid of the user the description was created for.") - context: Optional[StrictStr] = Field(None, description="the application this description was created from.") - os: Optional[StrictStr] = Field(None, description="This is the UUID of the OS that this context is currently connected to.") + description: Optional[StrictStr] = Field(default=None, description="This is the stringified json of a TLPDescription object") + asset: StrictStr = Field(default=..., description="This is the asset id.") + created: StrictStr = Field(default=..., description="timestamp of creation") + model: StrictStr = Field(default=..., description="this is the model version") + latency: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="the time it takes to run this model.") + user: StrictStr = Field(default=..., description="the uuid of the user the description was created for.") + context: Optional[StrictStr] = Field(default=None, description="the application this description was created from.") + os: Optional[StrictStr] = Field(default=None, description="This is the UUID of the OS that this context is currently connected to.") __properties = ["description", "asset", "created", "model", "latency", "user", "context", "os"] class Config: diff --git a/src/pieces_os_client/models/tlp_code_fragment_descriptive_statistics.py b/src/pieces_os_client/models/tlp_code_fragment_descriptive_statistics.py index 4314364..6c8d99a 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_descriptive_statistics.py +++ b/src/pieces_os_client/models/tlp_code_fragment_descriptive_statistics.py @@ -27,7 +27,7 @@ class TLPCodeFragmentDescriptiveStatistics(BaseModel): """ Model for ML big query Data collection. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") user: StrictStr = Field(...) os: StrictStr = Field(...) language: StrictStr = Field(...) @@ -35,8 +35,8 @@ class TLPCodeFragmentDescriptiveStatistics(BaseModel): ast: StrictStr = Field(...) timestamp: StrictStr = Field(...) asset: StrictStr = Field(...) - context: StrictStr = Field(..., description="this is the application in which this was created from.") - snippet: StrictStr = Field(..., description="this is the value of the snippet") + context: StrictStr = Field(default=..., description="this is the application in which this was created from.") + snippet: StrictStr = Field(default=..., description="this is the value of the snippet") __properties = ["schema", "user", "os", "language", "length", "ast", "timestamp", "asset", "context", "snippet"] class Config: diff --git a/src/pieces_os_client/models/tlp_code_fragment_reclassification.py b/src/pieces_os_client/models/tlp_code_fragment_reclassification.py index c5c2a74..ae55f53 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_reclassification.py +++ b/src/pieces_os_client/models/tlp_code_fragment_reclassification.py @@ -28,13 +28,13 @@ class TLPCodeFragmentReclassification(BaseModel): """ Model for ML big query Reclassification. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) model: StrictStr = Field(...) created: StrictStr = Field(...) updates: TLPCodeFragmentReclassificationUpdates = Field(...) - user: StrictStr = Field(..., description="this is the user that is reclassifying") - context: StrictStr = Field(..., description="this is the application is which this is from.") + user: StrictStr = Field(default=..., description="this is the user that is reclassifying") + context: StrictStr = Field(default=..., description="this is the application is which this is from.") __properties = ["schema", "asset", "model", "created", "updates", "user", "context"] class Config: diff --git a/src/pieces_os_client/models/tlp_code_fragment_reclassification_updates.py b/src/pieces_os_client/models/tlp_code_fragment_reclassification_updates.py index 6f1902e..e4def73 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_reclassification_updates.py +++ b/src/pieces_os_client/models/tlp_code_fragment_reclassification_updates.py @@ -28,7 +28,7 @@ class TLPCodeFragmentReclassificationUpdates(BaseModel): """ TLPCodeFragmentReclassificationUpdates """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") previous: Classification = Field(...) current: Classification = Field(...) __properties = ["schema", "previous", "current"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_statistics.py b/src/pieces_os_client/models/tlp_code_fragment_statistics.py index 5d2edf2..0c3074f 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_statistics.py +++ b/src/pieces_os_client/models/tlp_code_fragment_statistics.py @@ -28,7 +28,7 @@ class TLPCodeFragmentStatistics(BaseModel): """ TLPCodeFragmentStatistics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") descriptive: Optional[TLPCodeFragmentDescriptiveStatistics] = None __properties = ["schema", "descriptive"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_suggested_reuse.py b/src/pieces_os_client/models/tlp_code_fragment_suggested_reuse.py index 43487cc..62a15fc 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_suggested_reuse.py +++ b/src/pieces_os_client/models/tlp_code_fragment_suggested_reuse.py @@ -27,7 +27,7 @@ class TLPCodeFragmentSuggestedReuse(BaseModel): """ TLPCodeFragmentSuggestedReuse """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/tlp_code_fragment_suggested_save.py b/src/pieces_os_client/models/tlp_code_fragment_suggested_save.py index 08bc65b..113860b 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_suggested_save.py +++ b/src/pieces_os_client/models/tlp_code_fragment_suggested_save.py @@ -27,15 +27,15 @@ class TLPCodeFragmentSuggestedSave(BaseModel): """ Model for monitoring and evaluating the suggested save feature # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") asset: StrictStr = Field(...) user: StrictStr = Field(...) model: StrictStr = Field(...) created: StrictStr = Field(...) os: StrictStr = Field(...) - context: Optional[StrictStr] = Field(None, description="context from where suggestion came from") - score: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="maximum similarity score") - candidates: Optional[StrictInt] = Field(None, description="number of candidates") + context: Optional[StrictStr] = Field(default=None, description="context from where suggestion came from") + score: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="maximum similarity score") + candidates: Optional[StrictInt] = Field(default=None, description="number of candidates") __properties = ["schema", "asset", "user", "model", "created", "os", "context", "score", "candidates"] class Config: diff --git a/src/pieces_os_client/models/tlp_code_fragment_tagify.py b/src/pieces_os_client/models/tlp_code_fragment_tagify.py index 30d4156..6abe810 100644 --- a/src/pieces_os_client/models/tlp_code_fragment_tagify.py +++ b/src/pieces_os_client/models/tlp_code_fragment_tagify.py @@ -28,7 +28,7 @@ class TLPCodeFragmentTagify(BaseModel): """ TLPCodeFragmentTagify """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code: Optional[TLPCodeSnippetTagifyCode] = None __properties = ["schema", "code"] diff --git a/src/pieces_os_client/models/tlp_code_processing.py b/src/pieces_os_client/models/tlp_code_processing.py index 8bf5e62..e3971e8 100644 --- a/src/pieces_os_client/models/tlp_code_processing.py +++ b/src/pieces_os_client/models/tlp_code_processing.py @@ -31,7 +31,7 @@ class TLPCodeProcessing(BaseModel): """ TLPCodeProcessing """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") fragment: Optional[TLPCodeSnippetAnalytics] = None file: Optional[TLPCodeFileAnalytics] = None directory: Optional[TLPCodeDirectoryAnalytics] = None diff --git a/src/pieces_os_client/models/tlp_code_repository_analytics.py b/src/pieces_os_client/models/tlp_code_repository_analytics.py index 7dac1f4..da42dc0 100644 --- a/src/pieces_os_client/models/tlp_code_repository_analytics.py +++ b/src/pieces_os_client/models/tlp_code_repository_analytics.py @@ -27,7 +27,7 @@ class TLPCodeRepositoryAnalytics(BaseModel): """ TLPCodeRepositoryAnalytics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: Optional[StrictStr] = None __properties = ["schema", "id"] diff --git a/src/pieces_os_client/models/tlp_code_snippet_analytics.py b/src/pieces_os_client/models/tlp_code_snippet_analytics.py index 77b36dc..8d4a92f 100644 --- a/src/pieces_os_client/models/tlp_code_snippet_analytics.py +++ b/src/pieces_os_client/models/tlp_code_snippet_analytics.py @@ -33,7 +33,7 @@ class TLPCodeSnippetAnalytics(BaseModel): """ TLPCodeSnippetAnalytics """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") statistics: Optional[TLPCodeFragmentStatistics] = None classification: Optional[TLPCodeFragmentClassification] = None reclassification: Optional[TLPCodeFragmentReclassification] = None diff --git a/src/pieces_os_client/models/tlp_code_snippet_suggested_interactions.py b/src/pieces_os_client/models/tlp_code_snippet_suggested_interactions.py index 21ff5ce..186a588 100644 --- a/src/pieces_os_client/models/tlp_code_snippet_suggested_interactions.py +++ b/src/pieces_os_client/models/tlp_code_snippet_suggested_interactions.py @@ -29,7 +29,7 @@ class TLPCodeSnippetSuggestedInteractions(BaseModel): """ TLPCodeSnippetSuggestedInteractions """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") save: Optional[TLPCodeFragmentSuggestedSave] = None reuse: Optional[TLPCodeFragmentSuggestedReuse] = None __properties = ["schema", "save", "reuse"] diff --git a/src/pieces_os_client/models/tlp_code_snippet_tagify_code.py b/src/pieces_os_client/models/tlp_code_snippet_tagify_code.py index d130334..2714a29 100644 --- a/src/pieces_os_client/models/tlp_code_snippet_tagify_code.py +++ b/src/pieces_os_client/models/tlp_code_snippet_tagify_code.py @@ -27,17 +27,17 @@ class TLPCodeSnippetTagifyCode(BaseModel): """ # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - distribution: StrictStr = Field(..., description="stringified array of numbers") - inferred_distribution: StrictStr = Field(..., description="stringified array of numbers") - tags: StrictStr = Field(..., description="stringified array of strings") - inferred_tags: StrictStr = Field(..., description="stringified array of strings") - model: StrictStr = Field(..., description="this is the model version ") - label_version: StrictStr = Field(..., description="This is the version of the file that we are using that contains all the possible tags") - threshold: Union[StrictFloat, StrictInt] = Field(..., description="this is the minimum score from the model that a tag needs to have to be included in the tags array.") - inferred_threshold: Union[StrictFloat, StrictInt] = Field(..., description="this is the minimum score from the postprocessing that a tag needs to have to be included in the inferred_tags array.") - context: StrictStr = Field(..., description="this is the origin in which this asset was created, application(string representation)") - asset: StrictStr = Field(..., description="This is the asset id.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + distribution: StrictStr = Field(default=..., description="stringified array of numbers") + inferred_distribution: StrictStr = Field(default=..., description="stringified array of numbers") + tags: StrictStr = Field(default=..., description="stringified array of strings") + inferred_tags: StrictStr = Field(default=..., description="stringified array of strings") + model: StrictStr = Field(default=..., description="this is the model version ") + label_version: StrictStr = Field(default=..., description="This is the version of the file that we are using that contains all the possible tags") + threshold: Union[StrictFloat, StrictInt] = Field(default=..., description="this is the minimum score from the model that a tag needs to have to be included in the tags array.") + inferred_threshold: Union[StrictFloat, StrictInt] = Field(default=..., description="this is the minimum score from the postprocessing that a tag needs to have to be included in the inferred_tags array.") + context: StrictStr = Field(default=..., description="this is the origin in which this asset was created, application(string representation)") + asset: StrictStr = Field(default=..., description="This is the asset id.") __properties = ["schema", "distribution", "inferred_distribution", "tags", "inferred_tags", "model", "label_version", "threshold", "inferred_threshold", "context", "asset"] class Config: diff --git a/src/pieces_os_client/models/tlp_directed_discovery_filters.py b/src/pieces_os_client/models/tlp_directed_discovery_filters.py index dd2d48b..02d0ec1 100644 --- a/src/pieces_os_client/models/tlp_directed_discovery_filters.py +++ b/src/pieces_os_client/models/tlp_directed_discovery_filters.py @@ -27,7 +27,7 @@ class TLPDirectedDiscoveryFilters(BaseModel): """ Contains array of TLPDirectedDiscoveryFilter # noqa: E501 """ - iterable: conlist(TLPDirectedDiscoveryFilter) = Field(..., description="Array that contains filters like class/function/loop") + iterable: conlist(TLPDirectedDiscoveryFilter) = Field(default=..., description="Array that contains filters like class/function/loop") __properties = ["iterable"] class Config: diff --git a/src/pieces_os_client/models/tlp_machine_learning_processing_event.py b/src/pieces_os_client/models/tlp_machine_learning_processing_event.py index 8da515f..57ffabf 100644 --- a/src/pieces_os_client/models/tlp_machine_learning_processing_event.py +++ b/src/pieces_os_client/models/tlp_machine_learning_processing_event.py @@ -28,7 +28,7 @@ class TLPMachineLearningProcessingEvent(BaseModel): """ TLPMachineLearningProcessingEvent """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") code: Optional[TLPCodeProcessing] = None __properties = ["schema", "code"] diff --git a/src/pieces_os_client/models/tokenized_pkce.py b/src/pieces_os_client/models/tokenized_pkce.py index d48e804..5467d45 100644 --- a/src/pieces_os_client/models/tokenized_pkce.py +++ b/src/pieces_os_client/models/tokenized_pkce.py @@ -27,13 +27,13 @@ class TokenizedPKCE(BaseModel): """ This is the flow that mobile apps use to access an API. Use this endpoint to exchange an Authorization Code for a Token. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - grant_type: StrictStr = Field(..., description="Denotes the flow you are using. For Authorization Code, use authorization_code or refresh_token.") - client_id: StrictStr = Field(..., description="Your application's Client ID.") - code: StrictStr = Field(..., description="The Authorization Code received from the initial /authorize call.") - redirect_uri: StrictStr = Field(..., description="This is required only if it was set at the GET /authorize endpoint. The values must match.") - code_verifier: StrictStr = Field(..., description="Cryptographically random key that was used to generate the code_challenge passed to /authorize.") - audience: Optional[StrictStr] = Field(None, description="The audience domain: i.e. https://pieces.us.auth0.com") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + grant_type: StrictStr = Field(default=..., description="Denotes the flow you are using. For Authorization Code, use authorization_code or refresh_token.") + client_id: StrictStr = Field(default=..., description="Your application's Client ID.") + code: StrictStr = Field(default=..., description="The Authorization Code received from the initial /authorize call.") + redirect_uri: StrictStr = Field(default=..., description="This is required only if it was set at the GET /authorize endpoint. The values must match.") + code_verifier: StrictStr = Field(default=..., description="Cryptographically random key that was used to generate the code_challenge passed to /authorize.") + audience: Optional[StrictStr] = Field(default=None, description="The audience domain: i.e. https://pieces.us.auth0.com") __properties = ["schema", "grant_type", "client_id", "code", "redirect_uri", "code_verifier", "audience"] @validator('grant_type') diff --git a/src/pieces_os_client/models/tracked_application_install.py b/src/pieces_os_client/models/tracked_application_install.py index 776c72d..11b6707 100644 --- a/src/pieces_os_client/models/tracked_application_install.py +++ b/src/pieces_os_client/models/tracked_application_install.py @@ -29,7 +29,7 @@ class TrackedApplicationInstall(BaseModel): """ A model that allows for us to specifically track Application Installs & Related Data # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") application: Application = Field(...) user: Optional[TrackedUserProfile] = None __properties = ["schema", "application", "user"] diff --git a/src/pieces_os_client/models/tracked_application_update.py b/src/pieces_os_client/models/tracked_application_update.py index b839831..8f0eed4 100644 --- a/src/pieces_os_client/models/tracked_application_update.py +++ b/src/pieces_os_client/models/tracked_application_update.py @@ -29,7 +29,7 @@ class TrackedApplicationUpdate(BaseModel): """ This is a model used to track when an Application is Updated # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") current: Application = Field(...) previous: Optional[Application] = None user: Optional[TrackedUserProfile] = None diff --git a/src/pieces_os_client/models/tracked_asset_event_creation_metadata.py b/src/pieces_os_client/models/tracked_asset_event_creation_metadata.py index 7eb7bf1..48ce74a 100644 --- a/src/pieces_os_client/models/tracked_asset_event_creation_metadata.py +++ b/src/pieces_os_client/models/tracked_asset_event_creation_metadata.py @@ -29,7 +29,7 @@ class TrackedAssetEventCreationMetadata(BaseModel): """ Metadata attached to a creation event on an Asset # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") clipboard: Optional[TrackedAssetEventCreationMetadataClipboard] = None file: Optional[TrackedAssetEventCreationMetadataFile] = None __properties = ["schema", "clipboard", "file"] diff --git a/src/pieces_os_client/models/tracked_asset_event_creation_metadata_clipboard.py b/src/pieces_os_client/models/tracked_asset_event_creation_metadata_clipboard.py index 9ecb5cc..d0aff4c 100644 --- a/src/pieces_os_client/models/tracked_asset_event_creation_metadata_clipboard.py +++ b/src/pieces_os_client/models/tracked_asset_event_creation_metadata_clipboard.py @@ -27,9 +27,9 @@ class TrackedAssetEventCreationMetadataClipboard(BaseModel): """ If an asset was created from a clipboard event # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - keyboard: Optional[StrictBool] = Field(None, description="Whether the clipboard was utilized via the keyboard") - interaction: Optional[StrictBool] = Field(None, description="Whether the clipboard was extracted through a button click") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + keyboard: Optional[StrictBool] = Field(default=None, description="Whether the clipboard was utilized via the keyboard") + interaction: Optional[StrictBool] = Field(default=None, description="Whether the clipboard was extracted through a button click") __properties = ["schema", "keyboard", "interaction"] class Config: diff --git a/src/pieces_os_client/models/tracked_asset_event_creation_metadata_file.py b/src/pieces_os_client/models/tracked_asset_event_creation_metadata_file.py index ca90c46..49d35cd 100644 --- a/src/pieces_os_client/models/tracked_asset_event_creation_metadata_file.py +++ b/src/pieces_os_client/models/tracked_asset_event_creation_metadata_file.py @@ -26,9 +26,9 @@ class TrackedAssetEventCreationMetadataFile(BaseModel): """ If an asset was created from a file attachment # noqa: E501 """ - keyboard: Optional[StrictBool] = Field(None, description="Whether the file was pasted via the keyboard") - drag_and_drop: Optional[StrictBool] = Field(None, description="Whether the file was dropped onto pieces") - interaction: Optional[StrictBool] = Field(None, description="Whether the file was attached via a button click") + keyboard: Optional[StrictBool] = Field(default=None, description="Whether the file was pasted via the keyboard") + drag_and_drop: Optional[StrictBool] = Field(default=None, description="Whether the file was dropped onto pieces") + interaction: Optional[StrictBool] = Field(default=None, description="Whether the file was attached via a button click") __properties = ["keyboard", "drag_and_drop", "interaction"] class Config: diff --git a/src/pieces_os_client/models/tracked_asset_event_format_reclassification_metadata.py b/src/pieces_os_client/models/tracked_asset_event_format_reclassification_metadata.py index 304e273..513044c 100644 --- a/src/pieces_os_client/models/tracked_asset_event_format_reclassification_metadata.py +++ b/src/pieces_os_client/models/tracked_asset_event_format_reclassification_metadata.py @@ -28,7 +28,7 @@ class TrackedAssetEventFormatReclassificationMetadata(BaseModel): """ Metadata of a format reclassification event # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") previous: Optional[Classification] = None current: Optional[Classification] = None __properties = ["schema", "previous", "current"] diff --git a/src/pieces_os_client/models/tracked_asset_event_identifier_description_pairs.py b/src/pieces_os_client/models/tracked_asset_event_identifier_description_pairs.py index 83f9530..0f14493 100644 --- a/src/pieces_os_client/models/tracked_asset_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/tracked_asset_event_identifier_description_pairs.py @@ -27,34 +27,34 @@ class TrackedAssetEventIdentifierDescriptionPairs(BaseModel): """ These are all of the available event types that are permitted in an object pair notation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - asset_created: Optional[StrictStr] = Field(None, description="The key value pair for an asset being created.") - asset_viewed: Optional[StrictStr] = Field(None, description="An asset was viewed") - asset_format_copied: Optional[StrictStr] = Field(None, description="An asset's format was copied") - asset_format_downloaded: Optional[StrictStr] = Field(None, description="An asset's format was downloaded") - asset_deleted: Optional[StrictStr] = Field(None, description="An asset was deleted or not") - asset_description_updated: Optional[StrictStr] = Field(None, description="An asset was redescribed by the user") - asset_name_updated: Optional[StrictStr] = Field(None, description="An asset was renamed by the user") - asset_format_generic_classification_updated: Optional[StrictStr] = Field(None, description="A generic classification was changed on a format within an asset") - asset_format_specific_classification_updated: Optional[StrictStr] = Field(None, description="A specific classification was changed on a format within an asset") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + asset_created: Optional[StrictStr] = Field(default=None, description="The key value pair for an asset being created.") + asset_viewed: Optional[StrictStr] = Field(default=None, description="An asset was viewed") + asset_format_copied: Optional[StrictStr] = Field(default=None, description="An asset's format was copied") + asset_format_downloaded: Optional[StrictStr] = Field(default=None, description="An asset's format was downloaded") + asset_deleted: Optional[StrictStr] = Field(default=None, description="An asset was deleted or not") + asset_description_updated: Optional[StrictStr] = Field(default=None, description="An asset was redescribed by the user") + asset_name_updated: Optional[StrictStr] = Field(default=None, description="An asset was renamed by the user") + asset_format_generic_classification_updated: Optional[StrictStr] = Field(default=None, description="A generic classification was changed on a format within an asset") + asset_format_specific_classification_updated: Optional[StrictStr] = Field(default=None, description="A specific classification was changed on a format within an asset") asset_creation_failed: Optional[StrictStr] = None asset_tag_added: Optional[StrictStr] = None asset_link_added: Optional[StrictStr] = None - asset_link_generated: Optional[StrictStr] = Field(None, description="user generated a link for the asset") + asset_link_generated: Optional[StrictStr] = Field(default=None, description="user generated a link for the asset") asset_link_deleted: Optional[StrictStr] = None asset_tag_deleted: Optional[StrictStr] = None - asset_updated: Optional[StrictStr] = Field(None, description="This is just a generic string for an asset was updated.") - asset_format_value_edited: Optional[StrictStr] = Field(None, description="This is a side effect event for a format value getting edited that exists on an asset.") - asset_format_updated: Optional[StrictStr] = Field(None, description="This is a generic activity event for an asset getting updated because our format was updated for some reason.") - asset_link_revoked: Optional[StrictStr] = Field(None, description="This means that a shareable link was revoked.") - asset_person_added: Optional[StrictStr] = Field(None, description="This just means that a person was added via the user.") - asset_person_deleted: Optional[StrictStr] = Field(None, description="This just means that a person was deleted via the user.") - asset_sensitive_added: Optional[StrictStr] = Field(None, description="This just means that a sensitive was added via the user.") - asset_sensitive_deleted: Optional[StrictStr] = Field(None, description="This just means that a sensitive was deleted via the user.") - suggested_asset_referenced: Optional[StrictStr] = Field(None, description="This means that an asset was view/used while the user was looking at the suggestion view.") - searched_asset_referenced: Optional[StrictStr] = Field(None, description="This means that an asset was view/used while the user was looking at the searching view.") - asset_referenced: Optional[StrictStr] = Field(None, description="This means that an asset was view/used while the user was looking at the default view.") - activity_asset_referenced: Optional[StrictStr] = Field(None, description="This means that a user referenced an asset by first clicking on an asset within an activity event.(ie from the activity view)") + asset_updated: Optional[StrictStr] = Field(default=None, description="This is just a generic string for an asset was updated.") + asset_format_value_edited: Optional[StrictStr] = Field(default=None, description="This is a side effect event for a format value getting edited that exists on an asset.") + asset_format_updated: Optional[StrictStr] = Field(default=None, description="This is a generic activity event for an asset getting updated because our format was updated for some reason.") + asset_link_revoked: Optional[StrictStr] = Field(default=None, description="This means that a shareable link was revoked.") + asset_person_added: Optional[StrictStr] = Field(default=None, description="This just means that a person was added via the user.") + asset_person_deleted: Optional[StrictStr] = Field(default=None, description="This just means that a person was deleted via the user.") + asset_sensitive_added: Optional[StrictStr] = Field(default=None, description="This just means that a sensitive was added via the user.") + asset_sensitive_deleted: Optional[StrictStr] = Field(default=None, description="This just means that a sensitive was deleted via the user.") + suggested_asset_referenced: Optional[StrictStr] = Field(default=None, description="This means that an asset was view/used while the user was looking at the suggestion view.") + searched_asset_referenced: Optional[StrictStr] = Field(default=None, description="This means that an asset was view/used while the user was looking at the searching view.") + asset_referenced: Optional[StrictStr] = Field(default=None, description="This means that an asset was view/used while the user was looking at the default view.") + activity_asset_referenced: Optional[StrictStr] = Field(default=None, description="This means that a user referenced an asset by first clicking on an asset within an activity event.(ie from the activity view)") asset_annotation_added: Optional[StrictStr] = None asset_annotation_deleted: Optional[StrictStr] = None asset_annotation_updated: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/tracked_asset_event_rename_metadata.py b/src/pieces_os_client/models/tracked_asset_event_rename_metadata.py index a592448..ebe2746 100644 --- a/src/pieces_os_client/models/tracked_asset_event_rename_metadata.py +++ b/src/pieces_os_client/models/tracked_asset_event_rename_metadata.py @@ -27,7 +27,7 @@ class TrackedAssetEventRenameMetadata(BaseModel): """ This will give specific metadata need to determine what the rename was to/from. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") previous: StrictStr = Field(...) current: StrictStr = Field(...) __properties = ["schema", "previous", "current"] diff --git a/src/pieces_os_client/models/tracked_assets_event_identifier_description_pairs.py b/src/pieces_os_client/models/tracked_assets_event_identifier_description_pairs.py index 113db38..e5b7ec3 100644 --- a/src/pieces_os_client/models/tracked_assets_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/tracked_assets_event_identifier_description_pairs.py @@ -27,8 +27,8 @@ class TrackedAssetsEventIdentifierDescriptionPairs(BaseModel): """ These are all of the available event types that are permitted in an object pair notation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - assets_searched: Optional[StrictStr] = Field(None, description="A If the assets were searched") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + assets_searched: Optional[StrictStr] = Field(default=None, description="A If the assets were searched") __properties = ["schema", "assets_searched"] @validator('assets_searched') diff --git a/src/pieces_os_client/models/tracked_assets_event_search_metadata.py b/src/pieces_os_client/models/tracked_assets_event_search_metadata.py index 23bb0c8..daade32 100644 --- a/src/pieces_os_client/models/tracked_assets_event_search_metadata.py +++ b/src/pieces_os_client/models/tracked_assets_event_search_metadata.py @@ -27,8 +27,8 @@ class TrackedAssetsEventSearchMetadata(BaseModel): """ Metadata attached to a search event on an Asset # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - query: Optional[StrictStr] = Field(None, description="The search query itself") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + query: Optional[StrictStr] = Field(default=None, description="The search query itself") results: Optional[TrackedAssetsEventSearchMetadataResults] = None __properties = ["schema", "query", "results"] diff --git a/src/pieces_os_client/models/tracked_assets_event_search_metadata_results.py b/src/pieces_os_client/models/tracked_assets_event_search_metadata_results.py index c48e30d..41de986 100644 --- a/src/pieces_os_client/models/tracked_assets_event_search_metadata_results.py +++ b/src/pieces_os_client/models/tracked_assets_event_search_metadata_results.py @@ -27,8 +27,8 @@ class TrackedAssetsEventSearchMetadataResults(BaseModel): """ Numbers related to search results # noqa: E501 """ - fuzzy: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Total number of fuzzy results") - exact: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Total number of exact results") + fuzzy: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Total number of fuzzy results") + exact: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Total number of exact results") assets: Optional[FlattenedAssets] = None space: Optional[Space] = None __properties = ["fuzzy", "exact", "assets", "space"] diff --git a/src/pieces_os_client/models/tracked_conversation_event_identifier_description_pairs.py b/src/pieces_os_client/models/tracked_conversation_event_identifier_description_pairs.py index 9bef25a..364182a 100644 --- a/src/pieces_os_client/models/tracked_conversation_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/tracked_conversation_event_identifier_description_pairs.py @@ -27,14 +27,14 @@ class TrackedConversationEventIdentifierDescriptionPairs(BaseModel): """ These are all of the available event types that are permitted in an object pair notation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - conversation_created: Optional[StrictStr] = Field(None, description="The key value pair for an conversation being created.") - conversation_referenced: Optional[StrictStr] = Field(None, description="This means that an conversation was view/used while the user was looking at the default view.") - conversation_deleted: Optional[StrictStr] = Field(None, description="A conversation was deleted") - conversation_summary_annotation_generated_by_the_user: Optional[StrictStr] = Field(None, description="A conversation summary was generated by the user") - conversation_name_updated_by_the_system: Optional[StrictStr] = Field(None, description="A conversation was renamed by the system") - conversation_name_updated_by_the_user: Optional[StrictStr] = Field(None, description="A conversation was renamed by the user") - conversation_summary_annotation_generated_by_the_system: Optional[StrictStr] = Field(None, description="A conversation summary was generated") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + conversation_created: Optional[StrictStr] = Field(default=None, description="The key value pair for an conversation being created.") + conversation_referenced: Optional[StrictStr] = Field(default=None, description="This means that an conversation was view/used while the user was looking at the default view.") + conversation_deleted: Optional[StrictStr] = Field(default=None, description="A conversation was deleted") + conversation_summary_annotation_generated_by_the_user: Optional[StrictStr] = Field(default=None, description="A conversation summary was generated by the user") + conversation_name_updated_by_the_system: Optional[StrictStr] = Field(default=None, description="A conversation was renamed by the system") + conversation_name_updated_by_the_user: Optional[StrictStr] = Field(default=None, description="A conversation was renamed by the user") + conversation_summary_annotation_generated_by_the_system: Optional[StrictStr] = Field(default=None, description="A conversation summary was generated") __properties = ["schema", "conversation_created", "conversation_referenced", "conversation_deleted", "conversation_summary_annotation_generated_by_the_user", "conversation_name_updated_by_the_system", "conversation_name_updated_by_the_user", "conversation_summary_annotation_generated_by_the_system"] @validator('conversation_created') diff --git a/src/pieces_os_client/models/tracked_conversation_event_metadata.py b/src/pieces_os_client/models/tracked_conversation_event_metadata.py index c26e304..3184ca8 100644 --- a/src/pieces_os_client/models/tracked_conversation_event_metadata.py +++ b/src/pieces_os_client/models/tracked_conversation_event_metadata.py @@ -28,7 +28,7 @@ class TrackedConversationEventMetadata(BaseModel): """ This is the metadata for the the ConversationEvent # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") rename: Optional[TrackedConversationEventRenameMetadata] = None __properties = ["schema", "rename"] diff --git a/src/pieces_os_client/models/tracked_conversation_event_rename_metadata.py b/src/pieces_os_client/models/tracked_conversation_event_rename_metadata.py index 0b515a4..43c47f8 100644 --- a/src/pieces_os_client/models/tracked_conversation_event_rename_metadata.py +++ b/src/pieces_os_client/models/tracked_conversation_event_rename_metadata.py @@ -27,7 +27,7 @@ class TrackedConversationEventRenameMetadata(BaseModel): """ This will give specific metadata need to determine what the rename was to/from. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") previous: StrictStr = Field(...) current: StrictStr = Field(...) __properties = ["schema", "previous", "current"] diff --git a/src/pieces_os_client/models/tracked_format.py b/src/pieces_os_client/models/tracked_format.py index e640cf0..d789101 100644 --- a/src/pieces_os_client/models/tracked_format.py +++ b/src/pieces_os_client/models/tracked_format.py @@ -29,11 +29,11 @@ class TrackedFormat(BaseModel): """ A minimal format to send to Mixpanel # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The UUID of the format") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The UUID of the format") classification: Classification = Field(...) role: Role = Field(...) - asset: StrictStr = Field(..., description="The UUID of the asset associated") + asset: StrictStr = Field(default=..., description="The UUID of the asset associated") fragment: StrictBool = Field(...) file: StrictBool = Field(...) __properties = ["schema", "id", "classification", "role", "asset", "fragment", "file"] diff --git a/src/pieces_os_client/models/tracked_format_event.py b/src/pieces_os_client/models/tracked_format_event.py index df7a924..9845a26 100644 --- a/src/pieces_os_client/models/tracked_format_event.py +++ b/src/pieces_os_client/models/tracked_format_event.py @@ -30,8 +30,8 @@ class TrackedFormatEvent(BaseModel): """ This is a model that represents a generic event that we may want to track in relation to a format, for example beamed, copied, downloaded, and view. ** Note: This is the model that will get returned by our api, and is. Representative of a full TrackedFormat event. ** # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - format: TrackedFormat = Field(..., alias=" format") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + format: TrackedFormat = Field(default=..., alias=" format") identifier_description_pair: TrackedFormatEventIdentifierDescriptionPairs = Field(...) metadata: Optional[TrackedFormatEventMetadata] = None __properties = ["schema", " format", "identifier_description_pair", "metadata"] diff --git a/src/pieces_os_client/models/tracked_format_event_identifier_description_pairs.py b/src/pieces_os_client/models/tracked_format_event_identifier_description_pairs.py index 7d9cd52..92344b4 100644 --- a/src/pieces_os_client/models/tracked_format_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/tracked_format_event_identifier_description_pairs.py @@ -27,17 +27,17 @@ class TrackedFormatEventIdentifierDescriptionPairs(BaseModel): """ This is a model that allows us to send send over super specific format related events such as copied, deleted, downloaded, etc # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - format_created: Optional[StrictStr] = Field(None, description="The key value pair for an asset being created.") - format_copied: Optional[StrictStr] = Field(None, description="If a format was copied entirely") - format_partially_copied: Optional[StrictStr] = Field(None, description="If a format was copied partially") - format_downloaded: Optional[StrictStr] = Field(None, description="If a format was downloaded") - format_deleted: Optional[StrictStr] = Field(None, description="If an format was deleted") - format_generic_classification_updated: Optional[StrictStr] = Field(None, description="If a generic classification was changed on a format") - format_specific_classification_updated: Optional[StrictStr] = Field(None, description="If a specific classification was changed on a format") - format_updated: Optional[StrictStr] = Field(None, description="a format was updated, generic update.") - format_inserted: Optional[StrictStr] = Field(None, description="a format was inserted") - format_value_edited: Optional[StrictStr] = Field(None, description="a format's value was update ie, the text, etc...") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + format_created: Optional[StrictStr] = Field(default=None, description="The key value pair for an asset being created.") + format_copied: Optional[StrictStr] = Field(default=None, description="If a format was copied entirely") + format_partially_copied: Optional[StrictStr] = Field(default=None, description="If a format was copied partially") + format_downloaded: Optional[StrictStr] = Field(default=None, description="If a format was downloaded") + format_deleted: Optional[StrictStr] = Field(default=None, description="If an format was deleted") + format_generic_classification_updated: Optional[StrictStr] = Field(default=None, description="If a generic classification was changed on a format") + format_specific_classification_updated: Optional[StrictStr] = Field(default=None, description="If a specific classification was changed on a format") + format_updated: Optional[StrictStr] = Field(default=None, description="a format was updated, generic update.") + format_inserted: Optional[StrictStr] = Field(default=None, description="a format was inserted") + format_value_edited: Optional[StrictStr] = Field(default=None, description="a format's value was update ie, the text, etc...") __properties = ["schema", "format_created", "format_copied", "format_partially_copied", "format_downloaded", "format_deleted", "format_generic_classification_updated", "format_specific_classification_updated", "format_updated", "format_inserted", "format_value_edited"] @validator('format_created') diff --git a/src/pieces_os_client/models/tracked_interaction_event.py b/src/pieces_os_client/models/tracked_interaction_event.py index 58296fa..75580e8 100644 --- a/src/pieces_os_client/models/tracked_interaction_event.py +++ b/src/pieces_os_client/models/tracked_interaction_event.py @@ -27,9 +27,9 @@ class TrackedInteractionEvent(BaseModel): """ This is a model that will hold relavent information in relation to an interaction(ONLY CLICK/TAP) analytics event(usage). If you want to register an event that relates to an interaction with the key then register a Keyboard Event. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - description: StrictStr = Field(..., description="(optional) a description of this button that was clicked. or maybe what it did.") - element: Optional[StrictStr] = Field(None, description="This is an identifer that will allow the developer to know what unique button/field was interacted with.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + description: StrictStr = Field(default=..., description="(optional) a description of this button that was clicked. or maybe what it did.") + element: Optional[StrictStr] = Field(default=None, description="This is an identifer that will allow the developer to know what unique button/field was interacted with.") __properties = ["schema", "description", "element"] class Config: diff --git a/src/pieces_os_client/models/tracked_keyboard_event.py b/src/pieces_os_client/models/tracked_keyboard_event.py index 78d0edd..f6f2bcf 100644 --- a/src/pieces_os_client/models/tracked_keyboard_event.py +++ b/src/pieces_os_client/models/tracked_keyboard_event.py @@ -27,9 +27,9 @@ class TrackedKeyboardEvent(BaseModel): """ This is a model that will hold relavent information in relation to a keyboard(including shortcuts) analytics event (usage). # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - description: StrictStr = Field(..., description="this is a description of the event, optional.") - shortcut: conlist(StrictInt) = Field(..., description="this is an array of of ascii values that represent numerics on your keyboard.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + description: StrictStr = Field(default=..., description="this is a description of the event, optional.") + shortcut: conlist(StrictInt) = Field(default=..., description="this is an array of of ascii values that represent numerics on your keyboard.") __properties = ["schema", "description", "shortcut"] class Config: diff --git a/src/pieces_os_client/models/tracked_session_event_identifier_description_pairs.py b/src/pieces_os_client/models/tracked_session_event_identifier_description_pairs.py index a846e35..1d846e3 100644 --- a/src/pieces_os_client/models/tracked_session_event_identifier_description_pairs.py +++ b/src/pieces_os_client/models/tracked_session_event_identifier_description_pairs.py @@ -27,19 +27,19 @@ class TrackedSessionEventIdentifierDescriptionPairs(BaseModel): """ These are all of the available event types that are permitted in an object pair notation. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - session_initialized: Optional[StrictStr] = Field(None, description="The key value pair for an application being opened.") - session_local_connection_succeeded: Optional[StrictStr] = Field(None, description="There was a successful connection locally") - session_local_connection_failed: Optional[StrictStr] = Field(None, description="There was a failed connection locally") - session_inactive: Optional[StrictStr] = Field(None, description="If the current application is in the background or not, could also be minimized.") - session_active: Optional[StrictStr] = Field(None, description="If the application has been brought to the forground.") - session_terminated: Optional[StrictStr] = Field(None, description="If the user has closed the application, thus ending the session.") - session_authenticated_with_sign_in: Optional[StrictStr] = Field(None, description="A user has signed into this session with a an external account") - session_unauthenticated_with_sign_out: Optional[StrictStr] = Field(None, description="A user has signed out of this session") - session_unauthenticated_with_dismiss: Optional[StrictStr] = Field(None, description="A user did not sign into the session with a dismissal") - session_unauthenticated_with_remind: Optional[StrictStr] = Field(None, description="A user did not sign into the session with a reminder") - session_onboarding_initialized: Optional[StrictStr] = Field(None, description="Onboarding has been initialized for this session") - session_onboarding_completed: Optional[StrictStr] = Field(None, description="Onboarding has been completed for this session") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + session_initialized: Optional[StrictStr] = Field(default=None, description="The key value pair for an application being opened.") + session_local_connection_succeeded: Optional[StrictStr] = Field(default=None, description="There was a successful connection locally") + session_local_connection_failed: Optional[StrictStr] = Field(default=None, description="There was a failed connection locally") + session_inactive: Optional[StrictStr] = Field(default=None, description="If the current application is in the background or not, could also be minimized.") + session_active: Optional[StrictStr] = Field(default=None, description="If the application has been brought to the forground.") + session_terminated: Optional[StrictStr] = Field(default=None, description="If the user has closed the application, thus ending the session.") + session_authenticated_with_sign_in: Optional[StrictStr] = Field(default=None, description="A user has signed into this session with a an external account") + session_unauthenticated_with_sign_out: Optional[StrictStr] = Field(default=None, description="A user has signed out of this session") + session_unauthenticated_with_dismiss: Optional[StrictStr] = Field(default=None, description="A user did not sign into the session with a dismissal") + session_unauthenticated_with_remind: Optional[StrictStr] = Field(default=None, description="A user did not sign into the session with a reminder") + session_onboarding_initialized: Optional[StrictStr] = Field(default=None, description="Onboarding has been initialized for this session") + session_onboarding_completed: Optional[StrictStr] = Field(default=None, description="Onboarding has been completed for this session") __properties = ["schema", "session_initialized", "session_local_connection_succeeded", "session_local_connection_failed", "session_inactive", "session_active", "session_terminated", "session_authenticated_with_sign_in", "session_unauthenticated_with_sign_out", "session_unauthenticated_with_dismiss", "session_unauthenticated_with_remind", "session_onboarding_initialized", "session_onboarding_completed"] @validator('session_initialized') diff --git a/src/pieces_os_client/models/tracked_summary_totals.py b/src/pieces_os_client/models/tracked_summary_totals.py new file mode 100644 index 0000000..8a8f535 --- /dev/null +++ b/src/pieces_os_client/models/tracked_summary_totals.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + + +from pydantic import BaseModel, Field, StrictInt + +class TrackedSummaryTotals(BaseModel): + """ + This is the counts of things that users can add. # noqa: E501 + """ + assets: StrictInt = Field(...) + tags: StrictInt = Field(...) + websites: StrictInt = Field(...) + persons: StrictInt = Field(...) + sensitives: StrictInt = Field(...) + shares: StrictInt = Field(...) + copilot_sends: StrictInt = Field(...) + copilot_receives: StrictInt = Field(...) + copilot_sessions: StrictInt = Field(...) + copilot_conversations: StrictInt = Field(...) + productivity_score: StrictInt = Field(...) + searches: StrictInt = Field(...) + references: StrictInt = Field(...) + reuses: StrictInt = Field(...) + anchor_files: StrictInt = Field(...) + anchor_folders: StrictInt = Field(...) + isr_reports: StrictInt = Field(...) + __properties = ["assets", "tags", "websites", "persons", "sensitives", "shares", "copilot_sends", "copilot_receives", "copilot_sessions", "copilot_conversations", "productivity_score", "searches", "references", "reuses", "anchor_files", "anchor_folders", "isr_reports"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TrackedSummaryTotals: + """Create an instance of TrackedSummaryTotals from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TrackedSummaryTotals: + """Create an instance of TrackedSummaryTotals from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TrackedSummaryTotals.parse_obj(obj) + + _obj = TrackedSummaryTotals.parse_obj({ + "assets": obj.get("assets"), + "tags": obj.get("tags"), + "websites": obj.get("websites"), + "persons": obj.get("persons"), + "sensitives": obj.get("sensitives"), + "shares": obj.get("shares"), + "copilot_sends": obj.get("copilot_sends"), + "copilot_receives": obj.get("copilot_receives"), + "copilot_sessions": obj.get("copilot_sessions"), + "copilot_conversations": obj.get("copilot_conversations"), + "productivity_score": obj.get("productivity_score"), + "searches": obj.get("searches"), + "references": obj.get("references"), + "reuses": obj.get("reuses"), + "anchor_files": obj.get("anchor_files"), + "anchor_folders": obj.get("anchor_folders"), + "isr_reports": obj.get("isr_reports") + }) + return _obj + + diff --git a/src/pieces_os_client/models/tracked_user_profile.py b/src/pieces_os_client/models/tracked_user_profile.py index 4ca9b79..5ef23d7 100644 --- a/src/pieces_os_client/models/tracked_user_profile.py +++ b/src/pieces_os_client/models/tracked_user_profile.py @@ -27,11 +27,11 @@ class TrackedUserProfile(BaseModel): """ A user that will be passed along with each analytics event # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - id: StrictStr = Field(..., description="The ID of the user that you are tracking.") - username: StrictStr = Field(..., description="This is a username that is attempted to be assigned but is \"Anonymous User\" by default") - email: Optional[StrictStr] = Field(None, description="The user's email if we have it.") - granularity: StrictStr = Field(..., description="At what level is this user being tracked.") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(default=..., description="The ID of the user that you are tracking.") + username: StrictStr = Field(default=..., description="This is a username that is attempted to be assigned but is \"Anonymous User\" by default") + email: Optional[StrictStr] = Field(default=None, description="The user's email if we have it.") + granularity: StrictStr = Field(default=..., description="At what level is this user being tracked.") __properties = ["schema", "id", "username", "email", "granularity"] @validator('granularity') diff --git a/src/pieces_os_client/models/transferable_bytes.py b/src/pieces_os_client/models/transferable_bytes.py index 9b51116..d3b02b2 100644 --- a/src/pieces_os_client/models/transferable_bytes.py +++ b/src/pieces_os_client/models/transferable_bytes.py @@ -27,11 +27,11 @@ class TransferableBytes(BaseModel): """ Bytes is a Model for A FileFormat. Raw and file are the only 2 that are currently supported. Raw and file are an array of integers that represent the file.Typical conversion UTF8 -> array[int] or UTF8 -> array[bytes(in hexidecimal)] -> array[int]. Either way you convert is up to you but the type we need here is an array of integers. [NOT IMPLEMENTED] base64, base64_url, data_url [IMPLEMENTED] raw # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - raw: Optional[conlist(StrictInt)] = Field(None, description="IMPLEMENTED") - var_base64: Optional[conlist(StrictInt)] = Field(None, alias="base64", description="NOT IMPLEMENTED") - base64_url: Optional[conlist(StrictInt)] = Field(None, description="NOT IMPLEMENTED") - data_url: Optional[conlist(StrictInt)] = Field(None, description="NOT IMPLEMENTED") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + raw: Optional[conlist(StrictInt)] = Field(default=None, description="IMPLEMENTED") + var_base64: Optional[conlist(StrictInt)] = Field(default=None, alias="base64", description="NOT IMPLEMENTED") + base64_url: Optional[conlist(StrictInt)] = Field(default=None, description="NOT IMPLEMENTED") + data_url: Optional[conlist(StrictInt)] = Field(default=None, description="NOT IMPLEMENTED") __properties = ["schema", "raw", "base64", "base64_url", "data_url"] class Config: diff --git a/src/pieces_os_client/models/transferable_string.py b/src/pieces_os_client/models/transferable_string.py index 46b02dd..c690946 100644 --- a/src/pieces_os_client/models/transferable_string.py +++ b/src/pieces_os_client/models/transferable_string.py @@ -27,11 +27,11 @@ class TransferableString(BaseModel): """ This is a String representaion of any of these changes. [NOT IMPLEMENTED] base64, base64_url, data_url [IMPLEMENTED] raw # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - raw: Optional[StrictStr] = Field(None, description="IMPLEMENTED") - var_base64: Optional[StrictStr] = Field(None, alias="base64", description="NOT IMPLEMENTED") - base64_url: Optional[StrictStr] = Field(None, description="NOT IMPLEMENTED") - data_url: Optional[StrictStr] = Field(None, description="NOT IMPLEMENTED") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + raw: Optional[StrictStr] = Field(default=None, description="IMPLEMENTED") + var_base64: Optional[StrictStr] = Field(default=None, alias="base64", description="NOT IMPLEMENTED") + base64_url: Optional[StrictStr] = Field(default=None, description="NOT IMPLEMENTED") + data_url: Optional[StrictStr] = Field(default=None, description="NOT IMPLEMENTED") __properties = ["schema", "raw", "base64", "base64_url", "data_url"] class Config: diff --git a/src/pieces_os_client/models/unchecked_os_update.py b/src/pieces_os_client/models/unchecked_os_server_update.py similarity index 78% rename from src/pieces_os_client/models/unchecked_os_update.py rename to src/pieces_os_client/models/unchecked_os_server_update.py index d9a040f..49d7ebd 100644 --- a/src/pieces_os_client/models/unchecked_os_update.py +++ b/src/pieces_os_client/models/unchecked_os_server_update.py @@ -23,11 +23,11 @@ from pydantic import BaseModel, Field from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema -class UncheckedOSUpdate(BaseModel): +class UncheckedOSServerUpdate(BaseModel): """ This is the input body for /os/update/check, just a placeholder for now. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: @@ -44,8 +44,8 @@ def to_json(self) -> str: return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UncheckedOSUpdate: - """Create an instance of UncheckedOSUpdate from a JSON string""" + def from_json(cls, json_str: str) -> UncheckedOSServerUpdate: + """Create an instance of UncheckedOSServerUpdate from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self): @@ -60,15 +60,15 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UncheckedOSUpdate: - """Create an instance of UncheckedOSUpdate from a dict""" + def from_dict(cls, obj: dict) -> UncheckedOSServerUpdate: + """Create an instance of UncheckedOSServerUpdate from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UncheckedOSUpdate.parse_obj(obj) + return UncheckedOSServerUpdate.parse_obj(obj) - _obj = UncheckedOSUpdate.parse_obj({ + _obj = UncheckedOSServerUpdate.parse_obj({ "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None }) return _obj diff --git a/src/pieces_os_client/models/unsegmented_technical_language.py b/src/pieces_os_client/models/unsegmented_technical_language.py index 7f9a25a..985ec19 100644 --- a/src/pieces_os_client/models/unsegmented_technical_language.py +++ b/src/pieces_os_client/models/unsegmented_technical_language.py @@ -27,7 +27,7 @@ class UnsegmentedTechnicalLanguage(BaseModel): """ This is the input model for '/machine_learning/text/technical_language/parsers/segmentation' This will take the unsegmentedText here! # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") value: StrictStr = Field(...) __properties = ["schema", "value"] diff --git a/src/pieces_os_client/models/updated_external_provider_api_key.py b/src/pieces_os_client/models/updated_external_provider_api_key.py index 791a8d7..63ca9f3 100644 --- a/src/pieces_os_client/models/updated_external_provider_api_key.py +++ b/src/pieces_os_client/models/updated_external_provider_api_key.py @@ -28,7 +28,7 @@ class UpdatedExternalProviderApiKey(BaseModel): """ This is the update Auth0UserMetadata object, and the specific update output model for \"/external_provider/api_key/update\" # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") metadata: Auth0UserMetadata = Field(...) __properties = ["schema", "metadata"] diff --git a/src/pieces_os_client/models/user_beta_status.py b/src/pieces_os_client/models/user_beta_status.py index d512444..071d5e7 100644 --- a/src/pieces_os_client/models/user_beta_status.py +++ b/src/pieces_os_client/models/user_beta_status.py @@ -28,7 +28,7 @@ class UserBetaStatus(BaseModel): """ This is used to either grant or remove a specific provider betastatus # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") auth0: Optional[Auth0UserBetaStatus] = None user: StrictStr = Field(...) __properties = ["schema", "auth0", "user"] diff --git a/src/pieces_os_client/models/user_profile.py b/src/pieces_os_client/models/user_profile.py index e03a03d..46478b2 100644 --- a/src/pieces_os_client/models/user_profile.py +++ b/src/pieces_os_client/models/user_profile.py @@ -32,14 +32,14 @@ class UserProfile(BaseModel): """ This is the model for a user logged into Pieces. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - picture: Optional[StrictStr] = Field('https://picsum.photos/200', description="mapped from picture.URL pointing to the user's profile picture. ") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + picture: Optional[StrictStr] = Field(default='https://picsum.photos/200', description="mapped from picture.URL pointing to the user's profile picture. ") email: Optional[StrictStr] = 'user@pieces.app' created: Optional[GroupedTimestamp] = None updated: Optional[GroupedTimestamp] = None - username: Optional[StrictStr] = Field(None, description=" (unique) User's username. ") + username: Optional[StrictStr] = Field(default=None, description=" (unique) User's username. ") id: StrictStr = Field(...) - name: Optional[StrictStr] = Field(None, description="This is the name of the User.") + name: Optional[StrictStr] = Field(default=None, description="This is the name of the User.") aesthetics: Aesthetics = Field(...) vanityname: Optional[StrictStr] = None allocation: Optional[AllocationCloud] = None diff --git a/src/pieces_os_client/models/users.py b/src/pieces_os_client/models/users.py index 17f804a..5fa6848 100644 --- a/src/pieces_os_client/models/users.py +++ b/src/pieces_os_client/models/users.py @@ -28,7 +28,7 @@ class Users(BaseModel): """ A base class for a collection of users and some additional meta properties. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: Optional[conlist(UserProfile)] = None __properties = ["schema", "iterable"] diff --git a/src/pieces_os_client/models/verified_os_filesystem_path.py b/src/pieces_os_client/models/verified_os_filesystem_path.py new file mode 100644 index 0000000..6f0d67f --- /dev/null +++ b/src/pieces_os_client/models/verified_os_filesystem_path.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictBool, StrictStr +from pieces_os_client.models.byte_descriptor import ByteDescriptor +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class VerifiedOSFilesystemPath(BaseModel): + """ + This will return is the given path was verified/ or it was invalid. and if it is valid if it is a file/folder note: file/directory are both null. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + path: StrictStr = Field(...) + file: Optional[StrictBool] = None + directory: Optional[StrictBool] = None + verified: StrictBool = Field(default=..., description="This means if the path(file/folder) exists on the machine.") + denied: Optional[StrictBool] = Field(default=None, description="This means that attempting to access the file was not aloud(ie no permission)") + bytes: Optional[ByteDescriptor] = None + __properties = ["schema", "path", "file", "directory", "verified", "denied", "bytes"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> VerifiedOSFilesystemPath: + """Create an instance of VerifiedOSFilesystemPath from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of bytes + if self.bytes: + _dict['bytes'] = self.bytes.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> VerifiedOSFilesystemPath: + """Create an instance of VerifiedOSFilesystemPath from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return VerifiedOSFilesystemPath.parse_obj(obj) + + _obj = VerifiedOSFilesystemPath.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "path": obj.get("path"), + "file": obj.get("file"), + "directory": obj.get("directory"), + "verified": obj.get("verified"), + "denied": obj.get("denied"), + "bytes": ByteDescriptor.from_dict(obj.get("bytes")) if obj.get("bytes") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/website.py b/src/pieces_os_client/models/website.py index 46cdc75..d9e5439 100644 --- a/src/pieces_os_client/models/website.py +++ b/src/pieces_os_client/models/website.py @@ -34,16 +34,16 @@ class Website(BaseModel): """ This is a specific model for related websites to an asset. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) assets: Optional[FlattenedAssets] = None - url: StrictStr = Field(..., description="this is the actual website url.") - name: StrictStr = Field(..., description="This is a name that is customized.") + url: StrictStr = Field(default=..., description="this is the actual website url.") + name: StrictStr = Field(default=..., description="This is a name that is customized.") created: GroupedTimestamp = Field(...) updated: GroupedTimestamp = Field(...) deleted: Optional[GroupedTimestamp] = None - mechanisms: Optional[Dict[str, MechanismEnum]] = Field(None, description="This is a Map where the the key is an asset id.") - interactions: Optional[StrictInt] = Field(None, description="This is an optional value that will keep track of the number of times this has been interacted with.") + mechanisms: Optional[Dict[str, MechanismEnum]] = Field(default=None, description="This is a Map where the the key is an asset id.") + interactions: Optional[StrictInt] = Field(default=None, description="This is an optional value that will keep track of the number of times this has been interacted with.") persons: Optional[FlattenedPersons] = None conversations: Optional[FlattenedConversations] = None score: Optional[Score] = None diff --git a/src/pieces_os_client/models/websites.py b/src/pieces_os_client/models/websites.py index 39ffc3c..ac37bef 100644 --- a/src/pieces_os_client/models/websites.py +++ b/src/pieces_os_client/models/websites.py @@ -29,9 +29,9 @@ class Websites(BaseModel): """ This is a specific model for related websites to an asset. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(Website) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an website id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an website id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/window_dimensions.py b/src/pieces_os_client/models/window_dimensions.py new file mode 100644 index 0000000..df0657c --- /dev/null +++ b/src/pieces_os_client/models/window_dimensions.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional, Union +from pydantic import BaseModel, Field, StrictFloat, StrictInt +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class WindowDimensions(BaseModel): + """ + note: this is modeled off of the browsers bounding box DOMRect https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + bottom: Union[StrictFloat, StrictInt] = Field(...) + height: Union[StrictFloat, StrictInt] = Field(...) + left: Union[StrictFloat, StrictInt] = Field(...) + right: Union[StrictFloat, StrictInt] = Field(...) + top: Union[StrictFloat, StrictInt] = Field(...) + width: Union[StrictFloat, StrictInt] = Field(...) + x: Union[StrictFloat, StrictInt] = Field(...) + y: Union[StrictFloat, StrictInt] = Field(...) + __properties = ["schema", "bottom", "height", "left", "right", "top", "width", "x", "y"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WindowDimensions: + """Create an instance of WindowDimensions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WindowDimensions: + """Create an instance of WindowDimensions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WindowDimensions.parse_obj(obj) + + _obj = WindowDimensions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "bottom": obj.get("bottom"), + "height": obj.get("height"), + "left": obj.get("left"), + "right": obj.get("right"), + "top": obj.get("top"), + "width": obj.get("width"), + "x": obj.get("x"), + "y": obj.get("y") + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_event.py b/src/pieces_os_client/models/workstream_event.py index ca2f6f4..b97fae8 100644 --- a/src/pieces_os_client/models/workstream_event.py +++ b/src/pieces_os_client/models/workstream_event.py @@ -33,7 +33,7 @@ class WorkstreamEvent(BaseModel): """ This is a Shadow Activity event: This is used to for 2 collections the internal Shadow Activity collection and the Shadow Activity Collection. The Internal Shadow Activity will me just a massive growing and shrinkling persisted list activity event that will endup getting rolled up into Workstream summaries. When we roll up the internalWorkstreamEvent events we will do a ton of filtering and only take the highly relevant events and turn them into WorkstreamEvent (these will be used to create a reference to the workstream summary, so we can know what event were used to generate the summary and vise versa). A Shadow Activity model is a collection of a ton of small interactions with the plugins (copy/paste/file open/file close/tab changed/...etc events) that will also enable use to know what materials are being used to funnel them into our engine to show highly relevant data according to your given flow. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None application: Application = Field(...) diff --git a/src/pieces_os_client/models/workstream_event_context.py b/src/pieces_os_client/models/workstream_event_context.py index d48ce0a..9a8e694 100644 --- a/src/pieces_os_client/models/workstream_event_context.py +++ b/src/pieces_os_client/models/workstream_event_context.py @@ -27,7 +27,7 @@ class WorkstreamEventContext(BaseModel): """ This is a free form data object that will enable additional data to be passed into SeededWorkstreamEvent, that corresponds to the event on the WorkstreamEvent. This is a WIP object. Need to think if we want to do something like raw:string (that is just a jsonObject) that is stringified, or if we add specific bits of data that we want. and specific fields for each event. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ide: Optional[WorkstreamEventTriggerContextIDE] = None browser: Optional[WorkstreamEventTriggerContextBrowser] = None __properties = ["schema", "ide", "browser"] diff --git a/src/pieces_os_client/models/workstream_event_trigger.py b/src/pieces_os_client/models/workstream_event_trigger.py index de4e10c..ca8a027 100644 --- a/src/pieces_os_client/models/workstream_event_trigger.py +++ b/src/pieces_os_client/models/workstream_event_trigger.py @@ -27,8 +27,8 @@ class WorkstreamEventTrigger(BaseModel): """ This is the specific event that represent the Shadow Activity ie the copy/paste ...xyz # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") - check_in: Optional[StrictBool] = Field(None, description="this is a sort of check-in event(ie when ever your application is in the forground on there is an interaction)") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + check_in: Optional[StrictBool] = Field(default=None, description="this is a sort of check-in event(ie when ever your application is in the foreground on there is an interaction)") copy_field: Optional[StrictBool] = Field(default=None, alias="copy") paste: Optional[StrictBool] = None file_open: Optional[StrictBool] = None diff --git a/src/pieces_os_client/models/workstream_event_trigger_context_browser.py b/src/pieces_os_client/models/workstream_event_trigger_context_browser.py index 923df8e..e6c78d4 100644 --- a/src/pieces_os_client/models/workstream_event_trigger_context_browser.py +++ b/src/pieces_os_client/models/workstream_event_trigger_context_browser.py @@ -27,7 +27,7 @@ class WorkstreamEventTriggerContextBrowser(BaseModel): """ This is the given context for the browser, a client can pass through many of the same tab if they would like, note: however please try to only side 3 unique website/anchors # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") tabs: Optional[BrowserTabs] = None __properties = ["schema", "tabs"] diff --git a/src/pieces_os_client/models/workstream_event_trigger_context_ide.py b/src/pieces_os_client/models/workstream_event_trigger_context_ide.py index c937679..0345051 100644 --- a/src/pieces_os_client/models/workstream_event_trigger_context_ide.py +++ b/src/pieces_os_client/models/workstream_event_trigger_context_ide.py @@ -27,7 +27,7 @@ class WorkstreamEventTriggerContextIDE(BaseModel): """ This is the given context for an IDE. tabs: this here refers to the tabs w/in the IDE. Modules here are the given repositories Name: this is the name of a workspace, but not required. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") tabs: Optional[IDETabs] = None modules: Optional[ProjectModules] = None name: Optional[StrictStr] = None diff --git a/src/pieces_os_client/models/workstream_events.py b/src/pieces_os_client/models/workstream_events.py index 82348a1..ab4b98a 100644 --- a/src/pieces_os_client/models/workstream_events.py +++ b/src/pieces_os_client/models/workstream_events.py @@ -29,9 +29,9 @@ class WorkstreamEvents(BaseModel): """ This is a collection of many Shadow Activity events. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(WorkstreamEvent) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an activity id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an activity id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/workstream_ingestion.py b/src/pieces_os_client/models/workstream_ingestion.py index b810998..56d4c3e 100644 --- a/src/pieces_os_client/models/workstream_ingestion.py +++ b/src/pieces_os_client/models/workstream_ingestion.py @@ -27,7 +27,7 @@ class WorkstreamIngestion(BaseModel): """ This is used for a returnable in the contest ingestion endpoint for the Feed. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") __properties = ["schema"] class Config: diff --git a/src/pieces_os_client/models/workstream_pattern_engine_data_cleanup_request.py b/src/pieces_os_client/models/workstream_pattern_engine_data_cleanup_request.py index 86dd502..bf0bb80 100644 --- a/src/pieces_os_client/models/workstream_pattern_engine_data_cleanup_request.py +++ b/src/pieces_os_client/models/workstream_pattern_engine_data_cleanup_request.py @@ -28,7 +28,7 @@ class WorkstreamPatternEngineDataCleanupRequest(BaseModel): """ NOTE: if we want to remove all the data the from would be unset, the to will be right now. from: is always in the past to: is always at least before from in our time. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") ranges: Optional[conlist(AnonymousTemporalRange)] = None __properties = ["schema", "ranges"] diff --git a/src/pieces_os_client/models/workstream_pattern_engine_source.py b/src/pieces_os_client/models/workstream_pattern_engine_source.py new file mode 100644 index 0000000..d8e94f0 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_source.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema + +class WorkstreamPatternEngineSource(BaseModel): + """ + This is a specific model for a given WPE qdrant source. note: application is optional b/c we may want a network sorce in the future TODO: think about adding an enum or something that will delimit the type of processor(vision/filewatcher/network/audio) TODO: in the future we can add tabs/filepaths to this model here. TODO: Enum for source/processor ? i.e. WorkstreamPatternEngineProcessorEnum.VISION, WorkstreamPatternEngineProcessorEnum.NETWORK, WorkstreamPatternEngineProcessorEnum.FILE_IO, WorkstreamPatternEngineProcessorEnum.AUDIO, etc. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + name: StrictStr = Field(default=..., description="This is the name of the window(foreground window)/application.(this will always be present)") + __properties = ["schema", "name"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineSource: + """Create an instance of WorkstreamPatternEngineSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineSource: + """Create an instance of WorkstreamPatternEngineSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineSource.parse_obj(obj) + + _obj = WorkstreamPatternEngineSource.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "name": obj.get("name") + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_sources.py b/src/pieces_os_client/models/workstream_pattern_engine_sources.py new file mode 100644 index 0000000..aeef3ce --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_sources.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_source import WorkstreamPatternEngineSource + +class WorkstreamPatternEngineSources(BaseModel): + """ + This is a plural version of the WPE qdrant applications # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(WorkstreamPatternEngineSource) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineSources: + """Create an instance of WorkstreamPatternEngineSources from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineSources: + """Create an instance of WorkstreamPatternEngineSources from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineSources.parse_obj(obj) + + _obj = WorkstreamPatternEngineSources.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [WorkstreamPatternEngineSource.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_status.py b/src/pieces_os_client/models/workstream_pattern_engine_status.py index c81b2cf..c2aa4bf 100644 --- a/src/pieces_os_client/models/workstream_pattern_engine_status.py +++ b/src/pieces_os_client/models/workstream_pattern_engine_status.py @@ -28,7 +28,7 @@ class WorkstreamPatternEngineStatus(BaseModel): """ This will return the status for the Workstream pettern engine, specifically the activation/deactivation status # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") vision: Optional[WorkstreamPatternEngineVisionStatus] = None __properties = ["schema", "vision"] diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_calibration.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_calibration.py new file mode 100644 index 0000000..ce88222 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_calibration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.grouped_timestamp import GroupedTimestamp +from pieces_os_client.models.window_dimensions import WindowDimensions + +class WorkstreamPatternEngineVisionCalibration(BaseModel): + """ + This model is used for the dimensions of the copilot/feed/xyz window. if dimensions/captured are null this means we do not have the dimensions for this given window. TODO: consider adding 5 markers here for the qr codes(ie location of these as wel) NOTE: will want to add type of calibration for this specific dimension(ie copilot/feed/xyz) # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + foreground: StrictStr = Field(default=..., description="This is the name of the window(foreground window).(this will always be present)") + captured: Optional[GroupedTimestamp] = None + dimensions: Optional[WindowDimensions] = None + __properties = ["schema", "foreground", "captured", "dimensions"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionCalibration: + """Create an instance of WorkstreamPatternEngineVisionCalibration from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of captured + if self.captured: + _dict['captured'] = self.captured.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimensions + if self.dimensions: + _dict['dimensions'] = self.dimensions.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionCalibration: + """Create an instance of WorkstreamPatternEngineVisionCalibration from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionCalibration.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionCalibration.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "foreground": obj.get("foreground"), + "captured": GroupedTimestamp.from_dict(obj.get("captured")) if obj.get("captured") is not None else None, + "dimensions": WindowDimensions.from_dict(obj.get("dimensions")) if obj.get("dimensions") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_calibrations.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_calibrations.py new file mode 100644 index 0000000..0eeaeb5 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_calibrations.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_vision_calibration import WorkstreamPatternEngineVisionCalibration + +class WorkstreamPatternEngineVisionCalibrations(BaseModel): + """ + TODO: description This the plural of a single copilot Capture. This will return all the the given copilot captures # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(WorkstreamPatternEngineVisionCalibration) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionCalibrations: + """Create an instance of WorkstreamPatternEngineVisionCalibrations from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionCalibrations: + """Create an instance of WorkstreamPatternEngineVisionCalibrations from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionCalibrations.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionCalibrations.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [WorkstreamPatternEngineVisionCalibration.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_event.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_event.py new file mode 100644 index 0000000..b230a28 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_event.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictStr +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.grouped_timestamp import GroupedTimestamp +from pieces_os_client.models.workstream_pattern_engine_source import WorkstreamPatternEngineSource +from pieces_os_client.models.workstream_pattern_engine_vision_event_textual_value import WorkstreamPatternEngineVisionEventTextualValue + +class WorkstreamPatternEngineVisionEvent(BaseModel): + """ + This will return a specific event for the WPE. note: value is nullable here because we may want to pass in transferables:true/false # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + id: StrictStr = Field(...) + created: GroupedTimestamp = Field(...) + source: Optional[WorkstreamPatternEngineSource] = None + textual: Optional[WorkstreamPatternEngineVisionEventTextualValue] = None + __properties = ["schema", "id", "created", "source", "textual"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionEvent: + """Create an instance of WorkstreamPatternEngineVisionEvent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of created + if self.created: + _dict['created'] = self.created.to_dict() + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict['source'] = self.source.to_dict() + # override the default output from pydantic by calling `to_dict()` of textual + if self.textual: + _dict['textual'] = self.textual.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionEvent: + """Create an instance of WorkstreamPatternEngineVisionEvent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionEvent.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionEvent.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "id": obj.get("id"), + "created": GroupedTimestamp.from_dict(obj.get("created")) if obj.get("created") is not None else None, + "source": WorkstreamPatternEngineSource.from_dict(obj.get("source")) if obj.get("source") is not None else None, + "textual": WorkstreamPatternEngineVisionEventTextualValue.from_dict(obj.get("textual")) if obj.get("textual") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_event_deletions.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_event_deletions.py new file mode 100644 index 0000000..83a88a5 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_event_deletions.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.flattened_workstream_pattern_engine_vision_events import FlattenedWorkstreamPatternEngineVisionEvents +from pieces_os_client.models.search_input import SearchInput + +class WorkstreamPatternEngineVisionEventDeletions(BaseModel): + """ + note: recomended to use the search option here(where you can pass in workstream. note: \"scope\" here will run a search with the given scope and then remove these events. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + search_scope: Optional[SearchInput] = None + identifiers: Optional[FlattenedWorkstreamPatternEngineVisionEvents] = None + __properties = ["schema", "search_scope", "identifiers"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionEventDeletions: + """Create an instance of WorkstreamPatternEngineVisionEventDeletions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of search_scope + if self.search_scope: + _dict['search_scope'] = self.search_scope.to_dict() + # override the default output from pydantic by calling `to_dict()` of identifiers + if self.identifiers: + _dict['identifiers'] = self.identifiers.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionEventDeletions: + """Create an instance of WorkstreamPatternEngineVisionEventDeletions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionEventDeletions.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionEventDeletions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "search_scope": SearchInput.from_dict(obj.get("search_scope")) if obj.get("search_scope") is not None else None, + "identifiers": FlattenedWorkstreamPatternEngineVisionEvents.from_dict(obj.get("identifiers")) if obj.get("identifiers") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_event_textual_value.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_event_textual_value.py new file mode 100644 index 0000000..df39879 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_event_textual_value.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.textually_extracted_material import TextuallyExtractedMaterial +from pieces_os_client.models.transferable_string import TransferableString + +class WorkstreamPatternEngineVisionEventTextualValue(BaseModel): + """ + note: we could add a summarize property. TODO: might need an extracted bool to say to aggregate the extracted # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + ocr: Optional[TransferableString] = None + extracted: Optional[TextuallyExtractedMaterial] = None + __properties = ["schema", "ocr", "extracted"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionEventTextualValue: + """Create an instance of WorkstreamPatternEngineVisionEventTextualValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of ocr + if self.ocr: + _dict['ocr'] = self.ocr.to_dict() + # override the default output from pydantic by calling `to_dict()` of extracted + if self.extracted: + _dict['extracted'] = self.extracted.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionEventTextualValue: + """Create an instance of WorkstreamPatternEngineVisionEventTextualValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionEventTextualValue.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionEventTextualValue.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "ocr": TransferableString.from_dict(obj.get("ocr")) if obj.get("ocr") is not None else None, + "extracted": TextuallyExtractedMaterial.from_dict(obj.get("extracted")) if obj.get("extracted") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_events.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_events.py new file mode 100644 index 0000000..44106e0 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_events.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, Field, conlist +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent + +class WorkstreamPatternEngineVisionEvents(BaseModel): + """ + This is a plural snapshot of all of the events within WPE qdrant # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + iterable: conlist(WorkstreamPatternEngineVisionEvent) = Field(...) + __properties = ["schema", "iterable"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionEvents: + """Create an instance of WorkstreamPatternEngineVisionEvents from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in iterable (list) + _items = [] + if self.iterable: + for _item in self.iterable: + if _item: + _items.append(_item.to_dict()) + _dict['iterable'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionEvents: + """Create an instance of WorkstreamPatternEngineVisionEvents from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionEvents.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionEvents.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "iterable": [WorkstreamPatternEngineVisionEvent.from_dict(_item) for _item in obj.get("iterable")] if obj.get("iterable") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_events_metadata.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_events_metadata.py new file mode 100644 index 0000000..4295065 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_events_metadata.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field, StrictInt +from pieces_os_client.models.byte_descriptor import ByteDescriptor +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_vision_event import WorkstreamPatternEngineVisionEvent + +class WorkstreamPatternEngineVisionEventsMetadata(BaseModel): + """ + This is specific model that will return the size of the WPE in bytes # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + bytes: ByteDescriptor = Field(...) + total: StrictInt = Field(default=..., description="This is the total number of events.") + oldest: Optional[WorkstreamPatternEngineVisionEvent] = None + newest: Optional[WorkstreamPatternEngineVisionEvent] = None + __properties = ["schema", "bytes", "total", "oldest", "newest"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionEventsMetadata: + """Create an instance of WorkstreamPatternEngineVisionEventsMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of bytes + if self.bytes: + _dict['bytes'] = self.bytes.to_dict() + # override the default output from pydantic by calling `to_dict()` of oldest + if self.oldest: + _dict['oldest'] = self.oldest.to_dict() + # override the default output from pydantic by calling `to_dict()` of newest + if self.newest: + _dict['newest'] = self.newest.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionEventsMetadata: + """Create an instance of WorkstreamPatternEngineVisionEventsMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionEventsMetadata.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionEventsMetadata.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "bytes": ByteDescriptor.from_dict(obj.get("bytes")) if obj.get("bytes") is not None else None, + "total": obj.get("total"), + "oldest": WorkstreamPatternEngineVisionEvent.from_dict(obj.get("oldest")) if obj.get("oldest") is not None else None, + "newest": WorkstreamPatternEngineVisionEvent.from_dict(obj.get("newest")) if obj.get("newest") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_metadata.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_metadata.py new file mode 100644 index 0000000..ffaf481 --- /dev/null +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_metadata.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_vision_events_metadata import WorkstreamPatternEngineVisionEventsMetadata + +class WorkstreamPatternEngineVisionMetadata(BaseModel): + """ + This will return all the WPE vision specific metadata # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + events: Optional[WorkstreamPatternEngineVisionEventsMetadata] = None + __properties = ["schema", "events"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamPatternEngineVisionMetadata: + """Create an instance of WorkstreamPatternEngineVisionMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of events + if self.events: + _dict['events'] = self.events.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamPatternEngineVisionMetadata: + """Create an instance of WorkstreamPatternEngineVisionMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamPatternEngineVisionMetadata.parse_obj(obj) + + _obj = WorkstreamPatternEngineVisionMetadata.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "events": WorkstreamPatternEngineVisionEventsMetadata.from_dict(obj.get("events")) if obj.get("events") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_pattern_engine_vision_status.py b/src/pieces_os_client/models/workstream_pattern_engine_vision_status.py index 40788ec..f6a7940 100644 --- a/src/pieces_os_client/models/workstream_pattern_engine_vision_status.py +++ b/src/pieces_os_client/models/workstream_pattern_engine_vision_status.py @@ -28,7 +28,7 @@ class WorkstreamPatternEngineVisionStatus(BaseModel): """ activation: can be active for forever w/ continous true, or it can be activated for the next couple hours deactivation: here can be deactivated for forever w/ continuous true, or it can be deactivated for the next couple hours Note: one or the other will be set and both are nullable. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") activation: Optional[AnonymousTemporalRange] = None deactivation: Optional[AnonymousTemporalRange] = None __properties = ["schema", "activation", "deactivation"] diff --git a/src/pieces_os_client/models/workstream_search_options.py b/src/pieces_os_client/models/workstream_search_options.py new file mode 100644 index 0000000..a86d186 --- /dev/null +++ b/src/pieces_os_client/models/workstream_search_options.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Pieces Isomorphic OpenAPI + + Endpoints for Assets, Formats, Users, Asset, Format, User. + + The version of the OpenAPI document: 1.0 + Contact: tsavo@pieces.app + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Optional +from pydantic import BaseModel, Field +from pieces_os_client.models.embedded_model_schema import EmbeddedModelSchema +from pieces_os_client.models.workstream_pattern_engine_sources import WorkstreamPatternEngineSources + +class WorkstreamSearchOptions(BaseModel): + """ + This is a search realted to the workstream pattern engine data, for instance in a WPE/vision/search we will want to be able to search via a WorkstreamPatternEngineSource. # noqa: E501 + """ + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") + sources: Optional[WorkstreamPatternEngineSources] = None + __properties = ["schema", "sources"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> WorkstreamSearchOptions: + """Create an instance of WorkstreamSearchOptions from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of sources + if self.sources: + _dict['sources'] = self.sources.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> WorkstreamSearchOptions: + """Create an instance of WorkstreamSearchOptions from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return WorkstreamSearchOptions.parse_obj(obj) + + _obj = WorkstreamSearchOptions.parse_obj({ + "var_schema": EmbeddedModelSchema.from_dict(obj.get("schema")) if obj.get("schema") is not None else None, + "sources": WorkstreamPatternEngineSources.from_dict(obj.get("sources")) if obj.get("sources") is not None else None + }) + return _obj + + diff --git a/src/pieces_os_client/models/workstream_suggestion.py b/src/pieces_os_client/models/workstream_suggestion.py index c192771..3832a5e 100644 --- a/src/pieces_os_client/models/workstream_suggestion.py +++ b/src/pieces_os_client/models/workstream_suggestion.py @@ -36,12 +36,14 @@ from pieces_os_client.models.referenced_tag import ReferencedTag from pieces_os_client.models.referenced_website import ReferencedWebsite from pieces_os_client.models.referenced_workstream_summary import ReferencedWorkstreamSummary +from pieces_os_client.models.seed import Seed +from pieces_os_client.models.seeds import Seeds class WorkstreamSuggestion(BaseModel): """ This is an individual material that is apart of the workstream feed. might want to also consider plural uuids ie top websites/tags/and others.. related: this is an optional field that will only be calculated for first degree relationships. ie. an anchor may have related.iterable.first.persons that are not associated but related. via the workstream patturn engine. current: if current is defined then this is the current viewed object # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") summary: Optional[ReferencedWorkstreamSummary] = None asset: Optional[ReferencedAsset] = None tag: Optional[ReferencedTag] = None @@ -49,6 +51,8 @@ class WorkstreamSuggestion(BaseModel): anchor: Optional[ReferencedAnchor] = None conversation: Optional[ReferencedConversation] = None person: Optional[ReferencedPerson] = None + seed: Optional[Seed] = None + seeds: Optional[Seeds] = None summaries: Optional[FlattenedWorkstreamSummaries] = None assets: Optional[FlattenedAssets] = None tags: Optional[FlattenedTags] = None @@ -58,7 +62,7 @@ class WorkstreamSuggestion(BaseModel): persons: Optional[FlattenedPersons] = None related: Optional[WorkstreamSuggestions] = None current: Optional[WorkstreamSuggestion] = None - __properties = ["schema", "summary", "asset", "tag", "website", "anchor", "conversation", "person", "summaries", "assets", "tags", "websites", "anchors", "conversations", "persons", "related", "current"] + __properties = ["schema", "summary", "asset", "tag", "website", "anchor", "conversation", "person", "seed", "seeds", "summaries", "assets", "tags", "websites", "anchors", "conversations", "persons", "related", "current"] class Config: """Pydantic configuration""" @@ -108,6 +112,12 @@ def to_dict(self): # override the default output from pydantic by calling `to_dict()` of person if self.person: _dict['person'] = self.person.to_dict() + # override the default output from pydantic by calling `to_dict()` of seed + if self.seed: + _dict['seed'] = self.seed.to_dict() + # override the default output from pydantic by calling `to_dict()` of seeds + if self.seeds: + _dict['seeds'] = self.seeds.to_dict() # override the default output from pydantic by calling `to_dict()` of summaries if self.summaries: _dict['summaries'] = self.summaries.to_dict() @@ -155,6 +165,8 @@ def from_dict(cls, obj: dict) -> WorkstreamSuggestion: "anchor": ReferencedAnchor.from_dict(obj.get("anchor")) if obj.get("anchor") is not None else None, "conversation": ReferencedConversation.from_dict(obj.get("conversation")) if obj.get("conversation") is not None else None, "person": ReferencedPerson.from_dict(obj.get("person")) if obj.get("person") is not None else None, + "seed": Seed.from_dict(obj.get("seed")) if obj.get("seed") is not None else None, + "seeds": Seeds.from_dict(obj.get("seeds")) if obj.get("seeds") is not None else None, "summaries": FlattenedWorkstreamSummaries.from_dict(obj.get("summaries")) if obj.get("summaries") is not None else None, "assets": FlattenedAssets.from_dict(obj.get("assets")) if obj.get("assets") is not None else None, "tags": FlattenedTags.from_dict(obj.get("tags")) if obj.get("tags") is not None else None, diff --git a/src/pieces_os_client/models/workstream_suggestion_type.py b/src/pieces_os_client/models/workstream_suggestion_type.py index 9f00a4b..c5227a9 100644 --- a/src/pieces_os_client/models/workstream_suggestion_type.py +++ b/src/pieces_os_client/models/workstream_suggestion_type.py @@ -26,7 +26,7 @@ class WorkstreamSuggestionType(BaseModel): """ This is used to map the types of the iterable to given booleans of their respective material types # noqa: E501 """ - var_schema: Optional[StrictBool] = Field(None, alias="schema") + var_schema: Optional[StrictBool] = Field(default=None, alias="schema") summary: Optional[StrictBool] = None asset: Optional[StrictBool] = None tag: Optional[StrictBool] = None @@ -34,6 +34,8 @@ class WorkstreamSuggestionType(BaseModel): anchor: Optional[StrictBool] = None conversation: Optional[StrictBool] = None person: Optional[StrictBool] = None + seed: Optional[StrictBool] = None + seeds: Optional[StrictBool] = None summaries: Optional[StrictBool] = None assets: Optional[StrictBool] = None tags: Optional[StrictBool] = None @@ -41,7 +43,7 @@ class WorkstreamSuggestionType(BaseModel): anchors: Optional[StrictBool] = None conversations: Optional[StrictBool] = None persons: Optional[StrictBool] = None - __properties = ["schema", "summary", "asset", "tag", "website", "anchor", "conversation", "person", "summaries", "assets", "tags", "websites", "anchors", "conversations", "persons"] + __properties = ["schema", "summary", "asset", "tag", "website", "anchor", "conversation", "person", "seed", "seeds", "summaries", "assets", "tags", "websites", "anchors", "conversations", "persons"] class Config: """Pydantic configuration""" @@ -87,6 +89,8 @@ def from_dict(cls, obj: dict) -> WorkstreamSuggestionType: "anchor": obj.get("anchor"), "conversation": obj.get("conversation"), "person": obj.get("person"), + "seed": obj.get("seed"), + "seeds": obj.get("seeds"), "summaries": obj.get("summaries"), "assets": obj.get("assets"), "tags": obj.get("tags"), diff --git a/src/pieces_os_client/models/workstream_suggestions.py b/src/pieces_os_client/models/workstream_suggestions.py index 2040705..f4f13b2 100644 --- a/src/pieces_os_client/models/workstream_suggestions.py +++ b/src/pieces_os_client/models/workstream_suggestions.py @@ -28,9 +28,9 @@ class WorkstreamSuggestions(BaseModel): """ This is a list of the materials used in the workstream suggestions. The feed will return a list of individual material that will be required to be fetched and re-referenced.(the materials that is.) Considering if we want to have all the materaials just being referenced( ie ReferencedWebsite/ReferencedWorkstreamSummary/...xyz) && rebuilt # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(WorkstreamSuggestion) = Field(...) - types: Optional[conlist(WorkstreamSuggestionType)] = Field(None, description="This is iterable [] that gives the type of each of the items in the iterable. I.E. types[0] is the suggestion type of the item at iterable[0].") + types: Optional[conlist(WorkstreamSuggestionType)] = Field(default=None, description="This is iterable [] that gives the type of each of the items in the iterable. I.E. types[0] is the suggestion type of the item at iterable[0].") __properties = ["schema", "iterable", "types"] class Config: diff --git a/src/pieces_os_client/models/workstream_suggestions_refresh.py b/src/pieces_os_client/models/workstream_suggestions_refresh.py index 7f1ac36..a447934 100644 --- a/src/pieces_os_client/models/workstream_suggestions_refresh.py +++ b/src/pieces_os_client/models/workstream_suggestions_refresh.py @@ -28,7 +28,7 @@ class WorkstreamSuggestionsRefresh(BaseModel): """ This will return the new refreshed suggestions, about what data changed, and the data that was used to bias the suggestions. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") suggestions: WorkstreamSuggestions = Field(...) __properties = ["schema", "suggestions"] diff --git a/src/pieces_os_client/models/workstream_summaries.py b/src/pieces_os_client/models/workstream_summaries.py index 3a3f51f..aeb6928 100644 --- a/src/pieces_os_client/models/workstream_summaries.py +++ b/src/pieces_os_client/models/workstream_summaries.py @@ -29,9 +29,9 @@ class WorkstreamSummaries(BaseModel): """ This is a collection of many WorkstreamSummary # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") iterable: conlist(WorkstreamSummary) = Field(...) - indices: Optional[Dict[str, StrictInt]] = Field(None, description="This is a Map where the the key is an summary id.") + indices: Optional[Dict[str, StrictInt]] = Field(default=None, description="This is a Map where the the key is an summary id.") score: Optional[Score] = None __properties = ["schema", "iterable", "indices", "score"] diff --git a/src/pieces_os_client/models/workstream_summary.py b/src/pieces_os_client/models/workstream_summary.py index 7584d41..057dae8 100644 --- a/src/pieces_os_client/models/workstream_summary.py +++ b/src/pieces_os_client/models/workstream_summary.py @@ -39,7 +39,7 @@ class WorkstreamSummary(BaseModel): """ This is representation or a summarized version of the highly relevant WorkstreamEvent events from a given time period, 1 day, 1 week, 1 month, dependinng on your given flow. # noqa: E501 """ - var_schema: Optional[EmbeddedModelSchema] = Field(None, alias="schema") + var_schema: Optional[EmbeddedModelSchema] = Field(default=None, alias="schema") id: StrictStr = Field(...) score: Optional[Score] = None created: GroupedTimestamp = Field(...)