forked from Henry-Sarabia/igdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
achievementicon.go
101 lines (82 loc) · 3.04 KB
/
achievementicon.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
package igdb
import (
"github.com/Henry-Sarabia/sliceconv"
"github.com/pkg/errors"
"strconv"
)
// AchievementIcon is an icon for a specific achievement.
// For more information visit: https://api-docs.igdb.com/#achievement-icon
type AchievementIcon struct {
Image
ID int `json:"id"`
}
// AchievementIconService handles all the API calls for the IGDB
// AchievementIcon endpoint.
// This endpoint is only available for the IGDB Pro tier or above.
type AchievementIconService service
// Get returns a single AchievementIcon 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 AchievementIcons, an error is returned.
func (as *AchievementIconService) Get(id int, opts ...Option) (*AchievementIcon, error) {
if id < 0 {
return nil, ErrNegativeID
}
var icon []*AchievementIcon
opts = append(opts, SetFilter("id", OpEquals, strconv.Itoa(id)))
err := as.client.get(as.end, &icon, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get AchievementIcon with ID %v", id)
}
return icon[0], nil
}
// List returns a list of AchievementIcons 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 AchievementIcon is ignored. If none of the IDs
// match a AchievementIcon, an error is returned.
func (as *AchievementIconService) List(ids []int, opts ...Option) ([]*AchievementIcon, error) {
for len(ids) < 1 {
return nil, ErrEmptyIDs
}
for _, id := range ids {
if id < 0 {
return nil, ErrNegativeID
}
}
var icon []*AchievementIcon
opts = append(opts, SetFilter("id", OpContainsAtLeast, sliceconv.Itoa(ids)...))
err := as.client.get(as.end, &icon, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get AchievementIcons with IDs %v", ids)
}
return icon, nil
}
// Index returns an index of AchievementIcons based solely on the provided functional
// options used to sort, filter, and paginate the results. If no AchievementIcons can
// be found using the provided options, an error is returned.
func (as *AchievementIconService) Index(opts ...Option) ([]*AchievementIcon, error) {
var icon []*AchievementIcon
err := as.client.get(as.end, &icon, opts...)
if err != nil {
return nil, errors.Wrap(err, "cannot get index of AchievementIcons")
}
return icon, nil
}
// Count returns the number of AchievementIcons available in the IGDB.
// Provide the SetFilter functional option if you need to filter
// which AchievementIcons to count.
func (as *AchievementIconService) Count(opts ...Option) (int, error) {
ct, err := as.client.getCount(as.end, opts...)
if err != nil {
return 0, errors.Wrap(err, "cannot count AchievementIcons")
}
return ct, nil
}
// Fields returns the up-to-date list of fields in an
// IGDB AchievementIcon object.
func (as *AchievementIconService) Fields() ([]string, error) {
f, err := as.client.getFields(as.end)
if err != nil {
return nil, errors.Wrap(err, "cannot get AchievementIcon fields")
}
return f, nil
}