@seamapi/types 1.989.0 → 1.991.0

package/package.json

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -124,17 +124,6 @@ const no_space_for_access_code_on_device = common_access_code_error.extend({
     No space for access code on device.
     `)
 
-const insufficient_permissions = common_access_code_error.extend({
-  error_code: z
-    .literal('insufficient_permissions')
-    .describe(error_code_description),
-}).describe(`
-    ---
-    resource_type: access_code
-    ---
-    Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.
-    `)
-
 const access_code_inactive_error = common_access_code_error.extend({
   error_code: z
     .literal('access_code_inactive')
@@ -155,7 +144,6 @@ const access_code_error = z
     no_space_for_access_code_on_device,
     conflicting_external_modification_error,
     access_code_inactive_error,
-    insufficient_permissions,
   ])
   .describe(
     'Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
@@ -173,7 +161,6 @@ const _access_code_error_map = z.object({
     .optional()
     .nullable(),
   duplicate_code_on_device: duplicate_code_on_device.optional().nullable(),
-  insufficient_permissions: insufficient_permissions.optional().nullable(),
   conflicting_external_modification: conflicting_external_modification_error
     .optional()
     .nullable(),

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -150,12 +150,24 @@ const provider_service_unavailable = common_acs_system_error.extend({
     Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.
     `)
 
+const insufficient_permissions = common_acs_system_error.extend({
+  error_code: z
+    .literal('insufficient_permissions')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://docs.seam.co/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
+    `)
+
 const acs_system_error = z
   .discriminatedUnion('error_code', [
     seam_bridge_disconnected,
     bridge_disconnected,
     visionline_instance_unreachable,
     salto_ks_subscription_limit_exceeded,
+    insufficient_permissions,
     acs_system_disconnected,
     account_disconnected,
     salto_ks_certification_expired,
@@ -174,6 +186,7 @@ const _acs_system_error_map = z.object({
   salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded
     .optional()
     .nullable(),
+  insufficient_permissions: insufficient_permissions.optional().nullable(),
   acs_system_disconnected: acs_system_disconnected.optional().nullable(),
   account_disconnected: account_disconnected.optional().nullable(),
   salto_ks_certification_expired: salto_ks_certification_expired

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

@@ -285,10 +285,30 @@ const subscription_required = common_device_error.extend({
     Indicates that a subscription is required to connect.
     `)
 
+const insufficient_permissions = common_device_error.extend({
+  error_code: z
+    .literal('insufficient_permissions')
+    .describe(error_code_description),
+  is_connected_account_error: z
+    .literal(true)
+    .describe(
+      'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
+    ),
+  is_device_error: z
+    .literal(false)
+    .describe('Indicates that the error is not a device error.'),
+}).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
+    `)
+
 export const device_error = z
   .discriminatedUnion('error_code', [
     account_disconnected,
     salto_ks_subscription_limit_exceeded,
+    insufficient_permissions,
     dormakaba_sites_disconnected,
     device_offline,
     device_removed,
@@ -317,6 +337,7 @@ export const device_error_map = z.object({
   salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded
     .optional()
     .nullable(),
+  insufficient_permissions: insufficient_permissions.optional().nullable(),
   dormakaba_sites_disconnected: dormakaba_sites_disconnected
     .optional()
     .nullable(),
@@ -636,17 +657,6 @@ const max_access_codes_reached = common_device_warning.extend({
     Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
     `)
 
-const insufficient_permissions = common_device_warning.extend({
-  warning_code: z
-    .literal('insufficient_permissions')
-    .describe(warning_code_description),
-}).describe(`
-    ---
-    variant_group_key: locks
-    ---
-    Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.
-    `)
-
 const device_warning = z.discriminatedUnion('warning_code', [
   partial_backup_access_code_pool,
   many_active_backup_codes,
@@ -675,7 +685,6 @@ const device_warning = z.discriminatedUnion('warning_code', [
   accessory_keypad_setup_required,
   unreliable_online_status,
   max_access_codes_reached,
-  insufficient_permissions,
 ])
 
 export type DeviceWarning = z.infer<typeof device_warning>
@@ -734,7 +743,6 @@ export const device_warning_map = z.object({
     .nullable(),
   unreliable_online_status: unreliable_online_status.optional().nullable(),
   max_access_codes_reached: max_access_codes_reached.optional().nullable(),
-  insufficient_permissions: insufficient_permissions.optional().nullable(),
 })
 
 export type DeviceWarningMap = z.infer<typeof device_warning_map>

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

@@ -368,8 +368,7 @@ const openapi: OpenAPISpec = {
                   'x-resource-type': 'access_code',
                 },
                 {
-                  description:
-                    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
+                  description: 'Indicates that the account is disconnected.',
                   properties: {
                     created_at: {
                       description:
@@ -380,27 +379,40 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['insufficient_permissions'],
+                      enum: ['account_disconnected'],
                       type: 'string',
                     },
-                    is_access_code_error: {
+                    is_connected_account_error: {
                       description:
-                        'Indicates that this is an access code error.',
+                        'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
                       enum: [true],
                       type: 'boolean',
                     },
+                    is_device_error: {
+                      description:
+                        'Indicates that the error is not a device error.',
+                      enum: [false],
+                      type: 'boolean',
+                    },
                     message: {
                       description:
                         'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
                   },
-                  required: ['message', 'is_access_code_error', 'error_code'],
+                  required: [
+                    'message',
+                    'is_device_error',
+                    'created_at',
+                    'error_code',
+                    'is_connected_account_error',
+                  ],
                   type: 'object',
-                  'x-resource-type': 'access_code',
+                  'x-resource-type': 'connected_account',
                 },
                 {
-                  description: 'Indicates that the account is disconnected.',
+                  description:
+                    'Indicates that the Salto site user limit has been reached.',
                   properties: {
                     created_at: {
                       description:
@@ -411,7 +423,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['account_disconnected'],
+                      enum: ['salto_ks_subscription_limit_exceeded'],
                       type: 'string',
                     },
                     is_connected_account_error: {
@@ -441,10 +453,11 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                   'x-resource-type': 'connected_account',
+                  'x-variant-group-key': 'locks',
                 },
                 {
                   description:
-                    'Indicates that the Salto site user limit has been reached.',
+                    "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
                   properties: {
                     created_at: {
                       description:
@@ -455,7 +468,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      enum: ['insufficient_permissions'],
                       type: 'string',
                     },
                     is_connected_account_error: {
@@ -485,7 +498,6 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                   'x-resource-type': 'connected_account',
-                  'x-variant-group-key': 'locks',
                 },
                 {
                   description:
@@ -4576,6 +4588,32 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-resource-type': 'acs_system',
                 },
+                {
+                  description:
+                    "Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://docs.seam.co/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['insufficient_permissions'],
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                  'x-resource-type': 'acs_system',
+                },
                 {
                   description:
                     'Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.',
@@ -13270,6 +13308,50 @@ const openapi: OpenAPISpec = {
                   'x-resource-type': 'connected_account',
                   'x-variant-group-key': 'locks',
                 },
+                {
+                  description:
+                    "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['insufficient_permissions'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      description:
+                        'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    is_device_error: {
+                      description:
+                        'Indicates that the error is not a device error.',
+                      enum: [false],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'message',
+                    'is_device_error',
+                    'created_at',
+                    'error_code',
+                    'is_connected_account_error',
+                  ],
+                  type: 'object',
+                  'x-resource-type': 'connected_account',
+                },
                 {
                   description:
                     'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
@@ -17268,32 +17350,6 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-variant-group-key': 'access_codes',
                 },
-                {
-                  description:
-                    "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
-                  properties: {
-                    created_at: {
-                      description:
-                        'Date and time at which Seam created the warning.',
-                      format: 'date-time',
-                      type: 'string',
-                    },
-                    message: {
-                      description:
-                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
-                      type: 'string',
-                    },
-                    warning_code: {
-                      description:
-                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['insufficient_permissions'],
-                      type: 'string',
-                    },
-                  },
-                  required: ['message', 'created_at', 'warning_code'],
-                  type: 'object',
-                  'x-variant-group-key': 'locks',
-                },
               ],
             },
             type: 'array',
@@ -30047,8 +30103,7 @@ const openapi: OpenAPISpec = {
                   'x-resource-type': 'access_code',
                 },
                 {
-                  description:
-                    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
+                  description: 'Indicates that the account is disconnected.',
                   properties: {
                     created_at: {
                       description:
@@ -30059,27 +30114,40 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['insufficient_permissions'],
+                      enum: ['account_disconnected'],
                       type: 'string',
                     },
-                    is_access_code_error: {
+                    is_connected_account_error: {
                       description:
-                        'Indicates that this is an access code error.',
+                        'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
                       enum: [true],
                       type: 'boolean',
                     },
+                    is_device_error: {
+                      description:
+                        'Indicates that the error is not a device error.',
+                      enum: [false],
+                      type: 'boolean',
+                    },
                     message: {
                       description:
                         'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
                   },
-                  required: ['message', 'is_access_code_error', 'error_code'],
+                  required: [
+                    'message',
+                    'is_device_error',
+                    'created_at',
+                    'error_code',
+                    'is_connected_account_error',
+                  ],
                   type: 'object',
-                  'x-resource-type': 'access_code',
+                  'x-resource-type': 'connected_account',
                 },
                 {
-                  description: 'Indicates that the account is disconnected.',
+                  description:
+                    'Indicates that the Salto site user limit has been reached.',
                   properties: {
                     created_at: {
                       description:
@@ -30090,7 +30158,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['account_disconnected'],
+                      enum: ['salto_ks_subscription_limit_exceeded'],
                       type: 'string',
                     },
                     is_connected_account_error: {
@@ -30120,10 +30188,11 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                   'x-resource-type': 'connected_account',
+                  'x-variant-group-key': 'locks',
                 },
                 {
                   description:
-                    'Indicates that the Salto site user limit has been reached.',
+                    "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
                   properties: {
                     created_at: {
                       description:
@@ -30134,7 +30203,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      enum: ['insufficient_permissions'],
                       type: 'string',
                     },
                     is_connected_account_error: {
@@ -30164,7 +30233,6 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                   'x-resource-type': 'connected_account',
-                  'x-variant-group-key': 'locks',
                 },
                 {
                   description:
@@ -34241,6 +34309,50 @@ const openapi: OpenAPISpec = {
                   'x-resource-type': 'connected_account',
                   'x-variant-group-key': 'locks',
                 },
+                {
+                  description:
+                    "Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['insufficient_permissions'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      description:
+                        'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    is_device_error: {
+                      description:
+                        'Indicates that the error is not a device error.',
+                      enum: [false],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'message',
+                    'is_device_error',
+                    'created_at',
+                    'error_code',
+                    'is_connected_account_error',
+                  ],
+                  type: 'object',
+                  'x-resource-type': 'connected_account',
+                },
                 {
                   description:
                     'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
@@ -35581,32 +35693,6 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-variant-group-key': 'access_codes',
                 },
-                {
-                  description:
-                    "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
-                  properties: {
-                    created_at: {
-                      description:
-                        'Date and time at which Seam created the warning.',
-                      format: 'date-time',
-                      type: 'string',
-                    },
-                    message: {
-                      description:
-                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
-                      type: 'string',
-                    },
-                    warning_code: {
-                      description:
-                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['insufficient_permissions'],
-                      type: 'string',
-                    },
-                  },
-                  required: ['message', 'created_at', 'warning_code'],
-                  type: 'object',
-                  'x-variant-group-key': 'locks',
-                },
               ],
             },
             type: 'array',