Skip to content

Download Response Dto

immichpy.client.generated.models.download_response_dto.DownloadResponseDto pydantic-model

Bases: BaseModel

DownloadResponseDto

Show JSON schema: 
{
  "$defs": {
    "DownloadArchiveInfo": {
      "description": "DownloadArchiveInfo",
      "properties": {
        "assetIds": {
          "description": "Asset IDs in this archive",
          "items": {
            "type": "string"
          },
          "title": "Assetids",
          "type": "array"
        },
        "size": {
          "description": "Archive size in bytes",
          "title": "Size",
          "type": "integer"
        }
      },
      "required": [
        "assetIds",
        "size"
      ],
      "title": "DownloadArchiveInfo",
      "type": "object"
    }
  },
  "description": "DownloadResponseDto",
  "properties": {
    "archives": {
      "description": "Archive information",
      "items": {
        "$ref": "#/$defs/DownloadArchiveInfo"
      },
      "title": "Archives",
      "type": "array"
    },
    "totalSize": {
      "description": "Total size in bytes",
      "title": "Totalsize",
      "type": "integer"
    }
  },
  "required": [
    "archives",
    "totalSize"
  ],
  "title": "DownloadResponseDto",
  "type": "object"
}

Config:

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

Fields:

archives pydantic-field 

archives: List[DownloadArchiveInfo]

Archive information

total_size pydantic-field 

total_size: StrictInt

Total size in bytes

from_dict classmethod 

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

Create an instance of DownloadResponseDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "archives": [
                DownloadArchiveInfo.from_dict(_item) for _item in obj["archives"]
            ]
            if obj.get("archives") is not None
            else None,
            "totalSize": obj.get("totalSize"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of DownloadResponseDto from a JSON string

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

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/download_response_dto.py 
45
46
47
48
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/download_response_dto.py 
41
42
43
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))