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": "Reaction type",
      "enum": [
        "comment",
        "like"
      ],
      "title": "ReactionType",
      "type": "string"
    },
    "UserAvatarColor": {
      "description": "User 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",
          "format": "uuid",
          "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": [
        {
          "format": "uuid",
          "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",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "id": {
      "description": "Activity ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "type": {
      "$ref": "#/$defs/ReactionType"
    },
    "user": {
      "$ref": "#/$defs/UserResponseDto"
    }
  },
  "required": [
    "assetId",
    "createdAt",
    "id",
    "type",
    "user"
  ],
  "title": "ActivityResponseDto",
  "type": "object"
}

Config:

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

Fields:

Validators:

asset_id pydantic-field 

asset_id: Optional[UUID]

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: UUID

Activity ID

asset_id_validate_regular_expression pydantic-validator 

asset_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/activity_response_dto.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
@field_validator("asset_id", mode="before")
def asset_id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

created_at_validate_regular_expression pydantic-validator 

created_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/activity_response_dto.py 
73
74
75
76
77
78
79
80
81
82
83
@field_validator("created_at", mode="before")
def created_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

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 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@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 
112
113
114
115
@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))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/activity_response_dto.py 
85
86
87
88
89
90
91
92
93
94
95
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

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 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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 
108
109
110
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/activity_response_dto.py 
104
105
106
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))