Skip to content

Memory Create Dto

immichpy.client.generated.models.memory_create_dto.MemoryCreateDto pydantic-model

Bases: BaseModel

MemoryCreateDto

Show JSON schema: 
{
  "$defs": {
    "MemoryType": {
      "description": "MemoryType",
      "enum": [
        "on_this_day"
      ],
      "title": "MemoryType",
      "type": "string"
    },
    "OnThisDayDto": {
      "description": "OnThisDayDto",
      "properties": {
        "year": {
          "anyOf": [
            {
              "minimum": 1,
              "type": "number"
            },
            {
              "minimum": 1,
              "type": "integer"
            }
          ],
          "description": "Year for on this day memory",
          "title": "Year"
        }
      },
      "required": [
        "year"
      ],
      "title": "OnThisDayDto",
      "type": "object"
    }
  },
  "description": "MemoryCreateDto",
  "properties": {
    "assetIds": {
      "anyOf": [
        {
          "items": {
            "format": "uuid",
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Asset IDs to associate with memory",
      "title": "Assetids"
    },
    "data": {
      "$ref": "#/$defs/OnThisDayDto"
    },
    "hideAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date when memory should be hidden",
      "title": "Hideat"
    },
    "isSaved": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Is memory saved",
      "title": "Issaved"
    },
    "memoryAt": {
      "description": "Memory date",
      "format": "date-time",
      "title": "Memoryat",
      "type": "string"
    },
    "seenAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date when memory was seen",
      "title": "Seenat"
    },
    "showAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date when memory should be shown",
      "title": "Showat"
    },
    "type": {
      "$ref": "#/$defs/MemoryType",
      "description": "Memory type"
    }
  },
  "required": [
    "data",
    "memoryAt",
    "type"
  ],
  "title": "MemoryCreateDto",
  "type": "object"
}

Config:

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

Fields:

asset_ids pydantic-field 

asset_ids: Optional[List[UUID]] = None

Asset IDs to associate with memory

hide_at pydantic-field 

hide_at: Optional[datetime] = None

Date when memory should be hidden

is_saved pydantic-field 

is_saved: Optional[StrictBool] = None

Is memory saved

memory_at pydantic-field 

memory_at: datetime

Memory date

seen_at pydantic-field 

seen_at: Optional[datetime] = None

Date when memory was seen

show_at pydantic-field 

show_at: Optional[datetime] = None

Date when memory should be shown

type pydantic-field 

type: MemoryType

Memory type

from_dict classmethod 

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

Create an instance of MemoryCreateDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "assetIds": obj.get("assetIds"),
            "data": OnThisDayDto.from_dict(obj["data"])
            if obj.get("data") is not None
            else None,
            "hideAt": obj.get("hideAt"),
            "isSaved": obj.get("isSaved"),
            "memoryAt": obj.get("memoryAt"),
            "seenAt": obj.get("seenAt"),
            "showAt": obj.get("showAt"),
            "type": obj.get("type"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of MemoryCreateDto from a JSON string

Source code in immichpy/client/generated/models/memory_create_dto.py 
78
79
80
81
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of MemoryCreateDto 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/memory_create_dto.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
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 data
    if self.data:
        _dict["data"] = self.data.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/memory_create_dto.py 
73
74
75
76
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/memory_create_dto.py 
69
70
71
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))