@seamapi/types 1.928.0 → 1.930.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 +194 -9
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1348 -104
- package/dist/index.cjs +194 -9
- package/dist/index.cjs.map +1 -1
- 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 +5 -5
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -5
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +4 -4
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +4 -4
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +2 -2
- package/lib/seam/connect/models/customer/customer-data.d.ts +12 -12
- package/lib/seam/connect/models/customer/location-resources.d.ts +8 -8
- package/lib/seam/connect/models/devices/capability-properties/access-code.d.ts +201 -0
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +58 -0
- 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 +165 -13
- package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +12 -12
- package/lib/seam/connect/models/devices/device-metadata.d.ts +20 -20
- package/lib/seam/connect/models/devices/device.d.ts +248 -40
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +180 -28
- package/lib/seam/connect/models/spaces/space.d.ts +4 -4
- package/lib/seam/connect/models/thermostats/climate-preset.d.ts +4 -4
- package/lib/seam/connect/openapi.js +140 -4
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +895 -11
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +5 -5
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +86 -0
- package/src/lib/seam/connect/models/devices/capability-properties/index.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +168 -4
- package/src/lib/seam/connect/route-types.ts +1133 -11
|
@@ -2019,7 +2019,7 @@ export type Routes = {
|
|
|
2019
2019
|
/** Date and time at which Seam created the warning. */
|
|
2020
2020
|
created_at?: string | undefined;
|
|
2021
2021
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
2022
|
-
warning_code: '
|
|
2022
|
+
warning_code: 'code_rotates_periodically';
|
|
2023
2023
|
} | {
|
|
2024
2024
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
2025
2025
|
message: string;
|
|
@@ -2552,7 +2552,7 @@ export type Routes = {
|
|
|
2552
2552
|
/** Date and time at which Seam created the warning. */
|
|
2553
2553
|
created_at?: string | undefined;
|
|
2554
2554
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
2555
|
-
warning_code: '
|
|
2555
|
+
warning_code: 'code_rotates_periodically';
|
|
2556
2556
|
} | {
|
|
2557
2557
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
2558
2558
|
message: string;
|
|
@@ -4773,7 +4773,7 @@ export type Routes = {
|
|
|
4773
4773
|
/** Date and time at which Seam created the warning. */
|
|
4774
4774
|
created_at?: string | undefined;
|
|
4775
4775
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
4776
|
-
warning_code: '
|
|
4776
|
+
warning_code: 'code_rotates_periodically';
|
|
4777
4777
|
} | {
|
|
4778
4778
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
4779
4779
|
message: string;
|
|
@@ -5352,7 +5352,7 @@ export type Routes = {
|
|
|
5352
5352
|
/** Date and time at which Seam created the warning. */
|
|
5353
5353
|
created_at?: string | undefined;
|
|
5354
5354
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5355
|
-
warning_code: '
|
|
5355
|
+
warning_code: 'code_rotates_periodically';
|
|
5356
5356
|
} | {
|
|
5357
5357
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5358
5358
|
message: string;
|
|
@@ -5876,7 +5876,7 @@ export type Routes = {
|
|
|
5876
5876
|
/** Date and time at which Seam created the warning. */
|
|
5877
5877
|
created_at?: string | undefined;
|
|
5878
5878
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5879
|
-
warning_code: '
|
|
5879
|
+
warning_code: 'code_rotates_periodically';
|
|
5880
5880
|
} | {
|
|
5881
5881
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5882
5882
|
message: string;
|
|
@@ -6377,7 +6377,7 @@ export type Routes = {
|
|
|
6377
6377
|
/** Date and time at which Seam created the warning. */
|
|
6378
6378
|
created_at?: string | undefined;
|
|
6379
6379
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
6380
|
-
warning_code: '
|
|
6380
|
+
warning_code: 'code_rotates_periodically';
|
|
6381
6381
|
} | {
|
|
6382
6382
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
6383
6383
|
message: string;
|
|
@@ -6911,7 +6911,7 @@ export type Routes = {
|
|
|
6911
6911
|
/** Date and time at which Seam created the warning. */
|
|
6912
6912
|
created_at?: string | undefined;
|
|
6913
6913
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
6914
|
-
warning_code: '
|
|
6914
|
+
warning_code: 'code_rotates_periodically';
|
|
6915
6915
|
} | {
|
|
6916
6916
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
6917
6917
|
message: string;
|
|
@@ -9041,7 +9041,7 @@ export type Routes = {
|
|
|
9041
9041
|
/** Date and time at which Seam created the warning. */
|
|
9042
9042
|
created_at?: string | undefined;
|
|
9043
9043
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
9044
|
-
warning_code: '
|
|
9044
|
+
warning_code: 'code_rotates_periodically';
|
|
9045
9045
|
} | {
|
|
9046
9046
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
9047
9047
|
message: string;
|
|
@@ -9461,7 +9461,7 @@ export type Routes = {
|
|
|
9461
9461
|
/** Date and time at which Seam created the warning. */
|
|
9462
9462
|
created_at?: string | undefined;
|
|
9463
9463
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
9464
|
-
warning_code: '
|
|
9464
|
+
warning_code: 'code_rotates_periodically';
|
|
9465
9465
|
} | {
|
|
9466
9466
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
9467
9467
|
message: string;
|
|
@@ -12534,6 +12534,58 @@ export type Routes = {
|
|
|
12534
12534
|
})[] | undefined) | undefined;
|
|
12535
12535
|
/** Supported code lengths for access codes. */
|
|
12536
12536
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
12537
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
12538
|
+
offline_time_frame_options?: ({
|
|
12539
|
+
/** 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 check-in times`). */
|
|
12540
|
+
display_name: string;
|
|
12541
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
12542
|
+
min_duration?: string | undefined;
|
|
12543
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
12544
|
+
max_duration?: string | undefined;
|
|
12545
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
12546
|
+
matching_start_end_time?: true | undefined;
|
|
12547
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
12548
|
+
time_pairs?: {
|
|
12549
|
+
/** Label for the check-in/check-out time pairing. */
|
|
12550
|
+
display_name: string;
|
|
12551
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
12552
|
+
check_in_time: string;
|
|
12553
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
12554
|
+
check_out_time: string;
|
|
12555
|
+
}[] | undefined;
|
|
12556
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
12557
|
+
start_date_recurrence_rule?: string | undefined;
|
|
12558
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
12559
|
+
end_date_recurrence_rule?: string | undefined;
|
|
12560
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
12561
|
+
time_zone?: string | undefined;
|
|
12562
|
+
}[] | undefined) | undefined;
|
|
12563
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
12564
|
+
online_time_frame_options?: ({
|
|
12565
|
+
/** 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 check-in times`). */
|
|
12566
|
+
display_name: string;
|
|
12567
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
12568
|
+
min_duration?: string | undefined;
|
|
12569
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
12570
|
+
max_duration?: string | undefined;
|
|
12571
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
12572
|
+
matching_start_end_time?: true | undefined;
|
|
12573
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
12574
|
+
time_pairs?: {
|
|
12575
|
+
/** Label for the check-in/check-out time pairing. */
|
|
12576
|
+
display_name: string;
|
|
12577
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
12578
|
+
check_in_time: string;
|
|
12579
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
12580
|
+
check_out_time: string;
|
|
12581
|
+
}[] | undefined;
|
|
12582
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
12583
|
+
start_date_recurrence_rule?: string | undefined;
|
|
12584
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
12585
|
+
end_date_recurrence_rule?: string | undefined;
|
|
12586
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
12587
|
+
time_zone?: string | undefined;
|
|
12588
|
+
}[] | undefined) | undefined;
|
|
12537
12589
|
/** Maximum number of active access codes that the device supports. */
|
|
12538
12590
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
12539
12591
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -19182,6 +19234,58 @@ export type Routes = {
|
|
|
19182
19234
|
})[] | undefined) | undefined;
|
|
19183
19235
|
/** Supported code lengths for access codes. */
|
|
19184
19236
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
19237
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
19238
|
+
offline_time_frame_options?: ({
|
|
19239
|
+
/** 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 check-in times`). */
|
|
19240
|
+
display_name: string;
|
|
19241
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
19242
|
+
min_duration?: string | undefined;
|
|
19243
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
19244
|
+
max_duration?: string | undefined;
|
|
19245
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
19246
|
+
matching_start_end_time?: true | undefined;
|
|
19247
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
19248
|
+
time_pairs?: {
|
|
19249
|
+
/** Label for the check-in/check-out time pairing. */
|
|
19250
|
+
display_name: string;
|
|
19251
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
19252
|
+
check_in_time: string;
|
|
19253
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
19254
|
+
check_out_time: string;
|
|
19255
|
+
}[] | undefined;
|
|
19256
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
19257
|
+
start_date_recurrence_rule?: string | undefined;
|
|
19258
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
19259
|
+
end_date_recurrence_rule?: string | undefined;
|
|
19260
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
19261
|
+
time_zone?: string | undefined;
|
|
19262
|
+
}[] | undefined) | undefined;
|
|
19263
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
19264
|
+
online_time_frame_options?: ({
|
|
19265
|
+
/** 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 check-in times`). */
|
|
19266
|
+
display_name: string;
|
|
19267
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
19268
|
+
min_duration?: string | undefined;
|
|
19269
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
19270
|
+
max_duration?: string | undefined;
|
|
19271
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
19272
|
+
matching_start_end_time?: true | undefined;
|
|
19273
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
19274
|
+
time_pairs?: {
|
|
19275
|
+
/** Label for the check-in/check-out time pairing. */
|
|
19276
|
+
display_name: string;
|
|
19277
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
19278
|
+
check_in_time: string;
|
|
19279
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
19280
|
+
check_out_time: string;
|
|
19281
|
+
}[] | undefined;
|
|
19282
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
19283
|
+
start_date_recurrence_rule?: string | undefined;
|
|
19284
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
19285
|
+
end_date_recurrence_rule?: string | undefined;
|
|
19286
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
19287
|
+
time_zone?: string | undefined;
|
|
19288
|
+
}[] | undefined) | undefined;
|
|
19185
19289
|
/** Maximum number of active access codes that the device supports. */
|
|
19186
19290
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
19187
19291
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -41602,6 +41706,58 @@ export type Routes = {
|
|
|
41602
41706
|
})[] | undefined) | undefined;
|
|
41603
41707
|
/** Supported code lengths for access codes. */
|
|
41604
41708
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
41709
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
41710
|
+
offline_time_frame_options?: ({
|
|
41711
|
+
/** 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 check-in times`). */
|
|
41712
|
+
display_name: string;
|
|
41713
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
41714
|
+
min_duration?: string | undefined;
|
|
41715
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
41716
|
+
max_duration?: string | undefined;
|
|
41717
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
41718
|
+
matching_start_end_time?: true | undefined;
|
|
41719
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
41720
|
+
time_pairs?: {
|
|
41721
|
+
/** Label for the check-in/check-out time pairing. */
|
|
41722
|
+
display_name: string;
|
|
41723
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
41724
|
+
check_in_time: string;
|
|
41725
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
41726
|
+
check_out_time: string;
|
|
41727
|
+
}[] | undefined;
|
|
41728
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
41729
|
+
start_date_recurrence_rule?: string | undefined;
|
|
41730
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
41731
|
+
end_date_recurrence_rule?: string | undefined;
|
|
41732
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
41733
|
+
time_zone?: string | undefined;
|
|
41734
|
+
}[] | undefined) | undefined;
|
|
41735
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
41736
|
+
online_time_frame_options?: ({
|
|
41737
|
+
/** 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 check-in times`). */
|
|
41738
|
+
display_name: string;
|
|
41739
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
41740
|
+
min_duration?: string | undefined;
|
|
41741
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
41742
|
+
max_duration?: string | undefined;
|
|
41743
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
41744
|
+
matching_start_end_time?: true | undefined;
|
|
41745
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
41746
|
+
time_pairs?: {
|
|
41747
|
+
/** Label for the check-in/check-out time pairing. */
|
|
41748
|
+
display_name: string;
|
|
41749
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
41750
|
+
check_in_time: string;
|
|
41751
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
41752
|
+
check_out_time: string;
|
|
41753
|
+
}[] | undefined;
|
|
41754
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
41755
|
+
start_date_recurrence_rule?: string | undefined;
|
|
41756
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
41757
|
+
end_date_recurrence_rule?: string | undefined;
|
|
41758
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
41759
|
+
time_zone?: string | undefined;
|
|
41760
|
+
}[] | undefined) | undefined;
|
|
41605
41761
|
/** Maximum number of active access codes that the device supports. */
|
|
41606
41762
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
41607
41763
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -43044,6 +43200,58 @@ export type Routes = {
|
|
|
43044
43200
|
})[] | undefined) | undefined;
|
|
43045
43201
|
/** Supported code lengths for access codes. */
|
|
43046
43202
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
43203
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
43204
|
+
offline_time_frame_options?: ({
|
|
43205
|
+
/** 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 check-in times`). */
|
|
43206
|
+
display_name: string;
|
|
43207
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
43208
|
+
min_duration?: string | undefined;
|
|
43209
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
43210
|
+
max_duration?: string | undefined;
|
|
43211
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
43212
|
+
matching_start_end_time?: true | undefined;
|
|
43213
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
43214
|
+
time_pairs?: {
|
|
43215
|
+
/** Label for the check-in/check-out time pairing. */
|
|
43216
|
+
display_name: string;
|
|
43217
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
43218
|
+
check_in_time: string;
|
|
43219
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
43220
|
+
check_out_time: string;
|
|
43221
|
+
}[] | undefined;
|
|
43222
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
43223
|
+
start_date_recurrence_rule?: string | undefined;
|
|
43224
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
43225
|
+
end_date_recurrence_rule?: string | undefined;
|
|
43226
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
43227
|
+
time_zone?: string | undefined;
|
|
43228
|
+
}[] | undefined) | undefined;
|
|
43229
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
43230
|
+
online_time_frame_options?: ({
|
|
43231
|
+
/** 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 check-in times`). */
|
|
43232
|
+
display_name: string;
|
|
43233
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
43234
|
+
min_duration?: string | undefined;
|
|
43235
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
43236
|
+
max_duration?: string | undefined;
|
|
43237
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
43238
|
+
matching_start_end_time?: true | undefined;
|
|
43239
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
43240
|
+
time_pairs?: {
|
|
43241
|
+
/** Label for the check-in/check-out time pairing. */
|
|
43242
|
+
display_name: string;
|
|
43243
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
43244
|
+
check_in_time: string;
|
|
43245
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
43246
|
+
check_out_time: string;
|
|
43247
|
+
}[] | undefined;
|
|
43248
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
43249
|
+
start_date_recurrence_rule?: string | undefined;
|
|
43250
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
43251
|
+
end_date_recurrence_rule?: string | undefined;
|
|
43252
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
43253
|
+
time_zone?: string | undefined;
|
|
43254
|
+
}[] | undefined) | undefined;
|
|
43047
43255
|
/** Maximum number of active access codes that the device supports. */
|
|
43048
43256
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
43049
43257
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -53537,6 +53745,58 @@ export type Routes = {
|
|
|
53537
53745
|
})[] | undefined) | undefined;
|
|
53538
53746
|
/** Supported code lengths for access codes. */
|
|
53539
53747
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
53748
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
53749
|
+
offline_time_frame_options?: ({
|
|
53750
|
+
/** 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 check-in times`). */
|
|
53751
|
+
display_name: string;
|
|
53752
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
53753
|
+
min_duration?: string | undefined;
|
|
53754
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
53755
|
+
max_duration?: string | undefined;
|
|
53756
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
53757
|
+
matching_start_end_time?: true | undefined;
|
|
53758
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
53759
|
+
time_pairs?: {
|
|
53760
|
+
/** Label for the check-in/check-out time pairing. */
|
|
53761
|
+
display_name: string;
|
|
53762
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
53763
|
+
check_in_time: string;
|
|
53764
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
53765
|
+
check_out_time: string;
|
|
53766
|
+
}[] | undefined;
|
|
53767
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
53768
|
+
start_date_recurrence_rule?: string | undefined;
|
|
53769
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
53770
|
+
end_date_recurrence_rule?: string | undefined;
|
|
53771
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
53772
|
+
time_zone?: string | undefined;
|
|
53773
|
+
}[] | undefined) | undefined;
|
|
53774
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
53775
|
+
online_time_frame_options?: ({
|
|
53776
|
+
/** 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 check-in times`). */
|
|
53777
|
+
display_name: string;
|
|
53778
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
53779
|
+
min_duration?: string | undefined;
|
|
53780
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
53781
|
+
max_duration?: string | undefined;
|
|
53782
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
53783
|
+
matching_start_end_time?: true | undefined;
|
|
53784
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
53785
|
+
time_pairs?: {
|
|
53786
|
+
/** Label for the check-in/check-out time pairing. */
|
|
53787
|
+
display_name: string;
|
|
53788
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
53789
|
+
check_in_time: string;
|
|
53790
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
53791
|
+
check_out_time: string;
|
|
53792
|
+
}[] | undefined;
|
|
53793
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
53794
|
+
start_date_recurrence_rule?: string | undefined;
|
|
53795
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
53796
|
+
end_date_recurrence_rule?: string | undefined;
|
|
53797
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
53798
|
+
time_zone?: string | undefined;
|
|
53799
|
+
}[] | undefined) | undefined;
|
|
53540
53800
|
/** Maximum number of active access codes that the device supports. */
|
|
53541
53801
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
53542
53802
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -54929,6 +55189,58 @@ export type Routes = {
|
|
|
54929
55189
|
})[] | undefined) | undefined;
|
|
54930
55190
|
/** Supported code lengths for access codes. */
|
|
54931
55191
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
55192
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
55193
|
+
offline_time_frame_options?: ({
|
|
55194
|
+
/** 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 check-in times`). */
|
|
55195
|
+
display_name: string;
|
|
55196
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
55197
|
+
min_duration?: string | undefined;
|
|
55198
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
55199
|
+
max_duration?: string | undefined;
|
|
55200
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
55201
|
+
matching_start_end_time?: true | undefined;
|
|
55202
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
55203
|
+
time_pairs?: {
|
|
55204
|
+
/** Label for the check-in/check-out time pairing. */
|
|
55205
|
+
display_name: string;
|
|
55206
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
55207
|
+
check_in_time: string;
|
|
55208
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
55209
|
+
check_out_time: string;
|
|
55210
|
+
}[] | undefined;
|
|
55211
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
55212
|
+
start_date_recurrence_rule?: string | undefined;
|
|
55213
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
55214
|
+
end_date_recurrence_rule?: string | undefined;
|
|
55215
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
55216
|
+
time_zone?: string | undefined;
|
|
55217
|
+
}[] | undefined) | undefined;
|
|
55218
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
55219
|
+
online_time_frame_options?: ({
|
|
55220
|
+
/** 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 check-in times`). */
|
|
55221
|
+
display_name: string;
|
|
55222
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
55223
|
+
min_duration?: string | undefined;
|
|
55224
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
55225
|
+
max_duration?: string | undefined;
|
|
55226
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
55227
|
+
matching_start_end_time?: true | undefined;
|
|
55228
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
55229
|
+
time_pairs?: {
|
|
55230
|
+
/** Label for the check-in/check-out time pairing. */
|
|
55231
|
+
display_name: string;
|
|
55232
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
55233
|
+
check_in_time: string;
|
|
55234
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
55235
|
+
check_out_time: string;
|
|
55236
|
+
}[] | undefined;
|
|
55237
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
55238
|
+
start_date_recurrence_rule?: string | undefined;
|
|
55239
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
55240
|
+
end_date_recurrence_rule?: string | undefined;
|
|
55241
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
55242
|
+
time_zone?: string | undefined;
|
|
55243
|
+
}[] | undefined) | undefined;
|
|
54932
55244
|
/** Maximum number of active access codes that the device supports. */
|
|
54933
55245
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
54934
55246
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -56371,6 +56683,58 @@ export type Routes = {
|
|
|
56371
56683
|
})[] | undefined) | undefined;
|
|
56372
56684
|
/** Supported code lengths for access codes. */
|
|
56373
56685
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
56686
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
56687
|
+
offline_time_frame_options?: ({
|
|
56688
|
+
/** 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 check-in times`). */
|
|
56689
|
+
display_name: string;
|
|
56690
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
56691
|
+
min_duration?: string | undefined;
|
|
56692
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
56693
|
+
max_duration?: string | undefined;
|
|
56694
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
56695
|
+
matching_start_end_time?: true | undefined;
|
|
56696
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
56697
|
+
time_pairs?: {
|
|
56698
|
+
/** Label for the check-in/check-out time pairing. */
|
|
56699
|
+
display_name: string;
|
|
56700
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
56701
|
+
check_in_time: string;
|
|
56702
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
56703
|
+
check_out_time: string;
|
|
56704
|
+
}[] | undefined;
|
|
56705
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
56706
|
+
start_date_recurrence_rule?: string | undefined;
|
|
56707
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
56708
|
+
end_date_recurrence_rule?: string | undefined;
|
|
56709
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
56710
|
+
time_zone?: string | undefined;
|
|
56711
|
+
}[] | undefined) | undefined;
|
|
56712
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
56713
|
+
online_time_frame_options?: ({
|
|
56714
|
+
/** 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 check-in times`). */
|
|
56715
|
+
display_name: string;
|
|
56716
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
56717
|
+
min_duration?: string | undefined;
|
|
56718
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
56719
|
+
max_duration?: string | undefined;
|
|
56720
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
56721
|
+
matching_start_end_time?: true | undefined;
|
|
56722
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
56723
|
+
time_pairs?: {
|
|
56724
|
+
/** Label for the check-in/check-out time pairing. */
|
|
56725
|
+
display_name: string;
|
|
56726
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
56727
|
+
check_in_time: string;
|
|
56728
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
56729
|
+
check_out_time: string;
|
|
56730
|
+
}[] | undefined;
|
|
56731
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
56732
|
+
start_date_recurrence_rule?: string | undefined;
|
|
56733
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
56734
|
+
end_date_recurrence_rule?: string | undefined;
|
|
56735
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
56736
|
+
time_zone?: string | undefined;
|
|
56737
|
+
}[] | undefined) | undefined;
|
|
56374
56738
|
/** Maximum number of active access codes that the device supports. */
|
|
56375
56739
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
56376
56740
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -57762,6 +58126,58 @@ export type Routes = {
|
|
|
57762
58126
|
})[] | undefined) | undefined;
|
|
57763
58127
|
/** Supported code lengths for access codes. */
|
|
57764
58128
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
58129
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
58130
|
+
offline_time_frame_options?: ({
|
|
58131
|
+
/** 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 check-in times`). */
|
|
58132
|
+
display_name: string;
|
|
58133
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
58134
|
+
min_duration?: string | undefined;
|
|
58135
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
58136
|
+
max_duration?: string | undefined;
|
|
58137
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
58138
|
+
matching_start_end_time?: true | undefined;
|
|
58139
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
58140
|
+
time_pairs?: {
|
|
58141
|
+
/** Label for the check-in/check-out time pairing. */
|
|
58142
|
+
display_name: string;
|
|
58143
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
58144
|
+
check_in_time: string;
|
|
58145
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
58146
|
+
check_out_time: string;
|
|
58147
|
+
}[] | undefined;
|
|
58148
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
58149
|
+
start_date_recurrence_rule?: string | undefined;
|
|
58150
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
58151
|
+
end_date_recurrence_rule?: string | undefined;
|
|
58152
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
58153
|
+
time_zone?: string | undefined;
|
|
58154
|
+
}[] | undefined) | undefined;
|
|
58155
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
58156
|
+
online_time_frame_options?: ({
|
|
58157
|
+
/** 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 check-in times`). */
|
|
58158
|
+
display_name: string;
|
|
58159
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
58160
|
+
min_duration?: string | undefined;
|
|
58161
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
58162
|
+
max_duration?: string | undefined;
|
|
58163
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
58164
|
+
matching_start_end_time?: true | undefined;
|
|
58165
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
58166
|
+
time_pairs?: {
|
|
58167
|
+
/** Label for the check-in/check-out time pairing. */
|
|
58168
|
+
display_name: string;
|
|
58169
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
58170
|
+
check_in_time: string;
|
|
58171
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
58172
|
+
check_out_time: string;
|
|
58173
|
+
}[] | undefined;
|
|
58174
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
58175
|
+
start_date_recurrence_rule?: string | undefined;
|
|
58176
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
58177
|
+
end_date_recurrence_rule?: string | undefined;
|
|
58178
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
58179
|
+
time_zone?: string | undefined;
|
|
58180
|
+
}[] | undefined) | undefined;
|
|
57765
58181
|
/** Maximum number of active access codes that the device supports. */
|
|
57766
58182
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
57767
58183
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -65930,6 +66346,58 @@ export type Routes = {
|
|
|
65930
66346
|
})[] | undefined) | undefined;
|
|
65931
66347
|
/** Supported code lengths for access codes. */
|
|
65932
66348
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
66349
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
66350
|
+
offline_time_frame_options?: ({
|
|
66351
|
+
/** 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 check-in times`). */
|
|
66352
|
+
display_name: string;
|
|
66353
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
66354
|
+
min_duration?: string | undefined;
|
|
66355
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
66356
|
+
max_duration?: string | undefined;
|
|
66357
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
66358
|
+
matching_start_end_time?: true | undefined;
|
|
66359
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
66360
|
+
time_pairs?: {
|
|
66361
|
+
/** Label for the check-in/check-out time pairing. */
|
|
66362
|
+
display_name: string;
|
|
66363
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
66364
|
+
check_in_time: string;
|
|
66365
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
66366
|
+
check_out_time: string;
|
|
66367
|
+
}[] | undefined;
|
|
66368
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
66369
|
+
start_date_recurrence_rule?: string | undefined;
|
|
66370
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
66371
|
+
end_date_recurrence_rule?: string | undefined;
|
|
66372
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
66373
|
+
time_zone?: string | undefined;
|
|
66374
|
+
}[] | undefined) | undefined;
|
|
66375
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
66376
|
+
online_time_frame_options?: ({
|
|
66377
|
+
/** 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 check-in times`). */
|
|
66378
|
+
display_name: string;
|
|
66379
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
66380
|
+
min_duration?: string | undefined;
|
|
66381
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
66382
|
+
max_duration?: string | undefined;
|
|
66383
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
66384
|
+
matching_start_end_time?: true | undefined;
|
|
66385
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
66386
|
+
time_pairs?: {
|
|
66387
|
+
/** Label for the check-in/check-out time pairing. */
|
|
66388
|
+
display_name: string;
|
|
66389
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
66390
|
+
check_in_time: string;
|
|
66391
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
66392
|
+
check_out_time: string;
|
|
66393
|
+
}[] | undefined;
|
|
66394
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
66395
|
+
start_date_recurrence_rule?: string | undefined;
|
|
66396
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
66397
|
+
end_date_recurrence_rule?: string | undefined;
|
|
66398
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
66399
|
+
time_zone?: string | undefined;
|
|
66400
|
+
}[] | undefined) | undefined;
|
|
65933
66401
|
/** Maximum number of active access codes that the device supports. */
|
|
65934
66402
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
65935
66403
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -67321,6 +67789,58 @@ export type Routes = {
|
|
|
67321
67789
|
})[] | undefined) | undefined;
|
|
67322
67790
|
/** Supported code lengths for access codes. */
|
|
67323
67791
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
67792
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
67793
|
+
offline_time_frame_options?: ({
|
|
67794
|
+
/** 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 check-in times`). */
|
|
67795
|
+
display_name: string;
|
|
67796
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
67797
|
+
min_duration?: string | undefined;
|
|
67798
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
67799
|
+
max_duration?: string | undefined;
|
|
67800
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
67801
|
+
matching_start_end_time?: true | undefined;
|
|
67802
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
67803
|
+
time_pairs?: {
|
|
67804
|
+
/** Label for the check-in/check-out time pairing. */
|
|
67805
|
+
display_name: string;
|
|
67806
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
67807
|
+
check_in_time: string;
|
|
67808
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
67809
|
+
check_out_time: string;
|
|
67810
|
+
}[] | undefined;
|
|
67811
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
67812
|
+
start_date_recurrence_rule?: string | undefined;
|
|
67813
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
67814
|
+
end_date_recurrence_rule?: string | undefined;
|
|
67815
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
67816
|
+
time_zone?: string | undefined;
|
|
67817
|
+
}[] | undefined) | undefined;
|
|
67818
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
67819
|
+
online_time_frame_options?: ({
|
|
67820
|
+
/** 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 check-in times`). */
|
|
67821
|
+
display_name: string;
|
|
67822
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
67823
|
+
min_duration?: string | undefined;
|
|
67824
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
67825
|
+
max_duration?: string | undefined;
|
|
67826
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
67827
|
+
matching_start_end_time?: true | undefined;
|
|
67828
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
67829
|
+
time_pairs?: {
|
|
67830
|
+
/** Label for the check-in/check-out time pairing. */
|
|
67831
|
+
display_name: string;
|
|
67832
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
67833
|
+
check_in_time: string;
|
|
67834
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
67835
|
+
check_out_time: string;
|
|
67836
|
+
}[] | undefined;
|
|
67837
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
67838
|
+
start_date_recurrence_rule?: string | undefined;
|
|
67839
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
67840
|
+
end_date_recurrence_rule?: string | undefined;
|
|
67841
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
67842
|
+
time_zone?: string | undefined;
|
|
67843
|
+
}[] | undefined) | undefined;
|
|
67324
67844
|
/** Maximum number of active access codes that the device supports. */
|
|
67325
67845
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
67326
67846
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -82773,6 +83293,58 @@ export type Routes = {
|
|
|
82773
83293
|
})[] | undefined) | undefined;
|
|
82774
83294
|
/** Supported code lengths for access codes. */
|
|
82775
83295
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
83296
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
83297
|
+
offline_time_frame_options?: ({
|
|
83298
|
+
/** 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 check-in times`). */
|
|
83299
|
+
display_name: string;
|
|
83300
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
83301
|
+
min_duration?: string | undefined;
|
|
83302
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
83303
|
+
max_duration?: string | undefined;
|
|
83304
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
83305
|
+
matching_start_end_time?: true | undefined;
|
|
83306
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
83307
|
+
time_pairs?: {
|
|
83308
|
+
/** Label for the check-in/check-out time pairing. */
|
|
83309
|
+
display_name: string;
|
|
83310
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
83311
|
+
check_in_time: string;
|
|
83312
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
83313
|
+
check_out_time: string;
|
|
83314
|
+
}[] | undefined;
|
|
83315
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
83316
|
+
start_date_recurrence_rule?: string | undefined;
|
|
83317
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
83318
|
+
end_date_recurrence_rule?: string | undefined;
|
|
83319
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
83320
|
+
time_zone?: string | undefined;
|
|
83321
|
+
}[] | undefined) | undefined;
|
|
83322
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
83323
|
+
online_time_frame_options?: ({
|
|
83324
|
+
/** 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 check-in times`). */
|
|
83325
|
+
display_name: string;
|
|
83326
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
83327
|
+
min_duration?: string | undefined;
|
|
83328
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
83329
|
+
max_duration?: string | undefined;
|
|
83330
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
83331
|
+
matching_start_end_time?: true | undefined;
|
|
83332
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
83333
|
+
time_pairs?: {
|
|
83334
|
+
/** Label for the check-in/check-out time pairing. */
|
|
83335
|
+
display_name: string;
|
|
83336
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
83337
|
+
check_in_time: string;
|
|
83338
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
83339
|
+
check_out_time: string;
|
|
83340
|
+
}[] | undefined;
|
|
83341
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
83342
|
+
start_date_recurrence_rule?: string | undefined;
|
|
83343
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
83344
|
+
end_date_recurrence_rule?: string | undefined;
|
|
83345
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
83346
|
+
time_zone?: string | undefined;
|
|
83347
|
+
}[] | undefined) | undefined;
|
|
82776
83348
|
/** Maximum number of active access codes that the device supports. */
|
|
82777
83349
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
82778
83350
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -90172,6 +90744,58 @@ export type Routes = {
|
|
|
90172
90744
|
})[] | undefined) | undefined;
|
|
90173
90745
|
/** Supported code lengths for access codes. */
|
|
90174
90746
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
90747
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
90748
|
+
offline_time_frame_options?: ({
|
|
90749
|
+
/** 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 check-in times`). */
|
|
90750
|
+
display_name: string;
|
|
90751
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
90752
|
+
min_duration?: string | undefined;
|
|
90753
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
90754
|
+
max_duration?: string | undefined;
|
|
90755
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
90756
|
+
matching_start_end_time?: true | undefined;
|
|
90757
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
90758
|
+
time_pairs?: {
|
|
90759
|
+
/** Label for the check-in/check-out time pairing. */
|
|
90760
|
+
display_name: string;
|
|
90761
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
90762
|
+
check_in_time: string;
|
|
90763
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
90764
|
+
check_out_time: string;
|
|
90765
|
+
}[] | undefined;
|
|
90766
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
90767
|
+
start_date_recurrence_rule?: string | undefined;
|
|
90768
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
90769
|
+
end_date_recurrence_rule?: string | undefined;
|
|
90770
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
90771
|
+
time_zone?: string | undefined;
|
|
90772
|
+
}[] | undefined) | undefined;
|
|
90773
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
90774
|
+
online_time_frame_options?: ({
|
|
90775
|
+
/** 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 check-in times`). */
|
|
90776
|
+
display_name: string;
|
|
90777
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
90778
|
+
min_duration?: string | undefined;
|
|
90779
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
90780
|
+
max_duration?: string | undefined;
|
|
90781
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
90782
|
+
matching_start_end_time?: true | undefined;
|
|
90783
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
90784
|
+
time_pairs?: {
|
|
90785
|
+
/** Label for the check-in/check-out time pairing. */
|
|
90786
|
+
display_name: string;
|
|
90787
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
90788
|
+
check_in_time: string;
|
|
90789
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
90790
|
+
check_out_time: string;
|
|
90791
|
+
}[] | undefined;
|
|
90792
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
90793
|
+
start_date_recurrence_rule?: string | undefined;
|
|
90794
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
90795
|
+
end_date_recurrence_rule?: string | undefined;
|
|
90796
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
90797
|
+
time_zone?: string | undefined;
|
|
90798
|
+
}[] | undefined) | undefined;
|
|
90175
90799
|
/** Maximum number of active access codes that the device supports. */
|
|
90176
90800
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
90177
90801
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -94990,6 +95614,58 @@ export type Routes = {
|
|
|
94990
95614
|
})[] | undefined) | undefined;
|
|
94991
95615
|
/** Supported code lengths for access codes. */
|
|
94992
95616
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
95617
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
95618
|
+
offline_time_frame_options?: ({
|
|
95619
|
+
/** 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 check-in times`). */
|
|
95620
|
+
display_name: string;
|
|
95621
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
95622
|
+
min_duration?: string | undefined;
|
|
95623
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
95624
|
+
max_duration?: string | undefined;
|
|
95625
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
95626
|
+
matching_start_end_time?: true | undefined;
|
|
95627
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
95628
|
+
time_pairs?: {
|
|
95629
|
+
/** Label for the check-in/check-out time pairing. */
|
|
95630
|
+
display_name: string;
|
|
95631
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
95632
|
+
check_in_time: string;
|
|
95633
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
95634
|
+
check_out_time: string;
|
|
95635
|
+
}[] | undefined;
|
|
95636
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
95637
|
+
start_date_recurrence_rule?: string | undefined;
|
|
95638
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
95639
|
+
end_date_recurrence_rule?: string | undefined;
|
|
95640
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
95641
|
+
time_zone?: string | undefined;
|
|
95642
|
+
}[] | undefined) | undefined;
|
|
95643
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
95644
|
+
online_time_frame_options?: ({
|
|
95645
|
+
/** 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 check-in times`). */
|
|
95646
|
+
display_name: string;
|
|
95647
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
95648
|
+
min_duration?: string | undefined;
|
|
95649
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
95650
|
+
max_duration?: string | undefined;
|
|
95651
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
95652
|
+
matching_start_end_time?: true | undefined;
|
|
95653
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
95654
|
+
time_pairs?: {
|
|
95655
|
+
/** Label for the check-in/check-out time pairing. */
|
|
95656
|
+
display_name: string;
|
|
95657
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
95658
|
+
check_in_time: string;
|
|
95659
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
95660
|
+
check_out_time: string;
|
|
95661
|
+
}[] | undefined;
|
|
95662
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
95663
|
+
start_date_recurrence_rule?: string | undefined;
|
|
95664
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
95665
|
+
end_date_recurrence_rule?: string | undefined;
|
|
95666
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
95667
|
+
time_zone?: string | undefined;
|
|
95668
|
+
}[] | undefined) | undefined;
|
|
94993
95669
|
/** Maximum number of active access codes that the device supports. */
|
|
94994
95670
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
94995
95671
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -96381,6 +97057,58 @@ export type Routes = {
|
|
|
96381
97057
|
})[] | undefined) | undefined;
|
|
96382
97058
|
/** Supported code lengths for access codes. */
|
|
96383
97059
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
97060
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
97061
|
+
offline_time_frame_options?: ({
|
|
97062
|
+
/** 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 check-in times`). */
|
|
97063
|
+
display_name: string;
|
|
97064
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
97065
|
+
min_duration?: string | undefined;
|
|
97066
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
97067
|
+
max_duration?: string | undefined;
|
|
97068
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
97069
|
+
matching_start_end_time?: true | undefined;
|
|
97070
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
97071
|
+
time_pairs?: {
|
|
97072
|
+
/** Label for the check-in/check-out time pairing. */
|
|
97073
|
+
display_name: string;
|
|
97074
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
97075
|
+
check_in_time: string;
|
|
97076
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
97077
|
+
check_out_time: string;
|
|
97078
|
+
}[] | undefined;
|
|
97079
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
97080
|
+
start_date_recurrence_rule?: string | undefined;
|
|
97081
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
97082
|
+
end_date_recurrence_rule?: string | undefined;
|
|
97083
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
97084
|
+
time_zone?: string | undefined;
|
|
97085
|
+
}[] | undefined) | undefined;
|
|
97086
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
97087
|
+
online_time_frame_options?: ({
|
|
97088
|
+
/** 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 check-in times`). */
|
|
97089
|
+
display_name: string;
|
|
97090
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
97091
|
+
min_duration?: string | undefined;
|
|
97092
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
97093
|
+
max_duration?: string | undefined;
|
|
97094
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
97095
|
+
matching_start_end_time?: true | undefined;
|
|
97096
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
97097
|
+
time_pairs?: {
|
|
97098
|
+
/** Label for the check-in/check-out time pairing. */
|
|
97099
|
+
display_name: string;
|
|
97100
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
97101
|
+
check_in_time: string;
|
|
97102
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
97103
|
+
check_out_time: string;
|
|
97104
|
+
}[] | undefined;
|
|
97105
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
97106
|
+
start_date_recurrence_rule?: string | undefined;
|
|
97107
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
97108
|
+
end_date_recurrence_rule?: string | undefined;
|
|
97109
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
97110
|
+
time_zone?: string | undefined;
|
|
97111
|
+
}[] | undefined) | undefined;
|
|
96384
97112
|
/** Maximum number of active access codes that the device supports. */
|
|
96385
97113
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
96386
97114
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -105488,6 +106216,58 @@ export type Routes = {
|
|
|
105488
106216
|
})[] | undefined) | undefined;
|
|
105489
106217
|
/** Supported code lengths for access codes. */
|
|
105490
106218
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
106219
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
106220
|
+
offline_time_frame_options?: ({
|
|
106221
|
+
/** 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 check-in times`). */
|
|
106222
|
+
display_name: string;
|
|
106223
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
106224
|
+
min_duration?: string | undefined;
|
|
106225
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
106226
|
+
max_duration?: string | undefined;
|
|
106227
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
106228
|
+
matching_start_end_time?: true | undefined;
|
|
106229
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
106230
|
+
time_pairs?: {
|
|
106231
|
+
/** Label for the check-in/check-out time pairing. */
|
|
106232
|
+
display_name: string;
|
|
106233
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
106234
|
+
check_in_time: string;
|
|
106235
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
106236
|
+
check_out_time: string;
|
|
106237
|
+
}[] | undefined;
|
|
106238
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
106239
|
+
start_date_recurrence_rule?: string | undefined;
|
|
106240
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
106241
|
+
end_date_recurrence_rule?: string | undefined;
|
|
106242
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
106243
|
+
time_zone?: string | undefined;
|
|
106244
|
+
}[] | undefined) | undefined;
|
|
106245
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
106246
|
+
online_time_frame_options?: ({
|
|
106247
|
+
/** 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 check-in times`). */
|
|
106248
|
+
display_name: string;
|
|
106249
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
106250
|
+
min_duration?: string | undefined;
|
|
106251
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
106252
|
+
max_duration?: string | undefined;
|
|
106253
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
106254
|
+
matching_start_end_time?: true | undefined;
|
|
106255
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
106256
|
+
time_pairs?: {
|
|
106257
|
+
/** Label for the check-in/check-out time pairing. */
|
|
106258
|
+
display_name: string;
|
|
106259
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
106260
|
+
check_in_time: string;
|
|
106261
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
106262
|
+
check_out_time: string;
|
|
106263
|
+
}[] | undefined;
|
|
106264
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
106265
|
+
start_date_recurrence_rule?: string | undefined;
|
|
106266
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
106267
|
+
end_date_recurrence_rule?: string | undefined;
|
|
106268
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
106269
|
+
time_zone?: string | undefined;
|
|
106270
|
+
}[] | undefined) | undefined;
|
|
105491
106271
|
/** Maximum number of active access codes that the device supports. */
|
|
105492
106272
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
105493
106273
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -106881,6 +107661,58 @@ export type Routes = {
|
|
|
106881
107661
|
})[] | undefined) | undefined;
|
|
106882
107662
|
/** Supported code lengths for access codes. */
|
|
106883
107663
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
107664
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
107665
|
+
offline_time_frame_options?: ({
|
|
107666
|
+
/** 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 check-in times`). */
|
|
107667
|
+
display_name: string;
|
|
107668
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
107669
|
+
min_duration?: string | undefined;
|
|
107670
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
107671
|
+
max_duration?: string | undefined;
|
|
107672
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
107673
|
+
matching_start_end_time?: true | undefined;
|
|
107674
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
107675
|
+
time_pairs?: {
|
|
107676
|
+
/** Label for the check-in/check-out time pairing. */
|
|
107677
|
+
display_name: string;
|
|
107678
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
107679
|
+
check_in_time: string;
|
|
107680
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
107681
|
+
check_out_time: string;
|
|
107682
|
+
}[] | undefined;
|
|
107683
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
107684
|
+
start_date_recurrence_rule?: string | undefined;
|
|
107685
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
107686
|
+
end_date_recurrence_rule?: string | undefined;
|
|
107687
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
107688
|
+
time_zone?: string | undefined;
|
|
107689
|
+
}[] | undefined) | undefined;
|
|
107690
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
107691
|
+
online_time_frame_options?: ({
|
|
107692
|
+
/** 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 check-in times`). */
|
|
107693
|
+
display_name: string;
|
|
107694
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
107695
|
+
min_duration?: string | undefined;
|
|
107696
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
107697
|
+
max_duration?: string | undefined;
|
|
107698
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
107699
|
+
matching_start_end_time?: true | undefined;
|
|
107700
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
107701
|
+
time_pairs?: {
|
|
107702
|
+
/** Label for the check-in/check-out time pairing. */
|
|
107703
|
+
display_name: string;
|
|
107704
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
107705
|
+
check_in_time: string;
|
|
107706
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
107707
|
+
check_out_time: string;
|
|
107708
|
+
}[] | undefined;
|
|
107709
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
107710
|
+
start_date_recurrence_rule?: string | undefined;
|
|
107711
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
107712
|
+
end_date_recurrence_rule?: string | undefined;
|
|
107713
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
107714
|
+
time_zone?: string | undefined;
|
|
107715
|
+
}[] | undefined) | undefined;
|
|
106884
107716
|
/** Maximum number of active access codes that the device supports. */
|
|
106885
107717
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
106886
107718
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -109529,6 +110361,58 @@ export type Routes = {
|
|
|
109529
110361
|
})[] | undefined) | undefined;
|
|
109530
110362
|
/** Supported code lengths for access codes. */
|
|
109531
110363
|
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
110364
|
+
/** Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
110365
|
+
offline_time_frame_options?: ({
|
|
110366
|
+
/** 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 check-in times`). */
|
|
110367
|
+
display_name: string;
|
|
110368
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
110369
|
+
min_duration?: string | undefined;
|
|
110370
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
110371
|
+
max_duration?: string | undefined;
|
|
110372
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
110373
|
+
matching_start_end_time?: true | undefined;
|
|
110374
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
110375
|
+
time_pairs?: {
|
|
110376
|
+
/** Label for the check-in/check-out time pairing. */
|
|
110377
|
+
display_name: string;
|
|
110378
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
110379
|
+
check_in_time: string;
|
|
110380
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
110381
|
+
check_out_time: string;
|
|
110382
|
+
}[] | undefined;
|
|
110383
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
110384
|
+
start_date_recurrence_rule?: string | undefined;
|
|
110385
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
110386
|
+
end_date_recurrence_rule?: string | undefined;
|
|
110387
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
110388
|
+
time_zone?: string | undefined;
|
|
110389
|
+
}[] | undefined) | undefined;
|
|
110390
|
+
/** Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works. */
|
|
110391
|
+
online_time_frame_options?: ({
|
|
110392
|
+
/** 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 check-in times`). */
|
|
110393
|
+
display_name: string;
|
|
110394
|
+
/** Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum. */
|
|
110395
|
+
min_duration?: string | undefined;
|
|
110396
|
+
/** Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum. */
|
|
110397
|
+
max_duration?: string | undefined;
|
|
110398
|
+
/** When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`. */
|
|
110399
|
+
matching_start_end_time?: true | undefined;
|
|
110400
|
+
/** Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`. */
|
|
110401
|
+
time_pairs?: {
|
|
110402
|
+
/** Label for the check-in/check-out time pairing. */
|
|
110403
|
+
display_name: string;
|
|
110404
|
+
/** Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. */
|
|
110405
|
+
check_in_time: string;
|
|
110406
|
+
/** Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date. */
|
|
110407
|
+
check_out_time: string;
|
|
110408
|
+
}[] | undefined;
|
|
110409
|
+
/** iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
110410
|
+
start_date_recurrence_rule?: string | undefined;
|
|
110411
|
+
/** iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules. */
|
|
110412
|
+
end_date_recurrence_rule?: string | undefined;
|
|
110413
|
+
/** IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates. */
|
|
110414
|
+
time_zone?: string | undefined;
|
|
110415
|
+
}[] | undefined) | undefined;
|
|
109532
110416
|
/** Maximum number of active access codes that the device supports. */
|
|
109533
110417
|
max_active_codes_supported?: (number | undefined) | undefined;
|
|
109534
110418
|
/** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
|
|
@@ -117718,7 +118602,7 @@ export type Routes = {
|
|
|
117718
118602
|
/** Date and time at which Seam created the warning. */
|
|
117719
118603
|
created_at?: string | undefined;
|
|
117720
118604
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117721
|
-
warning_code: '
|
|
118605
|
+
warning_code: 'code_rotates_periodically';
|
|
117722
118606
|
} | {
|
|
117723
118607
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117724
118608
|
message: string;
|
|
@@ -118122,7 +119006,7 @@ export type Routes = {
|
|
|
118122
119006
|
/** Date and time at which Seam created the warning. */
|
|
118123
119007
|
created_at?: string | undefined;
|
|
118124
119008
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
118125
|
-
warning_code: '
|
|
119009
|
+
warning_code: 'code_rotates_periodically';
|
|
118126
119010
|
} | {
|
|
118127
119011
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
118128
119012
|
message: string;
|