@seamapi/types 1.871.0 → 1.872.0

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

@@ -22,13 +22,28 @@ const common_access_code_error = z.object({
 const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
 
+const provider_issue = common_access_code_error
+  .extend({
+    error_code: z.literal('provider_issue').describe(error_code_description),
+  })
+  .describe(
+    'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
+  )
+
 const smartthings_failed_to_set_access_code_error = common_access_code_error
   .extend({
     error_code: z
       .literal('smartthings_failed_to_set_access_code')
       .describe(error_code_description),
   })
-  .describe('Failed to set code on SmartThings device.')
+  .describe(
+    `
+    ---
+    deprecated: Handled by the generic \`failed_to_set_on_device\` system.
+    ---
+    Failed to set code on SmartThings device.
+    `,
+  )
 
 const smartthings_failed_to_set_after_multiple_retries =
   common_access_code_error
@@ -37,7 +52,14 @@ const smartthings_failed_to_set_after_multiple_retries =
         .literal('smartthings_failed_to_set_after_multiple_retries')
         .describe(error_code_description),
     })
-    .describe('Failed to set code after multiple retries.')
+    .describe(
+      `
+    ---
+    deprecated: Handled by the generic \`failed_to_set_on_device\` system.
+    ---
+    Failed to set code after multiple retries.
+    `,
+    )
 
 const modified_field = z.object({
   field: z
@@ -172,7 +194,12 @@ const kwikset_insufficient_permissions = common_access_code_error
       .describe(error_code_description),
   })
   .describe(
-    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.
+    `,
   )
 
 const august_lock_invalid_code_length = common_access_code_error
@@ -181,7 +208,14 @@ const august_lock_invalid_code_length = common_access_code_error
       .literal('august_lock_invalid_code_length')
       .describe(error_code_description),
   })
-  .describe('Invalid code length for August lock.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Invalid code length for August lock.
+    `,
+  )
 
 const august_lock_temporarily_offline_error = common_access_code_error
   .extend({
@@ -189,7 +223,14 @@ const august_lock_temporarily_offline_error = common_access_code_error
       .literal('august_lock_temporarily_offline')
       .describe(error_code_description),
   })
-  .describe('August lock is temporarily offline.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is temporarily offline.
+    `,
+  )
 
 const august_lock_missing_keypad = common_access_code_error
   .extend({
@@ -197,7 +238,24 @@ const august_lock_missing_keypad = common_access_code_error
       .literal('august_lock_missing_keypad')
       .describe(error_code_description),
   })
-  .describe('August lock is missing a keypad.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is missing a keypad.
+    `,
+  )
+
+const access_code_inactive_error = common_access_code_error
+  .extend({
+    error_code: z
+      .literal('access_code_inactive')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
+  )
 
 const salto_ks_user_not_subscribed = common_access_code_error
   .extend({
@@ -205,7 +263,14 @@ const salto_ks_user_not_subscribed = common_access_code_error
       .literal('salto_ks_user_not_subscribed')
       .describe(error_code_description),
   })
-  .describe('Salto site user is not subscribed.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`access_code_inactive\` instead.
+    ---
+    Salto site user is not subscribed.
+    `,
+  )
 
 const wyze_duplicate_code_name = common_access_code_error
   .extend({
@@ -244,7 +309,12 @@ const dormakaba_oracode_invalid_time_range = common_access_code_error
       .describe(error_code_description),
   })
   .describe(
-    'No Dormakaba Oracode user levels configured for the requested time range.',
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    No Dormakaba Oracode user levels configured for the requested time range.
+    `,
   )
 
 const keynest_unsupported_third_party_locker = common_access_code_error
@@ -253,7 +323,14 @@ const keynest_unsupported_third_party_locker = common_access_code_error
       .literal('keynest_unsupported_third_party_locker')
       .describe(error_code_description),
   })
