@seamapi/types 1.1076.0 → 1.1078.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/seam/connect/models/access-codes/managed-access-code.d.ts +16 -16
- package/lib/seam/connect/models/access-codes/managed-access-code.js +4 -4
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -5
- package/lib/seam/connect/models/events/access-codes.d.ts +8 -8
- package/lib/seam/connect/models/events/access-codes.js +4 -4
- package/lib/seam/connect/models/events/seam-event.d.ts +4 -4
- package/lib/seam/connect/openapi.js +194 -12
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +76 -24
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +4 -4
- package/src/lib/seam/connect/models/events/access-codes.ts +6 -6
- package/src/lib/seam/connect/openapi.ts +197 -12
- package/src/lib/seam/connect/route-types.ts +76 -24
|
@@ -196,15 +196,15 @@ declare const access_code_error: z.ZodDiscriminatedUnion<"error_code", [z.ZodObj
|
|
|
196
196
|
is_access_code_error: z.ZodLiteral<true>;
|
|
197
197
|
created_at: z.ZodOptional<z.ZodString>;
|
|
198
198
|
} & {
|
|
199
|
-
error_code: z.ZodLiteral<"
|
|
199
|
+
error_code: z.ZodLiteral<"failed_to_remove">;
|
|
200
200
|
}, "strip", z.ZodTypeAny, {
|
|
201
201
|
message: string;
|
|
202
|
-
error_code: "
|
|
202
|
+
error_code: "failed_to_remove";
|
|
203
203
|
is_access_code_error: true;
|
|
204
204
|
created_at?: string | undefined;
|
|
205
205
|
}, {
|
|
206
206
|
message: string;
|
|
207
|
-
error_code: "
|
|
207
|
+
error_code: "failed_to_remove";
|
|
208
208
|
is_access_code_error: true;
|
|
209
209
|
created_at?: string | undefined;
|
|
210
210
|
}>]>;
|
|
@@ -412,20 +412,20 @@ declare const _access_code_error_map: z.ZodObject<{
|
|
|
412
412
|
is_access_code_error: true;
|
|
413
413
|
created_at?: string | undefined;
|
|
414
414
|
}>>>;
|
|
415
|
-
|
|
415
|
+
failed_to_remove: z.ZodNullable<z.ZodOptional<z.ZodObject<{
|
|
416
416
|
message: z.ZodString;
|
|
417
417
|
is_access_code_error: z.ZodLiteral<true>;
|
|
418
418
|
created_at: z.ZodOptional<z.ZodString>;
|
|
419
419
|
} & {
|
|
420
|
-
error_code: z.ZodLiteral<"
|
|
420
|
+
error_code: z.ZodLiteral<"failed_to_remove">;
|
|
421
421
|
}, "strip", z.ZodTypeAny, {
|
|
422
422
|
message: string;
|
|
423
|
-
error_code: "
|
|
423
|
+
error_code: "failed_to_remove";
|
|
424
424
|
is_access_code_error: true;
|
|
425
425
|
created_at?: string | undefined;
|
|
426
426
|
}, {
|
|
427
427
|
message: string;
|
|
428
|
-
error_code: "
|
|
428
|
+
error_code: "failed_to_remove";
|
|
429
429
|
is_access_code_error: true;
|
|
430
430
|
created_at?: string | undefined;
|
|
431
431
|
}>>>;
|
|
@@ -486,9 +486,9 @@ declare const _access_code_error_map: z.ZodObject<{
|
|
|
486
486
|
is_access_code_error: true;
|
|
487
487
|
created_at?: string | undefined;
|
|
488
488
|
} | null | undefined;
|
|
489
|
-
|
|
489
|
+
failed_to_remove?: {
|
|
490
490
|
message: string;
|
|
491
|
-
error_code: "
|
|
491
|
+
error_code: "failed_to_remove";
|
|
492
492
|
is_access_code_error: true;
|
|
493
493
|
created_at?: string | undefined;
|
|
494
494
|
} | null | undefined;
|
|
@@ -561,9 +561,9 @@ declare const _access_code_error_map: z.ZodObject<{
|
|
|
561
561
|
is_access_code_error: true;
|
|
562
562
|
created_at?: string | undefined;
|
|
563
563
|
} | null | undefined;
|
|
564
|
-
|
|
564
|
+
failed_to_remove?: {
|
|
565
565
|
message: string;
|
|
566
|
-
error_code: "
|
|
566
|
+
error_code: "failed_to_remove";
|
|
567
567
|
is_access_code_error: true;
|
|
568
568
|
created_at?: string | undefined;
|
|
569
569
|
} | null | undefined;
|
|
@@ -1332,15 +1332,15 @@ export declare const access_code: z.ZodObject<{
|
|
|
1332
1332
|
is_access_code_error: z.ZodLiteral<true>;
|
|
1333
1333
|
created_at: z.ZodOptional<z.ZodString>;
|
|
1334
1334
|
} & {
|
|
1335
|
-
error_code: z.ZodLiteral<"
|
|
1335
|
+
error_code: z.ZodLiteral<"failed_to_remove">;
|
|
1336
1336
|
}, "strip", z.ZodTypeAny, {
|
|
1337
1337
|
message: string;
|
|
1338
|
-
error_code: "
|
|
1338
|
+
error_code: "failed_to_remove";
|
|
1339
1339
|
is_access_code_error: true;
|
|
1340
1340
|
created_at?: string | undefined;
|
|
1341
1341
|
}, {
|
|
1342
1342
|
message: string;
|
|
1343
|
-
error_code: "
|
|
1343
|
+
error_code: "failed_to_remove";
|
|
1344
1344
|
is_access_code_error: true;
|
|
1345
1345
|
created_at?: string | undefined;
|
|
1346
1346
|
}>, ...(z.ZodObject<{
|
|
@@ -2239,7 +2239,7 @@ export declare const access_code: z.ZodObject<{
|
|
|
2239
2239
|
created_at?: string | undefined;
|
|
2240
2240
|
} | {
|
|
2241
2241
|
message: string;
|
|
2242
|
-
error_code: "
|
|
2242
|
+
error_code: "failed_to_remove";
|
|
2243
2243
|
is_access_code_error: true;
|
|
2244
2244
|
created_at?: string | undefined;
|
|
2245
2245
|
} | {
|
|
@@ -2537,7 +2537,7 @@ export declare const access_code: z.ZodObject<{
|
|
|
2537
2537
|
created_at?: string | undefined;
|
|
2538
2538
|
} | {
|
|
2539
2539
|
message: string;
|
|
2540
|
-
error_code: "
|
|
2540
|
+
error_code: "failed_to_remove";
|
|
2541
2541
|
is_access_code_error: true;
|
|
2542
2542
|
created_at?: string | undefined;
|
|
2543
2543
|
} | {
|
|
@@ -115,8 +115,8 @@ const failed_to_update = common_access_code_error.extend({
|
|
|
115
115
|
---
|
|
116
116
|
Seam was unable to apply this access code's requested update to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the update is applied.
|
|
117
117
|
`);
|
|
118
|
-
const
|
|
119
|
-
error_code: z.literal('
|
|
118
|
+
const failed_to_remove = common_access_code_error.extend({
|
|
119
|
+
error_code: z.literal('failed_to_remove').describe(error_code_description),
|
|
120
120
|
}).describe(`
|
|
121
121
|
---
|
|
122
122
|
resource_type: access_code
|
|
@@ -156,7 +156,7 @@ const access_code_error = z
|
|
|
156
156
|
code_constraints_violated,
|
|
157
157
|
failed_to_issue,
|
|
158
158
|
failed_to_update,
|
|
159
|
-
|
|
159
|
+
failed_to_remove,
|
|
160
160
|
])
|
|
161
161
|
.describe('Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).');
|
|
162
162
|
const _access_code_error_map = z.object({
|
|
@@ -176,7 +176,7 @@ const _access_code_error_map = z.object({
|
|
|
176
176
|
code_constraints_violated: code_constraints_violated.optional().nullable(),
|
|
177
177
|
failed_to_issue: failed_to_issue.optional().nullable(),
|
|
178
178
|
failed_to_update: failed_to_update.optional().nullable(),
|
|
179
|
-
|
|
179
|
+
failed_to_remove: failed_to_remove.optional().nullable(),
|
|
180
180
|
});
|
|
181
181
|
const common_access_code_warning = z.object({
|
|
182
182
|
message: z
|
|
@@ -205,15 +205,15 @@ export declare const unmanaged_access_code: z.ZodObject<{
|
|
|
205
205
|
is_access_code_error: z.ZodLiteral<true>;
|
|
206
206
|
created_at: z.ZodOptional<z.ZodString>;
|
|
207
207
|
} & {
|
|
208
|
-
error_code: z.ZodLiteral<"
|
|
208
|
+
error_code: z.ZodLiteral<"failed_to_remove">;
|
|
209
209
|
}, "strip", z.ZodTypeAny, {
|
|
210
210
|
message: string;
|
|
211
|
-
error_code: "
|
|
211
|
+
error_code: "failed_to_remove";
|
|
212
212
|
is_access_code_error: true;
|
|
213
213
|
created_at?: string | undefined;
|
|
214
214
|
}, {
|
|
215
215
|
message: string;
|
|
216
|
-
error_code: "
|
|
216
|
+
error_code: "failed_to_remove";
|
|
217
217
|
is_access_code_error: true;
|
|
218
218
|
created_at?: string | undefined;
|
|
219
219
|
}>, ...(z.ZodObject<{
|
|
@@ -938,7 +938,7 @@ export declare const unmanaged_access_code: z.ZodObject<{
|
|
|
938
938
|
created_at?: string | undefined;
|
|
939
939
|
} | {
|
|
940
940
|
message: string;
|
|
941
|
-
error_code: "
|
|
941
|
+
error_code: "failed_to_remove";
|
|
942
942
|
is_access_code_error: true;
|
|
943
943
|
created_at?: string | undefined;
|
|
944
944
|
} | {
|
|
@@ -1183,7 +1183,7 @@ export declare const unmanaged_access_code: z.ZodObject<{
|
|
|
1183
1183
|
created_at?: string | undefined;
|
|
1184
1184
|
} | {
|
|
1185
1185
|
message: string;
|
|
1186
|
-
error_code: "
|
|
1186
|
+
error_code: "failed_to_remove";
|
|
1187
1187
|
is_access_code_error: true;
|
|
1188
1188
|
created_at?: string | undefined;
|
|
1189
1189
|
} | {
|
|
@@ -1449,7 +1449,7 @@ export declare const access_code_failed_to_update_event: z.ZodObject<{
|
|
|
1449
1449
|
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
1450
1450
|
}>;
|
|
1451
1451
|
export type AccessCodeFailedToUpdateEvent = z.infer<typeof access_code_failed_to_update_event>;
|
|
1452
|
-
export declare const
|
|
1452
|
+
export declare const access_code_failed_to_remove_event: z.ZodObject<{
|
|
1453
1453
|
event_id: z.ZodString;
|
|
1454
1454
|
workspace_id: z.ZodString;
|
|
1455
1455
|
created_at: z.ZodString;
|
|
@@ -1462,7 +1462,7 @@ export declare const access_code_failed_to_expire_event: z.ZodObject<{
|
|
|
1462
1462
|
device_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
1463
1463
|
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
1464
1464
|
} & {
|
|
1465
|
-
event_type: z.ZodLiteral<"access_code.
|
|
1465
|
+
event_type: z.ZodLiteral<"access_code.failed_to_remove">;
|
|
1466
1466
|
} & {
|
|
1467
1467
|
connected_account_errors: z.ZodArray<z.ZodObject<{
|
|
1468
1468
|
created_at: z.ZodString;
|
|
@@ -1550,7 +1550,7 @@ export declare const access_code_failed_to_expire_event: z.ZodObject<{
|
|
|
1550
1550
|
access_code_id: string;
|
|
1551
1551
|
event_id: string;
|
|
1552
1552
|
occurred_at: string;
|
|
1553
|
-
event_type: "access_code.
|
|
1553
|
+
event_type: "access_code.failed_to_remove";
|
|
1554
1554
|
connected_account_errors: {
|
|
1555
1555
|
message: string;
|
|
1556
1556
|
created_at: string;
|
|
@@ -1592,7 +1592,7 @@ export declare const access_code_failed_to_expire_event: z.ZodObject<{
|
|
|
1592
1592
|
access_code_id: string;
|
|
1593
1593
|
event_id: string;
|
|
1594
1594
|
occurred_at: string;
|
|
1595
|
-
event_type: "access_code.
|
|
1595
|
+
event_type: "access_code.failed_to_remove";
|
|
1596
1596
|
connected_account_errors: {
|
|
1597
1597
|
message: string;
|
|
1598
1598
|
created_at: string;
|
|
@@ -1627,7 +1627,7 @@ export declare const access_code_failed_to_expire_event: z.ZodObject<{
|
|
|
1627
1627
|
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
1628
1628
|
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
1629
1629
|
}>;
|
|
1630
|
-
export type
|
|
1630
|
+
export type AccessCodeFailedToRemoveEvent = z.infer<typeof access_code_failed_to_remove_event>;
|
|
1631
1631
|
export declare const access_code_deleted_event: z.ZodObject<{
|
|
1632
1632
|
event_id: z.ZodString;
|
|
1633
1633
|
workspace_id: z.ZodString;
|
|
@@ -3886,7 +3886,7 @@ export declare const access_code_events: readonly [z.ZodObject<{
|
|
|
3886
3886
|
device_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
3887
3887
|
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
3888
3888
|
} & {
|
|
3889
|
-
event_type: z.ZodLiteral<"access_code.
|
|
3889
|
+
event_type: z.ZodLiteral<"access_code.failed_to_remove">;
|
|
3890
3890
|
} & {
|
|
3891
3891
|
connected_account_errors: z.ZodArray<z.ZodObject<{
|
|
3892
3892
|
created_at: z.ZodString;
|
|
@@ -3974,7 +3974,7 @@ export declare const access_code_events: readonly [z.ZodObject<{
|
|
|
3974
3974
|
access_code_id: string;
|
|
3975
3975
|
event_id: string;
|
|
3976
3976
|
occurred_at: string;
|
|
3977
|
-
event_type: "access_code.
|
|
3977
|
+
event_type: "access_code.failed_to_remove";
|
|
3978
3978
|
connected_account_errors: {
|
|
3979
3979
|
message: string;
|
|
3980
3980
|
created_at: string;
|
|
@@ -4016,7 +4016,7 @@ export declare const access_code_events: readonly [z.ZodObject<{
|
|
|
4016
4016
|
access_code_id: string;
|
|
4017
4017
|
event_id: string;
|
|
4018
4018
|
occurred_at: string;
|
|
4019
|
-
event_type: "access_code.
|
|
4019
|
+
event_type: "access_code.failed_to_remove";
|
|
4020
4020
|
connected_account_errors: {
|
|
4021
4021
|
message: string;
|
|
4022
4022
|
created_at: string;
|
|
@@ -264,16 +264,16 @@ export const access_code_failed_to_update_event = access_code_event
|
|
|
264
264
|
---
|
|
265
265
|
Seam was unable to apply this [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes)'s requested update to the device, so the code on the device does not match its requested state. Seam keeps retrying, and the accompanying \`failed_to_update\` error clears automatically once the update is applied.
|
|
266
266
|
`);
|
|
267
|
-
export const
|
|
267
|
+
export const access_code_failed_to_remove_event = access_code_event
|
|
268
268
|
.extend({
|
|
269
|
-
event_type: z.literal('access_code.
|
|
269
|
+
event_type: z.literal('access_code.failed_to_remove'),
|
|
270
270
|
})
|
|
271
271
|
.extend(access_code_event_issue_properties).describe(`
|
|
272
272
|
---
|
|
273
273
|
route_path: /access_codes
|
|
274
274
|
undocumented: Unreleased.
|
|
275
275
|
---
|
|
276
|
-
An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its \`ends_at\` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying \`
|
|
276
|
+
An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its \`ends_at\` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying \`failed_to_remove\` error clears automatically once the access code is no longer active.
|
|
277
277
|
`);
|
|
278
278
|
export const access_code_deleted_event = access_code_event.extend({
|
|
279
279
|
event_type: z.literal('access_code.deleted'),
|
|
@@ -383,7 +383,7 @@ export const access_code_events = [
|
|
|
383
383
|
access_code_delay_in_issuing_event,
|
|
384
384
|
access_code_failed_to_issue_event,
|
|
385
385
|
access_code_failed_to_update_event,
|
|
386
|
-
|
|
386
|
+
access_code_failed_to_remove_event,
|
|
387
387
|
access_code_deleted_event,
|
|
388
388
|
access_code_delay_in_removing_from_device_event,
|
|
389
389
|
access_code_failed_to_remove_from_device_event,
|
|
@@ -1432,7 +1432,7 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
|
|
|
1432
1432
|
device_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
1433
1433
|
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
1434
1434
|
} & {
|
|
1435
|
-
event_type: z.ZodLiteral<"access_code.
|
|
1435
|
+
event_type: z.ZodLiteral<"access_code.failed_to_remove">;
|
|
1436
1436
|
} & {
|
|
1437
1437
|
connected_account_errors: z.ZodArray<z.ZodObject<{
|
|
1438
1438
|
created_at: z.ZodString;
|
|
@@ -1520,7 +1520,7 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
|
|
|
1520
1520
|
access_code_id: string;
|
|
1521
1521
|
event_id: string;
|
|
1522
1522
|
occurred_at: string;
|
|
1523
|
-
event_type: "access_code.
|
|
1523
|
+
event_type: "access_code.failed_to_remove";
|
|
1524
1524
|
connected_account_errors: {
|
|
1525
1525
|
message: string;
|
|
1526
1526
|
created_at: string;
|
|
@@ -1562,7 +1562,7 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
|
|
|
1562
1562
|
access_code_id: string;
|
|
1563
1563
|
event_id: string;
|
|
1564
1564
|
occurred_at: string;
|
|
1565
|
-
event_type: "access_code.
|
|
1565
|
+
event_type: "access_code.failed_to_remove";
|
|
1566
1566
|
connected_account_errors: {
|
|
1567
1567
|
message: string;
|
|
1568
1568
|
created_at: string;
|
|
@@ -6370,5 +6370,5 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
|
|
|
6370
6370
|
space_key?: string | undefined;
|
|
6371
6371
|
}>]>;
|
|
6372
6372
|
export type SeamEvent = z.infer<typeof seam_event>;
|
|
6373
|
-
export declare const seam_event_type: z.ZodEnum<["access_code.created" | "access_code.changed" | "access_code.name_changed" | "access_code.code_changed" | "access_code.time_frame_changed" | "access_code.mutations_requested" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.removed_from_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_set_on_device" | "access_code.issued" | "access_code.delay_in_issuing" | "access_code.failed_to_issue" | "access_code.failed_to_update" | "access_code.
|
|
6373
|
+
export declare const seam_event_type: z.ZodEnum<["access_code.created" | "access_code.changed" | "access_code.name_changed" | "access_code.code_changed" | "access_code.time_frame_changed" | "access_code.mutations_requested" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.removed_from_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_set_on_device" | "access_code.issued" | "access_code.delay_in_issuing" | "access_code.failed_to_issue" | "access_code.failed_to_update" | "access_code.failed_to_remove" | "access_code.deleted" | "access_code.delay_in_removing_from_device" | "access_code.failed_to_remove_from_device" | "access_code.modified_external_to_seam" | "access_code.deleted_external_to_seam" | "access_code.backup_access_code_pulled" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "access_grant.created" | "access_grant.deleted" | "access_grant.access_granted_to_all_doors" | "access_grant.access_granted_to_door" | "access_grant.access_to_door_lost" | "access_grant.access_times_changed" | "access_grant.could_not_create_requested_access_methods" | "access_method.issued" | "access_method.card_encoding_required" | "access_method.revoked" | "access_method.deleted" | "access_method.reissued" | "access_method.created" | "access_method.delay_in_issuing" | "access_method.failed_to_issue" | "acs_access_group.deleted" | "acs_credential.deleted" | "acs_credential.issued" | "acs_credential.reissued" | "acs_credential.invalidated" | "acs_encoder.added" | "acs_encoder.removed" | "acs_entrance.added" | "acs_entrance.removed" | "acs_system.connected" | "acs_system.disconnected" | "acs_system.added" | "acs_user.deleted" | "acs_user.created" | "action_attempt.lock_door.succeeded" | "action_attempt.lock_door.failed" | "action_attempt.unlock_door.succeeded" | "action_attempt.unlock_door.failed" | "action_attempt.simulate_keypad_code_entry.succeeded" | "action_attempt.simulate_keypad_code_entry.failed" | "action_attempt.simulate_manual_lock_via_keypad.succeeded" | "action_attempt.simulate_manual_lock_via_keypad.failed" | "client_session.deleted" | "connect_webview.login_succeeded" | "connect_webview.login_failed" | "connected_account.connected" | "connected_account.created" | "connected_account.successful_login" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.deleted" | "connected_account.completed_first_sync_after_reconnection" | "connected_account.reauthorization_requested" | "device.connected" | "device.added" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.removed" | "device.deleted" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "device.accessory_keypad_connected" | "device.accessory_keypad_disconnected" | "noise_sensor.noise_threshold_triggered" | "lock.locked" | "lock.unlocked" | "lock.access_denied" | "thermostat.climate_preset_activated" | "thermostat.manually_adjusted" | "thermostat.temperature_threshold_exceeded" | "thermostat.temperature_threshold_no_longer_exceeded" | "thermostat.temperature_reached_set_point" | "thermostat.temperature_changed" | "device.name_changed" | "camera.activated" | "device.doorbell_rang" | "enrollment_automation.deleted" | "phone.deactivated" | "space.device_membership_changed" | "space.created" | "space.deleted", ...("access_code.created" | "access_code.changed" | "access_code.name_changed" | "access_code.code_changed" | "access_code.time_frame_changed" | "access_code.mutations_requested" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.removed_from_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_set_on_device" | "access_code.issued" | "access_code.delay_in_issuing" | "access_code.failed_to_issue" | "access_code.failed_to_update" | "access_code.failed_to_remove" | "access_code.deleted" | "access_code.delay_in_removing_from_device" | "access_code.failed_to_remove_from_device" | "access_code.modified_external_to_seam" | "access_code.deleted_external_to_seam" | "access_code.backup_access_code_pulled" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "access_grant.created" | "access_grant.deleted" | "access_grant.access_granted_to_all_doors" | "access_grant.access_granted_to_door" | "access_grant.access_to_door_lost" | "access_grant.access_times_changed" | "access_grant.could_not_create_requested_access_methods" | "access_method.issued" | "access_method.card_encoding_required" | "access_method.revoked" | "access_method.deleted" | "access_method.reissued" | "access_method.created" | "access_method.delay_in_issuing" | "access_method.failed_to_issue" | "acs_access_group.deleted" | "acs_credential.deleted" | "acs_credential.issued" | "acs_credential.reissued" | "acs_credential.invalidated" | "acs_encoder.added" | "acs_encoder.removed" | "acs_entrance.added" | "acs_entrance.removed" | "acs_system.connected" | "acs_system.disconnected" | "acs_system.added" | "acs_user.deleted" | "acs_user.created" | "action_attempt.lock_door.succeeded" | "action_attempt.lock_door.failed" | "action_attempt.unlock_door.succeeded" | "action_attempt.unlock_door.failed" | "action_attempt.simulate_keypad_code_entry.succeeded" | "action_attempt.simulate_keypad_code_entry.failed" | "action_attempt.simulate_manual_lock_via_keypad.succeeded" | "action_attempt.simulate_manual_lock_via_keypad.failed" | "client_session.deleted" | "connect_webview.login_succeeded" | "connect_webview.login_failed" | "connected_account.connected" | "connected_account.created" | "connected_account.successful_login" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.deleted" | "connected_account.completed_first_sync_after_reconnection" | "connected_account.reauthorization_requested" | "device.connected" | "device.added" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.removed" | "device.deleted" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "device.accessory_keypad_connected" | "device.accessory_keypad_disconnected" | "noise_sensor.noise_threshold_triggered" | "lock.locked" | "lock.unlocked" | "lock.access_denied" | "thermostat.climate_preset_activated" | "thermostat.manually_adjusted" | "thermostat.temperature_threshold_exceeded" | "thermostat.temperature_threshold_no_longer_exceeded" | "thermostat.temperature_reached_set_point" | "thermostat.temperature_changed" | "device.name_changed" | "camera.activated" | "device.doorbell_rang" | "enrollment_automation.deleted" | "phone.deactivated" | "space.device_membership_changed" | "space.created" | "space.deleted")[]]>;
|
|
6374
6374
|
export type SeamEventType = SeamEvent['event_type'];
|
|
@@ -406,7 +406,7 @@ const openapi = {
|
|
|
406
406
|
},
|
|
407
407
|
error_code: {
|
|
408
408
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
409
|
-
enum: ['
|
|
409
|
+
enum: ['failed_to_remove'],
|
|
410
410
|
type: 'string',
|
|
411
411
|
},
|
|
412
412
|
is_access_code_error: {
|
|
@@ -18200,7 +18200,7 @@ const openapi = {
|
|
|
18200
18200
|
'x-undocumented': 'Unreleased.',
|
|
18201
18201
|
},
|
|
18202
18202
|
{
|
|
18203
|
-
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying `
|
|
18203
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying `failed_to_remove` error clears automatically once the access code is no longer active.',
|
|
18204
18204
|
properties: {
|
|
18205
18205
|
access_code_errors: {
|
|
18206
18206
|
description: 'Errors associated with the access code.',
|
|
@@ -18390,7 +18390,7 @@ const openapi = {
|
|
|
18390
18390
|
type: 'string',
|
|
18391
18391
|
},
|
|
18392
18392
|
event_type: {
|
|
18393
|
-
enum: ['access_code.
|
|
18393
|
+
enum: ['access_code.failed_to_remove'],
|
|
18394
18394
|
type: 'string',
|
|
18395
18395
|
},
|
|
18396
18396
|
occurred_at: {
|
|
@@ -28665,7 +28665,7 @@ const openapi = {
|
|
|
28665
28665
|
},
|
|
28666
28666
|
error_code: {
|
|
28667
28667
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28668
|
-
enum: ['
|
|
28668
|
+
enum: ['failed_to_remove'],
|
|
28669
28669
|
type: 'string',
|
|
28670
28670
|
},
|
|
28671
28671
|
is_access_code_error: {
|
|
@@ -34869,7 +34869,7 @@ const openapi = {
|
|
|
34869
34869
|
'access_code.delay_in_issuing',
|
|
34870
34870
|
'access_code.failed_to_issue',
|
|
34871
34871
|
'access_code.failed_to_update',
|
|
34872
|
-
'access_code.
|
|
34872
|
+
'access_code.failed_to_remove',
|
|
34873
34873
|
'access_code.scheduled_on_device',
|
|
34874
34874
|
'access_code.set_on_device',
|
|
34875
34875
|
'access_code.removed_from_device',
|
|
@@ -34963,7 +34963,7 @@ const openapi = {
|
|
|
34963
34963
|
'access_code.delay_in_issuing',
|
|
34964
34964
|
'access_code.failed_to_issue',
|
|
34965
34965
|
'access_code.failed_to_update',
|
|
34966
|
-
'access_code.
|
|
34966
|
+
'access_code.failed_to_remove',
|
|
34967
34967
|
'access_code.scheduled_on_device',
|
|
34968
34968
|
'access_code.set_on_device',
|
|
34969
34969
|
'access_code.removed_from_device',
|
|
@@ -41778,6 +41778,188 @@ const openapi = {
|
|
|
41778
41778
|
'x-undocumented': 'Not yet for customer use.',
|
|
41779
41779
|
},
|
|
41780
41780
|
},
|
|
41781
|
+
'/cameras/live_views/create': {
|
|
41782
|
+
post: {
|
|
41783
|
+
description: 'Creates a short-lived, single-camera live view session.',
|
|
41784
|
+
operationId: 'camerasLiveViewsCreatePost',
|
|
41785
|
+
requestBody: {
|
|
41786
|
+
content: {
|
|
41787
|
+
'application/json': {
|
|
41788
|
+
schema: {
|
|
41789
|
+
additionalProperties: false,
|
|
41790
|
+
properties: {
|
|
41791
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
41792
|
+
duration_seconds: {
|
|
41793
|
+
default: 600,
|
|
41794
|
+
maximum: 600,
|
|
41795
|
+
minimum: 1,
|
|
41796
|
+
type: 'integer',
|
|
41797
|
+
},
|
|
41798
|
+
include_audio: { default: false, type: 'boolean' },
|
|
41799
|
+
},
|
|
41800
|
+
required: ['device_id'],
|
|
41801
|
+
type: 'object',
|
|
41802
|
+
},
|
|
41803
|
+
},
|
|
41804
|
+
},
|
|
41805
|
+
},
|
|
41806
|
+
responses: {
|
|
41807
|
+
'200': {
|
|
41808
|
+
content: {
|
|
41809
|
+
'application/json': {
|
|
41810
|
+
schema: {
|
|
41811
|
+
properties: {
|
|
41812
|
+
camera_live_view_session: {
|
|
41813
|
+
properties: {
|
|
41814
|
+
camera_live_view_session_id: {
|
|
41815
|
+
format: 'uuid',
|
|
41816
|
+
type: 'string',
|
|
41817
|
+
},
|
|
41818
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
41819
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
41820
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41821
|
+
},
|
|
41822
|
+
required: [
|
|
41823
|
+
'camera_live_view_session_id',
|
|
41824
|
+
'device_id',
|
|
41825
|
+
'expires_at',
|
|
41826
|
+
'token',
|
|
41827
|
+
],
|
|
41828
|
+
type: 'object',
|
|
41829
|
+
},
|
|
41830
|
+
ok: { type: 'boolean' },
|
|
41831
|
+
},
|
|
41832
|
+
required: ['camera_live_view_session', 'ok'],
|
|
41833
|
+
type: 'object',
|
|
41834
|
+
},
|
|
41835
|
+
},
|
|
41836
|
+
},
|
|
41837
|
+
description: 'OK',
|
|
41838
|
+
},
|
|
41839
|
+
'400': { description: 'Bad Request' },
|
|
41840
|
+
'401': { description: 'Unauthorized' },
|
|
41841
|
+
},
|
|
41842
|
+
security: [{ client_session: [] }],
|
|
41843
|
+
summary: '/cameras/live_views/create',
|
|
41844
|
+
tags: [],
|
|
41845
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41846
|
+
'x-fern-sdk-method-name': 'create',
|
|
41847
|
+
'x-fern-sdk-return-value': 'camera_live_view_session',
|
|
41848
|
+
'x-response-key': 'camera_live_view_session',
|
|
41849
|
+
'x-title': 'Create a Camera Live View Session',
|
|
41850
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41851
|
+
},
|
|
41852
|
+
},
|
|
41853
|
+
'/cameras/live_views/offer': {
|
|
41854
|
+
post: {
|
|
41855
|
+
description: 'Exchanges one WebRTC offer for an authorized camera live view session.',
|
|
41856
|
+
operationId: 'camerasLiveViewsOfferPost',
|
|
41857
|
+
requestBody: {
|
|
41858
|
+
content: {
|
|
41859
|
+
'application/json': {
|
|
41860
|
+
schema: {
|
|
41861
|
+
additionalProperties: false,
|
|
41862
|
+
properties: {
|
|
41863
|
+
camera_live_view_session_id: {
|
|
41864
|
+
format: 'uuid',
|
|
41865
|
+
type: 'string',
|
|
41866
|
+
},
|
|
41867
|
+
sdp_offer: {
|
|
41868
|
+
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
41869
|
+
maxLength: 65_536,
|
|
41870
|
+
minLength: 1,
|
|
41871
|
+
type: 'string',
|
|
41872
|
+
},
|
|
41873
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41874
|
+
},
|
|
41875
|
+
required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
|
|
41876
|
+
type: 'object',
|
|
41877
|
+
},
|
|
41878
|
+
},
|
|
41879
|
+
},
|
|
41880
|
+
},
|
|
41881
|
+
responses: {
|
|
41882
|
+
'200': {
|
|
41883
|
+
content: {
|
|
41884
|
+
'application/json': {
|
|
41885
|
+
schema: {
|
|
41886
|
+
properties: {
|
|
41887
|
+
ok: { type: 'boolean' },
|
|
41888
|
+
sdp_answer: {
|
|
41889
|
+
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
41890
|
+
maxLength: 65_536,
|
|
41891
|
+
minLength: 1,
|
|
41892
|
+
type: 'string',
|
|
41893
|
+
},
|
|
41894
|
+
},
|
|
41895
|
+
required: ['sdp_answer', 'ok'],
|
|
41896
|
+
type: 'object',
|
|
41897
|
+
},
|
|
41898
|
+
},
|
|
41899
|
+
},
|
|
41900
|
+
description: 'OK',
|
|
41901
|
+
},
|
|
41902
|
+
'400': { description: 'Bad Request' },
|
|
41903
|
+
'401': { description: 'Unauthorized' },
|
|
41904
|
+
},
|
|
41905
|
+
security: [{ client_session: [] }],
|
|
41906
|
+
summary: '/cameras/live_views/offer',
|
|
41907
|
+
tags: [],
|
|
41908
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41909
|
+
'x-fern-sdk-method-name': 'offer',
|
|
41910
|
+
'x-response-key': null,
|
|
41911
|
+
'x-title': 'Negotiate a Camera Live View',
|
|
41912
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41913
|
+
},
|
|
41914
|
+
},
|
|
41915
|
+
'/cameras/live_views/stop': {
|
|
41916
|
+
post: {
|
|
41917
|
+
description: 'Stops a camera live view session owned by the current client session.',
|
|
41918
|
+
operationId: 'camerasLiveViewsStopPost',
|
|
41919
|
+
requestBody: {
|
|
41920
|
+
content: {
|
|
41921
|
+
'application/json': {
|
|
41922
|
+
schema: {
|
|
41923
|
+
additionalProperties: false,
|
|
41924
|
+
properties: {
|
|
41925
|
+
camera_live_view_session_id: {
|
|
41926
|
+
format: 'uuid',
|
|
41927
|
+
type: 'string',
|
|
41928
|
+
},
|
|
41929
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41930
|
+
},
|
|
41931
|
+
required: ['camera_live_view_session_id', 'token'],
|
|
41932
|
+
type: 'object',
|
|
41933
|
+
},
|
|
41934
|
+
},
|
|
41935
|
+
},
|
|
41936
|
+
},
|
|
41937
|
+
responses: {
|
|
41938
|
+
'200': {
|
|
41939
|
+
content: {
|
|
41940
|
+
'application/json': {
|
|
41941
|
+
schema: {
|
|
41942
|
+
properties: { ok: { type: 'boolean' } },
|
|
41943
|
+
required: ['ok'],
|
|
41944
|
+
type: 'object',
|
|
41945
|
+
},
|
|
41946
|
+
},
|
|
41947
|
+
},
|
|
41948
|
+
description: 'OK',
|
|
41949
|
+
},
|
|
41950
|
+
'400': { description: 'Bad Request' },
|
|
41951
|
+
'401': { description: 'Unauthorized' },
|
|
41952
|
+
},
|
|
41953
|
+
security: [{ client_session: [] }],
|
|
41954
|
+
summary: '/cameras/live_views/stop',
|
|
41955
|
+
tags: [],
|
|
41956
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41957
|
+
'x-fern-sdk-method-name': 'stop',
|
|
41958
|
+
'x-response-key': null,
|
|
41959
|
+
'x-title': 'Stop a Camera Live View Session',
|
|
41960
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41961
|
+
},
|
|
41962
|
+
},
|
|
41781
41963
|
'/client_sessions/create': {
|
|
41782
41964
|
put: {
|
|
41783
41965
|
description: 'Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
|
|
@@ -48618,7 +48800,7 @@ const openapi = {
|
|
|
48618
48800
|
'access_code.delay_in_issuing',
|
|
48619
48801
|
'access_code.failed_to_issue',
|
|
48620
48802
|
'access_code.failed_to_update',
|
|
48621
|
-
'access_code.
|
|
48803
|
+
'access_code.failed_to_remove',
|
|
48622
48804
|
'access_code.deleted',
|
|
48623
48805
|
'access_code.delay_in_removing_from_device',
|
|
48624
48806
|
'access_code.failed_to_remove_from_device',
|
|
@@ -48743,7 +48925,7 @@ const openapi = {
|
|
|
48743
48925
|
'access_code.delay_in_issuing',
|
|
48744
48926
|
'access_code.failed_to_issue',
|
|
48745
48927
|
'access_code.failed_to_update',
|
|
48746
|
-
'access_code.
|
|
48928
|
+
'access_code.failed_to_remove',
|
|
48747
48929
|
'access_code.deleted',
|
|
48748
48930
|
'access_code.delay_in_removing_from_device',
|
|
48749
48931
|
'access_code.failed_to_remove_from_device',
|
|
@@ -56353,7 +56535,7 @@ const openapi = {
|
|
|
56353
56535
|
'access_code.delay_in_issuing',
|
|
56354
56536
|
'access_code.failed_to_issue',
|
|
56355
56537
|
'access_code.failed_to_update',
|
|
56356
|
-
'access_code.
|
|
56538
|
+
'access_code.failed_to_remove',
|
|
56357
56539
|
'access_code.deleted',
|
|
56358
56540
|
'access_code.delay_in_removing_from_device',
|
|
56359
56541
|
'access_code.failed_to_remove_from_device',
|
|
@@ -56479,7 +56661,7 @@ const openapi = {
|
|
|
56479
56661
|
'access_code.delay_in_issuing',
|
|
56480
56662
|
'access_code.failed_to_issue',
|
|
56481
56663
|
'access_code.failed_to_update',
|
|
56482
|
-
'access_code.
|
|
56664
|
+
'access_code.failed_to_remove',
|
|
56483
56665
|
'access_code.deleted',
|
|
56484
56666
|
'access_code.delay_in_removing_from_device',
|
|
56485
56667
|
'access_code.failed_to_remove_from_device',
|
|
@@ -59758,7 +59940,7 @@ const openapi = {
|
|
|
59758
59940
|
'access_code.delay_in_issuing',
|
|
59759
59941
|
'access_code.failed_to_issue',
|
|
59760
59942
|
'access_code.failed_to_update',
|
|
59761
|
-
'access_code.
|
|
59943
|
+
'access_code.failed_to_remove',
|
|
59762
59944
|
'access_code.deleted',
|
|
59763
59945
|
'access_code.delay_in_removing_from_device',
|
|
59764
59946
|
'access_code.failed_to_remove_from_device',
|
|
@@ -59961,7 +60143,7 @@ const openapi = {
|
|
|
59961
60143
|
'access_code.delay_in_issuing',
|
|
59962
60144
|
'access_code.failed_to_issue',
|
|
59963
60145
|
'access_code.failed_to_update',
|
|
59964
|
-
'access_code.
|
|
60146
|
+
'access_code.failed_to_remove',
|
|
59965
60147
|
'access_code.deleted',
|
|
59966
60148
|
'access_code.delay_in_removing_from_device',
|
|
59967
60149
|
'access_code.failed_to_remove_from_device',
|