82081959348e3cb21c36aad16900ef29b5c66cfa

neurostuff · Sep 8, 2023 · 0975071 · 0975071
1 parent f8ac1ba
commit 0975071
Show file tree

Hide file tree

Showing 22 changed files with 967 additions and 38 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -31,6 +31,8 @@ docs/AnnotationReturnOneOf1.md
 docs/AnnotationReturnRelationships.md
 docs/AnnotationReturnRelationshipsNotes.md
 docs/AnnotationsApi.md
+docs/BaseStudiesPost200Response.md
+docs/BaseStudiesPostRequest.md
 docs/BaseStudy.md
 docs/BaseStudyList.md
 docs/BaseStudyReturn.md
@@ -79,7 +81,8 @@ docs/StudyRequestRelationships.md
 docs/StudyRequestRelationshipsAnalyses.md
 docs/StudyReturn.md
 docs/StudyReturnAllOf.md
-docs/StudyReturnAllOfStudysets.md
+docs/StudyReturnAllOfStudysetsInner.md
+docs/StudyReturnAllOfStudysetsInnerOneOf.md
 docs/StudyReturnRelationships.md
 docs/StudyReturnRelationshipsAnalyses.md
 docs/StudysetBase.md
@@ -143,6 +146,8 @@ neurostore_sdk/models/annotation_return_one_of.py
 neurostore_sdk/models/annotation_return_one_of1.py
 neurostore_sdk/models/annotation_return_relationships.py
 neurostore_sdk/models/annotation_return_relationships_notes.py
+neurostore_sdk/models/base_studies_post200_response.py
+neurostore_sdk/models/base_studies_post_request.py
 neurostore_sdk/models/base_study.py
 neurostore_sdk/models/base_study_list.py
 neurostore_sdk/models/base_study_return.py
@@ -185,7 +190,8 @@ neurostore_sdk/models/study_request_relationships.py
 neurostore_sdk/models/study_request_relationships_analyses.py
 neurostore_sdk/models/study_return.py
 neurostore_sdk/models/study_return_all_of.py
-neurostore_sdk/models/study_return_all_of_studysets.py
+neurostore_sdk/models/study_return_all_of_studysets_inner.py
+neurostore_sdk/models/study_return_all_of_studysets_inner_one_of.py
 neurostore_sdk/models/study_return_relationships.py
 neurostore_sdk/models/study_return_relationships_analyses.py
 neurostore_sdk/models/studyset_base.py
@@ -210,4 +216,8 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_base_studies_post200_response.py
+test/test_base_studies_post_request.py
+test/test_study_return_all_of_studysets_inner.py
+test/test_study_return_all_of_studysets_inner_one_of.py
 tox.ini
diff --git a/README.md b/README.md
@@ -200,6 +200,8 @@ Class | Method | HTTP request | Description
  - [AnnotationReturnOneOf1](docs/AnnotationReturnOneOf1.md)
  - [AnnotationReturnRelationships](docs/AnnotationReturnRelationships.md)
  - [AnnotationReturnRelationshipsNotes](docs/AnnotationReturnRelationshipsNotes.md)
+ - [BaseStudiesPost200Response](docs/BaseStudiesPost200Response.md)
+ - [BaseStudiesPostRequest](docs/BaseStudiesPostRequest.md)
  - [BaseStudy](docs/BaseStudy.md)
  - [BaseStudyList](docs/BaseStudyList.md)
  - [BaseStudyReturn](docs/BaseStudyReturn.md)
@@ -242,7 +244,8 @@ Class | Method | HTTP request | Description
  - [StudyRequestRelationshipsAnalyses](docs/StudyRequestRelationshipsAnalyses.md)
  - [StudyReturn](docs/StudyReturn.md)
  - [StudyReturnAllOf](docs/StudyReturnAllOf.md)
- - [StudyReturnAllOfStudysets](docs/StudyReturnAllOfStudysets.md)
+ - [StudyReturnAllOfStudysetsInner](docs/StudyReturnAllOfStudysetsInner.md)
+ - [StudyReturnAllOfStudysetsInnerOneOf](docs/StudyReturnAllOfStudysetsInnerOneOf.md)
  - [StudyReturnRelationships](docs/StudyReturnRelationships.md)
  - [StudyReturnRelationshipsAnalyses](docs/StudyReturnRelationshipsAnalyses.md)
  - [StudysetBase](docs/StudysetBase.md)

