Users

This is a module containing: Monday query_users* tasks

query_users(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, 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
ids	Iterable[int]	A list of users unique identifiers.	None
kind	UserKind	The kind to search users by (all / non_guests / guests / non_pending).	None
newest_first	bool	Get the recently created users at the top of the list.	None
limit	int	Number of users to get.	None
emails	Iterable[str]	A list of users emails.	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/users.py

@task
async def query_users(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the list.
        limit: Number of users to get.
        emails: A list of users emails.
        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.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    )

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

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

query_users_account(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, return_fields=None) async

The user's account.

Parameters:

Name	Type	Description	Default
monday_credentials	MondayCredentials	Credentials to use for authentication with Monday.	required
ids	Iterable[int]	A list of users unique identifiers.	None
kind	UserKind	The kind to search users by (all / non_guests / guests / non_pending).	None
newest_first	bool	Get the recently created users at the top of the list.	None
limit	int	Number of users to get.	None
emails	Iterable[str]	A list of users emails.	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/users.py

@task
async def query_users_account(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The user's account.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the
            list.
        limit: Number of users to get.
        emails: A list of users emails.
        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.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    ).account(**strip_kwargs())

    op_stack = (
        "users",
        "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["users"]["account"]

query_users_teams(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, teams_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 users unique identifiers.	None
kind	UserKind	The kind to search users by (all / non_guests / guests / non_pending).	None
newest_first	bool	Get the recently created users at the top of the list.	None
limit	int	Number of users to get.	None
emails	Iterable[str]	A list of users emails.	None
teams_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/users.py

@task
async def query_users_teams(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    teams_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 users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the
            list.
        limit: Number of users to get.
        emails: A list of users emails.
        teams_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.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    ).teams(
        **strip_kwargs(
            ids=teams_ids,
        )
    )

    op_stack = (
        "users",
        "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["users"]["teams"]