Skip to content

Me

This is a module containing: Monday query_me* tasks

query_me(monday_credentials, 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
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/me.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
@task
async def query_me(
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        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.me(**strip_kwargs())

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

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

query_me_account(monday_credentials, return_fields=None) async

The user's account.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

 required
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/me.py 
 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
@task
async def query_me_account(
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The user's account.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        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.me(**strip_kwargs()).account(**strip_kwargs())

    op_stack = (
        "me",
        "account",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

query_me_teams(monday_credentials, ids=None, return_fields=None) async

The teams the user is a member in.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

 required
ids Iterable[int]

A list of teams unique identifiers.

 None
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/me.py 
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
@task
async def query_me_teams(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The teams the user is a member in.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of teams unique identifiers.
        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.me(**strip_kwargs()).teams(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "me",
        "teams",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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