Skip to content

Sync Memory V1

immichpy.client.generated.models.sync_memory_v1.SyncMemoryV1 pydantic-model

Bases: BaseModel

SyncMemoryV1

Show JSON schema:
{
  "$defs": {
    "MemoryType": {
      "description": "MemoryType",
      "enum": [
        "on_this_day"
      ],
      "title": "MemoryType",
      "type": "string"
    }
  },
  "description": "SyncMemoryV1",
  "properties": {
    "createdAt": {
      "description": "Created at",
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "data": {
      "additionalProperties": true,
      "description": "Data",
      "title": "Data",
      "type": "object"
    },
    "deletedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Deleted at",
      "title": "Deletedat"
    },
    "hideAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Hide at",
      "title": "Hideat"
    },
    "id": {
      "description": "Memory ID",
      "title": "Id",
      "type": "string"
    },
    "isSaved": {
      "description": "Is saved",
      "title": "Issaved",
      "type": "boolean"
    },
    "memoryAt": {
      "description": "Memory at",
      "format": "date-time",
      "title": "Memoryat",
      "type": "string"
    },
    "ownerId": {
      "description": "Owner ID",
      "title": "Ownerid",
      "type": "string"
    },
    "seenAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Seen at",
      "title": "Seenat"
    },
    "showAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Show at",
      "title": "Showat"
    },
    "type": {
      "$ref": "#/$defs/MemoryType",
      "description": "Memory type"
    },
    "updatedAt": {
      "description": "Updated at",
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "createdAt",
    "data",
    "deletedAt",
    "hideAt",
    "id",
    "isSaved",
    "memoryAt",
    "ownerId",
    "seenAt",
    "showAt",
    "type",
    "updatedAt"
  ],
  "title": "SyncMemoryV1",
  "type": "object"
}

Config:

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

Fields:

created_at pydantic-field

created_at: datetime

Created at

data pydantic-field

data: Dict[str, Any]

Data

deleted_at pydantic-field

deleted_at: Optional[datetime]

Deleted at

hide_at pydantic-field

hide_at: Optional[datetime]

Hide at

id pydantic-field

id: StrictStr

Memory ID

is_saved pydantic-field

is_saved: StrictBool

Is saved

memory_at pydantic-field

memory_at: datetime

Memory at

owner_id pydantic-field

owner_id: StrictStr

Owner ID

seen_at pydantic-field

seen_at: Optional[datetime]

Seen at

show_at pydantic-field

show_at: Optional[datetime]

Show at

type pydantic-field

type: MemoryType

Memory type

updated_at pydantic-field

updated_at: datetime

Updated at

from_dict classmethod

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

Create an instance of SyncMemoryV1 from a dict

Source code in immichpy/client/generated/models/sync_memory_v1.py
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
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SyncMemoryV1 from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "createdAt": obj.get("createdAt"),
            "data": obj.get("data"),
            "deletedAt": obj.get("deletedAt"),
            "hideAt": obj.get("hideAt"),
            "id": obj.get("id"),
            "isSaved": obj.get("isSaved"),
            "memoryAt": obj.get("memoryAt"),
            "ownerId": obj.get("ownerId"),
            "seenAt": obj.get("seenAt"),
            "showAt": obj.get("showAt"),
            "type": obj.get("type"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of SyncMemoryV1 from a JSON string

Source code in immichpy/client/generated/models/sync_memory_v1.py
74
75
76
77
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncMemoryV1 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/sync_memory_v1.py
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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,
    )
    # set to None if deleted_at (nullable) is None
    # and model_fields_set contains the field
    if self.deleted_at is None and "deleted_at" in self.model_fields_set:
        _dict["deletedAt"] = None

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

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

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

    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

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