-
Notifications
You must be signed in to change notification settings - Fork 7
/
jamfproapi_categories.go
205 lines (159 loc) · 5.76 KB
/
jamfproapi_categories.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// jamfproapi_categories.go
// Jamf Pro Api - Categories
// api reference: https://developer.jamf.com/jamf-pro/reference/get_v1-categories
// Jamf Pro API requires the structs to support a JSON data structure.
package jamfpro
import (
"fmt"
"github.com/mitchellh/mapstructure"
)
const uriCategories = "/api/v1/categories"
// List
type ResponseCategoriesList struct {
TotalCount int `json:"totalCount"`
Results []ResourceCategory `json:"results"`
}
// Resource
type ResourceCategory struct {
Id string `json:"id"`
Name string `json:"name"`
Priority int `json:"priority"`
}
// ResponseCategoryCreateAndUpdate represents the response structure for creating a category.
type ResponseCategoryCreateAndUpdate struct {
ID string `json:"id"`
Href string `json:"href"`
}
// CRUD
// GetCategories retrieves all categories from the Jamf Pro API, handling pagination automatically.
// This function makes multiple API calls to fetch each page of category data and aggregates the results.
// It uses a loop to iterate through all available pages of categories.
// The default response contains information for 100 resources, this function is set to the maximum number of 2000.
// Parameters:
// - sort: A string specifying the sorting order of the returned categories.
// - filter: A string to filter the categories based on certain criteria.
func (c *Client) GetCategories(sort_filter string) (*ResponseCategoriesList, error) {
resp, err := c.DoPaginatedGet(uriCategories, standardPageSize, startingPageNumber, sort_filter)
if err != nil {
return nil, fmt.Errorf(errMsgFailedPaginatedGet, "categories", err)
}
var out ResponseCategoriesList
out.TotalCount = resp.Size
for _, value := range resp.Results {
var newObj ResourceCategory
err := mapstructure.Decode(value, &newObj)
if err != nil {
return nil, fmt.Errorf(errMsgFailedMapstruct, "category", err)
}
out.Results = append(out.Results, newObj)
}
return &out, nil
}
// GetCategoryByID retrieves a category by its ID
func (c *Client) GetCategoryByID(id string) (*ResourceCategory, error) {
endpoint := fmt.Sprintf("%s/%s", uriCategories, id)
var category ResourceCategory
resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &category)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGetByID, "categories", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &category, nil
}
// GetCategoryNameByID retrieves a category by its name and then retrieves its details using its ID
func (c *Client) GetCategoryByName(name string) (*ResourceCategory, error) {
categories, err := c.GetCategories("")
if err != nil {
return nil, fmt.Errorf(errMsgFailedPaginatedGet, "categories", err)
}
for _, value := range categories.Results {
if value.Name == name {
return &value, nil
}
}
return nil, fmt.Errorf(errMsgFailedGetByName, "category", name, errMsgNoName)
}
// CreateCategory creates a new category
func (c *Client) CreateCategory(category *ResourceCategory) (*ResponseCategoryCreateAndUpdate, error) {
endpoint := uriCategories
var response ResponseCategoryCreateAndUpdate
resp, err := c.HTTP.DoRequest("POST", endpoint, category, &response)
if err != nil {
return nil, fmt.Errorf(errMsgFailedCreate, "category", err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &response, nil
}
// UpdateCategoryByID updates an existing category by its ID
func (c *Client) UpdateCategoryByID(id string, categoryUpdate *ResourceCategory) (*ResponseCategoryCreateAndUpdate, error) {
endpoint := fmt.Sprintf("%s/%s", uriCategories, id)
var response ResponseCategoryCreateAndUpdate
resp, err := c.HTTP.DoRequest("PUT", endpoint, categoryUpdate, &response)
if err != nil {
return nil, fmt.Errorf(errMsgFailedUpdateByID, "category", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &response, nil
}
// UpdateCategoryByNameByID updates a category by its name and then updates its details using its ID.
func (c *Client) UpdateCategoryByName(name string, categoryUpdate *ResourceCategory) (*ResponseCategoryCreateAndUpdate, error) {
category, err := c.GetCategoryByName(name)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGetByName, "category", name, err)
}
target_id := category.Id
resp, err := c.UpdateCategoryByID(target_id, categoryUpdate)
if err != nil {
return nil, fmt.Errorf(errMsgFailedUpdateByName, "category", name, err)
}
return resp, nil
}
// DeleteCategoryByID deletes a category by its ID
func (c *Client) DeleteCategoryByID(id string) error {
endpoint := fmt.Sprintf("%s/%s", uriCategories, id)
resp, err := c.HTTP.DoRequest("DELETE", endpoint, nil, nil)
if err != nil {
return fmt.Errorf(errMsgFailedDeleteByID, "category", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return nil
}
// DeleteCategoryByNameByID deletes a category by its name after inferring its ID.
func (c *Client) DeleteCategoryByName(name string) error {
category, err := c.GetCategoryByName(name)
if err != nil {
return fmt.Errorf(errMsgFailedGetByName, "category", name, err)
}
target_id := category.Id
err = c.DeleteCategoryByID(target_id)
if err != nil {
return fmt.Errorf(errMsgFailedDeleteByName, "category", name, err)
}
return nil
}
// DeleteMultipleCategoriesByID deletes multiple categories by their IDs
func (c *Client) DeleteMultipleCategoriesByID(ids []string) error {
endpoint := fmt.Sprintf("%s/delete-multiple", uriCategories)
// Construct the request payload
payload := struct {
IDs []string `json:"ids"`
}{
IDs: ids,
}
resp, err := c.HTTP.DoRequest("POST", endpoint, payload, nil)
if err != nil {
return fmt.Errorf(errMsgFailedDeleteMultiple, "categories", ids, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return nil
}