@seamapi/types 1.931.0 → 1.933.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.931.0",
+  "version": "1.933.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts

@@ -43,22 +43,20 @@ export type AccessCodeConstraint = z.infer<typeof access_code_constraint>
 
 const time_frame_option_time_pair = z
   .object({
-    display_name: z
-      .string()
-      .describe('Label for the check-in/check-out time pairing.'),
-    check_in_time: z
+    display_name: z.string().describe('Label for the start/end time pairing.'),
+    start_time: z
       .string()
       .describe(
-        "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+        "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
       ),
-    check_out_time: z
+    end_time: z
       .string()
       .describe(
-        "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.",
+        "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.",
       ),
   })
   .describe(
-    'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
+    'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
   )
 
 export const time_frame_option = z
@@ -66,7 +64,7 @@ export const time_frame_option = z
     display_name: z
       .string()
       .describe(
-        '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`).',
+        '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`).',
       ),
     min_duration: z
       .string()
@@ -84,25 +82,25 @@ export const time_frame_option = z
       .literal(true)
       .optional()
       .describe(
-        '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`.',
+        'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
       ),
     time_pairs: z
       .array(time_frame_option_time_pair)
       .optional()
       .describe(
-        'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
+        'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
       ),
     start_date_recurrence_rule: z
       .string()
       .optional()
       .describe(
-        '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.',
+        '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.',
       ),
     end_date_recurrence_rule: z
       .string()
       .optional()
       .describe(
-        '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.',
+        'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
       ),
     time_zone: z
       .string()

package/src/lib/seam/connect/models/events/devices.ts

@@ -415,6 +415,9 @@ export const lock_locked_event = device_event.extend({
     .uuid()
     .optional()
     .describe('ID of the access code that was used to lock the device.'),
+  code: z.string().optional().describe(`
+      Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
+    `),
   access_code_is_managed: z
     .boolean()
     .optional()
@@ -455,6 +458,9 @@ export const lock_unlocked_event = device_event.extend({
     .describe(
       'ID of the access code that was used to unlock the affected device.',
     ),
+  code: z.string().optional().describe(`
+      Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
+    `),
   access_code_is_managed: z
     .boolean()
     .optional()

package/src/lib/seam/connect/openapi.ts

@@ -15516,17 +15516,17 @@ const openapi: OpenAPISpec = {
                           properties: {
                             display_name: {
                               description:
-                                'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`).',
+                                '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`).',
                               type: 'string',
                             },
                             end_date_recurrence_rule: {
                               description:
-                                '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.',
+                                'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
                               type: 'string',
                             },
                             matching_start_end_time: {
                               description:
-                                '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`.',
+                                'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
                               enum: [true],
                               type: 'boolean',
                             },
@@ -15542,36 +15542,36 @@ const openapi: OpenAPISpec = {
                             },
                             start_date_recurrence_rule: {
                               description:
-                                '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.',
+                                '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.',
                               type: 'string',
                             },
                             time_pairs: {
                               description:
-                                'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
+                                'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
                               items: {
                                 description:
-                                  'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
+                                  'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
                                 properties: {
-                                  check_in_time: {
+                                  display_name: {
                                     description:
-                                      "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+                                      'Label for the start/end time pairing.',
                                     type: 'string',
                                   },
-                                  check_out_time: {
+                                  end_time: {
                                     description:
-                                      "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.",
+                                      "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.",
                                     type: 'string',
                                   },
-                                  display_name: {
+                                  start_time: {
                                     description:
-                                      'Label for the check-in/check-out time pairing.',
+                                      "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
                                     type: 'string',
                                   },
                                 },
                                 required: [
                                   'display_name',
-                                  'check_in_time',
-                                  'check_out_time',
+                                  'start_time',
+                                  'end_time',
                                 ],
                                 type: 'object',
                               },
@@ -15598,17 +15598,17 @@ const openapi: OpenAPISpec = {
                           properties: {
                             display_name: {
                               description:
-                                'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`).',
+                                '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`).',
                               type: 'string',
                             },
                             end_date_recurrence_rule: {
                               description:
-                                '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.',
+                                'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
                               type: 'string',
                             },
                             matching_start_end_time: {
                               description:
-                                '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`.',
+                                'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
                               enum: [true],
                               type: 'boolean',
                             },
@@ -15624,36 +15624,36 @@ const openapi: OpenAPISpec = {
                             },
                             start_date_recurrence_rule: {
                               description:
-                                '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.',
+                                '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.',
                               type: 'string',
                             },
                             time_pairs: {
                               description:
-                                'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
+                                'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
                               items: {
                                 description:
-                                  'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
+                                  'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
                                 properties: {
-                                  check_in_time: {
+                                  display_name: {
                                     description:
-                                      "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+                                      'Label for the start/end time pairing.',
                                     type: 'string',
                                   },
-                                  check_out_time: {
+                                  end_time: {
                                     description:
-                                      "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.",
+                                      "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.",
                                     type: 'string',
                                   },
-                                  display_name: {
+                                  start_time: {
                                     description:
-                                      'Label for the check-in/check-out time pairing.',
+                                      "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
                                     type: 'string',
                                   },
                                 },
                                 required: [
                                   'display_name',
-                                  'check_in_time',
-                                  'check_out_time',
+                                  'start_time',
+                                  'end_time',
                                 ],
                                 type: 'object',
                               },
@@ -25336,6 +25336,11 @@ const openapi: OpenAPISpec = {
                 format: 'uuid',
                 type: 'string',
               },
+              code: {
+                description:
+                  '\n      Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n    ',
+                type: 'string',
+              },
               connected_account_custom_metadata: {
                 additionalProperties: {
                   oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -25458,6 +25463,11 @@ const openapi: OpenAPISpec = {
                 format: 'uuid',
                 type: 'string',
               },
+              code: {
+                description:
+                  '\n      Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n    ',
+                type: 'string',
+              },
               connected_account_custom_metadata: {
                 additionalProperties: {
                   oneOf: [{ type: 'string' }, { type: 'boolean' }],