Skip to content

Updates

This is a module containing: Monday query_updates* tasks

query_updates(monday_credentials, limit=25, page=1, return_fields=None) async

Get your data from monday.com.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get, the default is 25.

25
page int

Page number to get, starting at 1.

1
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/updates.py
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
@task
async def query_updates(
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get, the default is 25.
        page: Page number to get, starting at 1.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    )

    op_stack = ("updates",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["updates"]

query_updates_assets(monday_credentials, limit=25, page=1, return_fields=None) async

The update's assets/files.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get, the default is 25.

25
page int

Page number to get, starting at 1.

1
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/updates.py
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
@task
async def query_updates_assets(
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The update's assets/files.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get, the default is 25.
        page: Page number to get, starting at 1.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    ).assets(**strip_kwargs())

    op_stack = (
        "updates",
        "assets",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["updates"]["assets"]

query_updates_creator(monday_credentials, limit=25, page=1, return_fields=None) async

The update's creator.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get, the default is 25.

25
page int

Page number to get, starting at 1.

1
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/updates.py
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
@task
async def query_updates_creator(
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The update's creator.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get, the default is 25.
        page: Page number to get, starting at 1.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "updates",
        "creator",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["updates"]["creator"]

query_updates_replies(monday_credentials, limit=25, page=1, return_fields=None) async

The update's replies.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

Number of items to get, the default is 25.

25
page int

Page number to get, starting at 1.

1
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/updates.py
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
@task
async def query_updates_replies(
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The update's replies.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        limit: Number of items to get, the default is 25.
        page: Page number to get, starting at 1.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    ).replies(**strip_kwargs())

    op_stack = (
        "updates",
        "replies",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["updates"]["replies"]