Skip to content

Commit 9ae1c9f

Browse files
60cb456fbcdfd0c2cb6410b4048b235135235b0a
1 parent 1180968 commit 9ae1c9f

14 files changed

Lines changed: 83 additions & 8 deletions

docs/ImageCommon.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**analysis** | **str** | | [optional]
9+
**study** | **str** | | [optional]
910

1011
## Example
1112

docs/ImageRelationships.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**analysis** | **str** | | [optional]
9+
**study** | **str** | | [optional]
910
**entities** | [**List[Entity]**](Entity.md) | | [optional]
1011
**analysis_name** | **str** | | [optional]
1112

docs/ImageRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
1212
**value_type** | **str** | The values the image represents. For example, T-statistic or Z-statistic, or Betas. | [optional]
1313
**add_date** | **datetime** | Date the image was added. | [optional] [readonly]
1414
**analysis** | **str** | | [optional]
15+
**study** | **str** | | [optional]
1516
**entities** | [**List[Entity]**](Entity.md) | | [optional]
1617
**analysis_name** | **str** | | [optional]
1718
**id** | **str** | short UUID specifying the location of this resource | [optional]

docs/ImageReturn.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
1212
**value_type** | **str** | The values the image represents. For example, T-statistic or Z-statistic, or Betas. | [optional]
1313
**add_date** | **datetime** | Date the image was added. | [optional] [readonly]
1414
**analysis** | **str** | | [optional]
15+
**study** | **str** | | [optional]
1516
**entities** | [**List[Entity]**](Entity.md) | | [optional]
1617
**analysis_name** | **str** | | [optional]
1718
**created_at** | **datetime** | time the resource was created on the database | [optional] [readonly]

docs/StoreApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1906,7 +1906,7 @@ Name | Type | Description | Notes
19061906
[[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)
19071907

19081908
# **images_get**
1909-
> 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)
1909+
> 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)
19101910
19111911
GET a list of images
19121912

@@ -1939,13 +1939,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
19391939
page_size = 56 # int | number of results to show on a page (optional)
19401940
paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
19411941
filename = 'filename_example' # str | search filename field (optional)
1942+
study = 'study_example' # str | Filter images by study id (optional)
19421943
analysis_name = 'analysis_name_example' # str | search analysis_name field (optional)
19431944
value_type = 'value_type_example' # str | search value_type field (optional)
19441945
space = 'space_example' # str | search space field (optional)
19451946

19461947
try:
19471948
# GET a list of images
1948-
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)
1949+
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)
19491950
print("The response of StoreApi->images_get:\n")
19501951
pprint(api_response)
19511952
except Exception as e:
@@ -1966,6 +1967,7 @@ Name | Type | Description | Notes
19661967
**page_size** | **int**| number of results to show on a page | [optional]
19671968
**paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
19681969
**filename** | **str**| search filename field | [optional]
1970+
**study** | **str**| Filter images by study id | [optional]
19691971
**analysis_name** | **str**| search analysis_name field | [optional]
19701972
**value_type** | **str**| search value_type field | [optional]
19711973
**space** | **str**| search space field | [optional]

neurostore_sdk/api/store_api.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7230,6 +7230,7 @@ def images_get(
72307230
page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
72317231
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
72327232
filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
7233+
study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
72337234
analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
72347235
value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
72357236
space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -7264,6 +7265,8 @@ def images_get(
72647265
:type paginate: bool
72657266
:param filename: search filename field
72667267
:type filename: str
7268+
:param study: Filter images by study id
7269+
:type study: str
72677270
:param analysis_name: search analysis_name field
72687271
:type analysis_name: str
72697272
:param value_type: search value_type field
@@ -7300,6 +7303,7 @@ def images_get(
73007303
page_size=page_size,
73017304
paginate=paginate,
73027305
filename=filename,
7306+
study=study,
73037307
analysis_name=analysis_name,
73047308
value_type=value_type,
73057309
space=space,
@@ -7333,6 +7337,7 @@ def images_get_with_http_info(
73337337
page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
73347338
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
73357339
filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
7340+
study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
73367341
analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
73377342
value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
73387343
space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -7367,6 +7372,8 @@ def images_get_with_http_info(
73677372
:type paginate: bool
73687373
:param filename: search filename field
73697374
:type filename: str
7375+
:param study: Filter images by study id
7376+
:type study: str
73707377
:param analysis_name: search analysis_name field
73717378
:type analysis_name: str
73727379
:param value_type: search value_type field
@@ -7403,6 +7410,7 @@ def images_get_with_http_info(
74037410
page_size=page_size,
74047411
paginate=paginate,
74057412
filename=filename,
7413+
study=study,
74067414
analysis_name=analysis_name,
74077415
value_type=value_type,
74087416
space=space,
@@ -7436,6 +7444,7 @@ def images_get_without_preload_content(
74367444
page_size: Annotated[Optional[Annotated[int, Field(lt=30000, strict=True, ge=1)]], Field(description="number of results to show on a page")] = None,
74377445
paginate: Annotated[Optional[StrictBool], Field(description="whether to paginate results (true) or return all results at once (false)")] = None,
74387446
filename: Annotated[Optional[StrictStr], Field(description="search filename field")] = None,
7447+
study: Annotated[Optional[StrictStr], Field(description="Filter images by study id")] = None,
74397448
analysis_name: Annotated[Optional[StrictStr], Field(description="search analysis_name field")] = None,
74407449
value_type: Annotated[Optional[StrictStr], Field(description="search value_type field")] = None,
74417450
space: Annotated[Optional[StrictStr], Field(description="search space field")] = None,
@@ -7470,6 +7479,8 @@ def images_get_without_preload_content(
74707479
:type paginate: bool
74717480
:param filename: search filename field
74727481
:type filename: str
7482+
:param study: Filter images by study id
7483+
:type study: str
74737484
:param analysis_name: search analysis_name field
74747485
:type analysis_name: str
74757486
:param value_type: search value_type field
@@ -7506,6 +7517,7 @@ def images_get_without_preload_content(
75067517
page_size=page_size,
75077518
paginate=paginate,
75087519
filename=filename,
7520+
study=study,
75097521
analysis_name=analysis_name,
75107522
value_type=value_type,
75117523
space=space,
@@ -7534,6 +7546,7 @@ def _images_get_serialize(
75347546
page_size,
75357547
paginate,
75367548
filename,
7549+
study,
75377550
analysis_name,
75387551
value_type,
75397552
space,
@@ -7587,6 +7600,10 @@ def _images_get_serialize(
75877600

75887601
_query_params.append(('filename', filename))
75897602

7603+
if study is not None:
7604+
7605+
_query_params.append(('study', study))
7606+
75907607
if analysis_name is not None:
75917608

75927609
_query_params.append(('analysis_name', analysis_name))

neurostore_sdk/models/image_common.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ class ImageCommon(BaseModel):
2828
ImageCommon
2929
""" # noqa: E501
3030
analysis: Optional[StrictStr] = None
31-
__properties: ClassVar[List[str]] = ["analysis"]
31+
study: Optional[StrictStr] = None
32+
__properties: ClassVar[List[str]] = ["analysis", "study"]
3233

3334
model_config = ConfigDict(
3435
populate_by_name=True,
@@ -68,6 +69,16 @@ def to_dict(self) -> Dict[str, Any]:
6869
exclude=excluded_fields,
6970
exclude_none=True,
7071
)
72+
# set to None if analysis (nullable) is None
73+
# and model_fields_set contains the field
74+
if self.analysis is None and "analysis" in self.model_fields_set:
75+
_dict['analysis'] = None
76+
77+
# set to None if study (nullable) is None
78+
# and model_fields_set contains the field
79+
if self.study is None and "study" in self.model_fields_set:
80+
_dict['study'] = None
81+
7182
return _dict
7283

7384
@classmethod
@@ -80,7 +91,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
8091
return cls.model_validate(obj)
8192

8293
_obj = cls.model_validate({
83-
"analysis": obj.get("analysis")
94+
"analysis": obj.get("analysis"),
95+
"study": obj.get("study")
8496
})
8597
return _obj
8698

neurostore_sdk/models/image_relationships.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ class ImageRelationships(BaseModel):
2929
ImageRelationships
3030
""" # noqa: E501
3131
analysis: Optional[StrictStr] = None
32+
study: Optional[StrictStr] = None
3233
entities: Optional[List[Entity]] = None
3334
analysis_name: Optional[StrictStr] = None
34-
__properties: ClassVar[List[str]] = ["analysis", "entities", "analysis_name"]
35+
__properties: ClassVar[List[str]] = ["analysis", "study", "entities", "analysis_name"]
3536

3637
model_config = ConfigDict(
3738
populate_by_name=True,
@@ -78,6 +79,16 @@ def to_dict(self) -> Dict[str, Any]:
7879
if _item_entities is not None:
7980
_items.append(_item_entities.to_dict())
8081
_dict['entities'] = _items
82+
# set to None if analysis (nullable) is None
83+
# and model_fields_set contains the field
84+
if self.analysis is None and "analysis" in self.model_fields_set:
85+
_dict['analysis'] = None
86+
87+
# set to None if study (nullable) is None
88+
# and model_fields_set contains the field
89+
if self.study is None and "study" in self.model_fields_set:
90+
_dict['study'] = None
91+
8192
# set to None if analysis_name (nullable) is None
8293
# and model_fields_set contains the field
8394
if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -96,6 +107,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
96107

97108
_obj = cls.model_validate({
98109
"analysis": obj.get("analysis"),
110+
"study": obj.get("study"),
99111
"entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
100112
"analysis_name": obj.get("analysis_name")
101113
})

neurostore_sdk/models/image_request.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,12 @@ class ImageRequest(BaseModel):
3737
value_type: Optional[StrictStr] = Field(default=None, description="The values the image represents. For example, T-statistic or Z-statistic, or Betas.")
3838
add_date: Optional[datetime] = Field(default=None, description="Date the image was added.")
3939
analysis: Optional[StrictStr] = None
40+
study: Optional[StrictStr] = None
4041
entities: Optional[List[Entity]] = None
4142
analysis_name: Optional[StrictStr] = None
4243
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")
4344
public: Optional[StrictBool] = Field(default=True, description="whether the resource is listed in public searches or not")
44-
__properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "entities", "analysis_name", "id", "public"]
45+
__properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "study", "entities", "analysis_name", "id", "public"]
4546

4647
model_config = ConfigDict(
4748
populate_by_name=True,
@@ -119,6 +120,16 @@ def to_dict(self) -> Dict[str, Any]:
119120
if self.add_date is None and "add_date" in self.model_fields_set:
120121
_dict['add_date'] = None
121122

123+
# set to None if analysis (nullable) is None
124+
# and model_fields_set contains the field
125+
if self.analysis is None and "analysis" in self.model_fields_set:
126+
_dict['analysis'] = None
127+
128+
# set to None if study (nullable) is None
129+
# and model_fields_set contains the field
130+
if self.study is None and "study" in self.model_fields_set:
131+
_dict['study'] = None
132+
122133
# set to None if analysis_name (nullable) is None
123134
# and model_fields_set contains the field
124135
if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -143,6 +154,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
143154
"value_type": obj.get("value_type"),
144155
"add_date": obj.get("add_date"),
145156
"analysis": obj.get("analysis"),
157+
"study": obj.get("study"),
146158
"entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
147159
"analysis_name": obj.get("analysis_name"),
148160
"id": obj.get("id"),

neurostore_sdk/models/image_return.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class ImageReturn(BaseModel):
3737
value_type: Optional[StrictStr] = Field(default=None, description="The values the image represents. For example, T-statistic or Z-statistic, or Betas.")
3838
add_date: Optional[datetime] = Field(default=None, description="Date the image was added.")
3939
analysis: Optional[StrictStr] = None
40+
study: Optional[StrictStr] = None
4041
entities: Optional[List[Entity]] = None
4142
analysis_name: Optional[StrictStr] = None
4243
created_at: Optional[datetime] = Field(default=None, description="time the resource was created on the database")
@@ -45,7 +46,7 @@ class ImageReturn(BaseModel):
4546
public: Optional[StrictBool] = Field(default=True, description="whether the resource is listed in public searches or not")
4647
user: Optional[StrictStr] = Field(default=None, description="who owns the resource")
4748
username: Optional[StrictStr] = Field(default=None, description="human readable username")
48-
__properties: ClassVar[List[str]] = ["metadata", "url", "filename", "space", "value_type", "add_date", "analysis", "entities", "analysis_name", "created_at", "updated_at", "id", "public", "user", "username"]
49+
__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"]
4950

5051
model_config = ConfigDict(
5152
populate_by_name=True,
@@ -126,6 +127,16 @@ def to_dict(self) -> Dict[str, Any]:
126127
if self.add_date is None and "add_date" in self.model_fields_set:
127128
_dict['add_date'] = None
128129

130+
# set to None if analysis (nullable) is None
131+
# and model_fields_set contains the field
132+
if self.analysis is None and "analysis" in self.model_fields_set:
133+
_dict['analysis'] = None
134+
135+
# set to None if study (nullable) is None
136+
# and model_fields_set contains the field
137+
if self.study is None and "study" in self.model_fields_set:
138+
_dict['study'] = None
139+
129140
# set to None if analysis_name (nullable) is None
130141
# and model_fields_set contains the field
131142
if self.analysis_name is None and "analysis_name" in self.model_fields_set:
@@ -165,6 +176,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
165176
"value_type": obj.get("value_type"),
166177
"add_date": obj.get("add_date"),
167178
"analysis": obj.get("analysis"),
179+
"study": obj.get("study"),
168180
"entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
169181
"analysis_name": obj.get("analysis_name"),
170182
"created_at": obj.get("created_at"),

0 commit comments

Comments
 (0)