ao3_sync.api.resources.SeriesApi
API for handling AO3 series
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client |
AO3ApiClient
|
AO3ApiClient instance |
required |
Attributes:
| Name | Type | Description |
|---|---|---|
URL_PATH |
str
|
URL path for series |
fetch_works(series_id)
Fetches a series from AO3.
Returns:
| Name | Type | Description |
|---|---|---|
works_list |
list[str]
|
List of work IDs in the series |
sync(series_id, formats=DEFAULT_DOWNLOAD_FORMATS)
Syncs all the works in a series from AO3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
series_id |
str
|
Series ID to sync |
required |
formats |
list[DownloadFormat]
|
Formats to download. Defaults to DEFAULT_DOWNLOAD_FORMATS |
DEFAULT_DOWNLOAD_FORMATS
|