wds-client 0.7.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. wds_client/__init__.py +8 -10
  2. wds_client/api/__init__.py +1 -2
  3. wds_client/api/capabilities_api.py +237 -102
  4. wds_client/api/cloning_api.py +782 -329
  5. wds_client/api/general_wds_information_api.py +463 -191
  6. wds_client/api/import_api.py +288 -127
  7. wds_client/api/instances_api.py +783 -333
  8. wds_client/api/job_api.py +518 -215
  9. wds_client/api/records_api.py +2512 -1089
  10. wds_client/api/schema_api.py +1450 -626
  11. wds_client/api_client.py +414 -310
  12. wds_client/api_response.py +21 -0
  13. wds_client/configuration.py +110 -53
  14. wds_client/exceptions.py +99 -20
  15. wds_client/models/__init__.py +4 -8
  16. wds_client/models/app.py +68 -125
  17. wds_client/models/attribute_data_type.py +31 -94
  18. wds_client/models/attribute_schema.py +71 -157
  19. wds_client/models/attribute_schema_update.py +69 -127
  20. wds_client/models/backup_job.py +96 -298
  21. wds_client/models/backup_response.py +70 -157
  22. wds_client/models/backup_restore_request.py +68 -129
  23. wds_client/models/batch_operation.py +83 -137
  24. wds_client/models/batch_record_request.py +70 -160
  25. wds_client/models/batch_response.py +68 -127
  26. wds_client/models/build.py +79 -207
  27. wds_client/models/capabilities.py +83 -103
  28. wds_client/models/clone_job.py +96 -298
  29. wds_client/models/clone_response.py +68 -129
  30. wds_client/models/commit.py +69 -125
  31. wds_client/models/error_response.py +78 -222
  32. wds_client/models/generic_job.py +102 -334
  33. wds_client/models/git.py +76 -129
  34. wds_client/models/import_request.py +77 -165
  35. wds_client/models/job.py +87 -243
  36. wds_client/models/job_v1.py +97 -277
  37. wds_client/models/record_query_response.py +86 -162
  38. wds_client/models/record_request.py +60 -96
  39. wds_client/models/record_response.py +70 -160
  40. wds_client/models/record_type_schema.py +84 -191
  41. wds_client/models/search_filter.py +60 -95
  42. wds_client/models/search_request.py +84 -220
  43. wds_client/models/search_sort_direction.py +17 -80
  44. wds_client/models/status_response.py +68 -125
  45. wds_client/models/tsv_upload_response.py +68 -127
  46. wds_client/models/version_response.py +86 -155
  47. wds_client/py.typed +0 -0
  48. wds_client/rest.py +136 -170
  49. wds_client-0.8.0.dist-info/METADATA +17 -0
  50. wds_client-0.8.0.dist-info/RECORD +52 -0
  51. wds_client/models/backup_job_all_of.py +0 -148
  52. wds_client/models/clone_job_all_of.py +0 -148
  53. wds_client/models/generic_job_all_of.py +0 -150
  54. wds_client/models/inline_object.py +0 -123
  55. wds_client-0.7.0.dist-info/METADATA +0 -16
  56. wds_client-0.7.0.dist-info/RECORD +0 -54
  57. {wds_client-0.7.0.dist-info → wds_client-0.8.0.dist-info}/WHEEL +0 -0
  58. {wds_client-0.7.0.dist-info → wds_client-0.8.0.dist-info}/top_level.txt +0 -0
@@ -3,395 +3,845 @@
3
3
  """
4
4
  Workspace Data Service
5
5
 
6
- This page lists current APIs. As of v0.2, all APIs are subject to change without notice. # noqa: E501
6
+ This page lists current APIs. All v0.2 APIs are subject to change without notice. Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases)
7
7
 
8
8
  The version of the OpenAPI document: v0.2
9
- Generated by: https://openapi-generator.tech
10
- """
11
-
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
12
10
 
13
- from __future__ import absolute_import
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
14
13
 
15
- import re # noqa: F401
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
16
18
 
17
- # python 2 and python 3 compatibility library
18
- import six
19
+ from pydantic import Field, StrictStr
20
+ from typing import List
21
+ from typing_extensions import Annotated
19
22
 
20
- from wds_client.api_client import ApiClient
21
- from wds_client.exceptions import ( # noqa: F401
22
- ApiTypeError,
23
- ApiValueError
24
- )
23
+ from wds_client.api_client import ApiClient, RequestSerialized
24
+ from wds_client.api_response import ApiResponse
25
+ from wds_client.rest import RESTResponseType
25
26
 
26
27
 
27
- class InstancesApi(object):
28
+ class InstancesApi:
28
29
  """NOTE: This class is auto generated by OpenAPI Generator
29
30
  Ref: https://openapi-generator.tech
30
31
 
31
32
  Do not edit the class manually.
32
33
  """
33
34
 
34
- def __init__(self, api_client=None):
35
+ def __init__(self, api_client=None) -> None:
35
36
  if api_client is None:
36
- api_client = ApiClient()
37
+ api_client = ApiClient.get_default()
37
38
  self.api_client = api_client
38
39
 
