-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_device_information.go
2065 lines (1786 loc) · 73.4 KB
/
api_device_information.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Kandji API
<html><head></head><body><h1 id="welcome-to-the-kandji-api-documentation">Welcome to the Kandji API Documentation</h1> <p>You can find your API URL in Settings > Access. The API URL will follow the below formats.</p> <ul> <li><p>US - <code>https://SubDomain.api.kandji.io</code></p> </li> <li><p>EU - <code>https://SubDomain.api.eu.kandji.io</code></p> </li> </ul> <p>For information on how to obtain an API token, please refer to the following support article.</p> <p><a href="https://support.kandji.io/api">https://support.kandji.io/api</a></p> <h4 id="rate-limit">Rate Limit</h4> <p>The Kandji API currently has an API rate limit of 10,000 requests per hour per customer.</p> <h4 id="request-methods">Request Methods</h4> <p>HTTP request methods supported by the Kandji API.</p> <div class="click-to-expand-wrapper is-table-wrapper"><table> <thead> <tr> <th>Method</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>The <code>GET</code> method requests a representation of the specified resource.</td> </tr> <tr> <td>POST</td> <td>The <code>POST</code> method submits an entity to the specified resource.</td> </tr> <tr> <td>PATCH</td> <td>The <code>PATCH</code> method applies partial modifications to a resource.</td> </tr> <tr> <td>DELETE</td> <td>The <code>DELETE</code> method deletes the specified resource.</td> </tr> </tbody> </table> </div><h4 id="response-codes">Response codes</h4> <p>Not all response codes apply to every endpoint.</p> <div class="click-to-expand-wrapper is-table-wrapper"><table> <thead> <tr> <th>Code</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td>200</td> <td>OK</td> </tr> <tr> <td>201</td> <td>Created</td> </tr> <tr> <td>204</td> <td>No content</td> </tr> <tr> <td></td> <td>Typical response when sending the DELETE method.</td> </tr> <tr> <td>400</td> <td>Bad Request</td> </tr> <tr> <td></td> <td>"Command already running" - The command may already be running in a <em>Pending</em> state waiting on the device.</td> </tr> <tr> <td></td> <td>"Command is not allowed for current device" - The command may not be compatible with the target device.</td> </tr> <tr> <td></td> <td>"JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)"</td> </tr> <tr> <td>401</td> <td>Unauthorized</td> </tr> <tr> <td></td> <td>This error can occur if the token is incorrect, was revoked, or the token has expired.</td> </tr> <tr> <td>403</td> <td>Forbidden</td> </tr> <tr> <td></td> <td>The request was understood but cannot be authorized.</td> </tr> <tr> <td>404</td> <td>Not found</td> </tr> <tr> <td></td> <td>Unable to locate the resource in the Kandji tenant.</td> </tr> <tr> <td>415</td> <td>Unsupported Media Type</td> </tr> <tr> <td></td> <td>The request contains a media type which the server or resource does not support.</td> </tr> <tr> <td>500</td> <td>Internal server error</td> </tr> <tr> <td>503</td> <td>Service unavailable</td> </tr> <tr> <td></td> <td>This error can occur if a file upload is still being processed via the custom apps API.</td> </tr> </tbody> </table> </div><h4 id="data-structure">Data structure</h4> <p>The API returns all structured responses in JSON schema format.</p> <h4 id="examples">Examples</h4> <p>Code examples using the API can be found in the Kandji support <a href="https://github.com/kandji-inc/support/tree/main/api-tools">GitHub</a>.</p> </body></html>
API version: 1.0.0
Contact: mitchelsblake@gmail.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package kandji
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
type DeviceInformationAPI interface {
/*
CancelLostMode Cancel Lost Mode
This endpoint can be used to send a cancelation request if Lost Mode is in an error state for a given iOS or iPadOS device.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiCancelLostModeRequest
*/
CancelLostMode(ctx context.Context, deviceId string) ApiCancelLostModeRequest
// CancelLostModeExecute executes the request
CancelLostModeExecute(r ApiCancelLostModeRequest) (*http.Response, error)
/*
GetDevice Get Device
This request returns the high-level information for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceRequest
*/
GetDevice(ctx context.Context, deviceId string) ApiGetDeviceRequest
// GetDeviceExecute executes the request
// @return DeviceInformationGetDevice200Response
GetDeviceExecute(r ApiGetDeviceRequest) (*DeviceInformationGetDevice200Response, *http.Response, error)
/*
GetDeviceActivity Get Device Activity
This request returns the device activity for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceActivityRequest
*/
GetDeviceActivity(ctx context.Context, deviceId string) ApiGetDeviceActivityRequest
// GetDeviceActivityExecute executes the request
// @return DeviceInformationGetDeviceActivity200Response
GetDeviceActivityExecute(r ApiGetDeviceActivityRequest) (*DeviceInformationGetDeviceActivity200Response, *http.Response, error)
/*
GetDeviceApps Get Device Apps
<p>This request returns a list of all installed apps for a specified Device ID.</p>
<p>For iPhone and iPad, the preinstalled Apple apps are not reported.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceAppsRequest
*/
GetDeviceApps(ctx context.Context, deviceId string) ApiGetDeviceAppsRequest
// GetDeviceAppsExecute executes the request
// @return DeviceInformationGetDeviceApps200Response
GetDeviceAppsExecute(r ApiGetDeviceAppsRequest) (*DeviceInformationGetDeviceApps200Response, *http.Response, error)
/*
GetDeviceDetails Get Device Details
This request returns the device details for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceDetailsRequest
*/
GetDeviceDetails(ctx context.Context, deviceId string) ApiGetDeviceDetailsRequest
// GetDeviceDetailsExecute executes the request
// @return DeviceInformationGetDeviceDetails200Response
GetDeviceDetailsExecute(r ApiGetDeviceDetailsRequest) (*DeviceInformationGetDeviceDetails200Response, *http.Response, error)
/*
GetDeviceLibraryItems Get Device Library Items
<p>This request gets all library items and their statuses for a specified Device ID</p>
<h4 id="possible-library-item-status-values">Possible library item status values</h4>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Value</strong></th>
<th><strong>Type</strong></th>
<th><strong>Additional Info</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>AVAILABLE</td>
<td>string</td>
<td>Library item available in Self Service</td>
</tr>
<tr>
<td>CACHED</td>
<td>string</td>
<td>Library item downloaded for install but not yet installed</td>
</tr>
<tr>
<td>CHANGE_PENDING</td>
<td>string</td>
<td>Recovery Password library item has changes that have not yet been applied</td>
</tr>
<tr>
<td>DOWNLOADING</td>
<td>string</td>
<td>Library item downloading</td>
</tr>
<tr>
<td>ERROR</td>
<td>string</td>
<td>Audit failure</td>
</tr>
<tr>
<td>EXCLUDED</td>
<td>string</td>
<td>Not in scope for assignment rule</td>
</tr>
<tr>
<td>INCOMPATIBLE</td>
<td>string</td>
<td>Not compatible with device or OS version</td>
</tr>
<tr>
<td>INSTALLING</td>
<td>string</td>
<td>Library item installing</td>
</tr>
<tr>
<td>PASS</td>
<td>string</td>
<td>Device meets requirements</td>
</tr>
<tr>
<td>PENDING</td>
<td>string</td>
<td>Waiting on device, not yet installed (All library items except for config profiles)</td>
</tr>
<tr>
<td>failed</td>
<td>string</td>
<td>Configuration profile failed to install</td>
</tr>
<tr>
<td>pending</td>
<td>string</td>
<td>Waiting on device, Configuration profile not yet installed</td>
</tr>
<tr>
<td>success</td>
<td>string</td>
<td>Configuration profile installed</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceLibraryItemsRequest
*/
GetDeviceLibraryItems(ctx context.Context, deviceId string) ApiGetDeviceLibraryItemsRequest
// GetDeviceLibraryItemsExecute executes the request
// @return DeviceInformationGetDeviceLibraryItems200Response
GetDeviceLibraryItemsExecute(r ApiGetDeviceLibraryItemsRequest) (*DeviceInformationGetDeviceLibraryItems200Response, *http.Response, error)
/*
GetDeviceLostModeDetails Get Device Lost Mode details
<p>This request returns the device lost mode details for a specified Device ID.</p>
<p><strong>Note</strong>: Lost Mode is is only available for iOS and iPadOS. For more information, please see this <a href="https://support.kandji.io/a/solutions/articles/72000573873">Kandji support artilcle</a>.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceLostModeDetailsRequest
*/
GetDeviceLostModeDetails(ctx context.Context, deviceId string) ApiGetDeviceLostModeDetailsRequest
// GetDeviceLostModeDetailsExecute executes the request
// @return DeviceInformationGetDeviceLostModeDetails200Response
GetDeviceLostModeDetailsExecute(r ApiGetDeviceLostModeDetailsRequest) (*DeviceInformationGetDeviceLostModeDetails200Response, *http.Response, error)
/*
GetDeviceParameters Get Device Parameters
<p>This request returns the parameters and their statuses for a specified Device ID</p>
<p>This endpoint is only applicable to macOS clients.</p>
<p>The parameters will be returned as a list of IDs. These IDs can be correlated with the parameter names available here: <a href="https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations">https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations</a></p>
<p><strong>Possible parameter status values</strong></p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Value</strong></th>
<th><strong>Type</strong></th>
<th><strong>Additional Info</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>ERROR</td>
<td>string</td>
<td>Audit failure</td>
</tr>
<tr>
<td>INCOMPATIBLE</td>
<td>string</td>
<td>Not compatible with device or OS version</td>
</tr>
<tr>
<td>PASS</td>
<td>string</td>
<td>Device meets requirements</td>
</tr>
<tr>
<td>PENDING</td>
<td>string</td>
<td>Waiting on device. Not yet run.</td>
</tr>
<tr>
<td>REMEDIATED</td>
<td>string</td>
<td>Parameter remediated</td>
</tr>
<tr>
<td>WARNING</td>
<td>string</td>
<td>Muted alert</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceParametersRequest
*/
GetDeviceParameters(ctx context.Context, deviceId string) ApiGetDeviceParametersRequest
// GetDeviceParametersExecute executes the request
// @return DeviceInformationGetDeviceParameters200Response
GetDeviceParametersExecute(r ApiGetDeviceParametersRequest) (*DeviceInformationGetDeviceParameters200Response, *http.Response, error)
/*
GetDeviceStatus Get Device Status
<p>This request returns the full status (parameters and library items) for a specified Device ID.</p>
<p>The parameters will be returned as a list of IDs. These IDs can be correlated with the parameter names available here: <a href="https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations">https://github.com/kandji-inc/support/wiki/Devices-API---Parameter-Correlations</a></p>
<h4 id="possible-status-values">Possible status values</h4>
<p><strong>Library items</strong></p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Value</strong></th>
<th><strong>Type</strong></th>
<th><strong>Additional Info</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>AVAILABLE</td>
<td>string</td>
<td>Library item available in Self Service</td>
</tr>
<tr>
<td>ERROR</td>
<td>string</td>
<td>Audit failure</td>
</tr>
<tr>
<td>EXCLUDED</td>
<td>string</td>
<td>Not in scope for assignment rule</td>
</tr>
<tr>
<td>INCOMPATIBLE</td>
<td>string</td>
<td>Not compatible with device or OS version</td>
</tr>
<tr>
<td>PASS</td>
<td>string</td>
<td>Device meets requirements</td>
</tr>
<tr>
<td>PENDING</td>
<td>string</td>
<td>Waiting on device, not yet installed (All library items except for config profiles)</td>
</tr>
<tr>
<td>failed</td>
<td>string</td>
<td>Configuration profile failed to install</td>
</tr>
<tr>
<td>pending</td>
<td>string</td>
<td>Waiting on device, Configuration profile not yet installed</td>
</tr>
<tr>
<td>success</td>
<td>string</td>
<td>Configuration profile installed</td>
</tr>
</tbody>
</table>
</div><p><strong>Parameters</strong></p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Value</strong></th>
<th><strong>Type</strong></th>
<th><strong>Additional Info</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>ERROR</td>
<td>string</td>
<td>Audit failure</td>
</tr>
<tr>
<td>INCOMPATIBLE</td>
<td>string</td>
<td>Not compatible with device or OS version</td>
</tr>
<tr>
<td>PASS</td>
<td>string</td>
<td>Device meets requirements</td>
</tr>
<tr>
<td>PENDING</td>
<td>string</td>
<td>Waiting on device. Not yet run.</td>
</tr>
<tr>
<td>REMEDIATED</td>
<td>string</td>
<td>Parameter remediated</td>
</tr>
<tr>
<td>WARNING</td>
<td>string</td>
<td>Muted alert</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceStatusRequest
*/
GetDeviceStatus(ctx context.Context, deviceId string) ApiGetDeviceStatusRequest
// GetDeviceStatusExecute executes the request
// @return DeviceInformationGetDeviceStatus200Response
GetDeviceStatusExecute(r ApiGetDeviceStatusRequest) (*DeviceInformationGetDeviceStatus200Response, *http.Response, error)
/*
ListDevices List Devices
<p>This request returns a list of devices in a Kandji tenant. Optionally. query parameters can be used to filter results.</p>
<p>There is a hard upper limit of 300 results per request. To return addtional results pagination must be used. Pagination examples can be found in the Kandji support <a href="https://github.com/kandji-inc/support/tree/main/api-tools/code-examples">GitHub</a>.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListDevicesRequest
*/
ListDevices(ctx context.Context) ApiListDevicesRequest
// ListDevicesExecute executes the request
// @return map[string]interface{}
ListDevicesExecute(r ApiListDevicesRequest) (map[string]interface{}, *http.Response, error)
/*
UpdateDevice Update Device
<p>This request allows you to update device information, such as the assigned blueprint, user, Asset Tag, and Tags. It is not required to use all attributes in a given request. For example if you only want to update the assigned blueprint, you only need to pass the <code>blueprint_id</code> in the request payload.</p>
<p><strong>NOTE</strong>: With the introduction of a UUID value for user ID in the <a href="https://api-docs.kandji.io/#b107eb0a-b586-414f-bc4c-3d2b304cfd5f">Users API</a>, the Device PATCH endpoint will support both the depricated user ID integer value and the new user ID UUID value when updating the user assignment for a device. The ability to update user assignment via the integer ID value will be removed starting January 2025.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>device_id</code> (path parameter): The unique identifier of the device.</p>
<h3 id="additional-information">Additional information</h3>
<p>User ID can be found using the <code>list users</code> API</p>
<p>A Blueprint ID can be found using the <code>list blueprints</code> API or in the URL path while on a Blueprint overview page.</p>
<p>For example, for this URL <a href="https://subdomain.kandji.io/blueprints/6391086e-85a1-4820-813c-f9c75025fff4">https://subdomain.kandji.io/blueprints/6391086e-85a1-4820-813c-f9c75025fff4</a></p>
<p>The Blueprint ID would be <code>6391086e-85a1-4820-813c-f9c75025fff4</code></p>
<p>An example script that leverages this API can be found in the <a href="https://github.com/kandji-inc/support/tree/main/api-tools/update-device-record">Kandji Support GitHub</a></p>
<h4 id="clearing-the-device-asset-tag">Clearing the device asset tag</h4>
<p>To clear a device asset tag, set the <code>asset_tag</code> value to <code>null</code> in the JSON payload.</p>
<pre class="click-to-expand-wrapper is-snippet-wrapper"><code class="language-json">{
"asset_tag": null
}
</code></pre>
<h4 id="clearing-the-assigned-user-attribute">Clearing the assigned user attribute</h4>
<p>To clear the assigned user for a given device, set the <code>user</code> value to <code>null</code> in the JSON payload.</p>
<pre class="click-to-expand-wrapper is-snippet-wrapper"><code class="language-json">{
"user": null
}
</code></pre>
<h4 id="clearing-all-tags">Clearing all tags</h4>
<p>To clear the assigned tags for a given device, set the <code>tags</code> value to an empty list <code>[]</code> in the JSON payload.</p>
<pre class="click-to-expand-wrapper is-snippet-wrapper"><code class="language-json">{
"tags": []
}
</code></pre>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiUpdateDeviceRequest
*/
UpdateDevice(ctx context.Context, deviceId string) ApiUpdateDeviceRequest
// UpdateDeviceExecute executes the request
// @return DeviceInformationUpdateDevice200Response
UpdateDeviceExecute(r ApiUpdateDeviceRequest) (*DeviceInformationUpdateDevice200Response, *http.Response, error)
}
// DeviceInformationAPIService DeviceInformationAPI service
type DeviceInformationAPIService service
type ApiCancelLostModeRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
}
func (r ApiCancelLostModeRequest) Execute() (*http.Response, error) {
return r.ApiService.CancelLostModeExecute(r)
}
/*
CancelLostMode Cancel Lost Mode
This endpoint can be used to send a cancelation request if Lost Mode is in an error state for a given iOS or iPadOS device.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiCancelLostModeRequest
*/
func (a *DeviceInformationAPIService) CancelLostMode(ctx context.Context, deviceId string) ApiCancelLostModeRequest {
return ApiCancelLostModeRequest{
ApiService: a,
ctx: ctx,
deviceId: deviceId,
}
}
// Execute executes the request
func (a *DeviceInformationAPIService) CancelLostModeExecute(r ApiCancelLostModeRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DeviceInformationAPIService.CancelLostMode")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/devices/{device_id}/details/lostmode"
localVarPath = strings.Replace(localVarPath, "{"+"device_id"+"}", url.PathEscape(parameterValueToString(r.deviceId, "deviceId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type ApiGetDeviceRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
}
func (r ApiGetDeviceRequest) Execute() (*DeviceInformationGetDevice200Response, *http.Response, error) {
return r.ApiService.GetDeviceExecute(r)
}
/*
GetDevice Get Device
This request returns the high-level information for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceRequest
*/
func (a *DeviceInformationAPIService) GetDevice(ctx context.Context, deviceId string) ApiGetDeviceRequest {
return ApiGetDeviceRequest{
ApiService: a,
ctx: ctx,
deviceId: deviceId,
}
}
// Execute executes the request
// @return DeviceInformationGetDevice200Response
func (a *DeviceInformationAPIService) GetDeviceExecute(r ApiGetDeviceRequest) (*DeviceInformationGetDevice200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DeviceInformationGetDevice200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DeviceInformationAPIService.GetDevice")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/devices/{device_id}"
localVarPath = strings.Replace(localVarPath, "{"+"device_id"+"}", url.PathEscape(parameterValueToString(r.deviceId, "deviceId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiGetDeviceActivityRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
limit *string
offset *string
}
// A hard upper <code>limit</code> is set at 300 device records returned per request. If more device records are expected, pagination should be used using the <code>limit</code> and <code>offset</code> parameters. Additionally, parameter queries can be added to a request to limit the results.
func (r ApiGetDeviceActivityRequest) Limit(limit string) ApiGetDeviceActivityRequest {
r.limit = &limit
return r
}
// Specify the starting record to return
func (r ApiGetDeviceActivityRequest) Offset(offset string) ApiGetDeviceActivityRequest {
r.offset = &offset
return r
}
func (r ApiGetDeviceActivityRequest) Execute() (*DeviceInformationGetDeviceActivity200Response, *http.Response, error) {
return r.ApiService.GetDeviceActivityExecute(r)
}
/*
GetDeviceActivity Get Device Activity
This request returns the device activity for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceActivityRequest
*/
func (a *DeviceInformationAPIService) GetDeviceActivity(ctx context.Context, deviceId string) ApiGetDeviceActivityRequest {
return ApiGetDeviceActivityRequest{
ApiService: a,
ctx: ctx,
deviceId: deviceId,
}
}
// Execute executes the request
// @return DeviceInformationGetDeviceActivity200Response
func (a *DeviceInformationAPIService) GetDeviceActivityExecute(r ApiGetDeviceActivityRequest) (*DeviceInformationGetDeviceActivity200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DeviceInformationGetDeviceActivity200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DeviceInformationAPIService.GetDeviceActivity")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/devices/{device_id}/activity"
localVarPath = strings.Replace(localVarPath, "{"+"device_id"+"}", url.PathEscape(parameterValueToString(r.deviceId, "deviceId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.limit == nil {
return localVarReturnValue, nil, reportError("limit is required and must be specified")
}
parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "form", "")
if r.offset != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "offset", r.offset, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiGetDeviceAppsRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
}
func (r ApiGetDeviceAppsRequest) Execute() (*DeviceInformationGetDeviceApps200Response, *http.Response, error) {
return r.ApiService.GetDeviceAppsExecute(r)
}
/*
GetDeviceApps Get Device Apps
<p>This request returns a list of all installed apps for a specified Device ID.</p>
<p>For iPhone and iPad, the preinstalled Apple apps are not reported.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceAppsRequest
*/
func (a *DeviceInformationAPIService) GetDeviceApps(ctx context.Context, deviceId string) ApiGetDeviceAppsRequest {
return ApiGetDeviceAppsRequest{
ApiService: a,
ctx: ctx,
deviceId: deviceId,
}
}
// Execute executes the request
// @return DeviceInformationGetDeviceApps200Response
func (a *DeviceInformationAPIService) GetDeviceAppsExecute(r ApiGetDeviceAppsRequest) (*DeviceInformationGetDeviceApps200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DeviceInformationGetDeviceApps200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DeviceInformationAPIService.GetDeviceApps")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/devices/{device_id}/apps"
localVarPath = strings.Replace(localVarPath, "{"+"device_id"+"}", url.PathEscape(parameterValueToString(r.deviceId, "deviceId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiGetDeviceDetailsRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
}
func (r ApiGetDeviceDetailsRequest) Execute() (*DeviceInformationGetDeviceDetails200Response, *http.Response, error) {
return r.ApiService.GetDeviceDetailsExecute(r)
}
/*
GetDeviceDetails Get Device Details
This request returns the device details for a specified Device ID.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId
@return ApiGetDeviceDetailsRequest
*/
func (a *DeviceInformationAPIService) GetDeviceDetails(ctx context.Context, deviceId string) ApiGetDeviceDetailsRequest {
return ApiGetDeviceDetailsRequest{
ApiService: a,
ctx: ctx,
deviceId: deviceId,
}
}
// Execute executes the request
// @return DeviceInformationGetDeviceDetails200Response
func (a *DeviceInformationAPIService) GetDeviceDetailsExecute(r ApiGetDeviceDetailsRequest) (*DeviceInformationGetDeviceDetails200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DeviceInformationGetDeviceDetails200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DeviceInformationAPIService.GetDeviceDetails")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/devices/{device_id}/details"
localVarPath = strings.Replace(localVarPath, "{"+"device_id"+"}", url.PathEscape(parameterValueToString(r.deviceId, "deviceId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiGetDeviceLibraryItemsRequest struct {
ctx context.Context
ApiService DeviceInformationAPI
deviceId string
}
func (r ApiGetDeviceLibraryItemsRequest) Execute() (*DeviceInformationGetDeviceLibraryItems200Response, *http.Response, error) {
return r.ApiService.GetDeviceLibraryItemsExecute(r)
}
/*
GetDeviceLibraryItems Get Device Library Items
<p>This request gets all library items and their statuses for a specified Device ID</p>
<h4 id="possible-library-item-status-values">Possible library item status values</h4>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Value</strong></th>
<th><strong>Type</strong></th>
<th><strong>Additional Info</strong></th>
</tr>
</thead>
<tbody>