b470be8ac1d88768653571b235c57636b13b03b1

Author: github-actions[bot]

docs/ImageCommon.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **analysis** | **str** |  | [optional] 
+**study** | **str** |  | [optional] 
 
 ## Example
 

docs/ImageRelationships.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **analysis** | **str** |  | [optional] 
+**study** | **str** |  | [optional] 
 **entities** | [**List[Entity]**](Entity.md) |  | [optional] 
 **analysis_name** | **str** |  | [optional] 
 

docs/ImageRequest.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **value_type** | **str** | The values the image represents. For example, T-statistic or Z-statistic, or Betas. | [optional] 
 **add_date** | **datetime** | Date the image was added. | [optional] [readonly] 
 **analysis** | **str** |  | [optional] 
+**study** | **str** |  | [optional] 
 **entities** | [**List[Entity]**](Entity.md) |  | [optional] 
 **analysis_name** | **str** |  | [optional] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 

docs/ImageReturn.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **value_type** | **str** | The values the image represents. For example, T-statistic or Z-statistic, or Betas. | [optional] 
 **add_date** | **datetime** | Date the image was added. | [optional] [readonly] 
 **analysis** | **str** |  | [optional] 
+**study** | **str** |  | [optional] 
 **entities** | [**List[Entity]**](Entity.md) |  | [optional] 
 **analysis_name** | **str** |  | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 

docs/ImagesApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **images_get**
-> ImageList images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
+> ImageList images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, study=study, analysis_name=analysis_name, value_type=value_type, space=space)
 
 GET a list of images
 
@@ -45,13 +45,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     page_size = 56 # int | number of results to show on a page (optional)
     paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
     filename = 'filename_example' # str | search filename field (optional)
+    study = 'study_example' # str | Filter images by study id (optional)
     analysis_name = 'analysis_name_example' # str | search analysis_name field (optional)
     value_type = 'value_type_example' # str | search value_type field (optional)
     space = 'space_example' # str | search space field (optional)
 
     try:
         # GET a list of images
