@seamapi/types 1.869.0 → 1.871.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.869.0",
+  "version": "1.871.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

@@ -39,11 +39,33 @@ const smartthings_failed_to_set_after_multiple_retries =
     })
     .describe('Failed to set code after multiple retries.')
 
+const modified_field = z.object({
+  field: z
+    .string()
+    .describe(
+      'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+    ),
+  from: z.string().nullable().describe('The previous value of the field.'),
+  to: z.string().nullable().describe('The new value of the field.'),
+})
+
 const code_modified_external_to_seam_error = common_access_code_error
   .extend({
     error_code: z
       .literal('code_modified_external_to_seam')
       .describe(error_code_description),
+    change_type: z
+      .enum(['modified', 'removed'])
+      .optional()
+      .describe(
+        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+      ),
+    modified_fields: z
+      .array(modified_field)
+      .optional()
+      .describe(
+        'List of fields that were changed externally, with their previous and new values.',
+      ),
   })
   .describe(
     'Code was modified or removed externally after Seam successfully set it on the device.',
@@ -103,13 +125,30 @@ const no_space_for_access_code_on_device = common_access_code_error
   })
   .describe('No space for access code on device.')
 
+const access_code_state_unconfirmed = common_access_code_error
+  .extend({
+    error_code: z
+      .literal('access_code_state_unconfirmed')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
+  )
+
 const kwikset_unable_to_confirm_code = common_access_code_error
   .extend({
     error_code: z
       .literal('kwikset_unable_to_confirm_code')
       .describe(error_code_description),
   })
-  .describe('Unable to confirm that the access code is set on Kwikset device.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`access_code_state_unconfirmed\` instead.
+    ---
+    Unable to confirm that the access code is set on Kwikset device.
+    `,
+  )
 
 const kwikset_unable_to_confirm_deletion = common_access_code_error
   .extend({
@@ -118,7 +157,12 @@ const kwikset_unable_to_confirm_deletion = common_access_code_error
       .describe(error_code_description),
   })
   .describe(
-    'Unable to confirm the deletion of the access code on Kwikset device.',
+    `
+    ---
+    deprecated: Use \`access_code_state_unconfirmed\` instead.
+    ---
+    Unable to confirm the deletion of the access code on Kwikset device.
+    `,
   )
 
 const kwikset_insufficient_permissions = common_access_code_error
@@ -230,6 +274,7 @@ const access_code_error = z
     duplicate_code_on_device,
     duplicate_code_attempt_prevented,
     no_space_for_access_code_on_device,
+    access_code_state_unconfirmed,
     kwikset_unable_to_confirm_code,
 
     kwikset_unable_to_confirm_deletion,
@@ -267,6 +312,9 @@ const _access_code_error_map = z.object({
   duplicate_code_attempt_prevented: duplicate_code_attempt_prevented
     .optional()
     .nullable(),
+  access_code_state_unconfirmed: access_code_state_unconfirmed
+    .optional()
+    .nullable(),
   kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code
     .optional()
     .nullable(),
@@ -343,6 +391,18 @@ const code_modified_external_to_seam_warning = common_access_code_warning
     warning_code: z
       .literal('code_modified_external_to_seam')
       .describe(warning_code_description),
+    change_type: z
+      .enum(['modified', 'removed'])
+      .optional()
+      .describe(
+        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+      ),
+    modified_fields: z
+      .array(modified_field)
+      .optional()
+      .describe(
+        'List of fields that were changed externally, with their previous and new values.',
+      ),
   })
   .describe(
     'Code was modified or removed externally after Seam successfully set it on the device.',
@@ -432,6 +492,16 @@ const kwikset_unable_to_confirm_code_warning = common_access_code_warning
   })
   .describe('Unable to confirm that the access code is set on Kwikset device.')
 
