visier-platform-sdk 22222222.99200.21494__py3-none-any.whl → 22222222.99200.22144__py3-none-any.whl

visier_platform_sdk/models/metric_definition_dto.py

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99200.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,10 +18,12 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from visier_platform_sdk.models.basic_information_dto import BasicInformationDTO
 from visier_platform_sdk.models.metric_type_details_dto import MetricTypeDetailsDTO
+from visier_platform_sdk.models.tag_reference_list_dto import TagReferenceListDTO
+from visier_platform_sdk.models.version_information_dto import VersionInformationDTO
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -34,7 +36,12 @@ class MetricDefinitionDTO(BaseModel):
     basic_information: Optional[BasicInformationDTO] = Field(default=None, description="Fields that identify and describe the metric, such as its display name, description, and explanation.", alias="basicInformation")
     details: Optional[MetricTypeDetailsDTO] = Field(default=None, description="The metric type and its details.")
     additive_type: Optional[StrictStr] = Field(default=None, description="How to sum the metric's values. Valid values:  - `fullyAdditive`: Sums the metric over any dimension, concept, or time period.  - `balance`: Sums the metric over any dimension or concept, but not time period.  - `nonAdditive`: Metric values are not additive.", alias="additiveType")
-    __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details", "additiveType"]
+    visible_in_analytics: Optional[StrictBool] = Field(default=None, description="If `true`, the object is visible to end users in the solution. Default is `true`.", alias="visibleInAnalytics")
+    include_with_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the object is available in Vee's responses.", alias="includeWithVee")
+    analytic_object_name: Optional[StrictStr] = Field(default=None, description="The metric's analytic object name.", alias="analyticObjectName")
+    tag_list: Optional[TagReferenceListDTO] = Field(default=None, description="The tags assigned to the object.", alias="tagList")
+    version_information: Optional[VersionInformationDTO] = Field(default=None, description="The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.", alias="versionInformation")
+    __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details", "additiveType", "visibleInAnalytics", "includeWithVee", "analyticObjectName", "tagList", "versionInformation"]
 
     @field_validator('additive_type')
     def additive_type_validate_enum(cls, value):
