@seamapi/http 2.31.0 → 2.33.0
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/lib/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +6 -6
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +6 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -192,15 +192,15 @@ export type ActionAttempt =
|
|
|
192
192
|
*/
|
|
193
193
|
acs_credential_on_encoder: {
|
|
194
194
|
/**
|
|
195
|
-
* A number or string that physically identifies the card associated with the [credential](https://
|
|
195
|
+
* A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
196
196
|
*/
|
|
197
197
|
card_number: string | null
|
|
198
198
|
/**
|
|
199
|
-
* Date and time at which the [credential](https://
|
|
199
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
200
200
|
*/
|
|
201
201
|
created_at: string | null
|
|
202
202
|
/**
|
|
203
|
-
* Date and time at which the [credential](https://
|
|
203
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable.
|
|
204
204
|
*/
|
|
205
205
|
ends_at: string | null
|
|
206
206
|
/**
|
|
@@ -208,60 +208,60 @@ export type ActionAttempt =
|
|
|
208
208
|
*/
|
|
209
209
|
is_issued: boolean | null
|
|
210
210
|
/**
|
|
211
|
-
* Date and time at which the [credential](https://
|
|
211
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable.
|
|
212
212
|
*/
|
|
213
213
|
starts_at: string | null
|
|
214
214
|
/**
|
|
215
|
-
* Visionline-specific metadata for the [credential](https://
|
|
215
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
216
216
|
*/
|
|
217
217
|
visionline_metadata?:
|
|
218
218
|
| {
|
|
219
219
|
/**
|
|
220
|
-
* Indicates whether the card associated with the [credential](https://
|
|
220
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled.
|
|
221
221
|
*/
|
|
222
222
|
cancelled?: boolean | undefined
|
|
223
223
|
/**
|
|
224
|
-
* Format of the card associated with the [credential](https://
|
|
224
|
+
* Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
225
225
|
*/
|
|
226
226
|
card_format?: 'TLCode' | 'rfid48' | undefined
|
|
227
227
|
/**
|
|
228
|
-
* Holder of the card associated with the [credential](https://
|
|
228
|
+
* Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
229
229
|
*/
|
|
230
230
|
card_holder?: string | undefined
|
|
231
231
|
/**
|
|
232
|
-
* Card ID for the Visionline card associated with the [credential](https://
|
|
232
|
+
* Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
233
233
|
*/
|
|
234
234
|
card_id?: string | undefined
|
|
235
235
|
/**
|
|
236
|
-
* IDs of the common [entrances](https://
|
|
236
|
+
* IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
237
237
|
*/
|
|
238
238
|
common_acs_entrance_ids?: Array<string> | undefined
|
|
239
239
|
/**
|
|
240
|
-
* Indicates whether the card associated with the [credential](https://
|
|
240
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded.
|
|
241
241
|
*/
|
|
242
242
|
discarded?: boolean | undefined
|
|
243
243
|
/**
|
|
244
|
-
* Indicates whether the card associated with the [credential](https://
|
|
244
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired.
|
|
245
245
|
*/
|
|
246
246
|
expired?: boolean | undefined
|
|
247
247
|
/**
|
|
248
|
-
* IDs of the guest [entrances](https://
|
|
248
|
+
* IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
249
249
|
*/
|
|
250
250
|
guest_acs_entrance_ids?: Array<string> | undefined
|
|
251
251
|
/**
|
|
252
|
-
* Number of issued cards associated with the [credential](https://
|
|
252
|
+
* Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
253
253
|
*/
|
|
254
254
|
number_of_issued_cards?: number | undefined
|
|
255
255
|
/**
|
|
256
|
-
* Indicates whether the card associated with the [credential](https://
|
|
256
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden.
|
|
257
257
|
*/
|
|
258
258
|
overridden?: boolean | undefined
|
|
259
259
|
/**
|
|
260
|
-
* Indicates whether the card associated with the [credential](https://
|
|
260
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten.
|
|
261
261
|
*/
|
|
262
262
|
overwritten?: boolean | undefined
|
|
263
263
|
/**
|
|
264
|
-
* Indicates whether the card associated with the [credential](https://
|
|
264
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update.
|
|
265
265
|
*/
|
|
266
266
|
pending_auto_update?: boolean | undefined
|
|
267
267
|
}
|
|
@@ -272,12 +272,12 @@ export type ActionAttempt =
|
|
|
272
272
|
*/
|
|
273
273
|
acs_credential_on_seam: {
|
|
274
274
|
/**
|
|
275
|
-
* Access method for the [credential](https://
|
|
275
|
+
* Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
276
276
|
*/
|
|
277
277
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
278
278
|
|
|
279
279
|
/**
|
|
280
|
-
* ID of the [credential](https://
|
|
280
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
281
281
|
*/
|
|
282
282
|
acs_credential_id: string
|
|
283
283
|
|
|
@@ -286,16 +286,16 @@ export type ActionAttempt =
|
|
|
286
286
|
*/
|
|
287
287
|
acs_credential_pool_id?: string | undefined
|
|
288
288
|
/**
|
|
289
|
-
* ID of the [access control system](https://
|
|
289
|
+
* ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
290
290
|
*/
|
|
291
291
|
acs_system_id: string
|
|
292
292
|
|
|
293
293
|
/**
|
|
294
|
-
* ID of the [ACS user](https://
|
|
294
|
+
* ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
295
295
|
*/
|
|
296
296
|
acs_user_id?: string | undefined
|
|
297
297
|
/**
|
|
298
|
-
* Akiles-specific metadata for the [credential](https://
|
|
298
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
299
299
|
*/
|
|
300
300
|
akiles_metadata?:
|
|
301
301
|
| {
|
|
@@ -306,7 +306,7 @@ export type ActionAttempt =
|
|
|
306
306
|
}
|
|
307
307
|
| undefined
|
|
308
308
|
/**
|
|
309
|
-
* Vostio-specific metadata for the [credential](https://
|
|
309
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
310
310
|
*/
|
|
311
311
|
assa_abloy_vostio_metadata?:
|
|
312
312
|
| {
|
|
@@ -337,34 +337,34 @@ export type ActionAttempt =
|
|
|
337
337
|
}
|
|
338
338
|
| undefined
|
|
339
339
|
/**
|
|
340
|
-
* Number of the card associated with the [credential](https://
|
|
340
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
341
341
|
*/
|
|
342
342
|
card_number?: string | null | undefined
|
|
343
343
|
/**
|
|
344
|
-
* Access (PIN) code for the [credential](https://
|
|
344
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
345
345
|
*/
|
|
346
346
|
code?: string | null | undefined
|
|
347
347
|
/**
|
|
348
|
-
* ID of the [connected account](https://
|
|
348
|
+
* ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
349
349
|
*/
|
|
350
350
|
connected_account_id: string
|
|
351
351
|
|
|
352
352
|
/**
|
|
353
|
-
* Date and time at which the [credential](https://
|
|
353
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
354
354
|
*/
|
|
355
355
|
created_at: string
|
|
356
356
|
|
|
357
357
|
/**
|
|
358
|
-
* Display name that corresponds to the [credential](https://
|
|
358
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
359
359
|
*/
|
|
360
360
|
display_name: string
|
|
361
361
|
|
|
362
362
|
/**
|
|
363
|
-
* Date and time at which the [credential](https://
|
|
363
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
364
364
|
*/
|
|
365
365
|
ends_at?: string | undefined
|
|
366
366
|
/**
|
|
367
|
-
* Errors associated with the [credential](https://
|
|
367
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
368
368
|
*/
|
|
369
369
|
errors: Array<{
|
|
370
370
|
/**
|
|
@@ -378,7 +378,7 @@ export type ActionAttempt =
|
|
|
378
378
|
}>
|
|
379
379
|
|
|
380
380
|
/**
|
|
381
|
-
* Brand-specific terminology for the [credential](https://
|
|
381
|
+
* Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
382
382
|
*/
|
|
383
383
|
external_type?:
|
|
384
384
|
| 'pti_card'
|
|
@@ -397,15 +397,15 @@ export type ActionAttempt =
|
|
|
397
397
|
| 'akiles_credential'
|
|
398
398
|
| undefined
|
|
399
399
|
/**
|
|
400
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
400
|
+
* Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
401
401
|
*/
|
|
402
402
|
external_type_display_name?: string | undefined
|
|
403
403
|
/**
|
|
404
|
-
* Indicates whether the [credential](https://
|
|
404
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
405
405
|
*/
|
|
406
406
|
is_issued?: boolean | undefined
|
|
407
407
|
/**
|
|
408
|
-
* Indicates whether the latest state of the [credential](https://
|
|
408
|
+
* Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
409
409
|
*/
|
|
410
410
|
is_latest_desired_state_synced_with_provider?:
|
|
411
411
|
boolean | null | undefined
|
|
@@ -413,36 +413,36 @@ export type ActionAttempt =
|
|
|
413
413
|
is_managed: true | false
|
|
414
414
|
|
|
415
415
|
/**
|
|
416
|
-
* Indicates whether the [credential](https://
|
|
416
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
417
417
|
*/
|
|
418
418
|
is_multi_phone_sync_credential?: boolean | undefined
|
|
419
419
|
/**
|
|
420
|
-
* Indicates whether the [credential](https://
|
|
420
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
421
421
|
*/
|
|
422
422
|
is_one_time_use?: boolean | undefined
|
|
423
423
|
/**
|
|
424
|
-
* Date and time at which the [credential](https://
|
|
424
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
425
425
|
*/
|
|
426
426
|
issued_at?: string | null | undefined
|
|
427
427
|
/**
|
|
428
|
-
* Date and time at which the state of the [credential](https://
|
|
428
|
+
* Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
429
429
|
*/
|
|
430
430
|
latest_desired_state_synced_with_provider_at?:
|
|
431
431
|
string | null | undefined
|
|
432
432
|
/**
|
|
433
|
-
* ID of the parent [credential](https://
|
|
433
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
434
434
|
*/
|
|
435
435
|
parent_acs_credential_id?: string | undefined
|
|
436
436
|
/**
|
|
437
|
-
* Date and time at which the [credential](https://
|
|
437
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
438
438
|
*/
|
|
439
439
|
starts_at?: string | undefined
|
|
440
440
|
/**
|
|
441
|
-
* ID of the [user identity](https://
|
|
441
|
+
* ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
442
442
|
*/
|
|
443
443
|
user_identity_id?: string | undefined
|
|
444
444
|
/**
|
|
445
|
-
* Visionline-specific metadata for the [credential](https://
|
|
445
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
446
446
|
*/
|
|
447
447
|
visionline_metadata?:
|
|
448
448
|
| {
|
|
@@ -481,7 +481,7 @@ export type ActionAttempt =
|
|
|
481
481
|
}
|
|
482
482
|
| undefined
|
|
483
483
|
/**
|
|
484
|
-
* Warnings associated with the [credential](https://
|
|
484
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
485
485
|
*/
|
|
486
486
|
warnings: Array<{
|
|
487
487
|
/**
|
|
@@ -517,7 +517,7 @@ export type ActionAttempt =
|
|
|
517
517
|
}>
|
|
518
518
|
|
|
519
519
|
/**
|
|
520
|
-
* ID of the workspace that contains the [credential](https://
|
|
520
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
521
521
|
*/
|
|
522
522
|
workspace_id: string
|
|
523
523
|
} | null
|
|
@@ -613,12 +613,12 @@ export type ActionAttempt =
|
|
|
613
613
|
*/
|
|
614
614
|
result: {
|
|
615
615
|
/**
|
|
616
|
-
* Access method for the [credential](https://
|
|
616
|
+
* Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
617
617
|
*/
|
|
618
618
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
619
619
|
|
|
620
620
|
/**
|
|
621
|
-
* ID of the [credential](https://
|
|
621
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
622
622
|
*/
|
|
623
623
|
acs_credential_id: string
|
|
624
624
|
|
|
@@ -627,16 +627,16 @@ export type ActionAttempt =
|
|
|
627
627
|
*/
|
|
628
628
|
acs_credential_pool_id?: string | undefined
|
|
629
629
|
/**
|
|
630
|
-
* ID of the [access control system](https://
|
|
630
|
+
* ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
631
631
|
*/
|
|
632
632
|
acs_system_id: string
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
* ID of the [ACS user](https://
|
|
635
|
+
* ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
636
636
|
*/
|
|
637
637
|
acs_user_id?: string | undefined
|
|
638
638
|
/**
|
|
639
|
-
* Akiles-specific metadata for the [credential](https://
|
|
639
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
640
640
|
*/
|
|
641
641
|
akiles_metadata?:
|
|
642
642
|
| {
|
|
@@ -647,7 +647,7 @@ export type ActionAttempt =
|
|
|
647
647
|
}
|
|
648
648
|
| undefined
|
|
649
649
|
/**
|
|
650
|
-
* Vostio-specific metadata for the [credential](https://
|
|
650
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
651
651
|
*/
|
|
652
652
|
assa_abloy_vostio_metadata?:
|
|
653
653
|
| {
|
|
@@ -678,34 +678,34 @@ export type ActionAttempt =
|
|
|
678
678
|
}
|
|
679
679
|
| undefined
|
|
680
680
|
/**
|
|
681
|
-
* Number of the card associated with the [credential](https://
|
|
681
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
682
682
|
*/
|
|
683
683
|
card_number?: string | null | undefined
|
|
684
684
|
/**
|
|
685
|
-
* Access (PIN) code for the [credential](https://
|
|
685
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
686
686
|
*/
|
|
687
687
|
code?: string | null | undefined
|
|
688
688
|
/**
|
|
689
|
-
* ID of the [connected account](https://
|
|
689
|
+
* ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
690
690
|
*/
|
|
691
691
|
connected_account_id: string
|
|
692
692
|
|
|
693
693
|
/**
|
|
694
|
-
* Date and time at which the [credential](https://
|
|
694
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
695
695
|
*/
|
|
696
696
|
created_at: string
|
|
697
697
|
|
|
698
698
|
/**
|
|
699
|
-
* Display name that corresponds to the [credential](https://
|
|
699
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
700
700
|
*/
|
|
701
701
|
display_name: string
|
|
702
702
|
|
|
703
703
|
/**
|
|
704
|
-
* Date and time at which the [credential](https://
|
|
704
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
705
705
|
*/
|
|
706
706
|
ends_at?: string | undefined
|
|
707
707
|
/**
|
|
708
|
-
* Errors associated with the [credential](https://
|
|
708
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
709
709
|
*/
|
|
710
710
|
errors: Array<{
|
|
711
711
|
/**
|
|
@@ -719,7 +719,7 @@ export type ActionAttempt =
|
|
|
719
719
|
}>
|
|
720
720
|
|
|
721
721
|
/**
|
|
722
|
-
* Brand-specific terminology for the [credential](https://
|
|
722
|
+
* Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
723
723
|
*/
|
|
724
724
|
external_type?:
|
|
725
725
|
| 'pti_card'
|
|
@@ -738,15 +738,15 @@ export type ActionAttempt =
|
|
|
738
738
|
| 'akiles_credential'
|
|
739
739
|
| undefined
|
|
740
740
|
/**
|
|
741
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
741
|
+
* Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
742
742
|
*/
|
|
743
743
|
external_type_display_name?: string | undefined
|
|
744
744
|
/**
|
|
745
|
-
* Indicates whether the [credential](https://
|
|
745
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
746
746
|
*/
|
|
747
747
|
is_issued?: boolean | undefined
|
|
748
748
|
/**
|
|
749
|
-
* Indicates whether the latest state of the [credential](https://
|
|
749
|
+
* Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
750
750
|
*/
|
|
751
751
|
is_latest_desired_state_synced_with_provider?:
|
|
752
752
|
boolean | null | undefined
|
|
@@ -754,35 +754,35 @@ export type ActionAttempt =
|
|
|
754
754
|
is_managed: true | false
|
|
755
755
|
|
|
756
756
|
/**
|
|
757
|
-
* Indicates whether the [credential](https://
|
|
757
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
758
758
|
*/
|
|
759
759
|
is_multi_phone_sync_credential?: boolean | undefined
|
|
760
760
|
/**
|
|
761
|
-
* Indicates whether the [credential](https://
|
|
761
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
762
762
|
*/
|
|
763
763
|
is_one_time_use?: boolean | undefined
|
|
764
764
|
/**
|
|
765
|
-
* Date and time at which the [credential](https://
|
|
765
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
766
766
|
*/
|
|
767
767
|
issued_at?: string | null | undefined
|
|
768
768
|
/**
|
|
769
|
-
* Date and time at which the state of the [credential](https://
|
|
769
|
+
* Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
770
770
|
*/
|
|
771
771
|
latest_desired_state_synced_with_provider_at?: string | null | undefined
|
|
772
772
|
/**
|
|
773
|
-
* ID of the parent [credential](https://
|
|
773
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
774
774
|
*/
|
|
775
775
|
parent_acs_credential_id?: string | undefined
|
|
776
776
|
/**
|
|
777
|
-
* Date and time at which the [credential](https://
|
|
777
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
778
778
|
*/
|
|
779
779
|
starts_at?: string | undefined
|
|
780
780
|
/**
|
|
781
|
-
* ID of the [user identity](https://
|
|
781
|
+
* ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
782
782
|
*/
|
|
783
783
|
user_identity_id?: string | undefined
|
|
784
784
|
/**
|
|
785
|
-
* Visionline-specific metadata for the [credential](https://
|
|
785
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
786
786
|
*/
|
|
787
787
|
visionline_metadata?:
|
|
788
788
|
| {
|
|
@@ -821,7 +821,7 @@ export type ActionAttempt =
|
|
|
821
821
|
}
|
|
822
822
|
| undefined
|
|
823
823
|
/**
|
|
824
|
-
* Warnings associated with the [credential](https://
|
|
824
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
825
825
|
*/
|
|
826
826
|
warnings: Array<{
|
|
827
827
|
/**
|
|
@@ -857,7 +857,7 @@ export type ActionAttempt =
|
|
|
857
857
|
}>
|
|
858
858
|
|
|
859
859
|
/**
|
|
860
|
-
* ID of the workspace that contains the [credential](https://
|
|
860
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
861
861
|
*/
|
|
862
862
|
workspace_id: string
|
|
863
863
|
}
|
|
@@ -940,12 +940,12 @@ export type ActionAttempt =
|
|
|
940
940
|
*/
|
|
941
941
|
result: {
|
|
942
942
|
/**
|
|
943
|
-
* Access method for the [credential](https://
|
|
943
|
+
* Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
944
944
|
*/
|
|
945
945
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
946
946
|
|
|
947
947
|
/**
|
|
948
|
-
* ID of the [credential](https://
|
|
948
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
949
949
|
*/
|
|
950
950
|
acs_credential_id: string
|
|
951
951
|
|
|
@@ -954,16 +954,16 @@ export type ActionAttempt =
|
|
|
954
954
|
*/
|
|
955
955
|
acs_credential_pool_id?: string | undefined
|
|
956
956
|
/**
|
|
957
|
-
* ID of the [access control system](https://
|
|
957
|
+
* ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
958
958
|
*/
|
|
959
959
|
acs_system_id: string
|
|
960
960
|
|
|
961
961
|
/**
|
|
962
|
-
* ID of the [ACS user](https://
|
|
962
|
+
* ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
963
963
|
*/
|
|
964
964
|
acs_user_id?: string | undefined
|
|
965
965
|
/**
|
|
966
|
-
* Akiles-specific metadata for the [credential](https://
|
|
966
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
967
967
|
*/
|
|
968
968
|
akiles_metadata?:
|
|
969
969
|
| {
|
|
@@ -974,7 +974,7 @@ export type ActionAttempt =
|
|
|
974
974
|
}
|
|
975
975
|
| undefined
|
|
976
976
|
/**
|
|
977
|
-
* Vostio-specific metadata for the [credential](https://
|
|
977
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
978
978
|
*/
|
|
979
979
|
assa_abloy_vostio_metadata?:
|
|
980
980
|
| {
|
|
@@ -1005,34 +1005,34 @@ export type ActionAttempt =
|
|
|
1005
1005
|
}
|
|
1006
1006
|
| undefined
|
|
1007
1007
|
/**
|
|
1008
|
-
* Number of the card associated with the [credential](https://
|
|
1008
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1009
1009
|
*/
|
|
1010
1010
|
card_number?: string | null | undefined
|
|
1011
1011
|
/**
|
|
1012
|
-
* Access (PIN) code for the [credential](https://
|
|
1012
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1013
1013
|
*/
|
|
1014
1014
|
code?: string | null | undefined
|
|
1015
1015
|
/**
|
|
1016
|
-
* ID of the [connected account](https://
|
|
1016
|
+
* ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
1017
1017
|
*/
|
|
1018
1018
|
connected_account_id: string
|
|
1019
1019
|
|
|
1020
1020
|
/**
|
|
1021
|
-
* Date and time at which the [credential](https://
|
|
1021
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
1022
1022
|
*/
|
|
1023
1023
|
created_at: string
|
|
1024
1024
|
|
|
1025
1025
|
/**
|
|
1026
|
-
* Display name that corresponds to the [credential](https://
|
|
1026
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
1027
1027
|
*/
|
|
1028
1028
|
display_name: string
|
|
1029
1029
|
|
|
1030
1030
|
/**
|
|
1031
|
-
* Date and time at which the [credential](https://
|
|
1031
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
1032
1032
|
*/
|
|
1033
1033
|
ends_at?: string | undefined
|
|
1034
1034
|
/**
|
|
1035
|
-
* Errors associated with the [credential](https://
|
|
1035
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1036
1036
|
*/
|
|
1037
1037
|
errors: Array<{
|
|
1038
1038
|
/**
|
|
@@ -1046,7 +1046,7 @@ export type ActionAttempt =
|
|
|
1046
1046
|
}>
|
|
1047
1047
|
|
|
1048
1048
|
/**
|
|
1049
|
-
* Brand-specific terminology for the [credential](https://
|
|
1049
|
+
* Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
1050
1050
|
*/
|
|
1051
1051
|
external_type?:
|
|
1052
1052
|
| 'pti_card'
|
|
@@ -1065,15 +1065,15 @@ export type ActionAttempt =
|
|
|
1065
1065
|
| 'akiles_credential'
|
|
1066
1066
|
| undefined
|
|
1067
1067
|
/**
|
|
1068
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
1068
|
+
* Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
1069
1069
|
*/
|
|
1070
1070
|
external_type_display_name?: string | undefined
|
|
1071
1071
|
/**
|
|
1072
|
-
* Indicates whether the [credential](https://
|
|
1072
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
1073
1073
|
*/
|
|
1074
1074
|
is_issued?: boolean | undefined
|
|
1075
1075
|
/**
|
|
1076
|
-
* Indicates whether the latest state of the [credential](https://
|
|
1076
|
+
* Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
1077
1077
|
*/
|
|
1078
1078
|
is_latest_desired_state_synced_with_provider?:
|
|
1079
1079
|
boolean | null | undefined
|
|
@@ -1083,35 +1083,35 @@ export type ActionAttempt =
|
|
|
1083
1083
|
is_managed: true
|
|
1084
1084
|
|
|
1085
1085
|
/**
|
|
1086
|
-
* Indicates whether the [credential](https://
|
|
1086
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
1087
1087
|
*/
|
|
1088
1088
|
is_multi_phone_sync_credential?: boolean | undefined
|
|
1089
1089
|
/**
|
|
1090
|
-
* Indicates whether the [credential](https://
|
|
1090
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
1091
1091
|
*/
|
|
1092
1092
|
is_one_time_use?: boolean | undefined
|
|
1093
1093
|
/**
|
|
1094
|
-
* Date and time at which the [credential](https://
|
|
1094
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
1095
1095
|
*/
|
|
1096
1096
|
issued_at?: string | null | undefined
|
|
1097
1097
|
/**
|
|
1098
|
-
* Date and time at which the state of the [credential](https://
|
|
1098
|
+
* Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
1099
1099
|
*/
|
|
1100
1100
|
latest_desired_state_synced_with_provider_at?: string | null | undefined
|
|
1101
1101
|
/**
|
|
1102
|
-
* ID of the parent [credential](https://
|
|
1102
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1103
1103
|
*/
|
|
1104
1104
|
parent_acs_credential_id?: string | undefined
|
|
1105
1105
|
/**
|
|
1106
|
-
* Date and time at which the [credential](https://
|
|
1106
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
1107
1107
|
*/
|
|
1108
1108
|
starts_at?: string | undefined
|
|
1109
1109
|
/**
|
|
1110
|
-
* ID of the [user identity](https://
|
|
1110
|
+
* ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
1111
1111
|
*/
|
|
1112
1112
|
user_identity_id?: string | undefined
|
|
1113
1113
|
/**
|
|
1114
|
-
* Visionline-specific metadata for the [credential](https://
|
|
1114
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1115
1115
|
*/
|
|
1116
1116
|
visionline_metadata?:
|
|
1117
1117
|
| {
|
|
@@ -1150,7 +1150,7 @@ export type ActionAttempt =
|
|
|
1150
1150
|
}
|
|
1151
1151
|
| undefined
|
|
1152
1152
|
/**
|
|
1153
|
-
* Warnings associated with the [credential](https://
|
|
1153
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1154
1154
|
*/
|
|
1155
1155
|
warnings: Array<{
|
|
1156
1156
|
/**
|
|
@@ -1186,7 +1186,7 @@ export type ActionAttempt =
|
|
|
1186
1186
|
}>
|
|
1187
1187
|
|
|
1188
1188
|
/**
|
|
1189
|
-
* ID of the workspace that contains the [credential](https://
|
|
1189
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1190
1190
|
*/
|
|
1191
1191
|
workspace_id: string
|
|
1192
1192
|
}
|
|
@@ -1294,7 +1294,7 @@ export type ActionAttempt =
|
|
|
1294
1294
|
display_status: string
|
|
1295
1295
|
|
|
1296
1296
|
/**
|
|
1297
|
-
* Errors associated with the [access method](https://
|
|
1297
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1298
1298
|
*/
|
|
1299
1299
|
errors: Array<{
|
|
1300
1300
|
/**
|
|
@@ -1348,7 +1348,7 @@ export type ActionAttempt =
|
|
|
1348
1348
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
1349
1349
|
|
|
1350
1350
|
/**
|
|
1351
|
-
* Pending mutations for the [access method](https://
|
|
1351
|
+
* Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
|
|
1352
1352
|
*/
|
|
1353
1353
|
pending_mutations: Array<{
|
|
1354
1354
|
/**
|
|
@@ -1397,7 +1397,7 @@ export type ActionAttempt =
|
|
|
1397
1397
|
}>
|
|
1398
1398
|
|
|
1399
1399
|
/**
|
|
1400
|
-
* Warnings associated with the [access method](https://
|
|
1400
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1401
1401
|
*/
|
|
1402
1402
|
warnings: Array<{
|
|
1403
1403
|
/**
|