Skip to content

Plugin Method Response Dto

immichpy.client.generated.models.plugin_method_response_dto.PluginMethodResponseDto pydantic-model

Bases: BaseModel

PluginMethodResponseDto

Show JSON schema: 
{
  "$defs": {
    "WorkflowType": {
      "description": "Workflow type",
      "enum": [
        "AssetV1"
      ],
      "title": "WorkflowType",
      "type": "string"
    }
  },
  "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"
}

Config:

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

Fields:

description pydantic-field 

description: StrictStr

Description

key pydantic-field 

key: StrictStr

Key

name pydantic-field 

name: StrictStr

Name

title pydantic-field 

title: StrictStr

Title

types pydantic-field 

types: List[WorkflowType]

Workflow types

ui_hints pydantic-field 

ui_hints: List[StrictStr]

Ui hints

from_dict classmethod 

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

Create an instance of PluginMethodResponseDto from a dict

Source code in immichpy/client/generated/models/plugin_method_response_dto.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PluginMethodResponseDto 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"),
            "hostFunctions": obj.get("hostFunctions"),
            "key": obj.get("key"),
            "name": obj.get("name"),
            "schema": obj.get("schema"),
            "title": obj.get("title"),
            "types": obj.get("types"),
            "uiHints": obj.get("uiHints"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PluginMethodResponseDto from a JSON string

Source code in immichpy/client/generated/models/plugin_method_response_dto.py 
66
67
68
69
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PluginMethodResponseDto 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_method_response_dto.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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/plugin_method_response_dto.py 
62
63
64
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_method_response_dto.py 
58
59
60
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))