@seamapi/types 1.384.0 → 1.385.0

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

@@ -5845,6 +5845,202 @@ export default {
             ],
             type: 'object',
           },
+          {
+            description: 'Simulating keypad code entry.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
+                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: 'Simulating keypad code entry succeeded.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for successful action attempts.',
+                nullable: true,
+              },
+              result: { properties: {}, type: 'object' },
+              status: { enum: ['success'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'error',
+              'action_type',
+              'result',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Simulating keypad code entry failed.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
+                type: 'string',
+              },
+              error: {
+                properties: {
+                  message: { type: 'string' },
+                  type: { 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',
+          },
+          {
+            description: 'Simulating manual lock via keypad.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
+                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: 'Simulating manual lock via keypad succeeded.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
+                type: 'string',
+              },
+              error: {
+                description:
+                  'Errors associated with the action attempt. Null for successful action attempts.',
+                nullable: true,
+              },
+              result: { properties: {}, type: 'object' },
+              status: { enum: ['success'], type: 'string' },
+            },
+            required: [
+              'action_attempt_id',
+              'status',
+              'error',
+              'action_type',
+              'result',
+            ],
+            type: 'object',
+          },
+          {
+            description: 'Simulating manual lock via keypad failed.',
+            properties: {
+              action_attempt_id: {
+                description: 'ID of the action attempt.',
+                format: 'uuid',
+                type: 'string',
+              },
+              action_type: {
+                enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
+                type: 'string',
+              },
+              error: {
+                properties: {
+                  message: { type: 'string' },
+                  type: { 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: {
@@ -24706,98 +24902,6 @@ export default {
         'x-response-key': 'device_providers',
       },
     },
-    '/devices/simulate/access_code_lock': {
-      post: {
-        operationId: 'devicesSimulateAccessCodeLockPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_code_id: { format: 'uuid', type: 'string' },
-                  device_id: { format: 'uuid', type: 'string' },
-                },
-                required: ['device_id', 'access_code_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: { ok: { type: 'boolean' } },
-                  required: ['ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { api_key: [] },
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-        ],
-        summary: '/devices/simulate/access_code_lock',
-        tags: ['/devices'],
-        'x-fern-sdk-group-name': ['devices', 'simulate'],
-        'x-fern-sdk-method-name': 'access_code_lock',
-        'x-response-key': null,
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/devices/simulate/access_code_unlock': {
-      post: {
-        operationId: 'devicesSimulateAccessCodeUnlockPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_code_id: { format: 'uuid', type: 'string' },
-                  device_id: { format: 'uuid', type: 'string' },
-                },
-                required: ['device_id', 'access_code_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: { ok: { type: 'boolean' } },
-                  required: ['ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { api_key: [] },
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-        ],
-        summary: '/devices/simulate/access_code_unlock',
-        tags: ['/devices'],
-        'x-fern-sdk-group-name': ['devices', 'simulate'],
-        'x-fern-sdk-method-name': 'access_code_unlock',
-        'x-response-key': null,
-        'x-undocumented': 'Unreleased.',
-      },
-    },
     '/devices/simulate/connect': {
       post: {
         operationId: 'devicesSimulateConnectPost',
@@ -26149,6 +26253,108 @@ export default {
         'x-response-key': 'action_attempt',
       },
     },
+    '/locks/simulate/keypad_code_entry': {
+      post: {
+        operationId: 'locksSimulateKeypadCodeEntryPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  code: { type: 'string' },
+                  device_id: { format: 'uuid', type: 'string' },
+                },
+                required: ['device_id', 'code'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/access_code',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/locks/simulate/keypad_code_entry',
+        tags: ['/locks'],
+        'x-action-attempt-type': 'SIMULATE_KEYPAD_CODE_ENTRY',
+        'x-fern-sdk-group-name': ['locks', 'simulate'],
+        'x-fern-sdk-method-name': 'keypad_code_entry',
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
+        'x-undocumented': 'Unreleased.',
+      },
+    },
+    '/locks/simulate/manual_lock_via_keypad': {
+      post: {
+        operationId: 'locksSimulateManualLockViaKeypadPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: { device_id: { format: 'uuid', type: 'string' } },
+                required: ['device_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/access_code',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/locks/simulate/manual_lock_via_keypad',
+        tags: ['/locks'],
+        'x-action-attempt-type': 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD',
+        'x-fern-sdk-group-name': ['locks', 'simulate'],
+        'x-fern-sdk-method-name': 'manual_lock_via_keypad',
+        'x-response-key': null,
+        'x-undocumented': 'Unreleased.',
+      },
+    },
     '/locks/unlock_door': {
       post: {
         operationId: 'locksUnlockDoorPost',
@@ -28308,6 +28514,64 @@ export default {
         'x-undocumented': 'Seam Bridge Client only.',
       },
     },
+    '/seam/instant_key/v1/client_sessions/exchange_short_code': {
+      post: {
+        description:
+          'Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token \nusing a short code obtained from an instant key URL.',
+        operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  short_code: {
+                    description:
+                      'The short code to exchange for a client session token',
+                    type: 'string',
+                  },
+                },
+                required: ['short_code'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    client_session: {
+                      $ref: '#/components/schemas/client_session',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['client_session', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ certified_client: [] }],
+        summary: '/seam/instant_key/v1/client_sessions/exchange_short_code',
+        tags: ['/client_sessions'],
+        'x-fern-sdk-group-name': [
+          'seam',
+          'instant_key',
+          'v1',
+          'client_sessions',
+        ],
+        'x-fern-sdk-method-name': 'exchange_short_code',
+        'x-fern-sdk-return-value': 'client_session',
+        'x-response-key': 'client_session',
+        'x-title': 'Exchange Instant Key Short Code',
+      },
+    },
     '/thermostats/activate_climate_preset': {
       post: {
         description:
@@ -30470,21 +30734,6 @@ export default {
                   },
                   {
                     properties: {
-                      desired_access_methods: {
-                        items: {
-                          properties: {
-                            mode: {
-                              description:
-                                'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
-                              enum: ['code', 'card', 'mobile_key'],
-                              type: 'string',
-                            },
-                          },
-                          required: ['mode'],
-                          type: 'object',
-                        },
-                        type: 'array',
-                      },
                       ends_at: {
                         description:
                           'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
@@ -30509,6 +30758,10 @@ export default {
                             items: { format: 'uuid', type: 'string' },
                             type: 'array',
                           },
+                          name: {
+                            description: 'Name of the location.',
+                            type: 'string',
+                          },
                         },
                         type: 'object',
                       },
@@ -30518,6 +30771,21 @@ export default {
                         items: { format: 'uuid', type: 'string' },
                         type: 'array',
                       },
+                      requested_access_methods: {
+                        items: {
+                          properties: {
+                            mode: {
+                              description:
+                                'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+                              enum: ['code', 'card', 'mobile_key'],
+                              type: 'string',
+                            },
+                          },
+                          required: ['mode'],
+                          type: 'object',
+                        },
+                        type: 'array',
+                      },
                       starts_at: {
                         description:
                           'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -30525,7 +30793,7 @@ export default {
                         type: 'string',
                       },
                     },
-                    required: ['desired_access_methods'],
+                    required: ['requested_access_methods'],
                     type: 'object',
                   },
                 ],
@@ -30546,6 +30814,12 @@ export default {
                           format: 'uuid',
                           type: 'string',
                         },
+                        access_method_ids: {
+                          description:
+                            'IDs of the access methods that were created for this access grant.',
+                          items: { format: 'uuid', type: 'string' },
+                          type: 'array',
+                        },
                         created_at: {
                           description:
                             'Date and time at which the access grant was created.',
@@ -30567,6 +30841,12 @@ export default {
                             'Access methods that the user requested for this access grant.',
                           items: {
                             properties: {
+                              created_access_method_ids: {
+                                description:
+                                  'IDs of the access methods that were created for this requested access method.',
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
                               created_at: {
                                 description:
                                   'Date and time at which the requested access method was added to this access grant.',
@@ -30584,18 +30864,12 @@ export default {
                                 enum: ['code', 'card', 'mobile_key'],
                                 type: 'string',
                               },
-                              provisioned_access_method_ids: {
-                                description:
-                                  'IDs of the locations to which access is being given.',
-                                items: { format: 'uuid', type: 'string' },
-                                type: 'array',
-                              },
                             },
                             required: [
                               'display_name',
                               'mode',
                               'created_at',
-                              'provisioned_access_method_ids',
+                              'created_access_method_ids',
                             ],
                             type: 'object',
                             'x-undocumented': 'Unreleased.',
@@ -30621,6 +30895,7 @@ export default {
                         'user_identity_id',
                         'location_ids',
                         'requested_access_methods',
+                        'access_method_ids',
                         'display_name',
                         'created_at',
                       ],
@@ -30688,6 +30963,12 @@ export default {
                           format: 'uuid',
                           type: 'string',
                         },
+                        access_method_ids: {
+                          description:
+                            'IDs of the access methods that were created for this access grant.',
+                          items: { format: 'uuid', type: 'string' },
+                          type: 'array',
+                        },
                         created_at: {
                           description:
                             'Date and time at which the access grant was created.',
@@ -30709,6 +30990,12 @@ export default {
                             'Access methods that the user requested for this access grant.',
                           items: {
                             properties: {
+                              created_access_method_ids: {
+                                description:
+                                  'IDs of the access methods that were created for this requested access method.',
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
                               created_at: {
                                 description:
                                   'Date and time at which the requested access method was added to this access grant.',
@@ -30726,18 +31013,12 @@ export default {
                                 enum: ['code', 'card', 'mobile_key'],
                                 type: 'string',
                               },
-                              provisioned_access_method_ids: {
-                                description:
-                                  'IDs of the locations to which access is being given.',
-                                items: { format: 'uuid', type: 'string' },
-                                type: 'array',
-                              },
                             },
                             required: [
                               'display_name',
                               'mode',
                               'created_at',
-                              'provisioned_access_method_ids',
+                              'created_access_method_ids',
                             ],
                             type: 'object',
                             'x-undocumented': 'Unreleased.',
@@ -30763,6 +31044,7 @@ export default {
                         'user_identity_id',
                         'location_ids',
                         'requested_access_methods',
+                        'access_method_ids',
                         'display_name',
                         'created_at',
                       ],
@@ -30849,6 +31131,12 @@ export default {
                             format: 'uuid',
                             type: 'string',
                           },
+                          access_method_ids: {
+                            description:
+                              'IDs of the access methods that were created for this access grant.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
                           created_at: {
                             description:
                               'Date and time at which the access grant was created.',
@@ -30870,6 +31158,12 @@ export default {
                               'Access methods that the user requested for this access grant.',
                             items: {
                               properties: {
+                                created_access_method_ids: {
+                                  description:
+                                    'IDs of the access methods that were created for this requested access method.',
+                                  items: { format: 'uuid', type: 'string' },
+                                  type: 'array',
+                                },
                                 created_at: {
                                   description:
                                     'Date and time at which the requested access method was added to this access grant.',
@@ -30887,18 +31181,12 @@ export default {
                                   enum: ['code', 'card', 'mobile_key'],
                                   type: 'string',
                                 },
-                                provisioned_access_method_ids: {
-                                  description:
-                                    'IDs of the locations to which access is being given.',
-                                  items: { format: 'uuid', type: 'string' },
-                                  type: 'array',
-                                },
                               },
                               required: [
                                 'display_name',
                                 'mode',
                                 'created_at',
-                                'provisioned_access_method_ids',
+                                'created_access_method_ids',
                               ],
                               type: 'object',
                               'x-undocumented': 'Unreleased.',
@@ -30924,6 +31212,7 @@ export default {
                           'user_identity_id',
                           'location_ids',
                           'requested_access_methods',
+                          'access_method_ids',
                           'display_name',
                           'created_at',
                         ],
@@ -30959,10 +31248,11 @@ export default {
         'x-undocumented': 'Unreleased.',
       },
     },
-    '/unstable_access_grants/list_access_methods': {
+    '/unstable_access_methods/list': {
       post: {
-        description: 'List all access methods for an access grant.',
-        operationId: 'unstableAccessGrantsListAccessMethodsPost',
+        description:
+          'List all access methods, usually filtered by access grant.',
+        operationId: 'unstableAccessMethodsListPost',
         requestBody: {
           content: {
             'application/json': {
@@ -31055,13 +31345,13 @@ export default {
           { console_session_with_workspace: [] },
           { api_key: [] },
         ],
-        summary: '/unstable_access_grants/list_access_methods',
+        summary: '/unstable_access_methods/list',
         tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'list_access_methods',
+        'x-fern-sdk-group-name': ['unstable_access_methods'],
+        'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'access_methods',
         'x-response-key': 'access_methods',
-        'x-title': 'Get the Access Methods for an Access Grant',
+        'x-title': 'List Access Methods',
         'x-undocumented': 'Unreleased.',
       },
     },