Skip to content

Activity Create Dto

immichpy.client.generated.models.activity_create_dto.ActivityCreateDto pydantic-model

Bases: BaseModel

ActivityCreateDto

Show JSON schema: 
{
  "$defs": {
    "ReactionType": {
      "description": "ReactionType",
      "enum": [
        "comment",
        "like"
      ],
      "title": "ReactionType",
      "type": "string"
    }
  },
  "description": "ActivityCreateDto",
  "properties": {
    "albumId": {
      "description": "Album ID",
      "format": "uuid",
      "title": "Albumid",
      "type": "string"
    },
    "assetId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Asset ID (if activity is for an asset)",
      "title": "Assetid"
    },
    "comment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Comment text (required if type is comment)",
      "title": "Comment"
    },
    "type": {
      "$ref": "#/$defs/ReactionType",
      "description": "Activity type (like or comment)"
    }
  },
  "required": [
    "albumId",
    "type"
  ],
  "title": "ActivityCreateDto",
  "type": "object"
}

Config:

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

Fields:

album_id pydantic-field 

album_id: UUID

Album ID

asset_id pydantic-field 

asset_id: Optional[UUID] = None

Asset ID (if activity is for an asset)

comment pydantic-field 

comment: Optional[StrictStr] = None

Comment text (required if type is comment)

type pydantic-field 

type: ReactionType

Activity type (like or comment)

from_dict classmethod 

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

Create an instance of ActivityCreateDto from a dict

Source code in immichpy/client/generated/models/activity_create_dto.py 
 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 ActivityCreateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "albumId": obj.get("albumId"),
            "assetId": obj.get("assetId"),
            "comment": obj.get("comment"),
            "type": obj.get("type"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ActivityCreateDto from a JSON string

Source code in immichpy/client/generated/models/activity_create_dto.py 
59
60
61
62
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ActivityCreateDto 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_create_dto.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/activity_create_dto.py 
54
55
56
57
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_create_dto.py 
50
51
52
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))