-
Notifications
You must be signed in to change notification settings - Fork 5
/
classicapi_ebooks.go
365 lines (295 loc) · 11.2 KB
/
classicapi_ebooks.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
// classicapi_ebooks.go
// Jamf Pro Classic Api - Ebooks
// api reference: https://developer.jamf.com/jamf-pro/reference/ebooks
// Classic API requires the structs to support an XML data structure.
/*
Shared Resources in this Endpoint:
- SharedResourceSite
- SharedResourceCategory
- SharedResourceSelfServiceIcon
*/
package jamfpro
import (
"encoding/xml"
"fmt"
)
// URI for Ebooks in Jamf Pro API
const uriEbooks = "/JSSResource/ebooks"
// List
// Struct to capture the XML response for ebooks list
type ResponseEbooksList struct {
Size int `xml:"size"`
Ebooks EBookListItem `xml:"ebook"`
}
type EBookListItem struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// Resource
// ResourceEbooks represents the detailed structure of an Ebook response.
type ResourceEbooks struct {
General EbookSubsetGeneral `xml:"general"`
Scope EbookSubsetScope `xml:"scope"`
SelfService EbookSubsetSelfService `xml:"self_service"`
}
// Subsets & Containers
// General
type EbookSubsetGeneral struct {
ID int `xml:"id"`
Name string `xml:"name"`
Author string `xml:"author"`
Version string `xml:"version"`
Free bool `xml:"free"`
URL string `xml:"url"`
DeploymentType string `xml:"deployment_type"`
FileType string `xml:"file_type"`
DeployAsManaged bool `xml:"deploy_as_managed"`
Category SharedResourceCategory `xml:"category"`
SelfServiceIcon SharedResourceSelfServiceIcon `xml:"self_service_icon"`
Site SharedResourceSite `xml:"site"`
}
// Scope
type EbookSubsetScope struct {
AllComputers bool `xml:"all_computers"`
AllMobileDevices bool `xml:"all_mobile_devices"`
AllJSSUsers bool `xml:"all_jss_users"`
Computers []EbookSubsetScopeComputer `xml:"computers>computer"`
ComputerGroups []EbookSubsetScopeComputerGroup `xml:"computer_groups>computer_group"`
MobileDevices []EbookSubsetScopeMobileDevice `xml:"mobile_devices>mobile_device"`
MobileDeviceGroups []EbookSubsetScopeMobileDeviceGroup `xml:"mobile_device_groups>mobile_device_group"`
Buildings []EbookSubsetScopeBuilding `xml:"buildings>building"`
Departments []EbookSubsetScopeDepartment `xml:"departments>department"`
JSSUsers []EbookSubsetScopeUser `xml:"jss_users>user"`
JSSUserGroups []EbookSubsetScopeUserGroup `xml:"jss_user_groups>user_group"`
Classes []EbooksSubsetScopeClass `xml:"classes>class"`
Limitations EbookSubsetScopeLimitations `xml:"limitations"`
Exclusions EbookSubsetScopeExclusions `xml:"exclusions"`
}
// EbooksSubsetLimitations represents any limitations within the scope.
type EbookSubsetScopeLimitations struct {
NetworkSegments []struct {
ID int `xml:"id"`
UID string `xml:"uid,omitempty"`
Name string `xml:"name"`
} `xml:"network_segments>network_segment"`
Users []EbookSubsetScopeUser `xml:"users>user"`
UserGroups []EbookSubsetScopeUserGroup `xml:"user_groups>user_group"`
}
// Exclusions represent any exclusions within the scope.
type EbookSubsetScopeExclusions struct {
Computers []EbookSubsetScopeComputer `xml:"computers>computer"`
ComputerGroups []EbookSubsetScopeComputerGroup `xml:"computer_groups>computer_group"`
MobileDevices []EbookSubsetScopeMobileDevice `xml:"mobile_devices>mobile_device"`
MobileDeviceGroups []EbookSubsetScopeMobileDeviceGroup `xml:"mobile_device_groups>mobile_device_group"`
Buildings []EbookSubsetScopeBuilding `xml:"buildings>building"`
Departments []EbookSubsetScopeDepartment `xml:"departments>department"`
JSSUsers []EbookSubsetScopeUser `xml:"jss_users>user"`
JSSUserGroups []EbookSubsetScopeUserGroup `xml:"jss_user_groups>user_group"`
}
// Class represents a class within the scope.
type EbooksSubsetScopeClass struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// Self Service
type EbookSubsetSelfService struct {
SelfServiceDisplayName string `xml:"self_service_display_name"`
InstallButtonText string `xml:"install_button_text"`
SelfServiceDescription string `xml:"self_service_description"`
ForceUsersToViewDescription bool `xml:"force_users_to_view_description"`
SelfServiceIcon SharedResourceSelfServiceIcon `xml:"self_service_icon"`
FeatureOnMainPage bool `xml:"feature_on_main_page"`
SelfServiceCategories EbookSubsetSelfServiceCategories `xml:"self_service_categories"`
Notification bool `xml:"notification"`
NotificationSubject string `xml:"notification_subject"`
NotificationMessage string `xml:"notification_message"`
}
// SelfServiceCategories represent the categories within SelfService.
type EbookSubsetSelfServiceCategories struct {
Category []struct {
ID int `xml:"id"`
Name string `xml:"name"`
} `xml:"category"`
}
/// Shared In Resource
// Computer represents a single computer within the scope.
type EbookSubsetScopeComputer struct {
ID int `xml:"id"`
Name string `xml:"name"`
UDID string `xml:"udid"`
}
// ComputerGroup represents a group of computers within the scope.
type EbookSubsetScopeComputerGroup struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// MobileDevice represents a single mobile device within the scope.
type EbookSubsetScopeMobileDevice struct {
ID int `xml:"id"`
Name string `xml:"name"`
UDID string `xml:"udid"`
WiFiMacAddress string `xml:"wifi_mac_address"`
}
// EbooksSubsetMobileDeviceGroup represents a group of mobile devices within the scope.
type EbookSubsetScopeMobileDeviceGroup struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// Building represents a building within the scope.
type EbookSubsetScopeBuilding struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// Department represents a department within the scope.
type EbookSubsetScopeDepartment struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// User represents a user within the scope.
type EbookSubsetScopeUser struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// UserGroup represents a group of users within the scope.
type EbookSubsetScopeUserGroup struct {
ID int `xml:"id"`
Name string `xml:"name"`
}
// CRUD
// GetEbooks retrieves a serialized list of ebooks.
func (c *Client) GetEbooks() (*ResponseEbooksList, error) {
endpoint := uriEbooks
var ebooks ResponseEbooksList
resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &ebooks)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGet, "ebooks", err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &ebooks, nil
}
// GetEbooksByID retrieves a single ebook by its ID.
func (c *Client) GetEbookByID(id int) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/id/%d", uriEbooks, id)
var ebook ResourceEbooks
resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &ebook)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGetByID, "ebook", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &ebook, nil
}
// GetEbooksByName retrieves a single ebook by its name.
func (c *Client) GetEbookByName(name string) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/name/%s", uriEbooks, name)
var ebook ResourceEbooks
resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &ebook)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGetByName, "ebook", name, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &ebook, nil
}
// GetEbooksByNameAndDataSubset retrieves a specific subset of an ebook by its name.
func (c *Client) GetEbookByNameAndDataSubset(name, subset string) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/name/%s/subset/%s", uriEbooks, name, subset)
var ebook ResourceEbooks
resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &ebook)
if err != nil {
return nil, fmt.Errorf(errMsgFailedGetByName, "ebook", name, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &ebook, nil
}
// CreateEbook creates a new ebook.
func (c *Client) CreateEbook(ebook ResourceEbooks) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/id/0", uriEbooks)
if ebook.General.Site.ID == 0 && ebook.General.Site.Name == "" {
ebook.General.Site.ID = -1
ebook.General.Site.Name = "none"
}
requestBody := struct {
XMLName xml.Name `xml:"ebook"`
ResourceEbooks
}{
ResourceEbooks: ebook,
}
var response ResourceEbooks
resp, err := c.HTTP.DoRequest("POST", endpoint, &requestBody, &response)
if err != nil {
return nil, fmt.Errorf(errMsgFailedCreate, "ebook", err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &response, nil
}
// UpdateEbookByID updates an existing ebook by its ID.
func (c *Client) UpdateEbookByID(id int, ebook ResourceEbooks) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/id/%d", uriEbooks, id)
requestBody := struct {
XMLName xml.Name `xml:"ebook"`
ResourceEbooks
}{
ResourceEbooks: ebook,
}
var updatedEbook ResourceEbooks
resp, err := c.HTTP.DoRequest("PUT", endpoint, &requestBody, &updatedEbook)
if err != nil {
return nil, fmt.Errorf(errMsgFailedUpdateByID, "ebook", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &updatedEbook, nil
}
// UpdateEbookByName updates an existing ebook by its name.
func (c *Client) UpdateEbookByName(name string, ebook ResourceEbooks) (*ResourceEbooks, error) {
endpoint := fmt.Sprintf("%s/name/%s", uriEbooks, name)
requestBody := struct {
XMLName xml.Name `xml:"ebook"`
ResourceEbooks
}{
ResourceEbooks: ebook,
}
var updatedEbook ResourceEbooks
resp, err := c.HTTP.DoRequest("PUT", endpoint, &requestBody, &updatedEbook)
if err != nil {
return nil, fmt.Errorf(errMsgFailedUpdateByName, "ebook", name, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return &updatedEbook, nil
}
// DeleteEbookByID deletes a ebook by its ID.
func (c *Client) DeleteEbookByID(id int) error {
endpoint := fmt.Sprintf("%s/id/%d", uriEbooks, id)
resp, err := c.HTTP.DoRequest("DELETE", endpoint, nil, nil)
if err != nil {
return fmt.Errorf(errMsgFailedDeleteByID, "ebook", id, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return nil
}
// DeleteEbookByName deletes a ebook by its name.
func (c *Client) DeleteEbookByName(name string) error {
endpoint := fmt.Sprintf("%s/name/%s", uriEbooks, name)
resp, err := c.HTTP.DoRequest("DELETE", endpoint, nil, nil)
if err != nil {
return fmt.Errorf(errMsgFailedDeleteByName, "ebook", name, err)
}
if resp != nil && resp.Body != nil {
defer resp.Body.Close()
}
return nil
}