@seamapi/types 1.423.4 → 1.425.0

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

@@ -2179,6 +2179,12 @@ export default {
             nullable: true,
             type: 'string',
           },
+          connected_account_id: {
+            description:
+              'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+            format: 'uuid',
+            type: 'string',
+          },
           created_at: {
             description:
               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -2497,6 +2503,7 @@ export default {
         },
         required: [
           'acs_credential_id',
+          'connected_account_id',
           'acs_system_id',
           'display_name',
           'access_method',
@@ -2686,6 +2693,21 @@ export default {
             required: ['door_type', 'door_name'],
             type: 'object',
           },
+          can_unlock_with_card: {
+            description:
+              'Indicates whether the ACS entrance can be unlocked with card credentials.',
+            type: 'boolean',
+          },
+          can_unlock_with_code: {
+            description:
+              'Indicates whether the ACS entrance can be unlocked with pin codes.',
+            type: 'boolean',
+          },
+          can_unlock_with_mobile_key: {
+            description:
+              'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
+            type: 'boolean',
+          },
           connected_account_id: {
             description:
               'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -4531,6 +4553,12 @@ export default {
                             nullable: true,
                             type: 'string',
                           },
+                          connected_account_id: {
+                            description:
+                              'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
                           created_at: {
                             description:
                               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -4877,6 +4905,7 @@ export default {
                         },
                         required: [
                           'acs_credential_id',
+                          'connected_account_id',
                           'acs_system_id',
                           'display_name',
                           'access_method',
@@ -4972,6 +5001,12 @@ export default {
                             nullable: true,
                             type: 'string',
                           },
+                          connected_account_id: {
+                            description:
+                              'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
                           created_at: {
                             description:
                               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -5318,6 +5353,7 @@ export default {
                         },
                         required: [
                           'acs_credential_id',
+                          'connected_account_id',
                           'acs_system_id',
                           'display_name',
                           'access_method',
@@ -5865,6 +5901,12 @@ export default {
                         nullable: true,
                         type: 'string',
                       },
+                      connected_account_id: {
+                        description:
+                          'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       created_at: {
                         description:
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -6209,6 +6251,7 @@ export default {
                     },
                     required: [
                       'acs_credential_id',
+                      'connected_account_id',
                       'acs_system_id',
                       'display_name',
                       'access_method',
@@ -6303,6 +6346,12 @@ export default {
                         nullable: true,
                         type: 'string',
                       },
+                      connected_account_id: {
+                        description:
+                          'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       created_at: {
                         description:
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -6647,6 +6696,7 @@ export default {
                     },
                     required: [
                       'acs_credential_id',
+                      'connected_account_id',
                       'acs_system_id',
                       'display_name',
                       'access_method',
@@ -8714,7 +8764,7 @@ export default {
               'High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.',
             items: {
               description:
-                'High-level device capabilities that the Connect Webview can accept.',
+                '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
               enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
               type: 'string',
             },
@@ -8798,7 +8848,6 @@ export default {
           device_selection_mode: {
             enum: ['none', 'single', 'multiple'],
             type: 'string',
-            'x-undocumented': 'Not implemented.',
           },
           login_successful: {
             description:
@@ -8864,6 +8913,17 @@ export default {
         description:
           'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.',
         properties: {
+          accepted_capabilities: {
+            description:
+              'List of capabilities that were accepted during the account connection process.',
+            items: {
+              description:
+                '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
+              enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
+              type: 'string',
+            },
+            type: 'array',
+          },
           account_type: {
             description: 'Type of connected account.',
             type: 'string',
@@ -9279,6 +9339,7 @@ export default {
           'warnings',
           'custom_metadata',
           'automatically_manage_new_devices',
+          'accepted_capabilities',
         ],
         type: 'object',
         'x-route-path': '/connected_accounts',
@@ -18447,6 +18508,21 @@ export default {
                               required: ['door_type', 'door_name'],
                               type: 'object',
                             },
+                            can_unlock_with_card: {
+                              description:
+                                'Indicates whether the ACS entrance can be unlocked with card credentials.',
+                              type: 'boolean',
+                            },
+                            can_unlock_with_code: {
+                              description:
+                                'Indicates whether the ACS entrance can be unlocked with pin codes.',
+                              type: 'boolean',
+                            },
+                            can_unlock_with_mobile_key: {
+                              description:
+                                'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
+                              type: 'boolean',
+                            },
                             connected_account_id: {
                               description:
                                 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -18733,6 +18809,12 @@ export default {
                         nullable: true,
                         type: 'string',
                       },
+                      connected_account_id: {
+                        description:
+                          'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       created_at: {
                         description:
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -19076,6 +19158,7 @@ export default {
                       },
                     },
                     required: [
+                      'connected_account_id',
                       'acs_system_id',
                       'display_name',
                       'access_method',
@@ -21294,6 +21377,12 @@ export default {
             nullable: true,
             type: 'string',
           },
+          connected_account_id: {
+            description:
+              'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+            format: 'uuid',
+            type: 'string',
+          },
           created_at: {
             description:
               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
@@ -21612,6 +21701,7 @@ export default {
         },
         required: [
           'acs_credential_id',
+          'connected_account_id',
           'acs_system_id',
           'display_name',
           'access_method',
@@ -24119,7 +24209,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['device_id'],
                 type: 'object',
@@ -24258,7 +24352,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['device_ids'],
                 type: 'object',
@@ -24393,7 +24491,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['device_ids'],
                 type: 'object',
@@ -26011,7 +26113,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['access_code_id'],
                 type: 'object',
@@ -26161,7 +26267,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['access_code_id'],
                 type: 'object',
@@ -26311,7 +26421,11 @@ export default {
                       'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
                     type: 'boolean',
                   },
-                  use_offline_access_code: { type: 'boolean' },
+                  use_offline_access_code: {
+                    deprecated: true,
+                    type: 'boolean',
+                    'x-deprecated': 'Use `is_offline_access_code` instead.',
+                  },
                 },
                 required: ['access_code_id'],
                 type: 'object',
@@ -26563,7 +26677,6 @@ export default {
                       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`.',
-                        format: 'date-time',
                         type: 'string',
                       },
                       location: {
@@ -26623,7 +26736,6 @@ export default {
                       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.',
-                        format: 'date-time',
                         type: 'string',
                       },
                     },
@@ -34789,7 +34901,7 @@ export default {
                       'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.',
                     items: {
                       description:
-                        'High-level device capabilities that the Connect Webview can accept.',
+                        '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
                       enum: [
                         'lock',
                         'thermostat',
@@ -37908,6 +38020,16 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -38226,6 +38348,12 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
                       'ID of the space for which you want to list devices.',
@@ -39043,6 +39171,16 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -39358,6 +39496,12 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
                       'ID of the space for which you want to list devices.',
@@ -40977,6 +41121,16 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -41229,6 +41383,12 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
                       'ID of the space for which you want to list devices.',
@@ -41991,6 +42151,16 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -42158,6 +42328,12 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
                       'ID of the space for which you want to list devices.',
@@ -46720,6 +46896,16 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -46908,6 +47094,12 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
                   space_id: {
                     description:
                       'ID of the space for which you want to list devices.',
@@ -51857,6 +52049,15 @@ export default {
           'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
         operationId: 'userIdentitiesListGet',
         parameters: [
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
+              type: 'string',
+            },
+          },
           {
             in: 'query',
             name: 'credential_manager_acs_system_id',
@@ -51919,6 +52120,11 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },