@seamapi/types 1.264.2 → 1.266.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.
@@ -505,6 +505,13 @@ export default {
505
505
  format: 'date-time',
506
506
  type: 'string',
507
507
  },
508
+ default_credential_manager_acs_system_id: {
509
+ description: 'ID of the default credential manager acs_system for this access control system.',
510
+ format: 'uuid',
511
+ nullable: true,
512
+ type: 'string',
513
+ 'x-draft': 'Needs review',
514
+ },
508
515
  errors: {
509
516
  description: 'Errors associated with the `acs_system`.',
510
517
  items: {
@@ -642,6 +649,10 @@ export default {
642
649
  description: 'URL for the image that represents the `acs_system`.',
643
650
  type: 'string',
644
651
  },
652
+ is_credential_manager: {
653
+ description: 'Indicates if the `acs_system` is a credential manager.',
654
+ type: 'boolean',
655
+ },
645
656
  name: { description: 'Name of the `acs_system`.', type: 'string' },
646
657
  system_type: {
647
658
  deprecated: true,
@@ -714,6 +725,7 @@ export default {
714
725
  },
715
726
  required: [
716
727
  'acs_system_id',
728
+ 'is_credential_manager',
717
729
  'name',
718
730
  'created_at',
719
731
  'workspace_id',
@@ -1207,14 +1219,18 @@ export default {
1207
1219
  enum: ['TLCode', 'rfid48'],
1208
1220
  type: 'string',
1209
1221
  },
1210
- card_function_type: {
1211
- enum: ['guest', 'staff'],
1212
- type: 'string',
1213
- },
1214
1222
  card_holder: { type: 'string' },
1215
1223
  card_id: { type: 'string' },
1224
+ common_acs_entrance_ids: {
1225
+ items: { format: 'uuid', type: 'string' },
1226
+ type: 'array',
1227
+ },
1216
1228
  discarded: { type: 'boolean' },
1217
1229
  expired: { type: 'boolean' },
1230
+ guest_acs_entrance_ids: {
1231
+ items: { format: 'uuid', type: 'string' },
1232
+ type: 'array',
1233
+ },
1218
1234
  number_of_issued_cards: {
1219
1235
  format: 'float',
1220
1236
  type: 'number',
@@ -1225,7 +1241,6 @@ export default {
1225
1241
  },
1226
1242
  required: [
1227
1243
  'card_id',
1228
- 'card_function_type',
1229
1244
  'cancelled',
1230
1245
  'discarded',
1231
1246
  'expired',
@@ -8023,6 +8038,7 @@ export default {
8023
8038
  },
8024
8039
  '/acs/entrances/get': {
8025
8040
  post: {
8041
+ description: 'Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8026
8042
  operationId: 'acsEntrancesGetPost',
8027
8043
  requestBody: {
8028
8044
  content: {
@@ -8068,6 +8084,7 @@ export default {
8068
8084
  'x-fern-sdk-method-name': 'get',
8069
8085
  'x-fern-sdk-return-value': 'acs_entrance',
8070
8086
  'x-response-key': 'acs_entrance',
8087
+ 'x-title': 'Get an Entrance',
8071
8088
  },
8072
8089
  },
8073
8090
  '/acs/entrances/grant_access': {
@@ -8117,6 +8134,7 @@ export default {
8117
8134
  },
8118
8135
  '/acs/entrances/list': {
8119
8136
  post: {
8137
+ description: 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8120
8138
  operationId: 'acsEntrancesListPost',
8121
8139
  requestBody: {
8122
8140
  content: {
@@ -8165,10 +8183,12 @@ export default {
8165
8183
  'x-fern-sdk-method-name': 'list',
8166
8184
  'x-fern-sdk-return-value': 'acs_entrances',
8167
8185
  'x-response-key': 'acs_entrances',
8186
+ 'x-title': 'List Entrances',
8168
8187
  },
8169
8188
  },
8170
8189
  '/acs/entrances/list_credentials_with_access': {
8171
8190
  post: {
8191
+ description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8172
8192
  operationId: 'acsEntrancesListCredentialsWithAccessPost',
8173
8193
  requestBody: {
8174
8194
  content: {
@@ -8224,6 +8244,7 @@ export default {
8224
8244
  'x-fern-sdk-method-name': 'list_credentials_with_access',
8225
8245
  'x-fern-sdk-return-value': 'acs_credentials',
8226
8246
  'x-response-key': 'acs_credentials',
8247
+ 'x-title': 'List Credentials with Access to an Entrance',
8227
8248
  },
8228
8249
  },
8229
8250
  '/acs/systems/get': {