Skip to content

Commit 0a17f7e

Browse files
github-actions[bot]MScottBlake
authored andcommitted
[auto] Updated Kandji SDK
1 parent 6cd9920 commit 0a17f7e

File tree

105 files changed

+1816
-532
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+1816
-532
lines changed

.openapi-generator/FILES

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,15 @@ docs/DeviceInformationGetDevice200ResponseUser.md
3030
docs/DeviceInformationGetDeviceActivity200Response.md
3131
docs/DeviceInformationGetDeviceApps200Response.md
3232
docs/DeviceInformationGetDeviceDetails200Response.md
33-
docs/DeviceInformationGetDeviceDetails200ResponseActivationLock.md
34-
docs/DeviceInformationGetDeviceDetails200ResponseAppleBusinessManager.md
35-
docs/DeviceInformationGetDeviceDetails200ResponseAutomatedDeviceEnrollment.md
3633
docs/DeviceInformationGetDeviceDetails200ResponseCellular.md
37-
docs/DeviceInformationGetDeviceDetails200ResponseFilevault.md
3834
docs/DeviceInformationGetDeviceDetails200ResponseGeneral.md
39-
docs/DeviceInformationGetDeviceDetails200ResponseHardwareOverview.md
40-
docs/DeviceInformationGetDeviceDetails200ResponseKandjiAgent.md
41-
docs/DeviceInformationGetDeviceDetails200ResponseLostMode.md
42-
docs/DeviceInformationGetDeviceDetails200ResponseLostModeLastLocation.md
43-
docs/DeviceInformationGetDeviceDetails200ResponseMdm.md
44-
docs/DeviceInformationGetDeviceDetails200ResponseRecoveryInformation.md
45-
docs/DeviceInformationGetDeviceDetails200ResponseSecurityInformation.md
46-
docs/DeviceInformationGetDeviceDetails200ResponseUsers.md
35+
docs/DeviceInformationGetDeviceDetails200ResponseHardware.md
36+
docs/DeviceInformationGetDeviceDetails200ResponseManagement.md
37+
docs/DeviceInformationGetDeviceDetails200ResponseSecurity.md
4738
docs/DeviceInformationGetDeviceLibraryItems200Response.md
4839
docs/DeviceInformationGetDeviceLostModeDetails200Response.md
40+
docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostMode.md
41+
docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation.md
4942
docs/DeviceInformationGetDeviceParameters200Response.md
5043
docs/DeviceInformationGetDeviceStatus200Response.md
5144
docs/DeviceInformationUpdateDevice200Response.md
@@ -125,22 +118,15 @@ kandji/models/device_information_get_device200_response_user.py
125118
kandji/models/device_information_get_device_activity200_response.py
126119
kandji/models/device_information_get_device_apps200_response.py
127120
kandji/models/device_information_get_device_details200_response.py
128-
kandji/models/device_information_get_device_details200_response_activation_lock.py
129-
kandji/models/device_information_get_device_details200_response_apple_business_manager.py
130-
kandji/models/device_information_get_device_details200_response_automated_device_enrollment.py
131121
kandji/models/device_information_get_device_details200_response_cellular.py
132-
kandji/models/device_information_get_device_details200_response_filevault.py
133122
kandji/models/device_information_get_device_details200_response_general.py
134-
kandji/models/device_information_get_device_details200_response_hardware_overview.py
135-
kandji/models/device_information_get_device_details200_response_kandji_agent.py
136-
kandji/models/device_information_get_device_details200_response_lost_mode.py
137-
kandji/models/device_information_get_device_details200_response_lost_mode_last_location.py
138-
kandji/models/device_information_get_device_details200_response_mdm.py
139-
kandji/models/device_information_get_device_details200_response_recovery_information.py
140-
kandji/models/device_information_get_device_details200_response_security_information.py
141-
kandji/models/device_information_get_device_details200_response_users.py
123+
kandji/models/device_information_get_device_details200_response_hardware.py
124+
kandji/models/device_information_get_device_details200_response_management.py
125+
kandji/models/device_information_get_device_details200_response_security.py
142126
kandji/models/device_information_get_device_library_items200_response.py
143127
kandji/models/device_information_get_device_lost_mode_details200_response.py
128+
kandji/models/device_information_get_device_lost_mode_details200_response_lost_mode.py
129+
kandji/models/device_information_get_device_lost_mode_details200_response_lost_mode_last_location.py
144130
kandji/models/device_information_get_device_parameters200_response.py
145131
kandji/models/device_information_get_device_status200_response.py
146132
kandji/models/device_information_update_device200_response.py
@@ -177,4 +163,9 @@ setup.cfg
177163
setup.py
178164
test-requirements.txt
179165
test/__init__.py
166+
test/test_device_information_get_device_details200_response_hardware.py
167+
test/test_device_information_get_device_details200_response_management.py
168+
test/test_device_information_get_device_details200_response_security.py
169+
test/test_device_information_get_device_lost_mode_details200_response_lost_mode.py
170+
test/test_device_information_get_device_lost_mode_details200_response_lost_mode_last_location.py
180171
tox.ini

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# kandji
2-
<html><head></head><body><h1 id=&quot;welcome-to-the-kandji-api-documentation&quot;>Welcome to the Kandji API Documentation</h1>
2+
<html><head></head><body><h1 id=&quot;welcome-to-the-iru-endpoint-management-api-documentation&quot;>Welcome to the Iru Endpoint Management API Documentation</h1>
3+
<p><strong>Note:</strong> Kandji is now Iru, but many URLs and notes within this documentation will continue to reference Kandji for some time.</p>
34
<p>You can find your API URL in Settings &gt; Access. The API URL will follow the below formats.</p>
45
<ul>
56
<li><p>US - <code>https://SubDomain.api.kandji.io</code></p>
@@ -10,9 +11,9 @@
1011
<p>For information on how to obtain an API token, please refer to the following support article.</p>
1112
<p><a href=&quot;https://support.kandji.io/api&quot;>https://support.kandji.io/api</a></p>
1213
<h4 id=&quot;rate-limit&quot;>Rate Limit</h4>
13-
<p>The Kandji API currently has an API rate limit of 10,000 requests per hour per customer.</p>
14+
<p>The Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.</p>
1415
<h4 id=&quot;request-methods&quot;>Request Methods</h4>
15-
<p>HTTP request methods supported by the Kandji API.</p>
16+
<p>HTTP request methods supported by the API.</p>
1617
<div class=&quot;click-to-expand-wrapper is-table-wrapper&quot;><table>
1718
<thead>
1819
<tr>
@@ -103,7 +104,7 @@
103104
</tr>
104105
<tr>
105106
<td></td>
106-
<td>Unable to locate the resource in the Kandji tenant.</td>
107+
<td>Unable to locate the resource in the Iru tenant.</td>
107108
</tr>
108109
<tr>
109110
<td>415</td>
@@ -130,7 +131,7 @@
130131
</div><h4 id=&quot;data-structure&quot;>Data structure</h4>
131132
<p>The API returns all structured responses in JSON schema format.</p>
132133
<h4 id=&quot;examples&quot;>Examples</h4>
133-
<p>Code examples using the API can be found in the Kandji support <a href=&quot;https://github.com/kandji-inc/support/tree/main/api-tools&quot;>GitHub</a>.</p>
134+
<p>Code examples using the API can be found in the Iru Endpoint Management support <a href=&quot;https://github.com/kandji-inc/support/tree/main/api-tools&quot;>GitHub</a>.</p>
134135
</body></html>
135136

