Skip to main content

Module sync

Module sync 

Source
Expand description

Sync API — activities, all-items, history, ratings, add-to-list, watched.

Every endpoint here is exposed as a SimklRequest-implementing type. The POST endpoints (/sync/history, /sync/ratings, /sync/add-to-list, plus their /remove variants) carry a JSON body — the payload types (SyncHistoryPayload, SyncRatingPayload, SyncListPayload) are serialised separately via serde_json at the HTTP layer.

Structs§

Activities
AddRatingsRequest
POST /sync/ratings — send a SyncRatingPayload as the JSON body.
AddToHistoryRequest
POST /sync/history — send a SyncHistoryPayload as the JSON body.
AddToListRequest
POST /sync/add-to-list — send a SyncListPayload as the JSON body.
AllItemsRequest
Request for GET /sync/all-items/[<what>/]?date_from=....
AnimeHistoryItem
An individual anime to add to/remove from watch history.
AnimeListItem
An anime to add to a specific list.
AnimeRatingItem
An individual anime rating.
CheckIfWatchedRequest
GET /sync/watched — check which items in a set are marked watched.
MediaActivity
MovieHistoryItem
An individual movie to add/remove from watch history.
MovieListItem
A movie to add to a specific list.
MovieRatingItem
An individual movie rating.
RemoveFromHistoryRequest
POST /sync/history/remove — send a SyncHistoryPayload as the JSON body.
RemoveRatingsRequest
POST /sync/ratings/remove — send a SyncRatingPayload as the JSON body.
ShowHistoryItem
An individual TV show to add to/remove from watch history. Episodes can be specified at the show, season, or episode level.
ShowListItem
A show to add to a specific list.
ShowRatingItem
An individual show rating.
SyncActivitiesRequest
Request for POST /sync/activities — timestamps for each activity type.
SyncAddedCounts
Item counts in a SyncResult.
SyncHistoryPayload
Payload for POST /sync/history (add to watched history) and POST /sync/history/remove.
SyncListPayload
Payload for POST /sync/add-to-list.
SyncNotFound
Items the API could not process (unrecognised IDs, etc.).
SyncRatingPayload
Payload for POST /sync/ratings (add ratings) and POST /sync/ratings/remove.
SyncResult
Standard response body for POST sync endpoints.
SyncSettings
WatchedEpisode
A single watched episode (used inside season lists or show-level episode arrays).
WatchedSeason
A watched season entry inside a show sync payload.