lusid-sdk 2.1.395__py3-none-any.whl → 2.1.400__py3-none-any.whl

lusid/__init__.py

@@ -159,6 +159,8 @@ from lusid.models.basket import Basket
 from lusid.models.basket_identifier import BasketIdentifier
 from lusid.models.batch_adjust_holdings_response import BatchAdjustHoldingsResponse
 from lusid.models.batch_upsert_instrument_properties_response import BatchUpsertInstrumentPropertiesResponse
+from lusid.models.batch_upsert_portfolio_access_metadata_request import BatchUpsertPortfolioAccessMetadataRequest
+from lusid.models.batch_upsert_portfolio_access_metadata_response import BatchUpsertPortfolioAccessMetadataResponse
 from lusid.models.batch_upsert_portfolio_transactions_response import BatchUpsertPortfolioTransactionsResponse
 from lusid.models.batch_upsert_property_definition_properties_response import BatchUpsertPropertyDefinitionPropertiesResponse
 from lusid.models.block import Block
@@ -597,6 +599,8 @@ from lusid.models.market_quote import MarketQuote
 from lusid.models.match_criterion import MatchCriterion
 from lusid.models.maturity_event import MaturityEvent
 from lusid.models.merger_event import MergerEvent
+from lusid.models.metadata_key_value import MetadataKeyValue
+from lusid.models.metadata_key_value_response import MetadataKeyValueResponse
 from lusid.models.metric_value import MetricValue
 from lusid.models.model_options import ModelOptions
 from lusid.models.model_options_type import ModelOptionsType
