@seamapi/types 1.913.0 → 1.915.0

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

@@ -100,6 +100,86 @@ export const access_code_changed_event = access_code_event.extend({
 
 export type AccessCodeChangedEvent = z.infer<typeof access_code_changed_event>
 
+export const access_code_name_changed_event = access_code_event.extend({
+  event_type: z.literal('access_code.name_changed'),
+  from: z
+    .object({
+      name: z.string().nullable().describe('Previous name of the access code.'),
+    })
+    .describe('Previous access code name configuration.'),
+  to: z
+    .object({
+      name: z.string().nullable().describe('New name of the access code.'),
+    })
+    .describe('New access code name configuration.'),
+  description: z
+    .string()
+    .describe('Human-readable description of the change and its source.'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.
+  `)
+
+export type AccessCodeNameChangedEvent = z.infer<
+  typeof access_code_name_changed_event
+>
+
+export const access_code_code_changed_event = access_code_event.extend({
+  event_type: z.literal('access_code.code_changed'),
+  from: z
+    .object({
+      code: z.string().nullable().describe('Previous pin code.'),
+    })
+    .describe('Previous pin code configuration.'),
+  to: z
+    .object({
+      code: z.string().nullable().describe('New pin code.'),
+    })
+    .describe('New pin code configuration.'),
+  description: z
+    .string()
+    .describe('Human-readable description of the change and its source.'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.
+  `)
+
+export type AccessCodeCodeChangedEvent = z.infer<
+  typeof access_code_code_changed_event
+>
+
+export const access_code_time_frame_changed_event = access_code_event.extend({
+  event_type: z.literal('access_code.time_frame_changed'),
+  from: z
+    .object({
+      starts_at: z.string().nullable().describe('Previous start time.'),
+      ends_at: z.string().nullable().describe('Previous end time.'),
+    })
+    .describe('Previous time frame configuration.'),
+  to: z
+    .object({
+      starts_at: z.string().nullable().describe('New start time.'),
+      ends_at: z.string().nullable().describe('New end time.'),
+    })
+    .describe('New time frame configuration.'),
+  description: z
+    .string()
+    .describe('Human-readable description of the change and its source.'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.
+  `)
+
+export type AccessCodeTimeFrameChangedEvent = z.infer<
+  typeof access_code_time_frame_changed_event
+>
+
 export const access_code_scheduled_on_device_event = access_code_event.extend({
   event_type: z.literal('access_code.scheduled_on_device'),
   code,
@@ -317,6 +397,9 @@ export type UnmanagedAccessCodeRemovedEvent = z.infer<
 export const access_code_events = [
   access_code_created_event,
   access_code_changed_event,
+  access_code_name_changed_event,
+  access_code_code_changed_event,
+  access_code_time_frame_changed_event,
   access_code_scheduled_on_device_event,
   access_code_set_on_device_event,
   access_code_removed_from_device_event,

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

@@ -17354,6 +17354,340 @@ const openapi: OpenAPISpec = {
             type: 'object',
             'x-route-path': '/access_codes',
           },
+          {
+            description:
+              'The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
+            properties: {
+              access_code_id: {
+                description: 'ID of the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              connected_account_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the connected account, present when connected_account_id is provided.',
+                type: 'object',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              description: {
+                description:
+                  'Human-readable description of the change and its source.',
+                type: 'string',
+              },
+              device_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the device, present when device_id is provided.',
+                type: 'object',
+              },
+              device_id: {
+                description:
+                  'ID of the device associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: {
+                enum: ['access_code.name_changed'],
+                type: 'string',
+              },
+              from: {
+                description: 'Previous access code name configuration.',
+                properties: {
+                  name: {
+                    description: 'Previous name of the access code.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['name'],
+                type: 'object',
+              },
+              occurred_at: {
+                description: 'Date and time at which the event occurred.',
+                format: 'date-time',
+                type: 'string',
+              },
+              to: {
+                description: 'New access code name configuration.',
+                properties: {
+                  name: {
+                    description: 'New name of the access code.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['name'],
+                type: 'object',
+              },
+              workspace_id: {
+                description:
+                  'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'access_code_id',
+              'device_id',
+              'connected_account_id',
+              'event_type',
+              'from',
+              'to',
+              'description',
+            ],
+            type: 'object',
+            'x-route-path': '/access_codes',
+          },
+          {
+            description:
+              'The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
+            properties: {
+              access_code_id: {
+                description: 'ID of the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              connected_account_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the connected account, present when connected_account_id is provided.',
+                type: 'object',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              description: {
+                description:
+                  'Human-readable description of the change and its source.',
+                type: 'string',
+              },
+              device_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the device, present when device_id is provided.',
+                type: 'object',
+              },
+              device_id: {
+                description:
+                  'ID of the device associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: {
+                enum: ['access_code.code_changed'],
+                type: 'string',
+              },
+              from: {
+                description: 'Previous pin code configuration.',
+                properties: {
+                  code: {
+                    description: 'Previous pin code.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['code'],
+                type: 'object',
+              },
+              occurred_at: {
+                description: 'Date and time at which the event occurred.',
+                format: 'date-time',
+                type: 'string',
+              },
+              to: {
+                description: 'New pin code configuration.',
+                properties: {
+                  code: {
+                    description: 'New pin code.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['code'],
+                type: 'object',
+              },
+              workspace_id: {
+                description:
+                  'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'access_code_id',
+              'device_id',
+              'connected_account_id',
+              'event_type',
+              'from',
+              'to',
+              'description',
+            ],
+            type: 'object',
+            'x-route-path': '/access_codes',
+          },
+          {
+            description:
+              'The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
+            properties: {
+              access_code_id: {
+                description: 'ID of the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              connected_account_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the connected account, present when connected_account_id is provided.',
+                type: 'object',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              description: {
+                description:
+                  'Human-readable description of the change and its source.',
+                type: 'string',
+              },
+              device_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the device, present when device_id is provided.',
+                type: 'object',
+              },
+              device_id: {
+                description:
+                  'ID of the device associated with the affected access code.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: {
+                enum: ['access_code.time_frame_changed'],
+                type: 'string',
+              },
+              from: {
+                description: 'Previous time frame configuration.',
+                properties: {
+                  ends_at: {
+                    description: 'Previous end time.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                  starts_at: {
+                    description: 'Previous start time.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['starts_at', 'ends_at'],
+                type: 'object',
+              },
+              occurred_at: {
+                description: 'Date and time at which the event occurred.',
+                format: 'date-time',
+                type: 'string',
+              },
+              to: {
+                description: 'New time frame configuration.',
+                properties: {
+                  ends_at: {
+                    description: 'New end time.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                  starts_at: {
+                    description: 'New start time.',
+                    nullable: true,
+                    type: 'string',
+                  },
+                },
+                required: ['starts_at', 'ends_at'],
+                type: 'object',
+              },
+              workspace_id: {
+                description:
+                  'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'access_code_id',
+              'device_id',
+              'connected_account_id',
+              'event_type',
+              'from',
+              'to',
+              'description',
+            ],
+            type: 'object',
+            'x-route-path': '/access_codes',
+          },
           {
             description:
               'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.',
@@ -59843,6 +60177,9 @@ const openapi: OpenAPISpec = {
               enum: [
                 'access_code.created',
                 'access_code.changed',
+                'access_code.name_changed',
+                'access_code.code_changed',
+                'access_code.time_frame_changed',
                 'access_code.scheduled_on_device',
                 'access_code.set_on_device',
                 'access_code.removed_from_device',
@@ -59957,6 +60294,9 @@ const openapi: OpenAPISpec = {
                 enum: [
                   'access_code.created',
                   'access_code.changed',
+                  'access_code.name_changed',
+                  'access_code.code_changed',
+                  'access_code.time_frame_changed',
                   'access_code.scheduled_on_device',
                   'access_code.set_on_device',
                   'access_code.removed_from_device',
@@ -60404,6 +60744,9 @@ const openapi: OpenAPISpec = {
                     enum: [
                       'access_code.created',
                       'access_code.changed',
+                      'access_code.name_changed',
+                      'access_code.code_changed',
+                      'access_code.time_frame_changed',
                       'access_code.scheduled_on_device',
                       'access_code.set_on_device',
                       'access_code.removed_from_device',
@@ -60514,6 +60857,9 @@ const openapi: OpenAPISpec = {
                       enum: [
                         'access_code.created',
                         'access_code.changed',
+                        'access_code.name_changed',
+                        'access_code.code_changed',
+                        'access_code.time_frame_changed',
                         'access_code.scheduled_on_device',
                         'access_code.set_on_device',
                         'access_code.removed_from_device',
@@ -70782,6 +71128,9 @@ const openapi: OpenAPISpec = {
               enum: [
                 'access_code.created',
                 'access_code.changed',
+                'access_code.name_changed',
+                'access_code.code_changed',
+                'access_code.time_frame_changed',
                 'access_code.scheduled_on_device',
                 'access_code.set_on_device',
                 'access_code.removed_from_device',
@@ -70897,6 +71246,9 @@ const openapi: OpenAPISpec = {
                 enum: [
                   'access_code.created',
                   'access_code.changed',
+                  'access_code.name_changed',
+                  'access_code.code_changed',
+                  'access_code.time_frame_changed',
                   'access_code.scheduled_on_device',
                   'access_code.set_on_device',
                   'access_code.removed_from_device',
@@ -71075,6 +71427,9 @@ const openapi: OpenAPISpec = {
                     enum: [
                       'access_code.created',
                       'access_code.changed',
+                      'access_code.name_changed',
+                      'access_code.code_changed',
+                      'access_code.time_frame_changed',
                       'access_code.scheduled_on_device',
                       'access_code.set_on_device',
                       'access_code.removed_from_device',
@@ -71185,6 +71540,9 @@ const openapi: OpenAPISpec = {
                       enum: [
                         'access_code.created',
                         'access_code.changed',
+                        'access_code.name_changed',
+                        'access_code.code_changed',
+                        'access_code.time_frame_changed',
                         'access_code.scheduled_on_device',
                         'access_code.set_on_device',
                         'access_code.removed_from_device',