@seamapi/types 1.603.0 → 1.605.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1643,6 +1643,10 @@ export default {
1643
1643
  },
1644
1644
  type: 'array',
1645
1645
  },
1646
+ reservation_key: {
1647
+ description: 'Reservation key for the access grant.',
1648
+ type: 'string',
1649
+ },
1646
1650
  space_ids: {
1647
1651
  description: 'IDs of the spaces to which the Access Grant gives access.',
1648
1652
  items: { format: 'uuid', type: 'string' },
@@ -2522,13 +2526,12 @@ export default {
2522
2526
  hotek_metadata: {
2523
2527
  description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2524
2528
  properties: {
2525
- display_name: {
2529
+ common_area_name: {
2526
2530
  description: 'Display name of the entrance.',
2527
2531
  type: 'string',
2528
2532
  },
2529
- door_type: {
2530
- description: 'Type of door.',
2531
- enum: ['common_area', 'guest'],
2533
+ common_area_number: {
2534
+ description: 'Display name of the entrance.',
2532
2535
  type: 'string',
2533
2536
  },
2534
2537
  room_number: {
@@ -2536,7 +2539,6 @@ export default {
2536
2539
  type: 'string',
2537
2540
  },
2538
2541
  },
2539
- required: ['room_number', 'display_name', 'door_type'],
2540
2542
  type: 'object',
2541
2543
  },
2542
2544
  latch_metadata: {
@@ -17951,13 +17953,12 @@ export default {
17951
17953
  hotek_metadata: {
17952
17954
  description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
17953
17955
  properties: {
17954
- display_name: {
17956
+ common_area_name: {
17955
17957
  description: 'Display name of the entrance.',
17956
17958
  type: 'string',
17957
17959
  },
17958
- door_type: {
17959
- description: 'Type of door.',
17960
- enum: ['common_area', 'guest'],
17960
+ common_area_number: {
17961
+ description: 'Display name of the entrance.',
17961
17962
  type: 'string',
17962
17963
  },
17963
17964
  room_number: {
@@ -17965,11 +17966,6 @@ export default {
17965
17966
  type: 'string',
17966
17967
  },
17967
17968
  },
17968
- required: [
17969
- 'room_number',
17970
- 'display_name',
17971
- 'door_type',
17972
- ],
17973
17969
  type: 'object',
17974
17970
  },
17975
17971
  latch_metadata: {
@@ -25555,6 +25551,10 @@ export default {
25555
25551
  },
25556
25552
  type: 'array',
25557
25553
  },
25554
+ reservation_key: {
25555
+ description: 'Reservation key for the access grant.',
25556
+ type: 'string',
25557
+ },
25558
25558
  space_ids: {
25559
25559
  description: 'Set of IDs of existing spaces to which access is being granted.',
25560
25560
  items: { format: 'uuid', type: 'string' },
@@ -26440,6 +26440,10 @@ export default {
26440
26440
  },
26441
26441
  type: 'array',
26442
26442
  },
26443
+ reservation_key: {
26444
+ description: 'Reservation key for the access grant.',
26445
+ type: 'string',
26446
+ },
26443
26447
  space_ids: {
26444
26448
  description: 'IDs of the spaces to which the Access Grant gives access.',
26445
26449
  items: { format: 'uuid', type: 'string' },
@@ -26648,6 +26652,10 @@ export default {
26648
26652
  },
26649
26653
  type: 'array',
26650
26654
  },
26655
+ reservation_key: {
26656
+ description: 'Reservation key for the access grant.',
26657
+ type: 'string',
26658
+ },
26651
26659
  space_ids: {
26652
26660
  description: 'IDs of the spaces to which the Access Grant gives access.',
26653
26661
  items: { format: 'uuid', type: 'string' },
@@ -26871,6 +26879,10 @@ export default {
26871
26879
  },
26872
26880
  type: 'array',
26873
26881
  },
26882
+ reservation_key: {
26883
+ description: 'Reservation key for the access grant.',
26884
+ type: 'string',
26885
+ },
26874
26886
  space_ids: {
26875
26887
  description: 'IDs of the spaces to which the Access Grant gives access.',
26876
26888
  items: { format: 'uuid', type: 'string' },
@@ -27091,6 +27103,10 @@ export default {
27091
27103
  },
27092
27104
  type: 'array',
27093
27105
  },
27106
+ reservation_key: {
27107
+ description: 'Reservation key for the access grant.',
27108
+ type: 'string',
27109
+ },
27094
27110
  space_ids: {
27095
27111
  description: 'IDs of the spaces to which the Access Grant gives access.',
27096
27112
  items: { format: 'uuid', type: 'string' },
@@ -33023,6 +33039,116 @@ export default {
33023
33039
  'x-title': 'List Compatible Credential Manager ACS Systems',
33024
33040
  },
33025
33041
  },
33042
+ '/acs/systems/report_devices': {
33043
+ post: {
33044
+ description: 'Reports ACS system resources including encoders and entrances with their metadata.\n\nThis endpoint allows reporting of:\n- ACS encoders with removal status and encoder port metadata\n- ACS entrances with room number metadata',
33045
+ operationId: 'acsSystemsReportDevicesPost',
33046
+ requestBody: {
33047
+ content: {
33048
+ 'application/json': {
33049
+ schema: {
33050
+ properties: {
33051
+ acs_encoders: {
33052
+ default: [],
33053
+ description: 'Array of ACS encoders to report',
33054
+ items: {
33055
+ properties: {
33056
+ hotek_metadata: {
33057
+ properties: {
33058
+ encoder_number: {
33059
+ description: 'The encoder number determined by the USB port connection.',
33060
+ type: 'string',
33061
+ },
33062
+ },
33063
+ required: ['encoder_number'],
33064
+ type: 'object',
33065
+ },
33066
+ is_removed: {
33067
+ default: false,
33068
+ description: 'Whether the encoder is removed',
33069
+ type: 'boolean',
33070
+ },
33071
+ },
33072
+ required: ['hotek_metadata'],
33073
+ type: 'object',
33074
+ },
33075
+ type: 'array',
33076
+ },
33077
+ acs_entrances: {
33078
+ default: [],
33079
+ description: 'Array of ACS entrances to report',
33080
+ items: {
33081
+ properties: {
33082
+ hotek_metadata: {
33083
+ description: 'Hotek-specific metadata associated with the entrance.',
33084
+ properties: {
33085
+ common_area_name: {
33086
+ description: 'The common area name',
33087
+ type: 'string',
33088
+ },
33089
+ common_area_number: {
33090
+ description: 'The room number identifier',
33091
+ type: 'string',
33092
+ },
33093
+ room_number: {
33094
+ description: 'The room number identifier',
33095
+ type: 'string',
33096
+ },
33097
+ },
33098
+ type: 'object',
33099
+ },
33100
+ is_removed: {
33101
+ default: false,
33102
+ description: 'Whether the entrance is removed',
33103
+ type: 'boolean',
33104
+ },
33105
+ },
33106
+ required: ['hotek_metadata'],
33107
+ type: 'object',
33108
+ },
33109
+ type: 'array',
33110
+ },
33111
+ acs_system_id: {
33112
+ description: 'ID of the ACS system to report resources for',
33113
+ format: 'uuid',
33114
+ type: 'string',
33115
+ },
33116
+ },
33117
+ required: ['acs_system_id'],
33118
+ type: 'object',
33119
+ },
33120
+ },
33121
+ },
33122
+ },
33123
+ responses: {
33124
+ 200: {
33125
+ content: {
33126
+ 'application/json': {
33127
+ schema: {
33128
+ properties: { ok: { type: 'boolean' } },
33129
+ required: ['ok'],
33130
+ type: 'object',
33131
+ },
33132
+ },
33133
+ },
33134
+ description: 'OK',
33135
+ },
33136
+ 400: { description: 'Bad Request' },
33137
+ 401: { description: 'Unauthorized' },
33138
+ },
33139
+ security: [
33140
+ { pat_with_workspace: [] },
33141
+ { console_session_with_workspace: [] },
33142
+ { api_key: [] },
33143
+ ],
33144
+ summary: '/acs/systems/report_devices',
33145
+ tags: ['/acs'],
33146
+ 'x-fern-sdk-group-name': ['acs', 'systems'],
33147
+ 'x-fern-sdk-method-name': 'report_devices',
33148
+ 'x-response-key': null,
33149
+ 'x-title': 'Report ACS Resources',
33150
+ },
33151
+ },
33026
33152
  '/acs/users/add_to_access_group': {
33027
33153
  post: {
33028
33154
  description: 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',