flywheel-sdk 18.3.0rc0__py2.py3-none-any.whl → 18.4.0rc0__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. flywheel/__init__.py +7 -6
  2. flywheel/api/__init__.py +1 -1
  3. flywheel/api/acquisitions_api.py +10 -6
  4. flywheel/api/analyses_api.py +5 -1
  5. flywheel/api/bulk_api.py +3 -3
  6. flywheel/api/collections_api.py +5 -1
  7. flywheel/api/containers_api.py +10 -6
  8. flywheel/api/gears_api.py +3 -3
  9. flywheel/api/{workspaces_api.py → jupyterlab_servers_api.py} +47 -47
  10. flywheel/api/projects_api.py +10 -6
  11. flywheel/api/reports_api.py +30 -5
  12. flywheel/api/sessions_api.py +10 -6
  13. flywheel/api/site_api.py +6 -6
  14. flywheel/api/subjects_api.py +10 -6
  15. flywheel/api/upload_api.py +15 -15
  16. flywheel/api/views_api.py +4 -4
  17. flywheel/api_client.py +1 -1
  18. flywheel/configuration.py +2 -2
  19. flywheel/flywheel.py +55 -42
  20. flywheel/models/__init__.py +9 -8
  21. flywheel/models/as_storage.py +1 -1
  22. flywheel/models/aws_storage.py +1 -1
  23. flywheel/models/base_compute.py +1 -1
  24. flywheel/models/central_out.py +31 -4
  25. flywheel/models/change_method.py +1 -0
  26. flywheel/models/container_type.py +1 -1
  27. flywheel/models/context_input.py +1 -1
  28. flywheel/models/core_models_jobs_api_key_input.py +1 -1
  29. flywheel/models/exchange_storage.py +1 -1
  30. flywheel/models/gcp_storage.py +1 -1
  31. flywheel/models/gear_context_input.py +1 -1
  32. flywheel/models/gear_context_value_output_unfound.py +1 -1
  33. flywheel/models/gear_file_input.py +1 -1
  34. flywheel/models/gear_key_input.py +1 -1
  35. flywheel/models/job_file_input.py +1 -1
  36. flywheel/models/job_file_input_list_output.py +1 -1
  37. flywheel/models/{workspace_modify.py → jupyterlab_server_modify.py} +24 -24
  38. flywheel/models/{workspace_origin.py → jupyterlab_server_origin.py} +1 -1
  39. flywheel/models/{workspace_output.py → jupyterlab_server_output.py} +2 -2
  40. flywheel/models/{workspace_response.py → jupyterlab_server_response.py} +44 -44
  41. flywheel/models/{workspace_update.py → jupyterlab_server_update.py} +2 -2
  42. flywheel/models/local_storage.py +1 -1
  43. flywheel/models/mixins.py +10 -4
  44. flywheel/models/move_conflict.py +298 -0
  45. flywheel/models/s3_compat_storage.py +1 -1
  46. flywheel/models/site_settings.py +1 -1
  47. flywheel/models/static_compute.py +1 -1
  48. {flywheel_sdk-18.3.0rc0.dist-info → flywheel_sdk-18.4.0rc0.dist-info}/METADATA +2 -2
  49. {flywheel_sdk-18.3.0rc0.dist-info → flywheel_sdk-18.4.0rc0.dist-info}/RECORD +52 -51
  50. {flywheel_sdk-18.3.0rc0.dist-info → flywheel_sdk-18.4.0rc0.dist-info}/LICENSE.txt +0 -0
  51. {flywheel_sdk-18.3.0rc0.dist-info → flywheel_sdk-18.4.0rc0.dist-info}/WHEEL +0 -0
  52. {flywheel_sdk-18.3.0rc0.dist-info → flywheel_sdk-18.4.0rc0.dist-info}/top_level.txt +0 -0
@@ -20,7 +20,7 @@ import six
20
20
 
21
21
  from flywheel.models.origin import Origin # noqa: F401,E501
22
22
 
23
- class WorkspaceModify(object):
23
+ class JupyterlabServerModify(object):
24
24
 
25
25
  swagger_types = {
26
26
  'label': 'str',
@@ -47,8 +47,8 @@ class WorkspaceModify(object):
47
47
  }
48
48
 
49
49
  def __init__(self, label=None, last_modified_by=None, deleted=None, external_storage_id=None, latest_version=None): # noqa: E501
50
- """WorkspaceModify - a model defined in Swagger"""
51
- super(WorkspaceModify, self).__init__()
50
+ """JupyterlabServerModify - a model defined in Swagger"""
51
+ super(JupyterlabServerModify, self).__init__()
52
52
 
53
53
  self._label = None
54
54
  self._last_modified_by = None
@@ -71,20 +71,20 @@ class WorkspaceModify(object):
71
71
 
72
72
  @property
73
73
  def label(self):
74
- """Gets the label of this WorkspaceModify.
74
+ """Gets the label of this JupyterlabServerModify.
75
75
 
76
76
 
77
- :return: The label of this WorkspaceModify.
77
+ :return: The label of this JupyterlabServerModify.
78
78
  :rtype: str
79
79
  """
80
80
  return self._label
81
81
 
82
82
  @label.setter
83
83
  def label(self, label):
84
- """Sets the label of this WorkspaceModify.
84
+ """Sets the label of this JupyterlabServerModify.
85
85
 
86
86
 
87
- :param label: The label of this WorkspaceModify. # noqa: E501
87
+ :param label: The label of this JupyterlabServerModify. # noqa: E501
88
88
  :type: str
89
89
  """
90
90
 
@@ -92,20 +92,20 @@ class WorkspaceModify(object):
92
92
 
93
93
  @property
94
94
  def last_modified_by(self):
95
- """Gets the last_modified_by of this WorkspaceModify.
95
+ """Gets the last_modified_by of this JupyterlabServerModify.
96
96
 
97
97
 
98
- :return: The last_modified_by of this WorkspaceModify.
98
+ :return: The last_modified_by of this JupyterlabServerModify.
99
99
  :rtype: Origin
100
100
  """
101
101
  return self._last_modified_by
102
102
 
103
103
  @last_modified_by.setter
104
104
  def last_modified_by(self, last_modified_by):
105
- """Sets the last_modified_by of this WorkspaceModify.
105
+ """Sets the last_modified_by of this JupyterlabServerModify.
106
106
 
107
107
 
108
- :param last_modified_by: The last_modified_by of this WorkspaceModify. # noqa: E501
108
+ :param last_modified_by: The last_modified_by of this JupyterlabServerModify. # noqa: E501
109
109
  :type: Origin
110
110
  """
111
111
 
@@ -113,20 +113,20 @@ class WorkspaceModify(object):
113
113
 
114
114
  @property
115
115
  def deleted(self):
116
- """Gets the deleted of this WorkspaceModify.
116
+ """Gets the deleted of this JupyterlabServerModify.
117
117
 
118
118
 
119
- :return: The deleted of this WorkspaceModify.
119
+ :return: The deleted of this JupyterlabServerModify.
120
120
  :rtype: datetime
121
121
  """
122
122
  return self._deleted
123
123
 
124
124
  @deleted.setter
125
125
  def deleted(self, deleted):
126
- """Sets the deleted of this WorkspaceModify.
126
+ """Sets the deleted of this JupyterlabServerModify.
127
127
 
128
128
 
129
- :param deleted: The deleted of this WorkspaceModify. # noqa: E501
129
+ :param deleted: The deleted of this JupyterlabServerModify. # noqa: E501
130
130
  :type: datetime
131
131
  """
132
132
 
@@ -134,20 +134,20 @@ class WorkspaceModify(object):
134
134
 
135
135
  @property
136
136
  def external_storage_id(self):
137
- """Gets the external_storage_id of this WorkspaceModify.
137
+ """Gets the external_storage_id of this JupyterlabServerModify.
138
138
 
139
139
 
140
- :return: The external_storage_id of this WorkspaceModify.
140
+ :return: The external_storage_id of this JupyterlabServerModify.
141
141
  :rtype: str
142
142
  """
143
143
  return self._external_storage_id
144
144
 
145
145
  @external_storage_id.setter
146
146
  def external_storage_id(self, external_storage_id):
147
- """Sets the external_storage_id of this WorkspaceModify.
147
+ """Sets the external_storage_id of this JupyterlabServerModify.
148
148
 
149
149
 
150
- :param external_storage_id: The external_storage_id of this WorkspaceModify. # noqa: E501
150
+ :param external_storage_id: The external_storage_id of this JupyterlabServerModify. # noqa: E501
151
151
  :type: str
152
152
  """
153
153
 
@@ -155,20 +155,20 @@ class WorkspaceModify(object):
155
155
 
156
156
  @property
157
157
  def latest_version(self):
158
- """Gets the latest_version of this WorkspaceModify.
158
+ """Gets the latest_version of this JupyterlabServerModify.
159
159
 
160
160
 
161
- :return: The latest_version of this WorkspaceModify.
161
+ :return: The latest_version of this JupyterlabServerModify.
162
162
  :rtype: int
163
163
  """
164
164
  return self._latest_version
165
165
 
166
166
  @latest_version.setter
167
167
  def latest_version(self, latest_version):
168
- """Sets the latest_version of this WorkspaceModify.
168
+ """Sets the latest_version of this JupyterlabServerModify.
169
169
 
170
170
 
171
- :param latest_version: The latest_version of this WorkspaceModify. # noqa: E501
171
+ :param latest_version: The latest_version of this JupyterlabServerModify. # noqa: E501
172
172
  :type: int
173
173
  """
174
174
 
@@ -218,7 +218,7 @@ class WorkspaceModify(object):
218
218
 
219
219
  def __eq__(self, other):
220
220
  """Returns true if both objects are equal"""
221
- if not isinstance(other, WorkspaceModify):
221
+ if not isinstance(other, JupyterlabServerModify):
222
222
  return False
223
223
 
224
224
  return self.__dict__ == other.__dict__
@@ -21,4 +21,4 @@ import six
21
21
 
22
22
  from flywheel.models.origin import Origin
23
23
 
24
- WorkspaceOrigin = Origin
24
+ JupyterlabServerOrigin = Origin
@@ -19,6 +19,6 @@ import re # noqa: F401
19
19
  import six
20
20
 
21
21
 
22
- from flywheel.models.workspace_response import WorkspaceResponse
22
+ from flywheel.models.jupyterlab_server_response import JupyterlabServerResponse
23
23
 
24
- WorkspaceOutput = WorkspaceResponse
24
+ JupyterlabServerOutput = JupyterlabServerResponse
@@ -21,7 +21,7 @@ import six
21
21
  from flywheel.models.origin import Origin # noqa: F401,E501
22
22
  from flywheel.models.server_state import ServerState # noqa: F401,E501
23
23
 
24
- class WorkspaceResponse(object):
24
+ class JupyterlabServerResponse(object):
25
25
 
26
26
  swagger_types = {
27
27
  'id': 'str',
@@ -63,8 +63,8 @@ class WorkspaceResponse(object):
63
63
  }
64
64
 
65
65
  def __init__(self, id=None, project_id=None, label=None, created=None, modified=None, last_modified_by=None, origin=None, server_state=None, external_storage_id=None, latest_version=None): # noqa: E501
66
- """WorkspaceResponse - a model defined in Swagger"""
67
- super(WorkspaceResponse, self).__init__()
66
+ """JupyterlabServerResponse - a model defined in Swagger"""
67
+ super(JupyterlabServerResponse, self).__init__()
68
68
 
69
69
  self._id = None
70
70
  self._project_id = None
@@ -100,22 +100,22 @@ class WorkspaceResponse(object):
100
100
 
101
101
  @property
102
102
  def id(self):
103
- """Gets the id of this WorkspaceResponse.
103
+ """Gets the id of this JupyterlabServerResponse.
104
104
 
105
105
  Unique database ID
106
106
 
107
- :return: The id of this WorkspaceResponse.
107
+ :return: The id of this JupyterlabServerResponse.
108
108
  :rtype: str
109
109
  """
110
110
  return self._id
111
111
 
112
112
  @id.setter
113
113
  def id(self, id):
114
- """Sets the id of this WorkspaceResponse.
114
+ """Sets the id of this JupyterlabServerResponse.
115
115
 
116
116
  Unique database ID
117
117
 
118
- :param id: The id of this WorkspaceResponse. # noqa: E501
118
+ :param id: The id of this JupyterlabServerResponse. # noqa: E501
119
119
  :type: str
120
120
  """
121
121
 
@@ -123,22 +123,22 @@ class WorkspaceResponse(object):
123
123
 
124
124
  @property
125
125
  def project_id(self):
126
- """Gets the project_id of this WorkspaceResponse.
126
+ """Gets the project_id of this JupyterlabServerResponse.
127
127
 
128
128
  Unique database ID
129
129
 
130
- :return: The project_id of this WorkspaceResponse.
130
+ :return: The project_id of this JupyterlabServerResponse.
131
131
  :rtype: str
132
132
  """
133
133
  return self._project_id
134
134
 
135
135
  @project_id.setter
136
136
  def project_id(self, project_id):
137
- """Sets the project_id of this WorkspaceResponse.
137
+ """Sets the project_id of this JupyterlabServerResponse.
138
138
 
139
139
  Unique database ID
140
140
 
141
- :param project_id: The project_id of this WorkspaceResponse. # noqa: E501
141
+ :param project_id: The project_id of this JupyterlabServerResponse. # noqa: E501
142
142
  :type: str
143
143
  """
144
144
 
@@ -146,20 +146,20 @@ class WorkspaceResponse(object):
146
146
 
147
147
  @property
148
148
  def label(self):
149
- """Gets the label of this WorkspaceResponse.
149
+ """Gets the label of this JupyterlabServerResponse.
150
150
 
151
151
 
152
- :return: The label of this WorkspaceResponse.
152
+ :return: The label of this JupyterlabServerResponse.
153
153
  :rtype: str
154
154
  """
155
155
  return self._label
156
156
 
157
157
  @label.setter
158
158
  def label(self, label):
159
- """Sets the label of this WorkspaceResponse.
159
+ """Sets the label of this JupyterlabServerResponse.
160
160
 
161
161
 
162
- :param label: The label of this WorkspaceResponse. # noqa: E501
162
+ :param label: The label of this JupyterlabServerResponse. # noqa: E501
163
163
  :type: str
164
164
  """
165
165
 
@@ -167,22 +167,22 @@ class WorkspaceResponse(object):
167
167
 
168
168
  @property
169
169
  def created(self):
170
- """Gets the created of this WorkspaceResponse.
170
+ """Gets the created of this JupyterlabServerResponse.
171
171
 
172
172
  Creation time (automatically set)
173
173
 
174
- :return: The created of this WorkspaceResponse.
174
+ :return: The created of this JupyterlabServerResponse.
175
175
  :rtype: datetime
176
176
  """
177
177
  return self._created
178
178
 
179
179
  @created.setter
180
180
  def created(self, created):
181
- """Sets the created of this WorkspaceResponse.
181
+ """Sets the created of this JupyterlabServerResponse.
182
182
 
183
183
  Creation time (automatically set)
184
184
 
185
- :param created: The created of this WorkspaceResponse. # noqa: E501
185
+ :param created: The created of this JupyterlabServerResponse. # noqa: E501
186
186
  :type: datetime
187
187
  """
188
188
 
@@ -190,22 +190,22 @@ class WorkspaceResponse(object):
190
190
 
191
191
  @property
192
192
  def modified(self):
193
- """Gets the modified of this WorkspaceResponse.
193
+ """Gets the modified of this JupyterlabServerResponse.
194
194
 
195
195
  Last modification time (automatically updated)
196
196
 
197
- :return: The modified of this WorkspaceResponse.
197
+ :return: The modified of this JupyterlabServerResponse.
198
198
  :rtype: datetime
199
199
  """
200
200
  return self._modified
201
201
 
202
202
  @modified.setter
203
203
  def modified(self, modified):
204
- """Sets the modified of this WorkspaceResponse.
204
+ """Sets the modified of this JupyterlabServerResponse.
205
205
 
206
206
  Last modification time (automatically updated)
207
207
 
208
- :param modified: The modified of this WorkspaceResponse. # noqa: E501
208
+ :param modified: The modified of this JupyterlabServerResponse. # noqa: E501
209
209
  :type: datetime
210
210
  """
211
211
 
@@ -213,20 +213,20 @@ class WorkspaceResponse(object):
213
213
 
214
214
  @property
215
215
  def last_modified_by(self):
216
- """Gets the last_modified_by of this WorkspaceResponse.
216
+ """Gets the last_modified_by of this JupyterlabServerResponse.
217
217
 
