273cb981233291c8384882b34cf925927fe86d2c

docs/BaseStudyList.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **results** | [**List[BaseStudyReturn]**](BaseStudyReturn.md) |  | [optional] 
+**metadata** | [**Metadata**](Metadata.md) |  | [optional] 
 
 ## Example
 

docs/DefaultApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **base_studies_get**
-> BaseStudyReturn base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
+> BaseStudyList base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
 
 
 
@@ -22,7 +22,7 @@ Method | HTTP request | Description
 import time
 import os
 import neurostore_sdk
-from neurostore_sdk.models.base_study_return import BaseStudyReturn
+from neurostore_sdk.models.base_study_list import BaseStudyList
 from neurostore_sdk.rest import ApiException
 from pprint import pprint
 
@@ -96,7 +96,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**BaseStudyReturn**](BaseStudyReturn.md)
+[**BaseStudyList**](BaseStudyList.md)
 
 ### Authorization
 

neurostore_sdk/api/default_api.py

@@ -49,7 +49,7 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     @validate_arguments
-    def base_studies_get(self, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, desc : Annotated[Optional[StrictBool], Field(description="sort results by descending order (as opposed to ascending order)")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of results to show on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, authors : Annotated[Optional[StrictStr], Field(description="search authors")] = None, level : Annotated[Optional[StrictStr], Field(description="select between studies with group results or meta results")] = None, data_type : Annotated[Optional[StrictStr], Field(description="whether searching for studies that contain coordinates, images, or both")] = None, source : Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None, publication : Annotated[Optional[StrictStr], Field(description="search for papers from a particular journal")] = None, pmid : Annotated[Optional[StrictStr], Field(description="search for particular pmid")] = None, doi : Annotated[Optional[StrictStr], Field(description="search for study with specific doi")] = None, flat : Annotated[Optional[StrictStr], Field(description="do not return any embedded relationships. When set, it is incompatible with nested. ")] = None, info : Annotated[Optional[StrictStr], Field(description="show additional for endpoint-object relationships without being fully nested. Incompatible with nested")] = None, **kwargs) -> BaseStudyReturn:  # noqa: E501
+    def base_studies_get(self, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, desc : Annotated[Optional[StrictBool], Field(description="sort results by descending order (as opposed to ascending order)")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of results to show on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, authors : Annotated[Optional[StrictStr], Field(description="search authors")] = None, level : Annotated[Optional[StrictStr], Field(description="select between studies with group results or meta results")] = None, data_type : Annotated[Optional[StrictStr], Field(description="whether searching for studies that contain coordinates, images, or both")] = None, source : Annotated[Optional[StrictStr], Field(description="the source of the resource you would like to filter/copy from")] = None, publication : Annotated[Optional[StrictStr], Field(description="search for papers from a particular journal")] = None, pmid : Annotated[Optional[StrictStr], Field(description="search for particular pmid")] = None, doi : Annotated[Optional[StrictStr], Field(description="search for study with specific doi")] = None, flat : Annotated[Optional[StrictStr], Field(description="do not return any embedded relationships. When set, it is incompatible with nested. ")] = None, info : Annotated[Optional[StrictStr], Field(description="show additional for endpoint-object relationships without being fully nested. Incompatible with nested")] = None, **kwargs) -> BaseStudyList:  # noqa: E501
         """  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
@@ -99,7 +99,7 @@ def base_studies_get(self, search : Annotated[Optional[constr(strict=True, min_l
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: BaseStudyReturn
+        :rtype: BaseStudyList
         """
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
@@ -170,7 +170,7 @@ def base_studies_get_with_http_info(self, search : Annotated[Optional[constr(str
         :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(BaseStudyList, status_code(int), headers(HTTPHeaderDict))
         """
 
         _params = locals()
@@ -285,7 +285,7 @@ def base_studies_get_with_http_info(self, search : Annotated[Optional[constr(str
         _auth_settings = ['JSON-Web-Token']  # noqa: E501
 
         _response_types_map = {
-            '200': "BaseStudyReturn",
+            '200': "BaseStudyList",
         }
 
         return self.api_client.call_api(

neurostore_sdk/models/base_study_list.py

@@ -22,13 +22,15 @@
 from typing import List, Optional
 from pydantic import BaseModel, conlist
 from neurostore_sdk.models.base_study_return import BaseStudyReturn
+from neurostore_sdk.models.metadata import Metadata
 
 class BaseStudyList(BaseModel):
     """
     BaseStudyList
     """
     results: Optional[conlist(BaseStudyReturn)] = None
-    __properties = ["results"]
+    metadata: Optional[Metadata] = None
+    __properties = ["results", "metadata"]
 
     class Config:
         """Pydantic configuration"""
@@ -61,6 +63,9 @@ def to_dict(self):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['results'] = _items
+        # override the default output from pydantic by calling `to_dict()` of metadata
+        if self.metadata:
+            _dict['metadata'] = self.metadata.to_dict()
         return _dict
 
     @classmethod
@@ -73,7 +78,8 @@ def from_dict(cls, obj: dict) -> BaseStudyList:
             return BaseStudyList.parse_obj(obj)
 
         _obj = BaseStudyList.parse_obj({
-            "results": [BaseStudyReturn.from_dict(_item) for _item in obj.get("results")] if obj.get("results") is not None else None
+            "results": [BaseStudyReturn.from_dict(_item) for _item in obj.get("results")] if obj.get("results") is not None else None,
+            "metadata": Metadata.from_dict(obj.get("metadata")) if obj.get("metadata") is not None else None
         })
         return _obj