lusid-sdk 2.1.755__py3-none-any.whl → 2.1.757__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.
- lusid/__init__.py +8 -0
- lusid/api/workspace_api.py +392 -2034
- lusid/configuration.py +1 -1
- lusid/models/__init__.py +8 -0
- lusid/models/accumulation_event.py +3 -3
- lusid/models/adjust_global_commitment_event.py +3 -3
- lusid/models/amortisation_event.py +3 -3
- lusid/models/bond_coupon_event.py +3 -3
- lusid/models/bond_default_event.py +3 -3
- lusid/models/bond_principal_event.py +3 -3
- lusid/models/bonus_issue_event.py +3 -3
- lusid/models/call_on_intermediate_securities_event.py +3 -3
- lusid/models/capital_distribution_event.py +3 -3
- lusid/models/cash_dividend_event.py +3 -3
- lusid/models/cash_flow_event.py +3 -3
- lusid/models/cds_credit_event.py +3 -3
- lusid/models/cdx_credit_event.py +3 -3
- lusid/models/close_event.py +3 -3
- lusid/models/contract_initialisation_event.py +3 -3
- lusid/models/credit_premium_cash_flow_event.py +3 -3
- lusid/models/deposit_close_event.py +3 -3
- lusid/models/deposit_interest_payment_event.py +3 -3
- lusid/models/dividend_option_event.py +3 -3
- lusid/models/dividend_reinvestment_event.py +3 -3
- lusid/models/drawdown_event.py +3 -3
- lusid/models/early_redemption_event.py +3 -3
- lusid/models/exercise_event.py +3 -3
- lusid/models/expiry_event.py +3 -3
- lusid/models/future_expiry_event.py +3 -3
- lusid/models/future_mark_to_market_event.py +3 -3
- lusid/models/fx_forward_settlement_event.py +3 -3
- lusid/models/informational_error_event.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/instrument_event.py +6 -5
- lusid/models/instrument_event_type.py +1 -0
- lusid/models/intermediate_securities_distribution_event.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +163 -0
- lusid/models/loan_interest_repayment_event.py +3 -3
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/maturity_event.py +3 -3
- lusid/models/mbs_coupon_event.py +3 -3
- lusid/models/mbs_interest_deferral_event.py +3 -3
- lusid/models/mbs_interest_shortfall_event.py +3 -3
- lusid/models/mbs_principal_event.py +3 -3
- lusid/models/mbs_principal_write_off_event.py +3 -3
- lusid/models/merger_event.py +3 -3
- lusid/models/model_property.py +23 -2
- lusid/models/open_event.py +3 -3
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/perpetual_property.py +23 -2
- lusid/models/property_reference_data_value.py +89 -0
- lusid/models/protection_payout_cash_flow_event.py +3 -3
- lusid/models/quote_access_metadata_rule_id.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +3 -3
- lusid/models/reset_event.py +3 -3
- lusid/models/reverse_stock_split_event.py +3 -3
- lusid/models/rollover_constituent.py +83 -0
- lusid/models/scrip_dividend_event.py +3 -3
- lusid/models/spin_off_event.py +3 -3
- lusid/models/stock_dividend_event.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/swap_cash_flow_event.py +3 -3
- lusid/models/swap_principal_event.py +3 -3
- lusid/models/tender_event.py +3 -3
- lusid/models/term_deposit_interest_event.py +3 -3
- lusid/models/term_deposit_principal_event.py +3 -3
- lusid/models/transition_event.py +3 -3
- lusid/models/trigger_event.py +3 -3
- lusid/models/update_deposit_amount_event.py +3 -3
- lusid/models/valuation_point_data_response.py +3 -30
- lusid/models/workspace_visibility.py +38 -0
- {lusid_sdk-2.1.755.dist-info → lusid_sdk-2.1.757.dist-info}/METADATA +15 -21
- {lusid_sdk-2.1.755.dist-info → lusid_sdk-2.1.757.dist-info}/RECORD +76 -72
- {lusid_sdk-2.1.755.dist-info → lusid_sdk-2.1.757.dist-info}/WHEEL +0 -0
lusid/api/workspace_api.py
CHANGED
@@ -63,24 +63,26 @@ class WorkspaceApi:
|
|
63
63
|
|
64
64
|
|
65
65
|
@overload
|
66
|
-
async def
|
66
|
+
async def create_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
67
67
|
...
|
68
68
|
|
69
69
|
@overload
|
70
|
-
def
|
70
|
+
def create_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
71
71
|
...
|
72
72
|
|
73
73
|
@validate_arguments
|
74
|
-
def
|
75
|
-
"""[EXPERIMENTAL]
|
74
|
+
def create_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
75
|
+
"""[EXPERIMENTAL] CreateItem: Create a new item in a workspace. # noqa: E501
|
76
76
|
|
77
|
-
Create a new item in a
|
77
|
+
Create a new item in a workspace. # noqa: E501
|
78
78
|
This method makes a synchronous HTTP request by default. To make an
|
79
79
|
asynchronous HTTP request, please pass async_req=True
|
80
80
|
|
81
|
-
>>> thread = api.
|
81
|
+
>>> thread = api.create_item(visibility, workspace_name, workspace_item_creation_request, async_req=True)
|
82
82
|
>>> result = thread.get()
|
83
83
|
|
84
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
85
|
+
:type visibility: str
|
84
86
|
:param workspace_name: The item's workspace name. (required)
|
85
87
|
:type workspace_name: str
|
86
88
|
:param workspace_item_creation_request: The item to be created.
|
@@ -97,23 +99,25 @@ class WorkspaceApi:
|
|
97
99
|
"""
|
98
100
|
kwargs['_return_http_data_only'] = True
|
99
101
|
if '_preload_content' in kwargs:
|
100
|
-
message = "Error! Please call the
|
102
|
+
message = "Error! Please call the create_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
101
103
|
raise ValueError(message)
|
102
104
|
if async_req is not None:
|
103
105
|
kwargs['async_req'] = async_req
|
104
|
-
return self.
|
106
|
+
return self.create_item_with_http_info(visibility, workspace_name, workspace_item_creation_request, **kwargs) # noqa: E501
|
105
107
|
|
106
108
|
@validate_arguments
|
107
|
-
def
|
108
|
-
"""[EXPERIMENTAL]
|
109
|
+
def create_item_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
110
|
+
"""[EXPERIMENTAL] CreateItem: Create a new item in a workspace. # noqa: E501
|
109
111
|
|
110
|
-
Create a new item in a
|
112
|
+
Create a new item in a workspace. # noqa: E501
|
111
113
|
This method makes a synchronous HTTP request by default. To make an
|
112
114
|
asynchronous HTTP request, please pass async_req=True
|
113
115
|
|
114
|
-
>>> thread = api.
|
116
|
+
>>> thread = api.create_item_with_http_info(visibility, workspace_name, workspace_item_creation_request, async_req=True)
|
115
117
|
>>> result = thread.get()
|
116
118
|
|
119
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
120
|
+
:type visibility: str
|
117
121
|
:param workspace_name: The item's workspace name. (required)
|
118
122
|
:type workspace_name: str
|
119
123
|
:param workspace_item_creation_request: The item to be created.
|
@@ -145,6 +149,7 @@ class WorkspaceApi:
|
|
145
149
|
_params = locals()
|
146
150
|
|
147
151
|
_all_params = [
|
152
|
+
'visibility',
|
148
153
|
'workspace_name',
|
149
154
|
'workspace_item_creation_request'
|
150
155
|
]
|
@@ -166,7 +171,7 @@ class WorkspaceApi:
|
|
166
171
|
if _key not in _all_params:
|
167
172
|
raise ApiTypeError(
|
168
173
|
"Got an unexpected keyword argument '%s'"
|
169
|
-
" to method
|
174
|
+
" to method create_item" % _key
|
170
175
|
)
|
171
176
|
_params[_key] = _val
|
172
177
|
del _params['kwargs']
|
@@ -175,6 +180,9 @@ class WorkspaceApi:
|
|
175
180
|
|
176
181
|
# process the path parameters
|
177
182
|
_path_params = {}
|
183
|
+
if _params['visibility']:
|
184
|
+
_path_params['visibility'] = _params['visibility']
|
185
|
+
|
178
186
|
if _params['workspace_name']:
|
179
187
|
_path_params['workspaceName'] = _params['workspace_name']
|
180
188
|
|
@@ -211,7 +219,7 @@ class WorkspaceApi:
|
|
211
219
|
}
|
212
220
|
|
213
221
|
return self.api_client.call_api(
|
214
|
-
'/api/workspaces/
|
222
|
+
'/api/workspaces/{visibility}/{workspaceName}/items', 'POST',
|
215
223
|
_path_params,
|
216
224
|
_query_params,
|
217
225
|
_header_params,
|
@@ -230,24 +238,26 @@ class WorkspaceApi:
|
|
230
238
|
|
231
239
|
|
232
240
|
@overload
|
233
|
-
async def
|
241
|
+
async def create_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace being created. Must be `shared` or `personal`; case is important.")], workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> Workspace: # noqa: E501
|
234
242
|
...
|
235
243
|
|
236
244
|
@overload
|
237
|
-
def
|
245
|
+
def create_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace being created. Must be `shared` or `personal`; case is important.")], workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
238
246
|
...
|
239
247
|
|
240
248
|
@validate_arguments
|
241
|
-
def
|
242
|
-
"""[EXPERIMENTAL]
|
249
|
+
def create_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace being created. Must be `shared` or `personal`; case is important.")], workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
250
|
+
"""[EXPERIMENTAL] CreateWorkspace: Create a new workspace. # noqa: E501
|
243
251
|
|
244
|
-
Create a new
|
252
|
+
Create a new workspace. # noqa: E501
|
245
253
|
This method makes a synchronous HTTP request by default. To make an
|
246
254
|
asynchronous HTTP request, please pass async_req=True
|
247
255
|
|
248
|
-
>>> thread = api.
|
256
|
+
>>> thread = api.create_workspace(visibility, workspace_creation_request, async_req=True)
|
249
257
|
>>> result = thread.get()
|
250
258
|
|
259
|
+
:param visibility: The visibility for the workspace being created. Must be `shared` or `personal`; case is important. (required)
|
260
|
+
:type visibility: str
|
251
261
|
:param workspace_creation_request: The workspace to be created.
|
252
262
|
:type workspace_creation_request: WorkspaceCreationRequest
|
253
263
|
:param async_req: Whether to execute the request asynchronously.
|
@@ -262,23 +272,25 @@ class WorkspaceApi:
|
|
262
272
|
"""
|
263
273
|
kwargs['_return_http_data_only'] = True
|
264
274
|
if '_preload_content' in kwargs:
|
265
|
-
message = "Error! Please call the
|
275
|
+
message = "Error! Please call the create_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
266
276
|
raise ValueError(message)
|
267
277
|
if async_req is not None:
|
268
278
|
kwargs['async_req'] = async_req
|
269
|
-
return self.
|
279
|
+
return self.create_workspace_with_http_info(visibility, workspace_creation_request, **kwargs) # noqa: E501
|
270
280
|
|
271
281
|
@validate_arguments
|
272
|
-
def
|
273
|
-
"""[EXPERIMENTAL]
|
282
|
+
def create_workspace_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace being created. Must be `shared` or `personal`; case is important.")], workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
283
|
+
"""[EXPERIMENTAL] CreateWorkspace: Create a new workspace. # noqa: E501
|
274
284
|
|
275
|
-
Create a new
|
285
|
+
Create a new workspace. # noqa: E501
|
276
286
|
This method makes a synchronous HTTP request by default. To make an
|
277
287
|
asynchronous HTTP request, please pass async_req=True
|
278
288
|
|
279
|
-
>>> thread = api.
|
289
|
+
>>> thread = api.create_workspace_with_http_info(visibility, workspace_creation_request, async_req=True)
|
280
290
|
>>> result = thread.get()
|
281
291
|
|
292
|
+
:param visibility: The visibility for the workspace being created. Must be `shared` or `personal`; case is important. (required)
|
293
|
+
:type visibility: str
|
282
294
|
:param workspace_creation_request: The workspace to be created.
|
283
295
|
:type workspace_creation_request: WorkspaceCreationRequest
|
284
296
|
:param async_req: Whether to execute the request asynchronously.
|
@@ -308,6 +320,7 @@ class WorkspaceApi:
|
|
308
320
|
_params = locals()
|
309
321
|
|
310
322
|
_all_params = [
|
323
|
+
'visibility',
|
311
324
|
'workspace_creation_request'
|
312
325
|
]
|
313
326
|
_all_params.extend(
|
@@ -328,7 +341,7 @@ class WorkspaceApi:
|
|
328
341
|
if _key not in _all_params:
|
329
342
|
raise ApiTypeError(
|
330
343
|
"Got an unexpected keyword argument '%s'"
|
331
|
-
" to method
|
344
|
+
" to method create_workspace" % _key
|
332
345
|
)
|
333
346
|
_params[_key] = _val
|
334
347
|
del _params['kwargs']
|
@@ -337,6 +350,9 @@ class WorkspaceApi:
|
|
337
350
|
|
338
351
|
# process the path parameters
|
339
352
|
_path_params = {}
|
353
|
+
if _params['visibility']:
|
354
|
+
_path_params['visibility'] = _params['visibility']
|
355
|
+
|
340
356
|
|
341
357
|
# process the query parameters
|
342
358
|
_query_params = []
|
@@ -370,7 +386,7 @@ class WorkspaceApi:
|
|
370
386
|
}
|
371
387
|
|
372
388
|
return self.api_client.call_api(
|
373
|
-
'/api/workspaces/
|
389
|
+
'/api/workspaces/{visibility}', 'POST',
|
374
390
|
_path_params,
|
375
391
|
_query_params,
|
376
392
|
_header_params,
|
@@ -389,28 +405,32 @@ class WorkspaceApi:
|
|
389
405
|
|
390
406
|
|
391
407
|
@overload
|
392
|
-
async def
|
408
|
+
async def delete_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
393
409
|
...
|
394
410
|
|
395
411
|
@overload
|
396
|
-
def
|
412
|
+
def delete_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
397
413
|
...
|
398
414
|
|
399
415
|
@validate_arguments
|
400
|
-
def
|
401
|
-
"""[EXPERIMENTAL]
|
416
|
+
def delete_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
417
|
+
"""[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. # noqa: E501
|
402
418
|
|
403
|
-
|
419
|
+
Delete an item from a workspace. # noqa: E501
|
404
420
|
This method makes a synchronous HTTP request by default. To make an
|
405
421
|
asynchronous HTTP request, please pass async_req=True
|
406
422
|
|
407
|
-
>>> thread = api.
|
423
|
+
>>> thread = api.delete_item(visibility, workspace_name, group_name, item_name, async_req=True)
|
408
424
|
>>> result = thread.get()
|
409
425
|
|
410
|
-
:param
|
426
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
427
|
+
:type visibility: str
|
428
|
+
:param workspace_name: The name of the workspace. (required)
|
411
429
|
:type workspace_name: str
|
412
|
-
:param
|
413
|
-
:type
|
430
|
+
:param group_name: The group containing the item. (required)
|
431
|
+
:type group_name: str
|
432
|
+
:param item_name: The name of the item. (required)
|
433
|
+
:type item_name: str
|
414
434
|
:param async_req: Whether to execute the request asynchronously.
|
415
435
|
:type async_req: bool, optional
|
416
436
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -419,31 +439,35 @@ class WorkspaceApi:
|
|
419
439
|
:return: Returns the result object.
|
420
440
|
If the method is called asynchronously,
|
421
441
|
returns the request thread.
|
422
|
-
:rtype:
|
442
|
+
:rtype: DeletedEntityResponse
|
423
443
|
"""
|
424
444
|
kwargs['_return_http_data_only'] = True
|
425
445
|
if '_preload_content' in kwargs:
|
426
|
-
message = "Error! Please call the
|
446
|
+
message = "Error! Please call the delete_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
427
447
|
raise ValueError(message)
|
428
448
|
if async_req is not None:
|
429
449
|
kwargs['async_req'] = async_req
|
430
|
-
return self.
|
450
|
+
return self.delete_item_with_http_info(visibility, workspace_name, group_name, item_name, **kwargs) # noqa: E501
|
431
451
|
|
432
452
|
@validate_arguments
|
433
|
-
def
|
434
|
-
"""[EXPERIMENTAL]
|
453
|
+
def delete_item_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], **kwargs) -> ApiResponse: # noqa: E501
|
454
|
+
"""[EXPERIMENTAL] DeleteItem: Delete an item from a workspace. # noqa: E501
|
435
455
|
|
436
|
-
|
456
|
+
Delete an item from a workspace. # noqa: E501
|
437
457
|
This method makes a synchronous HTTP request by default. To make an
|
438
458
|
asynchronous HTTP request, please pass async_req=True
|
439
459
|
|
440
|
-
>>> thread = api.
|
460
|
+
>>> thread = api.delete_item_with_http_info(visibility, workspace_name, group_name, item_name, async_req=True)
|
441
461
|
>>> result = thread.get()
|
442
462
|
|
443
|
-
:param
|
463
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
464
|
+
:type visibility: str
|
465
|
+
:param workspace_name: The name of the workspace. (required)
|
444
466
|
:type workspace_name: str
|
445
|
-
:param
|
446
|
-
:type
|
467
|
+
:param group_name: The group containing the item. (required)
|
468
|
+
:type group_name: str
|
469
|
+
:param item_name: The name of the item. (required)
|
470
|
+
:type item_name: str
|
447
471
|
:param async_req: Whether to execute the request asynchronously.
|
448
472
|
:type async_req: bool, optional
|
449
473
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -465,14 +489,16 @@ class WorkspaceApi:
|
|
465
489
|
:return: Returns the result object.
|
466
490
|
If the method is called asynchronously,
|
467
491
|
returns the request thread.
|
468
|
-
:rtype: tuple(
|
492
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
469
493
|
"""
|
470
494
|
|
471
495
|
_params = locals()
|
472
496
|
|
473
497
|
_all_params = [
|
498
|
+
'visibility',
|
474
499
|
'workspace_name',
|
475
|
-
'
|
500
|
+
'group_name',
|
501
|
+
'item_name'
|
476
502
|
]
|
477
503
|
_all_params.extend(
|
478
504
|
[
|
@@ -492,7 +518,7 @@ class WorkspaceApi:
|
|
492
518
|
if _key not in _all_params:
|
493
519
|
raise ApiTypeError(
|
494
520
|
"Got an unexpected keyword argument '%s'"
|
495
|
-
" to method
|
521
|
+
" to method delete_item" % _key
|
496
522
|
)
|
497
523
|
_params[_key] = _val
|
498
524
|
del _params['kwargs']
|
@@ -501,9 +527,18 @@ class WorkspaceApi:
|
|
501
527
|
|
502
528
|
# process the path parameters
|
503
529
|
_path_params = {}
|
530
|
+
if _params['visibility']:
|
531
|
+
_path_params['visibility'] = _params['visibility']
|
532
|
+
|
504
533
|
if _params['workspace_name']:
|
505
534
|
_path_params['workspaceName'] = _params['workspace_name']
|
506
535
|
|
536
|
+
if _params['group_name']:
|
537
|
+
_path_params['groupName'] = _params['group_name']
|
538
|
+
|
539
|
+
if _params['item_name']:
|
540
|
+
_path_params['itemName'] = _params['item_name']
|
541
|
+
|
507
542
|
|
508
543
|
# process the query parameters
|
509
544
|
_query_params = []
|
@@ -514,30 +549,20 @@ class WorkspaceApi:
|
|
514
549
|
_files = {}
|
515
550
|
# process the body parameter
|
516
551
|
_body_params = None
|
517
|
-
if _params['workspace_item_creation_request'] is not None:
|
518
|
-
_body_params = _params['workspace_item_creation_request']
|
519
|
-
|
520
552
|
# set the HTTP header `Accept`
|
521
553
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
522
554
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
523
555
|
|
524
|
-
# set the HTTP header `Content-Type`
|
525
|
-
_content_types_list = _params.get('_content_type',
|
526
|
-
self.api_client.select_header_content_type(
|
527
|
-
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
528
|
-
if _content_types_list:
|
529
|
-
_header_params['Content-Type'] = _content_types_list
|
530
|
-
|
531
556
|
# authentication setting
|
532
557
|
_auth_settings = ['oauth2'] # noqa: E501
|
533
558
|
|
534
559
|
_response_types_map = {
|
535
|
-
'
|
560
|
+
'200': "DeletedEntityResponse",
|
536
561
|
'400': "LusidValidationProblemDetails",
|
537
562
|
}
|
538
563
|
|
539
564
|
return self.api_client.call_api(
|
540
|
-
'/api/workspaces/
|
565
|
+
'/api/workspaces/{visibility}/{workspaceName}/items/{groupName}/{itemName}', 'DELETE',
|
541
566
|
_path_params,
|
542
567
|
_query_params,
|
543
568
|
_header_params,
|
@@ -556,26 +581,28 @@ class WorkspaceApi:
|
|
556
581
|
|
557
582
|
|
558
583
|
@overload
|
559
|
-
async def
|
584
|
+
async def delete_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
560
585
|
...
|
561
586
|
|
562
587
|
@overload
|
563
|
-
def
|
588
|
+
def delete_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
564
589
|
...
|
565
590
|
|
566
591
|
@validate_arguments
|
567
|
-
def
|
568
|
-
"""[EXPERIMENTAL]
|
592
|
+
def delete_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
593
|
+
"""[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. # noqa: E501
|
569
594
|
|
570
|
-
|
595
|
+
Delete a workspace. # noqa: E501
|
571
596
|
This method makes a synchronous HTTP request by default. To make an
|
572
597
|
asynchronous HTTP request, please pass async_req=True
|
573
598
|
|
574
|
-
>>> thread = api.
|
599
|
+
>>> thread = api.delete_workspace(visibility, workspace_name, async_req=True)
|
575
600
|
>>> result = thread.get()
|
576
601
|
|
577
|
-
:param
|
578
|
-
:type
|
602
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
603
|
+
:type visibility: str
|
604
|
+
:param workspace_name: The name of the workspace. (required)
|
605
|
+
:type workspace_name: str
|
579
606
|
:param async_req: Whether to execute the request asynchronously.
|
580
607
|
:type async_req: bool, optional
|
581
608
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -584,29 +611,31 @@ class WorkspaceApi:
|
|
584
611
|
:return: Returns the result object.
|
585
612
|
If the method is called asynchronously,
|
586
613
|
returns the request thread.
|
587
|
-
:rtype:
|
614
|
+
:rtype: DeletedEntityResponse
|
588
615
|
"""
|
589
616
|
kwargs['_return_http_data_only'] = True
|
590
617
|
if '_preload_content' in kwargs:
|
591
|
-
message = "Error! Please call the
|
618
|
+
message = "Error! Please call the delete_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
592
619
|
raise ValueError(message)
|
593
620
|
if async_req is not None:
|
594
621
|
kwargs['async_req'] = async_req
|
595
|
-
return self.
|
622
|
+
return self.delete_workspace_with_http_info(visibility, workspace_name, **kwargs) # noqa: E501
|
596
623
|
|
597
624
|
@validate_arguments
|
598
|
-
def
|
599
|
-
"""[EXPERIMENTAL]
|
625
|
+
def delete_workspace_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], **kwargs) -> ApiResponse: # noqa: E501
|
626
|
+
"""[EXPERIMENTAL] DeleteWorkspace: Delete a workspace. # noqa: E501
|
600
627
|
|
601
|
-
|
628
|
+
Delete a workspace. # noqa: E501
|
602
629
|
This method makes a synchronous HTTP request by default. To make an
|
603
630
|
asynchronous HTTP request, please pass async_req=True
|
604
631
|
|
605
|
-
>>> thread = api.
|
632
|
+
>>> thread = api.delete_workspace_with_http_info(visibility, workspace_name, async_req=True)
|
606
633
|
>>> result = thread.get()
|
607
634
|
|
608
|
-
:param
|
609
|
-
:type
|
635
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
636
|
+
:type visibility: str
|
637
|
+
:param workspace_name: The name of the workspace. (required)
|
638
|
+
:type workspace_name: str
|
610
639
|
:param async_req: Whether to execute the request asynchronously.
|
611
640
|
:type async_req: bool, optional
|
612
641
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -628,13 +657,14 @@ class WorkspaceApi:
|
|
628
657
|
:return: Returns the result object.
|
629
658
|
If the method is called asynchronously,
|
630
659
|
returns the request thread.
|
631
|
-
:rtype: tuple(
|
660
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
632
661
|
"""
|
633
662
|
|
634
663
|
_params = locals()
|
635
664
|
|
636
665
|
_all_params = [
|
637
|
-
'
|
666
|
+
'visibility',
|
667
|
+
'workspace_name'
|
638
668
|
]
|
639
669
|
_all_params.extend(
|
640
670
|
[
|
@@ -654,7 +684,7 @@ class WorkspaceApi:
|
|
654
684
|
if _key not in _all_params:
|
655
685
|
raise ApiTypeError(
|
656
686
|
"Got an unexpected keyword argument '%s'"
|
657
|
-
" to method
|
687
|
+
" to method delete_workspace" % _key
|
658
688
|
)
|
659
689
|
_params[_key] = _val
|
660
690
|
del _params['kwargs']
|
@@ -663,6 +693,12 @@ class WorkspaceApi:
|
|
663
693
|
|
664
694
|
# process the path parameters
|
665
695
|
_path_params = {}
|
696
|
+
if _params['visibility']:
|
697
|
+
_path_params['visibility'] = _params['visibility']
|
698
|
+
|
699
|
+
if _params['workspace_name']:
|
700
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
701
|
+
|
666
702
|
|
667
703
|
# process the query parameters
|
668
704
|
_query_params = []
|
@@ -673,30 +709,20 @@ class WorkspaceApi:
|
|
673
709
|
_files = {}
|
674
710
|
# process the body parameter
|
675
711
|
_body_params = None
|
676
|
-
if _params['workspace_creation_request'] is not None:
|
677
|
-
_body_params = _params['workspace_creation_request']
|
678
|
-
|
679
712
|
# set the HTTP header `Accept`
|
680
713
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
681
714
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
682
715
|
|
683
|
-
# set the HTTP header `Content-Type`
|
684
|
-
_content_types_list = _params.get('_content_type',
|
685
|
-
self.api_client.select_header_content_type(
|
686
|
-
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
687
|
-
if _content_types_list:
|
688
|
-
_header_params['Content-Type'] = _content_types_list
|
689
|
-
|
690
716
|
# authentication setting
|
691
717
|
_auth_settings = ['oauth2'] # noqa: E501
|
692
718
|
|
693
719
|
_response_types_map = {
|
694
|
-
'
|
720
|
+
'200': "DeletedEntityResponse",
|
695
721
|
'400': "LusidValidationProblemDetails",
|
696
722
|
}
|
697
723
|
|
698
724
|
return self.api_client.call_api(
|
699
|
-
'/api/workspaces/
|
725
|
+
'/api/workspaces/{visibility}/{workspaceName}', 'DELETE',
|
700
726
|
_path_params,
|
701
727
|
_query_params,
|
702
728
|
_header_params,
|
@@ -715,30 +741,34 @@ class WorkspaceApi:
|
|
715
741
|
|
716
742
|
|
717
743
|
@overload
|
718
|
-
async def
|
744
|
+
async def get_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
719
745
|
...
|
720
746
|
|
721
747
|
@overload
|
722
|
-
def
|
748
|
+
def get_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
723
749
|
...
|
724
750
|
|
725
751
|
@validate_arguments
|
726
|
-
def
|
727
|
-
"""[EXPERIMENTAL]
|
752
|
+
def get_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
753
|
+
"""[EXPERIMENTAL] GetItem: Get a single workspace item. # noqa: E501
|
728
754
|
|
729
|
-
|
755
|
+
Get a single workspace item. # noqa: E501
|
730
756
|
This method makes a synchronous HTTP request by default. To make an
|
731
757
|
asynchronous HTTP request, please pass async_req=True
|
732
758
|
|
733
|
-
>>> thread = api.
|
759
|
+
>>> thread = api.get_item(visibility, workspace_name, group_name, item_name, as_at, async_req=True)
|
734
760
|
>>> result = thread.get()
|
735
761
|
|
736
|
-
:param
|
762
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
763
|
+
:type visibility: str
|
764
|
+
:param workspace_name: The name of the workspace. (required)
|
737
765
|
:type workspace_name: str
|
738
766
|
:param group_name: The group containing the item. (required)
|
739
767
|
:type group_name: str
|
740
768
|
:param item_name: The name of the item. (required)
|
741
769
|
:type item_name: str
|
770
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
771
|
+
:type as_at: datetime
|
742
772
|
:param async_req: Whether to execute the request asynchronously.
|
743
773
|
:type async_req: bool, optional
|
744
774
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -747,33 +777,37 @@ class WorkspaceApi:
|
|
747
777
|
:return: Returns the result object.
|
748
778
|
If the method is called asynchronously,
|
749
779
|
returns the request thread.
|
750
|
-
:rtype:
|
780
|
+
:rtype: WorkspaceItem
|
751
781
|
"""
|
752
782
|
kwargs['_return_http_data_only'] = True
|
753
783
|
if '_preload_content' in kwargs:
|
754
|
-
message = "Error! Please call the
|
784
|
+
message = "Error! Please call the get_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
755
785
|
raise ValueError(message)
|
756
786
|
if async_req is not None:
|
757
787
|
kwargs['async_req'] = async_req
|
758
|
-
return self.
|
788
|
+
return self.get_item_with_http_info(visibility, workspace_name, group_name, item_name, as_at, **kwargs) # noqa: E501
|
759
789
|
|
760
790
|
@validate_arguments
|
761
|
-
def
|
762
|
-
"""[EXPERIMENTAL]
|
791
|
+
def get_item_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The name of the workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
792
|
+
"""[EXPERIMENTAL] GetItem: Get a single workspace item. # noqa: E501
|
763
793
|
|
764
|
-
|
794
|
+
Get a single workspace item. # noqa: E501
|
765
795
|
This method makes a synchronous HTTP request by default. To make an
|
766
796
|
asynchronous HTTP request, please pass async_req=True
|
767
797
|
|
768
|
-
>>> thread = api.
|
798
|
+
>>> thread = api.get_item_with_http_info(visibility, workspace_name, group_name, item_name, as_at, async_req=True)
|
769
799
|
>>> result = thread.get()
|
770
800
|
|
771
|
-
:param
|
801
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
802
|
+
:type visibility: str
|
803
|
+
:param workspace_name: The name of the workspace. (required)
|
772
804
|
:type workspace_name: str
|
773
805
|
:param group_name: The group containing the item. (required)
|
774
806
|
:type group_name: str
|
775
807
|
:param item_name: The name of the item. (required)
|
776
808
|
:type item_name: str
|
809
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
810
|
+
:type as_at: datetime
|
777
811
|
:param async_req: Whether to execute the request asynchronously.
|
778
812
|
:type async_req: bool, optional
|
779
813
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -795,15 +829,17 @@ class WorkspaceApi:
|
|
795
829
|
:return: Returns the result object.
|
796
830
|
If the method is called asynchronously,
|
797
831
|
returns the request thread.
|
798
|
-
:rtype: tuple(
|
832
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
799
833
|
"""
|
800
834
|
|
801
835
|
_params = locals()
|
802
836
|
|
803
837
|
_all_params = [
|
838
|
+
'visibility',
|
804
839
|
'workspace_name',
|
805
840
|
'group_name',
|
806
|
-
'item_name'
|
841
|
+
'item_name',
|
842
|
+
'as_at'
|
807
843
|
]
|
808
844
|
_all_params.extend(
|
809
845
|
[
|
@@ -823,7 +859,7 @@ class WorkspaceApi:
|
|
823
859
|
if _key not in _all_params:
|
824
860
|
raise ApiTypeError(
|
825
861
|
"Got an unexpected keyword argument '%s'"
|
826
|
-
" to method
|
862
|
+
" to method get_item" % _key
|
827
863
|
)
|
828
864
|
_params[_key] = _val
|
829
865
|
del _params['kwargs']
|
@@ -832,6 +868,9 @@ class WorkspaceApi:
|
|
832
868
|
|
833
869
|
# process the path parameters
|
834
870
|
_path_params = {}
|
871
|
+
if _params['visibility']:
|
872
|
+
_path_params['visibility'] = _params['visibility']
|
873
|
+
|
835
874
|
if _params['workspace_name']:
|
836
875
|
_path_params['workspaceName'] = _params['workspace_name']
|
837
876
|
|
@@ -844,6 +883,12 @@ class WorkspaceApi:
|
|
844
883
|
|
845
884
|
# process the query parameters
|
846
885
|
_query_params = []
|
886
|
+
if _params.get('as_at') is not None: # noqa: E501
|
887
|
+
if isinstance(_params['as_at'], datetime):
|
888
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
889
|
+
else:
|
890
|
+
_query_params.append(('asAt', _params['as_at']))
|
891
|
+
|
847
892
|
# process the header parameters
|
848
893
|
_header_params = dict(_params.get('_headers', {}))
|
849
894
|
# process the form parameters
|
@@ -859,12 +904,12 @@ class WorkspaceApi:
|
|
859
904
|
_auth_settings = ['oauth2'] # noqa: E501
|
860
905
|
|
861
906
|
_response_types_map = {
|
862
|
-
'200': "
|
907
|
+
'200': "WorkspaceItem",
|
863
908
|
'400': "LusidValidationProblemDetails",
|
864
909
|
}
|
865
910
|
|
866
911
|
return self.api_client.call_api(
|
867
|
-
'/api/workspaces/
|
912
|
+
'/api/workspaces/{visibility}/{workspaceName}/items/{groupName}/{itemName}', 'GET',
|
868
913
|
_path_params,
|
869
914
|
_query_params,
|
870
915
|
_header_params,
|
@@ -883,26 +928,30 @@ class WorkspaceApi:
|
|
883
928
|
|
884
929
|
|
885
930
|
@overload
|
886
|
-
async def
|
931
|
+
async def get_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> Workspace: # noqa: E501
|
887
932
|
...
|
888
933
|
|
889
934
|
@overload
|
890
|
-
def
|
935
|
+
def get_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
891
936
|
...
|
892
937
|
|
893
938
|
@validate_arguments
|
894
|
-
def
|
895
|
-
"""[EXPERIMENTAL]
|
939
|
+
def get_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
940
|
+
"""[EXPERIMENTAL] GetWorkspace: Get a workspace. # noqa: E501
|
896
941
|
|
897
|
-
|
942
|
+
Get a workspace. # noqa: E501
|
898
943
|
This method makes a synchronous HTTP request by default. To make an
|
899
944
|
asynchronous HTTP request, please pass async_req=True
|
900
945
|
|
901
|
-
>>> thread = api.
|
946
|
+
>>> thread = api.get_workspace(visibility, workspace_name, as_at, async_req=True)
|
902
947
|
>>> result = thread.get()
|
903
948
|
|
904
|
-
:param
|
949
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
950
|
+
:type visibility: str
|
951
|
+
:param workspace_name: The workspace name. (required)
|
905
952
|
:type workspace_name: str
|
953
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
954
|
+
:type as_at: datetime
|
906
955
|
:param async_req: Whether to execute the request asynchronously.
|
907
956
|
:type async_req: bool, optional
|
908
957
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -911,29 +960,33 @@ class WorkspaceApi:
|
|
911
960
|
:return: Returns the result object.
|
912
961
|
If the method is called asynchronously,
|
913
962
|
returns the request thread.
|
914
|
-
:rtype:
|
963
|
+
:rtype: Workspace
|
915
964
|
"""
|
916
965
|
kwargs['_return_http_data_only'] = True
|
917
966
|
if '_preload_content' in kwargs:
|
918
|
-
message = "Error! Please call the
|
967
|
+
message = "Error! Please call the get_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
919
968
|
raise ValueError(message)
|
920
969
|
if async_req is not None:
|
921
970
|
kwargs['async_req'] = async_req
|
922
|
-
return self.
|
971
|
+
return self.get_workspace_with_http_info(visibility, workspace_name, as_at, **kwargs) # noqa: E501
|
923
972
|
|
924
973
|
@validate_arguments
|
925
|
-
def
|
926
|
-
"""[EXPERIMENTAL]
|
974
|
+
def get_workspace_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
975
|
+
"""[EXPERIMENTAL] GetWorkspace: Get a workspace. # noqa: E501
|
927
976
|
|
928
|
-
|
977
|
+
Get a workspace. # noqa: E501
|
929
978
|
This method makes a synchronous HTTP request by default. To make an
|
930
979
|
asynchronous HTTP request, please pass async_req=True
|
931
980
|
|
932
|
-
>>> thread = api.
|
981
|
+
>>> thread = api.get_workspace_with_http_info(visibility, workspace_name, as_at, async_req=True)
|
933
982
|
>>> result = thread.get()
|
934
983
|
|
935
|
-
:param
|
984
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
985
|
+
:type visibility: str
|
986
|
+
:param workspace_name: The workspace name. (required)
|
936
987
|
:type workspace_name: str
|
988
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
989
|
+
:type as_at: datetime
|
937
990
|
:param async_req: Whether to execute the request asynchronously.
|
938
991
|
:type async_req: bool, optional
|
939
992
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -955,13 +1008,15 @@ class WorkspaceApi:
|
|
955
1008
|
:return: Returns the result object.
|
956
1009
|
If the method is called asynchronously,
|
957
1010
|
returns the request thread.
|
958
|
-
:rtype: tuple(
|
1011
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
959
1012
|
"""
|
960
1013
|
|
961
1014
|
_params = locals()
|
962
1015
|
|
963
1016
|
_all_params = [
|
964
|
-
'
|
1017
|
+
'visibility',
|
1018
|
+
'workspace_name',
|
1019
|
+
'as_at'
|
965
1020
|
]
|
966
1021
|
_all_params.extend(
|
967
1022
|
[
|
@@ -981,7 +1036,7 @@ class WorkspaceApi:
|
|
981
1036
|
if _key not in _all_params:
|
982
1037
|
raise ApiTypeError(
|
983
1038
|
"Got an unexpected keyword argument '%s'"
|
984
|
-
" to method
|
1039
|
+
" to method get_workspace" % _key
|
985
1040
|
)
|
986
1041
|
_params[_key] = _val
|
987
1042
|
del _params['kwargs']
|
@@ -990,12 +1045,21 @@ class WorkspaceApi:
|
|
990
1045
|
|
991
1046
|
# process the path parameters
|
992
1047
|
_path_params = {}
|
1048
|
+
if _params['visibility']:
|
1049
|
+
_path_params['visibility'] = _params['visibility']
|
1050
|
+
|
993
1051
|
if _params['workspace_name']:
|
994
1052
|
_path_params['workspaceName'] = _params['workspace_name']
|
995
1053
|
|
996
1054
|
|
997
1055
|
# process the query parameters
|
998
1056
|
_query_params = []
|
1057
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1058
|
+
if isinstance(_params['as_at'], datetime):
|
1059
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1060
|
+
else:
|
1061
|
+
_query_params.append(('asAt', _params['as_at']))
|
1062
|
+
|
999
1063
|
# process the header parameters
|
1000
1064
|
_header_params = dict(_params.get('_headers', {}))
|
1001
1065
|
# process the form parameters
|
@@ -1011,12 +1075,12 @@ class WorkspaceApi:
|
|
1011
1075
|
_auth_settings = ['oauth2'] # noqa: E501
|
1012
1076
|
|
1013
1077
|
_response_types_map = {
|
1014
|
-
'200': "
|
1078
|
+
'200': "Workspace",
|
1015
1079
|
'400': "LusidValidationProblemDetails",
|
1016
1080
|
}
|
1017
1081
|
|
1018
1082
|
return self.api_client.call_api(
|
1019
|
-
'/api/workspaces/
|
1083
|
+
'/api/workspaces/{visibility}/{workspaceName}', 'GET',
|
1020
1084
|
_path_params,
|
1021
1085
|
_query_params,
|
1022
1086
|
_header_params,
|
@@ -1035,30 +1099,38 @@ class WorkspaceApi:
|
|
1035
1099
|
|
1036
1100
|
|
1037
1101
|
@overload
|
1038
|
-
async def
|
1102
|
+
async def list_items(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
1039
1103
|
...
|
1040
1104
|
|
1041
1105
|
@overload
|
1042
|
-
def
|
1106
|
+
def list_items(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
1043
1107
|
...
|
1044
1108
|
|
1045
1109
|
@validate_arguments
|
1046
|
-
def
|
1047
|
-
"""[EXPERIMENTAL]
|
1110
|
+
def list_items(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspaceItem, Awaitable[PagedResourceListOfWorkspaceItem]]: # noqa: E501
|
1111
|
+
"""[EXPERIMENTAL] ListItems: List the items in a workspace. # noqa: E501
|
1048
1112
|
|
1049
|
-
|
1113
|
+
List the items in a workspace. # noqa: E501
|
1050
1114
|
This method makes a synchronous HTTP request by default. To make an
|
1051
1115
|
asynchronous HTTP request, please pass async_req=True
|
1052
1116
|
|
1053
|
-
>>> thread = api.
|
1117
|
+
>>> thread = api.list_items(visibility, workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
1054
1118
|
>>> result = thread.get()
|
1055
1119
|
|
1056
|
-
:param
|
1120
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
1121
|
+
:type visibility: str
|
1122
|
+
:param workspace_name: The item's workspace name. (required)
|
1057
1123
|
:type workspace_name: str
|
1058
|
-
:param
|
1059
|
-
:type
|
1060
|
-
:param
|
1061
|
-
:type
|
1124
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
1125
|
+
:type as_at: datetime
|
1126
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1127
|
+
:type page: str
|
1128
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1129
|
+
:type sort_by: List[str]
|
1130
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
1131
|
+
:type limit: int
|
1132
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1133
|
+
:type filter: str
|
1062
1134
|
:param async_req: Whether to execute the request asynchronously.
|
1063
1135
|
:type async_req: bool, optional
|
1064
1136
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -1067,33 +1139,41 @@ class WorkspaceApi:
|
|
1067
1139
|
:return: Returns the result object.
|
1068
1140
|
If the method is called asynchronously,
|
1069
1141
|
returns the request thread.
|
1070
|
-
:rtype:
|
1142
|
+
:rtype: PagedResourceListOfWorkspaceItem
|
1071
1143
|
"""
|
1072
1144
|
kwargs['_return_http_data_only'] = True
|
1073
1145
|
if '_preload_content' in kwargs:
|
1074
|
-
message = "Error! Please call the
|
1146
|
+
message = "Error! Please call the list_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1075
1147
|
raise ValueError(message)
|
1076
1148
|
if async_req is not None:
|
1077
1149
|
kwargs['async_req'] = async_req
|
1078
|
-
return self.
|
1150
|
+
return self.list_items_with_http_info(visibility, workspace_name, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1079
1151
|
|
1080
1152
|
@validate_arguments
|
1081
|
-
def
|
1082
|
-
"""[EXPERIMENTAL]
|
1153
|
+
def list_items_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1154
|
+
"""[EXPERIMENTAL] ListItems: List the items in a workspace. # noqa: E501
|
1083
1155
|
|
1084
|
-
|
1156
|
+
List the items in a workspace. # noqa: E501
|
1085
1157
|
This method makes a synchronous HTTP request by default. To make an
|
1086
1158
|
asynchronous HTTP request, please pass async_req=True
|
1087
1159
|
|
1088
|
-
>>> thread = api.
|
1160
|
+
>>> thread = api.list_items_with_http_info(visibility, workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
1089
1161
|
>>> result = thread.get()
|
1090
1162
|
|
1091
|
-
:param
|
1163
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
1164
|
+
:type visibility: str
|
1165
|
+
:param workspace_name: The item's workspace name. (required)
|
1092
1166
|
:type workspace_name: str
|
1093
|
-
:param
|
1094
|
-
:type
|
1095
|
-
:param
|
1096
|
-
:type
|
1167
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
1168
|
+
:type as_at: datetime
|
1169
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1170
|
+
:type page: str
|
1171
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1172
|
+
:type sort_by: List[str]
|
1173
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
1174
|
+
:type limit: int
|
1175
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1176
|
+
:type filter: str
|
1097
1177
|
:param async_req: Whether to execute the request asynchronously.
|
1098
1178
|
:type async_req: bool, optional
|
1099
1179
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -1115,15 +1195,19 @@ class WorkspaceApi:
|
|
1115
1195
|
:return: Returns the result object.
|
1116
1196
|
If the method is called asynchronously,
|
1117
1197
|
returns the request thread.
|
1118
|
-
:rtype: tuple(
|
1198
|
+
:rtype: tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
1119
1199
|
"""
|
1120
1200
|
|
1121
1201
|
_params = locals()
|
1122
1202
|
|
1123
1203
|
_all_params = [
|
1204
|
+
'visibility',
|
1124
1205
|
'workspace_name',
|
1125
|
-
'
|
1126
|
-
'
|
1206
|
+
'as_at',
|
1207
|
+
'page',
|
1208
|
+
'sort_by',
|
1209
|
+
'limit',
|
1210
|
+
'filter'
|
1127
1211
|
]
|
1128
1212
|
_all_params.extend(
|
1129
1213
|
[
|
@@ -1143,7 +1227,7 @@ class WorkspaceApi:
|
|
1143
1227
|
if _key not in _all_params:
|
1144
1228
|
raise ApiTypeError(
|
1145
1229
|
"Got an unexpected keyword argument '%s'"
|
1146
|
-
" to method
|
1230
|
+
" to method list_items" % _key
|
1147
1231
|
)
|
1148
1232
|
_params[_key] = _val
|
1149
1233
|
del _params['kwargs']
|
@@ -1152,18 +1236,34 @@ class WorkspaceApi:
|
|
1152
1236
|
|
1153
1237
|
# process the path parameters
|
1154
1238
|
_path_params = {}
|
1239
|
+
if _params['visibility']:
|
1240
|
+
_path_params['visibility'] = _params['visibility']
|
1241
|
+
|
1155
1242
|
if _params['workspace_name']:
|
1156
1243
|
_path_params['workspaceName'] = _params['workspace_name']
|
1157
1244
|
|
1158
|
-
if _params['group_name']:
|
1159
|
-
_path_params['groupName'] = _params['group_name']
|
1160
|
-
|
1161
|
-
if _params['item_name']:
|
1162
|
-
_path_params['itemName'] = _params['item_name']
|
1163
|
-
|
1164
1245
|
|
1165
1246
|
# process the query parameters
|
1166
1247
|
_query_params = []
|
1248
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1249
|
+
if isinstance(_params['as_at'], datetime):
|
1250
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1251
|
+
else:
|
1252
|
+
_query_params.append(('asAt', _params['as_at']))
|
1253
|
+
|
1254
|
+
if _params.get('page') is not None: # noqa: E501
|
1255
|
+
_query_params.append(('page', _params['page']))
|
1256
|
+
|
1257
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
1258
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
1259
|
+
_collection_formats['sortBy'] = 'multi'
|
1260
|
+
|
1261
|
+
if _params.get('limit') is not None: # noqa: E501
|
1262
|
+
_query_params.append(('limit', _params['limit']))
|
1263
|
+
|
1264
|
+
if _params.get('filter') is not None: # noqa: E501
|
1265
|
+
_query_params.append(('filter', _params['filter']))
|
1266
|
+
|
1167
1267
|
# process the header parameters
|
1168
1268
|
_header_params = dict(_params.get('_headers', {}))
|
1169
1269
|
# process the form parameters
|
@@ -1179,12 +1279,12 @@ class WorkspaceApi:
|
|
1179
1279
|
_auth_settings = ['oauth2'] # noqa: E501
|
1180
1280
|
|
1181
1281
|
_response_types_map = {
|
1182
|
-
'200': "
|
1282
|
+
'200': "PagedResourceListOfWorkspaceItem",
|
1183
1283
|
'400': "LusidValidationProblemDetails",
|
1184
1284
|
}
|
1185
1285
|
|
1186
1286
|
return self.api_client.call_api(
|
1187
|
-
'/api/workspaces/
|
1287
|
+
'/api/workspaces/{visibility}/{workspaceName}/items', 'GET',
|
1188
1288
|
_path_params,
|
1189
1289
|
_query_params,
|
1190
1290
|
_header_params,
|
@@ -1203,26 +1303,36 @@ class WorkspaceApi:
|
|
1203
1303
|
|
1204
1304
|
|
1205
1305
|
@overload
|
1206
|
-
async def
|
1306
|
+
async def list_workspaces(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspaces. Must be `shared` or `personal`; case is important.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
1207
1307
|
...
|
1208
1308
|
|
1209
1309
|
@overload
|
1210
|
-
def
|
1310
|
+
def list_workspaces(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspaces. Must be `shared` or `personal`; case is important.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
1211
1311
|
...
|
1212
1312
|
|
1213
1313
|
@validate_arguments
|
1214
|
-
def
|
1215
|
-
"""[EXPERIMENTAL]
|
1314
|
+
def list_workspaces(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspaces. Must be `shared` or `personal`; case is important.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspace, Awaitable[PagedResourceListOfWorkspace]]: # noqa: E501
|
1315
|
+
"""[EXPERIMENTAL] ListWorkspaces: List workspaces. # noqa: E501
|
1216
1316
|
|
1217
|
-
|
1317
|
+
List workspaces. # noqa: E501
|
1218
1318
|
This method makes a synchronous HTTP request by default. To make an
|
1219
1319
|
asynchronous HTTP request, please pass async_req=True
|
1220
1320
|
|
1221
|
-
>>> thread = api.
|
1321
|
+
>>> thread = api.list_workspaces(visibility, as_at, page, sort_by, limit, filter, async_req=True)
|
1222
1322
|
>>> result = thread.get()
|
1223
1323
|
|
1224
|
-
:param
|
1225
|
-
:type
|
1324
|
+
:param visibility: The visibility for the workspaces. Must be `shared` or `personal`; case is important. (required)
|
1325
|
+
:type visibility: str
|
1326
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1327
|
+
:type as_at: datetime
|
1328
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1329
|
+
:type page: str
|
1330
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1331
|
+
:type sort_by: List[str]
|
1332
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
1333
|
+
:type limit: int
|
1334
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1335
|
+
:type filter: str
|
1226
1336
|
:param async_req: Whether to execute the request asynchronously.
|
1227
1337
|
:type async_req: bool, optional
|
1228
1338
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -1231,29 +1341,39 @@ class WorkspaceApi:
|
|
1231
1341
|
:return: Returns the result object.
|
1232
1342
|
If the method is called asynchronously,
|
1233
1343
|
returns the request thread.
|
1234
|
-
:rtype:
|
1344
|
+
:rtype: PagedResourceListOfWorkspace
|
1235
1345
|
"""
|
1236
1346
|
kwargs['_return_http_data_only'] = True
|
1237
1347
|
if '_preload_content' in kwargs:
|
1238
|
-
message = "Error! Please call the
|
1348
|
+
message = "Error! Please call the list_workspaces_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1239
1349
|
raise ValueError(message)
|
1240
1350
|
if async_req is not None:
|
1241
1351
|
kwargs['async_req'] = async_req
|
1242
|
-
return self.
|
1352
|
+
return self.list_workspaces_with_http_info(visibility, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1243
1353
|
|
1244
1354
|
@validate_arguments
|
1245
|
-
def
|
1246
|
-
"""[EXPERIMENTAL]
|
1355
|
+
def list_workspaces_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspaces. Must be `shared` or `personal`; case is important.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1356
|
+
"""[EXPERIMENTAL] ListWorkspaces: List workspaces. # noqa: E501
|
1247
1357
|
|
1248
|
-
|
1358
|
+
List workspaces. # noqa: E501
|
1249
1359
|
This method makes a synchronous HTTP request by default. To make an
|
1250
1360
|
asynchronous HTTP request, please pass async_req=True
|
1251
1361
|
|
1252
|
-
>>> thread = api.
|
1362
|
+
>>> thread = api.list_workspaces_with_http_info(visibility, as_at, page, sort_by, limit, filter, async_req=True)
|
1253
1363
|
>>> result = thread.get()
|
1254
1364
|
|
1255
|
-
:param
|
1256
|
-
:type
|
1365
|
+
:param visibility: The visibility for the workspaces. Must be `shared` or `personal`; case is important. (required)
|
1366
|
+
:type visibility: str
|
1367
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1368
|
+
:type as_at: datetime
|
1369
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1370
|
+
:type page: str
|
1371
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1372
|
+
:type sort_by: List[str]
|
1373
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
1374
|
+
:type limit: int
|
1375
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1376
|
+
:type filter: str
|
1257
1377
|
:param async_req: Whether to execute the request asynchronously.
|
1258
1378
|
:type async_req: bool, optional
|
1259
1379
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -1275,13 +1395,18 @@ class WorkspaceApi:
|
|
1275
1395
|
:return: Returns the result object.
|
1276
1396
|
If the method is called asynchronously,
|
1277
1397
|
returns the request thread.
|
1278
|
-
:rtype: tuple(
|
1398
|
+
:rtype: tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))
|
1279
1399
|
"""
|
1280
1400
|
|
1281
1401
|
_params = locals()
|
1282
1402
|
|
1283
1403
|
_all_params = [
|
1284
|
-
'
|
1404
|
+
'visibility',
|
1405
|
+
'as_at',
|
1406
|
+
'page',
|
1407
|
+
'sort_by',
|
1408
|
+
'limit',
|
1409
|
+
'filter'
|
1285
1410
|
]
|
1286
1411
|
_all_params.extend(
|
1287
1412
|
[
|
@@ -1301,7 +1426,7 @@ class WorkspaceApi:
|
|
1301
1426
|
if _key not in _all_params:
|
1302
1427
|
raise ApiTypeError(
|
1303
1428
|
"Got an unexpected keyword argument '%s'"
|
1304
|
-
" to method
|
1429
|
+
" to method list_workspaces" % _key
|
1305
1430
|
)
|
1306
1431
|
_params[_key] = _val
|
1307
1432
|
del _params['kwargs']
|
@@ -1310,12 +1435,31 @@ class WorkspaceApi:
|
|
1310
1435
|
|
1311
1436
|
# process the path parameters
|
1312
1437
|
_path_params = {}
|
1313
|
-
if _params['
|
1314
|
-
_path_params['
|
1438
|
+
if _params['visibility']:
|
1439
|
+
_path_params['visibility'] = _params['visibility']
|
1315
1440
|
|
1316
1441
|
|
1317
1442
|
# process the query parameters
|
1318
1443
|
_query_params = []
|
1444
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1445
|
+
if isinstance(_params['as_at'], datetime):
|
1446
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1447
|
+
else:
|
1448
|
+
_query_params.append(('asAt', _params['as_at']))
|
1449
|
+
|
1450
|
+
if _params.get('page') is not None: # noqa: E501
|
1451
|
+
_query_params.append(('page', _params['page']))
|
1452
|
+
|
1453
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
1454
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
1455
|
+
_collection_formats['sortBy'] = 'multi'
|
1456
|
+
|
1457
|
+
if _params.get('limit') is not None: # noqa: E501
|
1458
|
+
_query_params.append(('limit', _params['limit']))
|
1459
|
+
|
1460
|
+
if _params.get('filter') is not None: # noqa: E501
|
1461
|
+
_query_params.append(('filter', _params['filter']))
|
1462
|
+
|
1319
1463
|
# process the header parameters
|
1320
1464
|
_header_params = dict(_params.get('_headers', {}))
|
1321
1465
|
# process the form parameters
|
@@ -1331,12 +1475,12 @@ class WorkspaceApi:
|
|
1331
1475
|
_auth_settings = ['oauth2'] # noqa: E501
|
1332
1476
|
|
1333
1477
|
_response_types_map = {
|
1334
|
-
'200': "
|
1478
|
+
'200': "PagedResourceListOfWorkspace",
|
1335
1479
|
'400': "LusidValidationProblemDetails",
|
1336
1480
|
}
|
1337
1481
|
|
1338
1482
|
return self.api_client.call_api(
|
1339
|
-
'/api/workspaces/
|
1483
|
+
'/api/workspaces/{visibility}', 'GET',
|
1340
1484
|
_path_params,
|
1341
1485
|
_query_params,
|
1342
1486
|
_header_params,
|
@@ -1355,32 +1499,34 @@ class WorkspaceApi:
|
|
1355
1499
|
|
1356
1500
|
|
1357
1501
|
@overload
|
1358
|
-
async def
|
1502
|
+
async def update_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
1359
1503
|
...
|
1360
1504
|
|
1361
1505
|
@overload
|
1362
|
-
def
|
1506
|
+
def update_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
1363
1507
|
...
|
1364
1508
|
|
1365
1509
|
@validate_arguments
|
1366
|
-
def
|
1367
|
-
"""[EXPERIMENTAL]
|
1510
|
+
def update_item(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
1511
|
+
"""[EXPERIMENTAL] UpdateItem: Update an item in a workspace. # noqa: E501
|
1368
1512
|
|
1369
|
-
|
1513
|
+
Update an item in a workspace. # noqa: E501
|
1370
1514
|
This method makes a synchronous HTTP request by default. To make an
|
1371
1515
|
asynchronous HTTP request, please pass async_req=True
|
1372
1516
|
|
1373
|
-
>>> thread = api.
|
1517
|
+
>>> thread = api.update_item(visibility, workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
1374
1518
|
>>> result = thread.get()
|
1375
1519
|
|
1376
|
-
:param
|
1520
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
1521
|
+
:type visibility: str
|
1522
|
+
:param workspace_name: The workspace name. (required)
|
1377
1523
|
:type workspace_name: str
|
1378
1524
|
:param group_name: The group containing the item. (required)
|
1379
1525
|
:type group_name: str
|
1380
|
-
:param item_name: The name
|
1526
|
+
:param item_name: The item name. (required)
|
1381
1527
|
:type item_name: str
|
1382
|
-
:param
|
1383
|
-
:type
|
1528
|
+
:param workspace_item_update_request: The new item details.
|
1529
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
1384
1530
|
:param async_req: Whether to execute the request asynchronously.
|
1385
1531
|
:type async_req: bool, optional
|
1386
1532
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -1393,31 +1539,33 @@ class WorkspaceApi:
|
|
1393
1539
|
"""
|
1394
1540
|
kwargs['_return_http_data_only'] = True
|
1395
1541
|
if '_preload_content' in kwargs:
|
1396
|
-
message = "Error! Please call the
|
1542
|
+
message = "Error! Please call the update_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1397
1543
|
raise ValueError(message)
|
1398
1544
|
if async_req is not None:
|
1399
1545
|
kwargs['async_req'] = async_req
|
1400
|
-
return self.
|
1546
|
+
return self.update_item_with_http_info(visibility, workspace_name, group_name, item_name, workspace_item_update_request, **kwargs) # noqa: E501
|
1401
1547
|
|
1402
1548
|
@validate_arguments
|
1403
|
-
def
|
1404
|
-
"""[EXPERIMENTAL]
|
1549
|
+
def update_item_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the containing workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1550
|
+
"""[EXPERIMENTAL] UpdateItem: Update an item in a workspace. # noqa: E501
|
1405
1551
|
|
1406
|
-
|
1552
|
+
Update an item in a workspace. # noqa: E501
|
1407
1553
|
This method makes a synchronous HTTP request by default. To make an
|
1408
1554
|
asynchronous HTTP request, please pass async_req=True
|
1409
1555
|
|
1410
|
-
>>> thread = api.
|
1556
|
+
>>> thread = api.update_item_with_http_info(visibility, workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
1411
1557
|
>>> result = thread.get()
|
1412
1558
|
|
1413
|
-
:param
|
1559
|
+
:param visibility: The visibility for the containing workspace. Must be `shared` or `personal`; case is important. (required)
|
1560
|
+
:type visibility: str
|
1561
|
+
:param workspace_name: The workspace name. (required)
|
1414
1562
|
:type workspace_name: str
|
1415
1563
|
:param group_name: The group containing the item. (required)
|
1416
1564
|
:type group_name: str
|
1417
|
-
:param item_name: The name
|
1565
|
+
:param item_name: The item name. (required)
|
1418
1566
|
:type item_name: str
|
1419
|
-
:param
|
1420
|
-
:type
|
1567
|
+
:param workspace_item_update_request: The new item details.
|
1568
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
1421
1569
|
:param async_req: Whether to execute the request asynchronously.
|
1422
1570
|
:type async_req: bool, optional
|
1423
1571
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -1445,10 +1593,11 @@ class WorkspaceApi:
|
|
1445
1593
|
_params = locals()
|
1446
1594
|
|
1447
1595
|
_all_params = [
|
1596
|
+
'visibility',
|
1448
1597
|
'workspace_name',
|
1449
1598
|
'group_name',
|
1450
1599
|
'item_name',
|
1451
|
-
'
|
1600
|
+
'workspace_item_update_request'
|
1452
1601
|
]
|
1453
1602
|
_all_params.extend(
|
1454
1603
|
[
|
@@ -1468,1809 +1617,7 @@ class WorkspaceApi:
|
|
1468
1617
|
if _key not in _all_params:
|
1469
1618
|
raise ApiTypeError(
|
1470
1619
|
"Got an unexpected keyword argument '%s'"
|
1471
|
-
" to method
|
1472
|
-
)
|
1473
|
-
_params[_key] = _val
|
1474
|
-
del _params['kwargs']
|
1475
|
-
|
1476
|
-
_collection_formats = {}
|
1477
|
-
|
1478
|
-
# process the path parameters
|
1479
|
-
_path_params = {}
|
1480
|
-
if _params['workspace_name']:
|
1481
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
1482
|
-
|
1483
|
-
if _params['group_name']:
|
1484
|
-
_path_params['groupName'] = _params['group_name']
|
1485
|
-
|
1486
|
-
if _params['item_name']:
|
1487
|
-
_path_params['itemName'] = _params['item_name']
|
1488
|
-
|
1489
|
-
|
1490
|
-
# process the query parameters
|
1491
|
-
_query_params = []
|
1492
|
-
if _params.get('as_at') is not None: # noqa: E501
|
1493
|
-
if isinstance(_params['as_at'], datetime):
|
1494
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1495
|
-
else:
|
1496
|
-
_query_params.append(('asAt', _params['as_at']))
|
1497
|
-
|
1498
|
-
# process the header parameters
|
1499
|
-
_header_params = dict(_params.get('_headers', {}))
|
1500
|
-
# process the form parameters
|
1501
|
-
_form_params = []
|
1502
|
-
_files = {}
|
1503
|
-
# process the body parameter
|
1504
|
-
_body_params = None
|
1505
|
-
# set the HTTP header `Accept`
|
1506
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1507
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1508
|
-
|
1509
|
-
# authentication setting
|
1510
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
1511
|
-
|
1512
|
-
_response_types_map = {
|
1513
|
-
'200': "WorkspaceItem",
|
1514
|
-
'400': "LusidValidationProblemDetails",
|
1515
|
-
}
|
1516
|
-
|
1517
|
-
return self.api_client.call_api(
|
1518
|
-
'/api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName}', 'GET',
|
1519
|
-
_path_params,
|
1520
|
-
_query_params,
|
1521
|
-
_header_params,
|
1522
|
-
body=_body_params,
|
1523
|
-
post_params=_form_params,
|
1524
|
-
files=_files,
|
1525
|
-
response_types_map=_response_types_map,
|
1526
|
-
auth_settings=_auth_settings,
|
1527
|
-
async_req=_params.get('async_req'),
|
1528
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1529
|
-
_preload_content=_params.get('_preload_content', True),
|
1530
|
-
_request_timeout=_params.get('_request_timeout'),
|
1531
|
-
opts=_params.get('opts'),
|
1532
|
-
collection_formats=_collection_formats,
|
1533
|
-
_request_auth=_params.get('_request_auth'))
|
1534
|
-
|
1535
|
-
|
1536
|
-
@overload
|
1537
|
-
async def get_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> Workspace: # noqa: E501
|
1538
|
-
...
|
1539
|
-
|
1540
|
-
@overload
|
1541
|
-
def get_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
1542
|
-
...
|
1543
|
-
|
1544
|
-
@validate_arguments
|
1545
|
-
def get_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
1546
|
-
"""[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501
|
1547
|
-
|
1548
|
-
Get a personal workspace. # noqa: E501
|
1549
|
-
This method makes a synchronous HTTP request by default. To make an
|
1550
|
-
asynchronous HTTP request, please pass async_req=True
|
1551
|
-
|
1552
|
-
>>> thread = api.get_personal_workspace(workspace_name, as_at, async_req=True)
|
1553
|
-
>>> result = thread.get()
|
1554
|
-
|
1555
|
-
:param workspace_name: The personal workspace name. (required)
|
1556
|
-
:type workspace_name: str
|
1557
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1558
|
-
:type as_at: datetime
|
1559
|
-
:param async_req: Whether to execute the request asynchronously.
|
1560
|
-
:type async_req: bool, optional
|
1561
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1562
|
-
:param opts: Configuration options for this request
|
1563
|
-
:type opts: ConfigurationOptions, optional
|
1564
|
-
:return: Returns the result object.
|
1565
|
-
If the method is called asynchronously,
|
1566
|
-
returns the request thread.
|
1567
|
-
:rtype: Workspace
|
1568
|
-
"""
|
1569
|
-
kwargs['_return_http_data_only'] = True
|
1570
|
-
if '_preload_content' in kwargs:
|
1571
|
-
message = "Error! Please call the get_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1572
|
-
raise ValueError(message)
|
1573
|
-
if async_req is not None:
|
1574
|
-
kwargs['async_req'] = async_req
|
1575
|
-
return self.get_personal_workspace_with_http_info(workspace_name, as_at, **kwargs) # noqa: E501
|
1576
|
-
|
1577
|
-
@validate_arguments
|
1578
|
-
def get_personal_workspace_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1579
|
-
"""[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501
|
1580
|
-
|
1581
|
-
Get a personal workspace. # noqa: E501
|
1582
|
-
This method makes a synchronous HTTP request by default. To make an
|
1583
|
-
asynchronous HTTP request, please pass async_req=True
|
1584
|
-
|
1585
|
-
>>> thread = api.get_personal_workspace_with_http_info(workspace_name, as_at, async_req=True)
|
1586
|
-
>>> result = thread.get()
|
1587
|
-
|
1588
|
-
:param workspace_name: The personal workspace name. (required)
|
1589
|
-
:type workspace_name: str
|
1590
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1591
|
-
:type as_at: datetime
|
1592
|
-
:param async_req: Whether to execute the request asynchronously.
|
1593
|
-
:type async_req: bool, optional
|
1594
|
-
:param _preload_content: if False, the ApiResponse.data will
|
1595
|
-
be set to none and raw_data will store the
|
1596
|
-
HTTP response body without reading/decoding.
|
1597
|
-
Default is True.
|
1598
|
-
:type _preload_content: bool, optional
|
1599
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
1600
|
-
object with status code, headers, etc
|
1601
|
-
:type _return_http_data_only: bool, optional
|
1602
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1603
|
-
:param opts: Configuration options for this request
|
1604
|
-
:type opts: ConfigurationOptions, optional
|
1605
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1606
|
-
request; this effectively ignores the authentication
|
1607
|
-
in the spec for a single request.
|
1608
|
-
:type _request_auth: dict, optional
|
1609
|
-
:type _content_type: string, optional: force content-type for the request
|
1610
|
-
:return: Returns the result object.
|
1611
|
-
If the method is called asynchronously,
|
1612
|
-
returns the request thread.
|
1613
|
-
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
1614
|
-
"""
|
1615
|
-
|
1616
|
-
_params = locals()
|
1617
|
-
|
1618
|
-
_all_params = [
|
1619
|
-
'workspace_name',
|
1620
|
-
'as_at'
|
1621
|
-
]
|
1622
|
-
_all_params.extend(
|
1623
|
-
[
|
1624
|
-
'async_req',
|
1625
|
-
'_return_http_data_only',
|
1626
|
-
'_preload_content',
|
1627
|
-
'_request_timeout',
|
1628
|
-
'_request_auth',
|
1629
|
-
'_content_type',
|
1630
|
-
'_headers',
|
1631
|
-
'opts'
|
1632
|
-
]
|
1633
|
-
)
|
1634
|
-
|
1635
|
-
# validate the arguments
|
1636
|
-
for _key, _val in _params['kwargs'].items():
|
1637
|
-
if _key not in _all_params:
|
1638
|
-
raise ApiTypeError(
|
1639
|
-
"Got an unexpected keyword argument '%s'"
|
1640
|
-
" to method get_personal_workspace" % _key
|
1641
|
-
)
|
1642
|
-
_params[_key] = _val
|
1643
|
-
del _params['kwargs']
|
1644
|
-
|
1645
|
-
_collection_formats = {}
|
1646
|
-
|
1647
|
-
# process the path parameters
|
1648
|
-
_path_params = {}
|
1649
|
-
if _params['workspace_name']:
|
1650
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
1651
|
-
|
1652
|
-
|
1653
|
-
# process the query parameters
|
1654
|
-
_query_params = []
|
1655
|
-
if _params.get('as_at') is not None: # noqa: E501
|
1656
|
-
if isinstance(_params['as_at'], datetime):
|
1657
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1658
|
-
else:
|
1659
|
-
_query_params.append(('asAt', _params['as_at']))
|
1660
|
-
|
1661
|
-
# process the header parameters
|
1662
|
-
_header_params = dict(_params.get('_headers', {}))
|
1663
|
-
# process the form parameters
|
1664
|
-
_form_params = []
|
1665
|
-
_files = {}
|
1666
|
-
# process the body parameter
|
1667
|
-
_body_params = None
|
1668
|
-
# set the HTTP header `Accept`
|
1669
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1670
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1671
|
-
|
1672
|
-
# authentication setting
|
1673
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
1674
|
-
|
1675
|
-
_response_types_map = {
|
1676
|
-
'200': "Workspace",
|
1677
|
-
'400': "LusidValidationProblemDetails",
|
1678
|
-
}
|
1679
|
-
|
1680
|
-
return self.api_client.call_api(
|
1681
|
-
'/api/workspaces/personal/{workspaceName}', 'GET',
|
1682
|
-
_path_params,
|
1683
|
-
_query_params,
|
1684
|
-
_header_params,
|
1685
|
-
body=_body_params,
|
1686
|
-
post_params=_form_params,
|
1687
|
-
files=_files,
|
1688
|
-
response_types_map=_response_types_map,
|
1689
|
-
auth_settings=_auth_settings,
|
1690
|
-
async_req=_params.get('async_req'),
|
1691
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1692
|
-
_preload_content=_params.get('_preload_content', True),
|
1693
|
-
_request_timeout=_params.get('_request_timeout'),
|
1694
|
-
opts=_params.get('opts'),
|
1695
|
-
collection_formats=_collection_formats,
|
1696
|
-
_request_auth=_params.get('_request_auth'))
|
1697
|
-
|
1698
|
-
|
1699
|
-
@overload
|
1700
|
-
async def get_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The name of the shared workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
1701
|
-
...
|
1702
|
-
|
1703
|
-
@overload
|
1704
|
-
def get_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The name of the shared workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
1705
|
-
...
|
1706
|
-
|
1707
|
-
@validate_arguments
|
1708
|
-
def get_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The name of the shared workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
1709
|
-
"""[EXPERIMENTAL] GetSharedItem: Get a single shared workspace item. # noqa: E501
|
1710
|
-
|
1711
|
-
Get a single shared workspace item. # noqa: E501
|
1712
|
-
This method makes a synchronous HTTP request by default. To make an
|
1713
|
-
asynchronous HTTP request, please pass async_req=True
|
1714
|
-
|
1715
|
-
>>> thread = api.get_shared_item(workspace_name, group_name, item_name, as_at, async_req=True)
|
1716
|
-
>>> result = thread.get()
|
1717
|
-
|
1718
|
-
:param workspace_name: The name of the shared workspace. (required)
|
1719
|
-
:type workspace_name: str
|
1720
|
-
:param group_name: The group containing the item. (required)
|
1721
|
-
:type group_name: str
|
1722
|
-
:param item_name: The name of the item. (required)
|
1723
|
-
:type item_name: str
|
1724
|
-
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1725
|
-
:type as_at: datetime
|
1726
|
-
:param async_req: Whether to execute the request asynchronously.
|
1727
|
-
:type async_req: bool, optional
|
1728
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1729
|
-
:param opts: Configuration options for this request
|
1730
|
-
:type opts: ConfigurationOptions, optional
|
1731
|
-
:return: Returns the result object.
|
1732
|
-
If the method is called asynchronously,
|
1733
|
-
returns the request thread.
|
1734
|
-
:rtype: WorkspaceItem
|
1735
|
-
"""
|
1736
|
-
kwargs['_return_http_data_only'] = True
|
1737
|
-
if '_preload_content' in kwargs:
|
1738
|
-
message = "Error! Please call the get_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1739
|
-
raise ValueError(message)
|
1740
|
-
if async_req is not None:
|
1741
|
-
kwargs['async_req'] = async_req
|
1742
|
-
return self.get_shared_item_with_http_info(workspace_name, group_name, item_name, as_at, **kwargs) # noqa: E501
|
1743
|
-
|
1744
|
-
@validate_arguments
|
1745
|
-
def get_shared_item_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The name of the shared workspace.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1746
|
-
"""[EXPERIMENTAL] GetSharedItem: Get a single shared workspace item. # noqa: E501
|
1747
|
-
|
1748
|
-
Get a single shared workspace item. # noqa: E501
|
1749
|
-
This method makes a synchronous HTTP request by default. To make an
|
1750
|
-
asynchronous HTTP request, please pass async_req=True
|
1751
|
-
|
1752
|
-
>>> thread = api.get_shared_item_with_http_info(workspace_name, group_name, item_name, as_at, async_req=True)
|
1753
|
-
>>> result = thread.get()
|
1754
|
-
|
1755
|
-
:param workspace_name: The name of the shared workspace. (required)
|
1756
|
-
:type workspace_name: str
|
1757
|
-
:param group_name: The group containing the item. (required)
|
1758
|
-
:type group_name: str
|
1759
|
-
:param item_name: The name of the item. (required)
|
1760
|
-
:type item_name: str
|
1761
|
-
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1762
|
-
:type as_at: datetime
|
1763
|
-
:param async_req: Whether to execute the request asynchronously.
|
1764
|
-
:type async_req: bool, optional
|
1765
|
-
:param _preload_content: if False, the ApiResponse.data will
|
1766
|
-
be set to none and raw_data will store the
|
1767
|
-
HTTP response body without reading/decoding.
|
1768
|
-
Default is True.
|
1769
|
-
:type _preload_content: bool, optional
|
1770
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
1771
|
-
object with status code, headers, etc
|
1772
|
-
:type _return_http_data_only: bool, optional
|
1773
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1774
|
-
:param opts: Configuration options for this request
|
1775
|
-
:type opts: ConfigurationOptions, optional
|
1776
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1777
|
-
request; this effectively ignores the authentication
|
1778
|
-
in the spec for a single request.
|
1779
|
-
:type _request_auth: dict, optional
|
1780
|
-
:type _content_type: string, optional: force content-type for the request
|
1781
|
-
:return: Returns the result object.
|
1782
|
-
If the method is called asynchronously,
|
1783
|
-
returns the request thread.
|
1784
|
-
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
1785
|
-
"""
|
1786
|
-
|
1787
|
-
_params = locals()
|
1788
|
-
|
1789
|
-
_all_params = [
|
1790
|
-
'workspace_name',
|
1791
|
-
'group_name',
|
1792
|
-
'item_name',
|
1793
|
-
'as_at'
|
1794
|
-
]
|
1795
|
-
_all_params.extend(
|
1796
|
-
[
|
1797
|
-
'async_req',
|
1798
|
-
'_return_http_data_only',
|
1799
|
-
'_preload_content',
|
1800
|
-
'_request_timeout',
|
1801
|
-
'_request_auth',
|
1802
|
-
'_content_type',
|
1803
|
-
'_headers',
|
1804
|
-
'opts'
|
1805
|
-
]
|
1806
|
-
)
|
1807
|
-
|
1808
|
-
# validate the arguments
|
1809
|
-
for _key, _val in _params['kwargs'].items():
|
1810
|
-
if _key not in _all_params:
|
1811
|
-
raise ApiTypeError(
|
1812
|
-
"Got an unexpected keyword argument '%s'"
|
1813
|
-
" to method get_shared_item" % _key
|
1814
|
-
)
|
1815
|
-
_params[_key] = _val
|
1816
|
-
del _params['kwargs']
|
1817
|
-
|
1818
|
-
_collection_formats = {}
|
1819
|
-
|
1820
|
-
# process the path parameters
|
1821
|
-
_path_params = {}
|
1822
|
-
if _params['workspace_name']:
|
1823
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
1824
|
-
|
1825
|
-
if _params['group_name']:
|
1826
|
-
_path_params['groupName'] = _params['group_name']
|
1827
|
-
|
1828
|
-
if _params['item_name']:
|
1829
|
-
_path_params['itemName'] = _params['item_name']
|
1830
|
-
|
1831
|
-
|
1832
|
-
# process the query parameters
|
1833
|
-
_query_params = []
|
1834
|
-
if _params.get('as_at') is not None: # noqa: E501
|
1835
|
-
if isinstance(_params['as_at'], datetime):
|
1836
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1837
|
-
else:
|
1838
|
-
_query_params.append(('asAt', _params['as_at']))
|
1839
|
-
|
1840
|
-
# process the header parameters
|
1841
|
-
_header_params = dict(_params.get('_headers', {}))
|
1842
|
-
# process the form parameters
|
1843
|
-
_form_params = []
|
1844
|
-
_files = {}
|
1845
|
-
# process the body parameter
|
1846
|
-
_body_params = None
|
1847
|
-
# set the HTTP header `Accept`
|
1848
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
1849
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1850
|
-
|
1851
|
-
# authentication setting
|
1852
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
1853
|
-
|
1854
|
-
_response_types_map = {
|
1855
|
-
'200': "WorkspaceItem",
|
1856
|
-
'400': "LusidValidationProblemDetails",
|
1857
|
-
}
|
1858
|
-
|
1859
|
-
return self.api_client.call_api(
|
1860
|
-
'/api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName}', 'GET',
|
1861
|
-
_path_params,
|
1862
|
-
_query_params,
|
1863
|
-
_header_params,
|
1864
|
-
body=_body_params,
|
1865
|
-
post_params=_form_params,
|
1866
|
-
files=_files,
|
1867
|
-
response_types_map=_response_types_map,
|
1868
|
-
auth_settings=_auth_settings,
|
1869
|
-
async_req=_params.get('async_req'),
|
1870
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1871
|
-
_preload_content=_params.get('_preload_content', True),
|
1872
|
-
_request_timeout=_params.get('_request_timeout'),
|
1873
|
-
opts=_params.get('opts'),
|
1874
|
-
collection_formats=_collection_formats,
|
1875
|
-
_request_auth=_params.get('_request_auth'))
|
1876
|
-
|
1877
|
-
|
1878
|
-
@overload
|
1879
|
-
async def get_shared_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> Workspace: # noqa: E501
|
1880
|
-
...
|
1881
|
-
|
1882
|
-
@overload
|
1883
|
-
def get_shared_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
1884
|
-
...
|
1885
|
-
|
1886
|
-
@validate_arguments
|
1887
|
-
def get_shared_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
1888
|
-
"""[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501
|
1889
|
-
|
1890
|
-
Get a shared workspace. # noqa: E501
|
1891
|
-
This method makes a synchronous HTTP request by default. To make an
|
1892
|
-
asynchronous HTTP request, please pass async_req=True
|
1893
|
-
|
1894
|
-
>>> thread = api.get_shared_workspace(workspace_name, as_at, async_req=True)
|
1895
|
-
>>> result = thread.get()
|
1896
|
-
|
1897
|
-
:param workspace_name: The shared workspace name. (required)
|
1898
|
-
:type workspace_name: str
|
1899
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1900
|
-
:type as_at: datetime
|
1901
|
-
:param async_req: Whether to execute the request asynchronously.
|
1902
|
-
:type async_req: bool, optional
|
1903
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1904
|
-
:param opts: Configuration options for this request
|
1905
|
-
:type opts: ConfigurationOptions, optional
|
1906
|
-
:return: Returns the result object.
|
1907
|
-
If the method is called asynchronously,
|
1908
|
-
returns the request thread.
|
1909
|
-
:rtype: Workspace
|
1910
|
-
"""
|
1911
|
-
kwargs['_return_http_data_only'] = True
|
1912
|
-
if '_preload_content' in kwargs:
|
1913
|
-
message = "Error! Please call the get_shared_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1914
|
-
raise ValueError(message)
|
1915
|
-
if async_req is not None:
|
1916
|
-
kwargs['async_req'] = async_req
|
1917
|
-
return self.get_shared_workspace_with_http_info(workspace_name, as_at, **kwargs) # noqa: E501
|
1918
|
-
|
1919
|
-
@validate_arguments
|
1920
|
-
def get_shared_workspace_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1921
|
-
"""[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501
|
1922
|
-
|
1923
|
-
Get a shared workspace. # noqa: E501
|
1924
|
-
This method makes a synchronous HTTP request by default. To make an
|
1925
|
-
asynchronous HTTP request, please pass async_req=True
|
1926
|
-
|
1927
|
-
>>> thread = api.get_shared_workspace_with_http_info(workspace_name, as_at, async_req=True)
|
1928
|
-
>>> result = thread.get()
|
1929
|
-
|
1930
|
-
:param workspace_name: The shared workspace name. (required)
|
1931
|
-
:type workspace_name: str
|
1932
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1933
|
-
:type as_at: datetime
|
1934
|
-
:param async_req: Whether to execute the request asynchronously.
|
1935
|
-
:type async_req: bool, optional
|
1936
|
-
:param _preload_content: if False, the ApiResponse.data will
|
1937
|
-
be set to none and raw_data will store the
|
1938
|
-
HTTP response body without reading/decoding.
|
1939
|
-
Default is True.
|
1940
|
-
:type _preload_content: bool, optional
|
1941
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
1942
|
-
object with status code, headers, etc
|
1943
|
-
:type _return_http_data_only: bool, optional
|
1944
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1945
|
-
:param opts: Configuration options for this request
|
1946
|
-
:type opts: ConfigurationOptions, optional
|
1947
|
-
:param _request_auth: set to override the auth_settings for an a single
|
1948
|
-
request; this effectively ignores the authentication
|
1949
|
-
in the spec for a single request.
|
1950
|
-
:type _request_auth: dict, optional
|
1951
|
-
:type _content_type: string, optional: force content-type for the request
|
1952
|
-
:return: Returns the result object.
|
1953
|
-
If the method is called asynchronously,
|
1954
|
-
returns the request thread.
|
1955
|
-
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
1956
|
-
"""
|
1957
|
-
|
1958
|
-
_params = locals()
|
1959
|
-
|
1960
|
-
_all_params = [
|
1961
|
-
'workspace_name',
|
1962
|
-
'as_at'
|
1963
|
-
]
|
1964
|
-
_all_params.extend(
|
1965
|
-
[
|
1966
|
-
'async_req',
|
1967
|
-
'_return_http_data_only',
|
1968
|
-
'_preload_content',
|
1969
|
-
'_request_timeout',
|
1970
|
-
'_request_auth',
|
1971
|
-
'_content_type',
|
1972
|
-
'_headers',
|
1973
|
-
'opts'
|
1974
|
-
]
|
1975
|
-
)
|
1976
|
-
|
1977
|
-
# validate the arguments
|
1978
|
-
for _key, _val in _params['kwargs'].items():
|
1979
|
-
if _key not in _all_params:
|
1980
|
-
raise ApiTypeError(
|
1981
|
-
"Got an unexpected keyword argument '%s'"
|
1982
|
-
" to method get_shared_workspace" % _key
|
1983
|
-
)
|
1984
|
-
_params[_key] = _val
|
1985
|
-
del _params['kwargs']
|
1986
|
-
|
1987
|
-
_collection_formats = {}
|
1988
|
-
|
1989
|
-
# process the path parameters
|
1990
|
-
_path_params = {}
|
1991
|
-
if _params['workspace_name']:
|
1992
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
1993
|
-
|
1994
|
-
|
1995
|
-
# process the query parameters
|
1996
|
-
_query_params = []
|
1997
|
-
if _params.get('as_at') is not None: # noqa: E501
|
1998
|
-
if isinstance(_params['as_at'], datetime):
|
1999
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2000
|
-
else:
|
2001
|
-
_query_params.append(('asAt', _params['as_at']))
|
2002
|
-
|
2003
|
-
# process the header parameters
|
2004
|
-
_header_params = dict(_params.get('_headers', {}))
|
2005
|
-
# process the form parameters
|
2006
|
-
_form_params = []
|
2007
|
-
_files = {}
|
2008
|
-
# process the body parameter
|
2009
|
-
_body_params = None
|
2010
|
-
# set the HTTP header `Accept`
|
2011
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2012
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2013
|
-
|
2014
|
-
# authentication setting
|
2015
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2016
|
-
|
2017
|
-
_response_types_map = {
|
2018
|
-
'200': "Workspace",
|
2019
|
-
'400': "LusidValidationProblemDetails",
|
2020
|
-
}
|
2021
|
-
|
2022
|
-
return self.api_client.call_api(
|
2023
|
-
'/api/workspaces/shared/{workspaceName}', 'GET',
|
2024
|
-
_path_params,
|
2025
|
-
_query_params,
|
2026
|
-
_header_params,
|
2027
|
-
body=_body_params,
|
2028
|
-
post_params=_form_params,
|
2029
|
-
files=_files,
|
2030
|
-
response_types_map=_response_types_map,
|
2031
|
-
auth_settings=_auth_settings,
|
2032
|
-
async_req=_params.get('async_req'),
|
2033
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2034
|
-
_preload_content=_params.get('_preload_content', True),
|
2035
|
-
_request_timeout=_params.get('_request_timeout'),
|
2036
|
-
opts=_params.get('opts'),
|
2037
|
-
collection_formats=_collection_formats,
|
2038
|
-
_request_auth=_params.get('_request_auth'))
|
2039
|
-
|
2040
|
-
|
2041
|
-
@overload
|
2042
|
-
async def list_personal_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2043
|
-
...
|
2044
|
-
|
2045
|
-
@overload
|
2046
|
-
def list_personal_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2047
|
-
...
|
2048
|
-
|
2049
|
-
@validate_arguments
|
2050
|
-
def list_personal_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspaceItem, Awaitable[PagedResourceListOfWorkspaceItem]]: # noqa: E501
|
2051
|
-
"""[EXPERIMENTAL] ListPersonalItems: List the items in a personal workspace. # noqa: E501
|
2052
|
-
|
2053
|
-
List the items in a personal workspace. # noqa: E501
|
2054
|
-
This method makes a synchronous HTTP request by default. To make an
|
2055
|
-
asynchronous HTTP request, please pass async_req=True
|
2056
|
-
|
2057
|
-
>>> thread = api.list_personal_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2058
|
-
>>> result = thread.get()
|
2059
|
-
|
2060
|
-
:param workspace_name: The item's workspace name. (required)
|
2061
|
-
:type workspace_name: str
|
2062
|
-
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2063
|
-
:type as_at: datetime
|
2064
|
-
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2065
|
-
:type page: str
|
2066
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2067
|
-
:type sort_by: List[str]
|
2068
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2069
|
-
:type limit: int
|
2070
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2071
|
-
:type filter: str
|
2072
|
-
:param async_req: Whether to execute the request asynchronously.
|
2073
|
-
:type async_req: bool, optional
|
2074
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2075
|
-
:param opts: Configuration options for this request
|
2076
|
-
:type opts: ConfigurationOptions, optional
|
2077
|
-
:return: Returns the result object.
|
2078
|
-
If the method is called asynchronously,
|
2079
|
-
returns the request thread.
|
2080
|
-
:rtype: PagedResourceListOfWorkspaceItem
|
2081
|
-
"""
|
2082
|
-
kwargs['_return_http_data_only'] = True
|
2083
|
-
if '_preload_content' in kwargs:
|
2084
|
-
message = "Error! Please call the list_personal_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2085
|
-
raise ValueError(message)
|
2086
|
-
if async_req is not None:
|
2087
|
-
kwargs['async_req'] = async_req
|
2088
|
-
return self.list_personal_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2089
|
-
|
2090
|
-
@validate_arguments
|
2091
|
-
def list_personal_items_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2092
|
-
"""[EXPERIMENTAL] ListPersonalItems: List the items in a personal workspace. # noqa: E501
|
2093
|
-
|
2094
|
-
List the items in a personal workspace. # noqa: E501
|
2095
|
-
This method makes a synchronous HTTP request by default. To make an
|
2096
|
-
asynchronous HTTP request, please pass async_req=True
|
2097
|
-
|
2098
|
-
>>> thread = api.list_personal_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2099
|
-
>>> result = thread.get()
|
2100
|
-
|
2101
|
-
:param workspace_name: The item's workspace name. (required)
|
2102
|
-
:type workspace_name: str
|
2103
|
-
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2104
|
-
:type as_at: datetime
|
2105
|
-
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2106
|
-
:type page: str
|
2107
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2108
|
-
:type sort_by: List[str]
|
2109
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2110
|
-
:type limit: int
|
2111
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2112
|
-
:type filter: str
|
2113
|
-
:param async_req: Whether to execute the request asynchronously.
|
2114
|
-
:type async_req: bool, optional
|
2115
|
-
:param _preload_content: if False, the ApiResponse.data will
|
2116
|
-
be set to none and raw_data will store the
|
2117
|
-
HTTP response body without reading/decoding.
|
2118
|
-
Default is True.
|
2119
|
-
:type _preload_content: bool, optional
|
2120
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
2121
|
-
object with status code, headers, etc
|
2122
|
-
:type _return_http_data_only: bool, optional
|
2123
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2124
|
-
:param opts: Configuration options for this request
|
2125
|
-
:type opts: ConfigurationOptions, optional
|
2126
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2127
|
-
request; this effectively ignores the authentication
|
2128
|
-
in the spec for a single request.
|
2129
|
-
:type _request_auth: dict, optional
|
2130
|
-
:type _content_type: string, optional: force content-type for the request
|
2131
|
-
:return: Returns the result object.
|
2132
|
-
If the method is called asynchronously,
|
2133
|
-
returns the request thread.
|
2134
|
-
:rtype: tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2135
|
-
"""
|
2136
|
-
|
2137
|
-
_params = locals()
|
2138
|
-
|
2139
|
-
_all_params = [
|
2140
|
-
'workspace_name',
|
2141
|
-
'as_at',
|
2142
|
-
'page',
|
2143
|
-
'sort_by',
|
2144
|
-
'limit',
|
2145
|
-
'filter'
|
2146
|
-
]
|
2147
|
-
_all_params.extend(
|
2148
|
-
[
|
2149
|
-
'async_req',
|
2150
|
-
'_return_http_data_only',
|
2151
|
-
'_preload_content',
|
2152
|
-
'_request_timeout',
|
2153
|
-
'_request_auth',
|
2154
|
-
'_content_type',
|
2155
|
-
'_headers',
|
2156
|
-
'opts'
|
2157
|
-
]
|
2158
|
-
)
|
2159
|
-
|
2160
|
-
# validate the arguments
|
2161
|
-
for _key, _val in _params['kwargs'].items():
|
2162
|
-
if _key not in _all_params:
|
2163
|
-
raise ApiTypeError(
|
2164
|
-
"Got an unexpected keyword argument '%s'"
|
2165
|
-
" to method list_personal_items" % _key
|
2166
|
-
)
|
2167
|
-
_params[_key] = _val
|
2168
|
-
del _params['kwargs']
|
2169
|
-
|
2170
|
-
_collection_formats = {}
|
2171
|
-
|
2172
|
-
# process the path parameters
|
2173
|
-
_path_params = {}
|
2174
|
-
if _params['workspace_name']:
|
2175
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
2176
|
-
|
2177
|
-
|
2178
|
-
# process the query parameters
|
2179
|
-
_query_params = []
|
2180
|
-
if _params.get('as_at') is not None: # noqa: E501
|
2181
|
-
if isinstance(_params['as_at'], datetime):
|
2182
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2183
|
-
else:
|
2184
|
-
_query_params.append(('asAt', _params['as_at']))
|
2185
|
-
|
2186
|
-
if _params.get('page') is not None: # noqa: E501
|
2187
|
-
_query_params.append(('page', _params['page']))
|
2188
|
-
|
2189
|
-
if _params.get('sort_by') is not None: # noqa: E501
|
2190
|
-
_query_params.append(('sortBy', _params['sort_by']))
|
2191
|
-
_collection_formats['sortBy'] = 'multi'
|
2192
|
-
|
2193
|
-
if _params.get('limit') is not None: # noqa: E501
|
2194
|
-
_query_params.append(('limit', _params['limit']))
|
2195
|
-
|
2196
|
-
if _params.get('filter') is not None: # noqa: E501
|
2197
|
-
_query_params.append(('filter', _params['filter']))
|
2198
|
-
|
2199
|
-
# process the header parameters
|
2200
|
-
_header_params = dict(_params.get('_headers', {}))
|
2201
|
-
# process the form parameters
|
2202
|
-
_form_params = []
|
2203
|
-
_files = {}
|
2204
|
-
# process the body parameter
|
2205
|
-
_body_params = None
|
2206
|
-
# set the HTTP header `Accept`
|
2207
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2208
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2209
|
-
|
2210
|
-
# authentication setting
|
2211
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2212
|
-
|
2213
|
-
_response_types_map = {
|
2214
|
-
'200': "PagedResourceListOfWorkspaceItem",
|
2215
|
-
'400': "LusidValidationProblemDetails",
|
2216
|
-
}
|
2217
|
-
|
2218
|
-
return self.api_client.call_api(
|
2219
|
-
'/api/workspaces/personal/{workspaceName}/items', 'GET',
|
2220
|
-
_path_params,
|
2221
|
-
_query_params,
|
2222
|
-
_header_params,
|
2223
|
-
body=_body_params,
|
2224
|
-
post_params=_form_params,
|
2225
|
-
files=_files,
|
2226
|
-
response_types_map=_response_types_map,
|
2227
|
-
auth_settings=_auth_settings,
|
2228
|
-
async_req=_params.get('async_req'),
|
2229
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2230
|
-
_preload_content=_params.get('_preload_content', True),
|
2231
|
-
_request_timeout=_params.get('_request_timeout'),
|
2232
|
-
opts=_params.get('opts'),
|
2233
|
-
collection_formats=_collection_formats,
|
2234
|
-
_request_auth=_params.get('_request_auth'))
|
2235
|
-
|
2236
|
-
|
2237
|
-
@overload
|
2238
|
-
async def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
2239
|
-
...
|
2240
|
-
|
2241
|
-
@overload
|
2242
|
-
def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
2243
|
-
...
|
2244
|
-
|
2245
|
-
@validate_arguments
|
2246
|
-
def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspace, Awaitable[PagedResourceListOfWorkspace]]: # noqa: E501
|
2247
|
-
"""[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501
|
2248
|
-
|
2249
|
-
List personal workspaces. # noqa: E501
|
2250
|
-
This method makes a synchronous HTTP request by default. To make an
|
2251
|
-
asynchronous HTTP request, please pass async_req=True
|
2252
|
-
|
2253
|
-
>>> thread = api.list_personal_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
|
2254
|
-
>>> result = thread.get()
|
2255
|
-
|
2256
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2257
|
-
:type as_at: datetime
|
2258
|
-
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2259
|
-
:type page: str
|
2260
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2261
|
-
:type sort_by: List[str]
|
2262
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2263
|
-
:type limit: int
|
2264
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2265
|
-
:type filter: str
|
2266
|
-
:param async_req: Whether to execute the request asynchronously.
|
2267
|
-
:type async_req: bool, optional
|
2268
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2269
|
-
:param opts: Configuration options for this request
|
2270
|
-
:type opts: ConfigurationOptions, optional
|
2271
|
-
:return: Returns the result object.
|
2272
|
-
If the method is called asynchronously,
|
2273
|
-
returns the request thread.
|
2274
|
-
:rtype: PagedResourceListOfWorkspace
|
2275
|
-
"""
|
2276
|
-
kwargs['_return_http_data_only'] = True
|
2277
|
-
if '_preload_content' in kwargs:
|
2278
|
-
message = "Error! Please call the list_personal_workspaces_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2279
|
-
raise ValueError(message)
|
2280
|
-
if async_req is not None:
|
2281
|
-
kwargs['async_req'] = async_req
|
2282
|
-
return self.list_personal_workspaces_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2283
|
-
|
2284
|
-
@validate_arguments
|
2285
|
-
def list_personal_workspaces_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2286
|
-
"""[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501
|
2287
|
-
|
2288
|
-
List personal workspaces. # noqa: E501
|
2289
|
-
This method makes a synchronous HTTP request by default. To make an
|
2290
|
-
asynchronous HTTP request, please pass async_req=True
|
2291
|
-
|
2292
|
-
>>> thread = api.list_personal_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
2293
|
-
>>> result = thread.get()
|
2294
|
-
|
2295
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2296
|
-
:type as_at: datetime
|
2297
|
-
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2298
|
-
:type page: str
|
2299
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2300
|
-
:type sort_by: List[str]
|
2301
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2302
|
-
:type limit: int
|
2303
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2304
|
-
:type filter: str
|
2305
|
-
:param async_req: Whether to execute the request asynchronously.
|
2306
|
-
:type async_req: bool, optional
|
2307
|
-
:param _preload_content: if False, the ApiResponse.data will
|
2308
|
-
be set to none and raw_data will store the
|
2309
|
-
HTTP response body without reading/decoding.
|
2310
|
-
Default is True.
|
2311
|
-
:type _preload_content: bool, optional
|
2312
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
2313
|
-
object with status code, headers, etc
|
2314
|
-
:type _return_http_data_only: bool, optional
|
2315
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2316
|
-
:param opts: Configuration options for this request
|
2317
|
-
:type opts: ConfigurationOptions, optional
|
2318
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2319
|
-
request; this effectively ignores the authentication
|
2320
|
-
in the spec for a single request.
|
2321
|
-
:type _request_auth: dict, optional
|
2322
|
-
:type _content_type: string, optional: force content-type for the request
|
2323
|
-
:return: Returns the result object.
|
2324
|
-
If the method is called asynchronously,
|
2325
|
-
returns the request thread.
|
2326
|
-
:rtype: tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))
|
2327
|
-
"""
|
2328
|
-
|
2329
|
-
_params = locals()
|
2330
|
-
|
2331
|
-
_all_params = [
|
2332
|
-
'as_at',
|
2333
|
-
'page',
|
2334
|
-
'sort_by',
|
2335
|
-
'limit',
|
2336
|
-
'filter'
|
2337
|
-
]
|
2338
|
-
_all_params.extend(
|
2339
|
-
[
|
2340
|
-
'async_req',
|
2341
|
-
'_return_http_data_only',
|
2342
|
-
'_preload_content',
|
2343
|
-
'_request_timeout',
|
2344
|
-
'_request_auth',
|
2345
|
-
'_content_type',
|
2346
|
-
'_headers',
|
2347
|
-
'opts'
|
2348
|
-
]
|
2349
|
-
)
|
2350
|
-
|
2351
|
-
# validate the arguments
|
2352
|
-
for _key, _val in _params['kwargs'].items():
|
2353
|
-
if _key not in _all_params:
|
2354
|
-
raise ApiTypeError(
|
2355
|
-
"Got an unexpected keyword argument '%s'"
|
2356
|
-
" to method list_personal_workspaces" % _key
|
2357
|
-
)
|
2358
|
-
_params[_key] = _val
|
2359
|
-
del _params['kwargs']
|
2360
|
-
|
2361
|
-
_collection_formats = {}
|
2362
|
-
|
2363
|
-
# process the path parameters
|
2364
|
-
_path_params = {}
|
2365
|
-
|
2366
|
-
# process the query parameters
|
2367
|
-
_query_params = []
|
2368
|
-
if _params.get('as_at') is not None: # noqa: E501
|
2369
|
-
if isinstance(_params['as_at'], datetime):
|
2370
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2371
|
-
else:
|
2372
|
-
_query_params.append(('asAt', _params['as_at']))
|
2373
|
-
|
2374
|
-
if _params.get('page') is not None: # noqa: E501
|
2375
|
-
_query_params.append(('page', _params['page']))
|
2376
|
-
|
2377
|
-
if _params.get('sort_by') is not None: # noqa: E501
|
2378
|
-
_query_params.append(('sortBy', _params['sort_by']))
|
2379
|
-
_collection_formats['sortBy'] = 'multi'
|
2380
|
-
|
2381
|
-
if _params.get('limit') is not None: # noqa: E501
|
2382
|
-
_query_params.append(('limit', _params['limit']))
|
2383
|
-
|
2384
|
-
if _params.get('filter') is not None: # noqa: E501
|
2385
|
-
_query_params.append(('filter', _params['filter']))
|
2386
|
-
|
2387
|
-
# process the header parameters
|
2388
|
-
_header_params = dict(_params.get('_headers', {}))
|
2389
|
-
# process the form parameters
|
2390
|
-
_form_params = []
|
2391
|
-
_files = {}
|
2392
|
-
# process the body parameter
|
2393
|
-
_body_params = None
|
2394
|
-
# set the HTTP header `Accept`
|
2395
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2396
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2397
|
-
|
2398
|
-
# authentication setting
|
2399
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2400
|
-
|
2401
|
-
_response_types_map = {
|
2402
|
-
'200': "PagedResourceListOfWorkspace",
|
2403
|
-
'400': "LusidValidationProblemDetails",
|
2404
|
-
}
|
2405
|
-
|
2406
|
-
return self.api_client.call_api(
|
2407
|
-
'/api/workspaces/personal', 'GET',
|
2408
|
-
_path_params,
|
2409
|
-
_query_params,
|
2410
|
-
_header_params,
|
2411
|
-
body=_body_params,
|
2412
|
-
post_params=_form_params,
|
2413
|
-
files=_files,
|
2414
|
-
response_types_map=_response_types_map,
|
2415
|
-
auth_settings=_auth_settings,
|
2416
|
-
async_req=_params.get('async_req'),
|
2417
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2418
|
-
_preload_content=_params.get('_preload_content', True),
|
2419
|
-
_request_timeout=_params.get('_request_timeout'),
|
2420
|
-
opts=_params.get('opts'),
|
2421
|
-
collection_formats=_collection_formats,
|
2422
|
-
_request_auth=_params.get('_request_auth'))
|
2423
|
-
|
2424
|
-
|
2425
|
-
@overload
|
2426
|
-
async def list_shared_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2427
|
-
...
|
2428
|
-
|
2429
|
-
@overload
|
2430
|
-
def list_shared_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2431
|
-
...
|
2432
|
-
|
2433
|
-
@validate_arguments
|
2434
|
-
def list_shared_items(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspaceItem, Awaitable[PagedResourceListOfWorkspaceItem]]: # noqa: E501
|
2435
|
-
"""[EXPERIMENTAL] ListSharedItems: List the items in a shared workspace. # noqa: E501
|
2436
|
-
|
2437
|
-
List the items in a shared workspace. # noqa: E501
|
2438
|
-
This method makes a synchronous HTTP request by default. To make an
|
2439
|
-
asynchronous HTTP request, please pass async_req=True
|
2440
|
-
|
2441
|
-
>>> thread = api.list_shared_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2442
|
-
>>> result = thread.get()
|
2443
|
-
|
2444
|
-
:param workspace_name: The item's workspace name. (required)
|
2445
|
-
:type workspace_name: str
|
2446
|
-
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2447
|
-
:type as_at: datetime
|
2448
|
-
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2449
|
-
:type page: str
|
2450
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2451
|
-
:type sort_by: List[str]
|
2452
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2453
|
-
:type limit: int
|
2454
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2455
|
-
:type filter: str
|
2456
|
-
:param async_req: Whether to execute the request asynchronously.
|
2457
|
-
:type async_req: bool, optional
|
2458
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2459
|
-
:param opts: Configuration options for this request
|
2460
|
-
:type opts: ConfigurationOptions, optional
|
2461
|
-
:return: Returns the result object.
|
2462
|
-
If the method is called asynchronously,
|
2463
|
-
returns the request thread.
|
2464
|
-
:rtype: PagedResourceListOfWorkspaceItem
|
2465
|
-
"""
|
2466
|
-
kwargs['_return_http_data_only'] = True
|
2467
|
-
if '_preload_content' in kwargs:
|
2468
|
-
message = "Error! Please call the list_shared_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2469
|
-
raise ValueError(message)
|
2470
|
-
if async_req is not None:
|
2471
|
-
kwargs['async_req'] = async_req
|
2472
|
-
return self.list_shared_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2473
|
-
|
2474
|
-
@validate_arguments
|
2475
|
-
def list_shared_items_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2476
|
-
"""[EXPERIMENTAL] ListSharedItems: List the items in a shared workspace. # noqa: E501
|
2477
|
-
|
2478
|
-
List the items in a shared workspace. # noqa: E501
|
2479
|
-
This method makes a synchronous HTTP request by default. To make an
|
2480
|
-
asynchronous HTTP request, please pass async_req=True
|
2481
|
-
|
2482
|
-
>>> thread = api.list_shared_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2483
|
-
>>> result = thread.get()
|
2484
|
-
|
2485
|
-
:param workspace_name: The item's workspace name. (required)
|
2486
|
-
:type workspace_name: str
|
2487
|
-
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2488
|
-
:type as_at: datetime
|
2489
|
-
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2490
|
-
:type page: str
|
2491
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2492
|
-
:type sort_by: List[str]
|
2493
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2494
|
-
:type limit: int
|
2495
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2496
|
-
:type filter: str
|
2497
|
-
:param async_req: Whether to execute the request asynchronously.
|
2498
|
-
:type async_req: bool, optional
|
2499
|
-
:param _preload_content: if False, the ApiResponse.data will
|
2500
|
-
be set to none and raw_data will store the
|
2501
|
-
HTTP response body without reading/decoding.
|
2502
|
-
Default is True.
|
2503
|
-
:type _preload_content: bool, optional
|
2504
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
2505
|
-
object with status code, headers, etc
|
2506
|
-
:type _return_http_data_only: bool, optional
|
2507
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2508
|
-
:param opts: Configuration options for this request
|
2509
|
-
:type opts: ConfigurationOptions, optional
|
2510
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2511
|
-
request; this effectively ignores the authentication
|
2512
|
-
in the spec for a single request.
|
2513
|
-
:type _request_auth: dict, optional
|
2514
|
-
:type _content_type: string, optional: force content-type for the request
|
2515
|
-
:return: Returns the result object.
|
2516
|
-
If the method is called asynchronously,
|
2517
|
-
returns the request thread.
|
2518
|
-
:rtype: tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2519
|
-
"""
|
2520
|
-
|
2521
|
-
_params = locals()
|
2522
|
-
|
2523
|
-
_all_params = [
|
2524
|
-
'workspace_name',
|
2525
|
-
'as_at',
|
2526
|
-
'page',
|
2527
|
-
'sort_by',
|
2528
|
-
'limit',
|
2529
|
-
'filter'
|
2530
|
-
]
|
2531
|
-
_all_params.extend(
|
2532
|
-
[
|
2533
|
-
'async_req',
|
2534
|
-
'_return_http_data_only',
|
2535
|
-
'_preload_content',
|
2536
|
-
'_request_timeout',
|
2537
|
-
'_request_auth',
|
2538
|
-
'_content_type',
|
2539
|
-
'_headers',
|
2540
|
-
'opts'
|
2541
|
-
]
|
2542
|
-
)
|
2543
|
-
|
2544
|
-
# validate the arguments
|
2545
|
-
for _key, _val in _params['kwargs'].items():
|
2546
|
-
if _key not in _all_params:
|
2547
|
-
raise ApiTypeError(
|
2548
|
-
"Got an unexpected keyword argument '%s'"
|
2549
|
-
" to method list_shared_items" % _key
|
2550
|
-
)
|
2551
|
-
_params[_key] = _val
|
2552
|
-
del _params['kwargs']
|
2553
|
-
|
2554
|
-
_collection_formats = {}
|
2555
|
-
|
2556
|
-
# process the path parameters
|
2557
|
-
_path_params = {}
|
2558
|
-
if _params['workspace_name']:
|
2559
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
2560
|
-
|
2561
|
-
|
2562
|
-
# process the query parameters
|
2563
|
-
_query_params = []
|
2564
|
-
if _params.get('as_at') is not None: # noqa: E501
|
2565
|
-
if isinstance(_params['as_at'], datetime):
|
2566
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2567
|
-
else:
|
2568
|
-
_query_params.append(('asAt', _params['as_at']))
|
2569
|
-
|
2570
|
-
if _params.get('page') is not None: # noqa: E501
|
2571
|
-
_query_params.append(('page', _params['page']))
|
2572
|
-
|
2573
|
-
if _params.get('sort_by') is not None: # noqa: E501
|
2574
|
-
_query_params.append(('sortBy', _params['sort_by']))
|
2575
|
-
_collection_formats['sortBy'] = 'multi'
|
2576
|
-
|
2577
|
-
if _params.get('limit') is not None: # noqa: E501
|
2578
|
-
_query_params.append(('limit', _params['limit']))
|
2579
|
-
|
2580
|
-
if _params.get('filter') is not None: # noqa: E501
|
2581
|
-
_query_params.append(('filter', _params['filter']))
|
2582
|
-
|
2583
|
-
# process the header parameters
|
2584
|
-
_header_params = dict(_params.get('_headers', {}))
|
2585
|
-
# process the form parameters
|
2586
|
-
_form_params = []
|
2587
|
-
_files = {}
|
2588
|
-
# process the body parameter
|
2589
|
-
_body_params = None
|
2590
|
-
# set the HTTP header `Accept`
|
2591
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2592
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2593
|
-
|
2594
|
-
# authentication setting
|
2595
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2596
|
-
|
2597
|
-
_response_types_map = {
|
2598
|
-
'200': "PagedResourceListOfWorkspaceItem",
|
2599
|
-
'400': "LusidValidationProblemDetails",
|
2600
|
-
}
|
2601
|
-
|
2602
|
-
return self.api_client.call_api(
|
2603
|
-
'/api/workspaces/shared/{workspaceName}/items', 'GET',
|
2604
|
-
_path_params,
|
2605
|
-
_query_params,
|
2606
|
-
_header_params,
|
2607
|
-
body=_body_params,
|
2608
|
-
post_params=_form_params,
|
2609
|
-
files=_files,
|
2610
|
-
response_types_map=_response_types_map,
|
2611
|
-
auth_settings=_auth_settings,
|
2612
|
-
async_req=_params.get('async_req'),
|
2613
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2614
|
-
_preload_content=_params.get('_preload_content', True),
|
2615
|
-
_request_timeout=_params.get('_request_timeout'),
|
2616
|
-
opts=_params.get('opts'),
|
2617
|
-
collection_formats=_collection_formats,
|
2618
|
-
_request_auth=_params.get('_request_auth'))
|
2619
|
-
|
2620
|
-
|
2621
|
-
@overload
|
2622
|
-
async def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
2623
|
-
...
|
2624
|
-
|
2625
|
-
@overload
|
2626
|
-
def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfWorkspace: # noqa: E501
|
2627
|
-
...
|
2628
|
-
|
2629
|
-
@validate_arguments
|
2630
|
-
def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfWorkspace, Awaitable[PagedResourceListOfWorkspace]]: # noqa: E501
|
2631
|
-
"""[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501
|
2632
|
-
|
2633
|
-
List shared workspaces. # noqa: E501
|
2634
|
-
This method makes a synchronous HTTP request by default. To make an
|
2635
|
-
asynchronous HTTP request, please pass async_req=True
|
2636
|
-
|
2637
|
-
>>> thread = api.list_shared_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
|
2638
|
-
>>> result = thread.get()
|
2639
|
-
|
2640
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2641
|
-
:type as_at: datetime
|
2642
|
-
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2643
|
-
:type page: str
|
2644
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2645
|
-
:type sort_by: List[str]
|
2646
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2647
|
-
:type limit: int
|
2648
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2649
|
-
:type filter: str
|
2650
|
-
:param async_req: Whether to execute the request asynchronously.
|
2651
|
-
:type async_req: bool, optional
|
2652
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2653
|
-
:param opts: Configuration options for this request
|
2654
|
-
:type opts: ConfigurationOptions, optional
|
2655
|
-
:return: Returns the result object.
|
2656
|
-
If the method is called asynchronously,
|
2657
|
-
returns the request thread.
|
2658
|
-
:rtype: PagedResourceListOfWorkspace
|
2659
|
-
"""
|
2660
|
-
kwargs['_return_http_data_only'] = True
|
2661
|
-
if '_preload_content' in kwargs:
|
2662
|
-
message = "Error! Please call the list_shared_workspaces_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2663
|
-
raise ValueError(message)
|
2664
|
-
if async_req is not None:
|
2665
|
-
kwargs['async_req'] = async_req
|
2666
|
-
return self.list_shared_workspaces_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2667
|
-
|
2668
|
-
@validate_arguments
|
2669
|
-
def list_shared_workspaces_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2670
|
-
"""[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501
|
2671
|
-
|
2672
|
-
List shared workspaces. # noqa: E501
|
2673
|
-
This method makes a synchronous HTTP request by default. To make an
|
2674
|
-
asynchronous HTTP request, please pass async_req=True
|
2675
|
-
|
2676
|
-
>>> thread = api.list_shared_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
2677
|
-
>>> result = thread.get()
|
2678
|
-
|
2679
|
-
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2680
|
-
:type as_at: datetime
|
2681
|
-
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
2682
|
-
:type page: str
|
2683
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2684
|
-
:type sort_by: List[str]
|
2685
|
-
:param limit: When paginating, limit the number of returned results to this many.
|
2686
|
-
:type limit: int
|
2687
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2688
|
-
:type filter: str
|
2689
|
-
:param async_req: Whether to execute the request asynchronously.
|
2690
|
-
:type async_req: bool, optional
|
2691
|
-
:param _preload_content: if False, the ApiResponse.data will
|
2692
|
-
be set to none and raw_data will store the
|
2693
|
-
HTTP response body without reading/decoding.
|
2694
|
-
Default is True.
|
2695
|
-
:type _preload_content: bool, optional
|
2696
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
2697
|
-
object with status code, headers, etc
|
2698
|
-
:type _return_http_data_only: bool, optional
|
2699
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2700
|
-
:param opts: Configuration options for this request
|
2701
|
-
:type opts: ConfigurationOptions, optional
|
2702
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2703
|
-
request; this effectively ignores the authentication
|
2704
|
-
in the spec for a single request.
|
2705
|
-
:type _request_auth: dict, optional
|
2706
|
-
:type _content_type: string, optional: force content-type for the request
|
2707
|
-
:return: Returns the result object.
|
2708
|
-
If the method is called asynchronously,
|
2709
|
-
returns the request thread.
|
2710
|
-
:rtype: tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))
|
2711
|
-
"""
|
2712
|
-
|
2713
|
-
_params = locals()
|
2714
|
-
|
2715
|
-
_all_params = [
|
2716
|
-
'as_at',
|
2717
|
-
'page',
|
2718
|
-
'sort_by',
|
2719
|
-
'limit',
|
2720
|
-
'filter'
|
2721
|
-
]
|
2722
|
-
_all_params.extend(
|
2723
|
-
[
|
2724
|
-
'async_req',
|
2725
|
-
'_return_http_data_only',
|
2726
|
-
'_preload_content',
|
2727
|
-
'_request_timeout',
|
2728
|
-
'_request_auth',
|
2729
|
-
'_content_type',
|
2730
|
-
'_headers',
|
2731
|
-
'opts'
|
2732
|
-
]
|
2733
|
-
)
|
2734
|
-
|
2735
|
-
# validate the arguments
|
2736
|
-
for _key, _val in _params['kwargs'].items():
|
2737
|
-
if _key not in _all_params:
|
2738
|
-
raise ApiTypeError(
|
2739
|
-
"Got an unexpected keyword argument '%s'"
|
2740
|
-
" to method list_shared_workspaces" % _key
|
2741
|
-
)
|
2742
|
-
_params[_key] = _val
|
2743
|
-
del _params['kwargs']
|
2744
|
-
|
2745
|
-
_collection_formats = {}
|
2746
|
-
|
2747
|
-
# process the path parameters
|
2748
|
-
_path_params = {}
|
2749
|
-
|
2750
|
-
# process the query parameters
|
2751
|
-
_query_params = []
|
2752
|
-
if _params.get('as_at') is not None: # noqa: E501
|
2753
|
-
if isinstance(_params['as_at'], datetime):
|
2754
|
-
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2755
|
-
else:
|
2756
|
-
_query_params.append(('asAt', _params['as_at']))
|
2757
|
-
|
2758
|
-
if _params.get('page') is not None: # noqa: E501
|
2759
|
-
_query_params.append(('page', _params['page']))
|
2760
|
-
|
2761
|
-
if _params.get('sort_by') is not None: # noqa: E501
|
2762
|
-
_query_params.append(('sortBy', _params['sort_by']))
|
2763
|
-
_collection_formats['sortBy'] = 'multi'
|
2764
|
-
|
2765
|
-
if _params.get('limit') is not None: # noqa: E501
|
2766
|
-
_query_params.append(('limit', _params['limit']))
|
2767
|
-
|
2768
|
-
if _params.get('filter') is not None: # noqa: E501
|
2769
|
-
_query_params.append(('filter', _params['filter']))
|
2770
|
-
|
2771
|
-
# process the header parameters
|
2772
|
-
_header_params = dict(_params.get('_headers', {}))
|
2773
|
-
# process the form parameters
|
2774
|
-
_form_params = []
|
2775
|
-
_files = {}
|
2776
|
-
# process the body parameter
|
2777
|
-
_body_params = None
|
2778
|
-
# set the HTTP header `Accept`
|
2779
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2780
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2781
|
-
|
2782
|
-
# authentication setting
|
2783
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2784
|
-
|
2785
|
-
_response_types_map = {
|
2786
|
-
'200': "PagedResourceListOfWorkspace",
|
2787
|
-
'400': "LusidValidationProblemDetails",
|
2788
|
-
}
|
2789
|
-
|
2790
|
-
return self.api_client.call_api(
|
2791
|
-
'/api/workspaces/shared', 'GET',
|
2792
|
-
_path_params,
|
2793
|
-
_query_params,
|
2794
|
-
_header_params,
|
2795
|
-
body=_body_params,
|
2796
|
-
post_params=_form_params,
|
2797
|
-
files=_files,
|
2798
|
-
response_types_map=_response_types_map,
|
2799
|
-
auth_settings=_auth_settings,
|
2800
|
-
async_req=_params.get('async_req'),
|
2801
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2802
|
-
_preload_content=_params.get('_preload_content', True),
|
2803
|
-
_request_timeout=_params.get('_request_timeout'),
|
2804
|
-
opts=_params.get('opts'),
|
2805
|
-
collection_formats=_collection_formats,
|
2806
|
-
_request_auth=_params.get('_request_auth'))
|
2807
|
-
|
2808
|
-
|
2809
|
-
@overload
|
2810
|
-
async def update_personal_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
2811
|
-
...
|
2812
|
-
|
2813
|
-
@overload
|
2814
|
-
def update_personal_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
2815
|
-
...
|
2816
|
-
|
2817
|
-
@validate_arguments
|
2818
|
-
def update_personal_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
2819
|
-
"""[EXPERIMENTAL] UpdatePersonalItem: Update an item in a personal workspace. # noqa: E501
|
2820
|
-
|
2821
|
-
Update an item in a personal workspace. # noqa: E501
|
2822
|
-
This method makes a synchronous HTTP request by default. To make an
|
2823
|
-
asynchronous HTTP request, please pass async_req=True
|
2824
|
-
|
2825
|
-
>>> thread = api.update_personal_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
2826
|
-
>>> result = thread.get()
|
2827
|
-
|
2828
|
-
:param workspace_name: The personal workspace name. (required)
|
2829
|
-
:type workspace_name: str
|
2830
|
-
:param group_name: The group containing the item. (required)
|
2831
|
-
:type group_name: str
|
2832
|
-
:param item_name: The item name. (required)
|
2833
|
-
:type item_name: str
|
2834
|
-
:param workspace_item_update_request: The new item details.
|
2835
|
-
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
2836
|
-
:param async_req: Whether to execute the request asynchronously.
|
2837
|
-
:type async_req: bool, optional
|
2838
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2839
|
-
:param opts: Configuration options for this request
|
2840
|
-
:type opts: ConfigurationOptions, optional
|
2841
|
-
:return: Returns the result object.
|
2842
|
-
If the method is called asynchronously,
|
2843
|
-
returns the request thread.
|
2844
|
-
:rtype: WorkspaceItem
|
2845
|
-
"""
|
2846
|
-
kwargs['_return_http_data_only'] = True
|
2847
|
-
if '_preload_content' in kwargs:
|
2848
|
-
message = "Error! Please call the update_personal_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2849
|
-
raise ValueError(message)
|
2850
|
-
if async_req is not None:
|
2851
|
-
kwargs['async_req'] = async_req
|
2852
|
-
return self.update_personal_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, **kwargs) # noqa: E501
|
2853
|
-
|
2854
|
-
@validate_arguments
|
2855
|
-
def update_personal_item_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2856
|
-
"""[EXPERIMENTAL] UpdatePersonalItem: Update an item in a personal workspace. # noqa: E501
|
2857
|
-
|
2858
|
-
Update an item in a personal workspace. # noqa: E501
|
2859
|
-
This method makes a synchronous HTTP request by default. To make an
|
2860
|
-
asynchronous HTTP request, please pass async_req=True
|
2861
|
-
|
2862
|
-
>>> thread = api.update_personal_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
2863
|
-
>>> result = thread.get()
|
2864
|
-
|
2865
|
-
:param workspace_name: The personal workspace name. (required)
|
2866
|
-
:type workspace_name: str
|
2867
|
-
:param group_name: The group containing the item. (required)
|
2868
|
-
:type group_name: str
|
2869
|
-
:param item_name: The item name. (required)
|
2870
|
-
:type item_name: str
|
2871
|
-
:param workspace_item_update_request: The new item details.
|
2872
|
-
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
2873
|
-
:param async_req: Whether to execute the request asynchronously.
|
2874
|
-
:type async_req: bool, optional
|
2875
|
-
:param _preload_content: if False, the ApiResponse.data will
|
2876
|
-
be set to none and raw_data will store the
|
2877
|
-
HTTP response body without reading/decoding.
|
2878
|
-
Default is True.
|
2879
|
-
:type _preload_content: bool, optional
|
2880
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
2881
|
-
object with status code, headers, etc
|
2882
|
-
:type _return_http_data_only: bool, optional
|
2883
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2884
|
-
:param opts: Configuration options for this request
|
2885
|
-
:type opts: ConfigurationOptions, optional
|
2886
|
-
:param _request_auth: set to override the auth_settings for an a single
|
2887
|
-
request; this effectively ignores the authentication
|
2888
|
-
in the spec for a single request.
|
2889
|
-
:type _request_auth: dict, optional
|
2890
|
-
:type _content_type: string, optional: force content-type for the request
|
2891
|
-
:return: Returns the result object.
|
2892
|
-
If the method is called asynchronously,
|
2893
|
-
returns the request thread.
|
2894
|
-
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2895
|
-
"""
|
2896
|
-
|
2897
|
-
_params = locals()
|
2898
|
-
|
2899
|
-
_all_params = [
|
2900
|
-
'workspace_name',
|
2901
|
-
'group_name',
|
2902
|
-
'item_name',
|
2903
|
-
'workspace_item_update_request'
|
2904
|
-
]
|
2905
|
-
_all_params.extend(
|
2906
|
-
[
|
2907
|
-
'async_req',
|
2908
|
-
'_return_http_data_only',
|
2909
|
-
'_preload_content',
|
2910
|
-
'_request_timeout',
|
2911
|
-
'_request_auth',
|
2912
|
-
'_content_type',
|
2913
|
-
'_headers',
|
2914
|
-
'opts'
|
2915
|
-
]
|
2916
|
-
)
|
2917
|
-
|
2918
|
-
# validate the arguments
|
2919
|
-
for _key, _val in _params['kwargs'].items():
|
2920
|
-
if _key not in _all_params:
|
2921
|
-
raise ApiTypeError(
|
2922
|
-
"Got an unexpected keyword argument '%s'"
|
2923
|
-
" to method update_personal_item" % _key
|
2924
|
-
)
|
2925
|
-
_params[_key] = _val
|
2926
|
-
del _params['kwargs']
|
2927
|
-
|
2928
|
-
_collection_formats = {}
|
2929
|
-
|
2930
|
-
# process the path parameters
|
2931
|
-
_path_params = {}
|
2932
|
-
if _params['workspace_name']:
|
2933
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
2934
|
-
|
2935
|
-
if _params['group_name']:
|
2936
|
-
_path_params['groupName'] = _params['group_name']
|
2937
|
-
|
2938
|
-
if _params['item_name']:
|
2939
|
-
_path_params['itemName'] = _params['item_name']
|
2940
|
-
|
2941
|
-
|
2942
|
-
# process the query parameters
|
2943
|
-
_query_params = []
|
2944
|
-
# process the header parameters
|
2945
|
-
_header_params = dict(_params.get('_headers', {}))
|
2946
|
-
# process the form parameters
|
2947
|
-
_form_params = []
|
2948
|
-
_files = {}
|
2949
|
-
# process the body parameter
|
2950
|
-
_body_params = None
|
2951
|
-
if _params['workspace_item_update_request'] is not None:
|
2952
|
-
_body_params = _params['workspace_item_update_request']
|
2953
|
-
|
2954
|
-
# set the HTTP header `Accept`
|
2955
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
2956
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2957
|
-
|
2958
|
-
# set the HTTP header `Content-Type`
|
2959
|
-
_content_types_list = _params.get('_content_type',
|
2960
|
-
self.api_client.select_header_content_type(
|
2961
|
-
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
2962
|
-
if _content_types_list:
|
2963
|
-
_header_params['Content-Type'] = _content_types_list
|
2964
|
-
|
2965
|
-
# authentication setting
|
2966
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
2967
|
-
|
2968
|
-
_response_types_map = {
|
2969
|
-
'200': "WorkspaceItem",
|
2970
|
-
'400': "LusidValidationProblemDetails",
|
2971
|
-
}
|
2972
|
-
|
2973
|
-
return self.api_client.call_api(
|
2974
|
-
'/api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName}', 'PUT',
|
2975
|
-
_path_params,
|
2976
|
-
_query_params,
|
2977
|
-
_header_params,
|
2978
|
-
body=_body_params,
|
2979
|
-
post_params=_form_params,
|
2980
|
-
files=_files,
|
2981
|
-
response_types_map=_response_types_map,
|
2982
|
-
auth_settings=_auth_settings,
|
2983
|
-
async_req=_params.get('async_req'),
|
2984
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2985
|
-
_preload_content=_params.get('_preload_content', True),
|
2986
|
-
_request_timeout=_params.get('_request_timeout'),
|
2987
|
-
opts=_params.get('opts'),
|
2988
|
-
collection_formats=_collection_formats,
|
2989
|
-
_request_auth=_params.get('_request_auth'))
|
2990
|
-
|
2991
|
-
|
2992
|
-
@overload
|
2993
|
-
async def update_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> Workspace: # noqa: E501
|
2994
|
-
...
|
2995
|
-
|
2996
|
-
@overload
|
2997
|
-
def update_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
2998
|
-
...
|
2999
|
-
|
3000
|
-
@validate_arguments
|
3001
|
-
def update_personal_workspace(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
3002
|
-
"""[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501
|
3003
|
-
|
3004
|
-
Update a personal workspace. # noqa: E501
|
3005
|
-
This method makes a synchronous HTTP request by default. To make an
|
3006
|
-
asynchronous HTTP request, please pass async_req=True
|
3007
|
-
|
3008
|
-
>>> thread = api.update_personal_workspace(workspace_name, workspace_update_request, async_req=True)
|
3009
|
-
>>> result = thread.get()
|
3010
|
-
|
3011
|
-
:param workspace_name: The personal workspace name. (required)
|
3012
|
-
:type workspace_name: str
|
3013
|
-
:param workspace_update_request: The new workspace details.
|
3014
|
-
:type workspace_update_request: WorkspaceUpdateRequest
|
3015
|
-
:param async_req: Whether to execute the request asynchronously.
|
3016
|
-
:type async_req: bool, optional
|
3017
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3018
|
-
:param opts: Configuration options for this request
|
3019
|
-
:type opts: ConfigurationOptions, optional
|
3020
|
-
:return: Returns the result object.
|
3021
|
-
If the method is called asynchronously,
|
3022
|
-
returns the request thread.
|
3023
|
-
:rtype: Workspace
|
3024
|
-
"""
|
3025
|
-
kwargs['_return_http_data_only'] = True
|
3026
|
-
if '_preload_content' in kwargs:
|
3027
|
-
message = "Error! Please call the update_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3028
|
-
raise ValueError(message)
|
3029
|
-
if async_req is not None:
|
3030
|
-
kwargs['async_req'] = async_req
|
3031
|
-
return self.update_personal_workspace_with_http_info(workspace_name, workspace_update_request, **kwargs) # noqa: E501
|
3032
|
-
|
3033
|
-
@validate_arguments
|
3034
|
-
def update_personal_workspace_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3035
|
-
"""[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501
|
3036
|
-
|
3037
|
-
Update a personal workspace. # noqa: E501
|
3038
|
-
This method makes a synchronous HTTP request by default. To make an
|
3039
|
-
asynchronous HTTP request, please pass async_req=True
|
3040
|
-
|
3041
|
-
>>> thread = api.update_personal_workspace_with_http_info(workspace_name, workspace_update_request, async_req=True)
|
3042
|
-
>>> result = thread.get()
|
3043
|
-
|
3044
|
-
:param workspace_name: The personal workspace name. (required)
|
3045
|
-
:type workspace_name: str
|
3046
|
-
:param workspace_update_request: The new workspace details.
|
3047
|
-
:type workspace_update_request: WorkspaceUpdateRequest
|
3048
|
-
:param async_req: Whether to execute the request asynchronously.
|
3049
|
-
:type async_req: bool, optional
|
3050
|
-
:param _preload_content: if False, the ApiResponse.data will
|
3051
|
-
be set to none and raw_data will store the
|
3052
|
-
HTTP response body without reading/decoding.
|
3053
|
-
Default is True.
|
3054
|
-
:type _preload_content: bool, optional
|
3055
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
3056
|
-
object with status code, headers, etc
|
3057
|
-
:type _return_http_data_only: bool, optional
|
3058
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3059
|
-
:param opts: Configuration options for this request
|
3060
|
-
:type opts: ConfigurationOptions, optional
|
3061
|
-
:param _request_auth: set to override the auth_settings for an a single
|
3062
|
-
request; this effectively ignores the authentication
|
3063
|
-
in the spec for a single request.
|
3064
|
-
:type _request_auth: dict, optional
|
3065
|
-
:type _content_type: string, optional: force content-type for the request
|
3066
|
-
:return: Returns the result object.
|
3067
|
-
If the method is called asynchronously,
|
3068
|
-
returns the request thread.
|
3069
|
-
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
3070
|
-
"""
|
3071
|
-
|
3072
|
-
_params = locals()
|
3073
|
-
|
3074
|
-
_all_params = [
|
3075
|
-
'workspace_name',
|
3076
|
-
'workspace_update_request'
|
3077
|
-
]
|
3078
|
-
_all_params.extend(
|
3079
|
-
[
|
3080
|
-
'async_req',
|
3081
|
-
'_return_http_data_only',
|
3082
|
-
'_preload_content',
|
3083
|
-
'_request_timeout',
|
3084
|
-
'_request_auth',
|
3085
|
-
'_content_type',
|
3086
|
-
'_headers',
|
3087
|
-
'opts'
|
3088
|
-
]
|
3089
|
-
)
|
3090
|
-
|
3091
|
-
# validate the arguments
|
3092
|
-
for _key, _val in _params['kwargs'].items():
|
3093
|
-
if _key not in _all_params:
|
3094
|
-
raise ApiTypeError(
|
3095
|
-
"Got an unexpected keyword argument '%s'"
|
3096
|
-
" to method update_personal_workspace" % _key
|
3097
|
-
)
|
3098
|
-
_params[_key] = _val
|
3099
|
-
del _params['kwargs']
|
3100
|
-
|
3101
|
-
_collection_formats = {}
|
3102
|
-
|
3103
|
-
# process the path parameters
|
3104
|
-
_path_params = {}
|
3105
|
-
if _params['workspace_name']:
|
3106
|
-
_path_params['workspaceName'] = _params['workspace_name']
|
3107
|
-
|
3108
|
-
|
3109
|
-
# process the query parameters
|
3110
|
-
_query_params = []
|
3111
|
-
# process the header parameters
|
3112
|
-
_header_params = dict(_params.get('_headers', {}))
|
3113
|
-
# process the form parameters
|
3114
|
-
_form_params = []
|
3115
|
-
_files = {}
|
3116
|
-
# process the body parameter
|
3117
|
-
_body_params = None
|
3118
|
-
if _params['workspace_update_request'] is not None:
|
3119
|
-
_body_params = _params['workspace_update_request']
|
3120
|
-
|
3121
|
-
# set the HTTP header `Accept`
|
3122
|
-
_header_params['Accept'] = self.api_client.select_header_accept(
|
3123
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
3124
|
-
|
3125
|
-
# set the HTTP header `Content-Type`
|
3126
|
-
_content_types_list = _params.get('_content_type',
|
3127
|
-
self.api_client.select_header_content_type(
|
3128
|
-
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
3129
|
-
if _content_types_list:
|
3130
|
-
_header_params['Content-Type'] = _content_types_list
|
3131
|
-
|
3132
|
-
# authentication setting
|
3133
|
-
_auth_settings = ['oauth2'] # noqa: E501
|
3134
|
-
|
3135
|
-
_response_types_map = {
|
3136
|
-
'200': "Workspace",
|
3137
|
-
'400': "LusidValidationProblemDetails",
|
3138
|
-
}
|
3139
|
-
|
3140
|
-
return self.api_client.call_api(
|
3141
|
-
'/api/workspaces/personal/{workspaceName}', 'PUT',
|
3142
|
-
_path_params,
|
3143
|
-
_query_params,
|
3144
|
-
_header_params,
|
3145
|
-
body=_body_params,
|
3146
|
-
post_params=_form_params,
|
3147
|
-
files=_files,
|
3148
|
-
response_types_map=_response_types_map,
|
3149
|
-
auth_settings=_auth_settings,
|
3150
|
-
async_req=_params.get('async_req'),
|
3151
|
-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
3152
|
-
_preload_content=_params.get('_preload_content', True),
|
3153
|
-
_request_timeout=_params.get('_request_timeout'),
|
3154
|
-
opts=_params.get('opts'),
|
3155
|
-
collection_formats=_collection_formats,
|
3156
|
-
_request_auth=_params.get('_request_auth'))
|
3157
|
-
|
3158
|
-
|
3159
|
-
@overload
|
3160
|
-
async def update_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
3161
|
-
...
|
3162
|
-
|
3163
|
-
@overload
|
3164
|
-
def update_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
3165
|
-
...
|
3166
|
-
|
3167
|
-
@validate_arguments
|
3168
|
-
def update_shared_item(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
3169
|
-
"""[EXPERIMENTAL] UpdateSharedItem: Update an item in a shared workspace. # noqa: E501
|
3170
|
-
|
3171
|
-
Update an item in a shared workspace. # noqa: E501
|
3172
|
-
This method makes a synchronous HTTP request by default. To make an
|
3173
|
-
asynchronous HTTP request, please pass async_req=True
|
3174
|
-
|
3175
|
-
>>> thread = api.update_shared_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
3176
|
-
>>> result = thread.get()
|
3177
|
-
|
3178
|
-
:param workspace_name: The shared workspace name. (required)
|
3179
|
-
:type workspace_name: str
|
3180
|
-
:param group_name: The group containing the item. (required)
|
3181
|
-
:type group_name: str
|
3182
|
-
:param item_name: The item name. (required)
|
3183
|
-
:type item_name: str
|
3184
|
-
:param workspace_item_update_request: The new item details.
|
3185
|
-
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
3186
|
-
:param async_req: Whether to execute the request asynchronously.
|
3187
|
-
:type async_req: bool, optional
|
3188
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3189
|
-
:param opts: Configuration options for this request
|
3190
|
-
:type opts: ConfigurationOptions, optional
|
3191
|
-
:return: Returns the result object.
|
3192
|
-
If the method is called asynchronously,
|
3193
|
-
returns the request thread.
|
3194
|
-
:rtype: WorkspaceItem
|
3195
|
-
"""
|
3196
|
-
kwargs['_return_http_data_only'] = True
|
3197
|
-
if '_preload_content' in kwargs:
|
3198
|
-
message = "Error! Please call the update_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3199
|
-
raise ValueError(message)
|
3200
|
-
if async_req is not None:
|
3201
|
-
kwargs['async_req'] = async_req
|
3202
|
-
return self.update_shared_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, **kwargs) # noqa: E501
|
3203
|
-
|
3204
|
-
@validate_arguments
|
3205
|
-
def update_shared_item_with_http_info(self, workspace_name : Annotated[StrictStr, Field(..., description="The shared workspace name.")], group_name : Annotated[StrictStr, Field(..., description="The group containing the item.")], item_name : Annotated[StrictStr, Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3206
|
-
"""[EXPERIMENTAL] UpdateSharedItem: Update an item in a shared workspace. # noqa: E501
|
3207
|
-
|
3208
|
-
Update an item in a shared workspace. # noqa: E501
|
3209
|
-
This method makes a synchronous HTTP request by default. To make an
|
3210
|
-
asynchronous HTTP request, please pass async_req=True
|
3211
|
-
|
3212
|
-
>>> thread = api.update_shared_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
3213
|
-
>>> result = thread.get()
|
3214
|
-
|
3215
|
-
:param workspace_name: The shared workspace name. (required)
|
3216
|
-
:type workspace_name: str
|
3217
|
-
:param group_name: The group containing the item. (required)
|
3218
|
-
:type group_name: str
|
3219
|
-
:param item_name: The item name. (required)
|
3220
|
-
:type item_name: str
|
3221
|
-
:param workspace_item_update_request: The new item details.
|
3222
|
-
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
3223
|
-
:param async_req: Whether to execute the request asynchronously.
|
3224
|
-
:type async_req: bool, optional
|
3225
|
-
:param _preload_content: if False, the ApiResponse.data will
|
3226
|
-
be set to none and raw_data will store the
|
3227
|
-
HTTP response body without reading/decoding.
|
3228
|
-
Default is True.
|
3229
|
-
:type _preload_content: bool, optional
|
3230
|
-
:param _return_http_data_only: response data instead of ApiResponse
|
3231
|
-
object with status code, headers, etc
|
3232
|
-
:type _return_http_data_only: bool, optional
|
3233
|
-
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3234
|
-
:param opts: Configuration options for this request
|
3235
|
-
:type opts: ConfigurationOptions, optional
|
3236
|
-
:param _request_auth: set to override the auth_settings for an a single
|
3237
|
-
request; this effectively ignores the authentication
|
3238
|
-
in the spec for a single request.
|
3239
|
-
:type _request_auth: dict, optional
|
3240
|
-
:type _content_type: string, optional: force content-type for the request
|
3241
|
-
:return: Returns the result object.
|
3242
|
-
If the method is called asynchronously,
|
3243
|
-
returns the request thread.
|
3244
|
-
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
3245
|
-
"""
|
3246
|
-
|
3247
|
-
_params = locals()
|
3248
|
-
|
3249
|
-
_all_params = [
|
3250
|
-
'workspace_name',
|
3251
|
-
'group_name',
|
3252
|
-
'item_name',
|
3253
|
-
'workspace_item_update_request'
|
3254
|
-
]
|
3255
|
-
_all_params.extend(
|
3256
|
-
[
|
3257
|
-
'async_req',
|
3258
|
-
'_return_http_data_only',
|
3259
|
-
'_preload_content',
|
3260
|
-
'_request_timeout',
|
3261
|
-
'_request_auth',
|
3262
|
-
'_content_type',
|
3263
|
-
'_headers',
|
3264
|
-
'opts'
|
3265
|
-
]
|
3266
|
-
)
|
3267
|
-
|
3268
|
-
# validate the arguments
|
3269
|
-
for _key, _val in _params['kwargs'].items():
|
3270
|
-
if _key not in _all_params:
|
3271
|
-
raise ApiTypeError(
|
3272
|
-
"Got an unexpected keyword argument '%s'"
|
3273
|
-
" to method update_shared_item" % _key
|
1620
|
+
" to method update_item" % _key
|
3274
1621
|
)
|
3275
1622
|
_params[_key] = _val
|
3276
1623
|
del _params['kwargs']
|
@@ -3279,6 +1626,9 @@ class WorkspaceApi:
|
|
3279
1626
|
|
3280
1627
|
# process the path parameters
|
3281
1628
|
_path_params = {}
|
1629
|
+
if _params['visibility']:
|
1630
|
+
_path_params['visibility'] = _params['visibility']
|
1631
|
+
|
3282
1632
|
if _params['workspace_name']:
|
3283
1633
|
_path_params['workspaceName'] = _params['workspace_name']
|
3284
1634
|
|
@@ -3321,7 +1671,7 @@ class WorkspaceApi:
|
|
3321
1671
|
}
|
3322
1672
|
|
3323
1673
|
return self.api_client.call_api(
|
3324
|
-
'/api/workspaces/
|
1674
|
+
'/api/workspaces/{visibility}/{workspaceName}/items/{groupName}/{itemName}', 'PUT',
|
3325
1675
|
_path_params,
|
3326
1676
|
_query_params,
|
3327
1677
|
_header_params,
|
@@ -3340,25 +1690,27 @@ class WorkspaceApi:
|
|
3340
1690
|
|
3341
1691
|
|
3342
1692
|
@overload
|
3343
|
-
async def
|
1693
|
+
async def update_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> Workspace: # noqa: E501
|
3344
1694
|
...
|
3345
1695
|
|
3346
1696
|
@overload
|
3347
|
-
def
|
1697
|
+
def update_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
3348
1698
|
...
|
3349
1699
|
|
3350
1700
|
@validate_arguments
|
3351
|
-
def
|
3352
|
-
"""[EXPERIMENTAL]
|
1701
|
+
def update_workspace(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
1702
|
+
"""[EXPERIMENTAL] UpdateWorkspace: Update a workspace. # noqa: E501
|
3353
1703
|
|
3354
|
-
Update a
|
1704
|
+
Update a workspace. # noqa: E501
|
3355
1705
|
This method makes a synchronous HTTP request by default. To make an
|
3356
1706
|
asynchronous HTTP request, please pass async_req=True
|
3357
1707
|
|
3358
|
-
>>> thread = api.
|
1708
|
+
>>> thread = api.update_workspace(visibility, workspace_name, workspace_update_request, async_req=True)
|
3359
1709
|
>>> result = thread.get()
|
3360
1710
|
|
3361
|
-
:param
|
1711
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
1712
|
+
:type visibility: str
|
1713
|
+
:param workspace_name: The workspace name. (required)
|
3362
1714
|
:type workspace_name: str
|
3363
1715
|
:param workspace_update_request: The new workspace details.
|
3364
1716
|
:type workspace_update_request: WorkspaceUpdateRequest
|
@@ -3374,24 +1726,26 @@ class WorkspaceApi:
|
|
3374
1726
|
"""
|
3375
1727
|
kwargs['_return_http_data_only'] = True
|
3376
1728
|
if '_preload_content' in kwargs:
|
3377
|
-
message = "Error! Please call the
|
1729
|
+
message = "Error! Please call the update_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3378
1730
|
raise ValueError(message)
|
3379
1731
|
if async_req is not None:
|
3380
1732
|
kwargs['async_req'] = async_req
|
3381
|
-
return self.
|
1733
|
+
return self.update_workspace_with_http_info(visibility, workspace_name, workspace_update_request, **kwargs) # noqa: E501
|
3382
1734
|
|
3383
1735
|
@validate_arguments
|
3384
|
-
def
|
3385
|
-
"""[EXPERIMENTAL]
|
1736
|
+
def update_workspace_with_http_info(self, visibility : Annotated[StrictStr, Field(..., description="The visibility for the workspace. Must be `shared` or `personal`; case is important.")], workspace_name : Annotated[StrictStr, Field(..., description="The workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1737
|
+
"""[EXPERIMENTAL] UpdateWorkspace: Update a workspace. # noqa: E501
|
3386
1738
|
|
3387
|
-
Update a
|
1739
|
+
Update a workspace. # noqa: E501
|
3388
1740
|
This method makes a synchronous HTTP request by default. To make an
|
3389
1741
|
asynchronous HTTP request, please pass async_req=True
|
3390
1742
|
|
3391
|
-
>>> thread = api.
|
1743
|
+
>>> thread = api.update_workspace_with_http_info(visibility, workspace_name, workspace_update_request, async_req=True)
|
3392
1744
|
>>> result = thread.get()
|
3393
1745
|
|
3394
|
-
:param
|
1746
|
+
:param visibility: The visibility for the workspace. Must be `shared` or `personal`; case is important. (required)
|
1747
|
+
:type visibility: str
|
1748
|
+
:param workspace_name: The workspace name. (required)
|
3395
1749
|
:type workspace_name: str
|
3396
1750
|
:param workspace_update_request: The new workspace details.
|
3397
1751
|
:type workspace_update_request: WorkspaceUpdateRequest
|
@@ -3422,6 +1776,7 @@ class WorkspaceApi:
|
|
3422
1776
|
_params = locals()
|
3423
1777
|
|
3424
1778
|
_all_params = [
|
1779
|
+
'visibility',
|
3425
1780
|
'workspace_name',
|
3426
1781
|
'workspace_update_request'
|
3427
1782
|
]
|
@@ -3443,7 +1798,7 @@ class WorkspaceApi:
|
|
3443
1798
|
if _key not in _all_params:
|
3444
1799
|
raise ApiTypeError(
|
3445
1800
|
"Got an unexpected keyword argument '%s'"
|
3446
|
-
" to method
|
1801
|
+
" to method update_workspace" % _key
|
3447
1802
|
)
|
3448
1803
|
_params[_key] = _val
|
3449
1804
|
del _params['kwargs']
|
@@ -3452,6 +1807,9 @@ class WorkspaceApi:
|
|
3452
1807
|
|
3453
1808
|
# process the path parameters
|
3454
1809
|
_path_params = {}
|
1810
|
+
if _params['visibility']:
|
1811
|
+
_path_params['visibility'] = _params['visibility']
|
1812
|
+
|
3455
1813
|
if _params['workspace_name']:
|
3456
1814
|
_path_params['workspaceName'] = _params['workspace_name']
|
3457
1815
|
|
@@ -3488,7 +1846,7 @@ class WorkspaceApi:
|
|
3488
1846
|
}
|
3489
1847
|
|
3490
1848
|
return self.api_client.call_api(
|
3491
|
-
'/api/workspaces/
|
1849
|
+
'/api/workspaces/{visibility}/{workspaceName}', 'PUT',
|
3492
1850
|
_path_params,
|
3493
1851
|
_query_params,
|
3494
1852
|
_header_params,
|