lusid-sdk 2.1.876__py3-none-any.whl → 2.1.877__py3-none-any.whl

lusid/__init__.py

@@ -181,6 +181,7 @@ from lusid.models.barrier import Barrier
 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_amend_custom_data_model_membership_response import BatchAmendCustomDataModelMembershipResponse
 from lusid.models.batch_update_user_review_for_comparison_result_request import BatchUpdateUserReviewForComparisonResultRequest
 from lusid.models.batch_update_user_review_for_comparison_result_response import BatchUpdateUserReviewForComparisonResultResponse
 from lusid.models.batch_upsert_dates_for_calendar_response import BatchUpsertDatesForCalendarResponse
@@ -728,6 +729,8 @@ from lusid.models.mbs_interest_shortfall_event import MbsInterestShortfallEvent
 from lusid.models.mbs_principal_event import MbsPrincipalEvent
 from lusid.models.mbs_principal_write_off_event import MbsPrincipalWriteOffEvent
 from lusid.models.membership import Membership
+from lusid.models.membership_amendment_request import MembershipAmendmentRequest
+from lusid.models.membership_amendment_response import MembershipAmendmentResponse
 from lusid.models.membership_and_status import MembershipAndStatus
 from lusid.models.merger_event import MergerEvent
 from lusid.models.metric_value import MetricValue
@@ -1531,6 +1534,7 @@ __all__ = [
     "Basket",
     "BasketIdentifier",
     "BatchAdjustHoldingsResponse",
+    "BatchAmendCustomDataModelMembershipResponse",
     "BatchUpdateUserReviewForComparisonResultRequest",
     "BatchUpdateUserReviewForComparisonResultResponse",
     "BatchUpsertDatesForCalendarResponse",
@@ -2078,6 +2082,8 @@ __all__ = [
     "MbsPrincipalEvent",
     "MbsPrincipalWriteOffEvent",
     "Membership",
+    "MembershipAmendmentRequest",
+    "MembershipAmendmentResponse",
     "MembershipAndStatus",
     "MergerEvent",
     "MetricValue",

lusid/api/custom_data_models_api.py

@@ -24,11 +24,13 @@ from datetime import datetime
 
 from pydantic.v1 import Field, constr, validator
 
-from typing import Optional
+from typing import Dict, Optional
 
+from lusid.models.batch_amend_custom_data_model_membership_response import BatchAmendCustomDataModelMembershipResponse
 from lusid.models.create_custom_data_model_request import CreateCustomDataModelRequest
 from lusid.models.custom_data_model import CustomDataModel
 from lusid.models.deleted_entity_response import DeletedEntityResponse
+from lusid.models.membership_amendment_request import MembershipAmendmentRequest
 from lusid.models.resource_list_of_data_model_summary import ResourceListOfDataModelSummary
 from lusid.models.resource_list_of_string import ResourceListOfString
 from lusid.models.update_custom_data_model_request import UpdateCustomDataModelRequest
@@ -59,6 +61,173 @@ class CustomDataModelsApi:
         self.api_client = api_client
 
 
+    @overload
+    async def batch_amend(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], **kwargs) -> BatchAmendCustomDataModelMembershipResponse:  # noqa: E501
+        ...
+
+    @overload
+    def batch_amend(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], async_req: Optional[bool]=True, **kwargs) -> BatchAmendCustomDataModelMembershipResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def batch_amend(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], async_req: Optional[bool]=None, **kwargs) -> Union[BatchAmendCustomDataModelMembershipResponse, Awaitable[BatchAmendCustomDataModelMembershipResponse]]:  # noqa: E501
+        """[INTERNAL] BatchAmend: Batch amend Custom Data Models  # noqa: E501
+
+        Add/Remove entities to/from a Custom Data Model in a single operation.                Each amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.  It serves only as a way to easily identify each amendment in the response.                Note: If using partial failure modes, then it is important to check the response body for failures as any  failures will still return a 200 status code.  # 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_amend(success_mode, request_body, async_req=True)
+        >>> result = thread.get()
+
+        :param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
+        :type success_mode: str
+        :param request_body: The payload describing the amendments to make for the given Custom Data Model. (required)
+        :type request_body: Dict[str, MembershipAmendmentRequest]
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: BatchAmendCustomDataModelMembershipResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the batch_amend_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_amend_with_http_info(success_mode, request_body, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def batch_amend_with_http_info(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], **kwargs) -> ApiResponse:  # noqa: E501
+        """[INTERNAL] BatchAmend: Batch amend Custom Data Models  # noqa: E501
+
+        Add/Remove entities to/from a Custom Data Model in a single operation.                Each amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.  It serves only as a way to easily identify each amendment in the response.                Note: If using partial failure modes, then it is important to check the response body for failures as any  failures will still return a 200 status code.  # 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_amend_with_http_info(success_mode, request_body, async_req=True)
+        >>> result = thread.get()
+
+        :param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
+        :type success_mode: str
+        :param request_body: The payload describing the amendments to make for the given Custom Data Model. (required)
+        :type request_body: Dict[str, MembershipAmendmentRequest]
+        :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. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :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(BatchAmendCustomDataModelMembershipResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'success_mode',
+            'request_body'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers',
+                'opts'
+            ]
+        )
+
+        # 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_amend" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('success_mode') is not None:  # noqa: E501
+            _query_params.append(('successMode', _params['success_mode']))
+
+        # 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['request_body'] is not None:
+            _body_params = _params['request_body']
+
+        # 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': "BatchAmendCustomDataModelMembershipResponse",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/datamodel/$batchamend', 'POST',
+            _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'),
+            opts=_params.get('opts'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
+
     @overload
     async def create_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], create_custom_data_model_request : Annotated[Optional[CreateCustomDataModelRequest], Field(description="The request containing the details of the Data Model.")] = None, **kwargs) -> CustomDataModel:  # noqa: E501
         ...