+const access_code_inactive = common_access_code_warning
+  .extend({
+    warning_code: z
+      .literal('access_code_inactive')
+      .describe(warning_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 ultraloq_access_code_disabled = common_access_code_warning
   .extend({
     warning_code: z
@@ -439,7 +509,12 @@ const ultraloq_access_code_disabled = common_access_code_warning
       .describe(warning_code_description),
   })
   .describe(
-    'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
+    `
+    ---
+    deprecated: Use \`access_code_inactive\` instead.
+    ---
+    Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.
+    `,
   )
 
 const using_backup_access_code = common_access_code_warning
@@ -472,6 +547,7 @@ const access_code_warning = z
     igloo_algopin_must_be_used_within_24_hours,
     management_transferred,
     kwikset_unable_to_confirm_code_warning,
+    access_code_inactive,
     ultraloq_access_code_disabled,
     using_backup_access_code,
     being_deleted,
@@ -508,6 +584,7 @@ const _access_code_warning_map = z.object({
   kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning
     .optional()
     .nullable(),
+  access_code_inactive: access_code_inactive.optional().nullable(),
   ultraloq_access_code_disabled: ultraloq_access_code_disabled
     .optional()
     .nullable(),

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

@@ -330,6 +330,38 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  description:
+                    'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
+                  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_state_unconfirmed'],
+                      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:
                     'Unable to confirm that the access code is set on Kwikset device.',
                   properties: {
@@ -359,8 +391,11 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `access_code_state_unconfirmed` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Unable to confirm the deletion of the access code on Kwikset device.',
                   properties: {
@@ -390,11 +425,19 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `access_code_state_unconfirmed` instead.',
                 },
                 {
                   description:
                     'Code was modified or removed externally after Seam successfully set it on the device.',
                   properties: {
+                    change_type: {
+                      description:
+                        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+                      enum: ['modified', 'removed'],
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the error.',
@@ -418,6 +461,32 @@ const openapi: OpenAPISpec = {
                         'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
+                    modified_fields: {
+                      description:
+                        'List of fields that were changed externally, with their previous and new values.',
+                      items: {
+                        properties: {
+                          field: {
+                            description:
+                              'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+                            type: 'string',
+                          },
+                          from: {
+                            description: 'The previous value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          to: {
+                            description: 'The new value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                        },
+                        required: ['field', 'from', 'to'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
@@ -1755,6 +1824,12 @@ const openapi: OpenAPISpec = {
                   description:
                     'Code was modified or removed externally after Seam successfully set it on the device.',
                   properties: {
+                    change_type: {
+                      description:
+                        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+                      enum: ['modified', 'removed'],
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the warning.',
@@ -1766,6 +1841,32 @@ const openapi: OpenAPISpec = {
                         'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
+                    modified_fields: {
+                      description:
+                        'List of fields that were changed externally, with their previous and new values.',
+                      items: {
+                        properties: {
+                          field: {
+                            description:
+                              'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+                            type: 'string',
+                          },
+                          from: {
+                            description: 'The previous value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          to: {
+                            description: 'The new value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                        },
+                        required: ['field', 'from', 'to'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
@@ -1948,6 +2049,32 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  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 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: ['access_code_inactive'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'warning_code'],
+                  type: 'object',
+                },
+                {
+                  deprecated: true,
                   description:
                     'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
                   properties: {
@@ -1971,6 +2098,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `access_code_inactive` instead.',
                 },
                 {
                   description:
@@ -27575,6 +27703,38 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  description:
+                    'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
+                  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_state_unconfirmed'],
+                      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:
                     'Unable to confirm that the access code is set on Kwikset device.',
                   properties: {
@@ -27604,8 +27764,11 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `access_code_state_unconfirmed` instead.',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Unable to confirm the deletion of the access code on Kwikset device.',
                   properties: {
@@ -27635,11 +27798,19 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `access_code_state_unconfirmed` instead.',
                 },
                 {
                   description:
                     'Code was modified or removed externally after Seam successfully set it on the device.',
                   properties: {
+                    change_type: {
+                      description:
+                        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+                      enum: ['modified', 'removed'],
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the error.',
@@ -27663,6 +27834,32 @@ const openapi: OpenAPISpec = {
                         'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
+                    modified_fields: {
+                      description:
+                        'List of fields that were changed externally, with their previous and new values.',
+                      items: {
+                        properties: {
+                          field: {
+                            description:
+                              'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+                            type: 'string',
+                          },
+                          from: {
+                            description: 'The previous value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          to: {
+                            description: 'The new value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                        },
+                        required: ['field', 'from', 'to'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
@@ -28689,6 +28886,12 @@ const openapi: OpenAPISpec = {
                   description:
                     'Code was modified or removed externally after Seam successfully set it on the device.',
                   properties: {
+                    change_type: {
+                      description:
+                        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+                      enum: ['modified', 'removed'],
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the warning.',
@@ -28700,6 +28903,32 @@ const openapi: OpenAPISpec = {
                         'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
                       type: 'string',
                     },
+                    modified_fields: {
+                      description:
+                        'List of fields that were changed externally, with their previous and new values.',
+                      items: {
+                        properties: {
+                          field: {
+                            description:
+                              'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+                            type: 'string',
+                          },
+                          from: {
+                            description: 'The previous value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          to: {
+                            description: 'The new value of the field.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                        },
+                        required: ['field', 'from', 'to'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
@@ -28882,6 +29111,32 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  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 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: ['access_code_inactive'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'warning_code'],
+                  type: 'object',
+                },
+                {
+                  deprecated: true,
                   description:
                     'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
                   properties: {
@@ -28905,6 +29160,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `access_code_inactive` instead.',
                 },
                 {
                   description: