Skip to content

Plugin Response Dto

immichpy.client.generated.models.plugin_response_dto.PluginResponseDto pydantic-model

Bases: BaseModel

PluginResponseDto

Show JSON schema: 
{
  "$defs": {
    "PluginMethodResponseDto": {
      "description": "PluginMethodResponseDto",
      "properties": {
        "description": {
          "description": "Description",
          "title": "Description",
          "type": "string"
        },
        "hostFunctions": {
          "title": "Hostfunctions",
          "type": "boolean"
        },
        "key": {
          "description": "Key",
          "title": "Key",
          "type": "string"
        },
        "name": {
          "description": "Name",
          "title": "Name",
          "type": "string"
        },
        "schema": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Schema"
        },
        "title": {
          "description": "Title",
          "title": "Title",
          "type": "string"
        },
        "types": {
          "description": "Workflow types",
          "items": {
            "$ref": "#/$defs/WorkflowType"
          },
          "title": "Types",
          "type": "array"
        },
        "uiHints": {
          "description": "Ui hints",
          "items": {
            "type": "string"
          },
          "title": "Uihints",
          "type": "array"
        }
      },
      "required": [
        "description",
        "hostFunctions",
        "key",
        "name",
        "title",
        "types",
        "uiHints"
      ],
      "title": "PluginMethodResponseDto",
      "type": "object"
    },
    "WorkflowType": {
      "description": "Workflow type",
      "enum": [
        "AssetV1"
      ],
      "title": "WorkflowType",
      "type": "string"
    }
  },
  "description": "PluginResponseDto",
  "properties": {
    "author": {
      "description": "Plugin author",
      "title": "Author",
      "type": "string"
    },
    "createdAt": {
      "description": "Creation date",
      "title": "Createdat",
      "type": "string"
    },
    "description": {
      "description": "Plugin description",
      "title": "Description",
      "type": "string"
    },
    "id": {
      "description": "Plugin ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "methods": {
      "description": "Plugin methods",
      "items": {
        "$ref": "#/$defs/PluginMethodResponseDto"
      },
      "title": "Methods",
      "type": "array"
    },
    "name": {
      "description": "Plugin name",
      "title": "Name",
      "type": "string"
    },
    "title": {
      "description": "Plugin title",
      "title": "Title",
      "type": "string"
    },
    "updatedAt": {
      "description": "Last update date",
      "title": "Updatedat",
      "type": "string"
    },
    "version": {
      "description": "Plugin version",
      "title": "Version",
      "type": "string"
    }
  },
  "required": [
    "author",
    "createdAt",
    "description",
    "id",
    "methods",
    "name",
    "title",
    "updatedAt",
    "version"
  ],
  "title": "PluginResponseDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

author pydantic-field 

author: StrictStr

Plugin author

created_at pydantic-field 

created_at: StrictStr

Creation date

description pydantic-field 

description: StrictStr

Plugin description

id pydantic-field 

id: UUID

Plugin ID

methods pydantic-field 

methods: List[PluginMethodResponseDto]

Plugin methods

name pydantic-field 

name: StrictStr

Plugin name

title pydantic-field 

title: StrictStr

Plugin title

updated_at pydantic-field 

updated_at: StrictStr

Last update date

version pydantic-field 

version: StrictStr

Plugin version

from_dict classmethod 

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

Create an instance of PluginResponseDto from a dict

Source code in immichpy/client/generated/models/plugin_response_dto.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PluginResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "author": obj.get("author"),
            "createdAt": obj.get("createdAt"),
            "description": obj.get("description"),
            "id": obj.get("id"),
            "methods": [
                PluginMethodResponseDto.from_dict(_item) for _item in obj["methods"]
            ]
            if obj.get("methods") is not None
            else None,
            "name": obj.get("name"),
            "title": obj.get("title"),
            "updatedAt": obj.get("updatedAt"),
            "version": obj.get("version"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PluginResponseDto from a JSON string

Source code in immichpy/client/generated/models/plugin_response_dto.py 
83
84
85
86
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PluginResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/plugin_response_dto.py 
56
57
58
59
60
61
62
63
64
65
66
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    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/plugin_response_dto.py 
 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
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 each item in methods (list)
    _items = []
    if self.methods:
        for _item_methods in self.methods:
            _items.append(
                _item_methods.to_dict() if _item_methods is not None else None
            )
        _dict["methods"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/plugin_response_dto.py 
79
80
81
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/plugin_response_dto.py 
75
76
77
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))