lusid/configuration.py

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

lusid/models/__init__.py

@@ -91,6 +91,7 @@ from lusid.models.barrier import Barrier
 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_amend_custom_data_model_membership_response import BatchAmendCustomDataModelMembershipResponse
 from lusid.models.batch_update_user_review_for_comparison_result_request import BatchUpdateUserReviewForComparisonResultRequest
 from lusid.models.batch_update_user_review_for_comparison_result_response import BatchUpdateUserReviewForComparisonResultResponse
 from lusid.models.batch_upsert_dates_for_calendar_response import BatchUpsertDatesForCalendarResponse
@@ -638,6 +639,8 @@ from lusid.models.mbs_interest_shortfall_event import MbsInterestShortfallEvent
 from lusid.models.mbs_principal_event import MbsPrincipalEvent
 from lusid.models.mbs_principal_write_off_event import MbsPrincipalWriteOffEvent
 from lusid.models.membership import Membership
+from lusid.models.membership_amendment_request import MembershipAmendmentRequest
+from lusid.models.membership_amendment_response import MembershipAmendmentResponse
 from lusid.models.membership_and_status import MembershipAndStatus
 from lusid.models.merger_event import MergerEvent
 from lusid.models.metric_value import MetricValue
@@ -1352,6 +1355,7 @@ __all__ = [
     "Basket",
     "BasketIdentifier",
     "BatchAdjustHoldingsResponse",
+    "BatchAmendCustomDataModelMembershipResponse",
     "BatchUpdateUserReviewForComparisonResultRequest",
     "BatchUpdateUserReviewForComparisonResultResponse",
     "BatchUpsertDatesForCalendarResponse",
@@ -1899,6 +1903,8 @@ __all__ = [
     "MbsPrincipalEvent",
     "MbsPrincipalWriteOffEvent",
     "Membership",
+    "MembershipAmendmentRequest",
+    "MembershipAmendmentResponse",
     "MembershipAndStatus",
     "MergerEvent",
     "MetricValue",

lusid/models/batch_amend_custom_data_model_membership_response.py

@@ -0,0 +1,158 @@
+# 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, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, conlist 
+from lusid.models.error_detail import ErrorDetail
+from lusid.models.membership_amendment_response import MembershipAmendmentResponse
+from lusid.models.response_meta_data import ResponseMetaData
+
+class BatchAmendCustomDataModelMembershipResponse(BaseModel):
+    """
+    BatchAmendCustomDataModelMembershipResponse
+    """
+    values: Optional[Dict[str, MembershipAmendmentResponse]] = None
+    staged: Optional[Dict[str, MembershipAmendmentResponse]] = None
+    failed: Optional[Dict[str, ErrorDetail]] = None
+    metadata: Optional[Dict[str, conlist(ResponseMetaData)]] = None
+    __properties = ["values", "staged", "failed", "metadata"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    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) -> BatchAmendCustomDataModelMembershipResponse:
+        """Create an instance of BatchAmendCustomDataModelMembershipResponse 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 values (dict)
+        _field_dict = {}
+        if self.values:
+            for _key in self.values:
+                if self.values[_key]:
+                    _field_dict[_key] = self.values[_key].to_dict()
+            _dict['values'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in staged (dict)
+        _field_dict = {}
+        if self.staged:
+            for _key in self.staged:
+                if self.staged[_key]:
+                    _field_dict[_key] = self.staged[_key].to_dict()
+            _dict['staged'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in failed (dict)
+        _field_dict = {}
+        if self.failed:
+            for _key in self.failed:
+                if self.failed[_key]:
+                    _field_dict[_key] = self.failed[_key].to_dict()
+            _dict['failed'] = _field_dict
+        # 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
+        # set to None if values (nullable) is None
+        # and __fields_set__ contains the field
+        if self.values is None and "values" in self.__fields_set__:
+            _dict['values'] = None
+
+        # set to None if staged (nullable) is None
+        # and __fields_set__ contains the field
+        if self.staged is None and "staged" in self.__fields_set__:
+            _dict['staged'] = None
+
+        # set to None if failed (nullable) is None
+        # and __fields_set__ contains the field
+        if self.failed is None and "failed" in self.__fields_set__:
+            _dict['failed'] = None
+
+        # set to None if metadata (nullable) is None
+        # and __fields_set__ contains the field
+        if self.metadata is None and "metadata" in self.__fields_set__:
+            _dict['metadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BatchAmendCustomDataModelMembershipResponse:
+        """Create an instance of BatchAmendCustomDataModelMembershipResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BatchAmendCustomDataModelMembershipResponse.parse_obj(obj)
+
+        _obj = BatchAmendCustomDataModelMembershipResponse.parse_obj({
+            "values": dict(
+                (_k, MembershipAmendmentResponse.from_dict(_v))
+                for _k, _v in obj.get("values").items()
+            )
+            if obj.get("values") is not None
+            else None,
+            "staged": dict(
+                (_k, MembershipAmendmentResponse.from_dict(_v))
+                for _k, _v in obj.get("staged").items()
+            )
+            if obj.get("staged") is not None
+            else None,
+            "failed": dict(
+                (_k, ErrorDetail.from_dict(_v))
+                for _k, _v in obj.get("failed").items()
+            )
+            if obj.get("failed") is not None
+            else None,
+            "metadata": dict(
+                (_k,
+                        [ResponseMetaData.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/membership_amendment_request.py

@@ -0,0 +1,87 @@
+# 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 StrictStr, Field, BaseModel, Field, constr, validator 
+from lusid.models.resource_id import ResourceId
+
+class MembershipAmendmentRequest(BaseModel):
+    """
+    MembershipAmendmentRequest
+    """
+    custom_data_model_id: ResourceId = Field(..., alias="customDataModelId")
+    entity_type:  StrictStr = Field(...,alias="entityType", description="The type of the entity that is being added or removed from the Custom Data Model.") 
+    entity_unique_id:  StrictStr = Field(...,alias="entityUniqueId", description="The entity unique identifier of the entity that is being added or removed from the Custom Data Model.") 
+    operation:  StrictStr = Field(...,alias="operation", description="The operation to be performed on the entity's membership in the Custom Data Model. Either 'Add' or 'Remove'.") 
+    __properties = ["customDataModelId", "entityType", "entityUniqueId", "operation"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    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) -> MembershipAmendmentRequest:
+        """Create an instance of MembershipAmendmentRequest 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 custom_data_model_id
+        if self.custom_data_model_id:
+            _dict['customDataModelId'] = self.custom_data_model_id.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MembershipAmendmentRequest:
+        """Create an instance of MembershipAmendmentRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MembershipAmendmentRequest.parse_obj(obj)
+
+        _obj = MembershipAmendmentRequest.parse_obj({
+            "custom_data_model_id": ResourceId.from_dict(obj.get("customDataModelId")) if obj.get("customDataModelId") is not None else None,
+            "entity_type": obj.get("entityType"),
+            "entity_unique_id": obj.get("entityUniqueId"),
+            "operation": obj.get("operation")
+        })
+        return _obj

lusid/models/membership_amendment_response.py

@@ -0,0 +1,107 @@
+# 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, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, constr 
+from lusid.models.data_model_membership import DataModelMembership
+from lusid.models.resource_id import ResourceId
+from lusid.models.staged_modifications_info import StagedModificationsInfo
+from lusid.models.version import Version
+
+class MembershipAmendmentResponse(BaseModel):
+    """
+    MembershipAmendmentResponse
+    """
+    custom_data_model_id: ResourceId = Field(..., alias="customDataModelId")
+    entity_type:  StrictStr = Field(...,alias="entityType", description="The type of the entity that was added or removed from the Custom Data Model.") 
+    entity_unique_id:  StrictStr = Field(...,alias="entityUniqueId", description="The entity unique identifier of the entity that was added or removed from the Custom Data Model.") 
+    operation:  StrictStr = Field(...,alias="operation", description="The operation that was performed on the entity's membership in the Custom Data Model. Either 'Add' or 'Remove'.") 
+    entity_display_name:  StrictStr = Field(...,alias="entityDisplayName", description="The display name of the entity that was added or removed from the Custom Data Model.") 
+    data_model_membership: Optional[DataModelMembership] = Field(None, alias="dataModelMembership")
+    version: Optional[Version] = None
+    staged_modifications: Optional[StagedModificationsInfo] = Field(None, alias="stagedModifications")
+    __properties = ["customDataModelId", "entityType", "entityUniqueId", "operation", "entityDisplayName", "dataModelMembership", "version", "stagedModifications"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    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) -> MembershipAmendmentResponse:
+        """Create an instance of MembershipAmendmentResponse 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 custom_data_model_id
+        if self.custom_data_model_id:
+            _dict['customDataModelId'] = self.custom_data_model_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of data_model_membership
+        if self.data_model_membership:
+            _dict['dataModelMembership'] = self.data_model_membership.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of staged_modifications
+        if self.staged_modifications:
+            _dict['stagedModifications'] = self.staged_modifications.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MembershipAmendmentResponse:
+        """Create an instance of MembershipAmendmentResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MembershipAmendmentResponse.parse_obj(obj)
+
+        _obj = MembershipAmendmentResponse.parse_obj({
+            "custom_data_model_id": ResourceId.from_dict(obj.get("customDataModelId")) if obj.get("customDataModelId") is not None else None,
+            "entity_type": obj.get("entityType"),
+            "entity_unique_id": obj.get("entityUniqueId"),
+            "operation": obj.get("operation"),
+            "entity_display_name": obj.get("entityDisplayName"),
+            "data_model_membership": DataModelMembership.from_dict(obj.get("dataModelMembership")) if obj.get("dataModelMembership") is not None else None,
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
+            "staged_modifications": StagedModificationsInfo.from_dict(obj.get("stagedModifications")) if obj.get("stagedModifications") is not None else None
+        })
+        return _obj

{lusid_sdk-2.1.876.dist-info → lusid_sdk-2.1.877.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.876
+Version: 2.1.877
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -205,6 +205,7 @@ Class | Method | HTTP request | Description
 *CustomEntityDefinitionsApi* | [**get_definition**](docs/CustomEntityDefinitionsApi.md#get_definition) | **GET** /api/customentities/entitytypes/{entityType} | [EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.
 *CustomEntityDefinitionsApi* | [**list_custom_entity_definitions**](docs/CustomEntityDefinitionsApi.md#list_custom_entity_definitions) | **GET** /api/customentities/entitytypes | [EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions
 *CustomEntityDefinitionsApi* | [**update_custom_entity_definition**](docs/CustomEntityDefinitionsApi.md#update_custom_entity_definition) | **PUT** /api/customentities/entitytypes/{entityType} | [EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.
+*CustomDataModelsApi* | [**batch_amend**](docs/CustomDataModelsApi.md#batch_amend) | **POST** /api/datamodel/$batchamend | [INTERNAL] BatchAmend: Batch amend Custom Data Models
 *CustomDataModelsApi* | [**create_custom_data_model**](docs/CustomDataModelsApi.md#create_custom_data_model) | **POST** /api/datamodel/{entityType} | [EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model
 *CustomDataModelsApi* | [**delete_custom_data_model**](docs/CustomDataModelsApi.md#delete_custom_data_model) | **DELETE** /api/datamodel/{entityType}/{scope}/{code} | [EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model
 *CustomDataModelsApi* | [**get_custom_data_model**](docs/CustomDataModelsApi.md#get_custom_data_model) | **GET** /api/datamodel/{entityType}/{scope}/{code} | [EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model
@@ -751,6 +752,7 @@ Class | Method | HTTP request | Description
  - [Basket](docs/Basket.md)
  - [BasketIdentifier](docs/BasketIdentifier.md)
  - [BatchAdjustHoldingsResponse](docs/BatchAdjustHoldingsResponse.md)
+ - [BatchAmendCustomDataModelMembershipResponse](docs/BatchAmendCustomDataModelMembershipResponse.md)
  - [BatchUpdateUserReviewForComparisonResultRequest](docs/BatchUpdateUserReviewForComparisonResultRequest.md)
  - [BatchUpdateUserReviewForComparisonResultResponse](docs/BatchUpdateUserReviewForComparisonResultResponse.md)
  - [BatchUpsertDatesForCalendarResponse](docs/BatchUpsertDatesForCalendarResponse.md)
@@ -1298,6 +1300,8 @@ Class | Method | HTTP request | Description
  - [MbsPrincipalEvent](docs/MbsPrincipalEvent.md)
  - [MbsPrincipalWriteOffEvent](docs/MbsPrincipalWriteOffEvent.md)
  - [Membership](docs/Membership.md)
+ - [MembershipAmendmentRequest](docs/MembershipAmendmentRequest.md)
+ - [MembershipAmendmentResponse](docs/MembershipAmendmentResponse.md)
  - [MembershipAndStatus](docs/MembershipAndStatus.md)
  - [MergerEvent](docs/MergerEvent.md)
  - [MetricValue](docs/MetricValue.md)

{lusid_sdk-2.1.876.dist-info → lusid_sdk-2.1.877.dist-info}/RECORD

@@ -1,4 +1,4 @@
-lusid/__init__.py,sha256=d7pDUWDUHPyhcCQZC-piubiHm6nLz58IOUS4LNKbpXg,142406
+lusid/__init__.py,sha256=8LaCFupUXYWDQbhsYqdb9Ha5qEr-UX5hMrN4F37GHV0,142809
 lusid/api/__init__.py,sha256=B3B2NQMECuvDVNmD4qSFLd79vdoCFcwMeA91EfgIvDg,6693
 lusid/api/abor_api.py,sha256=N7Wsh0395mXOvpJI8z0Nrx5OY4nCP5FN9RkbtdHaZbM,165987
 lusid/api/abor_configuration_api.py,sha256=xQ9HcXm02eDFhCdWUHjqFRWl1oQMxm2LNObJ9kcLauU,84216
@@ -17,7 +17,7 @@ lusid/api/configuration_recipe_api.py,sha256=1hdNB1imRjVzf8KAmqnNJE10jv883s1SCza
 lusid/api/conventions_api.py,sha256=dsvB_lAcR5oVQLTqVJj9_zruF7Tyn8aGzD9EmEKvfWY,104288
 lusid/api/corporate_action_sources_api.py,sha256=7Js9dAFi_HOsYjZvYQew8SjK8x45x-Bi3VJxY-dhDKU,98350
 lusid/api/counterparties_api.py,sha256=dvRW05miC9_DBYAvJavmNucbNY4ZDwFjqLNXSoP-05A,71156
-lusid/api/custom_data_models_api.py,sha256=PaxGnE0UGabjXfg6pp1LQp580mY4SPfLSg-STDGBFvk,53848
+lusid/api/custom_data_models_api.py,sha256=SfUCIuYz1891A3EA1QM6m31OPNHwvgsP2DLscneobuQ,63897
 lusid/api/custom_entities_api.py,sha256=2R9I0th-pYAK69R3UdWntfd8EhYTYf0e1vbB8JvZ5OU,158464
 lusid/api/custom_entity_definitions_api.py,sha256=Hcuv2Au9oMpg1E5aMyveiq3dxcwldvZrvRzVdI-T_mo,40202
 lusid/api/custom_entity_types_api.py,sha256=Ldk2f5BDjzmnFUDR-Rw71tCpNoEnNeHZ5bptJUrV1EQ,40856
@@ -79,7 +79,7 @@ lusid/api/translation_api.py,sha256=xpRuTfwQvYBlWe6r_L2EI_uVpXqHFnEOim-i-kVQ85E,
 lusid/api/workspace_api.py,sha256=0pCNi3ZCRbIo0NXKa85XE7vtq0WV5YOKcQKvFlcLUaY,120708
 lusid/api_client.py,sha256=ewMTmf9SRurY8pYnUx9jy24RdldPCOa4US38pnrVxjA,31140
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=7CD6MYlUkKWkxp28C96FvQNpJu5sIIFiKHyvRxITkBw,17972
+lusid/configuration.py,sha256=ktG9lXMq6MPStlkaG3_l_HZskF-MiTTBcOdeqhfHwXU,17972
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=dzDHEzpn-9smd2-_UMWQzeyX6Ha4jGf6fnqx7qxKxNI,630
 lusid/extensions/api_client.py,sha256=GzygWg_h603QK1QS2HvAijuE2R1TnvoF6-Yg0CeM3ug,30943
@@ -94,7 +94,7 @@ lusid/extensions/rest.py,sha256=dp-bD_LMR2zAL1tmC3-urhWKLomXx7r5iGN1VteMBVQ,1601
 lusid/extensions/retry.py,sha256=EhW9OKJmGHipxN3H7eROH5DiMlAnfBVl95NQrttcsdg,14834
 lusid/extensions/socket_keep_alive.py,sha256=eX5ICvGfVzUCGIm80Q2RknfFZrBQAdnrcpY61M29V_k,1997
 lusid/extensions/tcp_keep_alive_connector.py,sha256=zaGtUsygRsxB1_4B3x39K3ILwztdhMLDv5bFZV7zmGE,3877
-lusid/models/__init__.py,sha256=XpKA2zcsJkqAuGWOFnXaTNT-sI-vkc98t-zU9bRf0K0,134681
+lusid/models/__init__.py,sha256=Sqi7-u6NBvgs1phQQJoC-3Fwg8lOq9iGHUGmrACYCrA,135084
 lusid/models/a2_b_breakdown.py,sha256=-FXgILrvtZXQDmvS0ARaJVGBq5LJ4AH-o3HjujFVmS4,3198
 lusid/models/a2_b_category.py,sha256=WunXUgx-dCnApPeLC8Qo5tVCX8Ywxkehib1vmNqNgNs,2957
 lusid/models/a2_b_data_record.py,sha256=qANTmV1_HUEo4l72-F8qzZjlQxOe0Onc9WPz7h-WWuY,9993
@@ -172,6 +172,7 @@ lusid/models/barrier.py,sha256=jzmNSt5xSeH7rYNvGf9JYP6fZJ8BE36e_IdkiS8vlH8,2985
 lusid/models/basket.py,sha256=DOl0vUP-uz_AsGHmdECAP-QCsUHBpLOwOwPG49Ci6xk,9390
 lusid/models/basket_identifier.py,sha256=GFqLW1rar1XqztWuCRPTYN8jQZxzWivYaOuwVHFS_tc,2842
 lusid/models/batch_adjust_holdings_response.py,sha256=U2wKOF3kdsYHVUmOcJq57uTM_o9uNN2mLUI8-zk3hGI,5919
+lusid/models/batch_amend_custom_data_model_membership_response.py,sha256=QcQZoL3Xncdr5-gXuvn5nuA74c6vFupbDD7-J-k5SUY,5954
 lusid/models/batch_update_user_review_for_comparison_result_request.py,sha256=XPPUsMkfk0ICuhpZEcs7jW0UzvSOMXRw5-r4jolr9cs,3714
 lusid/models/batch_update_user_review_for_comparison_result_response.py,sha256=BvU5oDWUVYNUAnpbkqInKbCyWv-f5-hVtDhq-ngTNPg,6224
 lusid/models/batch_upsert_dates_for_calendar_response.py,sha256=Xh2kcxFQHHhHhjaoVN1gdn5Aa4yI6r46z1JgpM1WJ64,5924
@@ -719,6 +720,8 @@ lusid/models/mbs_interest_shortfall_event.py,sha256=I5hR5owH8mpP3L0SfqYh4i16esq3
 lusid/models/mbs_principal_event.py,sha256=DU-WVIu_bbCRv5iqv612I9631S0dT6JwOsjQGpxoL70,12008
 lusid/models/mbs_principal_write_off_event.py,sha256=Xp0KRudBaJ1lx6-sc9BMb7dGNIxMt4Su0xUa9PsAoFs,12126
 lusid/models/membership.py,sha256=tCmIwzi46QxUF-Ad8llWpqdLQnyjG2xc1p_4Rslduvk,2473
+lusid/models/membership_amendment_request.py,sha256=ZY10yCsX-hnm-9reMpA1WElCaCmlmBGDJRpFe0Wxpxc,3294
+lusid/models/membership_amendment_response.py,sha256=Z8bQBB-e-2pag9QXenMo-EB59aE9LOVI2CbUv3BjJ7I,5058
 lusid/models/membership_and_status.py,sha256=Ge5mHyXZfdaQ7oCkRCDcdQm5SPjqD2bG1XDn_g-i88M,2735
 lusid/models/merger_event.py,sha256=WA_hKYIObgLAJrV49Lwgbv6fgNta0OR0NvazmDOlT0I,17191
 lusid/models/metric_value.py,sha256=VOO9uPCoJ0NeBxUnEuzvi5XfjootT0LfmKmxRTDft20,2441
@@ -1355,6 +1358,6 @@ lusid/models/year_month_day.py,sha256=gwSoxFwlD_wffKdddo1wfvAcLq3Cht3FHQidiaHzAA
 lusid/models/yield_curve_data.py,sha256=I1ZSWxHMgUxj9OQt6i9a4S91KB4_XtmrfFxpN_PV3YQ,9561
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=HQT__5LQEMu6_1sLKvYj-DI4FH1DJXBIPYfZCTTyrY4,13431
-lusid_sdk-2.1.876.dist-info/METADATA,sha256=z-uMr7d1YSy7x_g6MmZkqIyhANKbreIeKKmF2JJfoaU,226251
-lusid_sdk-2.1.876.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-lusid_sdk-2.1.876.dist-info/RECORD,,
+lusid_sdk-2.1.877.dist-info/METADATA,sha256=5sUzwjvHUI4H4tyD2qQjiGIEwArkWm2vOxdE9_uuWB4,226668
+lusid_sdk-2.1.877.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+lusid_sdk-2.1.877.dist-info/RECORD,,