86f984fc8b8cd43adb093751a23b29bc63d48bc1

Author: github-actions[bot]

docs/StoreApi.md

@@ -3292,11 +3292,11 @@ Name | Type | Description  | Notes
 [[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)
 
 # **studysets_post**
-> StudysetReturn studysets_post(studyset_request=studyset_request)
+> StudysetReturn studysets_post(source_id=source_id, source=source, copy_annotations=copy_annotations, studyset_request=studyset_request)
 
 POST/create a studyset
 
-Create a studyset.
+Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
 ### Example
 
@@ -3329,11 +3329,14 @@ configuration = neurostore_sdk.Configuration(
 with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.StoreApi(api_client)
+    source_id = '1234567890ab' # str | id of the resource you are either filtering/copying on (optional)
+    source = neurostore # str | the source of the resource you would like to filter/copy from (optional) (default to neurostore)
+    copy_annotations = True # bool | When cloning a studyset, copy annotations and their notes when true (default). (optional) (default to True)
     studyset_request = neurostore_sdk.StudysetRequest() # StudysetRequest |  (optional)
 
     try:
         # POST/create a studyset
-        api_response = api_instance.studysets_post(studyset_request=studyset_request)
+        api_response = api_instance.studysets_post(source_id=source_id, source=source, copy_annotations=copy_annotations, studyset_request=studyset_request)
         print("The response of StoreApi->studysets_post:\n")
         pprint(api_response)
     except Exception as e:
@@ -3347,6 +3350,9 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **source_id** | **str**| id of the resource you are either filtering/copying on | [optional] 
+ **source** | **str**| the source of the resource you would like to filter/copy from | [optional] [default to neurostore]
+ **copy_annotations** | **bool**| When cloning a studyset, copy annotations and their notes when true (default). | [optional] [default to True]
  **studyset_request** | [**StudysetRequest**](StudysetRequest.md)|  | [optional] 
 
 ### Return type

docs/StudysetsApi.md

@@ -346,11 +346,11 @@ Name | Type | Description  | Notes
 [[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)
 
 # **studysets_post**
-> StudysetReturn studysets_post(studyset_request=studyset_request)
+> StudysetReturn studysets_post(source_id=source_id, source=source, copy_annotations=copy_annotations, studyset_request=studyset_request)
 
 POST/create a studyset
 
-Create a studyset.
+Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
 ### Example
 
@@ -383,11 +383,14 @@ configuration = neurostore_sdk.Configuration(
 with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.StudysetsApi(api_client)
+    source_id = '1234567890ab' # str | id of the resource you are either filtering/copying on (optional)
+    source = neurostore # str | the source of the resource you would like to filter/copy from (optional) (default to neurostore)
+    copy_annotations = True # bool | When cloning a studyset, copy annotations and their notes when true (default). (optional) (default to True)
     studyset_request = neurostore_sdk.StudysetRequest() # StudysetRequest |  (optional)
 
     try:
         # POST/create a studyset
-        api_response = api_instance.studysets_post(studyset_request=studyset_request)
+        api_response = api_instance.studysets_post(source_id=source_id, source=source, copy_annotations=copy_annotations, studyset_request=studyset_request)
         print("The response of StudysetsApi->studysets_post:\n")
         pprint(api_response)
     except Exception as e:
@@ -401,6 +404,9 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **source_id** | **str**| id of the resource you are either filtering/copying on | [optional] 
+ **source** | **str**| the source of the resource you would like to filter/copy from | [optional] [default to neurostore]
+ **copy_annotations** | **bool**| When cloning a studyset, copy annotations and their notes when true (default). | [optional] [default to True]
  **studyset_request** | [**StudysetRequest**](StudysetRequest.md)|  | [optional] 
 
 ### Return type

neurostore_sdk/api/store_api.py

@@ -12564,6 +12564,9 @@ def _studysets_id_put_serialize(
     @validate_call
     def studysets_post(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -12580,8 +12583,14 @@ def studysets_post(
     ) -> StudysetReturn:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -12607,6 +12616,9 @@ def studysets_post(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -12631,6 +12643,9 @@ def studysets_post(
     @validate_call
     def studysets_post_with_http_info(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -12647,8 +12662,14 @@ def studysets_post_with_http_info(
     ) -> ApiResponse[StudysetReturn]:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -12674,6 +12695,9 @@ def studysets_post_with_http_info(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -12698,6 +12722,9 @@ def studysets_post_with_http_info(
     @validate_call
     def studysets_post_without_preload_content(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -12714,8 +12741,14 @@ def studysets_post_without_preload_content(
     ) -> RESTResponseType:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -12741,6 +12774,9 @@ def studysets_post_without_preload_content(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -12760,6 +12796,9 @@ def studysets_post_without_preload_content(
 
     def _studysets_post_serialize(
         self,
+        source_id,
+        source,
+        copy_annotations,
         studyset_request,
         _request_auth,
         _content_type,
@@ -12783,6 +12822,18 @@ def _studysets_post_serialize(
 
         # process the path parameters
         # process the query parameters
+        if source_id is not None:
+            
+            _query_params.append(('source_id', source_id))
+            
+        if source is not None:
+            
+            _query_params.append(('source', source))
+            
+        if copy_annotations is not None:
+            
+            _query_params.append(('copy_annotations', copy_annotations))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter

neurostore_sdk/api/studysets_api.py

@@ -1373,6 +1373,9 @@ def _studysets_id_put_serialize(
     @validate_call
     def studysets_post(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -1389,8 +1392,14 @@ def studysets_post(
     ) -> StudysetReturn:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -1416,6 +1425,9 @@ def studysets_post(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1440,6 +1452,9 @@ def studysets_post(
     @validate_call
     def studysets_post_with_http_info(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -1456,8 +1471,14 @@ def studysets_post_with_http_info(
     ) -> ApiResponse[StudysetReturn]:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -1483,6 +1504,9 @@ def studysets_post_with_http_info(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1507,6 +1531,9 @@ def studysets_post_with_http_info(
     @validate_call
     def studysets_post_without_preload_content(
         self,
+        source_id: Annotated[Optional[StrictStr], Field(description="id of the resource you are either filtering/copying on")] = None,
+        source: Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None,
+        copy_annotations: Annotated[Optional[StrictBool], Field(description="When cloning a studyset, copy annotations and their notes when true (default).")] = None,
         studyset_request: Optional[StudysetRequest] = None,
         _request_timeout: Union[
             None,
@@ -1523,8 +1550,14 @@ def studysets_post_without_preload_content(
     ) -> RESTResponseType:
         """POST/create a studyset
 
-        Create a studyset.
+        Create a studyset. When `source_id` is provided, Neurostore clones an existing studyset owned by any user into a new studyset owned by the caller, copying studies and (by default) annotations.
 
+        :param source_id: id of the resource you are either filtering/copying on
+        :type source_id: str
+        :param source: the source of the resource you would like to filter/copy from
+        :type source: str
+        :param copy_annotations: When cloning a studyset, copy annotations and their notes when true (default).
+        :type copy_annotations: bool
         :param studyset_request:
         :type studyset_request: StudysetRequest
         :param _request_timeout: timeout setting for this request. If one
@@ -1550,6 +1583,9 @@ def studysets_post_without_preload_content(
         """ # noqa: E501
 
         _param = self._studysets_post_serialize(
+            source_id=source_id,
+            source=source,
+            copy_annotations=copy_annotations,
             studyset_request=studyset_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1569,6 +1605,9 @@ def studysets_post_without_preload_content(
 
     def _studysets_post_serialize(
         self,
+        source_id,
+        source,
+        copy_annotations,
         studyset_request,
         _request_auth,
         _content_type,
@@ -1592,6 +1631,18 @@ def _studysets_post_serialize(
 
         # process the path parameters
         # process the query parameters
+        if source_id is not None:
+            
+            _query_params.append(('source_id', source_id))
+            
+        if source is not None:
+            
+            _query_params.append(('source', source))
+            
+        if copy_annotations is not None:
+            
+            _query_params.append(('copy_annotations', copy_annotations))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter