@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
|
@@ -156,15 +156,15 @@ export type ActionAttempt = {
|
|
|
156
156
|
*/
|
|
157
157
|
acs_credential_on_encoder: {
|
|
158
158
|
/**
|
|
159
|
-
* A number or string that physically identifies the card associated with the [credential](https://
|
|
159
|
+
* 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).
|
|
160
160
|
*/
|
|
161
161
|
card_number: string | null;
|
|
162
162
|
/**
|
|
163
|
-
* Date and time at which the [credential](https://
|
|
163
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
164
164
|
*/
|
|
165
165
|
created_at: string | null;
|
|
166
166
|
/**
|
|
167
|
-
* Date and time at which the [credential](https://
|
|
167
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable.
|
|
168
168
|
*/
|
|
169
169
|
ends_at: string | null;
|
|
170
170
|
/**
|
|
@@ -172,59 +172,59 @@ export type ActionAttempt = {
|
|
|
172
172
|
*/
|
|
173
173
|
is_issued: boolean | null;
|
|
174
174
|
/**
|
|
175
|
-
* Date and time at which the [credential](https://
|
|
175
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable.
|
|
176
176
|
*/
|
|
177
177
|
starts_at: string | null;
|
|
178
178
|
/**
|
|
179
|
-
* Visionline-specific metadata for the [credential](https://
|
|
179
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
180
180
|
*/
|
|
181
181
|
visionline_metadata?: {
|
|
182
182
|
/**
|
|
183
|
-
* Indicates whether the card associated with the [credential](https://
|
|
183
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled.
|
|
184
184
|
*/
|
|
185
185
|
cancelled?: boolean | undefined;
|
|
186
186
|
/**
|
|
187
|
-
* Format of the card associated with the [credential](https://
|
|
187
|
+
* Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
188
188
|
*/
|
|
189
189
|
card_format?: 'TLCode' | 'rfid48' | undefined;
|
|
190
190
|
/**
|
|
191
|
-
* Holder of the card associated with the [credential](https://
|
|
191
|
+
* Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
192
192
|
*/
|
|
193
193
|
card_holder?: string | undefined;
|
|
194
194
|
/**
|
|
195
|
-
* Card ID for the Visionline card associated with the [credential](https://
|
|
195
|
+
* Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
196
196
|
*/
|
|
197
197
|
card_id?: string | undefined;
|
|
198
198
|
/**
|
|
199
|
-
* IDs of the common [entrances](https://
|
|
199
|
+
* 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).
|
|
200
200
|
*/
|
|
201
201
|
common_acs_entrance_ids?: Array<string> | undefined;
|
|
202
202
|
/**
|
|
203
|
-
* Indicates whether the card associated with the [credential](https://
|
|
203
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded.
|
|
204
204
|
*/
|
|
205
205
|
discarded?: boolean | undefined;
|
|
206
206
|
/**
|
|
207
|
-
* Indicates whether the card associated with the [credential](https://
|
|
207
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired.
|
|
208
208
|
*/
|
|
209
209
|
expired?: boolean | undefined;
|
|
210
210
|
/**
|
|
211
|
-
* IDs of the guest [entrances](https://
|
|
211
|
+
* 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).
|
|
212
212
|
*/
|
|
213
213
|
guest_acs_entrance_ids?: Array<string> | undefined;
|
|
214
214
|
/**
|
|
215
|
-
* Number of issued cards associated with the [credential](https://
|
|
215
|
+
* Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
216
216
|
*/
|
|
217
217
|
number_of_issued_cards?: number | undefined;
|
|
218
218
|
/**
|
|
219
|
-
* Indicates whether the card associated with the [credential](https://
|
|
219
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden.
|
|
220
220
|
*/
|
|
221
221
|
overridden?: boolean | undefined;
|
|
222
222
|
/**
|
|
223
|
-
* Indicates whether the card associated with the [credential](https://
|
|
223
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten.
|
|
224
224
|
*/
|
|
225
225
|
overwritten?: boolean | undefined;
|
|
226
226
|
/**
|
|
227
|
-
* Indicates whether the card associated with the [credential](https://
|
|
227
|
+
* Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update.
|
|
228
228
|
*/
|
|
229
229
|
pending_auto_update?: boolean | undefined;
|
|
230
230
|
} | undefined;
|
|
@@ -234,11 +234,11 @@ export type ActionAttempt = {
|
|
|
234
234
|
*/
|
|
235
235
|
acs_credential_on_seam: {
|
|
236
236
|
/**
|
|
237
|
-
* Access method for the [credential](https://
|
|
237
|
+
* 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`.
|
|
238
238
|
*/
|
|
239
239
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
240
240
|
/**
|
|
241
|
-
* ID of the [credential](https://
|
|
241
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
242
242
|
*/
|
|
243
243
|
acs_credential_id: string;
|
|
244
244
|
/**
|
|
@@ -246,15 +246,15 @@ export type ActionAttempt = {
|
|
|
246
246
|
*/
|
|
247
247
|
acs_credential_pool_id?: string | undefined;
|
|
248
248
|
/**
|
|
249
|
-
* ID of the [access control system](https://
|
|
249
|
+
* 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).
|
|
250
250
|
*/
|
|
251
251
|
acs_system_id: string;
|
|
252
252
|
/**
|
|
253
|
-
* ID of the [ACS user](https://
|
|
253
|
+
* 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.
|
|
254
254
|
*/
|
|
255
255
|
acs_user_id?: string | undefined;
|
|
256
256
|
/**
|
|
257
|
-
* Akiles-specific metadata for the [credential](https://
|
|
257
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
258
258
|
*/
|
|
259
259
|
akiles_metadata?: {
|
|
260
260
|
/**
|
|
@@ -263,7 +263,7 @@ export type ActionAttempt = {
|
|
|
263
263
|
member_pin_id?: string | undefined;
|
|
264
264
|
} | undefined;
|
|
265
265
|
/**
|
|
266
|
-
* Vostio-specific metadata for the [credential](https://
|
|
266
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
267
267
|
*/
|
|
268
268
|
assa_abloy_vostio_metadata?: {
|
|
269
269
|
/**
|
|
@@ -292,31 +292,31 @@ export type ActionAttempt = {
|
|
|
292
292
|
override_guest_acs_entrance_ids?: Array<string> | undefined;
|
|
293
293
|
} | undefined;
|
|
294
294
|
/**
|
|
295
|
-
* Number of the card associated with the [credential](https://
|
|
295
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
296
296
|
*/
|
|
297
297
|
card_number?: string | null | undefined;
|
|
298
298
|
/**
|
|
299
|
-
* Access (PIN) code for the [credential](https://
|
|
299
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
300
300
|
*/
|
|
301
301
|
code?: string | null | undefined;
|
|
302
302
|
/**
|
|
303
|
-
* ID of the [connected account](https://
|
|
303
|
+
* 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.
|
|
304
304
|
*/
|
|
305
305
|
connected_account_id: string;
|
|
306
306
|
/**
|
|
307
|
-
* Date and time at which the [credential](https://
|
|
307
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
308
308
|
*/
|
|
309
309
|
created_at: string;
|
|
310
310
|
/**
|
|
311
|
-
* Display name that corresponds to the [credential](https://
|
|
311
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
312
312
|
*/
|
|
313
313
|
display_name: string;
|
|
314
314
|
/**
|
|
315
|
-
* Date and time at which the [credential](https://
|
|
315
|
+
* 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`.
|
|
316
316
|
*/
|
|
317
317
|
ends_at?: string | undefined;
|
|
318
318
|
/**
|
|
319
|
-
* Errors associated with the [credential](https://
|
|
319
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
320
320
|
*/
|
|
321
321
|
errors: Array<{
|
|
322
322
|
/**
|
|
@@ -327,52 +327,52 @@ export type ActionAttempt = {
|
|
|
327
327
|
message: string;
|
|
328
328
|
}>;
|
|
329
329
|
/**
|
|
330
|
-
* Brand-specific terminology for the [credential](https://
|
|
330
|
+
* 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`.
|
|
331
331
|
*/
|
|
332
332
|
external_type?: 'pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential' | undefined;
|
|
333
333
|
/**
|
|
334
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
334
|
+
* 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.
|
|
335
335
|
*/
|
|
336
336
|
external_type_display_name?: string | undefined;
|
|
337
337
|
/**
|
|
338
|
-
* Indicates whether the [credential](https://
|
|
338
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
339
339
|
*/
|
|
340
340
|
is_issued?: boolean | undefined;
|
|
341
341
|
/**
|
|
342
|
-
* Indicates whether the latest state of the [credential](https://
|
|
342
|
+
* 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.
|
|
343
343
|
*/
|
|
344
344
|
is_latest_desired_state_synced_with_provider?: boolean | null | undefined;
|
|
345
345
|
is_managed: true | false;
|
|
346
346
|
/**
|
|
347
|
-
* Indicates whether the [credential](https://
|
|
347
|
+
* 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).
|
|
348
348
|
*/
|
|
349
349
|
is_multi_phone_sync_credential?: boolean | undefined;
|
|
350
350
|
/**
|
|
351
|
-
* Indicates whether the [credential](https://
|
|
351
|
+
* 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.
|
|
352
352
|
*/
|
|
353
353
|
is_one_time_use?: boolean | undefined;
|
|
354
354
|
/**
|
|
355
|
-
* Date and time at which the [credential](https://
|
|
355
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
356
356
|
*/
|
|
357
357
|
issued_at?: string | null | undefined;
|
|
358
358
|
/**
|
|
359
|
-
* Date and time at which the state of the [credential](https://
|
|
359
|
+
* 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.
|
|
360
360
|
*/
|
|
361
361
|
latest_desired_state_synced_with_provider_at?: string | null | undefined;
|
|
362
362
|
/**
|
|
363
|
-
* ID of the parent [credential](https://
|
|
363
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
364
364
|
*/
|
|
365
365
|
parent_acs_credential_id?: string | undefined;
|
|
366
366
|
/**
|
|
367
|
-
* Date and time at which the [credential](https://
|
|
367
|
+
* 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.
|
|
368
368
|
*/
|
|
369
369
|
starts_at?: string | undefined;
|
|
370
370
|
/**
|
|
371
|
-
* ID of the [user identity](https://
|
|
371
|
+
* 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.
|
|
372
372
|
*/
|
|
373
373
|
user_identity_id?: string | undefined;
|
|
374
374
|
/**
|
|
375
|
-
* Visionline-specific metadata for the [credential](https://
|
|
375
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
376
376
|
*/
|
|
377
377
|
visionline_metadata?: {
|
|
378
378
|
/**
|
|
@@ -409,7 +409,7 @@ export type ActionAttempt = {
|
|
|
409
409
|
joiner_acs_credential_ids?: Array<string> | undefined;
|
|
410
410
|
} | undefined;
|
|
411
411
|
/**
|
|
412
|
-
* Warnings associated with the [credential](https://
|
|
412
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
413
413
|
*/
|
|
414
414
|
warnings: Array<{
|
|
415
415
|
/**
|
|
@@ -434,7 +434,7 @@ export type ActionAttempt = {
|
|
|
434
434
|
original_code?: string | undefined;
|
|
435
435
|
}>;
|
|
436
436
|
/**
|
|
437
|
-
* ID of the workspace that contains the [credential](https://
|
|
437
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
438
438
|
*/
|
|
439
439
|
workspace_id: string;
|
|
440
440
|
} | null;
|
|
@@ -507,11 +507,11 @@ export type ActionAttempt = {
|
|
|
507
507
|
*/
|
|
508
508
|
result: {
|
|
509
509
|
/**
|
|
510
|
-
* Access method for the [credential](https://
|
|
510
|
+
* 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`.
|
|
511
511
|
*/
|
|
512
512
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
513
513
|
/**
|
|
514
|
-
* ID of the [credential](https://
|
|
514
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
515
515
|
*/
|
|
516
516
|
acs_credential_id: string;
|
|
517
517
|
/**
|
|
@@ -519,15 +519,15 @@ export type ActionAttempt = {
|
|
|
519
519
|
*/
|
|
520
520
|
acs_credential_pool_id?: string | undefined;
|
|
521
521
|
/**
|
|
522
|
-
* ID of the [access control system](https://
|
|
522
|
+
* 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).
|
|
523
523
|
*/
|
|
524
524
|
acs_system_id: string;
|
|
525
525
|
/**
|
|
526
|
-
* ID of the [ACS user](https://
|
|
526
|
+
* 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.
|
|
527
527
|
*/
|
|
528
528
|
acs_user_id?: string | undefined;
|
|
529
529
|
/**
|
|
530
|
-
* Akiles-specific metadata for the [credential](https://
|
|
530
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
531
531
|
*/
|
|
532
532
|
akiles_metadata?: {
|
|
533
533
|
/**
|
|
@@ -536,7 +536,7 @@ export type ActionAttempt = {
|
|
|
536
536
|
member_pin_id?: string | undefined;
|
|
537
537
|
} | undefined;
|
|
538
538
|
/**
|
|
539
|
-
* Vostio-specific metadata for the [credential](https://
|
|
539
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
540
540
|
*/
|
|
541
541
|
assa_abloy_vostio_metadata?: {
|
|
542
542
|
/**
|
|
@@ -565,31 +565,31 @@ export type ActionAttempt = {
|
|
|
565
565
|
override_guest_acs_entrance_ids?: Array<string> | undefined;
|
|
566
566
|
} | undefined;
|
|
567
567
|
/**
|
|
568
|
-
* Number of the card associated with the [credential](https://
|
|
568
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
569
569
|
*/
|
|
570
570
|
card_number?: string | null | undefined;
|
|
571
571
|
/**
|
|
572
|
-
* Access (PIN) code for the [credential](https://
|
|
572
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
573
573
|
*/
|
|
574
574
|
code?: string | null | undefined;
|
|
575
575
|
/**
|
|
576
|
-
* ID of the [connected account](https://
|
|
576
|
+
* 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.
|
|
577
577
|
*/
|
|
578
578
|
connected_account_id: string;
|
|
579
579
|
/**
|
|
580
|
-
* Date and time at which the [credential](https://
|
|
580
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
581
581
|
*/
|
|
582
582
|
created_at: string;
|
|
583
583
|
/**
|
|
584
|
-
* Display name that corresponds to the [credential](https://
|
|
584
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
585
585
|
*/
|
|
586
586
|
display_name: string;
|
|
587
587
|
/**
|
|
588
|
-
* Date and time at which the [credential](https://
|
|
588
|
+
* 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`.
|
|
589
589
|
*/
|
|
590
590
|
ends_at?: string | undefined;
|
|
591
591
|
/**
|
|
592
|
-
* Errors associated with the [credential](https://
|
|
592
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
593
593
|
*/
|
|
594
594
|
errors: Array<{
|
|
595
595
|
/**
|
|
@@ -600,52 +600,52 @@ export type ActionAttempt = {
|
|
|
600
600
|
message: string;
|
|
601
601
|
}>;
|
|
602
602
|
/**
|
|
603
|
-
* Brand-specific terminology for the [credential](https://
|
|
603
|
+
* 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`.
|
|
604
604
|
*/
|
|
605
605
|
external_type?: 'pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential' | undefined;
|
|
606
606
|
/**
|
|
607
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
607
|
+
* 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.
|
|
608
608
|
*/
|
|
609
609
|
external_type_display_name?: string | undefined;
|
|
610
610
|
/**
|
|
611
|
-
* Indicates whether the [credential](https://
|
|
611
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
612
612
|
*/
|
|
613
613
|
is_issued?: boolean | undefined;
|
|
614
614
|
/**
|
|
615
|
-
* Indicates whether the latest state of the [credential](https://
|
|
615
|
+
* 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.
|
|
616
616
|
*/
|
|
617
617
|
is_latest_desired_state_synced_with_provider?: boolean | null | undefined;
|
|
618
618
|
is_managed: true | false;
|
|
619
619
|
/**
|
|
620
|
-
* Indicates whether the [credential](https://
|
|
620
|
+
* 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).
|
|
621
621
|
*/
|
|
622
622
|
is_multi_phone_sync_credential?: boolean | undefined;
|
|
623
623
|
/**
|
|
624
|
-
* Indicates whether the [credential](https://
|
|
624
|
+
* 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.
|
|
625
625
|
*/
|
|
626
626
|
is_one_time_use?: boolean | undefined;
|
|
627
627
|
/**
|
|
628
|
-
* Date and time at which the [credential](https://
|
|
628
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
629
629
|
*/
|
|
630
630
|
issued_at?: string | null | undefined;
|
|
631
631
|
/**
|
|
632
|
-
* Date and time at which the state of the [credential](https://
|
|
632
|
+
* 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.
|
|
633
633
|
*/
|
|
634
634
|
latest_desired_state_synced_with_provider_at?: string | null | undefined;
|
|
635
635
|
/**
|
|
636
|
-
* ID of the parent [credential](https://
|
|
636
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
637
637
|
*/
|
|
638
638
|
parent_acs_credential_id?: string | undefined;
|
|
639
639
|
/**
|
|
640
|
-
* Date and time at which the [credential](https://
|
|
640
|
+
* 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.
|
|
641
641
|
*/
|
|
642
642
|
starts_at?: string | undefined;
|
|
643
643
|
/**
|
|
644
|
-
* ID of the [user identity](https://
|
|
644
|
+
* 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.
|
|
645
645
|
*/
|
|
646
646
|
user_identity_id?: string | undefined;
|
|
647
647
|
/**
|
|
648
|
-
* Visionline-specific metadata for the [credential](https://
|
|
648
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
649
649
|
*/
|
|
650
650
|
visionline_metadata?: {
|
|
651
651
|
/**
|
|
@@ -682,7 +682,7 @@ export type ActionAttempt = {
|
|
|
682
682
|
joiner_acs_credential_ids?: Array<string> | undefined;
|
|
683
683
|
} | undefined;
|
|
684
684
|
/**
|
|
685
|
-
* Warnings associated with the [credential](https://
|
|
685
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
686
686
|
*/
|
|
687
687
|
warnings: Array<{
|
|
688
688
|
/**
|
|
@@ -707,7 +707,7 @@ export type ActionAttempt = {
|
|
|
707
707
|
original_code?: string | undefined;
|
|
708
708
|
}>;
|
|
709
709
|
/**
|
|
710
|
-
* ID of the workspace that contains the [credential](https://
|
|
710
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
711
711
|
*/
|
|
712
712
|
workspace_id: string;
|
|
713
713
|
};
|
|
@@ -766,11 +766,11 @@ export type ActionAttempt = {
|
|
|
766
766
|
*/
|
|
767
767
|
result: {
|
|
768
768
|
/**
|
|
769
|
-
* Access method for the [credential](https://
|
|
769
|
+
* 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`.
|
|
770
770
|
*/
|
|
771
771
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
772
772
|
/**
|
|
773
|
-
* ID of the [credential](https://
|
|
773
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
774
774
|
*/
|
|
775
775
|
acs_credential_id: string;
|
|
776
776
|
/**
|
|
@@ -778,15 +778,15 @@ export type ActionAttempt = {
|
|
|
778
778
|
*/
|
|
779
779
|
acs_credential_pool_id?: string | undefined;
|
|
780
780
|
/**
|
|
781
|
-
* ID of the [access control system](https://
|
|
781
|
+
* 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).
|
|
782
782
|
*/
|
|
783
783
|
acs_system_id: string;
|
|
784
784
|
/**
|
|
785
|
-
* ID of the [ACS user](https://
|
|
785
|
+
* 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.
|
|
786
786
|
*/
|
|
787
787
|
acs_user_id?: string | undefined;
|
|
788
788
|
/**
|
|
789
|
-
* Akiles-specific metadata for the [credential](https://
|
|
789
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
790
790
|
*/
|
|
791
791
|
akiles_metadata?: {
|
|
792
792
|
/**
|
|
@@ -795,7 +795,7 @@ export type ActionAttempt = {
|
|
|
795
795
|
member_pin_id?: string | undefined;
|
|
796
796
|
} | undefined;
|
|
797
797
|
/**
|
|
798
|
-
* Vostio-specific metadata for the [credential](https://
|
|
798
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
799
799
|
*/
|
|
800
800
|
assa_abloy_vostio_metadata?: {
|
|
801
801
|
/**
|
|
@@ -824,31 +824,31 @@ export type ActionAttempt = {
|
|
|
824
824
|
override_guest_acs_entrance_ids?: Array<string> | undefined;
|
|
825
825
|
} | undefined;
|
|
826
826
|
/**
|
|
827
|
-
* Number of the card associated with the [credential](https://
|
|
827
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
828
828
|
*/
|
|
829
829
|
card_number?: string | null | undefined;
|
|
830
830
|
/**
|
|
831
|
-
* Access (PIN) code for the [credential](https://
|
|
831
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
832
832
|
*/
|
|
833
833
|
code?: string | null | undefined;
|
|
834
834
|
/**
|
|
835
|
-
* ID of the [connected account](https://
|
|
835
|
+
* 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.
|
|
836
836
|
*/
|
|
837
837
|
connected_account_id: string;
|
|
838
838
|
/**
|
|
839
|
-
* Date and time at which the [credential](https://
|
|
839
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
840
840
|
*/
|
|
841
841
|
created_at: string;
|
|
842
842
|
/**
|
|
843
|
-
* Display name that corresponds to the [credential](https://
|
|
843
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
844
844
|
*/
|
|
845
845
|
display_name: string;
|
|
846
846
|
/**
|
|
847
|
-
* Date and time at which the [credential](https://
|
|
847
|
+
* 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`.
|
|
848
848
|
*/
|
|
849
849
|
ends_at?: string | undefined;
|
|
850
850
|
/**
|
|
851
|
-
* Errors associated with the [credential](https://
|
|
851
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
852
852
|
*/
|
|
853
853
|
errors: Array<{
|
|
854
854
|
/**
|
|
@@ -859,19 +859,19 @@ export type ActionAttempt = {
|
|
|
859
859
|
message: string;
|
|
860
860
|
}>;
|
|
861
861
|
/**
|
|
862
|
-
* Brand-specific terminology for the [credential](https://
|
|
862
|
+
* 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`.
|
|
863
863
|
*/
|
|
864
864
|
external_type?: 'pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential' | undefined;
|
|
865
865
|
/**
|
|
866
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
866
|
+
* 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.
|
|
867
867
|
*/
|
|
868
868
|
external_type_display_name?: string | undefined;
|
|
869
869
|
/**
|
|
870
|
-
* Indicates whether the [credential](https://
|
|
870
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
871
871
|
*/
|
|
872
872
|
is_issued?: boolean | undefined;
|
|
873
873
|
/**
|
|
874
|
-
* Indicates whether the latest state of the [credential](https://
|
|
874
|
+
* 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.
|
|
875
875
|
*/
|
|
876
876
|
is_latest_desired_state_synced_with_provider?: boolean | null | undefined;
|
|
877
877
|
/**
|
|
@@ -879,35 +879,35 @@ export type ActionAttempt = {
|
|
|
879
879
|
*/
|
|
880
880
|
is_managed: true;
|
|
881
881
|
/**
|
|
882
|
-
* Indicates whether the [credential](https://
|
|
882
|
+
* 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).
|
|
883
883
|
*/
|
|
884
884
|
is_multi_phone_sync_credential?: boolean | undefined;
|
|
885
885
|
/**
|
|
886
|
-
* Indicates whether the [credential](https://
|
|
886
|
+
* 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.
|
|
887
887
|
*/
|
|
888
888
|
is_one_time_use?: boolean | undefined;
|
|
889
889
|
/**
|
|
890
|
-
* Date and time at which the [credential](https://
|
|
890
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
891
891
|
*/
|
|
892
892
|
issued_at?: string | null | undefined;
|
|
893
893
|
/**
|
|
894
|
-
* Date and time at which the state of the [credential](https://
|
|
894
|
+
* 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.
|
|
895
895
|
*/
|
|
896
896
|
latest_desired_state_synced_with_provider_at?: string | null | undefined;
|
|
897
897
|
/**
|
|
898
|
-
* ID of the parent [credential](https://
|
|
898
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
899
899
|
*/
|
|
900
900
|
parent_acs_credential_id?: string | undefined;
|
|
901
901
|
/**
|
|
902
|
-
* Date and time at which the [credential](https://
|
|
902
|
+
* 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.
|
|
903
903
|
*/
|
|
904
904
|
starts_at?: string | undefined;
|
|
905
905
|
/**
|
|
906
|
-
* ID of the [user identity](https://
|
|
906
|
+
* 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.
|
|
907
907
|
*/
|
|
908
908
|
user_identity_id?: string | undefined;
|
|
909
909
|
/**
|
|
910
|
-
* Visionline-specific metadata for the [credential](https://
|
|
910
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
911
911
|
*/
|
|
912
912
|
visionline_metadata?: {
|
|
913
913
|
/**
|
|
@@ -944,7 +944,7 @@ export type ActionAttempt = {
|
|
|
944
944
|
joiner_acs_credential_ids?: Array<string> | undefined;
|
|
945
945
|
} | undefined;
|
|
946
946
|
/**
|
|
947
|
-
* Warnings associated with the [credential](https://
|
|
947
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
948
948
|
*/
|
|
949
949
|
warnings: Array<{
|
|
950
950
|
/**
|
|
@@ -969,7 +969,7 @@ export type ActionAttempt = {
|
|
|
969
969
|
original_code?: string | undefined;
|
|
970
970
|
}>;
|
|
971
971
|
/**
|
|
972
|
-
* ID of the workspace that contains the [credential](https://
|
|
972
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
973
973
|
*/
|
|
974
974
|
workspace_id: string;
|
|
975
975
|
};
|
|
@@ -1056,7 +1056,7 @@ export type ActionAttempt = {
|
|
|
1056
1056
|
*/
|
|
1057
1057
|
display_status: string;
|
|
1058
1058
|
/**
|
|
1059
|
-
* Errors associated with the [access method](https://
|
|
1059
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1060
1060
|
*/
|
|
1061
1061
|
errors: Array<{
|
|
1062
1062
|
/**
|
|
@@ -1105,7 +1105,7 @@ export type ActionAttempt = {
|
|
|
1105
1105
|
*/
|
|
1106
1106
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
1107
1107
|
/**
|
|
1108
|
-
* Pending mutations for the [access method](https://
|
|
1108
|
+
* 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.
|
|
1109
1109
|
*/
|
|
1110
1110
|
pending_mutations: Array<{
|
|
1111
1111
|
/**
|
|
@@ -1148,7 +1148,7 @@ export type ActionAttempt = {
|
|
|
1148
1148
|
};
|
|
1149
1149
|
}>;
|
|
1150
1150
|
/**
|
|
1151
|
-
* Warnings associated with the [access method](https://
|
|
1151
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1152
1152
|
*/
|
|
1153
1153
|
warnings: Array<{
|
|
1154
1154
|
/**
|