diff --git a/docs/BaseStudiesPost200Response.md b/docs/BaseStudiesPost200Response.md
@@ -0,0 +1,43 @@
+# BaseStudiesPost200Response
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **object** |  | [optional] 
+**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**publication** | **str** |  | [optional] 
+**doi** | **str** |  | [optional] 
+**pmid** | **str** |  | [optional] 
+**authors** | **str** |  | [optional] 
+**year** | **int** |  | [optional] 
+**level** | **str** |  | [optional] 
+**created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
+**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**id** | **str** | short UUID specifying the location of this resource | [optional] 
+**public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
+**user** | **str** | who owns the resource | [optional] [readonly] 
+**username** | **str** | human readable username | [optional] 
+
+## Example
+
+```python
+from neurostore_sdk.models.base_studies_post200_response import BaseStudiesPost200Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseStudiesPost200Response from a JSON string
+base_studies_post200_response_instance = BaseStudiesPost200Response.from_json(json)
+# print the JSON string representation of the object
+print BaseStudiesPost200Response.to_json()
+
+# convert the object into a dict
+base_studies_post200_response_dict = base_studies_post200_response_instance.to_dict()
+# create an instance of BaseStudiesPost200Response from a dict
+base_studies_post200_response_form_dict = base_studies_post200_response.from_dict(base_studies_post200_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/BaseStudiesPostRequest.md b/docs/BaseStudiesPostRequest.md
@@ -0,0 +1,37 @@
+# BaseStudiesPostRequest
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **object** |  | [optional] 
+**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**publication** | **str** |  | [optional] 
+**doi** | **str** |  | [optional] 
+**pmid** | **str** |  | [optional] 
+**authors** | **str** |  | [optional] 
+**year** | **int** |  | [optional] 
+**level** | **str** |  | [optional] 
+
+## Example
+
+```python
+from neurostore_sdk.models.base_studies_post_request import BaseStudiesPostRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseStudiesPostRequest from a JSON string
+base_studies_post_request_instance = BaseStudiesPostRequest.from_json(json)
+# print the JSON string representation of the object
+print BaseStudiesPostRequest.to_json()
+
+# convert the object into a dict
+base_studies_post_request_dict = base_studies_post_request_instance.to_dict()
+# create an instance of BaseStudiesPostRequest from a dict
+base_studies_post_request_form_dict = base_studies_post_request.from_dict(base_studies_post_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/DefaultApi.md b/docs/DefaultApi.md
@@ -258,7 +258,7 @@ 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)
 
 # **base_studies_post**
-> BaseStudyReturn base_studies_post(base_study=base_study)
+> BaseStudiesPost200Response base_studies_post(base_studies_post_request=base_studies_post_request)
 
 
 
@@ -269,8 +269,8 @@ Name | Type | Description  | Notes
 import time
 import os
 import neurostore_sdk
-from neurostore_sdk.models.base_study import BaseStudy
-from neurostore_sdk.models.base_study_return import BaseStudyReturn
+from neurostore_sdk.models.base_studies_post200_response import BaseStudiesPost200Response
+from neurostore_sdk.models.base_studies_post_request import BaseStudiesPostRequest
 from neurostore_sdk.rest import ApiException
 from pprint import pprint
 