39
- def create_wds_instance(self, instanceid, v, **kwargs): # noqa: E501
40
- """Create an instance # noqa: E501
41
-
42
- Create an instance with the given UUID. # noqa: E501
43
- This method makes a synchronous HTTP request by default. To make an
44
- asynchronous HTTP request, please pass async_req=True
45
- >>> thread = api.create_wds_instance(instanceid, v, async_req=True)
46
- >>> result = thread.get()
47
-
48
- :param async_req bool: execute request asynchronously
49
- :param str instanceid: WDS instance id; by convention equal to workspace id (required)
50
- :param str v: API version (required)
51
- :param _preload_content: if False, the urllib3.HTTPResponse object will
52
- be returned without reading/decoding response
53
- data. Default is True.
40
+
41
+ @validate_call
42
+ def create_wds_instance(
43
+ self,
44
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
45
+ v: Annotated[StrictStr, Field(description="API version")],
46
+ _request_timeout: Union[
47
+ None,
48
+ Annotated[StrictFloat, Field(gt=0)],
49
+ Tuple[
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Annotated[StrictFloat, Field(gt=0)]
52
+ ]
53
+ ] = None,
54
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
55
+ _content_type: Optional[StrictStr] = None,
56
+ _headers: Optional[Dict[StrictStr, Any]] = None,
57
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
58
+ ) -> None:
59
+ """Create an instance
60
+
61
+ Create an instance with the given UUID.
62
+
63
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
64
+ :type instanceid: str
65
+ :param v: API version (required)
66
+ :type v: str
54
67
  :param _request_timeout: timeout setting for this request. If one
55
68
  number provided, it will be total request
56
69
  timeout. It can also be a pair (tuple) of
57
70
  (connection, read) timeouts.
58
- :return: None
59
- If the method is called asynchronously,
60
- returns the request thread.
61
- """
62
- kwargs['_return_http_data_only'] = True
63
- return self.create_wds_instance_with_http_info(instanceid, v, **kwargs) # noqa: E501
64
-
65
- def create_wds_instance_with_http_info(self, instanceid, v, **kwargs): # noqa: E501
66
- """Create an instance # noqa: E501
67
-
68
- Create an instance with the given UUID. # noqa: E501
69
- This method makes a synchronous HTTP request by default. To make an
70
- asynchronous HTTP request, please pass async_req=True
71
- >>> thread = api.create_wds_instance_with_http_info(instanceid, v, async_req=True)
72
- >>> result = thread.get()
73
-
74
- :param async_req bool: execute request asynchronously
75
- :param str instanceid: WDS instance id; by convention equal to workspace id (required)
76
- :param str v: API version (required)
77
- :param _return_http_data_only: response data without head status code
78
- and headers
79
- :param _preload_content: if False, the urllib3.HTTPResponse object will
80
- be returned without reading/decoding response
81
- data. Default is True.
71
+ :type _request_timeout: int, tuple(int, int), optional
72
+ :param _request_auth: set to override the auth_settings for an a single
73
+ request; this effectively ignores the
74
+ authentication in the spec for a single request.
75
+ :type _request_auth: dict, optional
76
+ :param _content_type: force content-type for the request.
77
+ :type _content_type: str, Optional
78
+ :param _headers: set to override the headers for a single
79
+ request; this effectively ignores the headers
80
+ in the spec for a single request.
81
+ :type _headers: dict, optional
82
+ :param _host_index: set to override the host_index for a single
83
+ request; this effectively ignores the host_index
84
+ in the spec for a single request.
85
+ :type _host_index: int, optional
86
+ :return: Returns the result object.
87
+ """ # noqa: E501
88
+
89
+ _param = self._create_wds_instance_serialize(
90
+ instanceid=instanceid,
91
+ v=v,
92
+ _request_auth=_request_auth,
93
+ _content_type=_content_type,
94
+ _headers=_headers,
95
+ _host_index=_host_index
96
+ )
97
+
98
+ _response_types_map: Dict[str, Optional[str]] = {
99
+ '201': None,
100
+ '409': "ErrorResponse",
101
+ }
102
+ response_data = self.api_client.call_api(
103
+ *_param,
104
+ _request_timeout=_request_timeout
105
+ )
106
+ response_data.read()
107
+ return self.api_client.response_deserialize(
108
+ response_data=response_data,
109
+ response_types_map=_response_types_map,
110
+ ).data
111
+
112
+
113
+ @validate_call
114
+ def create_wds_instance_with_http_info(
115
+ self,
116
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
117
+ v: Annotated[StrictStr, Field(description="API version")],
118
+ _request_timeout: Union[
119
+ None,
120
+ Annotated[StrictFloat, Field(gt=0)],
121
+ Tuple[
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Annotated[StrictFloat, Field(gt=0)]
124
+ ]
125
+ ] = None,
126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
127
+ _content_type: Optional[StrictStr] = None,
128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
+ ) -> ApiResponse[None]:
131
+ """Create an instance
132
+
133
+ Create an instance with the given UUID.
134
+
135
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
136
+ :type instanceid: str
137
+ :param v: API version (required)
138
+ :type v: str
82
139
  :param _request_timeout: timeout setting for this request. If one
83
140
  number provided, it will be total request
84
141
  timeout. It can also be a pair (tuple) of
85
142
  (connection, read) timeouts.
86
- :return: None
87
- If the method is called asynchronously,
88
- returns the request thread.
89
- """
143
+ :type _request_timeout: int, tuple(int, int), optional
144
+ :param _request_auth: set to override the auth_settings for an a single
145
+ request; this effectively ignores the
146
+ authentication in the spec for a single request.
147
+ :type _request_auth: dict, optional
148
+ :param _content_type: force content-type for the request.
149
+ :type _content_type: str, Optional
150
+ :param _headers: set to override the headers for a single
151
+ request; this effectively ignores the headers
152
+ in the spec for a single request.
153
+ :type _headers: dict, optional
154
+ :param _host_index: set to override the host_index for a single
155
+ request; this effectively ignores the host_index
156
+ in the spec for a single request.
157
+ :type _host_index: int, optional
158
+ :return: Returns the result object.
159
+ """ # noqa: E501
160
+
161
+ _param = self._create_wds_instance_serialize(
162
+ instanceid=instanceid,
163
+ v=v,
164
+ _request_auth=_request_auth,
165
+ _content_type=_content_type,
166
+ _headers=_headers,
167
+ _host_index=_host_index
168
+ )
169
+
170
+ _response_types_map: Dict[str, Optional[str]] = {
171
+ '201': None,
172
+ '409': "ErrorResponse",
173
+ }
174
+ response_data = self.api_client.call_api(
175
+ *_param,
176
+ _request_timeout=_request_timeout
177
+ )
178
+ response_data.read()
179
+ return self.api_client.response_deserialize(
180
+ response_data=response_data,
181
+ response_types_map=_response_types_map,
182
+ )
90
183
 
91
- local_var_params = locals()
92
184
 
93
- all_params = [
94
- 'instanceid',
95
- 'v'
96
- ]
97
- all_params.extend(
185
+ @validate_call
186
+ def create_wds_instance_without_preload_content(
187
+ self,
188
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
189
+ v: Annotated[StrictStr, Field(description="API version")],
190
+ _request_timeout: Union[
191
+ None,
192
+ Annotated[StrictFloat, Field(gt=0)],
193
+ Tuple[
194
+ Annotated[StrictFloat, Field(gt=0)],
195
+ Annotated[StrictFloat, Field(gt=0)]
196
+ ]
197
+ ] = None,
198
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
199
+ _content_type: Optional[StrictStr] = None,
200
+ _headers: Optional[Dict[StrictStr, Any]] = None,
201
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
202
+ ) -> RESTResponseType:
203
+ """Create an instance
204
+
205
+ Create an instance with the given UUID.
206
+
207
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
208
+ :type instanceid: str
209
+ :param v: API version (required)
210
+ :type v: str
211
+ :param _request_timeout: timeout setting for this request. If one
212
+ number provided, it will be total request
213
+ timeout. It can also be a pair (tuple) of
214
+ (connection, read) timeouts.
215
+ :type _request_timeout: int, tuple(int, int), optional
216
+ :param _request_auth: set to override the auth_settings for an a single
217
+ request; this effectively ignores the
218
+ authentication in the spec for a single request.
219
+ :type _request_auth: dict, optional
220
+ :param _content_type: force content-type for the request.
221
+ :type _content_type: str, Optional
222
+ :param _headers: set to override the headers for a single
223
+ request; this effectively ignores the headers
224
+ in the spec for a single request.
225
+ :type _headers: dict, optional
226
+ :param _host_index: set to override the host_index for a single
227
+ request; this effectively ignores the host_index
228
+ in the spec for a single request.
229
+ :type _host_index: int, optional
230
+ :return: Returns the result object.
231
+ """ # noqa: E501
232
+
233
+ _param = self._create_wds_instance_serialize(
234
+ instanceid=instanceid,
235
+ v=v,
236
+ _request_auth=_request_auth,
237
+ _content_type=_content_type,
238
+ _headers=_headers,
239
+ _host_index=_host_index
240
+ )
241
+
242
+ _response_types_map: Dict[str, Optional[str]] = {
243
+ '201': None,
244
+ '409': "ErrorResponse",
245
+ }
246
+ response_data = self.api_client.call_api(
247
+ *_param,
248
+ _request_timeout=_request_timeout
249
+ )
250
+ return response_data.response
251
+
252
+
253
+ def _create_wds_instance_serialize(
254
+ self,
255
+ instanceid,
256
+ v,
257
+ _request_auth,
258
+ _content_type,
259
+ _headers,
260
+ _host_index,
261
+ ) -> RequestSerialized:
262
+
263
+ _host = None
264
+
265
+ _collection_formats: Dict[str, str] = {
266
+ }
267
+
268
+ _path_params: Dict[str, str] = {}
269
+ _query_params: List[Tuple[str, str]] = []
270
+ _header_params: Dict[str, Optional[str]] = _headers or {}
271
+ _form_params: List[Tuple[str, str]] = []
272
+ _files: Dict[str, Union[str, bytes]] = {}
273
+ _body_params: Optional[bytes] = None
274
+
275
+ # process the path parameters
276
+ if instanceid is not None:
277
+ _path_params['instanceid'] = instanceid
278
+ if v is not None:
279
+ _path_params['v'] = v
280
+ # process the query parameters
281
+ # process the header parameters
282
+ # process the form parameters
283
+ # process the body parameter
284
+
285
+
286
+ # set the HTTP header `Accept`
287
+ _header_params['Accept'] = self.api_client.select_header_accept(
98
288
  [
99
- 'async_req',
100
- '_return_http_data_only',
101
- '_preload_content',
102
- '_request_timeout'
289
+ 'application/json'
103
290
  ]
104
291
  )
105
292
 
106
- for key, val in six.iteritems(local_var_params['kwargs']):
107
- if key not in all_params:
108
- raise ApiTypeError(
109
- "Got an unexpected keyword argument '%s'"
110
- " to method create_wds_instance" % key
111
- )
112
- local_var_params[key] = val
113
- del local_var_params['kwargs']
114
- # verify the required parameter 'instanceid' is set
115
- if self.api_client.client_side_validation and ('instanceid' not in local_var_params or # noqa: E501
116
- local_var_params['instanceid'] is None): # noqa: E501
117
- raise ApiValueError("Missing the required parameter `instanceid` when calling `create_wds_instance`") # noqa: E501
118
- # verify the required parameter 'v' is set
119
- if self.api_client.client_side_validation and ('v' not in local_var_params or # noqa: E501
120
- local_var_params['v'] is None): # noqa: E501
121
- raise ApiValueError("Missing the required parameter `v` when calling `create_wds_instance`") # noqa: E501
122
-
123
- collection_formats = {}
124
-
125
- path_params = {}
126
- if 'instanceid' in local_var_params:
127
- path_params['instanceid'] = local_var_params['instanceid'] # noqa: E501
128
- if 'v' in local_var_params:
129
- path_params['v'] = local_var_params['v'] # noqa: E501
130
-
131
- query_params = []
132
-
133
- header_params = {}
134
-
135
- form_params = []
136
- local_var_files = {}
137
-
138
- body_params = None
139
- # HTTP header `Accept`
140
- header_params['Accept'] = self.api_client.select_header_accept(
141
- ['application/json']) # noqa: E501
142
-
143
- # Authentication setting
144
- auth_settings = ['bearerAuth'] # noqa: E501
145
-
146
- return self.api_client.call_api(
147
- '/instances/{v}/{instanceid}', 'POST',
148
- path_params,
149
- query_params,
150
- header_params,
151
- body=body_params,
152
- post_params=form_params,
153
- files=local_var_files,
154
- response_type=None, # noqa: E501
155
- auth_settings=auth_settings,
156
- async_req=local_var_params.get('async_req'),
157
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
158
- _preload_content=local_var_params.get('_preload_content', True),
159
- _request_timeout=local_var_params.get('_request_timeout'),
160
- collection_formats=collection_formats)
161
-
162
- def delete_wds_instance(self, instanceid, v, **kwargs): # noqa: E501
163
- """Delete an instance # noqa: E501
164
-
165
- Delete the instance with the given UUID. This API is liable to change. THIS WILL DELETE ALL DATA WITHIN THE INSTANCE. Be certain this is what you want to do. # noqa: E501
166
- This method makes a synchronous HTTP request by default. To make an
167
- asynchronous HTTP request, please pass async_req=True
168
- >>> thread = api.delete_wds_instance(instanceid, v, async_req=True)
169
- >>> result = thread.get()
170
-
171
- :param async_req bool: execute request asynchronously
172
- :param str instanceid: WDS instance id; by convention equal to workspace id (required)
173
- :param str v: API version (required)
174
- :param _preload_content: if False, the urllib3.HTTPResponse object will
175
- be returned without reading/decoding response
176
- data. Default is True.
293
+
294
+ # authentication setting
295
+ _auth_settings: List[str] = [
296
+ 'bearerAuth'
297
+ ]
298
+
299
+ return self.api_client.param_serialize(
300
+ method='POST',
301
+ resource_path='/instances/{v}/{instanceid}',
302
+ path_params=_path_params,
303
+ query_params=_query_params,
304
+ header_params=_header_params,
305
+ body=_body_params,
306
+ post_params=_form_params,
307
+ files=_files,
308
+ auth_settings=_auth_settings,
309
+ collection_formats=_collection_formats,
310
+ _host=_host,
311
+ _request_auth=_request_auth
312
+ )
313
+
314
+
315
+
316
+
317
+ @validate_call
318
+ def delete_wds_instance(
319
+ self,
320
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
321
+ v: Annotated[StrictStr, Field(description="API version")],
322
+ _request_timeout: Union[
323
+ None,
324
+ Annotated[StrictFloat, Field(gt=0)],
325
+ Tuple[
326
+ Annotated[StrictFloat, Field(gt=0)],
327
+ Annotated[StrictFloat, Field(gt=0)]
328
+ ]
329
+ ] = None,
330
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
331
+ _content_type: Optional[StrictStr] = None,
332
+ _headers: Optional[Dict[StrictStr, Any]] = None,
333
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
334
+ ) -> None:
335
+ """Delete an instance
336
+
337
+ Delete the instance with the given UUID. This API is liable to change. THIS WILL DELETE ALL DATA WITHIN THE INSTANCE. Be certain this is what you want to do.
338
+
339
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
340
+ :type instanceid: str
341
+ :param v: API version (required)
342
+ :type v: str
177
343
  :param _request_timeout: timeout setting for this request. If one
178
344
  number provided, it will be total request
179
345
  timeout. It can also be a pair (tuple) of
180
346
  (connection, read) timeouts.
181
- :return: None
182
- If the method is called asynchronously,
183
- returns the request thread.
184
- """
185
- kwargs['_return_http_data_only'] = True
186
- return self.delete_wds_instance_with_http_info(instanceid, v, **kwargs) # noqa: E501
187
-
188
- def delete_wds_instance_with_http_info(self, instanceid, v, **kwargs): # noqa: E501
189
- """Delete an instance # noqa: E501
190
-
191
- Delete the instance with the given UUID. This API is liable to change. THIS WILL DELETE ALL DATA WITHIN THE INSTANCE. Be certain this is what you want to do. # noqa: E501
192
- This method makes a synchronous HTTP request by default. To make an
193
- asynchronous HTTP request, please pass async_req=True
194
- >>> thread = api.delete_wds_instance_with_http_info(instanceid, v, async_req=True)
195
- >>> result = thread.get()
196
-
197
- :param async_req bool: execute request asynchronously
198
- :param str instanceid: WDS instance id; by convention equal to workspace id (required)
199
- :param str v: API version (required)
200
- :param _return_http_data_only: response data without head status code
201
- and headers
202
- :param _preload_content: if False, the urllib3.HTTPResponse object will
203
- be returned without reading/decoding response
204
- data. Default is True.
347
+ :type _request_timeout: int, tuple(int, int), optional
348
+ :param _request_auth: set to override the auth_settings for an a single
349
+ request; this effectively ignores the
350
+ authentication in the spec for a single request.
351
+ :type _request_auth: dict, optional
352
+ :param _content_type: force content-type for the request.
353
+ :type _content_type: str, Optional
354
+ :param _headers: set to override the headers for a single
355
+ request; this effectively ignores the headers
356
+ in the spec for a single request.
357
+ :type _headers: dict, optional
358
+ :param _host_index: set to override the host_index for a single
359
+ request; this effectively ignores the host_index
360
+ in the spec for a single request.
361
+ :type _host_index: int, optional
362
+ :return: Returns the result object.
363
+ """ # noqa: E501
364
+
365
+ _param = self._delete_wds_instance_serialize(
366
+ instanceid=instanceid,
367
+ v=v,
368
+ _request_auth=_request_auth,
369
+ _content_type=_content_type,
370
+ _headers=_headers,
371
+ _host_index=_host_index
372
+ )
373
+
374
+ _response_types_map: Dict[str, Optional[str]] = {
375
+ '200': None,
376
+ '404': "ErrorResponse",
377
+ }
378
+ response_data = self.api_client.call_api(
379
+ *_param,
380
+ _request_timeout=_request_timeout
381
+ )
382
+ response_data.read()
383
+ return self.api_client.response_deserialize(
384
+ response_data=response_data,
385
+ response_types_map=_response_types_map,
386
+ ).data
387
+
388
+
389
+ @validate_call
390
+ def delete_wds_instance_with_http_info(
391
+ self,
392
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
393
+ v: Annotated[StrictStr, Field(description="API version")],
394
+ _request_timeout: Union[
395
+ None,
396
+ Annotated[StrictFloat, Field(gt=0)],
397
+ Tuple[
398
+ Annotated[StrictFloat, Field(gt=0)],
399
+ Annotated[StrictFloat, Field(gt=0)]
400
+ ]
401
+ ] = None,
402
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
403
+ _content_type: Optional[StrictStr] = None,
404
+ _headers: Optional[Dict[StrictStr, Any]] = None,
405
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
406
+ ) -> ApiResponse[None]:
407
+ """Delete an instance
408
+
409
+ Delete the instance with the given UUID. This API is liable to change. THIS WILL DELETE ALL DATA WITHIN THE INSTANCE. Be certain this is what you want to do.
410
+
411
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
412
+ :type instanceid: str
413
+ :param v: API version (required)
414
+ :type v: str
205
415
  :param _request_timeout: timeout setting for this request. If one
206
416
  number provided, it will be total request
207
417
  timeout. It can also be a pair (tuple) of
208
418
  (connection, read) timeouts.
209
- :return: None
210
- If the method is called asynchronously,
211
- returns the request thread.
212
- """
419
+ :type _request_timeout: int, tuple(int, int), optional
420
+ :param _request_auth: set to override the auth_settings for an a single
421
+ request; this effectively ignores the
422
+ authentication in the spec for a single request.
423
+ :type _request_auth: dict, optional
424
+ :param _content_type: force content-type for the request.
425
+ :type _content_type: str, Optional
426
+ :param _headers: set to override the headers for a single
427
+ request; this effectively ignores the headers
428
+ in the spec for a single request.
429
+ :type _headers: dict, optional
430
+ :param _host_index: set to override the host_index for a single
431
+ request; this effectively ignores the host_index
432
+ in the spec for a single request.
433
+ :type _host_index: int, optional
434
+ :return: Returns the result object.
435
+ """ # noqa: E501
436
+
437
+ _param = self._delete_wds_instance_serialize(
438
+ instanceid=instanceid,
439
+ v=v,
440
+ _request_auth=_request_auth,
441
+ _content_type=_content_type,
442
+ _headers=_headers,
443
+ _host_index=_host_index
444
+ )
213
445
 
214
- local_var_params = locals()
446
+ _response_types_map: Dict[str, Optional[str]] = {
447
+ '200': None,
448
+ '404': "ErrorResponse",
449
+ }
450
+ response_data = self.api_client.call_api(
451
+ *_param,
452
+ _request_timeout=_request_timeout
453
+ )
454
+ response_data.read()
455
+ return self.api_client.response_deserialize(
456
+ response_data=response_data,
457
+ response_types_map=_response_types_map,
458
+ )
215
459
 
216
- all_params = [
217
- 'instanceid',
218
- 'v'
219
- ]
220
- all_params.extend(
460
+
461
+ @validate_call
462
+ def delete_wds_instance_without_preload_content(
463
+ self,
464
+ instanceid: Annotated[StrictStr, Field(description="WDS instance id; by convention equal to workspace id")],
465
+ v: Annotated[StrictStr, Field(description="API version")],
466
+ _request_timeout: Union[
467
+ None,
468
+ Annotated[StrictFloat, Field(gt=0)],
469
+ Tuple[
470
+ Annotated[StrictFloat, Field(gt=0)],
471
+ Annotated[StrictFloat, Field(gt=0)]
472
+ ]
473
+ ] = None,
474
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
475
+ _content_type: Optional[StrictStr] = None,
476
+ _headers: Optional[Dict[StrictStr, Any]] = None,
477
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
478
+ ) -> RESTResponseType:
479
+ """Delete an instance
480
+
481
+ Delete the instance with the given UUID. This API is liable to change. THIS WILL DELETE ALL DATA WITHIN THE INSTANCE. Be certain this is what you want to do.
482
+
483
+ :param instanceid: WDS instance id; by convention equal to workspace id (required)
484
+ :type instanceid: str
485
+ :param v: API version (required)
486
+ :type v: str
487
+ :param _request_timeout: timeout setting for this request. If one
488
+ number provided, it will be total request
489
+ timeout. It can also be a pair (tuple) of
490
+ (connection, read) timeouts.
491
+ :type _request_timeout: int, tuple(int, int), optional
492
+ :param _request_auth: set to override the auth_settings for an a single
493
+ request; this effectively ignores the
494
+ authentication in the spec for a single request.
495
+ :type _request_auth: dict, optional
496
+ :param _content_type: force content-type for the request.
497
+ :type _content_type: str, Optional
498
+ :param _headers: set to override the headers for a single
499
+ request; this effectively ignores the headers
500
+ in the spec for a single request.
501
+ :type _headers: dict, optional
502
+ :param _host_index: set to override the host_index for a single
503
+ request; this effectively ignores the host_index
504
+ in the spec for a single request.
505
+ :type _host_index: int, optional
506
+ :return: Returns the result object.
507
+ """ # noqa: E501
508
+
509
+ _param = self._delete_wds_instance_serialize(
510
+ instanceid=instanceid,
511
+ v=v,
512
+ _request_auth=_request_auth,
513
+ _content_type=_content_type,
514
+ _headers=_headers,
515
+ _host_index=_host_index
516
+ )
517
+
518
+ _response_types_map: Dict[str, Optional[str]] = {
519
+ '200': None,
520
+ '404': "ErrorResponse",
521
+ }
522
+ response_data = self.api_client.call_api(
523
+ *_param,
524
+ _request_timeout=_request_timeout
525
+ )
526
+ return response_data.response
527
+
528
+
529
+ def _delete_wds_instance_serialize(
530
+ self,
531
+ instanceid,
532
+ v,
533
+ _request_auth,
534
+ _content_type,
535
+ _headers,
536
+ _host_index,
537
+ ) -> RequestSerialized:
538
+
539
+ _host = None
540
+
541
+ _collection_formats: Dict[str, str] = {
542
+ }
543
+
544
+ _path_params: Dict[str, str] = {}
545
+ _query_params: List[Tuple[str, str]] = []
546
+ _header_params: Dict[str, Optional[str]] = _headers or {}
547
+ _form_params: List[Tuple[str, str]] = []
548
+ _files: Dict[str, Union[str, bytes]] = {}
549
+ _body_params: Optional[bytes] = None
550
+
551
+ # process the path parameters
552
+ if instanceid is not None:
553
+ _path_params['instanceid'] = instanceid
554
+ if v is not None:
555
+ _path_params['v'] = v
556
+ # process the query parameters
557
+ # process the header parameters
558
+ # process the form parameters
559
+ # process the body parameter
560
+
561
+
562
+ # set the HTTP header `Accept`
563
+ _header_params['Accept'] = self.api_client.select_header_accept(
221
564
  [
222
- 'async_req',
223
- '_return_http_data_only',
224
- '_preload_content',
225
- '_request_timeout'
565
+ 'application/json'
226
566
  ]
227
567
  )
228
568
 
229
- for key, val in six.iteritems(local_var_params['kwargs']):
230
- if key not in all_params:
231
- raise ApiTypeError(
232
- "Got an unexpected keyword argument '%s'"
233
- " to method delete_wds_instance" % key
234
- )
235
- local_var_params[key] = val
236
- del local_var_params['kwargs']
237
- # verify the required parameter 'instanceid' is set
238
- if self.api_client.client_side_validation and ('instanceid' not in local_var_params or # noqa: E501
239
- local_var_params['instanceid'] is None): # noqa: E501
240
- raise ApiValueError("Missing the required parameter `instanceid` when calling `delete_wds_instance`") # noqa: E501
241
- # verify the required parameter 'v' is set
242
- if self.api_client.client_side_validation and ('v' not in local_var_params or # noqa: E501
243
- local_var_params['v'] is None): # noqa: E501
244
- raise ApiValueError("Missing the required parameter `v` when calling `delete_wds_instance`") # noqa: E501
245
-
246
- collection_formats = {}
247
-
248
- path_params = {}
249
- if 'instanceid' in local_var_params:
250
- path_params['instanceid'] = local_var_params['instanceid'] # noqa: E501
251
- if 'v' in local_var_params:
252
- path_params['v'] = local_var_params['v'] # noqa: E501
253
-
254
- query_params = []
255
-
256
- header_params = {}
257
-
258
- form_params = []
259
- local_var_files = {}
260
-
261
- body_params = None
262
- # HTTP header `Accept`
263
- header_params['Accept'] = self.api_client.select_header_accept(
264
- ['application/json']) # noqa: E501
265
-
266
- # Authentication setting
267
- auth_settings = ['bearerAuth'] # noqa: E501
268
-
269
- return self.api_client.call_api(
270
- '/instances/{v}/{instanceid}', 'DELETE',
271
- path_params,
272
- query_params,
273
- header_params,
274
- body=body_params,
275
- post_params=form_params,
276
- files=local_var_files,
277
- response_type=None, # noqa: E501
278
- auth_settings=auth_settings,
279
- async_req=local_var_params.get('async_req'),
280
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
281
- _preload_content=local_var_params.get('_preload_content', True),
282
- _request_timeout=local_var_params.get('_request_timeout'),
283
- collection_formats=collection_formats)
284
-
285
- def list_wds_instances(self, v, **kwargs): # noqa: E501
286
- """List instances # noqa: E501
287
-
288
- List all instances in this server. # noqa: E501
289
- This method makes a synchronous HTTP request by default. To make an
290
- asynchronous HTTP request, please pass async_req=True
291
- >>> thread = api.list_wds_instances(v, async_req=True)
292
- >>> result = thread.get()
293
-
294
- :param async_req bool: execute request asynchronously
295
- :param str v: API version (required)
296
- :param _preload_content: if False, the urllib3.HTTPResponse object will
297
- be returned without reading/decoding response
298
- data. Default is True.
569
+
570
+ # authentication setting
571
+ _auth_settings: List[str] = [
572
+ 'bearerAuth'
573
+ ]
574
+
575
+ return self.api_client.param_serialize(
576
+ method='DELETE',
577
+ resource_path='/instances/{v}/{instanceid}',
578
+ path_params=_path_params,
579
+ query_params=_query_params,
580
+ header_params=_header_params,
581
+ body=_body_params,
582
+ post_params=_form_params,
583
+ files=_files,
584
+ auth_settings=_auth_settings,
585
+ collection_formats=_collection_formats,
586
+ _host=_host,
587
+ _request_auth=_request_auth
588
+ )
589
+
590
+
591
+
592
+
593
+ @validate_call
594
+ def list_wds_instances(
595
+ self,
596
+ v: Annotated[StrictStr, Field(description="API version")],
597
+ _request_timeout: Union[
598
+ None,
599
+ Annotated[StrictFloat, Field(gt=0)],
600
+ Tuple[
601
+ Annotated[StrictFloat, Field(gt=0)],
602
+ Annotated[StrictFloat, Field(gt=0)]
603
+ ]
604
+ ] = None,
605
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
606
+ _content_type: Optional[StrictStr] = None,
607
+ _headers: Optional[Dict[StrictStr, Any]] = None,
608
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
609
+ ) -> List[str]:
610
+ """List instances
611
+
612
+ List all instances in this server.
613
+
614
+ :param v: API version (required)
615
+ :type v: str
299
616
  :param _request_timeout: timeout setting for this request. If one
300
617
  number provided, it will be total request
301
618
  timeout. It can also be a pair (tuple) of
302
619
  (connection, read) timeouts.
303
- :return: list[str]
304
- If the method is called asynchronously,
305
- returns the request thread.
306
- """
307
- kwargs['_return_http_data_only'] = True
308
- return self.list_wds_instances_with_http_info(v, **kwargs) # noqa: E501
309
-
310
- def list_wds_instances_with_http_info(self, v, **kwargs): # noqa: E501
311
- """List instances # noqa: E501
312
-
313
- List all instances in this server. # noqa: E501
314
- This method makes a synchronous HTTP request by default. To make an
315
- asynchronous HTTP request, please pass async_req=True
316
- >>> thread = api.list_wds_instances_with_http_info(v, async_req=True)
317
- >>> result = thread.get()
318
-
319
- :param async_req bool: execute request asynchronously
320
- :param str v: API version (required)
321
- :param _return_http_data_only: response data without head status code
322
- and headers
323
- :param _preload_content: if False, the urllib3.HTTPResponse object will
324
- be returned without reading/decoding response
325
- data. Default is True.
620
+ :type _request_timeout: int, tuple(int, int), optional
621
+ :param _request_auth: set to override the auth_settings for an a single
622
+ request; this effectively ignores the
623
+ authentication in the spec for a single request.
624
+ :type _request_auth: dict, optional
625
+ :param _content_type: force content-type for the request.
626
+ :type _content_type: str, Optional
627
+ :param _headers: set to override the headers for a single
628
+ request; this effectively ignores the headers
629
+ in the spec for a single request.
630
+ :type _headers: dict, optional
631
+ :param _host_index: set to override the host_index for a single
632
+ request; this effectively ignores the host_index
633
+ in the spec for a single request.
634
+ :type _host_index: int, optional
635
+ :return: Returns the result object.
636
+ """ # noqa: E501
637
+
638
+ _param = self._list_wds_instances_serialize(
639
+ v=v,
640
+ _request_auth=_request_auth,
641
+ _content_type=_content_type,
642
+ _headers=_headers,
643
+ _host_index=_host_index
644
+ )
645
+
646
+ _response_types_map: Dict[str, Optional[str]] = {
647
+ '200': "List[str]",
648
+ }
649
+ response_data = self.api_client.call_api(
650
+ *_param,
651
+ _request_timeout=_request_timeout
652
+ )
653
+ response_data.read()
654
+ return self.api_client.response_deserialize(
655
+ response_data=response_data,
656
+ response_types_map=_response_types_map,
657
+ ).data
658
+
659
+
660
+ @validate_call
661
+ def list_wds_instances_with_http_info(
662
+ self,
663
+ v: Annotated[StrictStr, Field(description="API version")],
664
+ _request_timeout: Union[
665
+ None,
666
+ Annotated[StrictFloat, Field(gt=0)],
667
+ Tuple[
668
+ Annotated[StrictFloat, Field(gt=0)],
669
+ Annotated[StrictFloat, Field(gt=0)]
670
+ ]
671
+ ] = None,
672
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
673
+ _content_type: Optional[StrictStr] = None,
674
+ _headers: Optional[Dict[StrictStr, Any]] = None,
675
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
676
+ ) -> ApiResponse[List[str]]:
677
+ """List instances
678
+
679
+ List all instances in this server.
680
+
681
+ :param v: API version (required)
682
+ :type v: str
326
683
  :param _request_timeout: timeout setting for this request. If one
327
684
  number provided, it will be total request
328
685
  timeout. It can also be a pair (tuple) of
329
686
  (connection, read) timeouts.
330
- :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict))
331
- If the method is called asynchronously,
332
- returns the request thread.
333
- """
687
+ :type _request_timeout: int, tuple(int, int), optional
688
+ :param _request_auth: set to override the auth_settings for an a single
689
+ request; this effectively ignores the
690
+ authentication in the spec for a single request.
691
+ :type _request_auth: dict, optional
692
+ :param _content_type: force content-type for the request.
693
+ :type _content_type: str, Optional
694
+ :param _headers: set to override the headers for a single
695
+ request; this effectively ignores the headers
696
+ in the spec for a single request.
697
+ :type _headers: dict, optional
698
+ :param _host_index: set to override the host_index for a single
699
+ request; this effectively ignores the host_index
700
+ in the spec for a single request.
701
+ :type _host_index: int, optional
702
+ :return: Returns the result object.
703
+ """ # noqa: E501
704
+
705
+ _param = self._list_wds_instances_serialize(
706
+ v=v,
707
+ _request_auth=_request_auth,
708
+ _content_type=_content_type,
709
+ _headers=_headers,
710
+ _host_index=_host_index
711
+ )
334
712
 
