Skip to content

Calendar Heatmap Response Dto

immichpy.client.generated.models.calendar_heatmap_response_dto.CalendarHeatmapResponseDto pydantic-model

Bases: BaseModel

CalendarHeatmapResponseDto

Show JSON schema: 
{
  "$defs": {
    "CalendarHeatmapResponseDtoSeriesInner": {
      "description": "CalendarHeatmapResponseDtoSeriesInner",
      "properties": {
        "count": {
          "description": "Activity count",
          "maximum": 9007199254740991,
          "minimum": 0,
          "title": "Count",
          "type": "integer"
        },
        "date": {
          "description": "Date in UTC",
          "examples": [
            "2024-01-01"
          ],
          "title": "Date",
          "type": "string"
        }
      },
      "required": [
        "count",
        "date"
      ],
      "title": "CalendarHeatmapResponseDtoSeriesInner",
      "type": "object"
    }
  },
  "description": "CalendarHeatmapResponseDto",
  "properties": {
    "from": {
      "description": "Start date in UTC",
      "examples": [
        "2024-01-01"
      ],
      "title": "From",
      "type": "string"
    },
    "series": {
      "items": {
        "$ref": "#/$defs/CalendarHeatmapResponseDtoSeriesInner"
      },
      "title": "Series",
      "type": "array"
    },
    "to": {
      "description": "End date in UTC",
      "examples": [
        "2024-12-31"
      ],
      "title": "To",
      "type": "string"
    },
    "totalCount": {
      "description": "Total activity count over the period",
      "maximum": 9007199254740991,
      "minimum": 0,
      "title": "Totalcount",
      "type": "integer"
    }
  },
  "required": [
    "from",
    "series",
    "to",
    "totalCount"
  ],
  "title": "CalendarHeatmapResponseDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

to pydantic-field 

to: StrictStr

End date in UTC

total_count pydantic-field 

total_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]

Total activity count over the period

var_from pydantic-field 

var_from: StrictStr

Start date in UTC

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of CalendarHeatmapResponseDto from a dict

Source code in immichpy/client/generated/models/calendar_heatmap_response_dto.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of CalendarHeatmapResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "from": obj.get("from"),
            "series": [
                CalendarHeatmapResponseDtoSeriesInner.from_dict(_item)
                for _item in obj["series"]
            ]
            if obj.get("series") is not None
            else None,
            "to": obj.get("to"),
            "totalCount": obj.get("totalCount"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of CalendarHeatmapResponseDto from a JSON string

Source code in immichpy/client/generated/models/calendar_heatmap_response_dto.py 
64
65
66
67
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of CalendarHeatmapResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> 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.
Source code in immichpy/client/generated/models/calendar_heatmap_response_dto.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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 series (list)
    _items = []
    if self.series:
        for _item_series in self.series:
            _items.append(
                _item_series.to_dict() if _item_series is not None else None
            )
        _dict["series"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/calendar_heatmap_response_dto.py 
60
61
62
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/calendar_heatmap_response_dto.py 
56
57
58
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))