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

.. py:module:: kavita_client.models.series_dto

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

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

Classes
~~~~~~~

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

   * - :py:obj:`SeriesDto <kavita_client.models.series_dto.SeriesDto>`
     - .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto
          :summary:

Data
~~~~

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

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

API
~~~

.. py:class:: SeriesDto
   :canonical: kavita_client.models.series_dto.SeriesDto

   .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto

   .. py:attribute:: ani_list_id
      :canonical: kavita_client.models.series_dto.SeriesDto.ani_list_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.ani_list_id

   .. py:attribute:: avg_hours_to_read
      :canonical: kavita_client.models.series_dto.SeriesDto.avg_hours_to_read
      :type: float | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.avg_hours_to_read

   .. py:attribute:: cbr_id
      :canonical: kavita_client.models.series_dto.SeriesDto.cbr_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.cbr_id

   .. py:attribute:: comic_vine_id
      :canonical: kavita_client.models.series_dto.SeriesDto.comic_vine_id
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.comic_vine_id

   .. py:attribute:: cover_image
      :canonical: kavita_client.models.series_dto.SeriesDto.cover_image
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.cover_image

   .. py:attribute:: cover_image_locked
      :canonical: kavita_client.models.series_dto.SeriesDto.cover_image_locked
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.cover_image_locked

   .. py:attribute:: created
      :canonical: kavita_client.models.series_dto.SeriesDto.created
      :type: datetime.datetime | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.created

   .. py:attribute:: dont_match
      :canonical: kavita_client.models.series_dto.SeriesDto.dont_match
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.dont_match

   .. py:attribute:: folder_path
      :canonical: kavita_client.models.series_dto.SeriesDto.folder_path
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.folder_path

   .. py:attribute:: format_
      :canonical: kavita_client.models.series_dto.SeriesDto.format_
      :type: kavita_client.models.manga_format.MangaFormat | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.format_

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

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.from_dict

   .. py:attribute:: hardcover_id
      :canonical: kavita_client.models.series_dto.SeriesDto.hardcover_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.hardcover_id

   .. py:attribute:: has_user_rated
      :canonical: kavita_client.models.series_dto.SeriesDto.has_user_rated
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.has_user_rated

   .. py:attribute:: id
      :canonical: kavita_client.models.series_dto.SeriesDto.id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.id

   .. py:attribute:: is_blacklisted
      :canonical: kavita_client.models.series_dto.SeriesDto.is_blacklisted
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.is_blacklisted

   .. py:attribute:: is_stand_alone
      :canonical: kavita_client.models.series_dto.SeriesDto.is_stand_alone
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.is_stand_alone

   .. py:attribute:: last_chapter_added
      :canonical: kavita_client.models.series_dto.SeriesDto.last_chapter_added
      :type: datetime.datetime | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.last_chapter_added

   .. py:attribute:: last_chapter_added_utc
      :canonical: kavita_client.models.series_dto.SeriesDto.last_chapter_added_utc
      :type: datetime.datetime | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.last_chapter_added_utc

   .. py:attribute:: last_folder_scanned
      :canonical: kavita_client.models.series_dto.SeriesDto.last_folder_scanned
      :type: datetime.datetime | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.last_folder_scanned

   .. py:attribute:: latest_read_date
      :canonical: kavita_client.models.series_dto.SeriesDto.latest_read_date
      :type: datetime.datetime | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.latest_read_date

   .. py:attribute:: library_id
      :canonical: kavita_client.models.series_dto.SeriesDto.library_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.library_id

   .. py:attribute:: library_name
      :canonical: kavita_client.models.series_dto.SeriesDto.library_name
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.library_name

   .. py:attribute:: localized_name
      :canonical: kavita_client.models.series_dto.SeriesDto.localized_name
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.localized_name

   .. py:attribute:: localized_name_locked
      :canonical: kavita_client.models.series_dto.SeriesDto.localized_name_locked
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.localized_name_locked

   .. py:attribute:: lowest_folder_path
      :canonical: kavita_client.models.series_dto.SeriesDto.lowest_folder_path
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.lowest_folder_path

   .. py:attribute:: mal_id
      :canonical: kavita_client.models.series_dto.SeriesDto.mal_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.mal_id

   .. py:attribute:: manga_baka_edition_id
      :canonical: kavita_client.models.series_dto.SeriesDto.manga_baka_edition_id
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.manga_baka_edition_id

   .. py:attribute:: manga_baka_id
      :canonical: kavita_client.models.series_dto.SeriesDto.manga_baka_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.manga_baka_id

   .. py:attribute:: max_hours_to_read
      :canonical: kavita_client.models.series_dto.SeriesDto.max_hours_to_read
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.max_hours_to_read

   .. py:attribute:: metadata_provider_override
      :canonical: kavita_client.models.series_dto.SeriesDto.metadata_provider_override
      :type: kavita_client.models.metadata_provider.MetadataProvider | None | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.metadata_provider_override

   .. py:attribute:: metron_id
      :canonical: kavita_client.models.series_dto.SeriesDto.metron_id
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.metron_id

   .. py:attribute:: min_hours_to_read
      :canonical: kavita_client.models.series_dto.SeriesDto.min_hours_to_read
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.min_hours_to_read

   .. py:attribute:: name
      :canonical: kavita_client.models.series_dto.SeriesDto.name
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.name

   .. py:attribute:: name_locked
      :canonical: kavita_client.models.series_dto.SeriesDto.name_locked
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.name_locked

   .. py:attribute:: original_name
      :canonical: kavita_client.models.series_dto.SeriesDto.original_name
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.original_name

   .. py:attribute:: pages
      :canonical: kavita_client.models.series_dto.SeriesDto.pages
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.pages

   .. py:attribute:: pages_read
      :canonical: kavita_client.models.series_dto.SeriesDto.pages_read
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.pages_read

   .. py:attribute:: primary_color
      :canonical: kavita_client.models.series_dto.SeriesDto.primary_color
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.primary_color

   .. py:attribute:: secondary_color
      :canonical: kavita_client.models.series_dto.SeriesDto.secondary_color
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.secondary_color

   .. py:attribute:: sort_name
      :canonical: kavita_client.models.series_dto.SeriesDto.sort_name
      :type: None | str | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.sort_name

   .. py:attribute:: sort_name_locked
      :canonical: kavita_client.models.series_dto.SeriesDto.sort_name_locked
      :type: bool | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.sort_name_locked

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

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.to_dict

   .. py:attribute:: total_reads
      :canonical: kavita_client.models.series_dto.SeriesDto.total_reads
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.total_reads

   .. py:attribute:: user_rating
      :canonical: kavita_client.models.series_dto.SeriesDto.user_rating
      :type: float | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.user_rating

   .. py:attribute:: word_count
      :canonical: kavita_client.models.series_dto.SeriesDto.word_count
      :type: int | kavita_client.types.Unset
      :value: None

      .. autodoc2-docstring:: kavita_client.models.series_dto.SeriesDto.word_count

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

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