lusid-sdk 2.1.891__py3-none-any.whl → 2.1.893__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/api/funds_api.py CHANGED
@@ -262,22 +262,22 @@ class FundsApi:
262
262
 
263
263
 
264
264
  @overload
265
- async def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], **kwargs) -> Fee: # noqa: E501
265
+ async def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], nav_type_code : Annotated[Optional[StrictStr], Field( description="When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.")] = None, **kwargs) -> Fee: # noqa: E501
266
266
  ...
267
267
 
268
268
  @overload
269
- def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], async_req: Optional[bool]=True, **kwargs) -> Fee: # noqa: E501
269
+ def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], nav_type_code : Annotated[Optional[StrictStr], Field( description="When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.")] = None, async_req: Optional[bool]=True, **kwargs) -> Fee: # noqa: E501
270
270
  ...
271
271
 
272
272
  @validate_arguments
273
- def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], async_req: Optional[bool]=None, **kwargs) -> Union[Fee, Awaitable[Fee]]: # noqa: E501
273
+ def create_fee(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], nav_type_code : Annotated[Optional[StrictStr], Field( description="When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Fee, Awaitable[Fee]]: # noqa: E501
274
274
  """[EXPERIMENTAL] CreateFee: Create a Fee. # noqa: E501
275
275
 
276
276
  Create the given Fee. # noqa: E501
277
277
  This method makes a synchronous HTTP request by default. To make an
278
278
  asynchronous HTTP request, please pass async_req=True
279
279
 
280
- >>> thread = api.create_fee(scope, code, fee_request, async_req=True)
280
+ >>> thread = api.create_fee(scope, code, fee_request, nav_type_code, async_req=True)
281
281
  >>> result = thread.get()
282
282
 
283
283
  :param scope: The scope of the Fund. (required)
@@ -286,6 +286,8 @@ class FundsApi:
286
286
  :type code: str
287
287
  :param fee_request: The Fee to create. (required)
288
288
  :type fee_request: FeeRequest
289
+ :param nav_type_code: When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
290
+ :type nav_type_code: str
289
291
  :param async_req: Whether to execute the request asynchronously.
290
292
  :type async_req: bool, optional
291
293
  :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
@@ -302,17 +304,17 @@ class FundsApi:
302
304
  raise ValueError(message)
303
305
  if async_req is not None:
304
306
  kwargs['async_req'] = async_req
305
- return self.create_fee_with_http_info(scope, code, fee_request, **kwargs) # noqa: E501
307
+ return self.create_fee_with_http_info(scope, code, fee_request, nav_type_code, **kwargs) # noqa: E501
306
308
 
307
309
  @validate_arguments
308
- def create_fee_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], **kwargs) -> ApiResponse: # noqa: E501
310
+ def create_fee_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], fee_request : Annotated[FeeRequest, Field(..., description="The Fee to create.")], nav_type_code : Annotated[Optional[StrictStr], Field( description="When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.")] = None, **kwargs) -> ApiResponse: # noqa: E501
309
311
  """[EXPERIMENTAL] CreateFee: Create a Fee. # noqa: E501
310
312
 
311
313
  Create the given Fee. # noqa: E501
312
314
  This method makes a synchronous HTTP request by default. To make an
313
315
  asynchronous HTTP request, please pass async_req=True
314
316
 
315
- >>> thread = api.create_fee_with_http_info(scope, code, fee_request, async_req=True)
317
+ >>> thread = api.create_fee_with_http_info(scope, code, fee_request, nav_type_code, async_req=True)
316
318
  >>> result = thread.get()
317
319
 
318
320
  :param scope: The scope of the Fund. (required)
@@ -321,6 +323,8 @@ class FundsApi:
321
323
  :type code: str
322
324
  :param fee_request: The Fee to create. (required)
323
325
  :type fee_request: FeeRequest
326
+ :param nav_type_code: When provided runs against the specified NAV Type, otherwise the Primary NAV Type will be used.
327
+ :type nav_type_code: str
324
328
  :param async_req: Whether to execute the request asynchronously.
325
329
  :type async_req: bool, optional
326
330
  :param _preload_content: if False, the ApiResponse.data will
@@ -350,7 +354,8 @@ class FundsApi:
350
354
  _all_params = [
351
355
  'scope',
352
356
  'code',
353
- 'fee_request'
357
+ 'fee_request',
358
+ 'nav_type_code'
354
359
  ]
355
360
  _all_params.extend(
356
361
  [
@@ -388,6 +393,9 @@ class FundsApi:
388
393
 
389
394
  # process the query parameters
390
395
  _query_params = []
396
+ if _params.get('nav_type_code') is not None: # noqa: E501
397
+ _query_params.append(('navTypeCode', _params['nav_type_code']))
398
+
391
399
  # process the header parameters
392
400
  _header_params = dict(_params.get('_headers', {}))
393
401
  # process the form parameters
@@ -3138,15 +3138,15 @@ class InstrumentsApi:
3138
3138
 
3139
3139
 
3140
3140
  @overload
3141
- async def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.")] = None, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3141
+ async def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3142
3142
  ...
3143
3143
 
3144
3144
  @overload
3145
- def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3145
+ def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3146
3146
  ...
3147
3147
 
3148
3148
  @validate_arguments
3149
- def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfInstrument, Awaitable[PagedResourceListOfInstrument]]: # noqa: E501
3149
+ def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfInstrument, Awaitable[PagedResourceListOfInstrument]]: # noqa: E501
3150
3150
  """ListInstruments: List instruments # noqa: E501
3151
3151
 
3152
3152
  List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. # noqa: E501
@@ -3178,7 +3178,7 @@ class InstrumentsApi:
3178
3178
  :type data_model_scope: str
3179
3179
  :param data_model_code: The optional code of a Custom Data Model to use.
3180
3180
  :type data_model_code: str
3181
- :param membership_type: The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.
3181
+ :param membership_type: The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.
3182
3182
  :type membership_type: str
3183
3183
  :param async_req: Whether to execute the request asynchronously.
3184
3184
  :type async_req: bool, optional
@@ -3199,7 +3199,7 @@ class InstrumentsApi:
3199
3199
  return self.list_instruments_with_http_info(as_at, effective_at, page, sort_by, limit, filter, instrument_property_keys, scope, relationship_definition_ids, data_model_scope, data_model_code, membership_type, **kwargs) # noqa: E501
3200
3200
 
3201
3201
  @validate_arguments
3202
- def list_instruments_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3202
+ def list_instruments_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use.")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3203
3203
  """ListInstruments: List instruments # noqa: E501
3204
3204
 
3205
3205
  List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. # noqa: E501
@@ -3231,7 +3231,7 @@ class InstrumentsApi:
3231
3231
  :type data_model_scope: str
3232
3232
  :param data_model_code: The optional code of a Custom Data Model to use.
3233
3233
  :type data_model_code: str
3234
- :param membership_type: The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All.
3234
+ :param membership_type: The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.
3235
3235
  :type membership_type: str
3236
3236
  :param async_req: Whether to execute the request asynchronously.
3237
3237
  :type async_req: bool, optional
@@ -58,30 +58,32 @@ class InvestmentAccountsApi:
58
58
 
59
59
 
60
60
  @overload
61
- async def get_investment_account(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> InvestmentAccount: # noqa: E501
61
+ async def get_investment_account(self, identifier_type : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], identifier_value : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code.")], scope : Annotated[StrictStr, Field(..., description="The scope of the investment account entity.")], identifier_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> InvestmentAccount: # noqa: E501
62
62
  ...
63
63
 
64
64
  @overload
65
- def get_investment_account(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> InvestmentAccount: # noqa: E501
65
+ def get_investment_account(self, identifier_type : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], identifier_value : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code.")], scope : Annotated[StrictStr, Field(..., description="The scope of the investment account entity.")], identifier_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> InvestmentAccount: # noqa: E501
66
66
  ...
67
67
 
68
68
  @validate_arguments
69
- def get_investment_account(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InvestmentAccount, Awaitable[InvestmentAccount]]: # noqa: E501
69
+ def get_investment_account(self, identifier_type : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], identifier_value : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code.")], scope : Annotated[StrictStr, Field(..., description="The scope of the investment account entity.")], identifier_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InvestmentAccount, Awaitable[InvestmentAccount]]: # noqa: E501
70
70
  """[EXPERIMENTAL] GetInvestmentAccount: Get Investment Account # noqa: E501
71
71
 
72
72
  Retrieve the definition of an investment account. # noqa: E501
73
73
  This method makes a synchronous HTTP request by default. To make an
74
74
  asynchronous HTTP request, please pass async_req=True
75
75
 
76
- >>> thread = api.get_investment_account(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
76
+ >>> thread = api.get_investment_account(identifier_type, identifier_value, scope, identifier_scope, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
77
77
  >>> result = thread.get()
78
78
 
79
- :param id_type_scope: Scope of the investment account identifier type. (required)
80
- :type id_type_scope: str
81
- :param id_type_code: Code of the investment account identifier type. (required)
82
- :type id_type_code: str
83
- :param code: Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account. (required)
84
- :type code: str
79
+ :param identifier_type: Code of the investment account identifier type. (required)
80
+ :type identifier_type: str
81
+ :param identifier_value: Code of the investment account under specified identifier type's scope and code. (required)
82
+ :type identifier_value: str
83
+ :param scope: The scope of the investment account entity. (required)
84
+ :type scope: str
85
+ :param identifier_scope: Scope of the investment account identifier type. (required)
86
+ :type identifier_scope: str
85
87
  :param property_keys: A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".
86
88
  :type property_keys: List[str]
87
89
  :param effective_at: The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.
@@ -106,25 +108,27 @@ class InvestmentAccountsApi:
106
108
  raise ValueError(message)
107
109
  if async_req is not None:
108
110
  kwargs['async_req'] = async_req
109
- return self.get_investment_account_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, **kwargs) # noqa: E501
111
+ return self.get_investment_account_with_http_info(identifier_type, identifier_value, scope, identifier_scope, property_keys, effective_at, as_at, relationship_definition_ids, **kwargs) # noqa: E501
110
112
 
111
113
  @validate_arguments
112
- def get_investment_account_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
114
+ def get_investment_account_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="Code of the investment account identifier type.")], identifier_value : Annotated[StrictStr, Field(..., description="Code of the investment account under specified identifier type's scope and code.")], scope : Annotated[StrictStr, Field(..., description="The scope of the investment account entity.")], identifier_scope : Annotated[StrictStr, Field(..., description="Scope of the investment account identifier type.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the investment account. Defaults to return the latest version of the investment account if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the investment account in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
113
115
  """[EXPERIMENTAL] GetInvestmentAccount: Get Investment Account # noqa: E501
114
116
 
115
117
  Retrieve the definition of an investment account. # noqa: E501
116
118
  This method makes a synchronous HTTP request by default. To make an
117
119
  asynchronous HTTP request, please pass async_req=True
118
120
 
119
- >>> thread = api.get_investment_account_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
121
+ >>> thread = api.get_investment_account_with_http_info(identifier_type, identifier_value, scope, identifier_scope, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
120
122
  >>> result = thread.get()
121
123
 
122
- :param id_type_scope: Scope of the investment account identifier type. (required)
123
- :type id_type_scope: str
124
- :param id_type_code: Code of the investment account identifier type. (required)
125
- :type id_type_code: str
126
- :param code: Code of the investment account under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the investment account. (required)
127
- :type code: str
124
+ :param identifier_type: Code of the investment account identifier type. (required)
125
+ :type identifier_type: str
126
+ :param identifier_value: Code of the investment account under specified identifier type's scope and code. (required)
127
+ :type identifier_value: str
128
+ :param scope: The scope of the investment account entity. (required)
129
+ :type scope: str
130
+ :param identifier_scope: Scope of the investment account identifier type. (required)
131
+ :type identifier_scope: str
128
132
  :param property_keys: A list of property keys or identifier types (as property keys) from the \"InvestmentAccount\" domain to include for found investment account, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"InvestmentAccount/ContactDetails/Address\".
129
133
  :type property_keys: List[str]
130
134
  :param effective_at: The effective datetime or cut label at which to retrieve the investment account. Defaults to the current LUSID system datetime if not specified.
@@ -160,9 +164,10 @@ class InvestmentAccountsApi:
160
164
  _params = locals()
161
165
 
162
166
  _all_params = [
163
- 'id_type_scope',
164
- 'id_type_code',
165
- 'code',
167
+ 'identifier_type',
168
+ 'identifier_value',
169
+ 'scope',
170
+ 'identifier_scope',
166
171
  'property_keys',
167
172
  'effective_at',
168
173
  'as_at',
@@ -195,18 +200,21 @@ class InvestmentAccountsApi:
195
200
 
196
201
  # process the path parameters
197
202
  _path_params = {}
198
- if _params['id_type_scope']:
199
- _path_params['idTypeScope'] = _params['id_type_scope']
203
+ if _params['identifier_type']:
204
+ _path_params['identifierType'] = _params['identifier_type']
200
205
 
201
- if _params['id_type_code']:
202
- _path_params['idTypeCode'] = _params['id_type_code']
203
-
204
- if _params['code']:
205
- _path_params['code'] = _params['code']
206
+ if _params['identifier_value']:
207
+ _path_params['identifierValue'] = _params['identifier_value']
206
208
 
207
209
 
208
210
  # process the query parameters
209
211
  _query_params = []
212
+ if _params.get('scope') is not None: # noqa: E501
213
+ _query_params.append(('scope', _params['scope']))
214
+
215
+ if _params.get('identifier_scope') is not None: # noqa: E501
216
+ _query_params.append(('identifierScope', _params['identifier_scope']))
217
+
210
218
  if _params.get('property_keys') is not None: # noqa: E501
211
219
  _query_params.append(('propertyKeys', _params['property_keys']))
212
220
  _collection_formats['propertyKeys'] = 'multi'
@@ -244,7 +252,7 @@ class InvestmentAccountsApi:
244
252
  }
245
253
 
246
254
  return self.api_client.call_api(
247
- '/api/investmentaccounts/{idTypeScope}/{idTypeCode}/{code}', 'GET',
255
+ '/api/investmentaccounts/{identifierType}/{identifierValue}', 'GET',
248
256
  _path_params,
249
257
  _query_params,
250
258
  _header_params,