Skip to content

Workflow Response Dto

immichpy.client.generated.models.workflow_response_dto.WorkflowResponseDto pydantic-model

Bases: BaseModel

WorkflowResponseDto

Show JSON schema: 
{
  "$defs": {
    "PluginTriggerType": {
      "description": "Trigger type",
      "enum": [
        "AssetCreate",
        "PersonRecognized"
      ],
      "title": "PluginTriggerType",
      "type": "string"
    },
    "WorkflowActionResponseDto": {
      "description": "WorkflowActionResponseDto",
      "properties": {
        "actionConfig": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Action configuration",
          "title": "Actionconfig"
        },
        "id": {
          "description": "Action ID",
          "title": "Id",
          "type": "string"
        },
        "order": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "integer"
            }
          ],
          "description": "Action order",
          "title": "Order"
        },
        "pluginActionId": {
          "description": "Plugin action ID",
          "title": "Pluginactionid",
          "type": "string"
        },
        "workflowId": {
          "description": "Workflow ID",
          "title": "Workflowid",
          "type": "string"
        }
      },
      "required": [
        "actionConfig",
        "id",
        "order",
        "pluginActionId",
        "workflowId"
      ],
      "title": "WorkflowActionResponseDto",
      "type": "object"
    },
    "WorkflowFilterResponseDto": {
      "description": "WorkflowFilterResponseDto",
      "properties": {
        "filterConfig": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "description": "Filter configuration",
          "title": "Filterconfig"
        },
        "id": {
          "description": "Filter ID",
          "title": "Id",
          "type": "string"
        },
        "order": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "integer"
            }
          ],
          "description": "Filter order",
          "title": "Order"
        },
        "pluginFilterId": {
          "description": "Plugin filter ID",
          "title": "Pluginfilterid",
          "type": "string"
        },
        "workflowId": {
          "description": "Workflow ID",
          "title": "Workflowid",
          "type": "string"
        }
      },
      "required": [
        "filterConfig",
        "id",
        "order",
        "pluginFilterId",
        "workflowId"
      ],
      "title": "WorkflowFilterResponseDto",
      "type": "object"
    }
  },
  "description": "WorkflowResponseDto",
  "properties": {
    "actions": {
      "description": "Workflow actions",
      "items": {
        "$ref": "#/$defs/WorkflowActionResponseDto"
      },
      "title": "Actions",
      "type": "array"
    },
    "createdAt": {
      "description": "Creation date",
      "title": "Createdat",
      "type": "string"
    },
    "description": {
      "description": "Workflow description",
      "title": "Description",
      "type": "string"
    },
    "enabled": {
      "description": "Workflow enabled",
      "title": "Enabled",
      "type": "boolean"
    },
    "filters": {
      "description": "Workflow filters",
      "items": {
        "$ref": "#/$defs/WorkflowFilterResponseDto"
      },
      "title": "Filters",
      "type": "array"
    },
    "id": {
      "description": "Workflow ID",
      "title": "Id",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Workflow name",
      "title": "Name"
    },
    "ownerId": {
      "description": "Owner user ID",
      "title": "Ownerid",
      "type": "string"
    },
    "triggerType": {
      "$ref": "#/$defs/PluginTriggerType",
      "description": "Workflow trigger type"
    }
  },
  "required": [
    "actions",
    "createdAt",
    "description",
    "enabled",
    "filters",
    "id",
    "name",
    "ownerId",
    "triggerType"
  ],
  "title": "WorkflowResponseDto",
  "type": "object"
}

Config:

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

Fields:

actions pydantic-field 

actions: List[WorkflowActionResponseDto]

Workflow actions

created_at pydantic-field 

created_at: StrictStr

Creation date

description pydantic-field 

description: StrictStr

Workflow description

enabled pydantic-field 

enabled: StrictBool

Workflow enabled

filters pydantic-field 

filters: List[WorkflowFilterResponseDto]

Workflow filters

id pydantic-field 

id: StrictStr

Workflow ID

name pydantic-field 

name: Optional[StrictStr]

Workflow name

owner_id pydantic-field 

owner_id: StrictStr

Owner user ID

trigger_type pydantic-field 

trigger_type: PluginTriggerType

Workflow trigger type

from_dict classmethod 

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

Create an instance of WorkflowResponseDto from a dict

Source code in immichpy/client/generated/models/workflow_response_dto.py 
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
144
145
146
147
148
149
150
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of WorkflowResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "actions": [
                WorkflowActionResponseDto.from_dict(_item)
                for _item in obj["actions"]
            ]
            if obj.get("actions") is not None
            else None,
            "createdAt": obj.get("createdAt"),
            "description": obj.get("description"),
            "enabled": obj.get("enabled"),
            "filters": [
                WorkflowFilterResponseDto.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"),
            "ownerId": obj.get("ownerId"),
            "triggerType": obj.get("triggerType"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of WorkflowResponseDto from a JSON string

Source code in immichpy/client/generated/models/workflow_response_dto.py 
75
76
77
78
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of WorkflowResponseDto 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/workflow_response_dto.py 
 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
111
112
113
114
115
116
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
    # set to None if name (nullable) is None
    # and model_fields_set contains the field
    if self.name is None and "name" in self.model_fields_set:
        _dict["name"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/workflow_response_dto.py 
70
71
72
73
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/workflow_response_dto.py 
66
67
68
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))