# coding: utf-8

"""
    Mixpeek API

    This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.

    The version of the OpenAPI document: 1.3.0
    Contact: info@mixpeek.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 mixpeek.models.date_part_unit import DatePartUnit
from mixpeek.models.date_trunc_unit import DateTruncUnit
from typing import Optional, Set
from typing_extensions import Self

class GroupByField(BaseModel):
    """
    Configuration for grouping by a field.  Defines how to group data by a specific field, with optional transformations.  Requirements:     - field: REQUIRED, the field to group by     - alias: OPTIONAL, name for the grouped field in results     - date_trunc: OPTIONAL, truncate date fields to time periods     - date_part: OPTIONAL, extract part of date field  Examples:     - Simple grouping: GroupByField(field=\"metadata.category\")     - Daily grouping: GroupByField(field=\"created_at\", date_trunc=DateTruncUnit.DAY)     - Hour of day: GroupByField(field=\"created_at\", date_part=DatePartUnit.HOUR)
    """ # noqa: E501
    var_field: StrictStr = Field(description="The field path to group by. Supports dot notation for nested fields (e.g., 'metadata.category'). For date fields, can be combined with date_trunc or date_part.", alias="field")
    alias: Optional[StrictStr] = Field(default=None, description="Optional alias for the grouped field in results. If not provided, uses the field name. Useful for nested fields to create simpler result names.")
    date_trunc: Optional[DateTruncUnit] = Field(default=None, description="Truncate date field to specified unit. REQUIRED when grouping by date/time periods. Only valid for date/datetime fields. Cannot be used with date_part.")
    date_part: Optional[DatePartUnit] = Field(default=None, description="Extract specific part from date field. OPTIONAL for analyzing date patterns. Only valid for date/datetime fields. Cannot be used with date_trunc.")
    __properties: ClassVar[List[str]] = ["field", "alias", "date_trunc", "date_part"]

    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 GroupByField 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,
        )
        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of GroupByField from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "field": obj.get("field"),
            "alias": obj.get("alias"),
            "date_trunc": obj.get("date_trunc"),
            "date_part": obj.get("date_part")
        })
        return _obj


