Shared Link Create Dto
immichpy.client.generated.models.shared_link_create_dto.SharedLinkCreateDto
pydantic-model
Bases: BaseModel
SharedLinkCreateDto
Show JSON schema:
{
"$defs": {
"SharedLinkType": {
"description": "Shared link type",
"enum": [
"ALBUM",
"INDIVIDUAL"
],
"title": "SharedLinkType",
"type": "string"
}
},
"description": "SharedLinkCreateDto",
"properties": {
"albumId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Album ID (for album sharing)",
"title": "Albumid"
},
"allowDownload": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Allow downloads",
"title": "Allowdownload"
},
"allowUpload": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Allow uploads",
"title": "Allowupload"
},
"assetIds": {
"anyOf": [
{
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Asset IDs (for individual assets)",
"title": "Assetids"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Link description",
"title": "Description"
},
"expiresAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Expiration date",
"examples": [
"2024-01-01T00:00:00Z"
],
"title": "Expiresat"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Link password",
"title": "Password"
},
"showMetadata": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Show metadata",
"title": "Showmetadata"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Custom URL slug",
"title": "Slug"
},
"type": {
"$ref": "#/$defs/SharedLinkType"
}
},
"required": [
"type"
],
"title": "SharedLinkCreateDto",
"type": "object"
}
Config:
validate_by_name:Truevalidate_by_alias:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
album_id(Optional[UUID]) -
allow_download(Optional[StrictBool]) -
allow_upload(Optional[StrictBool]) -
asset_ids(Optional[List[UUID]]) -
description(Optional[StrictStr]) -
expires_at(Optional[datetime]) -
password(Optional[StrictStr]) -
show_metadata(Optional[StrictBool]) -
slug(Optional[StrictStr]) -
type(SharedLinkType)
Validators:
album_id
pydantic-field
album_id: Optional[UUID] = None
Album ID (for album sharing)
allow_download
pydantic-field
allow_download: Optional[StrictBool] = True
Allow downloads
allow_upload
pydantic-field
allow_upload: Optional[StrictBool] = None
Allow uploads
asset_ids
pydantic-field
asset_ids: Optional[List[UUID]] = None
Asset IDs (for individual assets)
description
pydantic-field
description: Optional[StrictStr] = None
Link description
expires_at
pydantic-field
expires_at: Optional[datetime] = None
Expiration date
password
pydantic-field
password: Optional[StrictStr] = None
Link password
show_metadata
pydantic-field
show_metadata: Optional[StrictBool] = True
Show metadata
slug
pydantic-field
slug: Optional[StrictStr] = None
Custom URL slug
album_id_validate_regular_expression
pydantic-validator
album_id_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/shared_link_create_dto.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 | |
expires_at_validate_regular_expression
pydantic-validator
expires_at_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/shared_link_create_dto.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of SharedLinkCreateDto from a dict
Source code in immichpy/client/generated/models/shared_link_create_dto.py
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of SharedLinkCreateDto from a JSON string
Source code in immichpy/client/generated/models/shared_link_create_dto.py
126 127 128 129 | |
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):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/shared_link_create_dto.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/shared_link_create_dto.py
122 123 124 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/shared_link_create_dto.py
118 119 120 | |