@seamapi/types 1.766.0 → 1.768.0

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

@@ -8834,6 +8834,119 @@ export default {
             ],
             type: 'object',
           },
+          {
+            description: 'Configuring the auto-lock is pending.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of configuring the auto-lock on a lock.',
+                enum: ['CONFIGURE_AUTO_LOCK'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for pending action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['pending'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'error',
+              'action_type',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Configuring the auto-lock succeeded.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of configuring the auto-lock on a lock.',
+                enum: ['CONFIGURE_AUTO_LOCK'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for successful action attempts.',
+                nullable: true,
+              },
+              result: {
+                description: 'Result of the action.',
+                properties: {},
+                type: 'object',
+              },
+              status: { enum: ['success'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'error',
+              'action_type',
+              'result',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Configuring the auto-lock failed.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                description:
+                  'Action attempt to track the status of configuring the auto-lock on a lock.',
+                enum: ['CONFIGURE_AUTO_LOCK'],
+                type: 'string',
+              },
+              error: {
+                description: 'Error associated with the action.',
+                properties: {
+                  message: {
+                    description:
+                      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                    type: 'string',
+                  },
+                  type: { description: 'Type of the error.', type: 'string' },
+                },
+                required: ['type', 'message'],
+                type: 'object',
+              },
+              result: {
+                description:
+                  'Result of the action attempt. Null for failed action attempts.',
+                nullable: true,
+              },
+              status: { enum: ['error'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'result',
+              'action_type',
+              'error',
+            ],
+            type: 'object',
+          },
           {
             properties: {
               action_attempt_id: {
@@ -10755,6 +10868,7 @@ export default {
         description:
           'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.',
         properties: {
+          can_configure_auto_lock: { type: 'boolean' },
           can_hvac_cool: { type: 'boolean' },
           can_hvac_heat: { type: 'boolean' },
           can_hvac_heat_cool: { type: 'boolean' },
@@ -12951,6 +13065,11 @@ export default {
                           features: {
                             description: 'Features for a TTLock device.',
                             properties: {
+                              auto_lock_time_config: {
+                                description:
+                                  'Indicates whether a TTLock device supports auto-lock time configuration.',
+                                type: 'boolean',
+                              },
                               incomplete_keyboard_passcode: {
                                 description:
                                   'Indicates whether a TTLock device supports an incomplete keyboard passcode.',
@@ -12989,6 +13108,7 @@ export default {
                               'lock_command',
                               'incomplete_keyboard_passcode',
                               'wifi',
+                              'auto_lock_time_config',
                             ],
                             type: 'object',
                           },
@@ -13163,6 +13283,19 @@ export default {
                         type: 'array',
                         'x-undocumented': 'Marked as experimental.',
                       },
+                      auto_lock_delay_seconds: {
+                        description:
+                          'The delay in seconds before the lock automatically locks after being unlocked.',
+                        format: 'float',
+                        type: 'number',
+                        'x-property-group-key': 'locks',
+                      },
+                      auto_lock_enabled: {
+                        description:
+                          'Indicates whether automatic locking is enabled.',
+                        type: 'boolean',
+                        'x-property-group-key': 'locks',
+                      },
                       code_constraints: {
                         description:
                           'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.',
@@ -14837,6 +14970,7 @@ export default {
       },
       device_provider: {
         properties: {
+          can_configure_auto_lock: { type: 'boolean' },
           can_hvac_cool: { type: 'boolean' },
           can_hvac_heat: { type: 'boolean' },
           can_hvac_heat_cool: { type: 'boolean' },
@@ -25256,6 +25390,7 @@ export default {
         required: ['name', 'staff_member_key'],
         type: 'object',
         'x-route-path': '/seam/customer/v1/staff_members',
+        'x-undocumented': 'Internal resource for customer portals.',
       },
       thermostat_daily_program: {
         description:
@@ -28945,6 +29080,7 @@ export default {
         description:
           'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
         properties: {
+          can_configure_auto_lock: { type: 'boolean' },
           can_hvac_cool: { type: 'boolean' },
           can_hvac_heat: { type: 'boolean' },
           can_hvac_heat_cool: { type: 'boolean' },
@@ -31724,6 +31860,8 @@ export default {
                     },
                     timeline_events: {
                       items: {
+                        description:
+                          'Timeline event for access code lifecycle activity.',
                         properties: {
                           actor: {
                             description:
@@ -31789,6 +31927,7 @@ export default {
                               'access_code.unmanaged.failed_to_convert_to_managed',
                             ],
                             type: 'string',
+                            'x-undocumented': 'Unreleased.',
                           },
                           occurred_at: {
                             description:
@@ -31828,6 +31967,7 @@ export default {
                           'actor',
                         ],
                         type: 'object',
+                        'x-undocumented': 'Unreleased.',
                       },
                       type: 'array',
                     },
@@ -31856,6 +31996,7 @@ export default {
         'x-fern-sdk-return-value': 'timeline_events',
         'x-response-key': 'timeline_events',
         'x-title': 'Get Access Code Timeline',
+        'x-undocumented': 'Unreleased.',
       },
       post: {
         description:
@@ -31944,6 +32085,8 @@ export default {
                     },
                     timeline_events: {
                       items: {
+                        description:
+                          'Timeline event for access code lifecycle activity.',
                         properties: {
                           actor: {
                             description:
@@ -32009,6 +32152,7 @@ export default {
                               'access_code.unmanaged.failed_to_convert_to_managed',
                             ],
                             type: 'string',
+                            'x-undocumented': 'Unreleased.',
                           },
                           occurred_at: {
                             description:
@@ -32048,6 +32192,7 @@ export default {
                           'actor',
                         ],
                         type: 'object',
+                        'x-undocumented': 'Unreleased.',
                       },
                       type: 'array',
                     },
@@ -32076,6 +32221,7 @@ export default {
         'x-fern-sdk-return-value': 'timeline_events',
         'x-response-key': 'timeline_events',
         'x-title': 'Get Access Code Timeline',
+        'x-undocumented': 'Unreleased.',
       },
     },
     '/access_codes/list': {
@@ -49517,6 +49663,8 @@ export default {
                         },
                         required: ['resource_type', 'resource_key'],
                         type: 'object',
+                        'x-undocumented':
+                          'Internal endpoint for customer portals.',
                       },
                       exclude_locale_picker: {
                         default: false,
@@ -50519,6 +50667,8 @@ export default {
                               required: ['name', 'staff_member_key'],
                               type: 'object',
                               'x-route-path': '/seam/customer/v1/staff_members',
+                              'x-undocumented':
+                                'Internal resource for customer portals.',
                             },
                             type: 'array',
                           },
@@ -51752,6 +51902,8 @@ export default {
                       required: ['name', 'staff_member_key'],
                       type: 'object',
                       'x-route-path': '/seam/customer/v1/staff_members',
+                      'x-undocumented':
+                        'Internal resource for customer portals.',
                     },
                     type: 'array',
                   },
@@ -51986,6 +52138,7 @@ export default {
         'x-fern-sdk-return-value': 'deep_link',
         'x-response-key': 'deep_link',
         'x-title': 'Create Reservation Deep Link',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/devices/delete': {
@@ -52543,6 +52696,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -52575,6 +52729,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -52875,6 +53030,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -52903,6 +53059,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -54426,6 +54583,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -54458,6 +54616,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -54768,6 +54927,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -54796,6 +54956,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -56671,6 +56832,78 @@ export default {
         'x-title': 'List Instant Keys',
       },
     },
+    '/locks/configure_auto_lock': {
+      post: {
+        description:
+          'Configures the auto-lock setting for a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).',
+        operationId: 'locksConfigureAutoLockPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  auto_lock_delay_seconds: {
+                    description:
+                      'Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.',
+                    format: 'float',
+                    maximum: 60,
+                    minimum: 1,
+                    type: 'number',
+                  },
+                  auto_lock_enabled: {
+                    description: 'Whether to enable or disable auto-lock.',
+                    type: 'boolean',
+                  },
+                  device_id: {
+                    description:
+                      'ID of the lock for which you want to configure the auto-lock.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['device_id', 'auto_lock_enabled'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/action_attempt',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['action_attempt', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/locks/configure_auto_lock',
+        tags: ['/locks'],
+        'x-action-attempt-type': 'CONFIGURE_AUTO_LOCK',
+        'x-fern-sdk-group-name': ['locks'],
+        'x-fern-sdk-method-name': 'configure_auto_lock',
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
+        'x-title': 'Configure Auto-Lock',
+      },
+    },
     '/locks/get': {
       get: {
         description:
@@ -57038,6 +57271,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -57070,6 +57304,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -57295,6 +57530,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -57323,6 +57559,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -57867,6 +58104,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -57899,6 +58137,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -58068,6 +58307,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -58096,6 +58336,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -63970,6 +64211,7 @@ export default {
         'x-fern-sdk-return-value': 'automation',
         'x-response-key': 'automation',
         'x-title': 'Get Customer Automation Configuration',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
       post: {
         description:
@@ -64268,6 +64510,7 @@ export default {
         'x-fern-sdk-return-value': 'automation',
         'x-response-key': 'automation',
         'x-title': 'Get Customer Automation Configuration',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/seam/customer/v1/customers/automations/update': {
@@ -64556,6 +64799,7 @@ export default {
         'x-fern-sdk-method-name': 'update',
         'x-response-key': null,
         'x-title': 'Update Customer Automation Configuration',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
       post: {
         description:
@@ -64842,6 +65086,7 @@ export default {
         'x-fern-sdk-method-name': 'update',
         'x-response-key': null,
         'x-title': 'Update Customer Automation Configuration',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/seam/customer/v1/customers/list': {
@@ -65026,6 +65271,7 @@ export default {
         'x-fern-sdk-method-name': 'me',
         'x-response-key': null,
         'x-title': 'Me',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
       post: {
         description:
@@ -65062,6 +65308,7 @@ export default {
         'x-fern-sdk-method-name': 'me',
         'x-response-key': null,
         'x-title': 'Me',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/seam/customer/v1/customers/open_portal': {
@@ -65926,6 +66173,8 @@ export default {
                           },
                           required: ['resource_type', 'resource_key'],
                           type: 'object',
+                          'x-undocumented':
+                            'Internal endpoint for customer portals.',
                         },
                         exclude_locale_picker: {
                           default: false,
@@ -66331,6 +66580,8 @@ export default {
                           },
                           required: ['resource_type', 'resource_key'],
                           type: 'object',
+                          'x-undocumented':
+                            'Internal endpoint for customer portals.',
                         },
                         exclude_locale_picker: {
                           default: false,
@@ -69040,6 +69291,7 @@ export default {
         'x-fern-sdk-method-name': 'push_common_areas',
         'x-response-key': null,
         'x-title': 'Push Common Areas',
+        'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
     '/seam/customer/v1/staff_members/get': {
@@ -69113,6 +69365,8 @@ export default {
                       required: ['staff_member_key', 'name'],
                       type: 'object',
                       'x-route-path': '/seam/customer/v1/staff_members',
+                      'x-undocumented':
+                        'Internal resource for customer portals.',
                     },
                   },
                   required: ['access_grant', 'spaces', 'staff_member', 'ok'],
@@ -69210,6 +69464,8 @@ export default {
                       required: ['staff_member_key', 'name'],
                       type: 'object',
                       'x-route-path': '/seam/customer/v1/staff_members',
+                      'x-undocumented':
+                        'Internal resource for customer portals.',
                     },
                   },
                   required: ['access_grant', 'spaces', 'staff_member', 'ok'],
@@ -69332,6 +69588,8 @@ export default {
                         required: ['staff_member_key', 'name'],
                         type: 'object',
                         'x-route-path': '/seam/customer/v1/staff_members',
+                        'x-undocumented':
+                          'Internal resource for customer portals.',
                       },
                       type: 'array',
                     },
@@ -69444,6 +69702,8 @@ export default {
                         required: ['staff_member_key', 'name'],
                         type: 'object',
                         'x-route-path': '/seam/customer/v1/staff_members',
+                        'x-undocumented':
+                          'Internal resource for customer portals.',
                       },
                       type: 'array',
                     },
@@ -72839,6 +73099,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -72871,6 +73132,7 @@ export default {
                   'can_simulate_hub_connection',
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
+                  'can_configure_auto_lock',
                 ],
                 type: 'string',
               },
@@ -73054,6 +73316,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },
@@ -73082,6 +73345,7 @@ export default {
                         'can_simulate_hub_connection',
                         'can_simulate_hub_disconnection',
                         'can_simulate_paid_subscription',
+                        'can_configure_auto_lock',
                       ],
                       type: 'string',
                     },