@@ -91,6 +98,12 @@ class MetricDefinitionDTO(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of details
         if self.details:
             _dict['details'] = self.details.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of tag_list
+        if self.tag_list:
+            _dict['tagList'] = self.tag_list.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of version_information
+        if self.version_information:
+            _dict['versionInformation'] = self.version_information.to_dict()
         return _dict
 
     @classmethod
@@ -107,7 +120,12 @@ class MetricDefinitionDTO(BaseModel):
             "objectName": obj.get("objectName"),
             "basicInformation": BasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None,
             "details": MetricTypeDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None,
-            "additiveType": obj.get("additiveType")
+            "additiveType": obj.get("additiveType"),
+            "visibleInAnalytics": obj.get("visibleInAnalytics"),
+            "includeWithVee": obj.get("includeWithVee"),
+            "analyticObjectName": obj.get("analyticObjectName"),
+            "tagList": TagReferenceListDTO.from_dict(obj["tagList"]) if obj.get("tagList") is not None else None,
+            "versionInformation": VersionInformationDTO.from_dict(obj["versionInformation"]) if obj.get("versionInformation") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/{member_selection_list_dto.py → metric_delete_request_dto.py}

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99200.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -20,16 +20,16 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
-from visier_platform_sdk.models.member_selection_dto import MemberSelectionDTO
+from visier_platform_sdk.models.metric_delete_with_context_dto import MetricDeleteWithContextDTO
 from typing import Optional, Set
 from typing_extensions import Self
 
-class MemberSelectionListDTO(BaseModel):
+class MetricDeleteRequestDTO(BaseModel):
     """
-    The population members that the concept selects.
+    The metrics to delete.
     """ # noqa: E501
-    member_selections: Optional[List[MemberSelectionDTO]] = Field(default=None, description="The dimension members in a member selection concept.", alias="memberSelections")
-    __properties: ClassVar[List[str]] = ["memberSelections"]
+    metrics: Optional[List[MetricDeleteWithContextDTO]] = Field(default=None, description="The metrics in the request.")
+    __properties: ClassVar[List[str]] = ["metrics"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -49,7 +49,7 @@ class MemberSelectionListDTO(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of MemberSelectionListDTO from a JSON string"""
+        """Create an instance of MetricDeleteRequestDTO from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -70,18 +70,18 @@ class MemberSelectionListDTO(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in member_selections (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
         _items = []
-        if self.member_selections:
-            for _item_member_selections in self.member_selections:
-                if _item_member_selections:
-                    _items.append(_item_member_selections.to_dict())
-            _dict['memberSelections'] = _items
+        if self.metrics:
+            for _item_metrics in self.metrics:
+                if _item_metrics:
+                    _items.append(_item_metrics.to_dict())
+            _dict['metrics'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of MemberSelectionListDTO from a dict"""
+        """Create an instance of MetricDeleteRequestDTO from a dict"""
         if obj is None:
             return None
 
@@ -89,7 +89,7 @@ class MemberSelectionListDTO(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "memberSelections": [MemberSelectionDTO.from_dict(_item) for _item in obj["memberSelections"]] if obj.get("memberSelections") is not None else None
+            "metrics": [MetricDeleteWithContextDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/metric_delete_with_context_dto.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.execution_context_dto import ExecutionContextDTO
+from visier_platform_sdk.models.object_id_dto import ObjectIdDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricDeleteWithContextDTO(BaseModel):
+    """
+    Information about the metric to delete and the context of the API request, such as the tenant code and project ID.
+    """ # noqa: E501
+    execution_context: Optional[ExecutionContextDTO] = Field(default=None, description="The context of the API request, such as the tenant code and project ID.", alias="executionContext")
+    metric: Optional[ObjectIdDTO] = Field(default=None, description="Information identifying the metric to delete.")
+    __properties: ClassVar[List[str]] = ["executionContext", "metric"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricDeleteWithContextDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of execution_context
+        if self.execution_context:
+            _dict['executionContext'] = self.execution_context.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of metric
+        if self.metric:
+            _dict['metric'] = self.metric.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricDeleteWithContextDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "executionContext": ExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None,
+            "metric": ObjectIdDTO.from_dict(obj["metric"]) if obj.get("metric") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/metric_dto.py

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99200.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,36 +18,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from visier_platform_sdk.models.parameter_definition_dto import ParameterDefinitionDTO
+from visier_platform_sdk.models.time_handling_dto import TimeHandlingDTO
 from typing import Optional, Set
 from typing_extensions import Self
 
 class MetricDTO(BaseModel):
     """
-    A metric is a calculation based on one or more attribute values of analytic objects.
+    The information of a metric.
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="The unique ID of the metric.")
-    display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the metric.", alias="displayName")
-    description: Optional[StrictStr] = Field(default=None, description="The localized description of the metric.")
-    data_start_date: Optional[StrictStr] = Field(default=None, description="The date from which data becomes available for this metric.  Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.  Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent  limitation in representing large numbers.", alias="dataStartDate")
-    data_end_date: Optional[StrictStr] = Field(default=None, description="The date from which data is no longer available for this metric.  Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.  Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent  limitation in representing large numbers.", alias="dataEndDate")
-    analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object.", alias="analyticObjectId")
-    parameters: Optional[List[ParameterDefinitionDTO]] = Field(default=None, description="The collection of parameters defined for the metric.")
-    category: Optional[StrictStr] = Field(default=None, description="The category of the metric. Will be one of: `REGULAR`, `DERIVED` or `PLANNING`.")
-    visible_in_app: Optional[StrictBool] = Field(default=None, description="// If `true`, the metric is visible to end users in the solution.", alias="visibleInApp")
-    __properties: ClassVar[List[str]] = ["id", "displayName", "description", "dataStartDate", "dataEndDate", "analyticObjectId", "parameters", "category", "visibleInApp"]
-
-    @field_validator('category')
-    def category_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['REGULAR', 'DERIVED', 'PLANNING']):
-            raise ValueError("must be one of enum values ('REGULAR', 'DERIVED', 'PLANNING')")
-        return value
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the metric.")
+    parameter_values: Optional[List[ParameterDefinitionDTO]] = Field(default=None, description="The values associated with the metric's parameters, if defined.", alias="parameterValues")
+    time_handling: Optional[TimeHandlingDTO] = Field(default=None, description="The time handling settings for the metric.", alias="timeHandling")
+    __properties: ClassVar[List[str]] = ["id", "parameterValues", "timeHandling"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,13 +73,16 @@ class MetricDTO(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in parameters (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in parameter_values (list)
         _items = []
-        if self.parameters:
-            for _item_parameters in self.parameters:
-                if _item_parameters:
-                    _items.append(_item_parameters.to_dict())
-            _dict['parameters'] = _items
+        if self.parameter_values:
+            for _item_parameter_values in self.parameter_values:
+                if _item_parameter_values:
+                    _items.append(_item_parameter_values.to_dict())
+            _dict['parameterValues'] = _items
+        # override the default output from pydantic by calling `to_dict()` of time_handling
+        if self.time_handling:
+            _dict['timeHandling'] = self.time_handling.to_dict()
         return _dict
 
     @classmethod
@@ -108,14 +96,8 @@ class MetricDTO(BaseModel):
 
         _obj = cls.model_validate({
             "id": obj.get("id"),
-            "displayName": obj.get("displayName"),
-            "description": obj.get("description"),
-            "dataStartDate": obj.get("dataStartDate"),
-            "dataEndDate": obj.get("dataEndDate"),
-            "analyticObjectId": obj.get("analyticObjectId"),
-            "parameters": [ParameterDefinitionDTO.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None,
-            "category": obj.get("category"),
-            "visibleInApp": obj.get("visibleInApp")
+            "parameterValues": [ParameterDefinitionDTO.from_dict(_item) for _item in obj["parameterValues"]] if obj.get("parameterValues") is not None else None,
+            "timeHandling": TimeHandlingDTO.from_dict(obj["timeHandling"]) if obj.get("timeHandling") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/metric_filter_parameter_value_dto.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.filter_dto import FilterDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricFilterParameterValueDTO(BaseModel):
+    """
+    The filter values of a metric parameter, including the parameter ID and the filters on the parameter
+    """ # noqa: E501
+    parameter_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the member parameter qualified by the object.", alias="parameterId")
+    filters: Optional[List[FilterDTO]] = Field(default=None, description="The filters on the primary metric input parameter.")
+    __properties: ClassVar[List[str]] = ["parameterId", "filters"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricFilterParameterValueDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricFilterParameterValueDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameterId": obj.get("parameterId"),
+            "filters": [FilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/metric_request_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.metric_with_context_dto import MetricWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricRequestDTO(BaseModel):
+    """
+    The metrics to create or update.
+    """ # noqa: E501
+    metrics: Optional[List[MetricWithContextDTO]] = Field(default=None, description="The metrics in the request.")
+    __properties: ClassVar[List[str]] = ["metrics"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricRequestDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item_metrics in self.metrics:
+                if _item_metrics:
+                    _items.append(_item_metrics.to_dict())
+            _dict['metrics'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "metrics": [MetricWithContextDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/metric_response_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.metric_with_context_dto import MetricWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricResponseDTO(BaseModel):
+    """
+    The response for retrieving metrics.
+    """ # noqa: E501
+    metrics: Optional[List[MetricWithContextDTO]] = Field(default=None, description="The metrics in the response.")
+    __properties: ClassVar[List[str]] = ["metrics"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricResponseDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item_metrics in self.metrics:
+                if _item_metrics:
+                    _items.append(_item_metrics.to_dict())
+            _dict['metrics'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "metrics": [MetricWithContextDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None
+        })
+        return _obj
+
+