136137
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
@@ -258,6 +259,7 @@ Class | Method | HTTP request | Description
258259
*DeviceActionsApi* | [**erase_device**](docs/DeviceActionsApi.md#erase_device) | **POST** /api/v1/devices/{device_id}/action/erase | Erase Device
259260
*DeviceActionsApi* | [**get_device_commands**](docs/DeviceActionsApi.md#get_device_commands) | **GET** /api/v1/devices/{device_id}/commands | Get Device Commands
260261
*DeviceActionsApi* | [**lock_device**](docs/DeviceActionsApi.md#lock_device) | **POST** /api/v1/devices/{device_id}/action/lock | Lock Device
262+
*DeviceActionsApi* | [**perform_daily_checkin**](docs/DeviceActionsApi.md#perform_daily_checkin) | **POST** /api/v1/devices/{device_id}/action/dailycheckin | Perform Daily Check-in
261263
*DeviceActionsApi* | [**reinstall_agent**](docs/DeviceActionsApi.md#reinstall_agent) | **POST** /api/v1/devices/{device_id}/action/reinstallagent | Reinstall Agent
262264
*DeviceActionsApi* | [**remote_desktop**](docs/DeviceActionsApi.md#remote_desktop) | **POST** /api/v1/devices/{device_id}/action/remotedesktop | Remote Desktop
263265
*DeviceActionsApi* | [**renew_mdm_profile**](docs/DeviceActionsApi.md#renew_mdm_profile) | **POST** /api/v1/devices/{device_id}/action/renewmdmprofile | Renew MDM Profile
@@ -344,22 +346,15 @@ Class | Method | HTTP request | Description
344346
- [DeviceInformationGetDeviceActivity200Response](docs/DeviceInformationGetDeviceActivity200Response.md)
345347
- [DeviceInformationGetDeviceApps200Response](docs/DeviceInformationGetDeviceApps200Response.md)
346348
- [DeviceInformationGetDeviceDetails200Response](docs/DeviceInformationGetDeviceDetails200Response.md)
347-
- [DeviceInformationGetDeviceDetails200ResponseActivationLock](docs/DeviceInformationGetDeviceDetails200ResponseActivationLock.md)
348-
- [DeviceInformationGetDeviceDetails200ResponseAppleBusinessManager](docs/DeviceInformationGetDeviceDetails200ResponseAppleBusinessManager.md)
349-
- [DeviceInformationGetDeviceDetails200ResponseAutomatedDeviceEnrollment](docs/DeviceInformationGetDeviceDetails200ResponseAutomatedDeviceEnrollment.md)
350349
- [DeviceInformationGetDeviceDetails200ResponseCellular](docs/DeviceInformationGetDeviceDetails200ResponseCellular.md)
351-
- [DeviceInformationGetDeviceDetails200ResponseFilevault](docs/DeviceInformationGetDeviceDetails200ResponseFilevault.md)
352350
- [DeviceInformationGetDeviceDetails200ResponseGeneral](docs/DeviceInformationGetDeviceDetails200ResponseGeneral.md)
353-
- [DeviceInformationGetDeviceDetails200ResponseHardwareOverview](docs/DeviceInformationGetDeviceDetails200ResponseHardwareOverview.md)
354-
- [DeviceInformationGetDeviceDetails200ResponseKandjiAgent](docs/DeviceInformationGetDeviceDetails200ResponseKandjiAgent.md)
355-
- [DeviceInformationGetDeviceDetails200ResponseLostMode](docs/DeviceInformationGetDeviceDetails200ResponseLostMode.md)
356-
- [DeviceInformationGetDeviceDetails200ResponseLostModeLastLocation](docs/DeviceInformationGetDeviceDetails200ResponseLostModeLastLocation.md)
357-
- [DeviceInformationGetDeviceDetails200ResponseMdm](docs/DeviceInformationGetDeviceDetails200ResponseMdm.md)
358-
- [DeviceInformationGetDeviceDetails200ResponseRecoveryInformation](docs/DeviceInformationGetDeviceDetails200ResponseRecoveryInformation.md)
359-
- [DeviceInformationGetDeviceDetails200ResponseSecurityInformation](docs/DeviceInformationGetDeviceDetails200ResponseSecurityInformation.md)
360-
- [DeviceInformationGetDeviceDetails200ResponseUsers](docs/DeviceInformationGetDeviceDetails200ResponseUsers.md)
351+
- [DeviceInformationGetDeviceDetails200ResponseHardware](docs/DeviceInformationGetDeviceDetails200ResponseHardware.md)
352+
- [DeviceInformationGetDeviceDetails200ResponseManagement](docs/DeviceInformationGetDeviceDetails200ResponseManagement.md)
353+
- [DeviceInformationGetDeviceDetails200ResponseSecurity](docs/DeviceInformationGetDeviceDetails200ResponseSecurity.md)
361354
- [DeviceInformationGetDeviceLibraryItems200Response](docs/DeviceInformationGetDeviceLibraryItems200Response.md)
362355
- [DeviceInformationGetDeviceLostModeDetails200Response](docs/DeviceInformationGetDeviceLostModeDetails200Response.md)
356+
- [DeviceInformationGetDeviceLostModeDetails200ResponseLostMode](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostMode.md)
357+
- [DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation](docs/DeviceInformationGetDeviceLostModeDetails200ResponseLostModeLastLocation.md)
363358
- [DeviceInformationGetDeviceParameters200Response](docs/DeviceInformationGetDeviceParameters200Response.md)
364359
- [DeviceInformationGetDeviceStatus200Response](docs/DeviceInformationGetDeviceStatus200Response.md)
365360
- [DeviceInformationUpdateDevice200Response](docs/DeviceInformationUpdateDevice200Response.md)

docs/AuditLogApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212
1313
List audit events
1414

15-
<p>List audit log events from the Kandji Activity module.</p>
15+
<p>List audit log events from the Activity module.</p>
1616
<p>Returns events related to</p>
1717
<ul>
1818
<li><p>Blueprint and Library Item creation, updates, and deletions (Create, Update, Delete)</p>

docs/AutomatedDeviceEnrollmentIntegrationsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Delete ADE integration
109109

110110
<h1 id=&quot;warning&quot;><strong>WARNING!</strong></h1>
111111
<p>This is a HIGHLY destructive action.</p>
112-
<p>Deleting an ADE token will unassign the associated device records from Kandji. For currently enrolled devices that were assigned to Kandji via the delete ADE integration will not be impacted until they are wiped and reprovisioned. This action is essentially the same as removing an ADE token from MDM and then adding it back.</p>
112+
<p>Deleting an ADE token will unassign the associated device records. For currently enrolled devices that were assigned via the delete ADE integration will not be impacted until they are wiped and reprovisioned. This action is essentially the same as removing an ADE token from MDM and then adding it back.</p>
113113
<p>If applicable, be sure to reassign the device records in ABM.</p>
114114

115115
### Example
@@ -445,7 +445,7 @@ with kandji.ApiClient(configuration) as api_client:
445445
# Create an instance of the API class
446446
api_instance = kandji.AutomatedDeviceEnrollmentIntegrationsApi(api_client)
447447
blueprint_id = 'fce0cc58-caa5-40d2-a0d7-a0b257127ec5' # str | Return results &quot;containing&quot; the specified blueprint id (optional)
448-
user_id = '5344c996-8823-4b37-8d6e-8515fc7c3a0a' # str | &quot;exact&quot; match on kandji user ID value (example: 5344c996-8823-4b37-8d6e-8515fc7c3a0a) (optional)
448+
user_id = '5344c996-8823-4b37-8d6e-8515fc7c3a0a' # str | &quot;exact&quot; match on user ID value (example: 5344c996-8823-4b37-8d6e-8515fc7c3a0a) (optional)
449449
dep_account = '' # str | The ADE token UUID (optional)
450450
device_family = '' # str | iPad, iPhone, iPod, Mac, AppleTV, or Vision (optional)
451451
model = 'MacBook Air' # str | Return model results &quot;containing&quot; the specified model string. - &quot;iPad (8th Generation)&quot;, &quot;MacBook Air&quot; (optional)
@@ -471,7 +471,7 @@ with kandji.ApiClient(configuration) as api_client:
471471
Name | Type | Description | Notes
472472
------------- | ------------- | ------------- | -------------
473473
**blueprint_id** | **str**| Return results &amp;quot;containing&amp;quot; the specified blueprint id | [optional]
474-
**user_id** | **str**| &amp;quot;exact&amp;quot; match on kandji user ID value (example: 5344c996-8823-4b37-8d6e-8515fc7c3a0a) | [optional]
474+
**user_id** | **str**| &amp;quot;exact&amp;quot; match on user ID value (example: 5344c996-8823-4b37-8d6e-8515fc7c3a0a) | [optional]
475475
**dep_account** | **str**| The ADE token UUID | [optional]
476476
**device_family** | **str**| iPad, iPhone, iPod, Mac, AppleTV, or Vision | [optional]
477477
**model** | **str**| Return model results &amp;quot;containing&amp;quot; the specified model string. - &amp;quot;iPad (8th Generation)&amp;quot;, &amp;quot;MacBook Air&amp;quot; | [optional]
@@ -579,7 +579,7 @@ void (empty response body)
579579
List devices associated to ADE token
580580

581581
<p>This request returns a list of devices associated with a specified <code>ade_token_id</code> as well as their enrollment status.</p>
582-
<p>When the <code>mdm_device</code> key value is <code>null</code>, this can be taken as an indication that the device is awaiting enrollment into Kandji.</p>
582+
<p>When the <code>mdm_device</code> key value is <code>null</code>, this can be taken as an indication that the device is awaiting enrollment.</p>
583583
<p>When data is present within the mdm_device dictionary, you can reference the <code>device_id</code> as the ID of the enrolled device record.</p>
584584

585585
### Example

docs/BlueprintsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Method | HTTP request | Description
2020
2121
Create Blueprint
2222

23-
<p>This request creates a new empty Blueprint or a new Blueprint from a template. The keys <code>name</code> and <code>enrollment_code</code> <code>is_active</code> are required, and the blueprint name key must be unique from the existing blueprint names in the Kandji tenant.</p>
23+
<p>This request creates a new empty Blueprint or a new Blueprint from a template. The keys <code>name</code> and <code>enrollment_code</code> <code>is_active</code> are required, and the blueprint name key must be unique from the existing blueprint names in the tenant.</p>
2424
<p>optionally, <code>type: map</code> can be used when creating a new Assignment Map blueprint.</p>
2525
<p>Note: If cloning an existing blueprint,`type` value and the type of sourced (`source.id`) blueprint must match and `source.type` value must be set to `blueprint`.</p>
2626

@@ -429,7 +429,7 @@ Name | Type | Description | Notes
429429
430430
List Blueprints
431431

432-
This request returns a list of a blueprint records in the Kandji tenant. Optional query parameters can be specified to filter the results.
432+
This request returns a list of a Blueprints. Optional query parameters can be specified to filter the results.
433433

434434
### Example
435435

0 commit comments

Comments
 (0)