Skip to content

Plugin Template Response Dto

immichpy.client.generated.models.plugin_template_response_dto.PluginTemplateResponseDto pydantic-model

Bases: BaseModel

PluginTemplateResponseDto

Show JSON schema: 
{
  "$defs": {
    "PluginTemplateStepResponseDto": {
      "description": "PluginTemplateStepResponseDto",
      "properties": {
        "config": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Step configuration",
          "title": "Config"
        },
        "enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Whether the step is enabled",
          "title": "Enabled"
        },
        "method": {
          "description": "Step plugin method",
          "title": "Method",
          "type": "string"
        }
      },
      "required": [
        "config",
        "method"
      ],
      "title": "PluginTemplateStepResponseDto",
      "type": "object"
    },
    "WorkflowTrigger": {
      "description": "Plugin trigger type",
      "enum": [
        "AssetCreate",
        "AssetMetadataExtraction",
        "AssetTagged"
      ],
      "title": "WorkflowTrigger",
      "type": "string"
    }
  },
  "description": "PluginTemplateResponseDto",
  "properties": {
    "description": {
      "description": "Template description",
      "title": "Description",
      "type": "string"
    },
    "key": {
      "description": "Template key (unique across all templates)",
      "title": "Key",
      "type": "string"
    },
    "steps": {
      "description": "Workflow steps",
      "items": {
        "$ref": "#/$defs/PluginTemplateStepResponseDto"
      },
      "title": "Steps",
      "type": "array"
    },
    "title": {
      "description": "Template title",
      "title": "Title",
      "type": "string"
    },
    "trigger": {
      "$ref": "#/$defs/WorkflowTrigger"
    },
    "uiHints": {
      "description": "Ui hints, for example \"smart-album\"",
      "items": {
        "type": "string"
      },
      "title": "Uihints",
      "type": "array"
    }
  },
  "required": [
    "description",
    "key",
    "steps",
    "title",
    "trigger",
    "uiHints"
  ],
  "title": "PluginTemplateResponseDto",
  "type": "object"
}

Config:

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

Fields:

description pydantic-field 

description: StrictStr

Template description

key pydantic-field 

key: StrictStr

Template key (unique across all templates)

steps pydantic-field 

steps: List[PluginTemplateStepResponseDto]

Workflow steps

title pydantic-field 

title: StrictStr

Template title

ui_hints pydantic-field 

ui_hints: List[StrictStr]

Ui hints, for example "smart-album"

from_dict classmethod 

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

Create an instance of PluginTemplateResponseDto from a dict

Source code in immichpy/client/generated/models/plugin_template_response_dto.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PluginTemplateResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "description": obj.get("description"),
            "key": obj.get("key"),
            "steps": [
                PluginTemplateStepResponseDto.from_dict(_item)
                for _item in obj["steps"]
            ]
            if obj.get("steps") is not None
            else None,
            "title": obj.get("title"),
            "trigger": obj.get("trigger"),
            "uiHints": obj.get("uiHints"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PluginTemplateResponseDto from a JSON string

Source code in immichpy/client/generated/models/plugin_template_response_dto.py 
67
68
69
70
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PluginTemplateResponseDto 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/plugin_template_response_dto.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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 steps (list)
    _items = []
    if self.steps:
        for _item_steps in self.steps:
            _items.append(
                _item_steps.to_dict() if _item_steps is not None else None
            )
        _dict["steps"] = _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_template_response_dto.py 
63
64
65
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_template_response_dto.py 
59
60
61
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))