Skip to content

incident_io_client.models.custom_fields_v1_update_request_body

CustomFieldsV1UpdateRequestBody

Example

{'description': 'Which team is impacted by this issue', 'name': 'Affected Team', 'required': 'never', 'required_v2': 'never', 'show_before_closure': True, 'show_before_creation': True, 'show_before_update': True, 'show_in_announcement_post': True}

Attributes:

Name Type Description
description str

Description of the custom field Example: Which team is impacted by this issue.
name str

Human readable name for the custom field Example: Affected Team.
show_before_closure bool

Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting. Example: True.
show_before_creation bool

Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required. Example: True.
show_before_update bool

Whether a custom field should be shown in the incident update modal. Example: True.
required Union[Unset, CustomFieldsV1UpdateRequestBodyRequired]

When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead]. Example: never.
required_v2 Union[Unset, CustomFieldsV1UpdateRequestBodyRequiredV2]

When this custom field must be set during the incident lifecycle. Example: never.
show_in_announcement_post Union[Unset, bool]

Whether a custom field should be shown in the list of fields as part of the announcement post when set. Example: True.
Source code in incident_io_client/models/custom_fields_v1_update_request_body.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 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
 98
 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
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
@_attrs_define
class CustomFieldsV1UpdateRequestBody:
    """
    Example:
        {'description': 'Which team is impacted by this issue', 'name': 'Affected Team', 'required': 'never',
            'required_v2': 'never', 'show_before_closure': True, 'show_before_creation': True, 'show_before_update': True,
            'show_in_announcement_post': True}

    Attributes:
        description (str): Description of the custom field Example: Which team is impacted by this issue.
        name (str): Human readable name for the custom field Example: Affected Team.
        show_before_closure (bool): Whether a custom field should be shown in the incident resolve modal. If this custom
            field is required before resolution, but no value has been set for it, the field will be shown in the resolve
            modal whatever the value of this setting. Example: True.
        show_before_creation (bool): Whether a custom field should be shown in the incident creation modal. This must be
            true if the field is always required. Example: True.
        show_before_update (bool): Whether a custom field should be shown in the incident update modal. Example: True.
        required (Union[Unset, CustomFieldsV1UpdateRequestBodyRequired]): When this custom field must be set during the
            incident lifecycle. [DEPRECATED: please use required_v2 instead]. Example: never.
        required_v2 (Union[Unset, CustomFieldsV1UpdateRequestBodyRequiredV2]): When this custom field must be set during
            the incident lifecycle. Example: never.
        show_in_announcement_post (Union[Unset, bool]): Whether a custom field should be shown in the list of fields as
            part of the announcement post when set. Example: True.
    """

    description: str
    name: str
    show_before_closure: bool
    show_before_creation: bool
    show_before_update: bool
    required: Union[Unset, CustomFieldsV1UpdateRequestBodyRequired] = UNSET
    required_v2: Union[Unset, CustomFieldsV1UpdateRequestBodyRequiredV2] = UNSET
    show_in_announcement_post: Union[Unset, bool] = UNSET
    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)

    def to_dict(self) -> Dict[str, Any]:
        description = self.description

        name = self.name

        show_before_closure = self.show_before_closure

        show_before_creation = self.show_before_creation

        show_before_update = self.show_before_update

        required: Union[Unset, str] = UNSET
        if not isinstance(self.required, Unset):
            required = self.required.value

        required_v2: Union[Unset, str] = UNSET
        if not isinstance(self.required_v2, Unset):
            required_v2 = self.required_v2.value

        show_in_announcement_post = self.show_in_announcement_post

        field_dict: Dict[str, Any] = {}
        field_dict.update(self.additional_properties)
        field_dict.update(
            {
                "description": description,
                "name": name,
                "show_before_closure": show_before_closure,
                "show_before_creation": show_before_creation,
                "show_before_update": show_before_update,
            }
        )
        if required is not UNSET:
            field_dict["required"] = required
        if required_v2 is not UNSET:
            field_dict["required_v2"] = required_v2
        if show_in_announcement_post is not UNSET:
            field_dict["show_in_announcement_post"] = show_in_announcement_post

        return field_dict

    @classmethod
    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
        d = src_dict.copy()
        description = d.pop("description")

        name = d.pop("name")

        show_before_closure = d.pop("show_before_closure")

        show_before_creation = d.pop("show_before_creation")

        show_before_update = d.pop("show_before_update")

        _required = d.pop("required", UNSET)
        required: Union[Unset, CustomFieldsV1UpdateRequestBodyRequired]
        if isinstance(_required, Unset):
            required = UNSET
        else:
            required = CustomFieldsV1UpdateRequestBodyRequired(_required)

        _required_v2 = d.pop("required_v2", UNSET)
        required_v2: Union[Unset, CustomFieldsV1UpdateRequestBodyRequiredV2]
        if isinstance(_required_v2, Unset):
            required_v2 = UNSET
        else:
            required_v2 = CustomFieldsV1UpdateRequestBodyRequiredV2(_required_v2)

        show_in_announcement_post = d.pop("show_in_announcement_post", UNSET)

        custom_fields_v1_update_request_body = cls(
            description=description,
            name=name,
            show_before_closure=show_before_closure,
            show_before_creation=show_before_creation,
            show_before_update=show_before_update,
            required=required,
            required_v2=required_v2,
            show_in_announcement_post=show_in_announcement_post,
        )

        custom_fields_v1_update_request_body.additional_properties = d
        return custom_fields_v1_update_request_body

    @property
    def additional_keys(self) -> List[str]:
        return list(self.additional_properties.keys())

    def __getitem__(self, key: str) -> Any:
        return self.additional_properties[key]

    def __setitem__(self, key: str, value: Any) -> None:
        self.additional_properties[key] = value

    def __delitem__(self, key: str) -> None:
        del self.additional_properties[key]

    def __contains__(self, key: str) -> bool:
        return key in self.additional_properties