@@ -294,11 +294,11 @@ configuration = neurostore_sdk.Configuration(
 with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.DefaultApi(api_client)
-    base_study = neurostore_sdk.BaseStudy() # BaseStudy |  (optional)
+    base_studies_post_request = neurostore_sdk.BaseStudiesPostRequest() # BaseStudiesPostRequest |  (optional)
 
     try:
         # 
-        api_response = api_instance.base_studies_post(base_study=base_study)
+        api_response = api_instance.base_studies_post(base_studies_post_request=base_studies_post_request)
         print("The response of DefaultApi->base_studies_post:\n")
         pprint(api_response)
     except Exception as e:
@@ -310,11 +310,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **base_study** | [**BaseStudy**](BaseStudy.md)|  | [optional] 
+ **base_studies_post_request** | [**BaseStudiesPostRequest**](BaseStudiesPostRequest.md)|  | [optional] 
 
 ### Return type
 
-[**BaseStudyReturn**](BaseStudyReturn.md)
+[**BaseStudiesPost200Response**](BaseStudiesPost200Response.md)
 
 ### Authorization
 

diff --git a/docs/StudyReturn.md b/docs/StudyReturn.md
@@ -22,7 +22,9 @@ Name | Type | Description | Notes
 **source_id** | **str** |  | [optional] 
 **source_updated_at** | **str** |  | [optional] [readonly] 
 **analyses** | [**StudyReturnRelationshipsAnalyses**](StudyReturnRelationshipsAnalyses.md) |  | [optional] 
-**studysets** | [**List[StudyReturnAllOfStudysets]**](StudyReturnAllOfStudysets.md) |  | [optional] 
+**studysets** | [**List[StudyReturnAllOfStudysetsInner]**](StudyReturnAllOfStudysetsInner.md) |  | [optional] 
+**has_coordinates** | **bool** |  | [optional] 
+**has_images** | **bool** |  | [optional] 
 
 ## Example
 

diff --git a/docs/StudyReturnAllOf.md b/docs/StudyReturnAllOf.md
@@ -4,7 +4,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**studysets** | [**List[StudyReturnAllOfStudysets]**](StudyReturnAllOfStudysets.md) |  | [optional] 
+**studysets** | [**List[StudyReturnAllOfStudysetsInner]**](StudyReturnAllOfStudysetsInner.md) |  | [optional] 
+**has_coordinates** | **bool** |  | [optional] 
+**has_images** | **bool** |  | [optional] 
 
 ## Example
 

diff --git a/docs/StudyReturnAllOfStudysetsInner.md b/docs/StudyReturnAllOfStudysetsInner.md
@@ -0,0 +1,30 @@
+# StudyReturnAllOfStudysetsInner
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**id** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+
+## Example
+
+```python
+from neurostore_sdk.models.study_return_all_of_studysets_inner import StudyReturnAllOfStudysetsInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of StudyReturnAllOfStudysetsInner from a JSON string
+study_return_all_of_studysets_inner_instance = StudyReturnAllOfStudysetsInner.from_json(json)
+# print the JSON string representation of the object
+print StudyReturnAllOfStudysetsInner.to_json()
+
+# convert the object into a dict
+study_return_all_of_studysets_inner_dict = study_return_all_of_studysets_inner_instance.to_dict()
+# create an instance of StudyReturnAllOfStudysetsInner from a dict
+study_return_all_of_studysets_inner_form_dict = study_return_all_of_studysets_inner.from_dict(study_return_all_of_studysets_inner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/StudyReturnAllOfStudysetsInnerOneOf.md b/docs/StudyReturnAllOfStudysetsInnerOneOf.md
@@ -0,0 +1,30 @@
+# StudyReturnAllOfStudysetsInnerOneOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**id** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+
+## Example
+
+```python
+from neurostore_sdk.models.study_return_all_of_studysets_inner_one_of import StudyReturnAllOfStudysetsInnerOneOf
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of StudyReturnAllOfStudysetsInnerOneOf from a JSON string
+study_return_all_of_studysets_inner_one_of_instance = StudyReturnAllOfStudysetsInnerOneOf.from_json(json)
+# print the JSON string representation of the object
+print StudyReturnAllOfStudysetsInnerOneOf.to_json()
+
+# convert the object into a dict
+study_return_all_of_studysets_inner_one_of_dict = study_return_all_of_studysets_inner_one_of_instance.to_dict()
+# create an instance of StudyReturnAllOfStudysetsInnerOneOf from a dict
+study_return_all_of_studysets_inner_one_of_form_dict = study_return_all_of_studysets_inner_one_of.from_dict(study_return_all_of_studysets_inner_one_of_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/neurostore_sdk/__init__.py b/neurostore_sdk/__init__.py
@@ -67,6 +67,8 @@
 from neurostore_sdk.models.annotation_return_one_of1 import AnnotationReturnOneOf1
 from neurostore_sdk.models.annotation_return_relationships import AnnotationReturnRelationships
 from neurostore_sdk.models.annotation_return_relationships_notes import AnnotationReturnRelationshipsNotes
+from neurostore_sdk.models.base_studies_post200_response import BaseStudiesPost200Response
+from neurostore_sdk.models.base_studies_post_request import BaseStudiesPostRequest
 from neurostore_sdk.models.base_study import BaseStudy
 from neurostore_sdk.models.base_study_list import BaseStudyList
 from neurostore_sdk.models.base_study_return import BaseStudyReturn
@@ -109,7 +111,8 @@
 from neurostore_sdk.models.study_request_relationships_analyses import StudyRequestRelationshipsAnalyses
 from neurostore_sdk.models.study_return import StudyReturn
 from neurostore_sdk.models.study_return_all_of import StudyReturnAllOf
-from neurostore_sdk.models.study_return_all_of_studysets import StudyReturnAllOfStudysets
+from neurostore_sdk.models.study_return_all_of_studysets_inner import StudyReturnAllOfStudysetsInner
+from neurostore_sdk.models.study_return_all_of_studysets_inner_one_of import StudyReturnAllOfStudysetsInnerOneOf
 from neurostore_sdk.models.study_return_relationships import StudyReturnRelationships
 from neurostore_sdk.models.study_return_relationships_analyses import StudyReturnRelationshipsAnalyses
 from neurostore_sdk.models.studyset_base import StudysetBase

diff --git a/neurostore_sdk/api/default_api.py b/neurostore_sdk/api/default_api.py
@@ -24,6 +24,8 @@
 
 from typing import Optional
 
+from neurostore_sdk.models.base_studies_post200_response import BaseStudiesPost200Response
+from neurostore_sdk.models.base_studies_post_request import BaseStudiesPostRequest
 from neurostore_sdk.models.base_study import BaseStudy
 from neurostore_sdk.models.base_study_list import BaseStudyList
 from neurostore_sdk.models.base_study_return import BaseStudyReturn
@@ -603,17 +605,17 @@ def base_studies_id_put_with_http_info(self, id : StrictStr, base_study : Option
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def base_studies_post(self, base_study : Optional[BaseStudy] = None, **kwargs) -> BaseStudyReturn:  # noqa: E501
+    def base_studies_post(self, base_studies_post_request : Optional[BaseStudiesPostRequest] = None, **kwargs) -> BaseStudiesPost200Response:  # noqa: E501
         """  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.base_studies_post(base_study, async_req=True)
+        >>> thread = api.base_studies_post(base_studies_post_request, async_req=True)
         >>> result = thread.get()
 
-        :param base_study:
-        :type base_study: BaseStudy
+        :param base_studies_post_request:
+        :type base_studies_post_request: BaseStudiesPostRequest
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -623,25 +625,25 @@ def base_studies_post(self, base_study : Optional[BaseStudy] = None, **kwargs) -
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: BaseStudyReturn
+        :rtype: BaseStudiesPost200Response
         """
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the base_studies_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.base_studies_post_with_http_info(base_study, **kwargs)  # noqa: E501
+        return self.base_studies_post_with_http_info(base_studies_post_request, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def base_studies_post_with_http_info(self, base_study : Optional[BaseStudy] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def base_studies_post_with_http_info(self, base_studies_post_request : Optional[BaseStudiesPostRequest] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.base_studies_post_with_http_info(base_study, async_req=True)
+        >>> thread = api.base_studies_post_with_http_info(base_studies_post_request, async_req=True)
         >>> result = thread.get()
 
-        :param base_study:
-        :type base_study: BaseStudy
+        :param base_studies_post_request:
+        :type base_studies_post_request: BaseStudiesPostRequest
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -664,13 +666,13 @@ def base_studies_post_with_http_info(self, base_study : Optional[BaseStudy] = No
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: tuple(BaseStudyReturn, status_code(int), headers(HTTPHeaderDict))
+        :rtype: tuple(BaseStudiesPost200Response, status_code(int), headers(HTTPHeaderDict))
         """
 
         _params = locals()
 
         _all_params = [
-            'base_study'
+            'base_studies_post_request'
         ]
         _all_params.extend(
             [
@@ -708,8 +710,8 @@ def base_studies_post_with_http_info(self, base_study : Optional[BaseStudy] = No
         _files = {}
         # process the body parameter
         _body_params = None
-        if _params['base_study'] is not None:
-            _body_params = _params['base_study']
+        if _params['base_studies_post_request'] is not None:
+            _body_params = _params['base_studies_post_request']
 
         # set the HTTP header `Accept`
         _header_params['Accept'] = self.api_client.select_header_accept(
@@ -726,7 +728,7 @@ def base_studies_post_with_http_info(self, base_study : Optional[BaseStudy] = No
         _auth_settings = ['JSON-Web-Token']  # noqa: E501
 
         _response_types_map = {
-            '200': "BaseStudyReturn",
+            '200': "BaseStudiesPost200Response",
         }
 
         return self.api_client.call_api(