@seamapi/types 1.50.0 → 1.52.0

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

@@ -490,6 +490,8 @@ export default {
       device: {
         properties: {
           capabilities_supported: {
+            description:
+              'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
             items: {
               enum: [
                 'access_code',
@@ -502,10 +504,25 @@ export default {
             },
             type: 'array',
           },
-          connected_account_id: { format: 'uuid', type: 'string' },
-          created_at: { format: 'date-time', type: 'string' },
-          device_id: { format: 'uuid', type: 'string' },
+          connected_account_id: {
+            description:
+              'Unique identifier for the account associated with the device.',
+            format: 'uuid',
+            type: 'string',
+          },
+          created_at: {
+            description:
+              'Date and time at which the device object was created.',
+            format: 'date-time',
+            type: 'string',
+          },
+          device_id: {
+            description: 'Unique identifier for the device.',
+            format: 'uuid',
+            type: 'string',
+          },
           device_type: {
+            description: 'Type of the device.',
             oneOf: [
               {
                 enum: [
@@ -548,6 +565,8 @@ export default {
             ],
           },
           errors: {
+            description:
+              'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
             items: {
               properties: {
                 error_code: { type: 'string' },
@@ -558,12 +577,23 @@ export default {
             },
             type: 'array',
           },
-          is_managed: { enum: [true], type: 'boolean' },
+          is_managed: {
+            description: 'Indicates whether Seam manages the device.',
+            enum: [true],
+            type: 'boolean',
+          },
           location: {
+            description: 'Location information for the device.',
             nullable: true,
             properties: {
-              location_name: { type: 'string' },
-              timezone: { type: 'string' },
+              location_name: {
+                description: 'Name of the device location.',
+                type: 'string',
+              },
+              timezone: {
+                description: 'Time zone of the device location.',
+                type: 'string',
+              },
             },
             type: 'object',
           },
@@ -574,6 +604,8 @@ export default {
                   {
                     properties: {
                       battery: {
+                        description:
+                          'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
                         properties: {
                           level: { maximum: 1, minimum: 0, type: 'number' },
                           status: {
@@ -584,43 +616,92 @@ export default {
                         required: ['level', 'status'],
                         type: 'object',
                       },
-                      battery_level: { maximum: 1, minimum: 0, type: 'number' },
-                      has_direct_power: { type: 'boolean' },
-                      image_alt_text: { type: 'string' },
-                      image_url: { format: 'uri', type: 'string' },
-                      manufacturer: { type: 'string' },
+                      battery_level: {
+                        description:
+                          'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
+                        maximum: 1,
+                        minimum: 0,
+                        type: 'number',
+                      },
+                      has_direct_power: {
+                        description:
+                          'Indicates whether the device has direct power.',
+                        type: 'boolean',
+                      },
+                      image_alt_text: {
+                        description: 'Alt text for the device image.',
+                        type: 'string',
+                      },
+                      image_url: {
+                        description: 'Image URL for the device.',
+                        format: 'uri',
+                        type: 'string',
+                      },
+                      manufacturer: {
+                        description: 'Manufacturer of the device.',
+                        type: 'string',
+                      },
                       model: {
                         properties: {
-                          accessory_keypad_supported: { type: 'boolean' },
-                          display_name: { type: 'string' },
-                          manufacturer_display_name: { type: 'string' },
-                          offline_access_codes_supported: { type: 'boolean' },
-                          online_access_codes_supported: { type: 'boolean' },
+                          accessory_keypad_supported: {
+                            description:
+                              'Indicates whether the device supports an accessory keypad.',
+                            type: 'boolean',
+                          },
+                          display_name: {
+                            description: 'Display name of the device model.',
+                            type: 'string',
+                          },
+                          manufacturer_display_name: {
+                            description:
+                              'Display name that corresponds to the manufacturer-specific terminology for the device.',
+                            type: 'string',
+                          },
+                          offline_access_codes_supported: {
+                            description:
+                              'Indicates whether the device supports offline access codes.',
+                            type: 'boolean',
+                          },
+                          online_access_codes_supported: {
+                            description:
+                              'Indicates whether the device supports online access codes.',
+                            type: 'boolean',
+                          },
                         },
                         required: ['display_name', 'manufacturer_display_name'],
                         type: 'object',
                       },
-                      name: { type: 'string' },
+                      name: {
+                        description:
+                          'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                        type: 'string',
+                      },
                       offline_access_codes_enabled: {
                         description:
-                          'Currently possible to use offline access codes',
+                          'Indicates whether it is currently possible to use offline access codes for the device.',
+                        type: 'boolean',
+                      },
+                      online: {
+                        description: 'Indicates whether the device is online.',
                         type: 'boolean',
                       },
-                      online: { type: 'boolean' },
                       online_access_codes_enabled: {
                         description:
-                          'Currently possible to use online access codes',
+                          'Indicates whether it is currently possible to use online access codes for the device.',
                         type: 'boolean',
                       },
-                      serial_number: { type: 'string' },
+                      serial_number: {
+                        description: 'Serial number of the device.',
+                        type: 'string',
+                      },
                       supports_accessory_keypad: {
                         description:
-                          'Deprecated: use model.offline_access_codes_enabled.',
+                          'Deprecated: Use model.offline_access_codes_enabled.',
                         type: 'boolean',
                       },
                       supports_offline_access_codes: {
                         description:
-                          'Deprecated: use model.accessory_keypad_supported.',
+                          'Deprecated: Use model.accessory_keypad_supported.',
                         type: 'boolean',
                       },
                     },
@@ -1433,8 +1514,11 @@ export default {
                 ],
               },
             ],
+            description: 'Properties of the device.',
           },
           warnings: {
+            description:
+              'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
             items: {
               properties: {
                 message: { type: 'string' },
@@ -1445,7 +1529,12 @@ export default {
             },
             type: 'array',
           },
-          workspace_id: { format: 'uuid', type: 'string' },
+          workspace_id: {
+            description:
+              'Unique identifier for the Seam workspace associated with the device.',
+            format: 'uuid',
+            type: 'string',
+          },
         },
         required: [
           'device_id',
@@ -1605,6 +1694,8 @@ export default {
       unmanaged_device: {
         properties: {
           capabilities_supported: {
+            description:
+              'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
             items: {
               enum: [
                 'access_code',
@@ -1617,10 +1708,25 @@ export default {
             },
             type: 'array',
           },
-          connected_account_id: { format: 'uuid', type: 'string' },
-          created_at: { format: 'date-time', type: 'string' },
-          device_id: { format: 'uuid', type: 'string' },
+          connected_account_id: {
+            description:
+              'Unique identifier for the account associated with the device.',
+            format: 'uuid',
+            type: 'string',
+          },
+          created_at: {
+            description:
+              'Date and time at which the device object was created.',
+            format: 'date-time',
+            type: 'string',
+          },
+          device_id: {
+            description: 'Unique identifier for the device.',
+            format: 'uuid',
+            type: 'string',
+          },
           device_type: {
+            description: 'Type of the device.',
             oneOf: [
               {
                 enum: [
@@ -1663,6 +1769,8 @@ export default {
             ],
           },
           errors: {
+            description:
+              'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
             items: {
               properties: {
                 error_code: { type: 'string' },
@@ -1694,6 +1802,8 @@ export default {
             type: 'object',
           },
           warnings: {
+            description:
+              'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
             items: {
               properties: {
                 message: { type: 'string' },
@@ -1704,7 +1814,12 @@ export default {
             },
             type: 'array',
           },
-          workspace_id: { format: 'uuid', type: 'string' },
+          workspace_id: {
+            description:
+              'Unique identifier for the Seam workspace associated with the device.',
+            format: 'uuid',
+            type: 'string',
+          },
         },
         required: [
           'device_id',
@@ -1763,6 +1878,16 @@ export default {
         name: 'client-session-token',
         type: 'apiKey',
       },
+      console_session: {
+        bearerFormat: 'Console Session Token',
+        scheme: 'bearer',
+        type: 'http',
+      },
+      pat_with_workspace: {
+        bearerFormat: 'API Token',
+        scheme: 'bearer',
+        type: 'http',
+      },
       seam_client_session_token: {
         in: 'header',
         name: 'seam-client-session-token',
@@ -3934,6 +4059,86 @@ export default {
         'x-fern-sdk-method-name': 'unassign',
       },
     },
+    '/acs/credentials/update': {
+      post: {
+        operationId: 'acsCredentialsUpdatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  code: { pattern: '^\\d+$', type: 'string' },
+                  name: { maxLength: 10, type: 'string' },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    acs_credential: {
+                      properties: {
+                        acs_credential_id: { format: 'uuid', type: 'string' },
+                        acs_credential_pool_id: {
+                          format: 'uuid',
+                          type: 'string',
+                        },
+                        acs_system_id: { format: 'uuid', type: 'string' },
+                        acs_user_id: { format: 'uuid', type: 'string' },
+                        code: { nullable: true, type: 'string' },
+                        created_at: { format: 'date-time', type: 'string' },
+                        display_name: { minLength: 1, type: 'string' },
+                        external_type: {
+                          enum: [
+                            'pti_card',
+                            'brivo_credential',
+                            'hid_credential',
+                          ],
+                          type: 'string',
+                        },
+                        external_type_display_name: { type: 'string' },
+                        workspace_id: { format: 'uuid', type: 'string' },
+                      },
+                      required: [
+                        'acs_credential_id',
+                        'acs_system_id',
+                        'display_name',
+                        'code',
+                        'external_type',
+                        'external_type_display_name',
+                        'created_at',
+                        'workspace_id',
+                      ],
+                      type: 'object',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['acs_credential', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { access_token: [], seam_workspace: [] },
+          { seam_client_session_token: [] },
+          { client_session_token: [] },
+        ],
+        summary: '/acs/credentials/update',
+        tags: [],
+        'x-fern-sdk-group-name': ['acs', 'credentials'],
+        'x-fern-sdk-method-name': 'update',
+      },
+    },
     '/acs/entrances/get': {
       post: {
         operationId: 'acsEntrancesGetPost',
@@ -4921,9 +5126,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { access_token: [], seam_workspace: [] },
-          { seam_client_session_token: [] },
-          { client_session_token: [] },
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/client_sessions/get',
         tags: ['/client_sessions'],
@@ -5302,6 +5508,7 @@ export default {
                         'pti',
                         'wyze',
                         'seam_passport',
+                        'visionline',
                         'yale_access',
                         'hid_cm',
                       ],
@@ -8758,6 +8965,8 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  first_name: { nullable: true, type: 'string' },
+                  last_name: { nullable: true, type: 'string' },
                   user_identity_key: { nullable: true, type: 'string' },
                 },
                 type: 'object',
@@ -8780,6 +8989,8 @@ export default {
                           nullable: true,
                           type: 'string',
                         },
+                        first_name: { nullable: true, type: 'string' },
+                        last_name: { nullable: true, type: 'string' },
                         user_identity_id: { format: 'uuid', type: 'string' },
                         user_identity_key: { nullable: true, type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
@@ -8853,6 +9064,8 @@ export default {
                           nullable: true,
                           type: 'string',
                         },
+                        first_name: { nullable: true, type: 'string' },
+                        last_name: { nullable: true, type: 'string' },
                         user_identity_id: { format: 'uuid', type: 'string' },
                         user_identity_key: { nullable: true, type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },