From f6120f818feca24e6184604ec2f83dfcace0edbd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 29 Feb 2024 00:12:21 +0000 Subject: [PATCH] 07eedcd48239f15365e73295cb63d1f3e510c95f --- docs/ComposeApi.md | 36 +++++- docs/GetApi.md | 36 +++++- docs/MetaAnalysesApi.md | 16 ++- docs/ProjectsApi.md | 20 ++- neurosynth_compose_sdk/api/compose_api.py | 120 ++++++++++++++++-- neurosynth_compose_sdk/api/get_api.py | 120 ++++++++++++++++-- .../api/meta_analyses_api.py | 62 ++++++++- neurosynth_compose_sdk/api/projects_api.py | 60 ++++++++- 8 files changed, 418 insertions(+), 52 deletions(-) diff --git a/docs/ComposeApi.md b/docs/ComposeApi.md index 5628af9..1f6c0b1 100644 --- a/docs/ComposeApi.md +++ b/docs/ComposeApi.md @@ -334,7 +334,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) # **meta_analyses_get** -> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids) +> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) GET a list of meta-analyses @@ -363,10 +363,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: api_instance = neurosynth_compose_sdk.ComposeApi(api_client) nested = True # bool | show nested component instead of id (optional) ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # GET a list of meta-analyses - api_response = api_instance.meta_analyses_get(nested=nested, ids=ids) + api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of ComposeApi->meta_analyses_get:\n") pprint(api_response) except Exception as e: @@ -380,6 +386,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **nested** | **bool**| show nested component instead of id | [optional] **ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional] + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type @@ -1486,7 +1498,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) # **projects_get** -> ProjectList projects_get() +> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) Your GET endpoint @@ -1521,10 +1533,16 @@ configuration = neurosynth_compose_sdk.Configuration( with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # Your GET endpoint - api_response = api_instance.projects_get() + api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of ComposeApi->projects_get:\n") pprint(api_response) except Exception as e: @@ -1533,7 +1551,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type diff --git a/docs/GetApi.md b/docs/GetApi.md index 7adc059..a4c7cba 100644 --- a/docs/GetApi.md +++ b/docs/GetApi.md @@ -154,7 +154,7 @@ No authorization required [[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) # **meta_analyses_get** -> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids) +> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) GET a list of meta-analyses @@ -183,10 +183,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: api_instance = neurosynth_compose_sdk.GetApi(api_client) nested = True # bool | show nested component instead of id (optional) ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # GET a list of meta-analyses - api_response = api_instance.meta_analyses_get(nested=nested, ids=ids) + api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of GetApi->meta_analyses_get:\n") pprint(api_response) except Exception as e: @@ -200,6 +206,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **nested** | **bool**| show nested component instead of id | [optional] **ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional] + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type @@ -666,7 +678,7 @@ No authorization required [[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) # **projects_get** -> ProjectList projects_get() +> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) Your GET endpoint @@ -701,10 +713,16 @@ configuration = neurosynth_compose_sdk.Configuration( with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.GetApi(api_client) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # Your GET endpoint - api_response = api_instance.projects_get() + api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of GetApi->projects_get:\n") pprint(api_response) except Exception as e: @@ -713,7 +731,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type diff --git a/docs/MetaAnalysesApi.md b/docs/MetaAnalysesApi.md index 6f1d343..2006ce1 100644 --- a/docs/MetaAnalysesApi.md +++ b/docs/MetaAnalysesApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description # **meta_analyses_get** -> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids) +> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) GET a list of meta-analyses @@ -44,10 +44,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: api_instance = neurosynth_compose_sdk.MetaAnalysesApi(api_client) nested = True # bool | show nested component instead of id (optional) ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # GET a list of meta-analyses - api_response = api_instance.meta_analyses_get(nested=nested, ids=ids) + api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of MetaAnalysesApi->meta_analyses_get:\n") pprint(api_response) except Exception as e: @@ -61,6 +67,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **nested** | **bool**| show nested component instead of id | [optional] **ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional] + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md index fe3893a..53dba3e 100644 --- a/docs/ProjectsApi.md +++ b/docs/ProjectsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **projects_get** -> ProjectList projects_get() +> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) Your GET endpoint @@ -47,10 +47,16 @@ configuration = neurosynth_compose_sdk.Configuration( with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.ProjectsApi(api_client) + page = 56 # int | page of results (optional) + page_size = 56 # int | number of elements to return on a page (optional) + name = 'name_example' # str | search the name field for a term (optional) + search = 'imagin' # str | search for entries that contain the substring (optional) + description = 'description_example' # str | search description field for a term (optional) + sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at') try: # Your GET endpoint - api_response = api_instance.projects_get() + api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort) print("The response of ProjectsApi->projects_get:\n") pprint(api_response) except Exception as e: @@ -59,7 +65,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| page of results | [optional] + **page_size** | **int**| number of elements to return on a page | [optional] + **name** | **str**| search the name field for a term | [optional] + **search** | **str**| search for entries that contain the substring | [optional] + **description** | **str**| search description field for a term | [optional] + **sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at'] ### Return type diff --git a/neurosynth_compose_sdk/api/compose_api.py b/neurosynth_compose_sdk/api/compose_api.py index 3f73161..776ecf4 100644 --- a/neurosynth_compose_sdk/api/compose_api.py +++ b/neurosynth_compose_sdk/api/compose_api.py @@ -20,7 +20,7 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictBool, StrictStr, conlist +from pydantic import Field, StrictBool, StrictStr, conint, conlist, constr from typing import Optional @@ -654,20 +654,32 @@ def annotations_post_with_http_info(self, annotation_post_body : Optional[Annota _request_auth=_params.get('_request_auth')) @validate_arguments - def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 + def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -682,23 +694,35 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501 + return self.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -728,7 +752,13 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _all_params = [ 'nested', - 'ids' + 'ids', + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -766,6 +796,24 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _query_params.append(('ids', _params['ids'])) _collection_formats['ids'] = 'multi' + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -2976,15 +3024,27 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov _request_auth=_params.get('_request_auth')) @validate_arguments - def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 + def projects_get(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ProjectList: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get(async_req=True) + >>> thread = api.projects_get(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -2999,18 +3059,30 @@ def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the projects_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.projects_get_with_http_info(**kwargs) # noqa: E501 + return self.projects_get_with_http_info(page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + def projects_get_with_http_info(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get_with_http_info(async_req=True) + >>> thread = api.projects_get_with_http_info(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3039,6 +3111,12 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _params = locals() _all_params = [ + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -3069,6 +3147,24 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters diff --git a/neurosynth_compose_sdk/api/get_api.py b/neurosynth_compose_sdk/api/get_api.py index ed04b81..f54c6e1 100644 --- a/neurosynth_compose_sdk/api/get_api.py +++ b/neurosynth_compose_sdk/api/get_api.py @@ -20,7 +20,7 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictBool, StrictStr, conlist +from pydantic import Field, StrictBool, StrictStr, conint, conlist, constr from typing import Optional @@ -334,20 +334,32 @@ def annotations_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResp _request_auth=_params.get('_request_auth')) @validate_arguments - def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 + def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -362,23 +374,35 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501 + return self.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -408,7 +432,13 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _all_params = [ 'nested', - 'ids' + 'ids', + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -446,6 +476,24 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _query_params.append(('ids', _params['ids'])) _collection_formats['ids'] = 'multi' + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -1432,15 +1480,27 @@ def neurovault_files_id_get_with_http_info(self, id : StrictStr, **kwargs) -> Ap _request_auth=_params.get('_request_auth')) @validate_arguments - def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 + def projects_get(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ProjectList: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get(async_req=True) + >>> thread = api.projects_get(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -1455,18 +1515,30 @@ def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the projects_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.projects_get_with_http_info(**kwargs) # noqa: E501 + return self.projects_get_with_http_info(page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + def projects_get_with_http_info(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get_with_http_info(async_req=True) + >>> thread = api.projects_get_with_http_info(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1495,6 +1567,12 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _params = locals() _all_params = [ + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -1525,6 +1603,24 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters diff --git a/neurosynth_compose_sdk/api/meta_analyses_api.py b/neurosynth_compose_sdk/api/meta_analyses_api.py index 4594090..ec6530a 100644 --- a/neurosynth_compose_sdk/api/meta_analyses_api.py +++ b/neurosynth_compose_sdk/api/meta_analyses_api.py @@ -20,7 +20,7 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictBool, StrictStr, conlist +from pydantic import Field, StrictBool, StrictStr, conint, conlist, constr from typing import Optional @@ -54,20 +54,32 @@ def __init__(self, api_client=None): self.api_client = api_client @validate_arguments - def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 + def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -82,23 +94,35 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501 + return self.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """GET a list of meta-analyses # noqa: E501 list all runnable specification, studyset, annotation bundles # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True) + >>> thread = api.meta_analyses_get_with_http_info(nested, ids, page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() :param nested: show nested component instead of id :type nested: bool :param ids: choose the specific ids you wish to get :type ids: List[str] + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -128,7 +152,13 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _all_params = [ 'nested', - 'ids' + 'ids', + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -166,6 +196,24 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo _query_params.append(('ids', _params['ids'])) _collection_formats['ids'] = 'multi' + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters diff --git a/neurosynth_compose_sdk/api/projects_api.py b/neurosynth_compose_sdk/api/projects_api.py index 34a754c..ee0ee26 100644 --- a/neurosynth_compose_sdk/api/projects_api.py +++ b/neurosynth_compose_sdk/api/projects_api.py @@ -20,7 +20,7 @@ from pydantic import validate_arguments, ValidationError from typing_extensions import Annotated -from pydantic import Field, StrictBool, StrictStr +from pydantic import Field, StrictBool, StrictStr, conint, constr from typing import Optional @@ -49,15 +49,27 @@ def __init__(self, api_client=None): self.api_client = api_client @validate_arguments - def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 + def projects_get(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ProjectList: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get(async_req=True) + >>> thread = api.projects_get(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -72,18 +84,30 @@ def projects_get(self, **kwargs) -> ProjectList: # noqa: E501 kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: raise ValueError("Error! Please call the projects_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.projects_get_with_http_info(**kwargs) # noqa: E501 + return self.projects_get_with_http_info(page, page_size, name, search, description, sort, **kwargs) # noqa: E501 @validate_arguments - def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + def projects_get_with_http_info(self, page : Annotated[Optional[conint(strict=True, ge=0)], Field(description="page of results")] = None, page_size : Annotated[Optional[conint(strict=True, lt=30000, ge=1)], Field(description="number of elements to return on a page")] = None, name : Annotated[Optional[StrictStr], Field(description="search the name field for a term")] = None, search : Annotated[Optional[constr(strict=True, min_length=1)], Field(description="search for entries that contain the substring")] = None, description : Annotated[Optional[StrictStr], Field(description="search description field for a term")] = None, sort : Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None, **kwargs) -> ApiResponse: # noqa: E501 """Your GET endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_get_with_http_info(async_req=True) + >>> thread = api.projects_get_with_http_info(page, page_size, name, search, description, sort, async_req=True) >>> result = thread.get() + :param page: page of results + :type page: int + :param page_size: number of elements to return on a page + :type page_size: int + :param name: search the name field for a term + :type name: str + :param search: search for entries that contain the substring + :type search: str + :param description: search description field for a term + :type description: str + :param sort: Parameter to sort results on + :type sort: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -112,6 +136,12 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 _params = locals() _all_params = [ + 'page', + 'page_size', + 'name', + 'search', + 'description', + 'sort' ] _all_params.extend( [ @@ -142,6 +172,24 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 # process the query parameters _query_params = [] + if _params.get('page') is not None: # noqa: E501 + _query_params.append(('page', _params['page'])) + + if _params.get('page_size') is not None: # noqa: E501 + _query_params.append(('page_size', _params['page_size'])) + + if _params.get('name') is not None: # noqa: E501 + _query_params.append(('name', _params['name'])) + + if _params.get('search') is not None: # noqa: E501 + _query_params.append(('search', _params['search'])) + + if _params.get('description') is not None: # noqa: E501 + _query_params.append(('description', _params['description'])) + + if _params.get('sort') is not None: # noqa: E501 + _query_params.append(('sort', _params['sort'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters