Skip to content

Mutations

This is a module containing: Monday mutation tasks

add_file_to_column(item_id, column_id, file, monday_credentials, return_fields=None) async

Add a file to a column value.

Parameters:

Name Type Description Default
item_id int

The item to add the file to.

required
column_id str

The column to add the file to.

required
file datetime

The file to upload.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
@task
async def add_file_to_column(
    item_id: int,
    column_id: str,
    file: datetime,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add a file to a column value.

    Args:
        item_id: The item to add the file to.
        column_id: The column to add the file to.
        file: The file to upload.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_file_to_column(
        **strip_kwargs(
            item_id=item_id,
            column_id=column_id,
            file=file,
        )
    )

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

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

add_file_to_column_uploaded_by(item_id, column_id, file, monday_credentials, return_fields=None) async

Add a file to a column value.

Parameters:

Name Type Description Default
item_id int

The item to add the file to.

required
column_id str

The column to add the file to.

required
file datetime

The file to upload.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
@task
async def add_file_to_column_uploaded_by(
    item_id: int,
    column_id: str,
    file: datetime,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add a file to a column value.

    Args:
        item_id: The item to add the file to.
        column_id: The column to add the file to.
        file: The file to upload.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_file_to_column(
        **strip_kwargs(
            item_id=item_id,
            column_id=column_id,
            file=file,
        )
    ).uploaded_by(**strip_kwargs())

    op_stack = (
        "add_file_to_column",
        "uploaded_by",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

add_file_to_update(update_id, file, monday_credentials, return_fields=None) async

Add a file to an update.

Parameters:

Name Type Description Default
update_id int

The update to add the file to.

required
file datetime

The file to upload.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
@task
async def add_file_to_update(
    update_id: int,
    file: datetime,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add a file to an update.

    Args:
        update_id: The update to add the file to.
        file: The file to upload.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_file_to_update(
        **strip_kwargs(
            update_id=update_id,
            file=file,
        )
    )

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

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

add_file_to_update_uploaded_by(update_id, file, monday_credentials, return_fields=None) async

Add a file to an update.

Parameters:

Name Type Description Default
update_id int

The update to add the file to.

required
file datetime

The file to upload.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
@task
async def add_file_to_update_uploaded_by(
    update_id: int,
    file: datetime,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add a file to an update.

    Args:
        update_id: The update to add the file to.
        file: The file to upload.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_file_to_update(
        **strip_kwargs(
            update_id=update_id,
            file=file,
        )
    ).uploaded_by(**strip_kwargs())

    op_stack = (
        "add_file_to_update",
        "uploaded_by",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

add_subscribers_to_board(board_id, user_ids, monday_credentials, kind='subscriber', return_fields=None) async

Add subscribers to a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a board.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind BoardSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
@task
async def add_subscribers_to_board(
    board_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.BoardSubscriberKind = "subscriber",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add subscribers to a board.

    Args:
        board_id: The board's unique identifier.
        user_ids: User ids to subscribe to a board.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_subscribers_to_board(
        **strip_kwargs(
            board_id=board_id,
            user_ids=user_ids,
            kind=kind,
        )
    )

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

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

add_subscribers_to_board_account(board_id, user_ids, monday_credentials, kind='subscriber', return_fields=None) async

Add subscribers to a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a board.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind BoardSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
@task
async def add_subscribers_to_board_account(
    board_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.BoardSubscriberKind = "subscriber",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add subscribers to a board.

    Args:
        board_id: The board's unique identifier.
        user_ids: User ids to subscribe to a board.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_subscribers_to_board(
        **strip_kwargs(
            board_id=board_id,
            user_ids=user_ids,
            kind=kind,
        )
    ).account(**strip_kwargs())

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

add_subscribers_to_board_teams(board_id, user_ids, monday_credentials, kind='subscriber', ids=None, return_fields=None) async

Add subscribers to a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a board.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind BoardSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
ids Iterable[int]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
@task
async def add_subscribers_to_board_teams(
    board_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.BoardSubscriberKind = "subscriber",
    ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add subscribers to a board.

    Args:
        board_id: The board's unique identifier.
        user_ids: User ids to subscribe to a board.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_subscribers_to_board(
        **strip_kwargs(
            board_id=board_id,
            user_ids=user_ids,
            kind=kind,
        )
    ).teams(
        **strip_kwargs(
            ids=ids,
        )
    )

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

add_teams_to_workspace(workspace_id, team_ids, monday_credentials, return_fields=None) async

Add teams to a workspace.

Parameters:

Name Type Description Default
workspace_id int

The workspace's unique identifier.

required
team_ids Iterable[int]

Team ids to subscribe to a workspace.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
@task
async def add_teams_to_workspace(
    workspace_id: int,
    team_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add teams to a workspace.

    Args:
        workspace_id: The workspace's unique identifier.
        team_ids: Team ids to subscribe to a workspace.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_teams_to_workspace(
        **strip_kwargs(
            workspace_id=workspace_id,
            team_ids=team_ids,
        )
    )

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

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

add_teams_to_workspace_users(workspace_id, team_ids, monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, return_fields=None) async

Add teams to a workspace.

Parameters:

Name Type Description Default
workspace_id int

The workspace's unique identifier.

required
team_ids Iterable[int]

Team ids to subscribe to a workspace.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

None.

None
kind UserKind

None.

None
newest_first bool

None.

None
limit int

None.

None
emails Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
@task
async def add_teams_to_workspace_users(
    workspace_id: int,
    team_ids: Iterable[int],
    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]:
    """
    Add teams to a workspace.

    Args:
        workspace_id: The workspace's unique identifier.
        team_ids: Team ids to subscribe to a workspace.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        kind: None.
        newest_first: None.
        limit: None.
        emails: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_teams_to_workspace(
        **strip_kwargs(
            workspace_id=workspace_id,
            team_ids=team_ids,
        )
    ).users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    )

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

add_users_to_workspace(workspace_id, user_ids, monday_credentials, kind='subscriber', return_fields=None) async

Add users to a workspace.

Parameters:

Name Type Description Default
workspace_id int

The workspace's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a workspace.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind WorkspaceSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
@task
async def add_users_to_workspace(
    workspace_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.WorkspaceSubscriberKind = "subscriber",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add users to a workspace.

    Args:
        workspace_id: The workspace's unique identifier.
        user_ids: User ids to subscribe to a workspace.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_users_to_workspace(
        **strip_kwargs(
            workspace_id=workspace_id,
            user_ids=user_ids,
            kind=kind,
        )
    )

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

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

add_users_to_workspace_account(workspace_id, user_ids, monday_credentials, kind='subscriber', return_fields=None) async

Add users to a workspace.

Parameters:

Name Type Description Default
workspace_id int

The workspace's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a workspace.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind WorkspaceSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
@task
async def add_users_to_workspace_account(
    workspace_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.WorkspaceSubscriberKind = "subscriber",
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add users to a workspace.

    Args:
        workspace_id: The workspace's unique identifier.
        user_ids: User ids to subscribe to a workspace.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_users_to_workspace(
        **strip_kwargs(
            workspace_id=workspace_id,
            user_ids=user_ids,
            kind=kind,
        )
    ).account(**strip_kwargs())

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

add_users_to_workspace_teams(workspace_id, user_ids, monday_credentials, kind='subscriber', ids=None, return_fields=None) async

Add users to a workspace.

Parameters:

Name Type Description Default
workspace_id int

The workspace's unique identifier.

required
user_ids Iterable[int]

User ids to subscribe to a workspace.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
kind WorkspaceSubscriberKind

Subscribers kind (subscriber / owner).

'subscriber'
ids Iterable[int]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
@task
async def add_users_to_workspace_teams(
    workspace_id: int,
    user_ids: Iterable[int],
    monday_credentials: MondayCredentials,
    kind: graphql_schema.WorkspaceSubscriberKind = "subscriber",
    ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Add users to a workspace.

    Args:
        workspace_id: The workspace's unique identifier.
        user_ids: User ids to subscribe to a workspace.
        monday_credentials: Credentials to use for authentication with Monday.
        kind: Subscribers kind (subscriber / owner).
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_users_to_workspace(
        **strip_kwargs(
            workspace_id=workspace_id,
            user_ids=user_ids,
            kind=kind,
        )
    ).teams(
        **strip_kwargs(
            ids=ids,
        )
    )

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

archive_board(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
@task
async def archive_board(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    )

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

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

archive_board_activity_logs(board_id, monday_credentials, limit=25, page=1, user_ids=None, column_ids=None, group_ids=None, item_ids=None, from_=None, to=None, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

None.

25
page int

None.

1
user_ids Iterable[int]

None.

None
column_ids Iterable[str]

None.

None
group_ids Iterable[str]

None.

None
item_ids Iterable[int]

None.

None
from_ datetime

None.

None
to datetime

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
@task
async def archive_board_activity_logs(
    board_id: int,
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    user_ids: Iterable[int] = None,
    column_ids: Iterable[str] = None,
    group_ids: Iterable[str] = None,
    item_ids: Iterable[int] = None,
    from_: datetime = None,
    to: datetime = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: None.
        page: None.
        user_ids: None.
        column_ids: None.
        group_ids: None.
        item_ids: None.
        from_: None.
        to: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(**strip_kwargs(board_id=board_id,)).activity_logs(
        **strip_kwargs(
            limit=limit,
            page=page,
            user_ids=user_ids,
            column_ids=column_ids,
            group_ids=group_ids,
            item_ids=item_ids,
            from_=from_,
            to=to,
        )
    )

    op_stack = (
        "archive_board",
        "activity_logs",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_columns(board_id, monday_credentials, ids=None, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
@task
async def archive_board_columns(
    board_id: int,
    monday_credentials: MondayCredentials,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(**strip_kwargs(board_id=board_id,)).columns(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "archive_board",
        "columns",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_creator(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
@task
async def archive_board_creator(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "archive_board",
        "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["archive_board"]["creator"]

archive_board_groups(board_id, monday_credentials, ids=None, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
@task
async def archive_board_groups(
    board_id: int,
    monday_credentials: MondayCredentials,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(**strip_kwargs(board_id=board_id,)).groups(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "archive_board",
        "groups",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_items(board_id, monday_credentials, ids=None, limit=None, page=1, newest_first=None, exclude_nonactive=None, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

None.

None
limit int

None.

None
page int

None.

1
newest_first bool

None.

None
exclude_nonactive bool

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
@task
async def archive_board_items(
    board_id: int,
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    limit: int = None,
    page: int = 1,
    newest_first: bool = None,
    exclude_nonactive: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        limit: None.
        page: None.
        newest_first: None.
        exclude_nonactive: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(**strip_kwargs(board_id=board_id,)).items(
        **strip_kwargs(
            ids=ids,
            limit=limit,
            page=page,
            newest_first=newest_first,
            exclude_nonactive=exclude_nonactive,
        )
    )

    op_stack = (
        "archive_board",
        "items",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_owner(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
@task
async def archive_board_owner(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).owner(**strip_kwargs())

    op_stack = (
        "archive_board",
        "owner",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_owners(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
@task
async def archive_board_owners(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).owners(**strip_kwargs())

    op_stack = (
        "archive_board",
        "owners",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_subscribers(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
@task
async def archive_board_subscribers(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "archive_board",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_tags(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
@task
async def archive_board_tags(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).tags(**strip_kwargs())

    op_stack = (
        "archive_board",
        "tags",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_top_group(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
@task
async def archive_board_top_group(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).top_group(**strip_kwargs())

    op_stack = (
        "archive_board",
        "top_group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

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

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
@task
async def archive_board_updates(
    board_id: int,
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

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

    op_stack = (
        "archive_board",
        "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["archive_board"]["updates"]

archive_board_views(board_id, monday_credentials, ids=None, type=None, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

None.

None
type str

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
@task
async def archive_board_views(
    board_id: int,
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    type: str = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        type: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(**strip_kwargs(board_id=board_id,)).views(
        **strip_kwargs(
            ids=ids,
            type=type,
        )
    )

    op_stack = (
        "archive_board",
        "views",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_board_workspace(board_id, monday_credentials, return_fields=None) async

Archive a board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
@task
async def archive_board_workspace(
    board_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive a board.

    Args:
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_board(
        **strip_kwargs(
            board_id=board_id,
        )
    ).workspace(**strip_kwargs())

    op_stack = (
        "archive_board",
        "workspace",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_group(board_id, group_id, monday_credentials, return_fields=None) async

Archives a group in a specific board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
group_id str

The group's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
@task
async def archive_group(
    board_id: int,
    group_id: str,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archives a group in a specific board.

    Args:
        board_id: The board's unique identifier.
        group_id: The group's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_group(
        **strip_kwargs(
            board_id=board_id,
            group_id=group_id,
        )
    )

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

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

archive_group_items(board_id, group_id, monday_credentials, ids=None, limit=None, page=1, newest_first=None, exclude_nonactive=None, return_fields=None) async

Archives a group in a specific board.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
group_id str

The group's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

None.

None
limit int

None.

None
page int

None.

1
newest_first bool

None.

None
exclude_nonactive bool

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
@task
async def archive_group_items(
    board_id: int,
    group_id: str,
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    limit: int = None,
    page: int = 1,
    newest_first: bool = None,
    exclude_nonactive: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archives a group in a specific board.

    Args:
        board_id: The board's unique identifier.
        group_id: The group's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        limit: None.
        page: None.
        newest_first: None.
        exclude_nonactive: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_group(
        **strip_kwargs(
            board_id=board_id,
            group_id=group_id,
        )
    ).items(
        **strip_kwargs(
            ids=ids,
            limit=limit,
            page=page,
            newest_first=newest_first,
            exclude_nonactive=exclude_nonactive,
        )
    )

    op_stack = (
        "archive_group",
        "items",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_item(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
@task
async def archive_item(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    )

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

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

archive_item_assets(monday_credentials, item_id=None, assets_source=None, column_ids=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
assets_source AssetsSource

None.

None
column_ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
@task
async def archive_item_assets(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        assets_source: None.
        column_ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(**strip_kwargs(item_id=item_id,)).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "archive_item",
        "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["archive_item"]["assets"]

archive_item_board(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
@task
async def archive_item_board(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "archive_item",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_item_column_values(monday_credentials, item_id=None, ids=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
@task
async def archive_item_column_values(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(**strip_kwargs(item_id=item_id,)).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "archive_item",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_item_creator(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
@task
async def archive_item_creator(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "archive_item",
        "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["archive_item"]["creator"]

archive_item_group(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
@task
async def archive_item_group(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "archive_item",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_item_subitems(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
@task
async def archive_item_subitems(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    ).subitems(**strip_kwargs())

    op_stack = (
        "archive_item",
        "subitems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

archive_item_subscribers(monday_credentials, item_id=None, return_fields=None) async

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
@task
async def archive_item_subscribers(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.archive_item(
        **strip_kwargs(
            item_id=item_id,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "archive_item",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

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

Archive an item.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
@task
async def archive_item_updates(
    monday_credentials: MondayCredentials,
    item_id: int = None,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Archive an item.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

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

    op_stack = (
        "archive_item",
        "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["archive_item"]["updates"]

change_column_metadata(column_id, board_id, monday_credentials, column_property=None, value=None, return_fields=None) async

Change a column's properties.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
column_property ColumnProperty

The property name of the column to be changed (title / description).

None
value str

The new description of the column.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
@task
async def change_column_metadata(
    column_id: str,
    board_id: int,
    monday_credentials: MondayCredentials,
    column_property: graphql_schema.ColumnProperty = None,
    value: str = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change a column's properties.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        column_property: The property name of the column to be changed (title /
            description).
        value: The new description of the column.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_metadata(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            column_property=column_property,
            value=value,
        )
    )

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

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

change_column_title(column_id, board_id, title, monday_credentials, return_fields=None) async

Change a column's title.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
title str

The new title of the column.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
@task
async def change_column_title(
    column_id: str,
    board_id: int,
    title: str,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change a column's title.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        title: The new title of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_title(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            title=title,
        )
    )

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

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

change_column_value(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
@task
async def change_column_value(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown labels if they're
            missing. (Requires permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    )

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

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

change_column_value_assets(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, assets_source=None, column_ids=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
assets_source AssetsSource

None.

None
column_ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
@task
async def change_column_value_assets(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        assets_source: None.
        column_ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "change_column_value",
        "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["change_column_value"]["assets"]

change_column_value_board(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
@task
async def change_column_value_board(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "change_column_value",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_column_value_column_values(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, ids=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
@task
async def change_column_value_column_values(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "change_column_value",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_column_value_creator(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
@task
async def change_column_value_creator(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "change_column_value",
        "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["change_column_value"]["creator"]

change_column_value_group(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
@task
async def change_column_value_group(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "change_column_value",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_column_value_subitems(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
@task
async def change_column_value_subitems(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subitems(**strip_kwargs())

    op_stack = (
        "change_column_value",
        "subitems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_column_value_subscribers(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
@task
async def change_column_value_subscribers(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "change_column_value",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_column_value_updates(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, limit=25, page=1, return_fields=None) async

Change an item's column value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value datetime

The new value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
@task
async def change_column_value_updates(
    column_id: str,
    board_id: int,
    value: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown
            labels if they're missing. (Requires permission to change
            board structure).
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    )

    op_stack = (
        "change_column_value",
        "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["change_column_value"]["updates"]

change_multiple_column_values(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
@task
async def change_multiple_column_values(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown labels if they're
            missing. (Requires permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    )

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

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

change_multiple_column_values_assets(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, assets_source=None, column_ids=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
assets_source AssetsSource

None.

None
column_ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
@task
async def change_multiple_column_values_assets(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        assets_source: None.
        column_ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "change_multiple_column_values",
        "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["change_multiple_column_values"]["assets"]

change_multiple_column_values_board(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
@task
async def change_multiple_column_values_board(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "change_multiple_column_values",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_multiple_column_values_column_values(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, ids=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
@task
async def change_multiple_column_values_column_values(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "change_multiple_column_values",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_multiple_column_values_creator(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
@task
async def change_multiple_column_values_creator(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "change_multiple_column_values",
        "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["change_multiple_column_values"]["creator"]

change_multiple_column_values_group(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
@task
async def change_multiple_column_values_group(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "change_multiple_column_values",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_multiple_column_values_subitems(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
@task
async def change_multiple_column_values_subitems(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subitems(**strip_kwargs())

    op_stack = (
        "change_multiple_column_values",
        "subitems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_multiple_column_values_subscribers(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
@task
async def change_multiple_column_values_subscribers(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "change_multiple_column_values",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_multiple_column_values_updates(board_id, column_values, monday_credentials, item_id=None, create_labels_if_missing=None, limit=25, page=1, return_fields=None) async

Changes the column values of a specific item.

Parameters:

Name Type Description Default
board_id int

The board's unique identifier.

required
column_values datetime

The column values updates.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
@task
async def change_multiple_column_values_updates(
    board_id: int,
    column_values: datetime,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Changes the column values of a specific item.

    Args:
        board_id: The board's unique identifier.
        column_values: The column values updates.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_multiple_column_values(
        **strip_kwargs(
            board_id=board_id,
            column_values=column_values,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    )

    op_stack = (
        "change_multiple_column_values",
        "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["change_multiple_column_values"]["updates"]

change_simple_column_value(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
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
@task
async def change_simple_column_value(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create Status/Dropdown labels if they're
            missing. (Requires permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    )

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

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

change_simple_column_value_assets(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, assets_source=None, column_ids=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
assets_source AssetsSource

None.

None
column_ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
@task
async def change_simple_column_value_assets(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        assets_source: None.
        column_ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "change_simple_column_value",
        "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["change_simple_column_value"]["assets"]

change_simple_column_value_board(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
 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
@task
async def change_simple_column_value_board(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "change_simple_column_value",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_simple_column_value_column_values(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, ids=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
@task
async def change_simple_column_value_column_values(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "change_simple_column_value",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_simple_column_value_creator(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
@task
async def change_simple_column_value_creator(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "change_simple_column_value",
        "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["change_simple_column_value"]["creator"]

change_simple_column_value_group(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
@task
async def change_simple_column_value_group(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "change_simple_column_value",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_simple_column_value_subitems(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
@task
async def change_simple_column_value_subitems(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subitems(**strip_kwargs())

    op_stack = (
        "change_simple_column_value",
        "subitems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_simple_column_value_subscribers(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
@task
async def change_simple_column_value_subscribers(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "change_simple_column_value",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

change_simple_column_value_updates(column_id, board_id, value, monday_credentials, item_id=None, create_labels_if_missing=None, limit=25, page=1, return_fields=None) async

Change an item's column with simple value.

Parameters:

Name Type Description Default
column_id str

The column's unique identifier.

required
board_id int

The board's unique identifier.

required
value str

The new simple value of the column.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
item_id int

The item's unique identifier.

None
create_labels_if_missing bool

Create Status/Dropdown labels if they're missing. (Requires permission to change board structure).

None
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
@task
async def change_simple_column_value_updates(
    column_id: str,
    board_id: int,
    value: str,
    monday_credentials: MondayCredentials,
    item_id: int = None,
    create_labels_if_missing: bool = None,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Change an item's column with simple value.

    Args:
        column_id: The column's unique identifier.
        board_id: The board's unique identifier.
        value: The new simple value of the column.
        monday_credentials: Credentials to use for authentication with Monday.
        item_id: The item's unique identifier.
        create_labels_if_missing: Create
            Status/Dropdown labels if they're missing. (Requires
            permission to change board structure).
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.change_simple_column_value(
        **strip_kwargs(
            column_id=column_id,
            board_id=board_id,
            value=value,
            item_id=item_id,
            create_labels_if_missing=create_labels_if_missing,
        )
    ).updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    )

    op_stack = (
        "change_simple_column_value",
        "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["change_simple_column_value"]["updates"]

clear_item_updates(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
@task
async def clear_item_updates(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    )

    op_stack = ("clear_item_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["clear_item_updates"]

clear_item_updates_assets(item_id, monday_credentials, assets_source=None, column_ids=None, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
assets_source AssetsSource

None.

None
column_ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
@task
async def clear_item_updates_assets(
    item_id: int,
    monday_credentials: MondayCredentials,
    assets_source: graphql_schema.AssetsSource = None,
    column_ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        assets_source: None.
        column_ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(**strip_kwargs(item_id=item_id,)).assets(
        **strip_kwargs(
            assets_source=assets_source,
            column_ids=column_ids,
        )
    )

    op_stack = (
        "clear_item_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["clear_item_updates"]["assets"]

clear_item_updates_board(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
@task
async def clear_item_updates_board(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).board(**strip_kwargs())

    op_stack = (
        "clear_item_updates",
        "board",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

clear_item_updates_column_values(item_id, monday_credentials, ids=None, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
@task
async def clear_item_updates_column_values(
    item_id: int,
    monday_credentials: MondayCredentials,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).column_values(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "clear_item_updates",
        "column_values",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

clear_item_updates_creator(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
@task
async def clear_item_updates_creator(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "clear_item_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["clear_item_updates"]["creator"]

clear_item_updates_group(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
@task
async def clear_item_updates_group(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).group(**strip_kwargs())

    op_stack = (
        "clear_item_updates",
        "group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

clear_item_updates_subitems(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
@task
async def clear_item_updates_subitems(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).subitems(**strip_kwargs())

    op_stack = (
        "clear_item_updates",
        "subitems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

clear_item_updates_subscribers(item_id, monday_credentials, return_fields=None) async

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
@task
async def clear_item_updates_subscribers(
    item_id: int,
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.clear_item_updates(
        **strip_kwargs(
            item_id=item_id,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "clear_item_updates",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

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

Clear an item's updates.

Parameters:

Name Type Description Default
item_id int

The item's unique identifier.

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
@task
async def clear_item_updates_updates(
    item_id: int,
    monday_credentials: MondayCredentials,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Clear an item's updates.

    Args:
        item_id: The item's unique identifier.
        monday_credentials: Credentials to use for authentication with Monday.
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

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

    op_stack = (
        "clear_item_updates",
        "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["clear_item_updates"]["updates"]

complexity(monday_credentials, return_fields=None) async

Get the complexity data of your mutations.

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/mutation/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
@task
async def complexity(
    monday_credentials: MondayCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get the complexity data of your mutations.

    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/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.complexity(**strip_kwargs())

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

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

create_board(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
@task
async def create_board(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    )

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

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

create_board_activity_logs(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, limit=25, page=1, user_ids=None, column_ids=None, group_ids=None, item_ids=None, from_=None, to=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
limit int

None.

25
page int

None.

1
user_ids Iterable[int]

None.

None
column_ids Iterable[str]

None.

None
group_ids Iterable[str]

None.

None
item_ids Iterable[int]

None.

None
from_ datetime

None.

None
to datetime

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
@task
async def create_board_activity_logs(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    limit: int = 25,
    page: int = 1,
    user_ids: Iterable[int] = None,
    column_ids: Iterable[str] = None,
    group_ids: Iterable[str] = None,
    item_ids: Iterable[int] = None,
    from_: datetime = None,
    to: datetime = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        limit: None.
        page: None.
        user_ids: None.
        column_ids: None.
        group_ids: None.
        item_ids: None.
        from_: None.
        to: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).activity_logs(
        **strip_kwargs(
            limit=limit,
            page=page,
            user_ids=user_ids,
            column_ids=column_ids,
            group_ids=group_ids,
            item_ids=item_ids,
            from_=from_,
            to=to,
        )
    )

    op_stack = (
        "create_board",
        "activity_logs",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_columns(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
@task
async def create_board_columns(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).columns(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "create_board",
        "columns",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_creator(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
@task
async def create_board_creator(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).creator(**strip_kwargs())

    op_stack = (
        "create_board",
        "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["create_board"]["creator"]

create_board_groups(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
ids Iterable[str]

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
@task
async def create_board_groups(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    ids: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        ids: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).groups(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = (
        "create_board",
        "groups",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_items(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, ids=None, limit=None, page=1, newest_first=None, exclude_nonactive=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
ids Iterable[int]

None.

None
limit int

None.

None
page int

None.

1
newest_first bool

None.

None
exclude_nonactive bool

None.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
@task
async def create_board_items(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    ids: Iterable[int] = None,
    limit: int = None,
    page: int = 1,
    newest_first: bool = None,
    exclude_nonactive: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        ids: None.
        limit: None.
        page: None.
        newest_first: None.
        exclude_nonactive: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).items(
        **strip_kwargs(
            ids=ids,
            limit=limit,
            page=page,
            newest_first=newest_first,
            exclude_nonactive=exclude_nonactive,
        )
    )

    op_stack = (
        "create_board",
        "items",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_owner(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
@task
async def create_board_owner(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).owner(**strip_kwargs())

    op_stack = (
        "create_board",
        "owner",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_owners(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
@task
async def create_board_owners(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).owners(**strip_kwargs())

    op_stack = (
        "create_board",
        "owners",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_subscribers(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
@task
async def create_board_subscribers(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).subscribers(**strip_kwargs())

    op_stack = (
        "create_board",
        "subscribers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_tags(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
@task
async def create_board_tags(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).tags(**strip_kwargs())

    op_stack = (
        "create_board",
        "tags",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_top_group(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
@task
async def create_board_top_group(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).top_group(**strip_kwargs())

    op_stack = (
        "create_board",
        "top_group",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

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

create_board_updates(board_name, board_kind, monday_credentials, folder_id=None, workspace_id=None, template_id=None, board_owner_ids=None, board_subscriber_ids=None, limit=25, page=1, return_fields=None) async

Create a new board.

Parameters:

Name Type Description Default
board_name str

The board's name.

required
board_kind BoardKind

The board's kind (public / private / share).

required
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
folder_id int

Optional board folder id.

None
workspace_id int

Optional workspace id.

None
template_id int

Optional board template id.

None
board_owner_ids Iterable[int]

Optional board owner ids.

None
board_subscriber_ids Iterable[int]

Optional board subscriber ids.

None
limit int

None.

25
page int

None.

1
return_fields Iterable[str]

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

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/mutations.py
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
@task
async def create_board_updates(
    board_name: str,
    board_kind: graphql_schema.BoardKind,
    monday_credentials: MondayCredentials,
    folder_id: int = None,
    workspace_id: int = None,
    template_id: int = None,
    board_owner_ids: Iterable[int] = None,
    board_subscriber_ids: Iterable[int] = None,
    limit: int = 25,
    page: int = 1,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Create a new board.

    Args:
        board_name: The board's name.
        board_kind: The board's kind (public / private / share).
        monday_credentials: Credentials to use for authentication with Monday.
        folder_id: Optional board folder id.
        workspace_id: Optional workspace id.
        template_id: Optional board template id.
        board_owner_ids: Optional board owner ids.
        board_subscriber_ids: Optional board subscriber ids.
        limit: None.
        page: None.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_board(
        **strip_kwargs(
            board_name=board_name,
            board_kind=board_kind,
            folder_id=folder_id,
            workspace_id=workspace_id,
            template_id=template_id,
            board_owner_ids=board_owner_ids,
            board_subscriber_ids=board_subscriber_ids,
        )
    ).updates(
        **strip_kwargs(
            limit=limit,
            page=page,
        )
    )

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

    result = await _execute_graphql_op(op, monday_credentials)