Skip to content

Activity Response Dto

immichpy.client.generated.models.activity_response_dto.ActivityResponseDto pydantic-model

Bases: BaseModel

ActivityResponseDto

Show JSON schema: 
{
  "$defs": {
    "ReactionType": {
      "description": "ReactionType",
      "enum": [
        "comment",
        "like"
      ],
      "title": "ReactionType",
      "type": "string"
    },
    "UserAvatarColor": {
      "description": "Avatar color",
      "enum": [
        "primary",
        "pink",
        "red",
        "yellow",
        "blue",
        "green",
        "purple",
        "orange",
        "gray",
        "amber"
      ],
      "title": "UserAvatarColor",
      "type": "string"
    },
    "UserResponseDto": {
      "description": "UserResponseDto",
      "properties": {
        "avatarColor": {
          "$ref": "#/$defs/UserAvatarColor"
        },
        "email": {
          "description": "User email",
          "title": "Email",
          "type": "string"
        },
        "id": {
          "description": "User ID",
          "title": "Id",
          "type": "string"
        },
        "name": {
          "description": "User name",
          "title": "Name",
          "type": "string"
        },
        "profileChangedAt": {
          "description": "Profile change date",
          "format": "date-time",
          "title": "Profilechangedat",
          "type": "string"
        },
        "profileImagePath": {
          "description": "Profile image path",
          "title": "Profileimagepath",
          "type": "string"
        }
      },
      "required": [
        "avatarColor",
        "email",
        "id",
        "name",
        "profileChangedAt",
        "profileImagePath"
      ],
      "title": "UserResponseDto",
      "type": "object"
    }
  },
  "description": "ActivityResponseDto",
  "properties": {
    "assetId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Asset ID (if activity is for an asset)",
      "title": "Assetid"
    },
    "comment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Comment text (for comment activities)",
      "title": "Comment"
    },
    "createdAt": {
      "description": "Creation date",
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "id": {
      "description": "Activity ID",
      "title": "Id",
      "type": "string"
    },
    "type": {
      "$ref": "#/$defs/ReactionType",
      "description": "Activity type"
    },
    "user": {
      "$ref": "#/$defs/UserResponseDto"
    }
  },
  "required": [
    "assetId",
    "createdAt",
    "id",
    "type",
    "user"
  ],
  "title": "ActivityResponseDto",
  "type": "object"
}

Config:

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

Fields:

asset_id pydantic-field 

asset_id: Optional[StrictStr]

Asset ID (if activity is for an asset)

comment pydantic-field 

comment: Optional[StrictStr] = None

Comment text (for comment activities)

created_at pydantic-field 

created_at: datetime

Creation date

id pydantic-field 

id: StrictStr

Activity ID

type pydantic-field 

type: ReactionType

Activity type

from_dict classmethod 

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

Create an instance of ActivityResponseDto from a dict

Source code in immichpy/client/generated/models/activity_response_dto.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of ActivityResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "assetId": obj.get("assetId"),
            "comment": obj.get("comment"),
            "createdAt": obj.get("createdAt"),
            "id": obj.get("id"),
            "type": obj.get("type"),
            "user": UserResponseDto.from_dict(obj["user"])
            if obj.get("user") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ActivityResponseDto from a JSON string

Source code in immichpy/client/generated/models/activity_response_dto.py 
67
68
69
70
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ActivityResponseDto 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/activity_response_dto.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
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 user
    if self.user:
        _dict["user"] = self.user.to_dict()
    # set to None if asset_id (nullable) is None
    # and model_fields_set contains the field
    if self.asset_id is None and "asset_id" in self.model_fields_set:
        _dict["assetId"] = None

    # set to None if comment (nullable) is None
    # and model_fields_set contains the field
    if self.comment is None and "comment" in self.model_fields_set:
        _dict["comment"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/activity_response_dto.py 
62
63
64
65
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/activity_response_dto.py 
58
59
60
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))