@@ -1303,6 +1307,8 @@ __all__ = [
     "BasketIdentifier",
     "BatchAdjustHoldingsResponse",
     "BatchUpsertInstrumentPropertiesResponse",
+    "BatchUpsertPortfolioAccessMetadataRequest",
+    "BatchUpsertPortfolioAccessMetadataResponse",
     "BatchUpsertPortfolioTransactionsResponse",
     "BatchUpsertPropertyDefinitionPropertiesResponse",
     "Block",
@@ -1741,6 +1747,8 @@ __all__ = [
     "MatchCriterion",
     "MaturityEvent",
     "MergerEvent",
+    "MetadataKeyValue",
+    "MetadataKeyValueResponse",
     "MetricValue",
     "ModelOptions",
     "ModelOptionsType",

lusid/api/portfolios_api.py

@@ -31,6 +31,8 @@ from lusid.models.access_metadata_value import AccessMetadataValue
 from lusid.models.aggregated_returns_dispersion_request import AggregatedReturnsDispersionRequest
 from lusid.models.aggregated_returns_request import AggregatedReturnsRequest
 from lusid.models.aggregated_returns_response import AggregatedReturnsResponse
+from lusid.models.batch_upsert_portfolio_access_metadata_request import BatchUpsertPortfolioAccessMetadataRequest
+from lusid.models.batch_upsert_portfolio_access_metadata_response import BatchUpsertPortfolioAccessMetadataResponse
 from lusid.models.composite_breakdown_request import CompositeBreakdownRequest
 from lusid.models.composite_breakdown_response import CompositeBreakdownResponse
 from lusid.models.composite_dispersion_response import CompositeDispersionResponse
@@ -77,6 +79,183 @@ class PortfoliosApi:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
+    @overload
+    async def batch_upsert_portfolio_access_metadata(self, batch_upsert_portfolio_access_metadata_request : Annotated[BatchUpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse:  # noqa: E501
+        ...
+
+    @overload
+    def batch_upsert_portfolio_access_metadata(self, batch_upsert_portfolio_access_metadata_request : Annotated[BatchUpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def batch_upsert_portfolio_access_metadata(self, batch_upsert_portfolio_access_metadata_request : Annotated[BatchUpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertPortfolioAccessMetadataResponse, Awaitable[BatchUpsertPortfolioAccessMetadataResponse]]:  # noqa: E501
+        """[EXPERIMENTAL] BatchUpsertPortfolioAccessMetadata: Upsert multiple portfolio access metadata with different keys to multiple portfolios  # noqa: E501
+
+        Update or insert multiple Portfolios Access Metadata Rule in multiple scopes. Items will be updated if it already exists  and inserted if it does not. No other items will be affected    The response will return the successfully updated or inserted Portfolio Access Metadata Rules or failure message if unsuccessful    It is important to always check to verify success (or failure).                Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.batch_upsert_portfolio_access_metadata(batch_upsert_portfolio_access_metadata_request, effective_at, effective_until, async_req=True)
+        >>> result = thread.get()
+
+        :param batch_upsert_portfolio_access_metadata_request: The Portfolio Access Metadata Rule to update or insert (required)
+        :type batch_upsert_portfolio_access_metadata_request: BatchUpsertPortfolioAccessMetadataRequest
+        :param effective_at: The date this rule will effective from
+        :type effective_at: str
+        :param effective_until: The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata
+        :type effective_until: datetime
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: BatchUpsertPortfolioAccessMetadataResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the batch_upsert_portfolio_access_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        if async_req is not None:
+            kwargs['async_req'] = async_req
+        return self.batch_upsert_portfolio_access_metadata_with_http_info(batch_upsert_portfolio_access_metadata_request, effective_at, effective_until, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def batch_upsert_portfolio_access_metadata_with_http_info(self, batch_upsert_portfolio_access_metadata_request : Annotated[BatchUpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EXPERIMENTAL] BatchUpsertPortfolioAccessMetadata: Upsert multiple portfolio access metadata with different keys to multiple portfolios  # noqa: E501
+
+        Update or insert multiple Portfolios Access Metadata Rule in multiple scopes. Items will be updated if it already exists  and inserted if it does not. No other items will be affected    The response will return the successfully updated or inserted Portfolio Access Metadata Rules or failure message if unsuccessful    It is important to always check to verify success (or failure).                Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.batch_upsert_portfolio_access_metadata_with_http_info(batch_upsert_portfolio_access_metadata_request, effective_at, effective_until, async_req=True)
+        >>> result = thread.get()
+
+        :param batch_upsert_portfolio_access_metadata_request: The Portfolio Access Metadata Rule to update or insert (required)
+        :type batch_upsert_portfolio_access_metadata_request: BatchUpsertPortfolioAccessMetadataRequest
+        :param effective_at: The date this rule will effective from
+        :type effective_at: str
+        :param effective_until: The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata
+        :type effective_until: datetime
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(BatchUpsertPortfolioAccessMetadataResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'batch_upsert_portfolio_access_metadata_request',
+            'effective_at',
+            'effective_until'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method batch_upsert_portfolio_access_metadata" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('effective_at') is not None:  # noqa: E501
+            _query_params.append(('effectiveAt', _params['effective_at']))
+
+        if _params.get('effective_until') is not None:  # noqa: E501
+            if isinstance(_params['effective_until'], datetime):
+                _query_params.append(('effectiveUntil', _params['effective_until'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('effectiveUntil', _params['effective_until']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params['batch_upsert_portfolio_access_metadata_request'] is not None:
+            _body_params = _params['batch_upsert_portfolio_access_metadata_request']
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get('_content_type',
+            self.api_client.select_header_content_type(
+                ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
+        if _content_types_list:
+                _header_params['Content-Type'] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '200': "BatchUpsertPortfolioAccessMetadataResponse",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/portfolios/metadata', 'PUT',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @overload
     async def delete_instrument_event_instruction(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be deleted.")], portfolio_effective_at : Annotated[Optional[constr(strict=True, max_length=6000, min_length=0)], Field(description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, **kwargs) -> DeletedEntityResponse:  # noqa: E501
         ...

lusid/configuration.py

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

lusid/models/__init__.py

@@ -78,6 +78,8 @@ from lusid.models.basket import Basket
 from lusid.models.basket_identifier import BasketIdentifier
 from lusid.models.batch_adjust_holdings_response import BatchAdjustHoldingsResponse
 from lusid.models.batch_upsert_instrument_properties_response import BatchUpsertInstrumentPropertiesResponse
+from lusid.models.batch_upsert_portfolio_access_metadata_request import BatchUpsertPortfolioAccessMetadataRequest
+from lusid.models.batch_upsert_portfolio_access_metadata_response import BatchUpsertPortfolioAccessMetadataResponse
 from lusid.models.batch_upsert_portfolio_transactions_response import BatchUpsertPortfolioTransactionsResponse
 from lusid.models.batch_upsert_property_definition_properties_response import BatchUpsertPropertyDefinitionPropertiesResponse
 from lusid.models.block import Block
@@ -516,6 +518,8 @@ from lusid.models.market_quote import MarketQuote
 from lusid.models.match_criterion import MatchCriterion
 from lusid.models.maturity_event import MaturityEvent
 from lusid.models.merger_event import MergerEvent
+from lusid.models.metadata_key_value import MetadataKeyValue
+from lusid.models.metadata_key_value_response import MetadataKeyValueResponse
 from lusid.models.metric_value import MetricValue
 from lusid.models.model_options import ModelOptions
 from lusid.models.model_options_type import ModelOptionsType
@@ -1142,6 +1146,8 @@ __all__ = [
     "BasketIdentifier",
     "BatchAdjustHoldingsResponse",
     "BatchUpsertInstrumentPropertiesResponse",
+    "BatchUpsertPortfolioAccessMetadataRequest",
+    "BatchUpsertPortfolioAccessMetadataResponse",
     "BatchUpsertPortfolioTransactionsResponse",
     "BatchUpsertPropertyDefinitionPropertiesResponse",
     "Block",
@@ -1580,6 +1586,8 @@ __all__ = [
     "MatchCriterion",
     "MaturityEvent",
     "MergerEvent",
+    "MetadataKeyValue",
+    "MetadataKeyValueResponse",
     "MetricValue",
     "ModelOptions",
     "ModelOptionsType",

lusid/models/batch_upsert_portfolio_access_metadata_request.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict
+from pydantic.v1 import BaseModel, Field
+from lusid.models.metadata_key_value import MetadataKeyValue
+
+class BatchUpsertPortfolioAccessMetadataRequest(BaseModel):
+    """
+    BatchUpsertPortfolioAccessMetadataRequest
+    """
+    portfolios_with_metadata: Dict[str, MetadataKeyValue] = Field(..., alias="portfoliosWithMetadata", description="The set of portfolios with the access control metadata")
+    __properties = ["portfoliosWithMetadata"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> BatchUpsertPortfolioAccessMetadataRequest:
+        """Create an instance of BatchUpsertPortfolioAccessMetadataRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in portfolios_with_metadata (dict)
+        _field_dict = {}
+        if self.portfolios_with_metadata:
+            for _key in self.portfolios_with_metadata:
+                if self.portfolios_with_metadata[_key]:
+                    _field_dict[_key] = self.portfolios_with_metadata[_key].to_dict()
+            _dict['portfoliosWithMetadata'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BatchUpsertPortfolioAccessMetadataRequest:
+        """Create an instance of BatchUpsertPortfolioAccessMetadataRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BatchUpsertPortfolioAccessMetadataRequest.parse_obj(obj)
+
+        _obj = BatchUpsertPortfolioAccessMetadataRequest.parse_obj({
+            "portfolios_with_metadata": dict(
+                (_k, MetadataKeyValue.from_dict(_v))
+                for _k, _v in obj.get("portfoliosWithMetadata").items()
+            )
+            if obj.get("portfoliosWithMetadata") is not None
+            else None
+        })
+        return _obj

lusid/models/batch_upsert_portfolio_access_metadata_response.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict
+from pydantic.v1 import BaseModel, Field
+from lusid.models.metadata_key_value_response import MetadataKeyValueResponse
+
+class BatchUpsertPortfolioAccessMetadataResponse(BaseModel):
+    """
+    BatchUpsertPortfolioAccessMetadataResponse
+    """
+    portfolios_with_metadata: Dict[str, MetadataKeyValueResponse] = Field(..., alias="portfoliosWithMetadata", description="The set of portfolios with the access control metadata")
+    __properties = ["portfoliosWithMetadata"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> BatchUpsertPortfolioAccessMetadataResponse:
+        """Create an instance of BatchUpsertPortfolioAccessMetadataResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in portfolios_with_metadata (dict)
+        _field_dict = {}
+        if self.portfolios_with_metadata:
+            for _key in self.portfolios_with_metadata:
+                if self.portfolios_with_metadata[_key]:
+                    _field_dict[_key] = self.portfolios_with_metadata[_key].to_dict()
+            _dict['portfoliosWithMetadata'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BatchUpsertPortfolioAccessMetadataResponse:
+        """Create an instance of BatchUpsertPortfolioAccessMetadataResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BatchUpsertPortfolioAccessMetadataResponse.parse_obj(obj)
+
+        _obj = BatchUpsertPortfolioAccessMetadataResponse.parse_obj({
+            "portfolios_with_metadata": dict(
+                (_k, MetadataKeyValueResponse.from_dict(_v))
+                for _k, _v in obj.get("portfoliosWithMetadata").items()
+            )
+            if obj.get("portfoliosWithMetadata") is not None
+            else None
+        })
+        return _obj

lusid/models/metadata_key_value.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, List
+from pydantic.v1 import BaseModel, Field, conlist
+from lusid.models.access_metadata_value import AccessMetadataValue
+
+class MetadataKeyValue(BaseModel):
+    """
+    MetadataKeyValue
+    """
+    metadata: Dict[str, conlist(AccessMetadataValue)] = Field(...)
+    __properties = ["metadata"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> MetadataKeyValue:
+        """Create an instance of MetadataKeyValue from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict of array)
+        _field_dict_of_array = {}
+        if self.metadata:
+            for _key in self.metadata:
+                if self.metadata[_key]:
+                    _field_dict_of_array[_key] = [
+                        _item.to_dict() for _item in self.metadata[_key]
+                    ]
+            _dict['metadata'] = _field_dict_of_array
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MetadataKeyValue:
+        """Create an instance of MetadataKeyValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MetadataKeyValue.parse_obj(obj)
+
+        _obj = MetadataKeyValue.parse_obj({
+            "metadata": dict(
+                (_k,
+                        [AccessMetadataValue.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("metadata").items()
+            )
+        })
+        return _obj

lusid/models/metadata_key_value_response.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, List
+from pydantic.v1 import BaseModel, Field, conlist
+from lusid.models.access_metadata_value import AccessMetadataValue
+
+class MetadataKeyValueResponse(BaseModel):
+    """
+    MetadataKeyValueResponse
+    """
+    metadata: Dict[str, conlist(AccessMetadataValue)] = Field(...)
+    __properties = ["metadata"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> MetadataKeyValueResponse:
+        """Create an instance of MetadataKeyValueResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict of array)
+        _field_dict_of_array = {}
+        if self.metadata:
+            for _key in self.metadata:
+                if self.metadata[_key]:
+                    _field_dict_of_array[_key] = [
+                        _item.to_dict() for _item in self.metadata[_key]
+                    ]
+            _dict['metadata'] = _field_dict_of_array
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MetadataKeyValueResponse:
+        """Create an instance of MetadataKeyValueResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MetadataKeyValueResponse.parse_obj(obj)
+
+        _obj = MetadataKeyValueResponse.parse_obj({
+            "metadata": dict(
+                (_k,
+                        [AccessMetadataValue.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("metadata").items()
+            )
+        })
+        return _obj

lusid/models/staged_modification.py

@@ -39,6 +39,7 @@ class StagedModification(BaseModel):
     decisions: Optional[conlist(StagedModificationDecision)] = Field(None, description="Object containing information relating to the decision on the staged modification.")
     decisions_count: Optional[StrictInt] = Field(None, alias="decisionsCount", description="Number of decisions made.")
     status: Optional[StrictStr] = Field(None, description="The status of the staged modification.")
+    as_at_closed: Optional[datetime] = Field(None, alias="asAtClosed", description="Time at which the modification was closed by either rejection or approval.")
     entity_type: Optional[StrictStr] = Field(None, alias="entityType", description="The type of the entity that the staged modification applies to.")
     scope: Optional[StrictStr] = Field(None, description="The scope of the entity that this staged modification applies to.")
     entity_unique_id: Optional[StrictStr] = Field(None, alias="entityUniqueId", description="The unique Id of the entity the staged modification applies to.")
@@ -46,7 +47,7 @@ class StagedModification(BaseModel):
     entity_hrefs: Optional[StagedModificationsEntityHrefs] = Field(None, alias="entityHrefs")
     display_name: Optional[StrictStr] = Field(None, alias="displayName", description="The display name of the entity the staged modification applies to.")
     links: Optional[conlist(Link)] = None
-    __properties = ["id", "asAtStaged", "userIdStaged", "requestedIdStaged", "action", "stagingRule", "decisions", "decisionsCount", "status", "entityType", "scope", "entityUniqueId", "requestedChanges", "entityHrefs", "displayName", "links"]
+    __properties = ["id", "asAtStaged", "userIdStaged", "requestedIdStaged", "action", "stagingRule", "decisions", "decisionsCount", "status", "asAtClosed", "entityType", "scope", "entityUniqueId", "requestedChanges", "entityHrefs", "displayName", "links"]
 
     class Config:
         """Pydantic configuration"""
@@ -125,6 +126,11 @@ class StagedModification(BaseModel):
         if self.status is None and "status" in self.__fields_set__:
             _dict['status'] = None
 
+        # set to None if as_at_closed (nullable) is None
+        # and __fields_set__ contains the field
+        if self.as_at_closed is None and "as_at_closed" in self.__fields_set__:
+            _dict['asAtClosed'] = None
+
         # set to None if entity_type (nullable) is None
         # and __fields_set__ contains the field
         if self.entity_type is None and "entity_type" in self.__fields_set__:
@@ -171,6 +177,7 @@ class StagedModification(BaseModel):
             "decisions": [StagedModificationDecision.from_dict(_item) for _item in obj.get("decisions")] if obj.get("decisions") is not None else None,
             "decisions_count": obj.get("decisionsCount"),
             "status": obj.get("status"),
+            "as_at_closed": obj.get("asAtClosed"),
             "entity_type": obj.get("entityType"),
             "scope": obj.get("scope"),
             "entity_unique_id": obj.get("entityUniqueId"),

{lusid_sdk-2.1.395.dist-info → lusid_sdk-2.1.400.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.395
+Version: 2.1.400
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -384,6 +384,7 @@ Class | Method | HTTP request | Description
 *PortfolioGroupsApi* | [**update_portfolio_group**](docs/PortfolioGroupsApi.md#update_portfolio_group) | **PUT** /api/portfoliogroups/{scope}/{code} | [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group
 *PortfolioGroupsApi* | [**upsert_group_properties**](docs/PortfolioGroupsApi.md#upsert_group_properties) | **POST** /api/portfoliogroups/{scope}/{code}/properties/$upsert | [EARLY ACCESS] UpsertGroupProperties: Upsert group properties
 *PortfolioGroupsApi* | [**upsert_portfolio_group_access_metadata**](docs/PortfolioGroupsApi.md#upsert_portfolio_group_access_metadata) | **PUT** /api/portfoliogroups/{scope}/{code}/metadata/{metadataKey} | UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
+*PortfoliosApi* | [**batch_upsert_portfolio_access_metadata**](docs/PortfoliosApi.md#batch_upsert_portfolio_access_metadata) | **PUT** /api/portfolios/metadata | [EXPERIMENTAL] BatchUpsertPortfolioAccessMetadata: Upsert multiple portfolio access metadata with different keys to multiple portfolios
 *PortfoliosApi* | [**delete_instrument_event_instruction**](docs/PortfoliosApi.md#delete_instrument_event_instruction) | **DELETE** /api/portfolios/{scope}/{code}/instrumenteventinstructions/{instrumentEventInstructionId} | [EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction
 *PortfoliosApi* | [**delete_key_from_portfolio_access_metadata**](docs/PortfoliosApi.md#delete_key_from_portfolio_access_metadata) | **DELETE** /api/portfolios/{scope}/{code}/metadata/{metadataKey} | DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule
 *PortfoliosApi* | [**delete_portfolio**](docs/PortfoliosApi.md#delete_portfolio) | **DELETE** /api/portfolios/{scope}/{code} | DeletePortfolio: Delete portfolio
@@ -665,6 +666,8 @@ Class | Method | HTTP request | Description
  - [BasketIdentifier](docs/BasketIdentifier.md)
  - [BatchAdjustHoldingsResponse](docs/BatchAdjustHoldingsResponse.md)
  - [BatchUpsertInstrumentPropertiesResponse](docs/BatchUpsertInstrumentPropertiesResponse.md)
+ - [BatchUpsertPortfolioAccessMetadataRequest](docs/BatchUpsertPortfolioAccessMetadataRequest.md)
+ - [BatchUpsertPortfolioAccessMetadataResponse](docs/BatchUpsertPortfolioAccessMetadataResponse.md)
  - [BatchUpsertPortfolioTransactionsResponse](docs/BatchUpsertPortfolioTransactionsResponse.md)
  - [BatchUpsertPropertyDefinitionPropertiesResponse](docs/BatchUpsertPropertyDefinitionPropertiesResponse.md)
  - [Block](docs/Block.md)
@@ -1103,6 +1106,8 @@ Class | Method | HTTP request | Description
  - [MatchCriterion](docs/MatchCriterion.md)
  - [MaturityEvent](docs/MaturityEvent.md)
  - [MergerEvent](docs/MergerEvent.md)
+ - [MetadataKeyValue](docs/MetadataKeyValue.md)
+ - [MetadataKeyValueResponse](docs/MetadataKeyValueResponse.md)
  - [MetricValue](docs/MetricValue.md)
  - [ModelOptions](docs/ModelOptions.md)
  - [ModelOptionsType](docs/ModelOptionsType.md)

{lusid_sdk-2.1.395.dist-info → lusid_sdk-2.1.400.dist-info}/RECORD

@@ -1,4 +1,4 @@
-lusid/__init__.py,sha256=PAz7_G32DWdLvPl9ZQpzNAsdMuv8-EuTPKUkPqBW3jo,118114
+lusid/__init__.py,sha256=aAn-r6xm3PnHcGlbs6Y5Ya04Rp32iiwTxUq5RYMgXKs,118638
 lusid/api/__init__.py,sha256=PcSZQXr1WZ0bijnKFOIf_xpuAuCF6zMxQQZvMecw2U4,5824
 lusid/api/abor_api.py,sha256=AvgsHuWE7qRSYJhKveBE2htSjHpqqS0VNJrysAfwME0,159655
 lusid/api/abor_configuration_api.py,sha256=G2bKPtMYOZ2GhUrg-nPJtCa9XIZdZYK7oafcbJWDMP8,64033
@@ -42,7 +42,7 @@ lusid/api/participations_api.py,sha256=nlVzeyfE33X9Ue9HC9rqCW3WACEPKBvcrEjFEmT8w
 lusid/api/persons_api.py,sha256=wYB_EaDB9LXTXuSIQr8SIR4h-0NrTgisfwd5uShz8JQ,256317
 lusid/api/placements_api.py,sha256=bsX7VHZlvnxJiZ3ZPtlJ8md_exerU-Qa_BkHGVRphH8,45797
 lusid/api/portfolio_groups_api.py,sha256=IueIpi-krYvm5w-I0gkvkYAgxHXfiWejRYcW6DW8400,380452
-lusid/api/portfolios_api.py,sha256=pXwxugbm-zQf901tDlh_zbC4odf384sQKclu1rrIWXk,421231
+lusid/api/portfolios_api.py,sha256=K8PpMVwZ4Q-O8TlafI8pdY1NHE4eY_X1R-RtiOGRPzs,433889
 lusid/api/property_definitions_api.py,sha256=I3aISrQ3USeB-Vkx8OVyakx345aEhPATghGmEtL6ApU,140367
 lusid/api/queryable_keys_api.py,sha256=1HafmN22bU1bV5H5nua8EZ5oL0pe0LZ5xkVDQTDSezg,10281
 lusid/api/quotes_api.py,sha256=QPSJ6rFAI-hsvei1QA-PoCzpHRJlcvF_SiCxyGyG678,115595
@@ -70,7 +70,7 @@ lusid/api/translation_api.py,sha256=xTAaKEW96JTDIZBXCjxSguCa7Gz4oVd5jdObUE2egwo,
 lusid/api/workspace_api.py,sha256=GtjOpr7UDgtXa3KmlwmFX4LJEa5dg53qzTyfy-FY0d4,192167
 lusid/api_client.py,sha256=dF6l9RAsdxdQjf6Qn4ny6LB-QXlJmsscWiozCvyyBFA,30709
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=M-wxrukpbuOcDxtt19CWXlKTyUi8xNwKD4AkCP_azvg,14733
+lusid/configuration.py,sha256=ALkV4ACrE_qhz2YgIH7Sn_C6rcSj3pVdi8NZerz3siU,14733
 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
@@ -84,7 +84,7 @@ lusid/extensions/rest.py,sha256=tjVCu-cRrYcjp-ttB975vebPKtBNyBWaeoAdO3QXG2I,1269
 lusid/extensions/retry.py,sha256=orBJ1uF1iT1IncjWX1iGHVqsCgTh0SBe9rtiV_sPnwk,11564
 lusid/extensions/socket_keep_alive.py,sha256=NGlqsv-E25IjJOLGZhXZY6kUdx51nEF8qCQyVdzayRk,1653
 lusid/extensions/tcp_keep_alive_connector.py,sha256=zaGtUsygRsxB1_4B3x39K3ILwztdhMLDv5bFZV7zmGE,3877
-lusid/models/__init__.py,sha256=XT5xiwqTnYV7vPRsrNlAvTPRHwaILtS6XnG2i-oQZiA,111258
+lusid/models/__init__.py,sha256=V57h_NBkz3LXGGhL1dTQGvvVyfeVWRqZ7imt5oSyO8I,111782
 lusid/models/a2_b_breakdown.py,sha256=Txi12EIQw3mH6NM-25QkOnHSQc3BVAWrP7yl9bZswSY,2947
 lusid/models/a2_b_category.py,sha256=k6NPAACi0CUjKyhdQac4obQSrPmp2PXD6lkAtCnyEFM,2725
 lusid/models/a2_b_data_record.py,sha256=zKGS2P4fzNpzdcGJiSIpkY4P3d_jAcawYfyuPCDeQgk,9737
@@ -149,6 +149,8 @@ lusid/models/basket.py,sha256=Xu390DRo-j2mkzM7KBE1SIY4wgQ9xbP-shuHfMJotlo,5957
 lusid/models/basket_identifier.py,sha256=Fn2M8buKDbj7h9_1TSEpwsqICFdkPtF6_YI_Wc6KDJw,2562
 lusid/models/batch_adjust_holdings_response.py,sha256=G7YVmb6acbhitvRw_Vs7oAXTcxS5zt844jybc4lXOCY,5687
 lusid/models/batch_upsert_instrument_properties_response.py,sha256=5ZYvAlLZDj9iZ6NytbqzFN11K46Jeum8bLQIw7qx1o4,4543
+lusid/models/batch_upsert_portfolio_access_metadata_request.py,sha256=q1L5sg_og3qRSEwk7W5j-XtLff8VYU6A8RUX3ktsXk0,2908
+lusid/models/batch_upsert_portfolio_access_metadata_response.py,sha256=cuDgQKCHix3IMxqH3TWnQ2NmvGEpgyKAUOQ2S_AA1RQ,2949
 lusid/models/batch_upsert_portfolio_transactions_response.py,sha256=Mp6_7vGBkzqRNlpjOhn0ZokSKukKWyANAVBDxJIj9qs,5803
 lusid/models/batch_upsert_property_definition_properties_response.py,sha256=usZ-NS6zUvgma-xjye6VcpwkAyvAYV2C6oo6l_vDbxk,4424
 lusid/models/block.py,sha256=JPc2-U_zDYuVoqo8g6-NZzPMieUXEWolpquih6BEY8E,7158
@@ -587,6 +589,8 @@ lusid/models/market_quote.py,sha256=Ra6tOiimR6Rdf7pAESEWW2IMZG669jU8eNje8NepYZg,
 lusid/models/match_criterion.py,sha256=cnLfFgO9k05dH7ooGS7s3d8BvyJNuVMDUh3Yt-SPuec,3568
 lusid/models/maturity_event.py,sha256=pIqFyDQYrmcWQSNL5TI292ePWrgVaqQCyCJnvELTZtU,5093
 lusid/models/merger_event.py,sha256=81kyNE4Mxq2FB5J-88MFi7mM1ypQLyj7NVzAHvHuv2s,11174
+lusid/models/metadata_key_value.py,sha256=3zTNnm-mAn9GblTfhQVEqcjd5CCNa407ATEQqkF7jXw,2646
+lusid/models/metadata_key_value_response.py,sha256=zvlscsIOrmW5MBAdOQJVH55KhRkvPVNnIbhWBPNISbE,2710
 lusid/models/metric_value.py,sha256=QycljuRptuyuEisuUKhJ9kSSlDPJrAykErN9wPZ-x7o,2187
 lusid/models/model_options.py,sha256=MaLJVMOfpgwL_ZLIIrLbLwpC1lhZKNkzMOGlFlVFgSM,4202
 lusid/models/model_options_type.py,sha256=9vvfKHqvTqomRGVbnhsjA9hhCouD-acEgOeMK4OZ8AE,931
@@ -955,7 +959,7 @@ lusid/models/simple_cash_flow_loan.py,sha256=9iHHvivjXERGxq5TlRj48zHzDmpjka83V11
 lusid/models/simple_instrument.py,sha256=Cerk4RI9xGwP59xF19u0ar6JVMqHcEqC9mAysPCIlps,6849
 lusid/models/sort_order.py,sha256=tx9hNHkrcdw2gQkSLTGQ-JED7cqZoFJ60abVdqkD-GM,644
 lusid/models/spin_off_event.py,sha256=nnm2nQ-Zvgvtqdu1VRCFC5YrqDPJ5YDxFCZ4bOCaWl0,8851
-lusid/models/staged_modification.py,sha256=SMPrCbKed3JZ8Sv5qOzdCY_S41tA37PcO5jv2QZ7ij8,9179
+lusid/models/staged_modification.py,sha256=LGM7EU5w7C7W7fuW9bYEDySqevWEV6edaW206n9LxS4,9630
 lusid/models/staged_modification_decision.py,sha256=IUIpOwYjk41vLP_nMWDzZgI354cCtM9L6Yrf-K_DP4s,3544
 lusid/models/staged_modification_decision_request.py,sha256=6PlH7coUQUIJe1-2GcwpatO3tpcqHIBelpgrd_BZ8qQ,2257
 lusid/models/staged_modification_effective_range.py,sha256=G9oChBwQ_358d41tVDab-j1dGqOwiaRj_wDSDJYcsIU,2256
@@ -1148,6 +1152,6 @@ lusid/models/workspace_update_request.py,sha256=uUXEpX-dJ5UiL9w1wMxIFeovSBiTJ-vi
 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.395.dist-info/METADATA,sha256=kycZfxEIHLmjWr7HD98gXn_1-UoxalKEeL2uxCPfniQ,195999
-lusid_sdk-2.1.395.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lusid_sdk-2.1.395.dist-info/RECORD,,
+lusid_sdk-2.1.400.dist-info/METADATA,sha256=yywPJ627svpQqUhPbdUZ2frzzBzXPbR_YtcbK9QXba0,196607
+lusid_sdk-2.1.400.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lusid_sdk-2.1.400.dist-info/RECORD,,