Skip to content

Batch update form request

BatchUpdateFormRequest

Bases: BaseFormItem

A batch of updates to perform on a form. All the specified updates are made or none of them are.

Source code in pygsuite/forms/generated/batch_update_form_request.py 
 8
 9
10
11
12
13
14
15
16
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
class BatchUpdateFormRequest(BaseFormItem):
    """
    A batch of updates to perform on a form. All the specified updates are made or none of them are.
    """

    def __init__(  # noqa: C901
        self,
        include_form_in_response: Optional[bool] = None,
        requests: Optional[List["Request"]] = None,
        write_control: Optional["WriteControl"] = None,
        object_info: Optional[Dict] = None,
    ):
        generated: Dict = {}

        if include_form_in_response is not None:

            generated["includeFormInResponse"] = include_form_in_response
        if requests is not None:
            generated["requests"] = [v._info for v in requests]
        if write_control is not None:

            generated["writeControl"] = write_control._info
        object_info = object_info or generated
        super().__init__(object_info=object_info)

    @property
    def include_form_in_response(self) -> bool:
        return self._info.get("includeFormInResponse")

    @include_form_in_response.setter
    def include_form_in_response(self, value: bool):
        if self._info.get("includeFormInResponse", None) == value:
            return
        self._info["includeFormInResponse"] = value

    @property
    def requests(self) -> List["Request"]:
        return [Request(object_info=v) for v in self._info.get("requests", [])]

    @requests.setter
    def requests(self, value: List["Request"]):
        if self._info.get("requests", None) == value:
            return
        self._info["requests"] = value

    @property
    def write_control(self) -> "WriteControl":
        return WriteControl(object_info=self._info.get("writeControl"))

    @write_control.setter
    def write_control(self, value: "WriteControl"):
        if self._info.get("writeControl", None) == value:
            return
        self._info["writeControl"] = value

    @property
    def wire_format(self) -> dict:
        base = "BatchUpdateForm"
        base = base[0].lower() + base[1:]

        return {base: self._info}