-        api_response = api_instance.images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
+        api_response = api_instance.images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, study=study, analysis_name=analysis_name, value_type=value_type, space=space)
         print("The response of ImagesApi->images_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -72,6 +73,7 @@ Name | Type | Description  | Notes
  **page_size** | **int**| number of results to show on a page | [optional] 
  **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
  **filename** | **str**| search filename field | [optional] 
+ **study** | **str**| Filter images by study id | [optional] 
  **analysis_name** | **str**| search analysis_name field | [optional] 
  **value_type** | **str**| search value_type field | [optional] 
  **space** | **str**| search space field | [optional] 

neurostore_sdk/api/images_api.py

@@ -52,6 +52,7 @@ def images_get(
         page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
         paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
         filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
+        study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
         analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
         value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
         space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -86,6 +87,8 @@ def images_get(
         :type paginate: bool
         :param filename: search filename field
         :type filename: str
+        :param study: Filter images by study id
+        :type study: str
         :param analysis_name: search analysis_name field
         :type analysis_name: str
         :param value_type: search value_type field
@@ -122,6 +125,7 @@ def images_get(
             page_size=page_size,
             paginate=paginate,
             filename=filename,
+            study=study,
             analysis_name=analysis_name,
             value_type=value_type,
             space=space,
@@ -155,6 +159,7 @@ def images_get_with_http_info(
         page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
         paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
         filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
+        study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
         analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
         value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
         space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -189,6 +194,8 @@ def images_get_with_http_info(
         :type paginate: bool
         :param filename: search filename field
         :type filename: str
+        :param study: Filter images by study id
+        :type study: str
         :param analysis_name: search analysis_name field
         :type analysis_name: str
         :param value_type: search value_type field
@@ -225,6 +232,7 @@ def images_get_with_http_info(
             page_size=page_size,
             paginate=paginate,
             filename=filename,
+            study=study,
             analysis_name=analysis_name,
             value_type=value_type,
             space=space,
@@ -258,6 +266,7 @@ def images_get_without_preload_content(
         page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
         paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
         filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
+        study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
         analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
         value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
         space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -292,6 +301,8 @@ def images_get_without_preload_content(
         :type paginate: bool
         :param filename: search filename field
         :type filename: str
+        :param study: Filter images by study id
+        :type study: str
         :param analysis_name: search analysis_name field
         :type analysis_name: str
         :param value_type: search value_type field
@@ -328,6 +339,7 @@ def images_get_without_preload_content(
             page_size=page_size,
             paginate=paginate,
             filename=filename,
+            study=study,
             analysis_name=analysis_name,
             value_type=value_type,
             space=space,
@@ -356,6 +368,7 @@ def _images_get_serialize(
         page_size,
         paginate,
         filename,
+        study,
         analysis_name,
         value_type,
         space,
@@ -409,6 +422,10 @@ def _images_get_serialize(
 
             _query_params.append(('filename', filename))
 
+        if study is not None:
+            
+            _query_params.append(('study', study))
+            
         if analysis_name is not None:
 
             _query_params.append(('analysis_name', analysis_name))

neurostore_sdk/models/image_common.py

@@ -28,7 +28,8 @@ class ImageCommon(BaseModel):
     ImageCommon
     """ # noqa: E501
     analysis: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["analysis"]
+    study: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["analysis", "study"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -69,6 +70,16 @@ def to_dict(self) -> Dict[str, Any]:
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if analysis (nullable) is None
+        # and model_fields_set contains the field
+        if self.analysis is None and "analysis" in self.model_fields_set:
+            _dict['analysis'] = None
+
+        # set to None if study (nullable) is None
+        # and model_fields_set contains the field
+        if self.study is None and "study" in self.model_fields_set:
+            _dict['study'] = None
+
         return _dict
 
     @classmethod
@@ -81,7 +92,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "analysis": obj.get("analysis")
+            "analysis": obj.get("analysis"),
+            "study": obj.get("study")
         })
         return _obj
 

neurostore_sdk/models/image_relationships.py

@@ -29,9 +29,10 @@ class ImageRelationships(BaseModel):
     ImageRelationships
     """ # noqa: E501
     analysis: Optional[StrictStr] = None
+    study: Optional[StrictStr] = None
     entities: Optional[List[Entity]] = None
     analysis_name: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["analysis", "entities", "analysis_name"]
+    __properties: ClassVar[List[str]] = ["analysis", "study", "entities", "analysis_name"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -79,6 +80,16 @@ def to_dict(self) -> Dict[str, Any]:
                 if _item_entities:
                     _items.append(_item_entities.to_dict())
             _dict['entities'] = _items
+        # set to None if analysis (nullable) is None
+        # and model_fields_set contains the field
+        if self.analysis is None and "analysis" in self.model_fields_set:
+            _dict['analysis'] = None
+
+        # set to None if study (nullable) is None
+        # and model_fields_set contains the field
+        if self.study is None and "study" in self.model_fields_set:
+            _dict['study'] = None
+
         # set to None if analysis_name (nullable) is None
         # and model_fields_set contains the field
         if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -97,6 +108,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "analysis": obj.get("analysis"),
+            "study": obj.get("study"),
             "entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
             "analysis_name": obj.get("analysis_name")
         })

neurostore_sdk/models/image_request.py

@@ -37,11 +37,12 @@ class ImageRequest(BaseModel):
     value_type: Optional[StrictStr] = Field(default=None, description="The values the image represents. For example, T-statistic or Z-statistic, or Betas.")
     add_date: Optional[datetime] = Field(default=None, description="Date the image was added.")
     analysis: Optional[StrictStr] = None
+    study: Optional[StrictStr] = None
     entities: Optional[List[Entity]] = None
     analysis_name: Optional[StrictStr] = None
     id: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=30)]] = Field(default=None, description="short UUID specifying the location of this resource")
     public: Optional[StrictBool] = Field(default=True, description="whether the resource is listed in public searches or not")
-    __properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "entities", "analysis_name", "id", "public"]
+    __properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "study", "entities", "analysis_name", "id", "public"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -121,6 +122,16 @@ def to_dict(self) -> Dict[str, Any]:
         if self.add_date is None and "add_date" in self.model_fields_set:
             _dict['add_date'] = None
 
+        # set to None if analysis (nullable) is None
+        # and model_fields_set contains the field
+        if self.analysis is None and "analysis" in self.model_fields_set:
+            _dict['analysis'] = None
+
+        # set to None if study (nullable) is None
+        # and model_fields_set contains the field
+        if self.study is None and "study" in self.model_fields_set:
+            _dict['study'] = None
+
         # set to None if analysis_name (nullable) is None
         # and model_fields_set contains the field
         if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -145,6 +156,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "value_type": obj.get("value_type"),
             "add_date": obj.get("add_date"),
             "analysis": obj.get("analysis"),
+            "study": obj.get("study"),
             "entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
             "analysis_name": obj.get("analysis_name"),
             "id": obj.get("id"),

neurostore_sdk/models/image_return.py

@@ -37,6 +37,7 @@ class ImageReturn(BaseModel):
     value_type: Optional[StrictStr] = Field(default=None, description="The values the image represents. For example, T-statistic or Z-statistic, or Betas.")
     add_date: Optional[datetime] = Field(default=None, description="Date the image was added.")
     analysis: Optional[StrictStr] = None
+    study: Optional[StrictStr] = None
     entities: Optional[List[Entity]] = None
     analysis_name: Optional[StrictStr] = None
     created_at: Optional[datetime] = Field(default=None, description="time the resource was created on the database")
@@ -45,7 +46,7 @@ class ImageReturn(BaseModel):
     public: Optional[StrictBool] = Field(default=True, description="whether the resource is listed in public searches or not")
     user: Optional[StrictStr] = Field(default=None, description="who owns the resource")
     username: Optional[StrictStr] = Field(default=None, description="human readable username")
-    __properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "entities", "analysis_name", "created_at", "updated_at", "id", "public", "user", "username"]
+    __properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "study", "entities", "analysis_name", "created_at", "updated_at", "id", "public", "user", "username"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -131,6 +132,16 @@ def to_dict(self) -> Dict[str, Any]:
         if self.add_date is None and "add_date" in self.model_fields_set:
             _dict['add_date'] = None
 
+        # set to None if analysis (nullable) is None
+        # and model_fields_set contains the field
+        if self.analysis is None and "analysis" in self.model_fields_set:
+            _dict['analysis'] = None
+
+        # set to None if study (nullable) is None
+        # and model_fields_set contains the field
+        if self.study is None and "study" in self.model_fields_set:
+            _dict['study'] = None
+
         # set to None if analysis_name (nullable) is None
         # and model_fields_set contains the field
         if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -170,6 +181,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "value_type": obj.get("value_type"),
             "add_date": obj.get("add_date"),
             "analysis": obj.get("analysis"),
+            "study": obj.get("study"),
             "entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
             "analysis_name": obj.get("analysis_name"),
             "created_at": obj.get("created_at"),