Skip to content

People Response Dto

immichpy.client.generated.models.people_response_dto.PeopleResponseDto pydantic-model

Bases: BaseModel

PeopleResponseDto

Show JSON schema: 
{
  "$defs": {
    "PersonResponseDto": {
      "description": "PersonResponseDto",
      "properties": {
        "birthDate": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Person date of birth",
          "title": "Birthdate"
        },
        "color": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Person color (hex)",
          "title": "Color"
        },
        "id": {
          "description": "Person ID",
          "title": "Id",
          "type": "string"
        },
        "isFavorite": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Is favorite",
          "title": "Isfavorite"
        },
        "isHidden": {
          "description": "Is hidden",
          "title": "Ishidden",
          "type": "boolean"
        },
        "name": {
          "description": "Person name",
          "title": "Name",
          "type": "string"
        },
        "thumbnailPath": {
          "description": "Thumbnail path",
          "title": "Thumbnailpath",
          "type": "string"
        },
        "updatedAt": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Last update date",
          "title": "Updatedat"
        }
      },
      "required": [
        "birthDate",
        "id",
        "isHidden",
        "name",
        "thumbnailPath"
      ],
      "title": "PersonResponseDto",
      "type": "object"
    }
  },
  "description": "PeopleResponseDto",
  "properties": {
    "hasNextPage": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether there are more pages",
      "title": "Hasnextpage"
    },
    "hidden": {
      "description": "Number of hidden people",
      "title": "Hidden",
      "type": "integer"
    },
    "people": {
      "description": "List of people",
      "items": {
        "$ref": "#/$defs/PersonResponseDto"
      },
      "title": "People",
      "type": "array"
    },
    "total": {
      "description": "Total number of people",
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "hidden",
    "people",
    "total"
  ],
  "title": "PeopleResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

has_next_page pydantic-field 

has_next_page: Optional[StrictBool] = None

Whether there are more pages

hidden pydantic-field 

hidden: StrictInt

Number of hidden people

people pydantic-field 

people: List[PersonResponseDto]

List of people

total pydantic-field 

total: StrictInt

Total number of people

from_dict classmethod 

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

Create an instance of PeopleResponseDto from a dict

Source code in immichpy/client/generated/models/people_response_dto.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PeopleResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "hasNextPage": obj.get("hasNextPage"),
            "hidden": obj.get("hidden"),
            "people": [
                PersonResponseDto.from_dict(_item) for _item in obj["people"]
            ]
            if obj.get("people") is not None
            else None,
            "total": obj.get("total"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PeopleResponseDto from a JSON string

Source code in immichpy/client/generated/models/people_response_dto.py 
54
55
56
57
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PeopleResponseDto 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/people_response_dto.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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 people (list)
    _items = []
    if self.people:
        for _item_people in self.people:
            if _item_people:
                _items.append(_item_people.to_dict())
        _dict["people"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/people_response_dto.py 
49
50
51
52
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())

to_str 

to_str() -> str

Returns the string representation of the model using alias

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