@rippling/rippling-sdk 0.2.0-alpha.62 → 0.2.0-alpha.64
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client.d.mts +12 -12
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -12
- package/client.d.ts.map +1 -1
- package/client.js +12 -12
- package/client.js.map +1 -1
- package/client.mjs +12 -12
- package/client.mjs.map +1 -1
- package/examples/manifest/dental-practice-management/dental-practice-management.ts +6 -5
- package/examples/manifest/gym-membership-management/gym-membership-management.ts +6 -5
- package/examples/manifest/simple-todo-app/simple-todo-app.ts +3 -1
- package/lib/manifest/custom-object-page-layout.d.mts +0 -6
- package/lib/manifest/custom-object-page-layout.d.mts.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.ts +0 -6
- package/lib/manifest/custom-object-page-layout.d.ts.map +1 -1
- package/lib/manifest/custom-object-page-layout.js +16 -5
- package/lib/manifest/custom-object-page-layout.js.map +1 -1
- package/lib/manifest/custom-object-page-layout.mjs +16 -5
- package/lib/manifest/custom-object-page-layout.mjs.map +1 -1
- package/lib/manifest/index.d.mts +2 -2
- package/lib/manifest/index.d.mts.map +1 -1
- package/lib/manifest/index.d.ts +2 -2
- package/lib/manifest/index.d.ts.map +1 -1
- package/lib/manifest/index.js.map +1 -1
- package/lib/manifest/index.mjs.map +1 -1
- package/lib/manifest/manifest-function.d.mts +4 -7
- package/lib/manifest/manifest-function.d.mts.map +1 -1
- package/lib/manifest/manifest-function.d.ts +4 -7
- package/lib/manifest/manifest-function.d.ts.map +1 -1
- package/lib/manifest/manifest-function.js +7 -11
- package/lib/manifest/manifest-function.js.map +1 -1
- package/lib/manifest/manifest-function.mjs +7 -10
- package/lib/manifest/manifest-function.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/app-users.d.mts +186 -0
- package/resources/app-users.d.mts.map +1 -0
- package/resources/app-users.d.ts +186 -0
- package/resources/app-users.d.ts.map +1 -0
- package/resources/app-users.js +32 -0
- package/resources/app-users.js.map +1 -0
- package/resources/app-users.mjs +28 -0
- package/resources/app-users.mjs.map +1 -0
- package/resources/devices.d.mts +272 -0
- package/resources/devices.d.mts.map +1 -0
- package/resources/devices.d.ts +272 -0
- package/resources/devices.d.ts.map +1 -0
- package/resources/devices.js +32 -0
- package/resources/devices.js.map +1 -0
- package/resources/devices.mjs +28 -0
- package/resources/devices.mjs.map +1 -0
- package/resources/functions/deployments.d.mts +8 -0
- package/resources/functions/deployments.d.mts.map +1 -1
- package/resources/functions/deployments.d.ts +8 -0
- package/resources/functions/deployments.d.ts.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +6 -6
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/workers.d.mts +13 -0
- package/resources/workers.d.mts.map +1 -1
- package/resources/workers.d.ts +13 -0
- package/resources/workers.d.ts.map +1 -1
- package/src/client.ts +44 -38
- package/src/lib/manifest/custom-object-page-layout.ts +14 -9
- package/src/lib/manifest/index.ts +0 -3
- package/src/lib/manifest/manifest-function.ts +8 -18
- package/src/resources/app-users.ts +270 -0
- package/src/resources/devices.ts +496 -0
- package/src/resources/functions/deployments.ts +10 -0
- package/src/resources/index.ts +16 -13
- package/src/resources/workers.ts +15 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/worker-change-fields.d.mts +0 -45
- package/resources/worker-change-fields.d.mts.map +0 -1
- package/resources/worker-change-fields.d.ts +0 -45
- package/resources/worker-change-fields.d.ts.map +0 -1
- package/resources/worker-change-fields.js +0 -21
- package/resources/worker-change-fields.js.map +0 -1
- package/resources/worker-change-fields.mjs +0 -17
- package/resources/worker-change-fields.mjs.map +0 -1
- package/resources/worker-changes.d.mts +0 -267
- package/resources/worker-changes.d.mts.map +0 -1
- package/resources/worker-changes.d.ts +0 -267
- package/resources/worker-changes.d.ts.map +0 -1
- package/resources/worker-changes.js +0 -36
- package/resources/worker-changes.js.map +0 -1
- package/resources/worker-changes.mjs +0 -32
- package/resources/worker-changes.mjs.map +0 -1
- package/src/resources/worker-change-fields.ts +0 -64
- package/src/resources/worker-changes.ts +0 -354
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.mjs";
|
|
3
|
+
import * as WorkersAPI from "./workers.mjs";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* Devices (laptops, desktops, phones, tablets) managed by Rippling
|
|
9
|
+
*/
|
|
10
|
+
export declare class Devices extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* A list of devices.
|
|
13
|
+
*
|
|
14
|
+
* - Requires: `API Tier 2`
|
|
15
|
+
* - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
|
|
16
|
+
* `enrollment_status`
|
|
17
|
+
* - Expandable fields: `worker`, `pending_actions`
|
|
18
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
19
|
+
*/
|
|
20
|
+
list(query?: DeviceListParams | null | undefined, options?: RequestOptions): PagePromise<DeviceListResponsesPageCursorURL, DeviceListResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieve a specific device
|
|
23
|
+
*/
|
|
24
|
+
retrieve(id: string, query?: DeviceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DeviceRetrieveResponse>;
|
|
25
|
+
}
|
|
26
|
+
export type DeviceListResponsesPageCursorURL = PageCursorURL<DeviceListResponse>;
|
|
27
|
+
export interface DeviceListResponse {
|
|
28
|
+
/**
|
|
29
|
+
* Identifier field
|
|
30
|
+
*/
|
|
31
|
+
id: string;
|
|
32
|
+
/**
|
|
33
|
+
* Record creation date
|
|
34
|
+
*/
|
|
35
|
+
created_at: string;
|
|
36
|
+
/**
|
|
37
|
+
* Record update date
|
|
38
|
+
*/
|
|
39
|
+
updated_at: string;
|
|
40
|
+
/**
|
|
41
|
+
* The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
|
|
42
|
+
* etc.
|
|
43
|
+
*/
|
|
44
|
+
enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
|
|
45
|
+
/**
|
|
46
|
+
* Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
|
|
47
|
+
* Windows).
|
|
48
|
+
*/
|
|
49
|
+
is_encrypted?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Whether the device is managed via MDM.
|
|
52
|
+
*/
|
|
53
|
+
is_managed?: boolean;
|
|
54
|
+
/**
|
|
55
|
+
* When the Rippling agent last checked in from this device.
|
|
56
|
+
*/
|
|
57
|
+
last_checkin_at?: string;
|
|
58
|
+
/**
|
|
59
|
+
* When the device last synced with MDM.
|
|
60
|
+
*/
|
|
61
|
+
last_mdm_sync_at?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
|
|
64
|
+
*/
|
|
65
|
+
lifecycle_state?: 'INIT' | 'ACTIVE' | 'ACTIVATING' | 'LOCKED' | 'LOCKING' | 'INACTIVE' | 'PENDING_MDM' | 'CLEANING' | 'READY' | 'DECOMMISSIONING' | 'DECOMMISSIONED' | 'FULL_WIPING' | 'FULL_WIPED' | 'E_CYCLED' | 'MDM_LOCKED' | 'LOST' | 'LOST_PLAYING_SOUND';
|
|
66
|
+
/**
|
|
67
|
+
* The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
|
|
68
|
+
* KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
|
|
69
|
+
* unenrolled or recently-reset devices).
|
|
70
|
+
*/
|
|
71
|
+
mdm_provider?: 'RIPPLING' | 'JUMPCLOUD' | 'JAMFCLOUD' | 'FLEETSMITH' | 'HEXNODE' | 'MICROMDM' | 'MERAKI' | 'SOTI' | 'ADDIGY' | 'FLEETDM' | 'KANDJI' | 'ZOHO' | 'INTUNE' | 'OTHER';
|
|
72
|
+
/**
|
|
73
|
+
* The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
|
|
74
|
+
* 'iPhone15,2').
|
|
75
|
+
*/
|
|
76
|
+
model?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The device operating system name.
|
|
79
|
+
*/
|
|
80
|
+
os_name?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The device operating system version.
|
|
83
|
+
*/
|
|
84
|
+
os_version?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Actions currently queued against the device (not yet completed). Expandable.
|
|
87
|
+
*
|
|
88
|
+
* Expandable field
|
|
89
|
+
*/
|
|
90
|
+
pending_actions?: Array<DeviceListResponse.PendingAction>;
|
|
91
|
+
/**
|
|
92
|
+
* The IDs of actions currently queued against the device (not yet completed).
|
|
93
|
+
*/
|
|
94
|
+
pending_actions_id?: Array<string>;
|
|
95
|
+
/**
|
|
96
|
+
* The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
|
|
97
|
+
*/
|
|
98
|
+
platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
|
|
99
|
+
/**
|
|
100
|
+
* The device's hardware serial number.
|
|
101
|
+
*/
|
|
102
|
+
serial_number?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The worker this device is currently assigned to.
|
|
105
|
+
*
|
|
106
|
+
* Expandable field
|
|
107
|
+
*/
|
|
108
|
+
worker?: WorkersAPI.Worker;
|
|
109
|
+
/**
|
|
110
|
+
* The ID of the worker this device is currently assigned to. Null if unassigned.
|
|
111
|
+
*/
|
|
112
|
+
worker_id?: string;
|
|
113
|
+
}
|
|
114
|
+
export declare namespace DeviceListResponse {
|
|
115
|
+
interface PendingAction {
|
|
116
|
+
/**
|
|
117
|
+
* Identifier field
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* Record creation date
|
|
122
|
+
*/
|
|
123
|
+
created_at: string;
|
|
124
|
+
/**
|
|
125
|
+
* Record update date
|
|
126
|
+
*/
|
|
127
|
+
updated_at: string;
|
|
128
|
+
/**
|
|
129
|
+
* The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
|
|
130
|
+
*/
|
|
131
|
+
action_type?: 'ADD_USER_TO_FILEVAULT' | 'ASSIGN_DEVICE' | 'AUTHENTICATE_AGENT' | 'CHANGE_FILEVAULT_RECOVERY_KEY' | 'CHANGE_PASSWORD' | 'CLEAR_PASSCODE' | 'CREATE_RIPPLING_ADMIN' | 'DELETE_LOCAL_ACCOUNT' | 'DEMOTE_ACCOUNT_PERMISSION' | 'DISABLE_FIND_MY' | 'DISABLE_LOST_MODE' | 'DISABLE_REMOTE_DESKTOP' | 'ENABLE_LOST_MODE' | 'ENABLE_REMOTE_DESKTOP' | 'ENFORCE_PASSWORD_POLICY' | 'FORCE_CHECK_IN' | 'FULL_WIPE' | 'GRANT_SECURE_TOKEN' | 'INSTALL_ENROLLMENT_PROFILE' | 'LOCK_DEVICE' | 'LOCK_USER_ACCOUNT' | 'LOST_MODE_GET_LOCATION' | 'LOST_MODE_PLAY_SOUND' | 'PROMOTE_ACCOUNT_PERMISSION' | 'RECOVER_AGENT_VIA_MDM' | 'REINSTALL_AGENT' | 'REINSTALL_ENROLLMENT_PROFILE' | 'REMOVE_OTHER_ENROLLMENT_PROFILES' | 'RESET_PASSWORD' | 'RESTART_DEVICE' | 'ROTATE_FILEVAULT_KEY' | 'SHUTDOWN_DEVICE' | 'SOFT_WIPE' | 'TURN_ON_FILEVAULT' | 'UNASSIGN_DEVICE' | 'UNINSTALL_AGENT' | 'UNINSTALL_ANTIVIRUS' | 'UNINSTALL_MDM' | 'UNLOCK_DEVICE' | 'UNLOCK_USER_ACCOUNT' | 'UPDATE_OS' | 'UNKNOWN';
|
|
132
|
+
/**
|
|
133
|
+
* When the action was queued.
|
|
134
|
+
*/
|
|
135
|
+
queued_at?: string;
|
|
136
|
+
/**
|
|
137
|
+
* The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
|
|
138
|
+
*/
|
|
139
|
+
state?: string;
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Meta information for the response.
|
|
144
|
+
*/
|
|
145
|
+
export interface DeviceRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
146
|
+
/**
|
|
147
|
+
* Identifier field
|
|
148
|
+
*/
|
|
149
|
+
id: string;
|
|
150
|
+
/**
|
|
151
|
+
* Record creation date
|
|
152
|
+
*/
|
|
153
|
+
created_at: string;
|
|
154
|
+
/**
|
|
155
|
+
* Record update date
|
|
156
|
+
*/
|
|
157
|
+
updated_at: string;
|
|
158
|
+
/**
|
|
159
|
+
* The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
|
|
160
|
+
* etc.
|
|
161
|
+
*/
|
|
162
|
+
enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
|
|
163
|
+
/**
|
|
164
|
+
* Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
|
|
165
|
+
* Windows).
|
|
166
|
+
*/
|
|
167
|
+
is_encrypted?: boolean;
|
|
168
|
+
/**
|
|
169
|
+
* Whether the device is managed via MDM.
|
|
170
|
+
*/
|
|
171
|
+
is_managed?: boolean;
|
|
172
|
+
/**
|
|
173
|
+
* When the Rippling agent last checked in from this device.
|
|
174
|
+
*/
|
|
175
|
+
last_checkin_at?: string;
|
|
176
|
+
/**
|
|
177
|
+
* When the device last synced with MDM.
|
|
178
|
+
*/
|
|
179
|
+
last_mdm_sync_at?: string;
|
|
180
|
+
/**
|
|
181
|
+
* The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
|
|
182
|
+
*/
|
|
183
|
+
lifecycle_state?: 'INIT' | 'ACTIVE' | 'ACTIVATING' | 'LOCKED' | 'LOCKING' | 'INACTIVE' | 'PENDING_MDM' | 'CLEANING' | 'READY' | 'DECOMMISSIONING' | 'DECOMMISSIONED' | 'FULL_WIPING' | 'FULL_WIPED' | 'E_CYCLED' | 'MDM_LOCKED' | 'LOST' | 'LOST_PLAYING_SOUND';
|
|
184
|
+
/**
|
|
185
|
+
* The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
|
|
186
|
+
* KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
|
|
187
|
+
* unenrolled or recently-reset devices).
|
|
188
|
+
*/
|
|
189
|
+
mdm_provider?: 'RIPPLING' | 'JUMPCLOUD' | 'JAMFCLOUD' | 'FLEETSMITH' | 'HEXNODE' | 'MICROMDM' | 'MERAKI' | 'SOTI' | 'ADDIGY' | 'FLEETDM' | 'KANDJI' | 'ZOHO' | 'INTUNE' | 'OTHER';
|
|
190
|
+
/**
|
|
191
|
+
* The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
|
|
192
|
+
* 'iPhone15,2').
|
|
193
|
+
*/
|
|
194
|
+
model?: string;
|
|
195
|
+
/**
|
|
196
|
+
* The device operating system name.
|
|
197
|
+
*/
|
|
198
|
+
os_name?: string;
|
|
199
|
+
/**
|
|
200
|
+
* The device operating system version.
|
|
201
|
+
*/
|
|
202
|
+
os_version?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Actions currently queued against the device (not yet completed). Expandable.
|
|
205
|
+
*
|
|
206
|
+
* Expandable field
|
|
207
|
+
*/
|
|
208
|
+
pending_actions?: Array<DeviceRetrieveResponse.PendingAction>;
|
|
209
|
+
/**
|
|
210
|
+
* The IDs of actions currently queued against the device (not yet completed).
|
|
211
|
+
*/
|
|
212
|
+
pending_actions_id?: Array<string>;
|
|
213
|
+
/**
|
|
214
|
+
* The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
|
|
215
|
+
*/
|
|
216
|
+
platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
|
|
217
|
+
/**
|
|
218
|
+
* The device's hardware serial number.
|
|
219
|
+
*/
|
|
220
|
+
serial_number?: string;
|
|
221
|
+
/**
|
|
222
|
+
* The worker this device is currently assigned to.
|
|
223
|
+
*
|
|
224
|
+
* Expandable field
|
|
225
|
+
*/
|
|
226
|
+
worker?: WorkersAPI.Worker;
|
|
227
|
+
/**
|
|
228
|
+
* The ID of the worker this device is currently assigned to. Null if unassigned.
|
|
229
|
+
*/
|
|
230
|
+
worker_id?: string;
|
|
231
|
+
}
|
|
232
|
+
export declare namespace DeviceRetrieveResponse {
|
|
233
|
+
interface PendingAction {
|
|
234
|
+
/**
|
|
235
|
+
* Identifier field
|
|
236
|
+
*/
|
|
237
|
+
id: string;
|
|
238
|
+
/**
|
|
239
|
+
* Record creation date
|
|
240
|
+
*/
|
|
241
|
+
created_at: string;
|
|
242
|
+
/**
|
|
243
|
+
* Record update date
|
|
244
|
+
*/
|
|
245
|
+
updated_at: string;
|
|
246
|
+
/**
|
|
247
|
+
* The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
|
|
248
|
+
*/
|
|
249
|
+
action_type?: 'ADD_USER_TO_FILEVAULT' | 'ASSIGN_DEVICE' | 'AUTHENTICATE_AGENT' | 'CHANGE_FILEVAULT_RECOVERY_KEY' | 'CHANGE_PASSWORD' | 'CLEAR_PASSCODE' | 'CREATE_RIPPLING_ADMIN' | 'DELETE_LOCAL_ACCOUNT' | 'DEMOTE_ACCOUNT_PERMISSION' | 'DISABLE_FIND_MY' | 'DISABLE_LOST_MODE' | 'DISABLE_REMOTE_DESKTOP' | 'ENABLE_LOST_MODE' | 'ENABLE_REMOTE_DESKTOP' | 'ENFORCE_PASSWORD_POLICY' | 'FORCE_CHECK_IN' | 'FULL_WIPE' | 'GRANT_SECURE_TOKEN' | 'INSTALL_ENROLLMENT_PROFILE' | 'LOCK_DEVICE' | 'LOCK_USER_ACCOUNT' | 'LOST_MODE_GET_LOCATION' | 'LOST_MODE_PLAY_SOUND' | 'PROMOTE_ACCOUNT_PERMISSION' | 'RECOVER_AGENT_VIA_MDM' | 'REINSTALL_AGENT' | 'REINSTALL_ENROLLMENT_PROFILE' | 'REMOVE_OTHER_ENROLLMENT_PROFILES' | 'RESET_PASSWORD' | 'RESTART_DEVICE' | 'ROTATE_FILEVAULT_KEY' | 'SHUTDOWN_DEVICE' | 'SOFT_WIPE' | 'TURN_ON_FILEVAULT' | 'UNASSIGN_DEVICE' | 'UNINSTALL_AGENT' | 'UNINSTALL_ANTIVIRUS' | 'UNINSTALL_MDM' | 'UNLOCK_DEVICE' | 'UNLOCK_USER_ACCOUNT' | 'UPDATE_OS' | 'UNKNOWN';
|
|
250
|
+
/**
|
|
251
|
+
* When the action was queued.
|
|
252
|
+
*/
|
|
253
|
+
queued_at?: string;
|
|
254
|
+
/**
|
|
255
|
+
* The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
|
|
256
|
+
*/
|
|
257
|
+
state?: string;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
export interface DeviceListParams {
|
|
261
|
+
cursor?: string;
|
|
262
|
+
expand?: string;
|
|
263
|
+
filter?: string;
|
|
264
|
+
order_by?: string;
|
|
265
|
+
}
|
|
266
|
+
export interface DeviceRetrieveParams {
|
|
267
|
+
expand?: string;
|
|
268
|
+
}
|
|
269
|
+
export declare namespace Devices {
|
|
270
|
+
export { type DeviceListResponse as DeviceListResponse, type DeviceRetrieveResponse as DeviceRetrieveResponse, type DeviceListResponsesPageCursorURL as DeviceListResponsesPageCursorURL, type DeviceListParams as DeviceListParams, type DeviceRetrieveParams as DeviceRetrieveParams, };
|
|
271
|
+
}
|
|
272
|
+
//# sourceMappingURL=devices.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"devices.d.mts","sourceRoot":"","sources":["../src/resources/devices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,kBAAkB,CAAC;IAIpE;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAGtC;AAED,MAAM,MAAM,gCAAgC,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEjF,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,UAAU,GAAG,wBAAwB,GAAG,OAAO,GAAG,YAAY,CAAC;IAEnF;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,aAAa,GACb,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,MAAM,GACN,oBAAoB,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,EACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,UAAU,GACV,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAE1D;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EACR,uBAAuB,GACvB,eAAe,GACf,oBAAoB,GACpB,+BAA+B,GAC/B,iBAAiB,GACjB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,oBAAoB,GACpB,4BAA4B,GAC5B,aAAa,GACb,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,iBAAiB,GACjB,8BAA8B,GAC9B,kCAAkC,GAClC,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,iBAAiB,GACjB,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,qBAAqB,GACrB,WAAW,GACX,SAAS,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB,CAAC,IAAI;IACtE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,UAAU,GAAG,wBAAwB,GAAG,OAAO,GAAG,YAAY,CAAC;IAEnF;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,aAAa,GACb,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,MAAM,GACN,oBAAoB,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,EACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,UAAU,GACV,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EACR,uBAAuB,GACvB,eAAe,GACf,oBAAoB,GACpB,+BAA+B,GAC/B,iBAAiB,GACjB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,oBAAoB,GACpB,4BAA4B,GAC5B,aAAa,GACb,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,iBAAiB,GACjB,8BAA8B,GAC9B,kCAAkC,GAClC,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,iBAAiB,GACjB,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,qBAAqB,GACrB,WAAW,GACX,SAAS,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.js";
|
|
3
|
+
import * as WorkersAPI from "./workers.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
7
|
+
/**
|
|
8
|
+
* Devices (laptops, desktops, phones, tablets) managed by Rippling
|
|
9
|
+
*/
|
|
10
|
+
export declare class Devices extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* A list of devices.
|
|
13
|
+
*
|
|
14
|
+
* - Requires: `API Tier 2`
|
|
15
|
+
* - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
|
|
16
|
+
* `enrollment_status`
|
|
17
|
+
* - Expandable fields: `worker`, `pending_actions`
|
|
18
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
19
|
+
*/
|
|
20
|
+
list(query?: DeviceListParams | null | undefined, options?: RequestOptions): PagePromise<DeviceListResponsesPageCursorURL, DeviceListResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieve a specific device
|
|
23
|
+
*/
|
|
24
|
+
retrieve(id: string, query?: DeviceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DeviceRetrieveResponse>;
|
|
25
|
+
}
|
|
26
|
+
export type DeviceListResponsesPageCursorURL = PageCursorURL<DeviceListResponse>;
|
|
27
|
+
export interface DeviceListResponse {
|
|
28
|
+
/**
|
|
29
|
+
* Identifier field
|
|
30
|
+
*/
|
|
31
|
+
id: string;
|
|
32
|
+
/**
|
|
33
|
+
* Record creation date
|
|
34
|
+
*/
|
|
35
|
+
created_at: string;
|
|
36
|
+
/**
|
|
37
|
+
* Record update date
|
|
38
|
+
*/
|
|
39
|
+
updated_at: string;
|
|
40
|
+
/**
|
|
41
|
+
* The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
|
|
42
|
+
* etc.
|
|
43
|
+
*/
|
|
44
|
+
enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
|
|
45
|
+
/**
|
|
46
|
+
* Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
|
|
47
|
+
* Windows).
|
|
48
|
+
*/
|
|
49
|
+
is_encrypted?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Whether the device is managed via MDM.
|
|
52
|
+
*/
|
|
53
|
+
is_managed?: boolean;
|
|
54
|
+
/**
|
|
55
|
+
* When the Rippling agent last checked in from this device.
|
|
56
|
+
*/
|
|
57
|
+
last_checkin_at?: string;
|
|
58
|
+
/**
|
|
59
|
+
* When the device last synced with MDM.
|
|
60
|
+
*/
|
|
61
|
+
last_mdm_sync_at?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
|
|
64
|
+
*/
|
|
65
|
+
lifecycle_state?: 'INIT' | 'ACTIVE' | 'ACTIVATING' | 'LOCKED' | 'LOCKING' | 'INACTIVE' | 'PENDING_MDM' | 'CLEANING' | 'READY' | 'DECOMMISSIONING' | 'DECOMMISSIONED' | 'FULL_WIPING' | 'FULL_WIPED' | 'E_CYCLED' | 'MDM_LOCKED' | 'LOST' | 'LOST_PLAYING_SOUND';
|
|
66
|
+
/**
|
|
67
|
+
* The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
|
|
68
|
+
* KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
|
|
69
|
+
* unenrolled or recently-reset devices).
|
|
70
|
+
*/
|
|
71
|
+
mdm_provider?: 'RIPPLING' | 'JUMPCLOUD' | 'JAMFCLOUD' | 'FLEETSMITH' | 'HEXNODE' | 'MICROMDM' | 'MERAKI' | 'SOTI' | 'ADDIGY' | 'FLEETDM' | 'KANDJI' | 'ZOHO' | 'INTUNE' | 'OTHER';
|
|
72
|
+
/**
|
|
73
|
+
* The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
|
|
74
|
+
* 'iPhone15,2').
|
|
75
|
+
*/
|
|
76
|
+
model?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The device operating system name.
|
|
79
|
+
*/
|
|
80
|
+
os_name?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The device operating system version.
|
|
83
|
+
*/
|
|
84
|
+
os_version?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Actions currently queued against the device (not yet completed). Expandable.
|
|
87
|
+
*
|
|
88
|
+
* Expandable field
|
|
89
|
+
*/
|
|
90
|
+
pending_actions?: Array<DeviceListResponse.PendingAction>;
|
|
91
|
+
/**
|
|
92
|
+
* The IDs of actions currently queued against the device (not yet completed).
|
|
93
|
+
*/
|
|
94
|
+
pending_actions_id?: Array<string>;
|
|
95
|
+
/**
|
|
96
|
+
* The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
|
|
97
|
+
*/
|
|
98
|
+
platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
|
|
99
|
+
/**
|
|
100
|
+
* The device's hardware serial number.
|
|
101
|
+
*/
|
|
102
|
+
serial_number?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The worker this device is currently assigned to.
|
|
105
|
+
*
|
|
106
|
+
* Expandable field
|
|
107
|
+
*/
|
|
108
|
+
worker?: WorkersAPI.Worker;
|
|
109
|
+
/**
|
|
110
|
+
* The ID of the worker this device is currently assigned to. Null if unassigned.
|
|
111
|
+
*/
|
|
112
|
+
worker_id?: string;
|
|
113
|
+
}
|
|
114
|
+
export declare namespace DeviceListResponse {
|
|
115
|
+
interface PendingAction {
|
|
116
|
+
/**
|
|
117
|
+
* Identifier field
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* Record creation date
|
|
122
|
+
*/
|
|
123
|
+
created_at: string;
|
|
124
|
+
/**
|
|
125
|
+
* Record update date
|
|
126
|
+
*/
|
|
127
|
+
updated_at: string;
|
|
128
|
+
/**
|
|
129
|
+
* The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
|
|
130
|
+
*/
|
|
131
|
+
action_type?: 'ADD_USER_TO_FILEVAULT' | 'ASSIGN_DEVICE' | 'AUTHENTICATE_AGENT' | 'CHANGE_FILEVAULT_RECOVERY_KEY' | 'CHANGE_PASSWORD' | 'CLEAR_PASSCODE' | 'CREATE_RIPPLING_ADMIN' | 'DELETE_LOCAL_ACCOUNT' | 'DEMOTE_ACCOUNT_PERMISSION' | 'DISABLE_FIND_MY' | 'DISABLE_LOST_MODE' | 'DISABLE_REMOTE_DESKTOP' | 'ENABLE_LOST_MODE' | 'ENABLE_REMOTE_DESKTOP' | 'ENFORCE_PASSWORD_POLICY' | 'FORCE_CHECK_IN' | 'FULL_WIPE' | 'GRANT_SECURE_TOKEN' | 'INSTALL_ENROLLMENT_PROFILE' | 'LOCK_DEVICE' | 'LOCK_USER_ACCOUNT' | 'LOST_MODE_GET_LOCATION' | 'LOST_MODE_PLAY_SOUND' | 'PROMOTE_ACCOUNT_PERMISSION' | 'RECOVER_AGENT_VIA_MDM' | 'REINSTALL_AGENT' | 'REINSTALL_ENROLLMENT_PROFILE' | 'REMOVE_OTHER_ENROLLMENT_PROFILES' | 'RESET_PASSWORD' | 'RESTART_DEVICE' | 'ROTATE_FILEVAULT_KEY' | 'SHUTDOWN_DEVICE' | 'SOFT_WIPE' | 'TURN_ON_FILEVAULT' | 'UNASSIGN_DEVICE' | 'UNINSTALL_AGENT' | 'UNINSTALL_ANTIVIRUS' | 'UNINSTALL_MDM' | 'UNLOCK_DEVICE' | 'UNLOCK_USER_ACCOUNT' | 'UPDATE_OS' | 'UNKNOWN';
|
|
132
|
+
/**
|
|
133
|
+
* When the action was queued.
|
|
134
|
+
*/
|
|
135
|
+
queued_at?: string;
|
|
136
|
+
/**
|
|
137
|
+
* The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
|
|
138
|
+
*/
|
|
139
|
+
state?: string;
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Meta information for the response.
|
|
144
|
+
*/
|
|
145
|
+
export interface DeviceRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
146
|
+
/**
|
|
147
|
+
* Identifier field
|
|
148
|
+
*/
|
|
149
|
+
id: string;
|
|
150
|
+
/**
|
|
151
|
+
* Record creation date
|
|
152
|
+
*/
|
|
153
|
+
created_at: string;
|
|
154
|
+
/**
|
|
155
|
+
* Record update date
|
|
156
|
+
*/
|
|
157
|
+
updated_at: string;
|
|
158
|
+
/**
|
|
159
|
+
* The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR,
|
|
160
|
+
* etc.
|
|
161
|
+
*/
|
|
162
|
+
enrollment_status?: 'ENROLLED' | 'WAITING_FOR_CONNECTION' | 'ERROR' | 'UNENROLLED';
|
|
163
|
+
/**
|
|
164
|
+
* Whether the device's disk is encrypted (FileVault on macOS, BitLocker on
|
|
165
|
+
* Windows).
|
|
166
|
+
*/
|
|
167
|
+
is_encrypted?: boolean;
|
|
168
|
+
/**
|
|
169
|
+
* Whether the device is managed via MDM.
|
|
170
|
+
*/
|
|
171
|
+
is_managed?: boolean;
|
|
172
|
+
/**
|
|
173
|
+
* When the Rippling agent last checked in from this device.
|
|
174
|
+
*/
|
|
175
|
+
last_checkin_at?: string;
|
|
176
|
+
/**
|
|
177
|
+
* When the device last synced with MDM.
|
|
178
|
+
*/
|
|
179
|
+
last_mdm_sync_at?: string;
|
|
180
|
+
/**
|
|
181
|
+
* The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).
|
|
182
|
+
*/
|
|
183
|
+
lifecycle_state?: 'INIT' | 'ACTIVE' | 'ACTIVATING' | 'LOCKED' | 'LOCKING' | 'INACTIVE' | 'PENDING_MDM' | 'CLEANING' | 'READY' | 'DECOMMISSIONING' | 'DECOMMISSIONED' | 'FULL_WIPING' | 'FULL_WIPED' | 'E_CYCLED' | 'MDM_LOCKED' | 'LOST' | 'LOST_PLAYING_SOUND';
|
|
184
|
+
/**
|
|
185
|
+
* The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE,
|
|
186
|
+
* KANDJI, etc.). Null when the device is not currently MDM-managed (typical for
|
|
187
|
+
* unenrolled or recently-reset devices).
|
|
188
|
+
*/
|
|
189
|
+
mdm_provider?: 'RIPPLING' | 'JUMPCLOUD' | 'JAMFCLOUD' | 'FLEETSMITH' | 'HEXNODE' | 'MICROMDM' | 'MERAKI' | 'SOTI' | 'ADDIGY' | 'FLEETDM' | 'KANDJI' | 'ZOHO' | 'INTUNE' | 'OTHER';
|
|
190
|
+
/**
|
|
191
|
+
* The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3',
|
|
192
|
+
* 'iPhone15,2').
|
|
193
|
+
*/
|
|
194
|
+
model?: string;
|
|
195
|
+
/**
|
|
196
|
+
* The device operating system name.
|
|
197
|
+
*/
|
|
198
|
+
os_name?: string;
|
|
199
|
+
/**
|
|
200
|
+
* The device operating system version.
|
|
201
|
+
*/
|
|
202
|
+
os_version?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Actions currently queued against the device (not yet completed). Expandable.
|
|
205
|
+
*
|
|
206
|
+
* Expandable field
|
|
207
|
+
*/
|
|
208
|
+
pending_actions?: Array<DeviceRetrieveResponse.PendingAction>;
|
|
209
|
+
/**
|
|
210
|
+
* The IDs of actions currently queued against the device (not yet completed).
|
|
211
|
+
*/
|
|
212
|
+
pending_actions_id?: Array<string>;
|
|
213
|
+
/**
|
|
214
|
+
* The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.
|
|
215
|
+
*/
|
|
216
|
+
platform?: 'MACOS' | 'WINDOWS' | 'IOS' | 'IPADOS';
|
|
217
|
+
/**
|
|
218
|
+
* The device's hardware serial number.
|
|
219
|
+
*/
|
|
220
|
+
serial_number?: string;
|
|
221
|
+
/**
|
|
222
|
+
* The worker this device is currently assigned to.
|
|
223
|
+
*
|
|
224
|
+
* Expandable field
|
|
225
|
+
*/
|
|
226
|
+
worker?: WorkersAPI.Worker;
|
|
227
|
+
/**
|
|
228
|
+
* The ID of the worker this device is currently assigned to. Null if unassigned.
|
|
229
|
+
*/
|
|
230
|
+
worker_id?: string;
|
|
231
|
+
}
|
|
232
|
+
export declare namespace DeviceRetrieveResponse {
|
|
233
|
+
interface PendingAction {
|
|
234
|
+
/**
|
|
235
|
+
* Identifier field
|
|
236
|
+
*/
|
|
237
|
+
id: string;
|
|
238
|
+
/**
|
|
239
|
+
* Record creation date
|
|
240
|
+
*/
|
|
241
|
+
created_at: string;
|
|
242
|
+
/**
|
|
243
|
+
* Record update date
|
|
244
|
+
*/
|
|
245
|
+
updated_at: string;
|
|
246
|
+
/**
|
|
247
|
+
* The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
|
|
248
|
+
*/
|
|
249
|
+
action_type?: 'ADD_USER_TO_FILEVAULT' | 'ASSIGN_DEVICE' | 'AUTHENTICATE_AGENT' | 'CHANGE_FILEVAULT_RECOVERY_KEY' | 'CHANGE_PASSWORD' | 'CLEAR_PASSCODE' | 'CREATE_RIPPLING_ADMIN' | 'DELETE_LOCAL_ACCOUNT' | 'DEMOTE_ACCOUNT_PERMISSION' | 'DISABLE_FIND_MY' | 'DISABLE_LOST_MODE' | 'DISABLE_REMOTE_DESKTOP' | 'ENABLE_LOST_MODE' | 'ENABLE_REMOTE_DESKTOP' | 'ENFORCE_PASSWORD_POLICY' | 'FORCE_CHECK_IN' | 'FULL_WIPE' | 'GRANT_SECURE_TOKEN' | 'INSTALL_ENROLLMENT_PROFILE' | 'LOCK_DEVICE' | 'LOCK_USER_ACCOUNT' | 'LOST_MODE_GET_LOCATION' | 'LOST_MODE_PLAY_SOUND' | 'PROMOTE_ACCOUNT_PERMISSION' | 'RECOVER_AGENT_VIA_MDM' | 'REINSTALL_AGENT' | 'REINSTALL_ENROLLMENT_PROFILE' | 'REMOVE_OTHER_ENROLLMENT_PROFILES' | 'RESET_PASSWORD' | 'RESTART_DEVICE' | 'ROTATE_FILEVAULT_KEY' | 'SHUTDOWN_DEVICE' | 'SOFT_WIPE' | 'TURN_ON_FILEVAULT' | 'UNASSIGN_DEVICE' | 'UNINSTALL_AGENT' | 'UNINSTALL_ANTIVIRUS' | 'UNINSTALL_MDM' | 'UNLOCK_DEVICE' | 'UNLOCK_USER_ACCOUNT' | 'UPDATE_OS' | 'UNKNOWN';
|
|
250
|
+
/**
|
|
251
|
+
* When the action was queued.
|
|
252
|
+
*/
|
|
253
|
+
queued_at?: string;
|
|
254
|
+
/**
|
|
255
|
+
* The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
|
|
256
|
+
*/
|
|
257
|
+
state?: string;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
export interface DeviceListParams {
|
|
261
|
+
cursor?: string;
|
|
262
|
+
expand?: string;
|
|
263
|
+
filter?: string;
|
|
264
|
+
order_by?: string;
|
|
265
|
+
}
|
|
266
|
+
export interface DeviceRetrieveParams {
|
|
267
|
+
expand?: string;
|
|
268
|
+
}
|
|
269
|
+
export declare namespace Devices {
|
|
270
|
+
export { type DeviceListResponse as DeviceListResponse, type DeviceRetrieveResponse as DeviceRetrieveResponse, type DeviceListResponsesPageCursorURL as DeviceListResponsesPageCursorURL, type DeviceListParams as DeviceListParams, type DeviceRetrieveParams as DeviceRetrieveParams, };
|
|
271
|
+
}
|
|
272
|
+
//# sourceMappingURL=devices.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../src/resources/devices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,kBAAkB,CAAC;IAIpE;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAGtC;AAED,MAAM,MAAM,gCAAgC,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEjF,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,UAAU,GAAG,wBAAwB,GAAG,OAAO,GAAG,YAAY,CAAC;IAEnF;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,aAAa,GACb,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,MAAM,GACN,oBAAoB,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,EACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,UAAU,GACV,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAE1D;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EACR,uBAAuB,GACvB,eAAe,GACf,oBAAoB,GACpB,+BAA+B,GAC/B,iBAAiB,GACjB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,oBAAoB,GACpB,4BAA4B,GAC5B,aAAa,GACb,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,iBAAiB,GACjB,8BAA8B,GAC9B,kCAAkC,GAClC,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,iBAAiB,GACjB,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,qBAAqB,GACrB,WAAW,GACX,SAAS,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB,CAAC,IAAI;IACtE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,UAAU,GAAG,wBAAwB,GAAG,OAAO,GAAG,YAAY,CAAC;IAEnF;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,aAAa,GACb,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,MAAM,GACN,oBAAoB,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,EACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,UAAU,GACV,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,CAAC;IAEZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EACR,uBAAuB,GACvB,eAAe,GACf,oBAAoB,GACpB,+BAA+B,GAC/B,iBAAiB,GACjB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,GAC3B,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,oBAAoB,GACpB,4BAA4B,GAC5B,aAAa,GACb,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,iBAAiB,GACjB,8BAA8B,GAC9B,kCAAkC,GAClC,gBAAgB,GAChB,gBAAgB,GAChB,sBAAsB,GACtB,iBAAiB,GACjB,WAAW,GACX,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,qBAAqB,GACrB,WAAW,GACX,SAAS,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Devices = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
/**
|
|
9
|
+
* Devices (laptops, desktops, phones, tablets) managed by Rippling
|
|
10
|
+
*/
|
|
11
|
+
class Devices extends resource_1.APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* A list of devices.
|
|
14
|
+
*
|
|
15
|
+
* - Requires: `API Tier 2`
|
|
16
|
+
* - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
|
|
17
|
+
* `enrollment_status`
|
|
18
|
+
* - Expandable fields: `worker`, `pending_actions`
|
|
19
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
20
|
+
*/
|
|
21
|
+
list(query = {}, options) {
|
|
22
|
+
return this._client.getAPIList('/devices/', (pagination_1.PageCursorURL), { query, ...options });
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Retrieve a specific device
|
|
26
|
+
*/
|
|
27
|
+
retrieve(id, query = {}, options) {
|
|
28
|
+
return this._client.get((0, path_1.path) `/devices/${id}/`, { query, ...options });
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
exports.Devices = Devices;
|
|
32
|
+
//# sourceMappingURL=devices.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"devices.js","sourceRoot":"","sources":["../src/resources/devices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,0BAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AA3BD,0BA2BC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { PageCursorURL } from "../core/pagination.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Devices (laptops, desktops, phones, tablets) managed by Rippling
|
|
7
|
+
*/
|
|
8
|
+
export class Devices extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* A list of devices.
|
|
11
|
+
*
|
|
12
|
+
* - Requires: `API Tier 2`
|
|
13
|
+
* - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
|
|
14
|
+
* `enrollment_status`
|
|
15
|
+
* - Expandable fields: `worker`, `pending_actions`
|
|
16
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
17
|
+
*/
|
|
18
|
+
list(query = {}, options) {
|
|
19
|
+
return this._client.getAPIList('/devices/', (PageCursorURL), { query, ...options });
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Retrieve a specific device
|
|
23
|
+
*/
|
|
24
|
+
retrieve(id, query = {}, options) {
|
|
25
|
+
return this._client.get(path `/devices/${id}/`, { query, ...options });
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=devices.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"devices.mjs","sourceRoot":"","sources":["../src/resources/devices.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,aAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
|
|
@@ -71,6 +71,10 @@ export interface FunctionDeployment {
|
|
|
71
71
|
* The ID of the version that this deployment is associated with
|
|
72
72
|
*/
|
|
73
73
|
function_version_id?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Input and output JSON Schema contracts for the deployment
|
|
76
|
+
*/
|
|
77
|
+
io_contract?: unknown;
|
|
74
78
|
/**
|
|
75
79
|
* Additional, runtime-specific options for the deployment
|
|
76
80
|
*/
|
|
@@ -127,6 +131,10 @@ export interface DeploymentCreateParams {
|
|
|
127
131
|
* The dependencies of the deployment
|
|
128
132
|
*/
|
|
129
133
|
dependencies?: unknown;
|
|
134
|
+
/**
|
|
135
|
+
* Input and output JSON Schema contracts for the deployment
|
|
136
|
+
*/
|
|
137
|
+
io_contract?: unknown;
|
|
130
138
|
/**
|
|
131
139
|
* Additional, runtime-specific options for the deployment
|
|
132
140
|
*/
|