class

Srcom::Api::Series

Inherits Reference / Object

Constants

Log = Srcom::Log.for("series")

Class methods

find_by(name : String | Nil = nil, abbreviation : String | Nil = nil, moderator : String | Nil = nil, order_by : String | Nil = nil, sort_direction : String | Nil = nil, page_size : Int32 = 200) : PageIterator(Srcom::Series)

Searches through all Series using the given query parameters.

Searching by name performs a fuzzy search across series names and abbreviations.

Seaching by abbreviation performs an exact-match search.

Searching by moderator will only return Series moderated by the User with the given id.

Possible values for order_by: "name.jap", "name.int", "abbreviation", or "created", with the default being "name.int".

Possible values for sort_direction: "desc" or "asc", with the default being "asc".

Source
find_by_id(id : String) : Srcom::Series

Finds a Series given its id or abbreviation.

Source
get_games(id : String, name : String | Nil = nil, abbreviation : String | Nil = nil, released : Int32 | Nil = nil, gametype : String | Nil = nil, platform : String | Nil = nil, region : String | Nil = nil, genre : String | Nil = nil, engine : String | Nil = nil, developer : String | Nil = nil, publisher : String | Nil = nil, moderator : String | Nil = nil, order_by : String | Nil = nil, sort_direction : String | Nil = nil, page_size : Int32 = 20) : PageIterator(Game)

Searches through all the games in the Series given by its id or abbreviation using the given query parameters (and gets all of those games if none of the filters are used).

Searching by name performs a fuzzy search across game names and abbreviations.

Seaching by abbreviation performs an exact-match search.

Searching by released restricts to search to games released in that exact year.

All other search parameters must be an ID.

Possible values for order_by: "name.jap", "name.int", "abbreviation", "released", or "created", with the default being "name.int".

Possible values for sort_direction: "desc" or "asc", with the default being "asc".

NOTE: Since Series typically don't have too many games in them it is very much feasible to get everything here, but only when requested in smaller chunks, so that is what is defaulted to.

Source
get_games_bulk(id : String, name : String | Nil = nil, abbreviation : String | Nil = nil, released : Int32 | Nil = nil, gametype : String | Nil = nil, platform : String | Nil = nil, region : String | Nil = nil, genre : String | Nil = nil, engine : String | Nil = nil, developer : String | Nil = nil, publisher : String | Nil = nil, moderator : String | Nil = nil, order_by : String | Nil = nil, sort_direction : String | Nil = nil, page_size : Int32 = 1000) : PageIterator(BulkGame)

Searches through all the games in the Series given by its id or abbreviation using the given query parameters (and gets all of those games if none of the filters are used), returning BulkGames, which have a greatly reduced amount of data present.

Searching by name performs a fuzzy search across game names and abbreviations.

Seaching by abbreviation performs an exact-match search.

Searching by released restricts to search to games released in that exact year.

All other search parameters must be an ID.

Possible values for order_by: "name.jap", "name.int", "abbreviation", "released", or "created", with the default being "name.int".

Possible values for sort_direction: "desc" or "asc", with the default being "asc".

Source