@seamapi/types 1.292.1 → 1.292.2

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.
@@ -9407,13 +9407,14 @@ export default {
9407
9407
  format: 'uuid',
9408
9408
  type: 'string',
9409
9409
  },
9410
- device_id: {
9411
- description: 'ID of the encoder to use for the encoding.',
9410
+ acs_encoder_id: {
9411
+ description:
9412
+ 'ID of the acs_encoder to use for the encoding.',
9412
9413
  format: 'uuid',
9413
9414
  type: 'string',
9414
9415
  },
9415
9416
  },
9416
- required: ['device_id', 'acs_credential_id'],
9417
+ required: ['acs_encoder_id', 'acs_credential_id'],
9417
9418
  type: 'object',
9418
9419
  },
9419
9420
  },
@@ -9464,28 +9465,28 @@ export default {
9464
9465
  oneOf: [
9465
9466
  {
9466
9467
  properties: {
9467
- acs_system_ids: {
9468
+ acs_encoder_ids: {
9468
9469
  items: { format: 'uuid', type: 'string' },
9469
9470
  type: 'array',
9470
9471
  },
9471
- device_ids: {
9472
+ acs_system_ids: {
9472
9473
  items: { format: 'uuid', type: 'string' },
9473
9474
  type: 'array',
9474
9475
  },
9475
9476
  limit: { default: 500, format: 'float', type: 'number' },
9476
9477
  },
9477
- required: ['acs_system_ids', 'device_ids'],
9478
+ required: ['acs_system_ids', 'acs_encoder_ids'],
9478
9479
  type: 'object',
9479
9480
  },
9480
9481
  {
9481
9482
  properties: {
9482
- device_ids: {
9483
+ acs_encoder_ids: {
9483
9484
  items: { format: 'uuid', type: 'string' },
9484
9485
  type: 'array',
9485
9486
  },
9486
9487
  limit: { default: 500, format: 'float', type: 'number' },
9487
9488
  },
9488
- required: ['device_ids'],
9489
+ required: ['acs_encoder_ids'],
9489
9490
  type: 'object',
9490
9491
  },
9491
9492
  {
@@ -9510,13 +9511,93 @@ export default {
9510
9511
  'application/json': {
9511
9512
  schema: {
9512
9513
  properties: {
9513
- devices: {
9514
- items: { $ref: '#/components/schemas/device' },
9514
+ acs_encoders: {
9515
+ items: {
9516
+ properties: {
9517
+ acs_encoder_id: {
9518
+ description: 'ID of the `acs_encoder`.',
9519
+ format: 'uuid',
9520
+ type: 'string',
9521
+ },
9522
+ acs_system_id: {
9523
+ description:
9524
+ 'ID of the access control system that contains the `acs_encoder`.',
9525
+ format: 'uuid',
9526
+ type: 'string',
9527
+ },
9528
+ created_at: {
9529
+ description:
9530
+ 'Date and time at which the `acs_encoder` was created.',
9531
+ format: 'date-time',
9532
+ type: 'string',
9533
+ },
9534
+ display_name: {
9535
+ description: 'Display name for the `acs_encoder`.',
9536
+ type: 'string',
9537
+ },
9538
+ errors: {
9539
+ description:
9540
+ 'Errors associated with the `acs_encoder`.',
9541
+ items: {
9542
+ description:
9543
+ 'Error associated with the `acs_encoder`.',
9544
+ properties: {
9545
+ _event_id: {
9546
+ description:
9547
+ 'ID of the event that was created when the `acs_encoder` was removed.',
9548
+ format: 'uuid',
9549
+ type: 'string',
9550
+ },
9551
+ created_at: {
9552
+ description:
9553
+ 'Date and time at which Seam created the error.',
9554
+ format: 'date-time',
9555
+ type: 'string',
9556
+ },
9557
+ error_code: {
9558
+ description:
9559
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9560
+ enum: ['acs_encoder_removed'],
9561
+ type: 'string',
9562
+ },
9563
+ message: {
9564
+ description:
9565
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
9566
+ type: 'string',
9567
+ },
9568
+ },
9569
+ required: [
9570
+ 'created_at',
9571
+ 'message',
9572
+ 'error_code',
9573
+ '_event_id',
9574
+ ],
9575
+ type: 'object',
9576
+ },
9577
+ type: 'array',
9578
+ },
9579
+ workspace_id: {
9580
+ description:
9581
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
9582
+ format: 'uuid',
9583
+ type: 'string',
9584
+ },
9585
+ },
9586
+ required: [
9587
+ 'acs_encoder_id',
9588
+ 'acs_system_id',
9589
+ 'workspace_id',
9590
+ 'errors',
9591
+ 'created_at',
9592
+ 'display_name',
9593
+ ],
9594
+ type: 'object',
9595
+ },
9515
9596
  type: 'array',
9516
9597
  },
9517
9598
  ok: { type: 'boolean' },
9518
9599
  },
9519
- required: ['devices', 'ok'],
9600
+ required: ['acs_encoders', 'ok'],
9520
9601
  type: 'object',
9521
9602
  },
9522
9603
  },
@@ -9535,8 +9616,8 @@ export default {
9535
9616
  tags: ['/acs'],
9536
9617
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9537
9618
  'x-fern-sdk-method-name': 'list',
9538
- 'x-fern-sdk-return-value': 'devices',
9539
- 'x-response-key': 'devices',
9619
+ 'x-fern-sdk-return-value': 'acs_encoders',
9620
+ 'x-response-key': 'acs_encoders',
9540
9621
  'x-undocumented': 'Encoders are in alpha.',
9541
9622
  },
9542
9623
  },
@@ -9548,18 +9629,18 @@ export default {
9548
9629
  'application/json': {
9549
9630
  schema: {
9550
9631
  properties: {
9551
- acs_system_id: {
9552
- description: 'ID of the acs_system the encoder belongs to.',
9632
+ acs_encoder_id: {
9633
+ description: 'ID of the acs_encoder to use for the scan.',
9553
9634
  format: 'uuid',
9554
9635
  type: 'string',
9555
9636
  },
9556
- device_id: {
9557
- description: 'ID of the encoder to use for the scan.',
9637
+ acs_system_id: {
9638
+ description: 'ID of the acs_system the encoder belongs to.',
9558
9639
  format: 'uuid',
9559
9640
  type: 'string',
9560
9641
  },
9561
9642
  },
9562
- required: ['acs_system_id', 'device_id'],
9643
+ required: ['acs_system_id', 'acs_encoder_id'],
9563
9644
  type: 'object',
9564
9645
  },
9565
9646
  },