218
218
 
219
- :return: The last_modified_by of this WorkspaceResponse.
219
+ :return: The last_modified_by of this JupyterlabServerResponse.
220
220
  :rtype: Origin
221
221
  """
222
222
  return self._last_modified_by
223
223
 
224
224
  @last_modified_by.setter
225
225
  def last_modified_by(self, last_modified_by):
226
- """Sets the last_modified_by of this WorkspaceResponse.
226
+ """Sets the last_modified_by of this JupyterlabServerResponse.
227
227
 
228
228
 
229
- :param last_modified_by: The last_modified_by of this WorkspaceResponse. # noqa: E501
229
+ :param last_modified_by: The last_modified_by of this JupyterlabServerResponse. # noqa: E501
230
230
  :type: Origin
231
231
  """
232
232
 
@@ -234,20 +234,20 @@ class WorkspaceResponse(object):
234
234
 
235
235
  @property
236
236
  def origin(self):
237
- """Gets the origin of this WorkspaceResponse.
237
+ """Gets the origin of this JupyterlabServerResponse.
238
238
 
239
239
 
240
- :return: The origin of this WorkspaceResponse.
240
+ :return: The origin of this JupyterlabServerResponse.
241
241
  :rtype: Origin
242
242
  """
243
243
  return self._origin
244
244
 
245
245
  @origin.setter
246
246
  def origin(self, origin):
247
- """Sets the origin of this WorkspaceResponse.
247
+ """Sets the origin of this JupyterlabServerResponse.
248
248
 
249
249
 
250
- :param origin: The origin of this WorkspaceResponse. # noqa: E501
250
+ :param origin: The origin of this JupyterlabServerResponse. # noqa: E501
251
251
  :type: Origin
252
252
  """
253
253
 
@@ -255,20 +255,20 @@ class WorkspaceResponse(object):
255
255
 
256
256
  @property
257
257
  def server_state(self):
258
- """Gets the server_state of this WorkspaceResponse.
258
+ """Gets the server_state of this JupyterlabServerResponse.
259
259
 
260
260
 
261
- :return: The server_state of this WorkspaceResponse.
261
+ :return: The server_state of this JupyterlabServerResponse.
262
262
  :rtype: ServerState
263
263
  """
264
264
  return self._server_state
265
265
 
266
266
  @server_state.setter
267
267
  def server_state(self, server_state):
268
- """Sets the server_state of this WorkspaceResponse.
268
+ """Sets the server_state of this JupyterlabServerResponse.
269
269
 
270
270
 
271
- :param server_state: The server_state of this WorkspaceResponse. # noqa: E501
271
+ :param server_state: The server_state of this JupyterlabServerResponse. # noqa: E501
272
272
  :type: ServerState
273
273
  """
274
274
 
@@ -276,20 +276,20 @@ class WorkspaceResponse(object):
276
276
 
277
277
  @property
278
278
  def external_storage_id(self):
279
- """Gets the external_storage_id of this WorkspaceResponse.
279
+ """Gets the external_storage_id of this JupyterlabServerResponse.
280
280
 
281
281
 
282
- :return: The external_storage_id of this WorkspaceResponse.
282
+ :return: The external_storage_id of this JupyterlabServerResponse.
283
283
  :rtype: str
284
284
  """
285
285
  return self._external_storage_id
286
286
 
287
287
  @external_storage_id.setter
288
288
  def external_storage_id(self, external_storage_id):
289
- """Sets the external_storage_id of this WorkspaceResponse.
289
+ """Sets the external_storage_id of this JupyterlabServerResponse.
290
290
 
291
291
 
292
- :param external_storage_id: The external_storage_id of this WorkspaceResponse. # noqa: E501
292
+ :param external_storage_id: The external_storage_id of this JupyterlabServerResponse. # noqa: E501
293
293
  :type: str
294
294
  """
295
295
 
@@ -297,20 +297,20 @@ class WorkspaceResponse(object):
297
297
 
298
298
  @property
299
299
  def latest_version(self):
300
- """Gets the latest_version of this WorkspaceResponse.
300
+ """Gets the latest_version of this JupyterlabServerResponse.
301
301
 
302
302
 
303
- :return: The latest_version of this WorkspaceResponse.
303
+ :return: The latest_version of this JupyterlabServerResponse.
304
304
  :rtype: int
305
305
  """
306
306
  return self._latest_version
307
307
 
308
308
  @latest_version.setter
309
309
  def latest_version(self, latest_version):
310
- """Sets the latest_version of this WorkspaceResponse.
310
+ """Sets the latest_version of this JupyterlabServerResponse.
311
311
 
312
312
 
313
- :param latest_version: The latest_version of this WorkspaceResponse. # noqa: E501
313
+ :param latest_version: The latest_version of this JupyterlabServerResponse. # noqa: E501
314
314
  :type: int
315
315
  """
316
316
 
@@ -360,7 +360,7 @@ class WorkspaceResponse(object):
360
360
 
361
361
  def __eq__(self, other):
362
362
  """Returns true if both objects are equal"""
363
- if not isinstance(other, WorkspaceResponse):
363
+ if not isinstance(other, JupyterlabServerResponse):
364
364
  return False
365
365
 
366
366
  return self.__dict__ == other.__dict__
@@ -19,6 +19,6 @@ import re # noqa: F401
19
19
  import six
20
20
 
21
21
 
22
- from flywheel.models.workspace_modify import WorkspaceModify
22
+ from flywheel.models.jupyterlab_server_modify import JupyterlabServerModify
23
23
 
24
- WorkspaceUpdate = WorkspaceModify
24
+ JupyterlabServerUpdate = JupyterlabServerModify
@@ -38,7 +38,7 @@ class LocalStorage(object):
38
38
  'config_class': 'config_class'
39
39
  }
40
40
 
41
- def __init__(self, path=None, config_type=None, config_class=None): # noqa: E501
41
+ def __init__(self, path=None, config_type='local', config_class='storage'): # noqa: E501
42
42
  """LocalStorage - a model defined in Swagger"""
43
43
  super(LocalStorage, self).__init__()
44
44
 
flywheel/models/mixins.py CHANGED
@@ -380,13 +380,13 @@ class GroupMixin(ContainerBase, TagMethods, PermissionMethods):
380
380
  def add_permission_template(self, permission, **kwargs):
381
381
  """Add a permission template for a group"""
382
382
  return self._invoke_container_api(
383
- "add_group_permission_template", self.id, permission, kwargs
383
+ "add_group_permission_template", self.id, permission, **kwargs
384
384
  )
385
385
 
386
386
  def get_permission_template(self, user_id, **kwargs):
387
387
  """Get a user's permission template for a group"""
388
388
  return self._invoke_container_api(
389
- "get_group_user_permission_template", self.id, user_id, permission, kwargs
389
+ "get_group_user_permission_template", self.id, user_id, **kwargs
390
390
  )
391
391
 
392
392
  def update_permission_template(self, user_id, permission, **kwargs):
@@ -396,13 +396,13 @@ class GroupMixin(ContainerBase, TagMethods, PermissionMethods):
396
396
  self.id,
397
397
  user_id,
398
398
  permission,
399
- kwargs,
399
+ **kwargs,
400
400
  )
401
401
 
402
402
  def delete_permission_template(self, user_id, **kwargs):
403
403
  """Delete a user's permission template from a group"""
404
404
  return self._invoke_container_api(
405
- "delete_group_user_permission_template", self.id, user_id, kwargs
405
+ "delete_group_user_permission_template", self.id, user_id, **kwargs
406
406
  )
407
407
 
408
408
 
@@ -521,6 +521,12 @@ class AnalysisMixin(
521
521
  def upload_output(self, file, **kwargs):
522
522
  """Upload an output file to analysis"""
523
523
  return self._invoke_container_api("upload_output_to_analysis", self.id, file, **kwargs)
524
+
525
+ def update_file_info(self, file_name, *args, **kwargs):
526
+ """Update the file's info with the passed in arguments"""
527
+ body = util.params_to_dict("update_file_info", args, kwargs)
528
+ # don't have analysis file methods in SDK yet, so use generic container method
529
+ return self._invoke_container_api("set_container_file_info", self.id, file_name, body)
524
530
 
525
531
 
526
532
  class CollectionMixin(ContainerBase, NoteMethods, TagMethods, FileMethods, InfoMethods):