diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index cb8b229..f21cdfa 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -12,7 +12,7 @@ docs/AnnotationUpdateAllOf.md docs/AnnotationsApi.md docs/ComposeApi.md docs/Corrector.md -docs/DefaultApi.md +docs/DeleteApi.md docs/Estimator.md docs/GetApi.md docs/MetaAnalysesApi.md @@ -26,6 +26,7 @@ docs/MetaAnalysisReturn.md docs/MetaAnalysisSpecification.md docs/MetaAnalysisStudyset.md docs/NeurostoreAnalysis.md +docs/NeurostoreStudiesApi.md docs/NeurostoreStudy.md docs/NeurostoreStudyList.md docs/NeurostoreStudyReturn.md @@ -63,6 +64,7 @@ docs/StudysetReference.md docs/StudysetReferenceList.md docs/StudysetReferenceReturn.md docs/StudysetReferenceSnapshotsInner.md +docs/StudysetReferencesApi.md docs/StudysetReturn.md docs/StudysetsApi.md docs/User.md @@ -74,14 +76,16 @@ neurosynth_compose_sdk/__init__.py neurosynth_compose_sdk/api/__init__.py neurosynth_compose_sdk/api/annotations_api.py neurosynth_compose_sdk/api/compose_api.py -neurosynth_compose_sdk/api/default_api.py +neurosynth_compose_sdk/api/delete_api.py neurosynth_compose_sdk/api/get_api.py neurosynth_compose_sdk/api/meta_analyses_api.py +neurosynth_compose_sdk/api/neurostore_studies_api.py neurosynth_compose_sdk/api/neurovault_api.py neurosynth_compose_sdk/api/post_api.py neurosynth_compose_sdk/api/projects_api.py neurosynth_compose_sdk/api/put_api.py neurosynth_compose_sdk/api/specifications_api.py +neurosynth_compose_sdk/api/studyset_references_api.py neurosynth_compose_sdk/api/studysets_api.py neurosynth_compose_sdk/api/users_api.py neurosynth_compose_sdk/api_client.py @@ -150,4 +154,7 @@ setup.cfg setup.py test-requirements.txt test/__init__.py +test/test_delete_api.py +test/test_neurostore_studies_api.py +test/test_studyset_references_api.py tox.ini diff --git a/README.md b/README.md index c70b974..f2bbc58 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,7 @@ Class | Method | HTTP request | Description *ComposeApi* | [**annotations_id_put**](docs/ComposeApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation *ComposeApi* | [**annotations_post**](docs/ComposeApi.md#annotations_post) | **POST** /annotations | Create a new Annotation *ComposeApi* | [**meta_analyses_get**](docs/ComposeApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses +*ComposeApi* | [**meta_analyses_id_delete**](docs/ComposeApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | *ComposeApi* | [**meta_analyses_id_get**](docs/ComposeApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information *ComposeApi* | [**meta_analyses_id_put**](docs/ComposeApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis *ComposeApi* | [**meta_analyses_post**](docs/ComposeApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis @@ -101,9 +102,13 @@ Class | Method | HTTP request | Description *ComposeApi* | [**meta_analysis_results_id_get**](docs/ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint *ComposeApi* | [**meta_analysis_results_id_put**](docs/ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | *ComposeApi* | [**meta_analysis_results_post**](docs/ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | +*ComposeApi* | [**neurostore_studies_get**](docs/ComposeApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +*ComposeApi* | [**neurostore_studies_id_get**](docs/ComposeApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +*ComposeApi* | [**neurostore_studies_id_put**](docs/ComposeApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | +*ComposeApi* | [**neurostore_studies_post**](docs/ComposeApi.md#neurostore_studies_post) | **POST** /neurostore-studies | *ComposeApi* | [**neurovault_collections_get**](docs/ComposeApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections *ComposeApi* | [**neurovault_collections_id_get**](docs/ComposeApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint -*ComposeApi* | [**neurovault_collections_id_put**](docs/ComposeApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +*ComposeApi* | [**neurovault_collections_id_put**](docs/ComposeApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference *ComposeApi* | [**neurovault_collections_post**](docs/ComposeApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection *ComposeApi* | [**neurovault_files_get**](docs/ComposeApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint *ComposeApi* | [**neurovault_files_id_get**](docs/ComposeApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint @@ -114,38 +119,40 @@ Class | Method | HTTP request | Description *ComposeApi* | [**projects_id_get**](docs/ComposeApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint *ComposeApi* | [**projects_id_put**](docs/ComposeApi.md#projects_id_put) | **PUT** /projects/{id} | *ComposeApi* | [**projects_post**](docs/ComposeApi.md#projects_post) | **POST** /projects | -*ComposeApi* | [**specifications_get**](docs/ComposeApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications +*ComposeApi* | [**specifications_id_delete**](docs/ComposeApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification *ComposeApi* | [**specifications_id_get**](docs/ComposeApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification *ComposeApi* | [**specifications_id_put**](docs/ComposeApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification -*ComposeApi* | [**specifications_post**](docs/ComposeApi.md#specifications_post) | **POST** /specifications | Create a Specification +*ComposeApi* | [**studyset_references_get**](docs/ComposeApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +*ComposeApi* | [**studyset_references_id_get**](docs/ComposeApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint *ComposeApi* | [**studysets_get**](docs/ComposeApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets *ComposeApi* | [**studysets_id_get**](docs/ComposeApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset *ComposeApi* | [**studysets_id_put**](docs/ComposeApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset *ComposeApi* | [**studysets_post**](docs/ComposeApi.md#studysets_post) | **POST** /studysets | Create a new Studyset -*DefaultApi* | [**meta_analyses_id_delete**](docs/DefaultApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | -*DefaultApi* | [**neurostore_studies_get**](docs/DefaultApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint -*DefaultApi* | [**neurostore_studies_id_get**](docs/DefaultApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint -*DefaultApi* | [**neurostore_studies_id_put**](docs/DefaultApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | -*DefaultApi* | [**neurostore_studies_post**](docs/DefaultApi.md#neurostore_studies_post) | **POST** /neurostore-studies | -*DefaultApi* | [**studyset_references_get**](docs/DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint -*DefaultApi* | [**studyset_references_id_get**](docs/DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint +*DeleteApi* | [**meta_analyses_id_delete**](docs/DeleteApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | +*DeleteApi* | [**projects_id_delete**](docs/DeleteApi.md#projects_id_delete) | **DELETE** /projects/{id} | +*DeleteApi* | [**specifications_id_delete**](docs/DeleteApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification *GetApi* | [**annotations_get**](docs/GetApi.md#annotations_get) | **GET** /annotations | GET a list of annotations *GetApi* | [**annotations_id_get**](docs/GetApi.md#annotations_id_get) | **GET** /annotations/{id} | GET information about an annotation *GetApi* | [**meta_analyses_get**](docs/GetApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses *GetApi* | [**meta_analyses_id_get**](docs/GetApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information *GetApi* | [**meta_analysis_results_get**](docs/GetApi.md#meta_analysis_results_get) | **GET** /meta-analysis-results | Your GET endpoint *GetApi* | [**meta_analysis_results_id_get**](docs/GetApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint +*GetApi* | [**neurostore_studies_get**](docs/GetApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +*GetApi* | [**neurostore_studies_id_get**](docs/GetApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +*GetApi* | [**neurostore_studies_id_put**](docs/GetApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | *GetApi* | [**neurovault_collections_get**](docs/GetApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections *GetApi* | [**neurovault_collections_id_get**](docs/GetApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint *GetApi* | [**neurovault_files_get**](docs/GetApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint *GetApi* | [**neurovault_files_id_get**](docs/GetApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint *GetApi* | [**projects_get**](docs/GetApi.md#projects_get) | **GET** /projects | Your GET endpoint *GetApi* | [**projects_id_get**](docs/GetApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint -*GetApi* | [**specifications_get**](docs/GetApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications *GetApi* | [**specifications_id_get**](docs/GetApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification +*GetApi* | [**studyset_references_get**](docs/GetApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +*GetApi* | [**studyset_references_id_get**](docs/GetApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint *GetApi* | [**studysets_get**](docs/GetApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets *GetApi* | [**studysets_id_get**](docs/GetApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset *MetaAnalysesApi* | [**meta_analyses_get**](docs/MetaAnalysesApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses +*MetaAnalysesApi* | [**meta_analyses_id_delete**](docs/MetaAnalysesApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | *MetaAnalysesApi* | [**meta_analyses_id_get**](docs/MetaAnalysesApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information *MetaAnalysesApi* | [**meta_analyses_id_put**](docs/MetaAnalysesApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis *MetaAnalysesApi* | [**meta_analyses_post**](docs/MetaAnalysesApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis @@ -153,9 +160,13 @@ Class | Method | HTTP request | Description *MetaAnalysesApi* | [**meta_analysis_results_id_get**](docs/MetaAnalysesApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint *MetaAnalysesApi* | [**meta_analysis_results_id_put**](docs/MetaAnalysesApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | *MetaAnalysesApi* | [**meta_analysis_results_post**](docs/MetaAnalysesApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | +*NeurostoreStudiesApi* | [**neurostore_studies_get**](docs/NeurostoreStudiesApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +*NeurostoreStudiesApi* | [**neurostore_studies_id_get**](docs/NeurostoreStudiesApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +*NeurostoreStudiesApi* | [**neurostore_studies_id_put**](docs/NeurostoreStudiesApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | +*NeurostoreStudiesApi* | [**neurostore_studies_post**](docs/NeurostoreStudiesApi.md#neurostore_studies_post) | **POST** /neurostore-studies | *NeurovaultApi* | [**neurovault_collections_get**](docs/NeurovaultApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections *NeurovaultApi* | [**neurovault_collections_id_get**](docs/NeurovaultApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint -*NeurovaultApi* | [**neurovault_collections_id_put**](docs/NeurovaultApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +*NeurovaultApi* | [**neurovault_collections_id_put**](docs/NeurovaultApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference *NeurovaultApi* | [**neurovault_collections_post**](docs/NeurovaultApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection *NeurovaultApi* | [**neurovault_files_get**](docs/NeurovaultApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint *NeurovaultApi* | [**neurovault_files_id_get**](docs/NeurovaultApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint @@ -164,10 +175,10 @@ Class | Method | HTTP request | Description *PostApi* | [**annotations_post**](docs/PostApi.md#annotations_post) | **POST** /annotations | Create a new Annotation *PostApi* | [**meta_analyses_post**](docs/PostApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis *PostApi* | [**meta_analysis_results_post**](docs/PostApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | +*PostApi* | [**neurostore_studies_post**](docs/PostApi.md#neurostore_studies_post) | **POST** /neurostore-studies | *PostApi* | [**neurovault_collections_post**](docs/PostApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection *PostApi* | [**neurovault_files_post**](docs/PostApi.md#neurovault_files_post) | **POST** /neurovault-files | *PostApi* | [**projects_post**](docs/PostApi.md#projects_post) | **POST** /projects | -*PostApi* | [**specifications_post**](docs/PostApi.md#specifications_post) | **POST** /specifications | Create a Specification *PostApi* | [**studysets_post**](docs/PostApi.md#studysets_post) | **POST** /studysets | Create a new Studyset *ProjectsApi* | [**projects_get**](docs/ProjectsApi.md#projects_get) | **GET** /projects | Your GET endpoint *ProjectsApi* | [**projects_id_delete**](docs/ProjectsApi.md#projects_id_delete) | **DELETE** /projects/{id} | @@ -177,15 +188,16 @@ Class | Method | HTTP request | Description *PutApi* | [**annotations_id_put**](docs/PutApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation *PutApi* | [**meta_analyses_id_put**](docs/PutApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis *PutApi* | [**meta_analysis_results_id_put**](docs/PutApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | -*PutApi* | [**neurovault_collections_id_put**](docs/PutApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +*PutApi* | [**neurovault_collections_id_put**](docs/PutApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference *PutApi* | [**neurovault_files_id_put**](docs/PutApi.md#neurovault_files_id_put) | **PUT** /neurovault-files/{id} | *PutApi* | [**projects_id_put**](docs/PutApi.md#projects_id_put) | **PUT** /projects/{id} | *PutApi* | [**specifications_id_put**](docs/PutApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification *PutApi* | [**studysets_id_put**](docs/PutApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset -*SpecificationsApi* | [**specifications_get**](docs/SpecificationsApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications +*SpecificationsApi* | [**specifications_id_delete**](docs/SpecificationsApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification *SpecificationsApi* | [**specifications_id_get**](docs/SpecificationsApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification *SpecificationsApi* | [**specifications_id_put**](docs/SpecificationsApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification -*SpecificationsApi* | [**specifications_post**](docs/SpecificationsApi.md#specifications_post) | **POST** /specifications | Create a Specification +*StudysetReferencesApi* | [**studyset_references_get**](docs/StudysetReferencesApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +*StudysetReferencesApi* | [**studyset_references_id_get**](docs/StudysetReferencesApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint *StudysetsApi* | [**studysets_get**](docs/StudysetsApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets *StudysetsApi* | [**studysets_id_get**](docs/StudysetsApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset *StudysetsApi* | [**studysets_id_put**](docs/StudysetsApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset diff --git a/docs/ComposeApi.md b/docs/ComposeApi.md index 5628af9..896105f 100644 --- a/docs/ComposeApi.md +++ b/docs/ComposeApi.md @@ -9,6 +9,7 @@ Method | HTTP request | Description [**annotations_id_put**](ComposeApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation [**annotations_post**](ComposeApi.md#annotations_post) | **POST** /annotations | Create a new Annotation [**meta_analyses_get**](ComposeApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses +[**meta_analyses_id_delete**](ComposeApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | [**meta_analyses_id_get**](ComposeApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information [**meta_analyses_id_put**](ComposeApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis [**meta_analyses_post**](ComposeApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis @@ -16,9 +17,13 @@ Method | HTTP request | Description [**meta_analysis_results_id_get**](ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint [**meta_analysis_results_id_put**](ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | [**meta_analysis_results_post**](ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | +[**neurostore_studies_get**](ComposeApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +[**neurostore_studies_id_get**](ComposeApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +[**neurostore_studies_id_put**](ComposeApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | +[**neurostore_studies_post**](ComposeApi.md#neurostore_studies_post) | **POST** /neurostore-studies | [**neurovault_collections_get**](ComposeApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections [**neurovault_collections_id_get**](ComposeApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint -[**neurovault_collections_id_put**](ComposeApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +[**neurovault_collections_id_put**](ComposeApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference [**neurovault_collections_post**](ComposeApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection [**neurovault_files_get**](ComposeApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint [**neurovault_files_id_get**](ComposeApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint @@ -29,10 +34,11 @@ Method | HTTP request | Description [**projects_id_get**](ComposeApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint [**projects_id_put**](ComposeApi.md#projects_id_put) | **PUT** /projects/{id} | [**projects_post**](ComposeApi.md#projects_post) | **POST** /projects | -[**specifications_get**](ComposeApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications +[**specifications_id_delete**](ComposeApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification [**specifications_id_get**](ComposeApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification [**specifications_id_put**](ComposeApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification -[**specifications_post**](ComposeApi.md#specifications_post) | **POST** /specifications | Create a Specification +[**studyset_references_get**](ComposeApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +[**studyset_references_id_get**](ComposeApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint [**studysets_get**](ComposeApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets [**studysets_id_get**](ComposeApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset [**studysets_id_put**](ComposeApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset @@ -402,6 +408,77 @@ 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_id_delete** +> meta_analyses_id_delete(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + id = 'id_example' # str | + + try: + # + api_instance.meta_analyses_id_delete(id) + except Exception as e: + print("Exception when calling ComposeApi->meta_analyses_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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_id_get** > MetaAnalysisReturn meta_analyses_id_get(id, nested=nested) @@ -929,6 +1006,274 @@ 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) +# **neurostore_studies_get** +> NeurostoreStudyList neurostore_studies_get() + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_get() + print("The response of ComposeApi->neurostore_studies_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComposeApi->neurostore_studies_get: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NeurostoreStudyList**](NeurostoreStudyList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_get** +> NeurostoreStudyReturn neurostore_studies_id_get(id) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + id = 'id_example' # str | + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_id_get(id) + print("The response of ComposeApi->neurostore_studies_id_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComposeApi->neurostore_studies_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_put** +> NeurostoreStudyReturn neurostore_studies_id_put(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + id = 'id_example' # str | + + try: + # + api_response = api_instance.neurostore_studies_id_put(id) + print("The response of ComposeApi->neurostore_studies_id_put:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComposeApi->neurostore_studies_id_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_post** +> NeurostoreStudyReturn neurostore_studies_post() + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + + try: + # + api_response = api_instance.neurostore_studies_post() + print("The response of ComposeApi->neurostore_studies_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComposeApi->neurostore_studies_post: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + # **neurovault_collections_get** > neurovault_collections_get() @@ -1053,7 +1398,7 @@ No authorization required # **neurovault_collections_id_put** > NeurovaultCollectionReturn neurovault_collections_id_put(id) - +Update Neurovault Collection Reference ### Example @@ -1089,7 +1434,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: id = 'id_example' # str | try: - # + # Update Neurovault Collection Reference api_response = api_instance.neurovault_collections_id_put(id) print("The response of ComposeApi->neurovault_collections_id_put:\n") pprint(api_response) @@ -1844,20 +2189,18 @@ 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) -# **specifications_get** -> SpecificationList specifications_get() +# **specifications_id_delete** +> specifications_id_delete(id) -Get a list of Specifications - -list of meta-analysis specifications +Delete a Specification ### Example +* Bearer Authentication (JSON-Web-Token): ```python import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_list import SpecificationList from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -1867,43 +2210,53 @@ configuration = neurosynth_compose_sdk.Configuration( host = "https://compose.neurosynth.org/api" ) +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + id = 'id_example' # str | try: - # Get a list of Specifications - api_response = api_instance.specifications_get() - print("The response of ComposeApi->specifications_get:\n") - pprint(api_response) + # Delete a Specification + api_instance.specifications_id_delete(id) except Exception as e: - print("Exception when calling ComposeApi->specifications_get: %s\n" % e) + print("Exception when calling ComposeApi->specifications_id_delete: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | ### Return type -[**SpecificationList**](SpecificationList.md) +void (empty response body) ### Authorization -No authorization required +[JSON-Web-Token](../README.md#JSON-Web-Token) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/problem+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | form when a request goes wrong | - | [[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) @@ -2058,22 +2411,20 @@ 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) -# **specifications_post** -> SpecificationReturn specifications_post(specification_post_body=specification_post_body) +# **studyset_references_get** +> StudysetReferenceList studyset_references_get(nested=nested) + +Your GET endpoint -Create a Specification -create a new meta-analysis specification ### Example -* Bearer Authentication (JSON-Web-Token): ```python import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody -from neurosynth_compose_sdk.models.specification_return import SpecificationReturn +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -2083,29 +2434,85 @@ configuration = neurosynth_compose_sdk.Configuration( host = "https://compose.neurosynth.org/api" ) -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. -# Configure Bearer authorization: JSON-Web-Token +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.ComposeApi(api_client) + nested = True # bool | show nested component instead of id (optional) + + try: + # Your GET endpoint + api_response = api_instance.studyset_references_get(nested=nested) + print("The response of ComposeApi->studyset_references_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComposeApi->studyset_references_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nested** | **bool**| show nested component instead of id | [optional] + +### Return type + +[**StudysetReferenceList**](StudysetReferenceList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **studyset_references_id_get** +> StudysetReferenceReturn studyset_references_id_get(id, nested=nested) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. configuration = neurosynth_compose_sdk.Configuration( - access_token = os.environ["BEARER_TOKEN"] + host = "https://compose.neurosynth.org/api" ) + # Enter a context with an instance of the API client with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.ComposeApi(api_client) - specification_post_body = neurosynth_compose_sdk.SpecificationPostBody() # SpecificationPostBody | (optional) + id = 'id_example' # str | + nested = True # bool | show nested component instead of id (optional) try: - # Create a Specification - api_response = api_instance.specifications_post(specification_post_body=specification_post_body) - print("The response of ComposeApi->specifications_post:\n") + # Your GET endpoint + api_response = api_instance.studyset_references_id_get(id, nested=nested) + print("The response of ComposeApi->studyset_references_id_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling ComposeApi->specifications_post: %s\n" % e) + print("Exception when calling ComposeApi->studyset_references_id_get: %s\n" % e) ``` @@ -2113,28 +2520,26 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **specification_post_body** | [**SpecificationPostBody**](SpecificationPostBody.md)| | [optional] + **id** | **str**| | + **nested** | **bool**| show nested component instead of id | [optional] ### Return type -[**SpecificationReturn**](SpecificationReturn.md) +[**StudysetReferenceReturn**](StudysetReferenceReturn.md) ### Authorization -[JSON-Web-Token](../README.md#JSON-Web-Token) +No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json, application/problem+json + - **Content-Type**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | form when a request goes wrong | - | -**422** | Unprocessable Entity (WebDAV) | - | -**500** | form when a request goes wrong | - | [[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) diff --git a/docs/DeleteApi.md b/docs/DeleteApi.md new file mode 100644 index 0000000..ff3ec87 --- /dev/null +++ b/docs/DeleteApi.md @@ -0,0 +1,224 @@ +# neurosynth_compose_sdk.DeleteApi + +All URIs are relative to *https://compose.neurosynth.org/api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**meta_analyses_id_delete**](DeleteApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | +[**projects_id_delete**](DeleteApi.md#projects_id_delete) | **DELETE** /projects/{id} | +[**specifications_id_delete**](DeleteApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification + + +# **meta_analyses_id_delete** +> meta_analyses_id_delete(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.DeleteApi(api_client) + id = 'id_example' # str | + + try: + # + api_instance.meta_analyses_id_delete(id) + except Exception as e: + print("Exception when calling DeleteApi->meta_analyses_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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_id_delete** +> projects_id_delete(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.DeleteApi(api_client) + id = 'id_example' # str | + + try: + # + api_instance.projects_id_delete(id) + except Exception as e: + print("Exception when calling DeleteApi->projects_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **specifications_id_delete** +> specifications_id_delete(id) + +Delete a Specification + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.DeleteApi(api_client) + id = 'id_example' # str | + + try: + # Delete a Specification + api_instance.specifications_id_delete(id) + except Exception as e: + print("Exception when calling DeleteApi->specifications_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + diff --git a/docs/GetApi.md b/docs/GetApi.md index 7adc059..7a65d35 100644 --- a/docs/GetApi.md +++ b/docs/GetApi.md @@ -10,14 +10,18 @@ Method | HTTP request | Description [**meta_analyses_id_get**](GetApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information [**meta_analysis_results_get**](GetApi.md#meta_analysis_results_get) | **GET** /meta-analysis-results | Your GET endpoint [**meta_analysis_results_id_get**](GetApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint +[**neurostore_studies_get**](GetApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +[**neurostore_studies_id_get**](GetApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +[**neurostore_studies_id_put**](GetApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | [**neurovault_collections_get**](GetApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections [**neurovault_collections_id_get**](GetApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint [**neurovault_files_get**](GetApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint [**neurovault_files_id_get**](GetApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint [**projects_get**](GetApi.md#projects_get) | **GET** /projects | Your GET endpoint [**projects_id_get**](GetApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint -[**specifications_get**](GetApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications [**specifications_id_get**](GetApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification +[**studyset_references_get**](GetApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +[**studyset_references_id_get**](GetApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint [**studysets_get**](GetApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets [**studysets_id_get**](GetApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset @@ -420,6 +424,204 @@ 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) +# **neurostore_studies_get** +> NeurostoreStudyList neurostore_studies_get() + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.GetApi(api_client) + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_get() + print("The response of GetApi->neurostore_studies_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GetApi->neurostore_studies_get: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NeurostoreStudyList**](NeurostoreStudyList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_get** +> NeurostoreStudyReturn neurostore_studies_id_get(id) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.GetApi(api_client) + id = 'id_example' # str | + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_id_get(id) + print("The response of GetApi->neurostore_studies_id_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GetApi->neurostore_studies_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_put** +> NeurostoreStudyReturn neurostore_studies_id_put(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.GetApi(api_client) + id = 'id_example' # str | + + try: + # + api_response = api_instance.neurostore_studies_id_put(id) + print("The response of GetApi->neurostore_studies_id_put:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GetApi->neurostore_studies_id_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + # **neurovault_collections_get** > neurovault_collections_get() @@ -801,12 +1003,12 @@ 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) -# **specifications_get** -> SpecificationList specifications_get() +# **specifications_id_get** +> SpecificationReturn specifications_id_get(id) -Get a list of Specifications +Get information about a Specification -list of meta-analysis specifications +get a meta-analysis specification ### Example @@ -814,7 +1016,7 @@ list of meta-analysis specifications import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_list import SpecificationList +from neurosynth_compose_sdk.models.specification_return import SpecificationReturn from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -829,23 +1031,27 @@ 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) + id = 'id_example' # str | try: - # Get a list of Specifications - api_response = api_instance.specifications_get() - print("The response of GetApi->specifications_get:\n") + # Get information about a Specification + api_response = api_instance.specifications_id_get(id) + print("The response of GetApi->specifications_id_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling GetApi->specifications_get: %s\n" % e) + print("Exception when calling GetApi->specifications_id_get: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | ### Return type -[**SpecificationList**](SpecificationList.md) +[**SpecificationReturn**](SpecificationReturn.md) ### Authorization @@ -860,16 +1066,17 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | form when a request goes wrong | - | +**401** | form when a request goes wrong | - | +**404** | form when a request goes wrong | - | [[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) -# **specifications_id_get** -> SpecificationReturn specifications_id_get(id) +# **studyset_references_get** +> StudysetReferenceList studyset_references_get(nested=nested) + +Your GET endpoint -Get information about a Specification -get a meta-analysis specification ### Example @@ -877,7 +1084,71 @@ get a meta-analysis specification import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_return import SpecificationReturn +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.GetApi(api_client) + nested = True # bool | show nested component instead of id (optional) + + try: + # Your GET endpoint + api_response = api_instance.studyset_references_get(nested=nested) + print("The response of GetApi->studyset_references_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GetApi->studyset_references_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nested** | **bool**| show nested component instead of id | [optional] + +### Return type + +[**StudysetReferenceList**](StudysetReferenceList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **studyset_references_id_get** +> StudysetReferenceReturn studyset_references_id_get(id, nested=nested) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -893,14 +1164,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.GetApi(api_client) id = 'id_example' # str | + nested = True # bool | show nested component instead of id (optional) try: - # Get information about a Specification - api_response = api_instance.specifications_id_get(id) - print("The response of GetApi->specifications_id_get:\n") + # Your GET endpoint + api_response = api_instance.studyset_references_id_get(id, nested=nested) + print("The response of GetApi->studyset_references_id_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling GetApi->specifications_id_get: %s\n" % e) + print("Exception when calling GetApi->studyset_references_id_get: %s\n" % e) ``` @@ -909,10 +1181,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | + **nested** | **bool**| show nested component instead of id | [optional] ### Return type -[**SpecificationReturn**](SpecificationReturn.md) +[**StudysetReferenceReturn**](StudysetReferenceReturn.md) ### Authorization @@ -921,14 +1194,12 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/problem+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**401** | form when a request goes wrong | - | -**404** | form when a request goes wrong | - | [[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) diff --git a/docs/MetaAnalysesApi.md b/docs/MetaAnalysesApi.md index 6f1d343..977fb6a 100644 --- a/docs/MetaAnalysesApi.md +++ b/docs/MetaAnalysesApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://compose.neurosynth.org/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**meta_analyses_get**](MetaAnalysesApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses +[**meta_analyses_id_delete**](MetaAnalysesApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} | [**meta_analyses_id_get**](MetaAnalysesApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information [**meta_analyses_id_put**](MetaAnalysesApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis [**meta_analyses_post**](MetaAnalysesApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis @@ -83,6 +84,77 @@ 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_id_delete** +> meta_analyses_id_delete(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.MetaAnalysesApi(api_client) + id = 'id_example' # str | + + try: + # + api_instance.meta_analyses_id_delete(id) + except Exception as e: + print("Exception when calling MetaAnalysesApi->meta_analyses_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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_id_get** > MetaAnalysisReturn meta_analyses_id_get(id, nested=nested) diff --git a/docs/NeurostoreStudiesApi.md b/docs/NeurostoreStudiesApi.md new file mode 100644 index 0000000..055ca8e --- /dev/null +++ b/docs/NeurostoreStudiesApi.md @@ -0,0 +1,280 @@ +# neurosynth_compose_sdk.NeurostoreStudiesApi + +All URIs are relative to *https://compose.neurosynth.org/api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**neurostore_studies_get**](NeurostoreStudiesApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint +[**neurostore_studies_id_get**](NeurostoreStudiesApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint +[**neurostore_studies_id_put**](NeurostoreStudiesApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} | +[**neurostore_studies_post**](NeurostoreStudiesApi.md#neurostore_studies_post) | **POST** /neurostore-studies | + + +# **neurostore_studies_get** +> NeurostoreStudyList neurostore_studies_get() + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.NeurostoreStudiesApi(api_client) + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_get() + print("The response of NeurostoreStudiesApi->neurostore_studies_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NeurostoreStudiesApi->neurostore_studies_get: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NeurostoreStudyList**](NeurostoreStudyList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_get** +> NeurostoreStudyReturn neurostore_studies_id_get(id) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.NeurostoreStudiesApi(api_client) + id = 'id_example' # str | + + try: + # Your GET endpoint + api_response = api_instance.neurostore_studies_id_get(id) + print("The response of NeurostoreStudiesApi->neurostore_studies_id_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NeurostoreStudiesApi->neurostore_studies_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_id_put** +> NeurostoreStudyReturn neurostore_studies_id_put(id) + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.NeurostoreStudiesApi(api_client) + id = 'id_example' # str | + + try: + # + api_response = api_instance.neurostore_studies_id_put(id) + print("The response of NeurostoreStudiesApi->neurostore_studies_id_put:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NeurostoreStudiesApi->neurostore_studies_id_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **neurostore_studies_post** +> NeurostoreStudyReturn neurostore_studies_post() + + + +### Example + +* Bearer Authentication (JSON-Web-Token): +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.NeurostoreStudiesApi(api_client) + + try: + # + api_response = api_instance.neurostore_studies_post() + print("The response of NeurostoreStudiesApi->neurostore_studies_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NeurostoreStudiesApi->neurostore_studies_post: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) + +### Authorization + +[JSON-Web-Token](../README.md#JSON-Web-Token) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + diff --git a/docs/NeurovaultApi.md b/docs/NeurovaultApi.md index 5603803..746082f 100644 --- a/docs/NeurovaultApi.md +++ b/docs/NeurovaultApi.md @@ -6,7 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**neurovault_collections_get**](NeurovaultApi.md#neurovault_collections_get) | **GET** /neurovault-collections | Get neurovault collections [**neurovault_collections_id_get**](NeurovaultApi.md#neurovault_collections_id_get) | **GET** /neurovault-collections/{id} | Your GET endpoint -[**neurovault_collections_id_put**](NeurovaultApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +[**neurovault_collections_id_put**](NeurovaultApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference [**neurovault_collections_post**](NeurovaultApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection [**neurovault_files_get**](NeurovaultApi.md#neurovault_files_get) | **GET** /neurovault-files | Your GET endpoint [**neurovault_files_id_get**](NeurovaultApi.md#neurovault_files_id_get) | **GET** /neurovault-files/{id} | Your GET endpoint @@ -138,7 +138,7 @@ No authorization required # **neurovault_collections_id_put** > NeurovaultCollectionReturn neurovault_collections_id_put(id) - +Update Neurovault Collection Reference ### Example @@ -174,7 +174,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: id = 'id_example' # str | try: - # + # Update Neurovault Collection Reference api_response = api_instance.neurovault_collections_id_put(id) print("The response of NeurovaultApi->neurovault_collections_id_put:\n") pprint(api_response) diff --git a/docs/PostApi.md b/docs/PostApi.md index 3794ef1..7ab4072 100644 --- a/docs/PostApi.md +++ b/docs/PostApi.md @@ -7,10 +7,10 @@ Method | HTTP request | Description [**annotations_post**](PostApi.md#annotations_post) | **POST** /annotations | Create a new Annotation [**meta_analyses_post**](PostApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis [**meta_analysis_results_post**](PostApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results | +[**neurostore_studies_post**](PostApi.md#neurostore_studies_post) | **POST** /neurostore-studies | [**neurovault_collections_post**](PostApi.md#neurovault_collections_post) | **POST** /neurovault-collections | Create neurovault collection [**neurovault_files_post**](PostApi.md#neurovault_files_post) | **POST** /neurovault-files | [**projects_post**](PostApi.md#projects_post) | **POST** /projects | -[**specifications_post**](PostApi.md#specifications_post) | **POST** /specifications | Create a Specification [**studysets_post**](PostApi.md#studysets_post) | **POST** /studysets | Create a new Studyset @@ -256,10 +256,8 @@ 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) -# **neurovault_collections_post** -> neurovault_collections_post(neurovault_collection=neurovault_collection) - -Create neurovault collection +# **neurostore_studies_post** +> NeurostoreStudyReturn neurostore_studies_post() @@ -270,7 +268,7 @@ Create neurovault collection import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.neurovault_collection import NeurovaultCollection +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -294,25 +292,23 @@ 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.PostApi(api_client) - neurovault_collection = neurosynth_compose_sdk.NeurovaultCollection() # NeurovaultCollection | (optional) try: - # Create neurovault collection - api_instance.neurovault_collections_post(neurovault_collection=neurovault_collection) + # + api_response = api_instance.neurostore_studies_post() + print("The response of PostApi->neurostore_studies_post:\n") + pprint(api_response) except Exception as e: - print("Exception when calling PostApi->neurovault_collections_post: %s\n" % e) + print("Exception when calling PostApi->neurostore_studies_post: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **neurovault_collection** | [**NeurovaultCollection**](NeurovaultCollection.md)| | [optional] +This endpoint does not need any parameter. ### Return type -void (empty response body) +[**NeurostoreStudyReturn**](NeurostoreStudyReturn.md) ### Authorization @@ -320,8 +316,8 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined + - **Content-Type**: multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | @@ -330,8 +326,10 @@ void (empty response body) [[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) -# **neurovault_files_post** -> NeurovaultFileReturn neurovault_files_post(neurovault_file=neurovault_file) +# **neurovault_collections_post** +> neurovault_collections_post(neurovault_collection=neurovault_collection) + +Create neurovault collection @@ -342,8 +340,7 @@ void (empty response body) import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.neurovault_file import NeurovaultFile -from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn +from neurosynth_compose_sdk.models.neurovault_collection import NeurovaultCollection from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -367,15 +364,13 @@ 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.PostApi(api_client) - neurovault_file = neurosynth_compose_sdk.NeurovaultFile() # NeurovaultFile | (optional) + neurovault_collection = neurosynth_compose_sdk.NeurovaultCollection() # NeurovaultCollection | (optional) try: - # - api_response = api_instance.neurovault_files_post(neurovault_file=neurovault_file) - print("The response of PostApi->neurovault_files_post:\n") - pprint(api_response) + # Create neurovault collection + api_instance.neurovault_collections_post(neurovault_collection=neurovault_collection) except Exception as e: - print("Exception when calling PostApi->neurovault_files_post: %s\n" % e) + print("Exception when calling PostApi->neurovault_collections_post: %s\n" % e) ``` @@ -383,11 +378,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **neurovault_file** | [**NeurovaultFile**](NeurovaultFile.md)| | [optional] + **neurovault_collection** | [**NeurovaultCollection**](NeurovaultCollection.md)| | [optional] ### Return type -[**NeurovaultFileReturn**](NeurovaultFileReturn.md) +void (empty response body) ### Authorization @@ -396,7 +391,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | @@ -405,8 +400,8 @@ 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_post** -> ProjectReturn projects_post(project=project) +# **neurovault_files_post** +> NeurovaultFileReturn neurovault_files_post(neurovault_file=neurovault_file) @@ -417,8 +412,8 @@ Name | Type | Description | Notes import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.project import Project -from neurosynth_compose_sdk.models.project_return import ProjectReturn +from neurosynth_compose_sdk.models.neurovault_file import NeurovaultFile +from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -442,15 +437,15 @@ 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.PostApi(api_client) - project = neurosynth_compose_sdk.Project() # Project | (optional) + neurovault_file = neurosynth_compose_sdk.NeurovaultFile() # NeurovaultFile | (optional) try: # - api_response = api_instance.projects_post(project=project) - print("The response of PostApi->projects_post:\n") + api_response = api_instance.neurovault_files_post(neurovault_file=neurovault_file) + print("The response of PostApi->neurovault_files_post:\n") pprint(api_response) except Exception as e: - print("Exception when calling PostApi->projects_post: %s\n" % e) + print("Exception when calling PostApi->neurovault_files_post: %s\n" % e) ``` @@ -458,11 +453,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **project** | [**Project**](Project.md)| | [optional] + **neurovault_file** | [**NeurovaultFile**](NeurovaultFile.md)| | [optional] ### Return type -[**ProjectReturn**](ProjectReturn.md) +[**NeurovaultFileReturn**](NeurovaultFileReturn.md) ### Authorization @@ -480,12 +475,10 @@ 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) -# **specifications_post** -> SpecificationReturn specifications_post(specification_post_body=specification_post_body) +# **projects_post** +> ProjectReturn projects_post(project=project) -Create a Specification -create a new meta-analysis specification ### Example @@ -494,8 +487,8 @@ create a new meta-analysis specification import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody -from neurosynth_compose_sdk.models.specification_return import SpecificationReturn +from neurosynth_compose_sdk.models.project import Project +from neurosynth_compose_sdk.models.project_return import ProjectReturn from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -519,15 +512,15 @@ 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.PostApi(api_client) - specification_post_body = neurosynth_compose_sdk.SpecificationPostBody() # SpecificationPostBody | (optional) + project = neurosynth_compose_sdk.Project() # Project | (optional) try: - # Create a Specification - api_response = api_instance.specifications_post(specification_post_body=specification_post_body) - print("The response of PostApi->specifications_post:\n") + # + api_response = api_instance.projects_post(project=project) + print("The response of PostApi->projects_post:\n") pprint(api_response) except Exception as e: - print("Exception when calling PostApi->specifications_post: %s\n" % e) + print("Exception when calling PostApi->projects_post: %s\n" % e) ``` @@ -535,11 +528,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **specification_post_body** | [**SpecificationPostBody**](SpecificationPostBody.md)| | [optional] + **project** | [**Project**](Project.md)| | [optional] ### Return type -[**SpecificationReturn**](SpecificationReturn.md) +[**ProjectReturn**](ProjectReturn.md) ### Authorization @@ -548,15 +541,12 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json, application/problem+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | form when a request goes wrong | - | -**422** | Unprocessable Entity (WebDAV) | - | -**500** | form when a request goes wrong | - | [[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) diff --git a/docs/PutApi.md b/docs/PutApi.md index 927ae2d..537b662 100644 --- a/docs/PutApi.md +++ b/docs/PutApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**annotations_id_put**](PutApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation [**meta_analyses_id_put**](PutApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis [**meta_analysis_results_id_put**](PutApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} | -[**neurovault_collections_id_put**](PutApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | +[**neurovault_collections_id_put**](PutApi.md#neurovault_collections_id_put) | **PUT** /neurovault-collections/{id} | Update Neurovault Collection Reference [**neurovault_files_id_put**](PutApi.md#neurovault_files_id_put) | **PUT** /neurovault-files/{id} | [**projects_id_put**](PutApi.md#projects_id_put) | **PUT** /projects/{id} | [**specifications_id_put**](PutApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification @@ -267,7 +267,7 @@ Name | Type | Description | Notes # **neurovault_collections_id_put** > NeurovaultCollectionReturn neurovault_collections_id_put(id) - +Update Neurovault Collection Reference ### Example @@ -303,7 +303,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client: id = 'id_example' # str | try: - # + # Update Neurovault Collection Reference api_response = api_instance.neurovault_collections_id_put(id) print("The response of PutApi->neurovault_collections_id_put:\n") pprint(api_response) diff --git a/docs/SpecificationsApi.md b/docs/SpecificationsApi.md index e102f7e..a209f80 100644 --- a/docs/SpecificationsApi.md +++ b/docs/SpecificationsApi.md @@ -4,26 +4,23 @@ All URIs are relative to *https://compose.neurosynth.org/api* Method | HTTP request | Description ------------- | ------------- | ------------- -[**specifications_get**](SpecificationsApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications +[**specifications_id_delete**](SpecificationsApi.md#specifications_id_delete) | **DELETE** /specifications/{id} | Delete a Specification [**specifications_id_get**](SpecificationsApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification [**specifications_id_put**](SpecificationsApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification -[**specifications_post**](SpecificationsApi.md#specifications_post) | **POST** /specifications | Create a Specification -# **specifications_get** -> SpecificationList specifications_get() +# **specifications_id_delete** +> specifications_id_delete(id) -Get a list of Specifications - -list of meta-analysis specifications +Delete a Specification ### Example +* Bearer Authentication (JSON-Web-Token): ```python import time import os import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_list import SpecificationList from neurosynth_compose_sdk.rest import ApiException from pprint import pprint @@ -33,43 +30,53 @@ configuration = neurosynth_compose_sdk.Configuration( host = "https://compose.neurosynth.org/api" ) +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization: JSON-Web-Token +configuration = neurosynth_compose_sdk.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with neurosynth_compose_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = neurosynth_compose_sdk.SpecificationsApi(api_client) + id = 'id_example' # str | try: - # Get a list of Specifications - api_response = api_instance.specifications_get() - print("The response of SpecificationsApi->specifications_get:\n") - pprint(api_response) + # Delete a Specification + api_instance.specifications_id_delete(id) except Exception as e: - print("Exception when calling SpecificationsApi->specifications_get: %s\n" % e) + print("Exception when calling SpecificationsApi->specifications_id_delete: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | ### Return type -[**SpecificationList**](SpecificationList.md) +void (empty response body) ### Authorization -No authorization required +[JSON-Web-Token](../README.md#JSON-Web-Token) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/problem+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | form when a request goes wrong | - | [[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) @@ -224,83 +231,3 @@ 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) -# **specifications_post** -> SpecificationReturn specifications_post(specification_post_body=specification_post_body) - -Create a Specification - -create a new meta-analysis specification - -### Example - -* Bearer Authentication (JSON-Web-Token): -```python -import time -import os -import neurosynth_compose_sdk -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody -from neurosynth_compose_sdk.models.specification_return import SpecificationReturn -from neurosynth_compose_sdk.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://compose.neurosynth.org/api -# See configuration.py for a list of all supported configuration parameters. -configuration = neurosynth_compose_sdk.Configuration( - host = "https://compose.neurosynth.org/api" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization: JSON-Web-Token -configuration = neurosynth_compose_sdk.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -with neurosynth_compose_sdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = neurosynth_compose_sdk.SpecificationsApi(api_client) - specification_post_body = neurosynth_compose_sdk.SpecificationPostBody() # SpecificationPostBody | (optional) - - try: - # Create a Specification - api_response = api_instance.specifications_post(specification_post_body=specification_post_body) - print("The response of SpecificationsApi->specifications_post:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SpecificationsApi->specifications_post: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **specification_post_body** | [**SpecificationPostBody**](SpecificationPostBody.md)| | [optional] - -### Return type - -[**SpecificationReturn**](SpecificationReturn.md) - -### Authorization - -[JSON-Web-Token](../README.md#JSON-Web-Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/problem+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | form when a request goes wrong | - | -**422** | Unprocessable Entity (WebDAV) | - | -**500** | form when a request goes wrong | - | - -[[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) - diff --git a/docs/StudysetReferencesApi.md b/docs/StudysetReferencesApi.md new file mode 100644 index 0000000..c3ec2db --- /dev/null +++ b/docs/StudysetReferencesApi.md @@ -0,0 +1,142 @@ +# neurosynth_compose_sdk.StudysetReferencesApi + +All URIs are relative to *https://compose.neurosynth.org/api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**studyset_references_get**](StudysetReferencesApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint +[**studyset_references_id_get**](StudysetReferencesApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint + + +# **studyset_references_get** +> StudysetReferenceList studyset_references_get(nested=nested) + +Your GET endpoint + + + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.StudysetReferencesApi(api_client) + nested = True # bool | show nested component instead of id (optional) + + try: + # Your GET endpoint + api_response = api_instance.studyset_references_get(nested=nested) + print("The response of StudysetReferencesApi->studyset_references_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling StudysetReferencesApi->studyset_references_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nested** | **bool**| show nested component instead of id | [optional] + +### Return type + +[**StudysetReferenceList**](StudysetReferenceList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **studyset_references_id_get** +> StudysetReferenceReturn studyset_references_id_get(id, nested=nested) + +Your GET endpoint + +### Example + +```python +import time +import os +import neurosynth_compose_sdk +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn +from neurosynth_compose_sdk.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://compose.neurosynth.org/api +# See configuration.py for a list of all supported configuration parameters. +configuration = neurosynth_compose_sdk.Configuration( + host = "https://compose.neurosynth.org/api" +) + + +# Enter a context with an instance of the API client +with neurosynth_compose_sdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = neurosynth_compose_sdk.StudysetReferencesApi(api_client) + id = 'id_example' # str | + nested = True # bool | show nested component instead of id (optional) + + try: + # Your GET endpoint + api_response = api_instance.studyset_references_id_get(id, nested=nested) + print("The response of StudysetReferencesApi->studyset_references_id_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling StudysetReferencesApi->studyset_references_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **nested** | **bool**| show nested component instead of id | [optional] + +### Return type + +[**StudysetReferenceReturn**](StudysetReferenceReturn.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + diff --git a/neurosynth_compose_sdk/__init__.py b/neurosynth_compose_sdk/__init__.py index e89455f..3dbe9cf 100644 --- a/neurosynth_compose_sdk/__init__.py +++ b/neurosynth_compose_sdk/__init__.py @@ -20,14 +20,16 @@ # import apis into sdk package from neurosynth_compose_sdk.api.annotations_api import AnnotationsApi from neurosynth_compose_sdk.api.compose_api import ComposeApi -from neurosynth_compose_sdk.api.default_api import DefaultApi +from neurosynth_compose_sdk.api.delete_api import DeleteApi from neurosynth_compose_sdk.api.get_api import GetApi from neurosynth_compose_sdk.api.meta_analyses_api import MetaAnalysesApi +from neurosynth_compose_sdk.api.neurostore_studies_api import NeurostoreStudiesApi from neurosynth_compose_sdk.api.neurovault_api import NeurovaultApi from neurosynth_compose_sdk.api.post_api import PostApi from neurosynth_compose_sdk.api.projects_api import ProjectsApi from neurosynth_compose_sdk.api.put_api import PutApi from neurosynth_compose_sdk.api.specifications_api import SpecificationsApi +from neurosynth_compose_sdk.api.studyset_references_api import StudysetReferencesApi from neurosynth_compose_sdk.api.studysets_api import StudysetsApi from neurosynth_compose_sdk.api.users_api import UsersApi diff --git a/neurosynth_compose_sdk/api/__init__.py b/neurosynth_compose_sdk/api/__init__.py index e0ad6ec..ce3b6f5 100644 --- a/neurosynth_compose_sdk/api/__init__.py +++ b/neurosynth_compose_sdk/api/__init__.py @@ -3,14 +3,16 @@ # import apis into api package from neurosynth_compose_sdk.api.annotations_api import AnnotationsApi from neurosynth_compose_sdk.api.compose_api import ComposeApi -from neurosynth_compose_sdk.api.default_api import DefaultApi +from neurosynth_compose_sdk.api.delete_api import DeleteApi from neurosynth_compose_sdk.api.get_api import GetApi from neurosynth_compose_sdk.api.meta_analyses_api import MetaAnalysesApi +from neurosynth_compose_sdk.api.neurostore_studies_api import NeurostoreStudiesApi from neurosynth_compose_sdk.api.neurovault_api import NeurovaultApi from neurosynth_compose_sdk.api.post_api import PostApi from neurosynth_compose_sdk.api.projects_api import ProjectsApi from neurosynth_compose_sdk.api.put_api import PutApi from neurosynth_compose_sdk.api.specifications_api import SpecificationsApi +from neurosynth_compose_sdk.api.studyset_references_api import StudysetReferencesApi from neurosynth_compose_sdk.api.studysets_api import StudysetsApi from neurosynth_compose_sdk.api.users_api import UsersApi diff --git a/neurosynth_compose_sdk/api/compose_api.py b/neurosynth_compose_sdk/api/compose_api.py index 3f73161..487bfa9 100644 --- a/neurosynth_compose_sdk/api/compose_api.py +++ b/neurosynth_compose_sdk/api/compose_api.py @@ -32,6 +32,8 @@ from neurosynth_compose_sdk.models.meta_analysis_list import MetaAnalysisList from neurosynth_compose_sdk.models.meta_analysis_post_body import MetaAnalysisPostBody from neurosynth_compose_sdk.models.meta_analysis_return import MetaAnalysisReturn +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn from neurosynth_compose_sdk.models.neurovault_collection import NeurovaultCollection from neurosynth_compose_sdk.models.neurovault_collection_return import NeurovaultCollectionReturn from neurosynth_compose_sdk.models.neurovault_file import NeurovaultFile @@ -45,12 +47,12 @@ from neurosynth_compose_sdk.models.result_list import ResultList from neurosynth_compose_sdk.models.result_return import ResultReturn from neurosynth_compose_sdk.models.specification import Specification -from neurosynth_compose_sdk.models.specification_list import SpecificationList -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody from neurosynth_compose_sdk.models.specification_return import SpecificationReturn from neurosynth_compose_sdk.models.studyset import Studyset from neurosynth_compose_sdk.models.studyset_list import StudysetList from neurosynth_compose_sdk.models.studyset_post_body import StudysetPostBody +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn from neurosynth_compose_sdk.models.studyset_return import StudysetReturn from neurosynth_compose_sdk.api_client import ApiClient @@ -802,6 +804,137 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def meta_analyses_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analyses_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analyses_id_delete_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analyses_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analyses_id_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/meta-analyses/{id}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def meta_analyses_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> MetaAnalysisReturn: # noqa: E501 """GET meta-analysis information # noqa: E501 @@ -1283,21 +1416,587 @@ def meta_analysis_results_get(self, meta_analysis_id : Annotated[Optional[Strict """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the meta_analysis_results_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analysis_results_get_with_http_info(meta_analysis_id, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the meta_analysis_results_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analysis_results_get_with_http_info(meta_analysis_id, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[Optional[StrictStr], Field(description="search for results with this meta-analysis id")] = 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.meta_analysis_results_get_with_http_info(meta_analysis_id, async_req=True) + >>> result = thread.get() + + :param meta_analysis_id: search for results with this meta-analysis id + :type meta_analysis_id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(ResultList, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'meta_analysis_id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analysis_results_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('meta_analysis_id') is not None: # noqa: E501 + _query_params.append(('meta_analysis_id', _params['meta_analysis_id'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "ResultList", + } + + return self.api_client.call_api( + '/meta-analysis-results', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def meta_analysis_results_id_get(self, id : StrictStr, **kwargs) -> ResultReturn: # 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.meta_analysis_results_id_get(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: ResultReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analysis_results_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analysis_results_id_get_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **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.meta_analysis_results_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analysis_results_id_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "ResultReturn", + } + + return self.api_client.call_api( + '/meta-analysis-results/{id}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def meta_analysis_results_id_put(self, id : StrictStr, result : Optional[Result] = None, **kwargs) -> ResultReturn: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analysis_results_id_put(id, result, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param result: + :type result: Result + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: ResultReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analysis_results_id_put_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analysis_results_id_put_with_http_info(id, result, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : Optional[Result] = None, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analysis_results_id_put_with_http_info(id, result, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param result: + :type result: Result + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id', + 'result' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analysis_results_id_put" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['result'] is not None: + _body_params = _params['result'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json', 'multipart/form-data'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['JSON-Web-Token', 'upload_key'] # noqa: E501 + + _response_types_map = { + '200': "ResultReturn", + } + + return self.api_client.call_api( + '/meta-analysis-results/{id}', 'PUT', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def meta_analysis_results_post(self, result_init : Optional[ResultInit] = None, **kwargs) -> ResultReturn: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analysis_results_post(result_init, async_req=True) + >>> result = thread.get() + + :param result_init: + :type result_init: ResultInit + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: ResultReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analysis_results_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analysis_results_post_with_http_info(result_init, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analysis_results_post_with_http_info(self, result_init : Optional[ResultInit] = None, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analysis_results_post_with_http_info(result_init, async_req=True) + >>> result = thread.get() + + :param result_init: + :type result_init: ResultInit + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'result_init' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analysis_results_post" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + if _params['result_init'] is not None: + _body_params = _params['result_init'] + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['application/json'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['JSON-Web-Token', 'upload_key'] # noqa: E501 + + _response_types_map = { + '200': "ResultReturn", + } + + return self.api_client.call_api( + '/meta-analysis-results', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_get(self, **kwargs) -> NeurostoreStudyList: # 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.neurostore_studies_get(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyList + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_get_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[Optional[StrictStr], Field(description="search for results with this meta-analysis id")] = None, **kwargs) -> ApiResponse: # noqa: E501 + def neurostore_studies_get_with_http_info(self, **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.meta_analysis_results_get_with_http_info(meta_analysis_id, async_req=True) + >>> thread = api.neurostore_studies_get_with_http_info(async_req=True) >>> result = thread.get() - :param meta_analysis_id: search for results with this meta-analysis id - :type meta_analysis_id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1320,13 +2019,12 @@ def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[ :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ResultList, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(NeurostoreStudyList, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'meta_analysis_id' ] _all_params.extend( [ @@ -1345,7 +2043,7 @@ def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[ if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method meta_analysis_results_get" % _key + " to method neurostore_studies_get" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1357,9 +2055,6 @@ def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[ # process the query parameters _query_params = [] - if _params.get('meta_analysis_id') is not None: # noqa: E501 - _query_params.append(('meta_analysis_id', _params['meta_analysis_id'])) - # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -1375,11 +2070,11 @@ def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[ _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "ResultList", + '200': "NeurostoreStudyList", } return self.api_client.call_api( - '/meta-analysis-results', 'GET', + '/neurostore-studies', 'GET', _path_params, _query_params, _header_params, @@ -1396,13 +2091,13 @@ def meta_analysis_results_get_with_http_info(self, meta_analysis_id : Annotated[ _request_auth=_params.get('_request_auth')) @validate_arguments - def meta_analysis_results_id_get(self, id : StrictStr, **kwargs) -> ResultReturn: # noqa: E501 + def neurostore_studies_id_get(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # 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.meta_analysis_results_id_get(id, async_req=True) + >>> thread = api.neurostore_studies_id_get(id, async_req=True) >>> result = thread.get() :param id: (required) @@ -1416,21 +2111,21 @@ def meta_analysis_results_id_get(self, id : StrictStr, **kwargs) -> ResultReturn :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: ResultReturn + :rtype: NeurostoreStudyReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the meta_analysis_results_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analysis_results_id_get_with_http_info(id, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurostore_studies_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_get_with_http_info(id, **kwargs) # noqa: E501 @validate_arguments - def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + def neurostore_studies_id_get_with_http_info(self, id : StrictStr, **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.meta_analysis_results_id_get_with_http_info(id, async_req=True) + >>> thread = api.neurostore_studies_id_get_with_http_info(id, async_req=True) >>> result = thread.get() :param id: (required) @@ -1457,7 +2152,7 @@ def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() @@ -1482,7 +2177,7 @@ def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method meta_analysis_results_id_get" % _key + " to method neurostore_studies_id_get" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1512,11 +2207,11 @@ def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "ResultReturn", + '200': "NeurostoreStudyReturn", } return self.api_client.call_api( - '/meta-analysis-results/{id}', 'GET', + '/neurostore-studies/{id}', 'GET', _path_params, _query_params, _header_params, @@ -1533,19 +2228,17 @@ def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) _request_auth=_params.get('_request_auth')) @validate_arguments - def meta_analysis_results_id_put(self, id : StrictStr, result : Optional[Result] = None, **kwargs) -> ResultReturn: # noqa: E501 + def neurostore_studies_id_put(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analysis_results_id_put(id, result, async_req=True) + >>> thread = api.neurostore_studies_id_put(id, async_req=True) >>> result = thread.get() :param id: (required) :type id: str - :param result: - :type result: Result :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -1555,27 +2248,25 @@ def meta_analysis_results_id_put(self, id : StrictStr, result : Optional[Result] :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: ResultReturn + :rtype: NeurostoreStudyReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the meta_analysis_results_id_put_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analysis_results_id_put_with_http_info(id, result, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurostore_studies_id_put_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_put_with_http_info(id, **kwargs) # noqa: E501 @validate_arguments - def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : Optional[Result] = None, **kwargs) -> ApiResponse: # noqa: E501 + def neurostore_studies_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analysis_results_id_put_with_http_info(id, result, async_req=True) + >>> thread = api.neurostore_studies_id_put_with_http_info(id, async_req=True) >>> result = thread.get() :param id: (required) :type id: str - :param result: - :type result: Result :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1598,14 +2289,13 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'id', - 'result' + 'id' ] _all_params.extend( [ @@ -1624,7 +2314,7 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method meta_analysis_results_id_put" % _key + " to method neurostore_studies_id_put" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1646,9 +2336,6 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O _files = {} # process the body parameter _body_params = None - if _params['result'] is not None: - _body_params = _params['result'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -1656,19 +2343,19 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', self.api_client.select_header_content_type( - ['application/json', 'multipart/form-data'])) + ['multipart/form-data'])) if _content_types_list: _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['JSON-Web-Token', 'upload_key'] # noqa: E501 + _auth_settings = ['JSON-Web-Token'] # noqa: E501 _response_types_map = { - '200': "ResultReturn", + '200': "NeurostoreStudyReturn", } return self.api_client.call_api( - '/meta-analysis-results/{id}', 'PUT', + '/neurostore-studies/{id}', 'PUT', _path_params, _query_params, _header_params, @@ -1685,17 +2372,15 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O _request_auth=_params.get('_request_auth')) @validate_arguments - def meta_analysis_results_post(self, result_init : Optional[ResultInit] = None, **kwargs) -> ResultReturn: # noqa: E501 + def neurostore_studies_post(self, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analysis_results_post(result_init, async_req=True) + >>> thread = api.neurostore_studies_post(async_req=True) >>> result = thread.get() - :param result_init: - :type result_init: ResultInit :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -1705,25 +2390,23 @@ def meta_analysis_results_post(self, result_init : Optional[ResultInit] = None, :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: ResultReturn + :rtype: NeurostoreStudyReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the meta_analysis_results_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.meta_analysis_results_post_with_http_info(result_init, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurostore_studies_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_post_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def meta_analysis_results_post_with_http_info(self, result_init : Optional[ResultInit] = None, **kwargs) -> ApiResponse: # noqa: E501 + def neurostore_studies_post_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.meta_analysis_results_post_with_http_info(result_init, async_req=True) + >>> thread = api.neurostore_studies_post_with_http_info(async_req=True) >>> result = thread.get() - :param result_init: - :type result_init: ResultInit :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1746,13 +2429,12 @@ def meta_analysis_results_post_with_http_info(self, result_init : Optional[Resul :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ResultReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'result_init' ] _all_params.extend( [ @@ -1771,7 +2453,7 @@ def meta_analysis_results_post_with_http_info(self, result_init : Optional[Resul if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method meta_analysis_results_post" % _key + " to method neurostore_studies_post" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1790,9 +2472,6 @@ def meta_analysis_results_post_with_http_info(self, result_init : Optional[Resul _files = {} # process the body parameter _body_params = None - if _params['result_init'] is not None: - _body_params = _params['result_init'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -1800,19 +2479,19 @@ def meta_analysis_results_post_with_http_info(self, result_init : Optional[Resul # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', self.api_client.select_header_content_type( - ['application/json'])) + ['multipart/form-data'])) if _content_types_list: _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['JSON-Web-Token', 'upload_key'] # noqa: E501 + _auth_settings = ['JSON-Web-Token'] # noqa: E501 _response_types_map = { - '200': "ResultReturn", + '200': "NeurostoreStudyReturn", } return self.api_client.call_api( - '/meta-analysis-results', 'POST', + '/neurostore-studies', 'POST', _path_params, _query_params, _header_params, @@ -2090,7 +2769,7 @@ def neurovault_collections_id_get_with_http_info(self, id : StrictStr, **kwargs) @validate_arguments def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultCollectionReturn: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2118,7 +2797,7 @@ def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultC @validate_arguments def neurovault_collections_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3677,16 +4356,17 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa _request_auth=_params.get('_request_auth')) @validate_arguments - def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """Delete a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get(async_req=True) + >>> thread = api.specifications_id_delete(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: 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 @@ -3696,24 +4376,25 @@ def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationList + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_get_with_http_info(**kwargs) # noqa: E501 + raise ValueError("Error! Please call the specifications_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.specifications_id_delete_with_http_info(id, **kwargs) # noqa: E501 @validate_arguments - def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """Delete a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get_with_http_info(async_req=True) + >>> thread = api.specifications_id_delete_with_http_info(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -3736,12 +4417,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationList, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ + 'id' ] _all_params.extend( [ @@ -3760,7 +4442,7 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_get" % _key + " to method specifications_id_delete" % _key ) _params[_key] = _val del _params['kwargs'] @@ -3769,6 +4451,9 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E # process the path parameters _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + # process the query parameters _query_params = [] @@ -3779,20 +4464,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E _files = {} # process the body parameter _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 - # authentication setting - _auth_settings = [] # noqa: E501 + _auth_settings = ['JSON-Web-Token'] # noqa: E501 - _response_types_map = { - '200': "SpecificationList", - '400': "MetaAnalysesGet400Response", - } + _response_types_map = {} return self.api_client.call_api( - '/specifications', 'GET', + '/specifications/{id}', 'DELETE', _path_params, _query_params, _header_params, @@ -4108,18 +4786,18 @@ def specifications_id_put_with_http_info(self, id : StrictStr, specification : O _request_auth=_params.get('_request_auth')) @validate_arguments - def specifications_post(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> SpecificationReturn: # noqa: E501 - """Create a Specification # noqa: E501 + def studyset_references_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceList: # noqa: E501 + """Your GET endpoint # noqa: E501 - create a new meta-analysis specification # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_post(specification_post_body, async_req=True) + >>> thread = api.studyset_references_get(nested, async_req=True) >>> result = thread.get() - :param specification_post_body: - :type specification_post_body: SpecificationPostBody + :param nested: show nested component instead of id + :type nested: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -4129,26 +4807,26 @@ def specifications_post(self, specification_post_body : Optional[SpecificationPo :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationReturn + :rtype: StudysetReferenceList """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_post_with_http_info(specification_post_body, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the studyset_references_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_get_with_http_info(nested, **kwargs) # noqa: E501 @validate_arguments - def specifications_post_with_http_info(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Create a Specification # noqa: E501 + def studyset_references_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Your GET endpoint # noqa: E501 - create a new meta-analysis specification # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_post_with_http_info(specification_post_body, async_req=True) + >>> thread = api.studyset_references_get_with_http_info(nested, async_req=True) >>> result = thread.get() - :param specification_post_body: - :type specification_post_body: SpecificationPostBody + :param nested: show nested component instead of id + :type nested: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -4171,13 +4849,13 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(StudysetReferenceList, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'specification_post_body' + 'nested' ] _all_params.extend( [ @@ -4196,7 +4874,7 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_post" % _key + " to method studyset_references_get" % _key ) _params[_key] = _val del _params['kwargs'] @@ -4208,6 +4886,9 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ # process the query parameters _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -4215,32 +4896,164 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ _files = {} # process the body parameter _body_params = None - if _params['specification_post_body'] is not None: - _body_params = _params['specification_post_body'] - # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 + ['application/json']) # noqa: E501 - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "StudysetReferenceList", + } + + return self.api_client.call_api( + '/studyset-references', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def studyset_references_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceReturn: # 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.studyset_references_id_get(id, nested, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: StudysetReferenceReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the studyset_references_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_id_get_with_http_info(id, nested, **kwargs) # noqa: E501 + + @validate_arguments + def studyset_references_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = 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.studyset_references_id_get_with_http_info(id, nested, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(StudysetReferenceReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id', + 'nested' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method studyset_references_id_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 # authentication setting - _auth_settings = ['JSON-Web-Token'] # noqa: E501 + _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "SpecificationReturn", - '400': "MetaAnalysesGet400Response", - '422': None, - '500': "MetaAnalysesGet400Response", + '200': "StudysetReferenceReturn", } return self.api_client.call_api( - '/specifications', 'POST', + '/studyset-references/{id}', 'GET', _path_params, _query_params, _header_params, diff --git a/neurosynth_compose_sdk/api/delete_api.py b/neurosynth_compose_sdk/api/delete_api.py new file mode 100644 index 0000000..250fee2 --- /dev/null +++ b/neurosynth_compose_sdk/api/delete_api.py @@ -0,0 +1,437 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import re # noqa: F401 +import io +import warnings + +from pydantic import validate_arguments, ValidationError +from typing_extensions import Annotated + +from pydantic import StrictStr + + +from neurosynth_compose_sdk.api_client import ApiClient +from neurosynth_compose_sdk.api_response import ApiResponse +from neurosynth_compose_sdk.exceptions import ( # noqa: F401 + ApiTypeError, + ApiValueError +) + + +class DeleteApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_arguments + def meta_analyses_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analyses_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analyses_id_delete_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analyses_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analyses_id_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/meta-analyses/{id}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def projects_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.projects_id_delete(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the projects_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.projects_id_delete_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def projects_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.projects_id_delete_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method projects_id_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/projects/{id}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def specifications_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """Delete a Specification # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.specifications_id_delete(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the specifications_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.specifications_id_delete_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def specifications_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """Delete a Specification # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.specifications_id_delete_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method specifications_id_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/specifications/{id}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/neurosynth_compose_sdk/api/get_api.py b/neurosynth_compose_sdk/api/get_api.py index ed04b81..ca286fd 100644 --- a/neurosynth_compose_sdk/api/get_api.py +++ b/neurosynth_compose_sdk/api/get_api.py @@ -28,6 +28,8 @@ from neurosynth_compose_sdk.models.annotation_return import AnnotationReturn from neurosynth_compose_sdk.models.meta_analysis_list import MetaAnalysisList from neurosynth_compose_sdk.models.meta_analysis_return import MetaAnalysisReturn +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn from neurosynth_compose_sdk.models.neurovault_collection_return import NeurovaultCollectionReturn from neurosynth_compose_sdk.models.neurovault_file_list import NeurovaultFileList from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn @@ -35,9 +37,10 @@ from neurosynth_compose_sdk.models.project_return import ProjectReturn from neurosynth_compose_sdk.models.result_list import ResultList from neurosynth_compose_sdk.models.result_return import ResultReturn -from neurosynth_compose_sdk.models.specification_list import SpecificationList from neurosynth_compose_sdk.models.specification_return import SpecificationReturn from neurosynth_compose_sdk.models.studyset_list import StudysetList +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn from neurosynth_compose_sdk.models.studyset_return import StudysetReturn from neurosynth_compose_sdk.api_client import ApiClient @@ -905,6 +908,416 @@ def meta_analysis_results_id_get_with_http_info(self, id : StrictStr, **kwargs) collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def neurostore_studies_get(self, **kwargs) -> NeurostoreStudyList: # 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.neurostore_studies_get(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyList + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_get_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_get_with_http_info(self, **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.neurostore_studies_get_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyList, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyList", + } + + return self.api_client.call_api( + '/neurostore-studies', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_id_get(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # 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.neurostore_studies_id_get(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_get_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_id_get_with_http_info(self, id : StrictStr, **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.neurostore_studies_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_id_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyReturn", + } + + return self.api_client.call_api( + '/neurostore-studies/{id}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_id_put(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_id_put(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_id_put_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_put_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_id_put_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_id_put" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['multipart/form-data'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyReturn", + } + + return self.api_client.call_api( + '/neurostore-studies/{id}', 'PUT', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def neurovault_collections_get(self, **kwargs) -> None: # noqa: E501 """Get neurovault collections # noqa: E501 @@ -1706,16 +2119,18 @@ def projects_id_get_with_http_info(self, id : StrictStr, info : Annotated[Option _request_auth=_params.get('_request_auth')) @validate_arguments - def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_get(self, id : StrictStr, **kwargs) -> SpecificationReturn: # noqa: E501 + """Get information about a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 + get a meta-analysis specification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get(async_req=True) + >>> thread = api.specifications_id_get(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: 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 @@ -1725,24 +2140,26 @@ def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationList + :rtype: SpecificationReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_get_with_http_info(**kwargs) # noqa: E501 + raise ValueError("Error! Please call the specifications_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.specifications_id_get_with_http_info(id, **kwargs) # noqa: E501 @validate_arguments - def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """Get information about a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 + get a meta-analysis specification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get_with_http_info(async_req=True) + >>> thread = api.specifications_id_get_with_http_info(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1765,12 +2182,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationList, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(SpecificationReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ + 'id' ] _all_params.extend( [ @@ -1789,7 +2207,7 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_get" % _key + " to method specifications_id_get" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1798,6 +2216,9 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E # process the path parameters _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + # process the query parameters _query_params = [] @@ -1816,12 +2237,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "SpecificationList", - '400': "MetaAnalysesGet400Response", + '200': "SpecificationReturn", + '401': "MetaAnalysesGet400Response", + '404': "MetaAnalysesGet400Response", } return self.api_client.call_api( - '/specifications', 'GET', + '/specifications/{id}', 'GET', _path_params, _query_params, _header_params, @@ -1838,18 +2260,158 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E _request_auth=_params.get('_request_auth')) @validate_arguments - def specifications_id_get(self, id : StrictStr, **kwargs) -> SpecificationReturn: # noqa: E501 - """Get information about a Specification # noqa: E501 + def studyset_references_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceList: # noqa: E501 + """Your GET endpoint # noqa: E501 - get a meta-analysis specification # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_id_get(id, async_req=True) + >>> thread = api.studyset_references_get(nested, async_req=True) + >>> result = thread.get() + + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: StudysetReferenceList + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the studyset_references_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_get_with_http_info(nested, **kwargs) # noqa: E501 + + @validate_arguments + def studyset_references_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Your GET endpoint # noqa: E501 + + # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.studyset_references_get_with_http_info(nested, async_req=True) + >>> result = thread.get() + + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(StudysetReferenceList, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'nested' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method studyset_references_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "StudysetReferenceList", + } + + return self.api_client.call_api( + '/studyset-references', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def studyset_references_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceReturn: # 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.studyset_references_id_get(id, nested, async_req=True) >>> result = thread.get() :param id: (required) :type id: str + :param nested: show nested component instead of id + :type nested: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -1859,26 +2421,27 @@ def specifications_id_get(self, id : StrictStr, **kwargs) -> SpecificationReturn :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationReturn + :rtype: StudysetReferenceReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_id_get_with_http_info(id, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the studyset_references_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_id_get_with_http_info(id, nested, **kwargs) # noqa: E501 @validate_arguments - def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """Get information about a Specification # noqa: E501 + def studyset_references_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Your GET endpoint # noqa: E501 - get a meta-analysis specification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_id_get_with_http_info(id, async_req=True) + >>> thread = api.studyset_references_id_get_with_http_info(id, nested, async_req=True) >>> result = thread.get() :param id: (required) :type id: str + :param nested: show nested component instead of id + :type nested: bool :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -1901,13 +2464,14 @@ def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiR :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(StudysetReferenceReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'id' + 'id', + 'nested' ] _all_params.extend( [ @@ -1926,7 +2490,7 @@ def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiR if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_id_get" % _key + " to method studyset_references_id_get" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1941,6 +2505,9 @@ def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiR # process the query parameters _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + # process the header parameters _header_params = dict(_params.get('_headers', {})) # process the form parameters @@ -1950,19 +2517,17 @@ def specifications_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiR _body_params = None # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 + ['application/json']) # noqa: E501 # authentication setting _auth_settings = [] # noqa: E501 _response_types_map = { - '200': "SpecificationReturn", - '401': "MetaAnalysesGet400Response", - '404': "MetaAnalysesGet400Response", + '200': "StudysetReferenceReturn", } return self.api_client.call_api( - '/specifications/{id}', 'GET', + '/studyset-references/{id}', 'GET', _path_params, _query_params, _header_params, diff --git a/neurosynth_compose_sdk/api/meta_analyses_api.py b/neurosynth_compose_sdk/api/meta_analyses_api.py index 4594090..6617e5b 100644 --- a/neurosynth_compose_sdk/api/meta_analyses_api.py +++ b/neurosynth_compose_sdk/api/meta_analyses_api.py @@ -202,6 +202,137 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def meta_analyses_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the meta_analyses_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.meta_analyses_id_delete_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def meta_analyses_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.meta_analyses_id_delete_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: None + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method meta_analyses_id_delete" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = {} + + return self.api_client.call_api( + '/meta-analyses/{id}', 'DELETE', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def meta_analyses_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> MetaAnalysisReturn: # noqa: E501 """GET meta-analysis information # noqa: E501 diff --git a/neurosynth_compose_sdk/api/neurostore_studies_api.py b/neurosynth_compose_sdk/api/neurostore_studies_api.py new file mode 100644 index 0000000..92a571e --- /dev/null +++ b/neurosynth_compose_sdk/api/neurostore_studies_api.py @@ -0,0 +1,592 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import re # noqa: F401 +import io +import warnings + +from pydantic import validate_arguments, ValidationError +from typing_extensions import Annotated + +from pydantic import StrictStr + +from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn + +from neurosynth_compose_sdk.api_client import ApiClient +from neurosynth_compose_sdk.api_response import ApiResponse +from neurosynth_compose_sdk.exceptions import ( # noqa: F401 + ApiTypeError, + ApiValueError +) + + +class NeurostoreStudiesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_arguments + def neurostore_studies_get(self, **kwargs) -> NeurostoreStudyList: # 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.neurostore_studies_get(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyList + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_get_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_get_with_http_info(self, **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.neurostore_studies_get_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyList, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyList", + } + + return self.api_client.call_api( + '/neurostore-studies', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_id_get(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # 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.neurostore_studies_id_get(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_get_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_id_get_with_http_info(self, id : StrictStr, **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.neurostore_studies_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_id_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyReturn", + } + + return self.api_client.call_api( + '/neurostore-studies/{id}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_id_put(self, id : StrictStr, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_id_put(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: 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 + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_id_put_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_id_put_with_http_info(id, **kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_id_put_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_id_put" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['multipart/form-data'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyReturn", + } + + return self.api_client.call_api( + '/neurostore-studies/{id}', 'PUT', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def neurostore_studies_post(self, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_post(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: NeurostoreStudyReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the neurostore_studies_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_post_with_http_info(**kwargs) # noqa: E501 + + @validate_arguments + def neurostore_studies_post_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.neurostore_studies_post_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method neurostore_studies_post" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # set the HTTP header `Content-Type` + _content_types_list = _params.get('_content_type', + self.api_client.select_header_content_type( + ['multipart/form-data'])) + if _content_types_list: + _header_params['Content-Type'] = _content_types_list + + # authentication setting + _auth_settings = ['JSON-Web-Token'] # noqa: E501 + + _response_types_map = { + '200': "NeurostoreStudyReturn", + } + + return self.api_client.call_api( + '/neurostore-studies', 'POST', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/neurosynth_compose_sdk/api/neurovault_api.py b/neurosynth_compose_sdk/api/neurovault_api.py index 7d28da3..2844878 100644 --- a/neurosynth_compose_sdk/api/neurovault_api.py +++ b/neurosynth_compose_sdk/api/neurovault_api.py @@ -312,7 +312,7 @@ def neurovault_collections_id_get_with_http_info(self, id : StrictStr, **kwargs) @validate_arguments def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultCollectionReturn: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -340,7 +340,7 @@ def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultC @validate_arguments def neurovault_collections_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/neurosynth_compose_sdk/api/post_api.py b/neurosynth_compose_sdk/api/post_api.py index bc1e6bd..8d1bcb1 100644 --- a/neurosynth_compose_sdk/api/post_api.py +++ b/neurosynth_compose_sdk/api/post_api.py @@ -26,6 +26,7 @@ from neurosynth_compose_sdk.models.annotation_return import AnnotationReturn from neurosynth_compose_sdk.models.meta_analysis_post_body import MetaAnalysisPostBody from neurosynth_compose_sdk.models.meta_analysis_return import MetaAnalysisReturn +from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn from neurosynth_compose_sdk.models.neurovault_collection import NeurovaultCollection from neurosynth_compose_sdk.models.neurovault_file import NeurovaultFile from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn @@ -33,8 +34,6 @@ from neurosynth_compose_sdk.models.project_return import ProjectReturn from neurosynth_compose_sdk.models.result_init import ResultInit from neurosynth_compose_sdk.models.result_return import ResultReturn -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody -from neurosynth_compose_sdk.models.specification_return import SpecificationReturn from neurosynth_compose_sdk.models.studyset_post_body import StudysetPostBody from neurosynth_compose_sdk.models.studyset_return import StudysetReturn @@ -501,18 +500,15 @@ def meta_analysis_results_post_with_http_info(self, result_init : Optional[Resul _request_auth=_params.get('_request_auth')) @validate_arguments - def neurovault_collections_post(self, neurovault_collection : Optional[NeurovaultCollection] = None, **kwargs) -> None: # noqa: E501 - """Create neurovault collection # noqa: E501 + def neurostore_studies_post(self, **kwargs) -> NeurostoreStudyReturn: # noqa: E501 + """ # noqa: E501 - # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.neurovault_collections_post(neurovault_collection, async_req=True) + >>> thread = api.neurostore_studies_post(async_req=True) >>> result = thread.get() - :param neurovault_collection: - :type neurovault_collection: NeurovaultCollection :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -522,26 +518,23 @@ def neurovault_collections_post(self, neurovault_collection : Optional[Neurovaul :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: NeurostoreStudyReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the neurovault_collections_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.neurovault_collections_post_with_http_info(neurovault_collection, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurostore_studies_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurostore_studies_post_with_http_info(**kwargs) # noqa: E501 @validate_arguments - def neurovault_collections_post_with_http_info(self, neurovault_collection : Optional[NeurovaultCollection] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Create neurovault collection # noqa: E501 + def neurostore_studies_post_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 - # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.neurovault_collections_post_with_http_info(neurovault_collection, async_req=True) + >>> thread = api.neurostore_studies_post_with_http_info(async_req=True) >>> result = thread.get() - :param neurovault_collection: - :type neurovault_collection: NeurovaultCollection :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -564,13 +557,12 @@ def neurovault_collections_post_with_http_info(self, neurovault_collection : Opt :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: None + :rtype: tuple(NeurostoreStudyReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'neurovault_collection' ] _all_params.extend( [ @@ -589,7 +581,7 @@ def neurovault_collections_post_with_http_info(self, neurovault_collection : Opt if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method neurovault_collections_post" % _key + " to method neurostore_studies_post" % _key ) _params[_key] = _val del _params['kwargs'] @@ -608,23 +600,26 @@ def neurovault_collections_post_with_http_info(self, neurovault_collection : Opt _files = {} # process the body parameter _body_params = None - if _params['neurovault_collection'] is not None: - _body_params = _params['neurovault_collection'] + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', self.api_client.select_header_content_type( - ['application/json'])) + ['multipart/form-data'])) if _content_types_list: _header_params['Content-Type'] = _content_types_list # authentication setting _auth_settings = ['JSON-Web-Token'] # noqa: E501 - _response_types_map = {} + _response_types_map = { + '200': "NeurostoreStudyReturn", + } return self.api_client.call_api( - '/neurovault-collections', 'POST', + '/neurostore-studies', 'POST', _path_params, _query_params, _header_params, @@ -641,17 +636,18 @@ def neurovault_collections_post_with_http_info(self, neurovault_collection : Opt _request_auth=_params.get('_request_auth')) @validate_arguments - def neurovault_files_post(self, neurovault_file : Optional[NeurovaultFile] = None, **kwargs) -> NeurovaultFileReturn: # noqa: E501 - """ # noqa: E501 + def neurovault_collections_post(self, neurovault_collection : Optional[NeurovaultCollection] = None, **kwargs) -> None: # noqa: E501 + """Create neurovault collection # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.neurovault_files_post(neurovault_file, async_req=True) + >>> thread = api.neurovault_collections_post(neurovault_collection, async_req=True) >>> result = thread.get() - :param neurovault_file: - :type neurovault_file: NeurovaultFile + :param neurovault_collection: + :type neurovault_collection: NeurovaultCollection :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -661,25 +657,26 @@ def neurovault_files_post(self, neurovault_file : Optional[NeurovaultFile] = Non :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: NeurovaultFileReturn + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the neurovault_files_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.neurovault_files_post_with_http_info(neurovault_file, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurovault_collections_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurovault_collections_post_with_http_info(neurovault_collection, **kwargs) # noqa: E501 @validate_arguments - def neurovault_files_post_with_http_info(self, neurovault_file : Optional[NeurovaultFile] = None, **kwargs) -> ApiResponse: # noqa: E501 - """ # noqa: E501 + def neurovault_collections_post_with_http_info(self, neurovault_collection : Optional[NeurovaultCollection] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Create neurovault collection # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.neurovault_files_post_with_http_info(neurovault_file, async_req=True) + >>> thread = api.neurovault_collections_post_with_http_info(neurovault_collection, async_req=True) >>> result = thread.get() - :param neurovault_file: - :type neurovault_file: NeurovaultFile + :param neurovault_collection: + :type neurovault_collection: NeurovaultCollection :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -702,13 +699,13 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(NeurovaultFileReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ - 'neurovault_file' + 'neurovault_collection' ] _all_params.extend( [ @@ -727,7 +724,7 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method neurovault_files_post" % _key + " to method neurovault_collections_post" % _key ) _params[_key] = _val del _params['kwargs'] @@ -746,12 +743,8 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov _files = {} # process the body parameter _body_params = None - if _params['neurovault_file'] is not None: - _body_params = _params['neurovault_file'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + if _params['neurovault_collection'] is not None: + _body_params = _params['neurovault_collection'] # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', @@ -763,12 +756,10 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov # authentication setting _auth_settings = ['JSON-Web-Token'] # noqa: E501 - _response_types_map = { - '200': "NeurovaultFileReturn", - } + _response_types_map = {} return self.api_client.call_api( - '/neurovault-files', 'POST', + '/neurovault-collections', 'POST', _path_params, _query_params, _header_params, @@ -785,17 +776,17 @@ def neurovault_files_post_with_http_info(self, neurovault_file : Optional[Neurov _request_auth=_params.get('_request_auth')) @validate_arguments - def projects_post(self, project : Optional[Project] = None, **kwargs) -> ProjectReturn: # noqa: E501 + def neurovault_files_post(self, neurovault_file : Optional[NeurovaultFile] = None, **kwargs) -> NeurovaultFileReturn: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_post(project, async_req=True) + >>> thread = api.neurovault_files_post(neurovault_file, async_req=True) >>> result = thread.get() - :param project: - :type project: Project + :param neurovault_file: + :type neurovault_file: NeurovaultFile :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -805,25 +796,25 @@ def projects_post(self, project : Optional[Project] = None, **kwargs) -> Project :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: ProjectReturn + :rtype: NeurovaultFileReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the projects_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.projects_post_with_http_info(project, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the neurovault_files_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.neurovault_files_post_with_http_info(neurovault_file, **kwargs) # noqa: E501 @validate_arguments - def projects_post_with_http_info(self, project : Optional[Project] = None, **kwargs) -> ApiResponse: # noqa: E501 + def neurovault_files_post_with_http_info(self, neurovault_file : Optional[NeurovaultFile] = None, **kwargs) -> ApiResponse: # noqa: E501 """ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.projects_post_with_http_info(project, async_req=True) + >>> thread = api.neurovault_files_post_with_http_info(neurovault_file, async_req=True) >>> result = thread.get() - :param project: - :type project: Project + :param neurovault_file: + :type neurovault_file: NeurovaultFile :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -846,13 +837,13 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(ProjectReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(NeurovaultFileReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'project' + 'neurovault_file' ] _all_params.extend( [ @@ -871,7 +862,7 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method projects_post" % _key + " to method neurovault_files_post" % _key ) _params[_key] = _val del _params['kwargs'] @@ -890,8 +881,8 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa _files = {} # process the body parameter _body_params = None - if _params['project'] is not None: - _body_params = _params['project'] + if _params['neurovault_file'] is not None: + _body_params = _params['neurovault_file'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( @@ -908,11 +899,11 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa _auth_settings = ['JSON-Web-Token'] # noqa: E501 _response_types_map = { - '200': "ProjectReturn", + '200': "NeurovaultFileReturn", } return self.api_client.call_api( - '/projects', 'POST', + '/neurovault-files', 'POST', _path_params, _query_params, _header_params, @@ -929,18 +920,17 @@ def projects_post_with_http_info(self, project : Optional[Project] = None, **kwa _request_auth=_params.get('_request_auth')) @validate_arguments - def specifications_post(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> SpecificationReturn: # noqa: E501 - """Create a Specification # noqa: E501 + def projects_post(self, project : Optional[Project] = None, **kwargs) -> ProjectReturn: # noqa: E501 + """ # noqa: E501 - create a new meta-analysis specification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_post(specification_post_body, async_req=True) + >>> thread = api.projects_post(project, async_req=True) >>> result = thread.get() - :param specification_post_body: - :type specification_post_body: SpecificationPostBody + :param project: + :type project: Project :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _request_timeout: timeout setting for this request. If one @@ -950,26 +940,25 @@ def specifications_post(self, specification_post_body : Optional[SpecificationPo :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationReturn + :rtype: ProjectReturn """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_post_with_http_info(specification_post_body, **kwargs) # noqa: E501 + raise ValueError("Error! Please call the projects_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.projects_post_with_http_info(project, **kwargs) # noqa: E501 @validate_arguments - def specifications_post_with_http_info(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Create a Specification # noqa: E501 + def projects_post_with_http_info(self, project : Optional[Project] = None, **kwargs) -> ApiResponse: # noqa: E501 + """ # noqa: E501 - create a new meta-analysis specification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_post_with_http_info(specification_post_body, async_req=True) + >>> thread = api.projects_post_with_http_info(project, async_req=True) >>> result = thread.get() - :param specification_post_body: - :type specification_post_body: SpecificationPostBody + :param project: + :type project: Project :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -992,13 +981,13 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationReturn, status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(ProjectReturn, status_code(int), headers(HTTPHeaderDict)) """ _params = locals() _all_params = [ - 'specification_post_body' + 'project' ] _all_params.extend( [ @@ -1017,7 +1006,7 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_post" % _key + " to method projects_post" % _key ) _params[_key] = _val del _params['kwargs'] @@ -1036,12 +1025,12 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ _files = {} # process the body parameter _body_params = None - if _params['specification_post_body'] is not None: - _body_params = _params['specification_post_body'] + if _params['project'] is not None: + _body_params = _params['project'] # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 + ['application/json']) # noqa: E501 # set the HTTP header `Content-Type` _content_types_list = _params.get('_content_type', @@ -1054,14 +1043,11 @@ def specifications_post_with_http_info(self, specification_post_body : Optional[ _auth_settings = ['JSON-Web-Token'] # noqa: E501 _response_types_map = { - '200': "SpecificationReturn", - '400': "MetaAnalysesGet400Response", - '422': None, - '500': "MetaAnalysesGet400Response", + '200': "ProjectReturn", } return self.api_client.call_api( - '/specifications', 'POST', + '/projects', 'POST', _path_params, _query_params, _header_params, diff --git a/neurosynth_compose_sdk/api/put_api.py b/neurosynth_compose_sdk/api/put_api.py index 27135a4..b626eac 100644 --- a/neurosynth_compose_sdk/api/put_api.py +++ b/neurosynth_compose_sdk/api/put_api.py @@ -529,7 +529,7 @@ def meta_analysis_results_id_put_with_http_info(self, id : StrictStr, result : O @validate_arguments def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultCollectionReturn: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -557,7 +557,7 @@ def neurovault_collections_id_put(self, id : StrictStr, **kwargs) -> NeurovaultC @validate_arguments def neurovault_collections_id_put_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """ # noqa: E501 + """Update Neurovault Collection Reference # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/neurosynth_compose_sdk/api/specifications_api.py b/neurosynth_compose_sdk/api/specifications_api.py index 458b6b4..351f8a4 100644 --- a/neurosynth_compose_sdk/api/specifications_api.py +++ b/neurosynth_compose_sdk/api/specifications_api.py @@ -25,8 +25,6 @@ from typing import Optional from neurosynth_compose_sdk.models.specification import Specification -from neurosynth_compose_sdk.models.specification_list import SpecificationList -from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody from neurosynth_compose_sdk.models.specification_return import SpecificationReturn from neurosynth_compose_sdk.api_client import ApiClient @@ -50,16 +48,17 @@ def __init__(self, api_client=None): self.api_client = api_client @validate_arguments - def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_delete(self, id : StrictStr, **kwargs) -> None: # noqa: E501 + """Delete a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get(async_req=True) + >>> thread = api.specifications_id_delete(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: 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 @@ -69,24 +68,25 @@ def specifications_get(self, **kwargs) -> SpecificationList: # noqa: E501 :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: SpecificationList + :rtype: None """ kwargs['_return_http_data_only'] = True if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_get_with_http_info(**kwargs) # noqa: E501 + raise ValueError("Error! Please call the specifications_id_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.specifications_id_delete_with_http_info(id, **kwargs) # noqa: E501 @validate_arguments - def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Get a list of Specifications # noqa: E501 + def specifications_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 + """Delete a Specification # noqa: E501 - list of meta-analysis specifications # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.specifications_get_with_http_info(async_req=True) + >>> thread = api.specifications_id_delete_with_http_info(id, async_req=True) >>> result = thread.get() + :param id: (required) + :type id: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional :param _preload_content: if False, the ApiResponse.data will @@ -109,12 +109,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E :return: Returns the result object. If the method is called asynchronously, returns the request thread. - :rtype: tuple(SpecificationList, status_code(int), headers(HTTPHeaderDict)) + :rtype: None """ _params = locals() _all_params = [ + 'id' ] _all_params.extend( [ @@ -133,7 +134,7 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E if _key not in _all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method specifications_get" % _key + " to method specifications_id_delete" % _key ) _params[_key] = _val del _params['kwargs'] @@ -142,6 +143,9 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E # process the path parameters _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + # process the query parameters _query_params = [] @@ -152,20 +156,13 @@ def specifications_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E _files = {} # process the body parameter _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 - # authentication setting - _auth_settings = [] # noqa: E501 + _auth_settings = ['JSON-Web-Token'] # noqa: E501 - _response_types_map = { - '200': "SpecificationList", - '400': "MetaAnalysesGet400Response", - } + _response_types_map = {} return self.api_client.call_api( - '/specifications', 'GET', + '/specifications/{id}', 'DELETE', _path_params, _query_params, _header_params, @@ -479,152 +476,3 @@ def specifications_id_put_with_http_info(self, id : StrictStr, specification : O _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) - - @validate_arguments - def specifications_post(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> SpecificationReturn: # noqa: E501 - """Create a Specification # noqa: E501 - - create a new meta-analysis specification # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.specifications_post(specification_post_body, async_req=True) - >>> result = thread.get() - - :param specification_post_body: - :type specification_post_body: SpecificationPostBody - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SpecificationReturn - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - raise ValueError("Error! Please call the specifications_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") - return self.specifications_post_with_http_info(specification_post_body, **kwargs) # noqa: E501 - - @validate_arguments - def specifications_post_with_http_info(self, specification_post_body : Optional[SpecificationPostBody] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Create a Specification # noqa: E501 - - create a new meta-analysis specification # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.specifications_post_with_http_info(specification_post_body, async_req=True) - >>> result = thread.get() - - :param specification_post_body: - :type specification_post_body: SpecificationPostBody - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SpecificationReturn, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'specification_post_body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method specifications_post" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['specification_post_body'] is not None: - _body_params = _params['specification_post_body'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/problem+json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['JSON-Web-Token'] # noqa: E501 - - _response_types_map = { - '200': "SpecificationReturn", - '400': "MetaAnalysesGet400Response", - '422': None, - '500': "MetaAnalysesGet400Response", - } - - return self.api_client.call_api( - '/specifications', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, - response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) diff --git a/neurosynth_compose_sdk/api/studyset_references_api.py b/neurosynth_compose_sdk/api/studyset_references_api.py new file mode 100644 index 0000000..658fff3 --- /dev/null +++ b/neurosynth_compose_sdk/api/studyset_references_api.py @@ -0,0 +1,332 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import re # noqa: F401 +import io +import warnings + +from pydantic import validate_arguments, ValidationError +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr + +from typing import Optional + +from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList +from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn + +from neurosynth_compose_sdk.api_client import ApiClient +from neurosynth_compose_sdk.api_response import ApiResponse +from neurosynth_compose_sdk.exceptions import ( # noqa: F401 + ApiTypeError, + ApiValueError +) + + +class StudysetReferencesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_arguments + def studyset_references_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceList: # noqa: E501 + """Your GET endpoint # noqa: E501 + + # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.studyset_references_get(nested, async_req=True) + >>> result = thread.get() + + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: StudysetReferenceList + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the studyset_references_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_get_with_http_info(nested, **kwargs) # noqa: E501 + + @validate_arguments + def studyset_references_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Your GET endpoint # noqa: E501 + + # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.studyset_references_get_with_http_info(nested, async_req=True) + >>> result = thread.get() + + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(StudysetReferenceList, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'nested' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method studyset_references_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "StudysetReferenceList", + } + + return self.api_client.call_api( + '/studyset-references', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def studyset_references_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceReturn: # 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.studyset_references_id_get(id, nested, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: StudysetReferenceReturn + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + raise ValueError("Error! Please call the studyset_references_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data") + return self.studyset_references_id_get_with_http_info(id, nested, **kwargs) # noqa: E501 + + @validate_arguments + def studyset_references_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = 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.studyset_references_id_get_with_http_info(id, nested, async_req=True) + >>> result = thread.get() + + :param id: (required) + :type id: str + :param nested: show nested component instead of id + :type nested: bool + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(StudysetReferenceReturn, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'id', + 'nested' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method studyset_references_id_get" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + if _params['id']: + _path_params['id'] = _params['id'] + + + # process the query parameters + _query_params = [] + if _params.get('nested') is not None: # noqa: E501 + _query_params.append(('nested', _params['nested'])) + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "StudysetReferenceReturn", + } + + return self.api_client.call_api( + '/studyset-references/{id}', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) diff --git a/test/test_delete_api.py b/test/test_delete_api.py new file mode 100644 index 0000000..ea15e89 --- /dev/null +++ b/test/test_delete_api.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import unittest + +import neurosynth_compose_sdk +from neurosynth_compose_sdk.api.delete_api import DeleteApi # noqa: E501 +from neurosynth_compose_sdk.rest import ApiException + + +class TestDeleteApi(unittest.TestCase): + """DeleteApi unit test stubs""" + + def setUp(self): + self.api = neurosynth_compose_sdk.api.delete_api.DeleteApi() # noqa: E501 + + def tearDown(self): + pass + + def test_meta_analyses_id_delete(self): + """Test case for meta_analyses_id_delete + + # noqa: E501 + """ + pass + + def test_projects_id_delete(self): + """Test case for projects_id_delete + + # noqa: E501 + """ + pass + + def test_specifications_id_delete(self): + """Test case for specifications_id_delete + + Delete a Specification # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_neurostore_studies_api.py b/test/test_neurostore_studies_api.py new file mode 100644 index 0000000..16d70ba --- /dev/null +++ b/test/test_neurostore_studies_api.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import unittest + +import neurosynth_compose_sdk +from neurosynth_compose_sdk.api.neurostore_studies_api import NeurostoreStudiesApi # noqa: E501 +from neurosynth_compose_sdk.rest import ApiException + + +class TestNeurostoreStudiesApi(unittest.TestCase): + """NeurostoreStudiesApi unit test stubs""" + + def setUp(self): + self.api = neurosynth_compose_sdk.api.neurostore_studies_api.NeurostoreStudiesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_neurostore_studies_get(self): + """Test case for neurostore_studies_get + + Your GET endpoint # noqa: E501 + """ + pass + + def test_neurostore_studies_id_get(self): + """Test case for neurostore_studies_id_get + + Your GET endpoint # noqa: E501 + """ + pass + + def test_neurostore_studies_id_put(self): + """Test case for neurostore_studies_id_put + + # noqa: E501 + """ + pass + + def test_neurostore_studies_post(self): + """Test case for neurostore_studies_post + + # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_studyset_references_api.py b/test/test_studyset_references_api.py new file mode 100644 index 0000000..62d8ff6 --- /dev/null +++ b/test/test_studyset_references_api.py @@ -0,0 +1,48 @@ +# coding: utf-8 + +""" + Analysis Specification for Meta-analysis + + api to create a meta-analysis specification # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: jamesdkent21@gmail.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" + + +import unittest + +import neurosynth_compose_sdk +from neurosynth_compose_sdk.api.studyset_references_api import StudysetReferencesApi # noqa: E501 +from neurosynth_compose_sdk.rest import ApiException + + +class TestStudysetReferencesApi(unittest.TestCase): + """StudysetReferencesApi unit test stubs""" + + def setUp(self): + self.api = neurosynth_compose_sdk.api.studyset_references_api.StudysetReferencesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_studyset_references_get(self): + """Test case for studyset_references_get + + Your GET endpoint # noqa: E501 + """ + pass + + def test_studyset_references_id_get(self): + """Test case for studyset_references_id_get + + Your GET endpoint # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main()