Skip to content

Plugin Response Dto

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

Bases: BaseModel

PluginResponseDto

Show JSON schema: 
{
  "$defs": {
    "PluginActionResponseDto": {
      "description": "PluginActionResponseDto",
      "properties": {
        "description": {
          "description": "Action description",
          "title": "Description",
          "type": "string"
        },
        "id": {
          "description": "Action ID",
          "title": "Id",
          "type": "string"
        },
        "methodName": {
          "description": "Method name",
          "title": "Methodname",
          "type": "string"
        },
        "pluginId": {
          "description": "Plugin ID",
          "title": "Pluginid",
          "type": "string"
        },
        "schema": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Action schema",
          "title": "Schema"
        },
        "supportedContexts": {
          "description": "Supported contexts",
          "items": {
            "$ref": "#/$defs/PluginContextType"
          },
          "title": "Supportedcontexts",
          "type": "array"
        },
        "title": {
          "description": "Action title",
          "title": "Title",
          "type": "string"
        }
      },
      "required": [
        "description",
        "id",
        "methodName",
        "pluginId",
        "schema",
        "supportedContexts",
        "title"
      ],
      "title": "PluginActionResponseDto",
      "type": "object"
    },
    "PluginContextType": {
      "description": "Context type",
      "enum": [
        "asset",
        "album",
        "person"
      ],
      "title": "PluginContextType",
      "type": "string"
    },
    "PluginFilterResponseDto": {
      "description": "PluginFilterResponseDto",
      "properties": {
        "description": {
          "description": "Filter description",
          "title": "Description",
          "type": "string"
        },
        "id": {
          "description": "Filter ID",
          "title": "Id",
          "type": "string"
        },
        "methodName": {
          "description": "Method name",
          "title": "Methodname",
          "type": "string"
        },
        "pluginId": {
          "description": "Plugin ID",
          "title": "Pluginid",
          "type": "string"
        },
        "schema": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Filter schema",
          "title": "Schema"
        },
        "supportedContexts": {
          "description": "Supported contexts",
          "items": {
            "$ref": "#/$defs/PluginContextType"
          },
          "title": "Supportedcontexts",
          "type": "array"
        },
        "title": {
          "description": "Filter title",
          "title": "Title",
          "type": "string"
        }
      },
      "required": [
        "description",
        "id",
        "methodName",
        "pluginId",
        "schema",
        "supportedContexts",
        "title"
      ],
      "title": "PluginFilterResponseDto",
      "type": "object"
    }
  },
  "description": "PluginResponseDto",
  "properties": {
    "actions": {
      "description": "Plugin actions",
      "items": {
        "$ref": "#/$defs/PluginActionResponseDto"
      },
      "title": "Actions",
      "type": "array"
    },
    "author": {
      "description": "Plugin author",
      "title": "Author",
      "type": "string"
    },
    "createdAt": {
      "description": "Creation date",
      "title": "Createdat",
      "type": "string"
    },
    "description": {
      "description": "Plugin description",
      "title": "Description",
      "type": "string"
    },
    "filters": {
      "description": "Plugin filters",
      "items": {
        "$ref": "#/$defs/PluginFilterResponseDto"
      },
      "title": "Filters",
      "type": "array"
    },
    "id": {
      "description": "Plugin ID",
      "title": "Id",
      "type": "string"
    },
    "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": [
    "actions",
    "author",
    "createdAt",
    "description",
    "filters",
    "id",
    "name",
    "title",
    "updatedAt",
    "version"
  ],
  "title": "PluginResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

actions pydantic-field 

actions: List[PluginActionResponseDto]

Plugin actions

author pydantic-field 

author: StrictStr

Plugin author

created_at pydantic-field 

created_at: StrictStr

Creation date

description pydantic-field 

description: StrictStr

Plugin description

filters pydantic-field 

filters: List[PluginFilterResponseDto]

Plugin filters

id pydantic-field 

id: StrictStr

Plugin ID

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 
112
113
114
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
142
143
@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(
        {
            "actions": [
                PluginActionResponseDto.from_dict(_item) for _item in obj["actions"]
            ]
            if obj.get("actions") is not None
            else None,
            "author": obj.get("author"),
            "createdAt": obj.get("createdAt"),
            "description": obj.get("description"),
            "filters": [
                PluginFilterResponseDto.from_dict(_item) for _item in obj["filters"]
            ]
            if obj.get("filters") is not None
            else None,
            "id": obj.get("id"),
            "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 
74
75
76
77
@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))

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 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
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 actions (list)
    _items = []
    if self.actions:
        for _item_actions in self.actions:
            if _item_actions:
                _items.append(_item_actions.to_dict())
        _dict["actions"] = _items
    # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
    _items = []
    if self.filters:
        for _item_filters in self.filters:
            if _item_filters:
                _items.append(_item_filters.to_dict())
        _dict["filters"] = _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 
69
70
71
72
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(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 
65
66
67
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))