Skip to content

User License

immichpy.client.generated.models.user_license.UserLicense pydantic-model

Bases: BaseModel

UserLicense

Show JSON schema: 
{
  "description": "UserLicense",
  "properties": {
    "activatedAt": {
      "description": "Activation date",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Activatedat",
      "type": "string"
    },
    "activationKey": {
      "description": "Activation key",
      "title": "Activationkey",
      "type": "string"
    },
    "licenseKey": {
      "description": "License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/)",
      "title": "Licensekey",
      "type": "string"
    }
  },
  "required": [
    "activatedAt",
    "activationKey",
    "licenseKey"
  ],
  "title": "UserLicense",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: 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)(-[\dA-Za-z]{4}){8}$/)

activated_at_validate_regular_expression pydantic-validator 

activated_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/user_license.py 
47
48
49
50
51
52
53
54
55
56
57
@field_validator("activated_at", mode="before")
def activated_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 UserLicense from a dict

Source code in immichpy/client/generated/models/user_license.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserLicense 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 UserLicense from a JSON string

Source code in immichpy/client/generated/models/user_license.py 
85
86
87
88
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserLicense 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/user_license.py 
59
60
61
62
63
64
65
66
67
68
@field_validator("license_key", mode="before")
def license_key_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and 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/user_license.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
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/user_license.py 
81
82
83
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/user_license.py 
77
78
79
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))