.. currentmodule:: fflogsapi

API reference
=============

This page provides autogenerated documentation on fflogsapi's API.

Client
------

.. autoclass:: FFLogsClient
    :members:

Authorization code flow
~~~~~~~~~~~~~~~~~~~~~~~

.. automethod:: FFLogsClient.set_auth_response
.. automethod:: FFLogsClient.user_auth

Report API
~~~~~~~~~~

.. automethod:: FFLogsClient.reports
.. automethod:: FFLogsClient.get_report

Character API
~~~~~~~~~~~~~

.. automethod:: FFLogsClient.get_character

User API
~~~~~~~~

.. automethod:: FFLogsClient.get_current_user
.. automethod:: FFLogsClient.get_user

Guild API
~~~~~~~~~

.. automethod:: FFLogsClient.guilds
.. automethod:: FFLogsClient.get_guild

Game API
~~~~~~~~

.. automethod:: FFLogsClient.icon_url
.. automethod:: FFLogsClient.abilities
.. automethod:: FFLogsClient.ability
.. automethod:: FFLogsClient.items
.. automethod:: FFLogsClient.item
.. automethod:: FFLogsClient.maps
.. automethod:: FFLogsClient.map
.. automethod:: FFLogsClient.jobs
.. automethod:: FFLogsClient.grand_companies

World API
~~~~~~~~~

.. automethod:: FFLogsClient.get_encounter
.. automethod:: FFLogsClient.get_expansion
.. automethod:: FFLogsClient.all_expansions
.. automethod:: FFLogsClient.get_region
.. automethod:: FFLogsClient.all_regions
.. automethod:: FFLogsClient.get_server
.. automethod:: FFLogsClient.get_subregion
.. automethod:: FFLogsClient.get_zone
.. automethod:: FFLogsClient.all_zones

Prog race API
~~~~~~~~~~~~~

.. automethod:: FFLogsClient.get_progress_race

Report API
----------

.. currentmodule:: fflogsapi.reports

Reports
~~~~~~~

.. autoclass:: FFLogsReport
    :members:

Fights
~~~~~~~

.. autoclass:: FFLogsFight
    :members:

Character API
-------------

.. currentmodule:: fflogsapi.characters

.. autoclass:: FFLogsCharacter
    :members:

User API
--------

.. currentmodule:: fflogsapi.user

.. autoclass:: FFLogsUser
    :members:

Guild API
---------

.. currentmodule:: fflogsapi.guilds

.. autoclass:: FFLogsGuild
    :members:

World API
---------

.. currentmodule:: fflogsapi.world

.. autoclass:: FFLogsExpansion
    :members:

.. autoclass:: FFLogsEncounter
    :members:

.. autoclass:: FFLogsZone
    :members:

.. autoclass:: FFLogsRegion
    :members:

.. autoclass:: FFLogsSubregion
    :members:

.. autoclass:: FFLogsServer
    :members:

Dataclasses
-----------

.. currentmodule:: fflogsapi.data

.. autoclass:: FFLogsAllStarsRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsFightRank
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsEncounterRankings
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsZoneEncounterRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsZoneRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsReportCharacterRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsReportComboRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsReportRanking
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFAbility
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFItem
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFJob
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFGrandCompany
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFMap
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsReportTag
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsAttendanceReport
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsRank
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsGuildZoneRankings
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsActor
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsReportAbility
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsArchivalData
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsPlayerDetails
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsNPCData
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFGameZone
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsPartition
  :members:
  :undoc-members:
  :private-members:

.. autoclass:: FFLogsPhase
  :members:
  :undoc-members:
  :private-members:

Pagination
----------

.. currentmodule:: fflogsapi.data.page

Many methods return ``Page`` and ``PaginationIterator`` objects. In such cases,
the pagination iterators allow you to iterate over multiple ``Page`` s, while each
``Page`` allows you to iterate over the relevant objects in the page. For example,
a ``FFLogsReportPaginationIterator`` lets you iterate over multiple ``FFLogsReportPage`` s,
which in turn allow you to iterate over ``FFLogsReport`` s.

Page API
~~~~~~~~

.. autoclass:: FFLogsPage
    :members: count, object

.. autoclass:: FFLogsPaginationIterator
    :members: