@seamapi/types 1.931.0 → 1.933.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/dist/connect.cjs +53 -39
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +470 -432
- package/dist/index.cjs +53 -39
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.d.ts +38 -38
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +11 -13
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +28 -28
- package/lib/seam/connect/models/devices/device-metadata.d.ts +16 -16
- package/lib/seam/connect/models/devices/device.d.ts +52 -52
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +40 -40
- package/lib/seam/connect/models/events/devices.d.ts +12 -0
- package/lib/seam/connect/models/events/devices.js +6 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +6 -0
- package/lib/seam/connect/openapi.js +36 -28
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +372 -340
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +11 -13
- package/src/lib/seam/connect/models/events/devices.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +38 -28
- package/src/lib/seam/connect/route-types.ts +372 -340
package/dist/index.cjs
CHANGED
|
@@ -97,19 +97,19 @@ var access_code_name_constraint = zod.z.object({
|
|
|
97
97
|
}).describe(`Name constraint for access codes.`);
|
|
98
98
|
var access_code_constraint = zod.z.union([access_code_code_constraint, access_code_name_constraint]).describe(`Access code constraint.`);
|
|
99
99
|
var time_frame_option_time_pair = zod.z.object({
|
|
100
|
-
display_name: zod.z.string().describe("Label for the
|
|
101
|
-
|
|
102
|
-
"
|
|
100
|
+
display_name: zod.z.string().describe("Label for the start/end time pairing."),
|
|
101
|
+
start_time: zod.z.string().describe(
|
|
102
|
+
"Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`."
|
|
103
103
|
),
|
|
104
|
-
|
|
105
|
-
"
|
|
104
|
+
end_time: zod.z.string().describe(
|
|
105
|
+
"End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date."
|
|
106
106
|
)
|
|
107
107
|
}).describe(
|
|
108
|
-
"Fixed
|
|
108
|
+
"Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs."
|
|
109
109
|
);
|
|
110
110
|
var time_frame_option = zod.z.object({
|
|
111
111
|
display_name: zod.z.string().describe(
|
|
112
|
-
"Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed
|
|
112
|
+
"Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`)."
|
|
113
113
|
),
|
|
114
114
|
min_duration: zod.z.string().optional().describe(
|
|
115
115
|
"Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum."
|
|
@@ -118,16 +118,16 @@ var time_frame_option = zod.z.object({
|
|
|
118
118
|
"Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum."
|
|
119
119
|
),
|
|
120
120
|
matching_start_end_time: zod.z.literal(true).optional().describe(
|
|
121
|
-
"When `true`, the
|
|
121
|
+
"When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`."
|
|
122
122
|
),
|
|
123
123
|
time_pairs: zod.z.array(time_frame_option_time_pair).optional().describe(
|
|
124
|
-
"Fixed
|
|
124
|
+
"Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`."
|
|
125
125
|
),
|
|
126
126
|
start_date_recurrence_rule: zod.z.string().optional().describe(
|
|
127
|
-
"iCalendar recurrence rule (RRULE) that the
|
|
127
|
+
"iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules."
|
|
128
128
|
),
|
|
129
129
|
end_date_recurrence_rule: zod.z.string().optional().describe(
|
|
130
|
-
"iCalendar recurrence rule (RRULE) that the
|
|
130
|
+
"iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules."
|
|
131
131
|
),
|
|
132
132
|
time_zone: zod.z.string().optional().describe(
|
|
133
133
|
"IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates."
|
|
@@ -6655,6 +6655,9 @@ var noise_sensor_noise_threshold_triggered_event = device_event.extend(
|
|
|
6655
6655
|
var lock_locked_event = device_event.extend({
|
|
6656
6656
|
event_type: zod.z.literal("lock.locked"),
|
|
6657
6657
|
access_code_id: zod.z.string().uuid().optional().describe("ID of the access code that was used to lock the device."),
|
|
6658
|
+
code: zod.z.string().optional().describe(`
|
|
6659
|
+
Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
|
|
6660
|
+
`),
|
|
6658
6661
|
access_code_is_managed: zod.z.boolean().optional().describe(
|
|
6659
6662
|
"Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set."
|
|
6660
6663
|
),
|
|
@@ -6681,6 +6684,9 @@ var lock_unlocked_event = device_event.extend({
|
|
|
6681
6684
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
6682
6685
|
"ID of the access code that was used to unlock the affected device."
|
|
6683
6686
|
),
|
|
6687
|
+
code: zod.z.string().optional().describe(`
|
|
6688
|
+
Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
|
|
6689
|
+
`),
|
|
6684
6690
|
access_code_is_managed: zod.z.boolean().optional().describe(
|
|
6685
6691
|
"Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set."
|
|
6686
6692
|
),
|
|
@@ -21320,15 +21326,15 @@ var openapi = {
|
|
|
21320
21326
|
description: "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.",
|
|
21321
21327
|
properties: {
|
|
21322
21328
|
display_name: {
|
|
21323
|
-
description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed
|
|
21329
|
+
description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).",
|
|
21324
21330
|
type: "string"
|
|
21325
21331
|
},
|
|
21326
21332
|
end_date_recurrence_rule: {
|
|
21327
|
-
description: "iCalendar recurrence rule (RRULE) that the
|
|
21333
|
+
description: "iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.",
|
|
21328
21334
|
type: "string"
|
|
21329
21335
|
},
|
|
21330
21336
|
matching_start_end_time: {
|
|
21331
|
-
description: "When `true`, the
|
|
21337
|
+
description: "When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.",
|
|
21332
21338
|
enum: [true],
|
|
21333
21339
|
type: "boolean"
|
|
21334
21340
|
},
|
|
@@ -21341,31 +21347,31 @@ var openapi = {
|
|
|
21341
21347
|
type: "string"
|
|
21342
21348
|
},
|
|
21343
21349
|
start_date_recurrence_rule: {
|
|
21344
|
-
description: "iCalendar recurrence rule (RRULE) that the
|
|
21350
|
+
description: "iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.",
|
|
21345
21351
|
type: "string"
|
|
21346
21352
|
},
|
|
21347
21353
|
time_pairs: {
|
|
21348
|
-
description: "Fixed
|
|
21354
|
+
description: "Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.",
|
|
21349
21355
|
items: {
|
|
21350
|
-
description: "Fixed
|
|
21356
|
+
description: "Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.",
|
|
21351
21357
|
properties: {
|
|
21352
|
-
|
|
21353
|
-
description: "
|
|
21358
|
+
display_name: {
|
|
21359
|
+
description: "Label for the start/end time pairing.",
|
|
21354
21360
|
type: "string"
|
|
21355
21361
|
},
|
|
21356
|
-
|
|
21357
|
-
description: "
|
|
21362
|
+
end_time: {
|
|
21363
|
+
description: "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
|
|
21358
21364
|
type: "string"
|
|
21359
21365
|
},
|
|
21360
|
-
|
|
21361
|
-
description: "
|
|
21366
|
+
start_time: {
|
|
21367
|
+
description: "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
|
|
21362
21368
|
type: "string"
|
|
21363
21369
|
}
|
|
21364
21370
|
},
|
|
21365
21371
|
required: [
|
|
21366
21372
|
"display_name",
|
|
21367
|
-
"
|
|
21368
|
-
"
|
|
21373
|
+
"start_time",
|
|
21374
|
+
"end_time"
|
|
21369
21375
|
],
|
|
21370
21376
|
type: "object"
|
|
21371
21377
|
},
|
|
@@ -21388,15 +21394,15 @@ var openapi = {
|
|
|
21388
21394
|
description: "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.",
|
|
21389
21395
|
properties: {
|
|
21390
21396
|
display_name: {
|
|
21391
|
-
description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed
|
|
21397
|
+
description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).",
|
|
21392
21398
|
type: "string"
|
|
21393
21399
|
},
|
|
21394
21400
|
end_date_recurrence_rule: {
|
|
21395
|
-
description: "iCalendar recurrence rule (RRULE) that the
|
|
21401
|
+
description: "iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.",
|
|
21396
21402
|
type: "string"
|
|
21397
21403
|
},
|
|
21398
21404
|
matching_start_end_time: {
|
|
21399
|
-
description: "When `true`, the
|
|
21405
|
+
description: "When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.",
|
|
21400
21406
|
enum: [true],
|
|
21401
21407
|
type: "boolean"
|
|
21402
21408
|
},
|
|
@@ -21409,31 +21415,31 @@ var openapi = {
|
|
|
21409
21415
|
type: "string"
|
|
21410
21416
|
},
|
|
21411
21417
|
start_date_recurrence_rule: {
|
|
21412
|
-
description: "iCalendar recurrence rule (RRULE) that the
|
|
21418
|
+
description: "iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.",
|
|
21413
21419
|
type: "string"
|
|
21414
21420
|
},
|
|
21415
21421
|
time_pairs: {
|
|
21416
|
-
description: "Fixed
|
|
21422
|
+
description: "Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.",
|
|
21417
21423
|
items: {
|
|
21418
|
-
description: "Fixed
|
|
21424
|
+
description: "Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.",
|
|
21419
21425
|
properties: {
|
|
21420
|
-
|
|
21421
|
-
description: "
|
|
21426
|
+
display_name: {
|
|
21427
|
+
description: "Label for the start/end time pairing.",
|
|
21422
21428
|
type: "string"
|
|
21423
21429
|
},
|
|
21424
|
-
|
|
21425
|
-
description: "
|
|
21430
|
+
end_time: {
|
|
21431
|
+
description: "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
|
|
21426
21432
|
type: "string"
|
|
21427
21433
|
},
|
|
21428
|
-
|
|
21429
|
-
description: "
|
|
21434
|
+
start_time: {
|
|
21435
|
+
description: "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
|
|
21430
21436
|
type: "string"
|
|
21431
21437
|
}
|
|
21432
21438
|
},
|
|
21433
21439
|
required: [
|
|
21434
21440
|
"display_name",
|
|
21435
|
-
"
|
|
21436
|
-
"
|
|
21441
|
+
"start_time",
|
|
21442
|
+
"end_time"
|
|
21437
21443
|
],
|
|
21438
21444
|
type: "object"
|
|
21439
21445
|
},
|
|
@@ -30302,6 +30308,10 @@ var openapi = {
|
|
|
30302
30308
|
format: "uuid",
|
|
30303
30309
|
type: "string"
|
|
30304
30310
|
},
|
|
30311
|
+
code: {
|
|
30312
|
+
description: "\n Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ",
|
|
30313
|
+
type: "string"
|
|
30314
|
+
},
|
|
30305
30315
|
connected_account_custom_metadata: {
|
|
30306
30316
|
additionalProperties: {
|
|
30307
30317
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -30410,6 +30420,10 @@ var openapi = {
|
|
|
30410
30420
|
format: "uuid",
|
|
30411
30421
|
type: "string"
|
|
30412
30422
|
},
|
|
30423
|
+
code: {
|
|
30424
|
+
description: "\n Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ",
|
|
30425
|
+
type: "string"
|
|
30426
|
+
},
|
|
30413
30427
|
connected_account_custom_metadata: {
|
|
30414
30428
|
additionalProperties: {
|
|
30415
30429
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|