lusid-sdk 2.1.347__py3-none-any.whl → 2.1.352__py3-none-any.whl

lusid/models/workspace_item.py

@@ -0,0 +1,105 @@
+# 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 BaseModel, Field, StrictInt, conlist, constr, validator
+from lusid.models.link import Link
+from lusid.models.version import Version
+
+class WorkspaceItem(BaseModel):
+    """
+    An item stored in a workspace.  # noqa: E501
+    """
+    type: constr(strict=True, min_length=1) = Field(..., description="The type of the workspace item.")
+    format: StrictInt = Field(..., description="A simple integer format identifier.")
+    name: constr(strict=True, min_length=1) = Field(..., description="A workspace item's name; a unique identifier.")
+    description: constr(strict=True, max_length=1024, min_length=0) = Field(..., description="The description of a workspace item.")
+    content: constr(strict=True, max_length=6000, min_length=0) = Field(..., description="The content associated with a workspace item.")
+    version: Optional[Version] = None
+    links: Optional[conlist(Link)] = None
+    __properties = ["type", "format", "name", "description", "content", "version", "links"]
+
+    @validator('description')
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    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) -> WorkspaceItem:
+        """Create an instance of WorkspaceItem 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 version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> WorkspaceItem:
+        """Create an instance of WorkspaceItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return WorkspaceItem.parse_obj(obj)
+
+        _obj = WorkspaceItem.parse_obj({
+            "type": obj.get("type"),
+            "format": obj.get("format"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "content": obj.get("content"),
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj

lusid/models/workspace_item_creation_request.py

@@ -0,0 +1,91 @@
+# 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, StrictInt, constr, validator
+
+class WorkspaceItemCreationRequest(BaseModel):
+    """
+    A request to create an item in a workspace.  # noqa: E501
+    """
+    format: StrictInt = Field(..., description="A simple integer format identifier.")
+    name: constr(strict=True, max_length=64, min_length=1) = Field(..., description="A workspace item's name; a unique identifier.")
+    description: constr(strict=True, max_length=1024, min_length=0) = Field(..., description="The description of a workspace item.")
+    content: constr(strict=True, max_length=6000, min_length=0) = Field(..., description="The content associated with a workspace item.")
+    type: constr(strict=True, max_length=6000, min_length=0) = Field(..., description="The type of the workspace item.")
+    __properties = ["format", "name", "description", "content", "type"]
+
+    @validator('name')
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('description')
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    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) -> WorkspaceItemCreationRequest:
+        """Create an instance of WorkspaceItemCreationRequest 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> WorkspaceItemCreationRequest:
+        """Create an instance of WorkspaceItemCreationRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return WorkspaceItemCreationRequest.parse_obj(obj)
+
+        _obj = WorkspaceItemCreationRequest.parse_obj({
+            "format": obj.get("format"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "content": obj.get("content"),
+            "type": obj.get("type")
+        })
+        return _obj

lusid/models/workspace_item_update_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, StrictInt, constr, validator
+
+class WorkspaceItemUpdateRequest(BaseModel):
+    """
+    A request to update a workspace item.  # noqa: E501
+    """
+    format: StrictInt = Field(..., description="A simple integer format identifier.")
+    description: constr(strict=True, max_length=1024, min_length=0) = Field(..., description="The description of a workspace item.")
+    content: constr(strict=True, max_length=6000, min_length=0) = Field(..., description="The content associated with a workspace item.")
+    type: constr(strict=True, max_length=6000, min_length=0) = Field(..., description="The type of the workspace item.")
+    __properties = ["format", "description", "content", "type"]
+
+    @validator('description')
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    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) -> WorkspaceItemUpdateRequest:
+        """Create an instance of WorkspaceItemUpdateRequest 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> WorkspaceItemUpdateRequest:
+        """Create an instance of WorkspaceItemUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return WorkspaceItemUpdateRequest.parse_obj(obj)
+
+        _obj = WorkspaceItemUpdateRequest.parse_obj({
+            "format": obj.get("format"),
+            "description": obj.get("description"),
+            "content": obj.get("content"),
+            "type": obj.get("type")
+        })
+        return _obj

lusid/models/workspace_update_request.py

@@ -0,0 +1,69 @@
+# 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, constr
+
+class WorkspaceUpdateRequest(BaseModel):
+    """
+    A request to update a workspace.  # noqa: E501
+    """
+    description: constr(strict=True, max_length=256, min_length=1) = Field(..., description="A friendly description for the workspace.")
+    __properties = ["description"]
+
+    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) -> WorkspaceUpdateRequest:
+        """Create an instance of WorkspaceUpdateRequest 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> WorkspaceUpdateRequest:
+        """Create an instance of WorkspaceUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return WorkspaceUpdateRequest.parse_obj(obj)
+
+        _obj = WorkspaceUpdateRequest.parse_obj({
+            "description": obj.get("description")
+        })
+        return _obj

{lusid_sdk-2.1.347.dist-info → lusid_sdk-2.1.352.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.347
+Version: 2.1.352
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -200,6 +200,7 @@ Class | Method | HTTP request | Description
 *CutLabelDefinitionsApi* | [**list_cut_label_definitions**](docs/CutLabelDefinitionsApi.md#list_cut_label_definitions) | **GET** /api/systemconfiguration/cutlabels | ListCutLabelDefinitions: List Existing Cut Labels
 *CutLabelDefinitionsApi* | [**update_cut_label_definition**](docs/CutLabelDefinitionsApi.md#update_cut_label_definition) | **PUT** /api/systemconfiguration/cutlabels/{code} | UpdateCutLabelDefinition: Update a Cut Label
 *DataTypesApi* | [**create_data_type**](docs/DataTypesApi.md#create_data_type) | **POST** /api/datatypes | [EARLY ACCESS] CreateDataType: Create data type definition
+*DataTypesApi* | [**delete_data_type**](docs/DataTypesApi.md#delete_data_type) | **DELETE** /api/datatypes/{scope}/{code} | DeleteDataType: Delete a data type definition.
 *DataTypesApi* | [**get_data_type**](docs/DataTypesApi.md#get_data_type) | **GET** /api/datatypes/{scope}/{code} | GetDataType: Get data type definition
 *DataTypesApi* | [**get_units_from_data_type**](docs/DataTypesApi.md#get_units_from_data_type) | **GET** /api/datatypes/{scope}/{code}/units | [EARLY ACCESS] GetUnitsFromDataType: Get units from data type
 *DataTypesApi* | [**list_data_type_summaries**](docs/DataTypesApi.md#list_data_type_summaries) | **GET** /api/datatypes | [EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data
@@ -572,6 +573,26 @@ Class | Method | HTTP request | Description
 *TransactionPortfoliosApi* | [**upsert_transactions**](docs/TransactionPortfoliosApi.md#upsert_transactions) | **POST** /api/transactionportfolios/{scope}/{code}/transactions | UpsertTransactions: Upsert transactions
 *TranslationApi* | [**translate_instrument_definitions**](docs/TranslationApi.md#translate_instrument_definitions) | **POST** /api/translation/instrumentdefinitions | [EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments
 *TranslationApi* | [**translate_trade_tickets**](docs/TranslationApi.md#translate_trade_tickets) | **POST** /api/translation/tradetickets | [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
+*WorkspaceApi* | [**create_personal_item**](docs/WorkspaceApi.md#create_personal_item) | **POST** /api/workspaces/personal/{workspaceName}/items | [EARLY ACCESS] CreatePersonalItem: Create a new item in a personal workspace.
+*WorkspaceApi* | [**create_personal_workspace**](docs/WorkspaceApi.md#create_personal_workspace) | **POST** /api/workspaces/personal | [EARLY ACCESS] CreatePersonalWorkspace: Create a new personal workspace.
+*WorkspaceApi* | [**create_shared_item**](docs/WorkspaceApi.md#create_shared_item) | **POST** /api/workspaces/shared/{workspaceName}/items | [EARLY ACCESS] CreateSharedItem: Create a new item in a shared workspace.
+*WorkspaceApi* | [**create_shared_workspace**](docs/WorkspaceApi.md#create_shared_workspace) | **POST** /api/workspaces/shared | [EARLY ACCESS] CreateSharedWorkspace: Create a new shared workspace.
+*WorkspaceApi* | [**delete_personal_item**](docs/WorkspaceApi.md#delete_personal_item) | **DELETE** /api/workspaces/personal/{workspaceName}/items/{itemName} | [EARLY ACCESS] DeletePersonalItem: Delete an item from a personal workspace.
+*WorkspaceApi* | [**delete_personal_workspace**](docs/WorkspaceApi.md#delete_personal_workspace) | **DELETE** /api/workspaces/personal/{workspaceName} | [EARLY ACCESS] DeletePersonalWorkspace: Delete a personal workspace.
+*WorkspaceApi* | [**delete_shared_item**](docs/WorkspaceApi.md#delete_shared_item) | **DELETE** /api/workspaces/shared/{workspaceName}/items/{itemName} | [EARLY ACCESS] DeleteSharedItem: Delete an item from a shared workspace.
+*WorkspaceApi* | [**delete_shared_workspace**](docs/WorkspaceApi.md#delete_shared_workspace) | **DELETE** /api/workspaces/shared/{workspaceName} | [EARLY ACCESS] DeleteSharedWorkspace: Delete a shared workspace.
+*WorkspaceApi* | [**get_personal_item**](docs/WorkspaceApi.md#get_personal_item) | **GET** /api/workspaces/personal/{workspaceName}/items/{itemName} | [EARLY ACCESS] GetPersonalItem: Get a single personal workspace item.
+*WorkspaceApi* | [**get_personal_workspace**](docs/WorkspaceApi.md#get_personal_workspace) | **GET** /api/workspaces/personal/{workspaceName} | [EARLY ACCESS] GetPersonalWorkspace: Get a personal workspace.
+*WorkspaceApi* | [**get_shared_item**](docs/WorkspaceApi.md#get_shared_item) | **GET** /api/workspaces/shared/{workspaceName}/items/{itemName} | [EARLY ACCESS] GetSharedItem: Get a single shared workspace item.
+*WorkspaceApi* | [**get_shared_workspace**](docs/WorkspaceApi.md#get_shared_workspace) | **GET** /api/workspaces/shared/{workspaceName} | [EARLY ACCESS] GetSharedWorkspace: Get a shared workspace.
+*WorkspaceApi* | [**list_personal_items**](docs/WorkspaceApi.md#list_personal_items) | **GET** /api/workspaces/personal/{workspaceName}/items | [EARLY ACCESS] ListPersonalItems: List the items in a personal workspace.
+*WorkspaceApi* | [**list_personal_workspaces**](docs/WorkspaceApi.md#list_personal_workspaces) | **GET** /api/workspaces/personal | [EARLY ACCESS] ListPersonalWorkspaces: List personal workspaces.
+*WorkspaceApi* | [**list_shared_items**](docs/WorkspaceApi.md#list_shared_items) | **GET** /api/workspaces/shared/{workspaceName}/items | [EARLY ACCESS] ListSharedItems: List the items in a shared workspace.
+*WorkspaceApi* | [**list_shared_workspaces**](docs/WorkspaceApi.md#list_shared_workspaces) | **GET** /api/workspaces/shared | [EARLY ACCESS] ListSharedWorkspaces: List shared workspaces.
+*WorkspaceApi* | [**update_personal_item**](docs/WorkspaceApi.md#update_personal_item) | **PUT** /api/workspaces/personal/{workspaceName}/items/{itemName} | [EARLY ACCESS] UpdatePersonalItem: Update an item in a personal workspace.
+*WorkspaceApi* | [**update_personal_workspace**](docs/WorkspaceApi.md#update_personal_workspace) | **PUT** /api/workspaces/personal/{workspaceName} | [EARLY ACCESS] UpdatePersonalWorkspace: Update a personal workspace.
+*WorkspaceApi* | [**update_shared_item**](docs/WorkspaceApi.md#update_shared_item) | **PUT** /api/workspaces/shared/{workspaceName}/items/{itemName} | [EARLY ACCESS] UpdateSharedItem: Update an item in a shared workspace.
+*WorkspaceApi* | [**update_shared_workspace**](docs/WorkspaceApi.md#update_shared_workspace) | **PUT** /api/workspaces/shared/{workspaceName} | [EARLY ACCESS] UpdateSharedWorkspace: Update a shared workspace.
 
 
 <a id="documentation-for-models"></a>
@@ -1182,6 +1203,8 @@ Class | Method | HTTP request | Description
  - [PagedResourceListOfTranslationScriptId](docs/PagedResourceListOfTranslationScriptId.md)
  - [PagedResourceListOfValuationPointOverview](docs/PagedResourceListOfValuationPointOverview.md)
  - [PagedResourceListOfVirtualRow](docs/PagedResourceListOfVirtualRow.md)
+ - [PagedResourceListOfWorkspace](docs/PagedResourceListOfWorkspace.md)
+ - [PagedResourceListOfWorkspaceItem](docs/PagedResourceListOfWorkspaceItem.md)
  - [Participation](docs/Participation.md)
  - [ParticipationRequest](docs/ParticipationRequest.md)
  - [ParticipationSetRequest](docs/ParticipationSetRequest.md)
@@ -1417,6 +1440,7 @@ Class | Method | HTTP request | Description
  - [ShareClassAmount](docs/ShareClassAmount.md)
  - [ShareClassBreakdown](docs/ShareClassBreakdown.md)
  - [ShareClassData](docs/ShareClassData.md)
+ - [ShareClassDealingBreakdown](docs/ShareClassDealingBreakdown.md)
  - [ShareClassDetails](docs/ShareClassDetails.md)
  - [ShareClassPnlBreakdown](docs/ShareClassPnlBreakdown.md)
  - [SideConfigurationData](docs/SideConfigurationData.md)
@@ -1451,6 +1475,7 @@ Class | Method | HTTP request | Description
  - [StructuredResultData](docs/StructuredResultData.md)
  - [StructuredResultDataId](docs/StructuredResultDataId.md)
  - [SubHoldingKeyValueEquals](docs/SubHoldingKeyValueEquals.md)
+ - [SwapCashFlowEvent](docs/SwapCashFlowEvent.md)
  - [TargetTaxLot](docs/TargetTaxLot.md)
  - [TargetTaxLotRequest](docs/TargetTaxLotRequest.md)
  - [TaxRule](docs/TaxRule.md)
@@ -1609,6 +1634,12 @@ Class | Method | HTTP request | Description
  - [WeightedInstrument](docs/WeightedInstrument.md)
  - [WeightedInstrumentInLineLookupIdentifiers](docs/WeightedInstrumentInLineLookupIdentifiers.md)
  - [WeightedInstruments](docs/WeightedInstruments.md)
+ - [Workspace](docs/Workspace.md)
+ - [WorkspaceCreationRequest](docs/WorkspaceCreationRequest.md)
+ - [WorkspaceItem](docs/WorkspaceItem.md)
+ - [WorkspaceItemCreationRequest](docs/WorkspaceItemCreationRequest.md)
+ - [WorkspaceItemUpdateRequest](docs/WorkspaceItemUpdateRequest.md)
+ - [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
  - [YieldCurveData](docs/YieldCurveData.md)