/
listentry.go
107 lines (87 loc) · 3.12 KB
/
listentry.go
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
package igdb
import (
"github.com/Henry-Sarabia/sliceconv"
"github.com/pkg/errors"
"strconv"
)
//go:generate gomodifytags -file $GOFILE -struct ListEntry -add-tags json -w
// ListEntry represents an entry in a user-created list of games.
// For more information visit: https://api-docs.igdb.com/#list-entry
type ListEntry struct {
ID int `json:"id"`
Description string `json:"description"`
Game int `json:"game"`
List int `json:"list"`
Platform int `json:"platform"`
Position int `json:"position"`
Private bool `json:"private"`
User int `json:"user"`
}
// ListEntryService handles all the API calls for the IGDB ListEntry endpoint.
type ListEntryService service
// Get returns a single ListEntry identified by the provided IGDB ID. Provide
// the SetFields functional option if you need to specify which fields to
// retrieve. If the ID does not match any ListEntrys, an error is returned.
func (ls *ListEntryService) Get(id int, opts ...Option) (*ListEntry, error) {
if id < 0 {
return nil, ErrNegativeID
}
var le []*ListEntry
opts = append(opts, SetFilter("id", OpEquals, strconv.Itoa(id)))
err := ls.client.get(ls.end, &le, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get ListEntry with ID %v", id)
}
return le[0], nil
}
// List returns a list of ListEntrys identified by the provided list of IGDB IDs.
// Provide functional options to sort, filter, and paginate the results.
// Any ID that does not match a ListEntry is ignored. If none of the IDs
// match a ListEntry, an error is returned.
func (ls *ListEntryService) List(ids []int, opts ...Option) ([]*ListEntry, error) {
for len(ids) < 1 {
return nil, ErrEmptyIDs
}
for _, id := range ids {
if id < 0 {
return nil, ErrNegativeID
}
}
var le []*ListEntry
opts = append(opts, SetFilter("id", OpContainsAtLeast, sliceconv.Itoa(ids)...))
err := ls.client.get(ls.end, &le, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get ListEntrys with IDs %v", ids)
}
return le, nil
}
// Index returns an index of ListEntrys based solely on the provided functional
// options used to sort, filter, and paginate the results. If no ListEntrys can
// be found using the provided options, an error is returned.
func (ls *ListEntryService) Index(opts ...Option) ([]*ListEntry, error) {
var le []*ListEntry
err := ls.client.get(ls.end, &le, opts...)
if err != nil {
return nil, errors.Wrap(err, "cannot get index of ListEntrys")
}
return le, nil
}
// Count returns the number of ListEntrys available in the IGDB.
// Provide the SetFilter functional option if you need to filter
// which ListEntrys to count.
func (ls *ListEntryService) Count(opts ...Option) (int, error) {
ct, err := ls.client.getCount(ls.end, opts...)
if err != nil {
return 0, errors.Wrap(err, "cannot count ListEntrys")
}
return ct, nil
}
// Fields returns the up-to-date list of fields in an
// IGDB ListEntry object.
func (ls *ListEntryService) Fields() ([]string, error) {
f, err := ls.client.getFields(ls.end)
if err != nil {
return nil, errors.Wrap(err, "cannot get ListEntry fields")
}
return f, nil
}