335
- local_var_params = locals()
713
+ _response_types_map: Dict[str, Optional[str]] = {
714
+ '200': "List[str]",
715
+ }
716
+ response_data = self.api_client.call_api(
717
+ *_param,
718
+ _request_timeout=_request_timeout
719
+ )
720
+ response_data.read()
721
+ return self.api_client.response_deserialize(
722
+ response_data=response_data,
723
+ response_types_map=_response_types_map,
724
+ )
336
725
 
337
- all_params = [
338
- 'v'
339
- ]
340
- all_params.extend(
726
+
727
+ @validate_call
728
+ def list_wds_instances_without_preload_content(
729
+ self,
730
+ v: Annotated[StrictStr, Field(description="API version")],
731
+ _request_timeout: Union[
732
+ None,
733
+ Annotated[StrictFloat, Field(gt=0)],
734
+ Tuple[
735
+ Annotated[StrictFloat, Field(gt=0)],
736
+ Annotated[StrictFloat, Field(gt=0)]
737
+ ]
738
+ ] = None,
739
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
740
+ _content_type: Optional[StrictStr] = None,
741
+ _headers: Optional[Dict[StrictStr, Any]] = None,
742
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
743
+ ) -> RESTResponseType:
744
+ """List instances
745
+
746
+ List all instances in this server.
747
+
748
+ :param v: API version (required)
749
+ :type v: str
750
+ :param _request_timeout: timeout setting for this request. If one
751
+ number provided, it will be total request
752
+ timeout. It can also be a pair (tuple) of
753
+ (connection, read) timeouts.
754
+ :type _request_timeout: int, tuple(int, int), optional
755
+ :param _request_auth: set to override the auth_settings for an a single
756
+ request; this effectively ignores the
757
+ authentication in the spec for a single request.
758
+ :type _request_auth: dict, optional
759
+ :param _content_type: force content-type for the request.
760
+ :type _content_type: str, Optional
761
+ :param _headers: set to override the headers for a single
762
+ request; this effectively ignores the headers
763
+ in the spec for a single request.
764
+ :type _headers: dict, optional
765
+ :param _host_index: set to override the host_index for a single
766
+ request; this effectively ignores the host_index
767
+ in the spec for a single request.
768
+ :type _host_index: int, optional
769
+ :return: Returns the result object.
770
+ """ # noqa: E501
771
+
772
+ _param = self._list_wds_instances_serialize(
773
+ v=v,
774
+ _request_auth=_request_auth,
775
+ _content_type=_content_type,
776
+ _headers=_headers,
777
+ _host_index=_host_index
778
+ )
779
+
780
+ _response_types_map: Dict[str, Optional[str]] = {
781
+ '200': "List[str]",
782
+ }
783
+ response_data = self.api_client.call_api(
784
+ *_param,
785
+ _request_timeout=_request_timeout
786
+ )
787
+ return response_data.response
788
+
789
+
790
+ def _list_wds_instances_serialize(
791
+ self,
792
+ v,
793
+ _request_auth,
794
+ _content_type,
795
+ _headers,
796
+ _host_index,
797
+ ) -> RequestSerialized:
798
+
799
+ _host = None
800
+
801
+ _collection_formats: Dict[str, str] = {
802
+ }
803
+
804
+ _path_params: Dict[str, str] = {}
805
+ _query_params: List[Tuple[str, str]] = []
806
+ _header_params: Dict[str, Optional[str]] = _headers or {}
807
+ _form_params: List[Tuple[str, str]] = []
808
+ _files: Dict[str, Union[str, bytes]] = {}
809
+ _body_params: Optional[bytes] = None
810
+
811
+ # process the path parameters
812
+ if v is not None:
813
+ _path_params['v'] = v
814
+ # process the query parameters
815
+ # process the header parameters
816
+ # process the form parameters
817
+ # process the body parameter
818
+
819
+
820
+ # set the HTTP header `Accept`
821
+ _header_params['Accept'] = self.api_client.select_header_accept(
341
822
  [
342
- 'async_req',
343
- '_return_http_data_only',
344
- '_preload_content',
345
- '_request_timeout'
823
+ 'application/json'
346
824
  ]
347
825
  )
348
826
 
349
- for key, val in six.iteritems(local_var_params['kwargs']):
350
- if key not in all_params:
351
- raise ApiTypeError(
352
- "Got an unexpected keyword argument '%s'"
353
- " to method list_wds_instances" % key
354
- )
355
- local_var_params[key] = val
356
- del local_var_params['kwargs']
357
- # verify the required parameter 'v' is set
358
- if self.api_client.client_side_validation and ('v' not in local_var_params or # noqa: E501
359
- local_var_params['v'] is None): # noqa: E501
360
- raise ApiValueError("Missing the required parameter `v` when calling `list_wds_instances`") # noqa: E501
361
-
362
- collection_formats = {}
363
-
364
- path_params = {}
365
- if 'v' in local_var_params:
366
- path_params['v'] = local_var_params['v'] # noqa: E501
367
-
368
- query_params = []
369
-
370
- header_params = {}
371
-
372
- form_params = []
373
- local_var_files = {}
374
-
375
- body_params = None
376
- # HTTP header `Accept`
377
- header_params['Accept'] = self.api_client.select_header_accept(
378
- ['application/json']) # noqa: E501
379
-
380
- # Authentication setting
381
- auth_settings = [] # noqa: E501
382
-
383
- return self.api_client.call_api(
384
- '/instances/{v}', 'GET',
385
- path_params,
386
- query_params,
387
- header_params,
388
- body=body_params,
389
- post_params=form_params,
390
- files=local_var_files,
391
- response_type='list[str]', # noqa: E501
392
- auth_settings=auth_settings,
393
- async_req=local_var_params.get('async_req'),
394
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
395
- _preload_content=local_var_params.get('_preload_content', True),
396
- _request_timeout=local_var_params.get('_request_timeout'),
397
- collection_formats=collection_formats)
827
+
828
+ # authentication setting
829
+ _auth_settings: List[str] = [
830
+ ]
831
+
832
+ return self.api_client.param_serialize(
833
+ method='GET',
834
+ resource_path='/instances/{v}',
835
+ path_params=_path_params,
836
+ query_params=_query_params,
837
+ header_params=_header_params,
838
+ body=_body_params,
839
+ post_params=_form_params,
840
+ files=_files,
841
+ auth_settings=_auth_settings,
842
+ collection_formats=_collection_formats,
843
+ _host=_host,
844
+ _request_auth=_request_auth
845
+ )
846
+
847
+