@seamapi/types 1.313.0 → 1.314.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.
@@ -196,6 +196,7 @@ export default {
196
196
  'pti_access_level',
197
197
  'salto_ks_access_group',
198
198
  'brivo_group',
199
+ 'salto_space_group',
199
200
  ],
200
201
  type: 'string',
201
202
  'x-deprecated': 'Use `external_type`.',
@@ -230,6 +231,7 @@ export default {
230
231
  'pti_access_level',
231
232
  'salto_ks_access_group',
232
233
  'brivo_group',
234
+ 'salto_space_group',
233
235
  ],
234
236
  type: 'string',
235
237
  },
@@ -2342,7 +2344,10 @@ export default {
2342
2344
  {
2343
2345
  properties: {
2344
2346
  message: { type: 'string' },
2345
- type: { enum: ['no_card_on_encoder'], type: 'string' },
2347
+ type: {
2348
+ enum: ['no_credential_on_encoder'],
2349
+ type: 'string',
2350
+ },
2346
2351
  },
2347
2352
  required: ['type', 'message'],
2348
2353
  type: 'object',
@@ -3042,7 +3047,10 @@ export default {
3042
3047
  {
3043
3048
  properties: {
3044
3049
  message: { type: 'string' },
3045
- type: { enum: ['no_card_on_encoder'], type: 'string' },
3050
+ type: {
3051
+ enum: ['no_credential_on_encoder'],
3052
+ type: 'string',
3053
+ },
3046
3054
  },
3047
3055
  required: ['type', 'message'],
3048
3056
  type: 'object',
@@ -12242,6 +12250,7 @@ export default {
12242
12250
  'pti_access_level',
12243
12251
  'salto_ks_access_group',
12244
12252
  'brivo_group',
12253
+ 'salto_space_group',
12245
12254
  ],
12246
12255
  type: 'string',
12247
12256
  'x-deprecated': 'Use `external_type`.',
@@ -12277,6 +12286,7 @@ export default {
12277
12286
  'pti_access_level',
12278
12287
  'salto_ks_access_group',
12279
12288
  'brivo_group',
12289
+ 'salto_space_group',
12280
12290
  ],
12281
12291
  type: 'string',
12282
12292
  },
@@ -12383,6 +12393,7 @@ export default {
12383
12393
  'pti_access_level',
12384
12394
  'salto_ks_access_group',
12385
12395
  'brivo_group',
12396
+ 'salto_space_group',
12386
12397
  ],
12387
12398
  type: 'string',
12388
12399
  'x-deprecated': 'Use `external_type`.',
@@ -12418,6 +12429,7 @@ export default {
12418
12429
  'pti_access_level',
12419
12430
  'salto_ks_access_group',
12420
12431
  'brivo_group',
12432
+ 'salto_space_group',
12421
12433
  ],
12422
12434
  type: 'string',
12423
12435
  },
@@ -14320,7 +14332,7 @@ export default {
14320
14332
  'x-fern-sdk-method-name': 'encode_credential',
14321
14333
  'x-fern-sdk-return-value': 'action_attempt',
14322
14334
  'x-response-key': 'action_attempt',
14323
- 'x-undocumented': 'Encoding a card is currently unimplemented.',
14335
+ 'x-undocumented': 'Encoders are in alpha.',
14324
14336
  },
14325
14337
  },
14326
14338
  '/acs/encoders/list': {
@@ -14534,7 +14546,283 @@ export default {
14534
14546
  'x-fern-sdk-method-name': 'scan_credential',
14535
14547
  'x-fern-sdk-return-value': 'action_attempt',
14536
14548
  'x-response-key': 'action_attempt',
14537
- 'x-undocumented': 'Reading a card is currently unimplemented.',
14549
+ 'x-undocumented': 'Encoders are in alpha.',
14550
+ },
14551
+ },
14552
+ '/acs/encoders/simulate/next_credential_encode_will_fail': {
14553
+ post: {
14554
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillFailPost',
14555
+ requestBody: {
14556
+ content: {
14557
+ 'application/json': {
14558
+ schema: {
14559
+ oneOf: [
14560
+ {
14561
+ additionalProperties: false,
14562
+ properties: {
14563
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14564
+ error_code: {
14565
+ default: 'no_credential_on_encoder',
14566
+ enum: ['no_credential_on_encoder'],
14567
+ type: 'string',
14568
+ },
14569
+ },
14570
+ required: ['acs_encoder_id'],
14571
+ type: 'object',
14572
+ },
14573
+ {
14574
+ additionalProperties: false,
14575
+ properties: {
14576
+ acs_credential_id: { format: 'uuid', type: 'string' },
14577
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14578
+ error_code: {
14579
+ enum: ['uncategorized_error', 'action_attempt_expired'],
14580
+ type: 'string',
14581
+ },
14582
+ },
14583
+ required: ['acs_encoder_id', 'error_code'],
14584
+ type: 'object',
14585
+ },
14586
+ ],
14587
+ },
14588
+ },
14589
+ },
14590
+ },
14591
+ responses: {
14592
+ 200: {
14593
+ content: {
14594
+ 'application/json': {
14595
+ schema: {
14596
+ properties: { ok: { type: 'boolean' } },
14597
+ required: ['ok'],
14598
+ type: 'object',
14599
+ },
14600
+ },
14601
+ },
14602
+ description: 'OK',
14603
+ },
14604
+ 400: { description: 'Bad Request' },
14605
+ 401: { description: 'Unauthorized' },
14606
+ },
14607
+ security: [
14608
+ { api_key: [] },
14609
+ { pat_with_workspace: [] },
14610
+ { console_session_with_workspace: [] },
14611
+ ],
14612
+ summary: '/acs/encoders/simulate/next_credential_encode_will_fail',
14613
+ tags: ['/acs'],
14614
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14615
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_fail',
14616
+ 'x-response-key': null,
14617
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14618
+ },
14619
+ },
14620
+ '/acs/encoders/simulate/next_credential_encode_will_succeed': {
14621
+ post: {
14622
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillSucceedPost',
14623
+ requestBody: {
14624
+ content: {
14625
+ 'application/json': {
14626
+ schema: {
14627
+ additionalProperties: false,
14628
+ properties: {
14629
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14630
+ scenario: {
14631
+ default: 'credential_is_issued',
14632
+ enum: ['credential_is_issued'],
14633
+ type: 'string',
14634
+ },
14635
+ },
14636
+ required: ['acs_encoder_id'],
14637
+ type: 'object',
14638
+ },
14639
+ },
14640
+ },
14641
+ },
14642
+ responses: {
14643
+ 200: {
14644
+ content: {
14645
+ 'application/json': {
14646
+ schema: {
14647
+ properties: { ok: { type: 'boolean' } },
14648
+ required: ['ok'],
14649
+ type: 'object',
14650
+ },
14651
+ },
14652
+ },
14653
+ description: 'OK',
14654
+ },
14655
+ 400: { description: 'Bad Request' },
14656
+ 401: { description: 'Unauthorized' },
14657
+ },
14658
+ security: [
14659
+ { api_key: [] },
14660
+ { pat_with_workspace: [] },
14661
+ { console_session_with_workspace: [] },
14662
+ ],
14663
+ summary: '/acs/encoders/simulate/next_credential_encode_will_succeed',
14664
+ tags: ['/acs'],
14665
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14666
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_succeed',
14667
+ 'x-response-key': null,
14668
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14669
+ },
14670
+ },
14671
+ '/acs/encoders/simulate/next_credential_scan_will_fail': {
14672
+ post: {
14673
+ operationId: 'acsEncodersSimulateNextCredentialScanWillFailPost',
14674
+ requestBody: {
14675
+ content: {
14676
+ 'application/json': {
14677
+ schema: {
14678
+ oneOf: [
14679
+ {
14680
+ additionalProperties: false,
14681
+ properties: {
14682
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14683
+ error_code: {
14684
+ default: 'no_credential_on_encoder',
14685
+ enum: ['no_credential_on_encoder'],
14686
+ type: 'string',
14687
+ },
14688
+ },
14689
+ required: ['acs_encoder_id'],
14690
+ type: 'object',
14691
+ },
14692
+ {
14693
+ additionalProperties: false,
14694
+ properties: {
14695
+ acs_credential_id_on_seam: {
14696
+ format: 'uuid',
14697
+ type: 'string',
14698
+ },
14699
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14700
+ error_code: {
14701
+ enum: ['uncategorized_error', 'action_attempt_expired'],
14702
+ type: 'string',
14703
+ },
14704
+ },
14705
+ required: ['acs_encoder_id', 'error_code'],
14706
+ type: 'object',
14707
+ },
14708
+ ],
14709
+ },
14710
+ },
14711
+ },
14712
+ },
14713
+ responses: {
14714
+ 200: {
14715
+ content: {
14716
+ 'application/json': {
14717
+ schema: {
14718
+ properties: { ok: { type: 'boolean' } },
14719
+ required: ['ok'],
14720
+ type: 'object',
14721
+ },
14722
+ },
14723
+ },
14724
+ description: 'OK',
14725
+ },
14726
+ 400: { description: 'Bad Request' },
14727
+ 401: { description: 'Unauthorized' },
14728
+ },
14729
+ security: [
14730
+ { api_key: [] },
14731
+ { pat_with_workspace: [] },
14732
+ { console_session_with_workspace: [] },
14733
+ ],
14734
+ summary: '/acs/encoders/simulate/next_credential_scan_will_fail',
14735
+ tags: ['/acs'],
14736
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14737
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_fail',
14738
+ 'x-response-key': null,
14739
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14740
+ },
14741
+ },
14742
+ '/acs/encoders/simulate/next_credential_scan_will_succeed': {
14743
+ post: {
14744
+ operationId: 'acsEncodersSimulateNextCredentialScanWillSucceedPost',
14745
+ requestBody: {
14746
+ content: {
14747
+ 'application/json': {
14748
+ schema: {
14749
+ oneOf: [
14750
+ {
14751
+ additionalProperties: false,
14752
+ properties: {
14753
+ acs_credential_id_on_seam: {
14754
+ format: 'uuid',
14755
+ type: 'string',
14756
+ },
14757
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14758
+ scenario: {
14759
+ default: 'credential_exists_on_seam',
14760
+ enum: [
14761
+ 'credential_exists_on_seam',
14762
+ 'credential_on_encoder_needs_update',
14763
+ ],
14764
+ type: 'string',
14765
+ },
14766
+ },
14767
+ required: ['acs_encoder_id'],
14768
+ type: 'object',
14769
+ },
14770
+ {
14771
+ additionalProperties: false,
14772
+ properties: {
14773
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14774
+ scenario: {
14775
+ enum: ['credential_does_not_exist_on_seam'],
14776
+ type: 'string',
14777
+ },
14778
+ },
14779
+ required: ['acs_encoder_id', 'scenario'],
14780
+ type: 'object',
14781
+ },
14782
+ {
14783
+ additionalProperties: false,
14784
+ properties: {
14785
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14786
+ scenario: {
14787
+ enum: ['credential_on_encoder_is_empty'],
14788
+ type: 'string',
14789
+ },
14790
+ },
14791
+ required: ['acs_encoder_id', 'scenario'],
14792
+ type: 'object',
14793
+ },
14794
+ ],
14795
+ },
14796
+ },
14797
+ },
14798
+ },
14799
+ responses: {
14800
+ 200: {
14801
+ content: {
14802
+ 'application/json': {
14803
+ schema: {
14804
+ properties: { ok: { type: 'boolean' } },
14805
+ required: ['ok'],
14806
+ type: 'object',
14807
+ },
14808
+ },
14809
+ },
14810
+ description: 'OK',
14811
+ },
14812
+ 400: { description: 'Bad Request' },
14813
+ 401: { description: 'Unauthorized' },
14814
+ },
14815
+ security: [
14816
+ { api_key: [] },
14817
+ { pat_with_workspace: [] },
14818
+ { console_session_with_workspace: [] },
14819
+ ],
14820
+ summary: '/acs/encoders/simulate/next_credential_scan_will_succeed',
14821
+ tags: ['/acs'],
14822
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14823
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_succeed',
14824
+ 'x-response-key': null,
14825
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14538
14826
  },
14539
14827
  },
14540
14828
  '/acs/entrances/get': {