lusid-sdk 2.1.303__py3-none-any.whl → 2.1.310__py3-none-any.whl

lusid/api/scopes_api.py

@@ -20,7 +20,9 @@ from pydantic.v1 import validate_arguments, ValidationError
 from typing import overload, Optional, Union, Awaitable
 
 from typing_extensions import Annotated
-from pydantic.v1 import Field, constr, validator
+from datetime import datetime
+
+from pydantic.v1 import Field, conint, constr, validator
 
 from typing import Optional
 
@@ -47,26 +49,32 @@ class ScopesApi:
         self.api_client = api_client
 
     @overload
-    async def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
+    async def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
         ...
 
     @overload
-    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
+    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
         ...
 
     @validate_arguments
-    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]:  # noqa: E501
+    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]:  # noqa: E501
         """ListEntityScopes: List Entity Scopes  # noqa: E501
 
         List all the scopes for a given entity type that contain data.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.list_entity_scopes(entity_type, async_req=True)
+        >>> thread = api.list_entity_scopes(entity_type, as_at, page, limit, async_req=True)
         >>> result = thread.get()
 
         :param entity_type: The entity type to list scopes for. (required)
         :type entity_type: str
+        :param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
+        :type as_at: datetime
+        :param page: The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
+        :type limit: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request.
@@ -84,21 +92,27 @@ class ScopesApi:
             raise ValueError(message)
         if async_req is not None:
             kwargs['async_req'] = async_req
-        return self.list_entity_scopes_with_http_info(entity_type, **kwargs)  # noqa: E501
+        return self.list_entity_scopes_with_http_info(entity_type, as_at, page, limit, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def list_entity_scopes_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def list_entity_scopes_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """ListEntityScopes: List Entity Scopes  # noqa: E501
 
         List all the scopes for a given entity type that contain data.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.list_entity_scopes_with_http_info(entity_type, async_req=True)
+        >>> thread = api.list_entity_scopes_with_http_info(entity_type, as_at, page, limit, async_req=True)
         >>> result = thread.get()
 
         :param entity_type: The entity type to list scopes for. (required)
         :type entity_type: str
+        :param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
+        :type as_at: datetime
+        :param page: The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
+        :type limit: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -127,7 +141,10 @@ class ScopesApi:
         _params = locals()
 
         _all_params = [
-            'entity_type'
+            'entity_type',
+            'as_at',
+            'page',
+            'limit'
         ]
         _all_params.extend(
             [
@@ -161,6 +178,18 @@ class ScopesApi:
 
         # process the query parameters
         _query_params = []
+        if _params.get('as_at') is not None:  # noqa: E501
+            if isinstance(_params['as_at'], datetime):
+                _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('asAt', _params['as_at']))
+
+        if _params.get('page') is not None:  # noqa: E501
+            _query_params.append(('page', _params['page']))
+
+        if _params.get('limit') is not None:  # noqa: E501
+            _query_params.append(('limit', _params['limit']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters

lusid/configuration.py

@@ -373,7 +373,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6734\n"\
+               "Version of the API: 0.11.6741\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

{lusid_sdk-2.1.303.dist-info → lusid_sdk-2.1.310.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.303
+Version: 2.1.310
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -29,8 +29,8 @@ FINBOURNE Technology
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.11.6734
-- Package version: 2.1.303
+- API version: 0.11.6741
+- Package version: 2.1.310
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
 

{lusid_sdk-2.1.303.dist-info → lusid_sdk-2.1.310.dist-info}/RECORD

@@ -53,7 +53,7 @@ lusid/api/relations_api.py,sha256=ka5L0sQkPNLiQS8vXhcOk0EYkJu2LIuqInmLGnoZSLA,22
 lusid/api/relationship_definitions_api.py,sha256=30MXQITMjIYXdedMRYH7lrj-rPhkIhhJN-yfB_rWAtU,54693
 lusid/api/relationships_api.py,sha256=CkqKKRKJm39FJXIKUgMa6py12fq1HN1iLC8v9MIBf_8,19956
 lusid/api/schemas_api.py,sha256=RrFrHu6dNw060nLQ6kpWa-eRPBlv8prk-ldGi04mgEU,30928
-lusid/api/scopes_api.py,sha256=p8OnCyJtsYrM0I-jzmHfhMJKAXzWkl52LtGVQw5DMtc,16390
+lusid/api/scopes_api.py,sha256=RZQAp2jCrG_uwd9wccrvmXs5ekoIie7WdfzARBwXRR0,21317
 lusid/api/scripted_translation_api.py,sha256=jOeKhCjDpq3M1FU9mAH-2sbW_O3NhVuirKPtJrDbEgo,84048
 lusid/api/search_api.py,sha256=Y6wgyv5H6EDEICDYERU_jXdAFmr0GPEe8r2BnM0KzXI,58533
 lusid/api/sequences_api.py,sha256=NUACzaG_zcloEMFwuIxI2c2MiQNmkBULUq7qeNvZ0GQ,37460
@@ -68,7 +68,7 @@ lusid/api/transaction_portfolios_api.py,sha256=7G5m6iTQXTKCc6ASdxnlVJjvFascHxEgD
 lusid/api/translation_api.py,sha256=xTAaKEW96JTDIZBXCjxSguCa7Gz4oVd5jdObUE2egwo,20092
 lusid/api_client.py,sha256=dF6l9RAsdxdQjf6Qn4ny6LB-QXlJmsscWiozCvyyBFA,30709
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=rOBsSCuZbdzdxRTeaQJGdgkySUjo4CKlSzx8CZNyeCo,14404
+lusid/configuration.py,sha256=RLaV9bgvbMMGLW9pOe7mwuG1eyF3mwKeaC8Ah0p98ds,14404
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=dzDHEzpn-9smd2-_UMWQzeyX6Ha4jGf6fnqx7qxKxNI,630
 lusid/extensions/api_client.py,sha256=Ob06urm4Em3MLzgP_geyeeGsPCkU225msW_1kpIeABM,30567
@@ -1109,6 +1109,6 @@ lusid/models/weighted_instruments.py,sha256=1y_y_vw4-LPsbkQx4FOzWdZc5fJnzhVkf1D3
 lusid/models/yield_curve_data.py,sha256=SbxvdJ4-GWK9kpMdw4Fnxc7_kvIMwgsRsd_31UJn7nw,6330
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=TNUzQ3yLNT2L053EdR7R0vNzQh2J3TlYD1T56Dye0W0,10138
-lusid_sdk-2.1.303.dist-info/METADATA,sha256=OYq_QuFvqtlnE8Mts4XrAGbQZtfVCG_8Om1JEKg3W-0,193452
-lusid_sdk-2.1.303.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lusid_sdk-2.1.303.dist-info/RECORD,,
+lusid_sdk-2.1.310.dist-info/METADATA,sha256=OIAFBwFjeGTyB8av395xwrx1gtosbfwvyg1qaJy2XXo,193452
+lusid_sdk-2.1.310.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lusid_sdk-2.1.310.dist-info/RECORD,,