Skip to content

Commit 47182a2

Browse files
github-actions[bot]github-actions[bot]
committed
afea9477ef8e0dad058e55045ba00b164a47ee91
1 parent 0db4877 commit 47182a2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1803
-20695
lines changed

‎.openapi-generator/FILES‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ docs/ImageRelationships.md
5454
docs/ImageRequest.md
5555
docs/ImageReturn.md
5656
docs/ImagesApi.md
57+
docs/JsonLd.md
5758
docs/JsonLdContext.md
59+
docs/Metadata.md
5860
docs/NestedPutAttributes.md
5961
docs/NoteCollectionBase.md
6062
docs/NoteCollectionList.md
@@ -83,6 +85,7 @@ docs/PointRequest.md
8385
docs/PointReturn.md
8486
docs/PointValue.md
8587
docs/PointsApi.md
88+
docs/ReadableResourceAttributes.md
8689
docs/ResourceAttributes.md
8790
docs/StoreApi.md
8891
docs/StudiesApi.md
@@ -118,7 +121,9 @@ docs/TablesApi.md
118121
docs/User.md
119122
docs/UserApi.md
120123
docs/UserList.md
124+
docs/UserResourceAttributes.md
121125
docs/UserlessResourceAttributes.md
126+
docs/WriteableResourceAttributes.md
122127
git_push.sh
123128
neurostore_sdk/__init__.py
124129
neurostore_sdk/api/__init__.py
@@ -188,7 +193,9 @@ neurostore_sdk/models/image_list.py
188193
neurostore_sdk/models/image_relationships.py
189194
neurostore_sdk/models/image_request.py
190195
neurostore_sdk/models/image_return.py
196+
neurostore_sdk/models/json_ld.py
191197
neurostore_sdk/models/json_ld_context.py
198+
neurostore_sdk/models/metadata.py
192199
neurostore_sdk/models/nested_put_attributes.py
193200
neurostore_sdk/models/note_collection_base.py
194201
neurostore_sdk/models/note_collection_list.py
@@ -212,6 +219,7 @@ neurostore_sdk/models/point_relationships_values.py
212219
neurostore_sdk/models/point_request.py
213220
neurostore_sdk/models/point_return.py
214221
neurostore_sdk/models/point_value.py
222+
neurostore_sdk/models/readable_resource_attributes.py
215223
neurostore_sdk/models/resource_attributes.py
216224
neurostore_sdk/models/study_base.py
217225
neurostore_sdk/models/study_common.py
@@ -242,7 +250,9 @@ neurostore_sdk/models/table_return.py
242250
neurostore_sdk/models/table_return_relationships.py
243251
neurostore_sdk/models/user.py
244252
neurostore_sdk/models/user_list.py
253+
neurostore_sdk/models/user_resource_attributes.py
245254
neurostore_sdk/models/userless_resource_attributes.py
255+
neurostore_sdk/models/writeable_resource_attributes.py
246256
neurostore_sdk/py.typed
247257
neurostore_sdk/rest.py
248258
pyproject.toml

‎README.md‎

Lines changed: 48 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,6 @@ Class | Method | HTTP request | Description
103103
*AnalysesApi* | [**annotation_analyses_id_get**](docs/AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
104104
*AnalysesApi* | [**annotation_analyses_id_put**](docs/AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
105105
*AnalysesApi* | [**annotation_analyses_post**](docs/AnalysesApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
106-
*AnnotationsApi* | [**annotation_analyses_get**](docs/AnnotationsApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
107-
*AnnotationsApi* | [**annotation_analyses_id_get**](docs/AnnotationsApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
108-
*AnnotationsApi* | [**annotation_analyses_id_put**](docs/AnnotationsApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
109-
*AnnotationsApi* | [**annotation_analyses_post**](docs/AnnotationsApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
110106
*AnnotationsApi* | [**annotations_get**](docs/AnnotationsApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
111107
*AnnotationsApi* | [**annotations_id_delete**](docs/AnnotationsApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
112108
*AnnotationsApi* | [**annotations_id_get**](docs/AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
@@ -144,39 +140,6 @@ Class | Method | HTTP request | Description
144140
*PointsApi* | [**points_id_get**](docs/PointsApi.md#points_id_get) | **GET** /points/{id} | GET a point
145141
*PointsApi* | [**points_id_put**](docs/PointsApi.md#points_id_put) | **PUT** /points/{id} | PUT/update a point
146142
*PointsApi* | [**points_post**](docs/PointsApi.md#points_post) | **POST** /points/ | POST Points
147-
*StoreApi* | [**analyses_get**](docs/StoreApi.md#analyses_get) | **GET** /analyses/ | GET list of analyses
148-
*StoreApi* | [**analyses_id_delete**](docs/StoreApi.md#analyses_id_delete) | **DELETE** /analyses/{id} | DELETE an analysis
149-
*StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
150-
*StoreApi* | [**analyses_id_put**](docs/StoreApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
151-
*StoreApi* | [**analyses_post**](docs/StoreApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
152-
*StoreApi* | [**annotation_analyses_get**](docs/StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
153-
*StoreApi* | [**annotation_analyses_id_get**](docs/StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
154-
*StoreApi* | [**annotation_analyses_id_put**](docs/StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
155-
*StoreApi* | [**annotation_analyses_post**](docs/StoreApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
156-
*StoreApi* | [**annotations_get**](docs/StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
157-
*StoreApi* | [**annotations_id_delete**](docs/StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
158-
*StoreApi* | [**annotations_id_get**](docs/StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
159-
*StoreApi* | [**annotations_id_put**](docs/StoreApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an annotation
160-
*StoreApi* | [**annotations_post**](docs/StoreApi.md#annotations_post) | **POST** /annotations/ | Post Annotation
161-
*StoreApi* | [**base_studies_get**](docs/StoreApi.md#base_studies_get) | **GET** /base-studies/ |
162-
*StoreApi* | [**base_studies_id_get**](docs/StoreApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
163-
*StoreApi* | [**base_studies_id_put**](docs/StoreApi.md#base_studies_id_put) | **PUT** /base-studies/{id} |
164-
*StoreApi* | [**base_studies_post**](docs/StoreApi.md#base_studies_post) | **POST** /base-studies/ |
165-
*StoreApi* | [**conditions_get**](docs/StoreApi.md#conditions_get) | **GET** /conditions/ | GET Conditions
166-
*StoreApi* | [**conditions_id_delete**](docs/StoreApi.md#conditions_id_delete) | **DELETE** /conditions/{id} | DELETE a condition
167-
*StoreApi* | [**conditions_id_get**](docs/StoreApi.md#conditions_id_get) | **GET** /conditions/{id} | GET a condition
168-
*StoreApi* | [**conditions_id_put**](docs/StoreApi.md#conditions_id_put) | **PUT** /conditions/{id} | PUT/update a condition
169-
*StoreApi* | [**conditions_post**](docs/StoreApi.md#conditions_post) | **POST** /conditions/ | POST/Create a condition
170-
*StoreApi* | [**images_get**](docs/StoreApi.md#images_get) | **GET** /images/ | GET a list of images
171-
*StoreApi* | [**images_id_delete**](docs/StoreApi.md#images_id_delete) | **DELETE** /images/{id} | DELETE an image
172-
*StoreApi* | [**images_id_get**](docs/StoreApi.md#images_id_get) | **GET** /images/{id} | GET an image
173-
*StoreApi* | [**images_id_put**](docs/StoreApi.md#images_id_put) | **PUT** /images/{id} | PUT/update an image
174-
*StoreApi* | [**images_post**](docs/StoreApi.md#images_post) | **POST** /images/ | POST/create an image
175-
*StoreApi* | [**points_get**](docs/StoreApi.md#points_get) | **GET** /points/ | Get Points
176-
*StoreApi* | [**points_id_delete**](docs/StoreApi.md#points_id_delete) | **DELETE** /points/{id} | DELETE a point
177-
*StoreApi* | [**points_id_get**](docs/StoreApi.md#points_id_get) | **GET** /points/{id} | GET a point
178-
*StoreApi* | [**points_id_put**](docs/StoreApi.md#points_id_put) | **PUT** /points/{id} | PUT/update a point
179-
*StoreApi* | [**points_post**](docs/StoreApi.md#points_post) | **POST** /points/ | POST Points
180143
*StoreApi* | [**studies_get**](docs/StoreApi.md#studies_get) | **GET** /studies/ | GET a list of studies
181144
*StoreApi* | [**studies_id_delete**](docs/StoreApi.md#studies_id_delete) | **DELETE** /studies/{id} | DELETE a study
182145
*StoreApi* | [**studies_id_get**](docs/StoreApi.md#studies_id_get) | **GET** /studies/{id} | GET a study
@@ -186,25 +149,11 @@ Class | Method | HTTP request | Description
186149
*StoreApi* | [**studysets_id_get**](docs/StoreApi.md#studysets_id_get) | **GET** /studysets/{id} | GET a studyset
187150
*StoreApi* | [**studysets_id_put**](docs/StoreApi.md#studysets_id_put) | **PUT** /studysets/{id} | PUT/update a studyset
188151
*StoreApi* | [**studysets_post**](docs/StoreApi.md#studysets_post) | **POST** /studysets/ | POST/create a studyset
189-
*StoreApi* | [**tables_get**](docs/StoreApi.md#tables_get) | **GET** /tables/ | GET list of tables
190-
*StoreApi* | [**tables_id_delete**](docs/StoreApi.md#tables_id_delete) | **DELETE** /tables/{id} | DELETE a table
191-
*StoreApi* | [**tables_id_get**](docs/StoreApi.md#tables_id_get) | **GET** /tables/{id} | GET a table
192-
*StoreApi* | [**tables_id_put**](docs/StoreApi.md#tables_id_put) | **PUT** /tables/{id} | PUT/update a table
193-
*StoreApi* | [**tables_post**](docs/StoreApi.md#tables_post) | **POST** /tables/ | POST/create a table
194152
*StudiesApi* | [**base_studies_get**](docs/StudiesApi.md#base_studies_get) | **GET** /base-studies/ |
195153
*StudiesApi* | [**base_studies_id_get**](docs/StudiesApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
196154
*StudiesApi* | [**base_studies_id_put**](docs/StudiesApi.md#base_studies_id_put) | **PUT** /base-studies/{id} |
197155
*StudiesApi* | [**base_studies_post**](docs/StudiesApi.md#base_studies_post) | **POST** /base-studies/ |
198-
*StudiesApi* | [**studies_get**](docs/StudiesApi.md#studies_get) | **GET** /studies/ | GET a list of studies
199-
*StudiesApi* | [**studies_id_delete**](docs/StudiesApi.md#studies_id_delete) | **DELETE** /studies/{id} | DELETE a study
200-
*StudiesApi* | [**studies_id_get**](docs/StudiesApi.md#studies_id_get) | **GET** /studies/{id} | GET a study
201-
*StudiesApi* | [**studies_id_put**](docs/StudiesApi.md#studies_id_put) | **PUT** /studies/{id} | PUT/update a study
202-
*StudiesApi* | [**studies_post**](docs/StudiesApi.md#studies_post) | **POST** /studies/ | POST/create a study
203156
*StudysetsApi* | [**studysets_get**](docs/StudysetsApi.md#studysets_get) | **GET** /studysets/ | GET a list of studysets
204-
*StudysetsApi* | [**studysets_id_delete**](docs/StudysetsApi.md#studysets_id_delete) | **DELETE** /studysets/{id} | DELETE a studyset
205-
*StudysetsApi* | [**studysets_id_get**](docs/StudysetsApi.md#studysets_id_get) | **GET** /studysets/{id} | GET a studyset
206-
*StudysetsApi* | [**studysets_id_put**](docs/StudysetsApi.md#studysets_id_put) | **PUT** /studysets/{id} | PUT/update a studyset
207-
*StudysetsApi* | [**studysets_post**](docs/StudysetsApi.md#studysets_post) | **POST** /studysets/ | POST/create a studyset
208157
*TablesApi* | [**tables_get**](docs/TablesApi.md#tables_get) | **GET** /tables/ | GET list of tables
209158
*TablesApi* | [**tables_id_delete**](docs/TablesApi.md#tables_id_delete) | **DELETE** /tables/{id} | DELETE a table
210159
*TablesApi* | [**tables_id_get**](docs/TablesApi.md#tables_id_get) | **GET** /tables/{id} | GET a table
@@ -265,7 +214,9 @@ Class | Method | HTTP request | Description
265214
- [ImageRelationships](docs/ImageRelationships.md)
266215
- [ImageRequest](docs/ImageRequest.md)
267216
- [ImageReturn](docs/ImageReturn.md)
217+
- [JsonLd](docs/JsonLd.md)
268218
- [JsonLdContext](docs/JsonLdContext.md)
219+
- [Metadata](docs/Metadata.md)
269220
- [NestedPutAttributes](docs/NestedPutAttributes.md)
270221
- [NoteCollectionBase](docs/NoteCollectionBase.md)
271222
- [NoteCollectionList](docs/NoteCollectionList.md)
@@ -289,6 +240,7 @@ Class | Method | HTTP request | Description
289240
- [PointRequest](docs/PointRequest.md)
290241
- [PointReturn](docs/PointReturn.md)
291242
- [PointValue](docs/PointValue.md)
243+
- [ReadableResourceAttributes](docs/ReadableResourceAttributes.md)
292244
- [ResourceAttributes](docs/ResourceAttributes.md)
293245
- [StudyBase](docs/StudyBase.md)
294246
- [StudyCommon](docs/StudyCommon.md)
@@ -319,7 +271,9 @@ Class | Method | HTTP request | Description
319271
- [TableReturnRelationships](docs/TableReturnRelationships.md)
320272
- [User](docs/User.md)
321273
- [UserList](docs/UserList.md)
274+
- [UserResourceAttributes](docs/UserResourceAttributes.md)
322275
- [UserlessResourceAttributes](docs/UserlessResourceAttributes.md)
276+
- [WriteableResourceAttributes](docs/WriteableResourceAttributes.md)
323277

324278

325279
<a id="documentation-for-authorization"></a>
@@ -338,3 +292,46 @@ Authentication schemes defined for the API:
338292
jamesdkent21@gmail.com
339293

340294

295+
296+
<!-- neurostuff-sdk-helpers:start -->
297+
## Neurostuff SDK Helpers
298+
299+
The generator adds two helper modules to reduce import friction:
300+
301+
1. `sdk.py`: a single facade for endpoint groups.
302+
2. `auth.py`: Auth0 refresh-token exchange + automatic bearer token refresh.
303+
304+
### Minimal usage
305+
306+
```python
307+
from neurostore_sdk.sdk import SDK
308+
309+
sdk = SDK(host="https://example.org/api", access_token="<access-token>")
310+
studysets_api = sdk.studysets
311+
result = studysets_api.studysets_get()
312+
```
313+
314+
### Auth0 refresh-token usage
315+
316+
```python
317+
from neurostore_sdk.sdk import SDK
318+
319+
sdk = SDK.from_auth0_refresh_token(
320+
domain="your-tenant.us.auth0.com",
321+
client_id="<auth0-client-id>",
322+
refresh_token="<auth0-refresh-token>",
323+
audience="<optional-audience>",
324+
)
325+
326+
# Access token is exchanged and refreshed automatically per request.
327+
users = sdk.users.users_get()
328+
```
329+
330+
You can also use environment variables:
331+
`AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, `AUTH0_REFRESH_TOKEN`, plus optional
332+
`AUTH0_AUDIENCE`, `AUTH0_CLIENT_SECRET`, `AUTH0_SCOPE`.
333+
334+
```python
335+
sdk = SDK.from_auth0_env(prefix="AUTH0")
336+
```
337+
<!-- neurostuff-sdk-helpers:end -->

0 commit comments

Comments
 (0)