:py:mod:`kavita_client.models.scan_folder_dto`
==============================================

.. py:module:: kavita_client.models.scan_folder_dto

.. autodoc2-docstring:: kavita_client.models.scan_folder_dto
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ScanFolderDto <kavita_client.models.scan_folder_dto.ScanFolderDto>`
     - .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`T <kavita_client.models.scan_folder_dto.T>`
     - .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.T
          :summary:

API
~~~

.. py:class:: ScanFolderDto
   :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto

   .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto

   .. py:attribute:: abort_on_no_series_match
      :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto.abort_on_no_series_match
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto.abort_on_no_series_match

   .. py:attribute:: api_key
      :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto.api_key
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto.api_key

   .. py:attribute:: folder_path
      :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto.folder_path
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto.folder_path

   .. py:method:: from_dict(src_dict: collections.abc.Mapping[str, typing.Any]) -> kavita_client.models.scan_folder_dto.T
      :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto.from_dict
      :classmethod:

      .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto.from_dict

   .. py:method:: to_dict() -> dict[str, typing.Any]
      :canonical: kavita_client.models.scan_folder_dto.ScanFolderDto.to_dict

      .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.ScanFolderDto.to_dict

.. py:data:: T
   :canonical: kavita_client.models.scan_folder_dto.T
   :value: 'TypeVar(...)'

   .. autodoc2-docstring:: kavita_client.models.scan_folder_dto.T