Skip to content

License Response Dto

immichpy.client.generated.models.license_response_dto.LicenseResponseDto pydantic-model

Bases: BaseModel

LicenseResponseDto

Show JSON schema:
{
  "description": "LicenseResponseDto",
  "properties": {
    "activatedAt": {
      "description": "Activation date",
      "format": "date-time",
      "title": "Activatedat",
      "type": "string"
    },
    "activationKey": {
      "description": "Activation key",
      "title": "Activationkey",
      "type": "string"
    },
    "licenseKey": {
      "description": "License key (format: IM(SV|CL)(-XXXX){8})",
      "title": "Licensekey",
      "type": "string"
    }
  },
  "required": [
    "activatedAt",
    "activationKey",
    "licenseKey"
  ],
  "title": "LicenseResponseDto",
  "type": "object"
}

Config:

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

Fields:

Validators:

activated_at pydantic-field

activated_at: datetime

Activation date

activation_key pydantic-field

activation_key: StrictStr

Activation key

license_key pydantic-field

license_key: Annotated[str, Field(strict=True)]

License key (format: IM(SV|CL)(-XXXX){8})

from_dict classmethod

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

Create an instance of LicenseResponseDto from a dict

Source code in immichpy/client/generated/models/license_response_dto.py
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of LicenseResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "activatedAt": obj.get("activatedAt"),
            "activationKey": obj.get("activationKey"),
            "licenseKey": obj.get("licenseKey"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of LicenseResponseDto from a JSON string

Source code in immichpy/client/generated/models/license_response_dto.py
65
66
67
68
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of LicenseResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

license_key_validate_regular_expression pydantic-validator

license_key_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/license_response_dto.py
41
42
43
44
45
46
47
48
@field_validator("license_key")
def license_key_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if not re.match(r"IM(SV|CL)(-[\dA-Za-z]{4}){8}", value):
        raise ValueError(
            r"must validate the regular expression /IM(SV|CL)(-[\dA-Za-z]{4}){8}/"
        )
    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/license_response_dto.py
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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/license_response_dto.py
60
61
62
63
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/license_response_dto.py
56
57
58
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))