@seamapi/types 1.932.0 → 1.933.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.932.0",
3
+ "version": "1.933.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -43,22 +43,20 @@ export type AccessCodeConstraint = z.infer<typeof access_code_constraint>
43
43
 
44
44
  const time_frame_option_time_pair = z
45
45
  .object({
46
- display_name: z
47
- .string()
48
- .describe('Label for the check-in/check-out time pairing.'),
49
- check_in_time: z
46
+ display_name: z.string().describe('Label for the start/end time pairing.'),
47
+ start_time: z
50
48
  .string()
51
49
  .describe(
52
- "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
50
+ "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
53
51
  ),
54
- check_out_time: z
52
+ end_time: z
55
53
  .string()
56
54
  .describe(
57
- "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.",
55
+ "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
58
56
  ),
59
57
  })
60
58
  .describe(
61
- 'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
59
+ 'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
62
60
  )
63
61
 
64
62
  export const time_frame_option = z
@@ -66,7 +64,7 @@ export const time_frame_option = z
66
64
  display_name: z
67
65
  .string()
68
66
  .describe(
69
- '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`).',
67
+ 'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).',
70
68
  ),
71
69
  min_duration: z
72
70
  .string()
@@ -84,25 +82,25 @@ export const time_frame_option = z
84
82
  .literal(true)
85
83
  .optional()
86
84
  .describe(
87
- '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`.',
85
+ 'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
88
86
  ),
89
87
  time_pairs: z
90
88
  .array(time_frame_option_time_pair)
91
89
  .optional()
92
90
  .describe(
93
- 'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
91
+ 'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
94
92
  ),
95
93
  start_date_recurrence_rule: z
96
94
  .string()
97
95
  .optional()
98
96
  .describe(
99
- '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.',
97
+ 'iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.',
100
98
  ),
101
99
  end_date_recurrence_rule: z
102
100
  .string()
103
101
  .optional()
104
102
  .describe(
105
- '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.',
103
+ 'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
106
104
  ),
107
105
  time_zone: z
108
106
  .string()
@@ -15516,17 +15516,17 @@ const openapi: OpenAPISpec = {
15516
15516
  properties: {
15517
15517
  display_name: {
15518
15518
  description:
15519
- '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`).',
15519
+ 'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).',
15520
15520
  type: 'string',
15521
15521
  },
15522
15522
  end_date_recurrence_rule: {
15523
15523
  description:
15524
- '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.',
15524
+ 'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
15525
15525
  type: 'string',
15526
15526
  },
15527
15527
  matching_start_end_time: {
15528
15528
  description:
15529
- '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`.',
15529
+ 'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
15530
15530
  enum: [true],
15531
15531
  type: 'boolean',
15532
15532
  },
@@ -15542,36 +15542,36 @@ const openapi: OpenAPISpec = {
15542
15542
  },
15543
15543
  start_date_recurrence_rule: {
15544
15544
  description:
15545
- '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.',
15545
+ 'iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.',
15546
15546
  type: 'string',
15547
15547
  },
15548
15548
  time_pairs: {
15549
15549
  description:
15550
- 'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
15550
+ 'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
15551
15551
  items: {
15552
15552
  description:
15553
- 'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
15553
+ 'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
15554
15554
  properties: {
15555
- check_in_time: {
15555
+ display_name: {
15556
15556
  description:
15557
- "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
15557
+ 'Label for the start/end time pairing.',
15558
15558
  type: 'string',
15559
15559
  },
15560
- check_out_time: {
15560
+ end_time: {
15561
15561
  description:
15562
- "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.",
15562
+ "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
15563
15563
  type: 'string',
15564
15564
  },
15565
- display_name: {
15565
+ start_time: {
15566
15566
  description:
15567
- 'Label for the check-in/check-out time pairing.',
15567
+ "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
15568
15568
  type: 'string',
15569
15569
  },
15570
15570
  },
15571
15571
  required: [
15572
15572
  'display_name',
15573
- 'check_in_time',
15574
- 'check_out_time',
15573
+ 'start_time',
15574
+ 'end_time',
15575
15575
  ],
15576
15576
  type: 'object',
15577
15577
  },
@@ -15598,17 +15598,17 @@ const openapi: OpenAPISpec = {
15598
15598
  properties: {
15599
15599
  display_name: {
15600
15600
  description:
15601
- '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`).',
15601
+ 'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).',
15602
15602
  type: 'string',
15603
15603
  },
15604
15604
  end_date_recurrence_rule: {
15605
15605
  description:
15606
- '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.',
15606
+ 'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
15607
15607
  type: 'string',
15608
15608
  },
15609
15609
  matching_start_end_time: {
15610
15610
  description:
15611
- '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`.',
15611
+ 'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
15612
15612
  enum: [true],
15613
15613
  type: 'boolean',
15614
15614
  },
@@ -15624,36 +15624,36 @@ const openapi: OpenAPISpec = {
15624
15624
  },
15625
15625
  start_date_recurrence_rule: {
15626
15626
  description:
15627
- '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.',
15627
+ 'iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.',
15628
15628
  type: 'string',
15629
15629
  },
15630
15630
  time_pairs: {
15631
15631
  description:
15632
- 'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
15632
+ 'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
15633
15633
  items: {
15634
15634
  description:
15635
- 'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
15635
+ 'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
15636
15636
  properties: {
15637
- check_in_time: {
15637
+ display_name: {
15638
15638
  description:
15639
- "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
15639
+ 'Label for the start/end time pairing.',
15640
15640
  type: 'string',
15641
15641
  },
15642
- check_out_time: {
15642
+ end_time: {
15643
15643
  description:
15644
- "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.",
15644
+ "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
15645
15645
  type: 'string',
15646
15646
  },
15647
- display_name: {
15647
+ start_time: {
15648
15648
  description:
15649
- 'Label for the check-in/check-out time pairing.',
15649
+ "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
15650
15650
  type: 'string',
15651
15651
  },
15652
15652
  },
15653
15653
  required: [
15654
15654
  'display_name',
15655
- 'check_in_time',
15656
- 'check_out_time',
15655
+ 'start_time',
15656
+ 'end_time',
15657
15657
  ],
15658
15658
  type: 'object',
15659
15659
  },