-
Notifications
You must be signed in to change notification settings - Fork 0
/
Family.kt
57 lines (49 loc) · 2.16 KB
/
Family.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/**
* Copyright 2023-2024 Bram Wijnands
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http:https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.audux.bgg.response
import com.fasterxml.jackson.annotation.JsonRootName
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty
import kotlinx.serialization.Serializable
import org.audux.bgg.common.FamilyType
import org.audux.bgg.common.Link
import org.audux.bgg.common.Name
/** Response wrapper for Family items, e.g. games having a related theme or gameplay. */
@JsonRootName("items")
@Serializable
data class Family(
/** Terms of use of the BGG API. */
@JacksonXmlProperty(isAttribute = true) val termsOfUse: String,
/** List of the actual items. */
@JacksonXmlProperty(localName = "item") val items: List<FamilyItem>
)
/** The actual Family item e.g. a `boardgamefamily`, rpg etc. */
@Serializable
data class FamilyItem(
/** Unique ID that can be used to look up more information using the thing endpoint. */
@JacksonXmlProperty(isAttribute = true) val id: Int,
/** Type of family thing e.g. RPG, board game etc. */
@JsonDeserialize(using = FamilyTypeDeserializer::class)
@JacksonXmlProperty(isAttribute = true)
val type: FamilyType,
/** Primary name represented as [Name]. */
val name: Name,
/** Description of this family i.e. what relates the list of items. */
@JsonDeserialize(using = TrimmedStringDeserializer::class) val description: String,
/**
* List of the items that are part of this family, e.g. board games that have a certain theme or
* gameplay.
*/
@JacksonXmlProperty(localName = "link") val links: List<Link>
)