-  .describe('KeyNest locker is not supported.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    KeyNest locker is not supported.
+    `,
+  )
 
 const replaced_by_newer_access_code = common_access_code_error
   .extend({
@@ -267,6 +344,7 @@ const replaced_by_newer_access_code = common_access_code_error
 
 const access_code_error = z
   .discriminatedUnion('error_code', [
+    provider_issue,
     smartthings_failed_to_set_access_code_error,
     smartthings_failed_to_set_after_multiple_retries,
     failed_to_set_on_device,
@@ -282,6 +360,7 @@ const access_code_error = z
     august_lock_invalid_code_length,
     august_lock_missing_keypad,
     august_lock_temporarily_offline_error,
+    access_code_inactive_error,
     salto_ks_user_not_subscribed,
     wyze_duplicate_code_name,
     wyze_potential_duplicate_code,
@@ -297,6 +376,7 @@ const access_code_error = z
 export type AccessCodeError = z.infer<typeof access_code_error>
 
 const _access_code_error_map = z.object({
+  provider_issue: provider_issue.optional().nullable(),
   smartthings_failed_to_set_access_code:
     smartthings_failed_to_set_access_code_error.optional().nullable(),
   smartthings_failed_to_set_after_multiple_retries:
@@ -334,6 +414,7 @@ const _access_code_error_map = z.object({
     .optional()
     .nullable(),
   august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(),
+  access_code_inactive: access_code_inactive_error.optional().nullable(),
   salto_ks_user_not_subscribed: salto_ks_user_not_subscribed
     .optional()
     .nullable(),
@@ -423,13 +504,30 @@ const schlage_detected_duplicate = common_access_code_warning
     `,
   )
 
+const provider_issue_warning = common_access_code_warning
+  .extend({
+    warning_code: z
+      .literal('provider_issue')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
+  )
+
 const schlage_creation_outage = common_access_code_warning
   .extend({
     warning_code: z
       .literal('schlage_creation_outage')
       .describe(warning_code_description),
   })
-  .describe('Received an error when attempting to create this code.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Received an error when attempting to create this code.
+    `,
+  )
 
 const schlage_access_code_ambiguous_timezone_dst_risk =
   common_access_code_warning
@@ -535,6 +633,7 @@ const being_deleted = common_access_code_warning
 
 const access_code_warning = z
   .discriminatedUnion('warning_code', [
+    provider_issue_warning,
     smartthings_failed_to_set_access_code_warning,
     schlage_detected_duplicate,
     schlage_creation_outage,
@@ -559,6 +658,7 @@ const access_code_warning = z
 export type AccessCodeWarning = z.infer<typeof access_code_warning>
 
 const _access_code_warning_map = z.object({
+  provider_issue: provider_issue_warning.optional().nullable(),
   smartthings_failed_to_set_access_code:
     smartthings_failed_to_set_access_code_warning.optional().nullable(),
   schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),

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

@@ -105,6 +105,38 @@ const openapi: OpenAPISpec = {
               discriminator: { propertyName: 'error_code' },
               oneOf: [
                 {
+                  description:
+                    'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
+                  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: ['provider_issue'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      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'],
+                  type: 'object',
+                },
+                {
+                  deprecated: true,
                   description: 'Failed to set code on SmartThings device.',
                   properties: {
                     created_at: {
@@ -133,8 +165,11 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Handled by the generic `failed_to_set_on_device` system.',
                 },
                 {
+                  deprecated: true,
                   description: 'Failed to set code after multiple retries.',
                   properties: {
                     created_at: {
@@ -165,6 +200,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Handled by the generic `failed_to_set_on_device` system.',
                 },
                 {
                   description: 'Failed to set code on device.',
@@ -492,6 +529,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Invalid code length for August lock.',
                   properties: {
                     created_at: {
@@ -520,8 +558,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'August lock is missing a keypad.',
                   properties: {
                     created_at: {
@@ -550,8 +590,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'August lock is temporarily offline.',
                   properties: {
                     created_at: {
@@ -580,8 +622,41 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
+                },
+                {
+                  description:
+                    'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
+                  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: ['access_code_inactive'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      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'],
+                  type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Salto site user is not subscribed.',
                   properties: {
                     created_at: {
@@ -610,6 +685,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `access_code_inactive` instead.',
                 },
                 {
                   deprecated: true,
@@ -676,6 +752,7 @@ const openapi: OpenAPISpec = {
                   'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'No Dormakaba Oracode user levels configured for the requested time range.',
                   properties: {
@@ -705,8 +782,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
                   properties: {
@@ -736,8 +815,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'KeyNest locker is not supported.',
                   properties: {
                     created_at: {
@@ -766,6 +847,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   description:
@@ -1719,6 +1801,31 @@ const openapi: OpenAPISpec = {
                 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
               discriminator: { propertyName: 'warning_code' },
               oneOf: [
+                {
+                  description:
+                    'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
+                  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: ['provider_issue'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'warning_code'],
+                  type: 'object',
+                },
                 {
                   description: 'Failed to set code on SmartThings device.',
                   properties: {
@@ -1771,6 +1878,7 @@ const openapi: OpenAPISpec = {
                     'Use `duplicate_code_on_device` error instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Received an error when attempting to create this code.',
                   properties: {
@@ -1794,6 +1902,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   description:
@@ -27478,6 +27587,38 @@ const openapi: OpenAPISpec = {
               discriminator: { propertyName: 'error_code' },
               oneOf: [
                 {
+                  description:
+                    'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
+                  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: ['provider_issue'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      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'],
+                  type: 'object',
+                },
+                {
+                  deprecated: true,
                   description: 'Failed to set code on SmartThings device.',
                   properties: {
                     created_at: {
@@ -27506,8 +27647,11 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Handled by the generic `failed_to_set_on_device` system.',
                 },
                 {
+                  deprecated: true,
                   description: 'Failed to set code after multiple retries.',
                   properties: {
                     created_at: {
@@ -27538,6 +27682,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Handled by the generic `failed_to_set_on_device` system.',
                 },
                 {
                   description: 'Failed to set code on device.',
@@ -27865,6 +28011,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Invalid code length for August lock.',
                   properties: {
                     created_at: {
@@ -27893,8 +28040,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'August lock is missing a keypad.',
                   properties: {
                     created_at: {
@@ -27923,8 +28072,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'August lock is temporarily offline.',
                   properties: {
                     created_at: {
@@ -27953,8 +28104,41 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
+                },
+                {
+                  description:
+                    'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
+                  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: ['access_code_inactive'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      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'],
+                  type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Salto site user is not subscribed.',
                   properties: {
                     created_at: {
@@ -27983,6 +28167,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `access_code_inactive` instead.',
                 },
                 {
                   deprecated: true,
@@ -28049,6 +28234,7 @@ const openapi: OpenAPISpec = {
                   'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'No Dormakaba Oracode user levels configured for the requested time range.',
                   properties: {
@@ -28078,8 +28264,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
                   properties: {
@@ -28109,8 +28297,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'KeyNest locker is not supported.',
                   properties: {
                     created_at: {
@@ -28139,6 +28329,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   description:
@@ -28781,6 +28972,31 @@ const openapi: OpenAPISpec = {
                 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
               discriminator: { propertyName: 'warning_code' },
               oneOf: [
+                {
+                  description:
+                    'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
+                  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: ['provider_issue'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'warning_code'],
+                  type: 'object',
+                },
                 {
                   description: 'Failed to set code on SmartThings device.',
                   properties: {
@@ -28833,6 +29049,7 @@ const openapi: OpenAPISpec = {
                     'Use `duplicate_code_on_device` error instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Received an error when attempting to create this code.',
                   properties: {
@@ -28856,6 +29073,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   description: