..
    This file is part of monday-client.

    Copyright (C) 2024 Leet Cyber Security <https://leetcybersecurity.com/>

    monday-client is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    monday-client is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with monday-client. If not, see <https://www.gnu.org/licenses/>.

.. _services_section:

Services
--------

.. attention::

    The services documented below are automatically initialized as part of `MondayClient <monday_client.html>`_ and should be accessed through the `MondayClient <monday_client.html>`_ instance.

.. note::

    The fields parameters in this class's methods directly correspond to monday.com's API GraphQL fields.
    For example, using ``fields='id name owners { id }'`` or ``fields=Fields('id name owners { id }')`` is equivalent to requesting ``id name owners { id }`` in a GraphQL query.

.. seealso::
        Complete documentation of available premade fields in the :ref:`Fields Reference <fields_section_top>`.

.. module:: monday.services

.. _services_section_boards:

Boards
~~~~~~
.. automethod:: monday.services.boards.Boards.query
.. automethod:: monday.services.boards.Boards.get_items
.. automethod:: monday.services.boards.Boards.get_items_by_column_values
.. automethod:: monday.services.boards.Boards.get_column_values
.. automethod:: monday.services.boards.Boards.create
.. automethod:: monday.services.boards.Boards.duplicate
.. automethod:: monday.services.boards.Boards.update
.. automethod:: monday.services.boards.Boards.archive
.. automethod:: monday.services.boards.Boards.delete
.. automethod:: monday.services.boards.Boards.create_column

.. _services_section_groups:

Groups
~~~~~~
.. automethod:: monday.services.groups.Groups.query
.. automethod:: monday.services.groups.Groups.create
.. automethod:: monday.services.groups.Groups.update
.. automethod:: monday.services.groups.Groups.duplicate
.. automethod:: monday.services.groups.Groups.archive
.. automethod:: monday.services.groups.Groups.delete
.. automethod:: monday.services.groups.Groups.get_items_by_name

.. note::

   ``Groups.create(position_relative_method)`` accepts ``'before'`` or ``'after'`` which map internally to the API enums ``before_at``/``after_at``.

.. _services_section_items:

Items
~~~~~
.. automethod:: monday.services.items.Items.query
.. automethod:: monday.services.items.Items.create
.. automethod:: monday.services.items.Items.duplicate
.. automethod:: monday.services.items.Items.move_to_group
.. automethod:: monday.services.items.Items.move_to_board
.. automethod:: monday.services.items.Items.archive
.. automethod:: monday.services.items.Items.delete
.. automethod:: monday.services.items.Items.clear_updates
.. automethod:: monday.services.items.Items.get_column_values
.. automethod:: monday.services.items.Items.change_column_values
.. automethod:: monday.services.items.Items.get_name
.. automethod:: monday.services.items.Items.get_id

.. note::

   ``Items.create(position_relative_method)`` accepts ``'before_at'`` or ``'after_at'`` to align with the underlying API enums.

.. _services_section_subitems:

Subitems
~~~~~~~~
.. automethod:: monday.services.subitems.Subitems.query
.. automethod:: monday.services.subitems.Subitems.create

.. _services_section_users:

Users
~~~~~
.. automethod:: monday.services.users.Users.query

.. _services_section_webhooks:

Webhooks
~~~~~~~~
.. automethod:: monday.services.webhooks.Webhooks.query
.. automethod:: monday.services.webhooks.Webhooks.create
.. automethod:: monday.services.webhooks.Webhooks.delete

.. toctree::
   :maxdepth: 1
   :caption: Related Service Guides

   webhooks