@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.
@@ -178,6 +178,7 @@ export default {
178
178
  'pti_access_level',
179
179
  'salto_ks_access_group',
180
180
  'brivo_group',
181
+ 'salto_space_group',
181
182
  ],
182
183
  type: 'string',
183
184
  'x-deprecated': 'Use `external_type`.',
@@ -210,6 +211,7 @@ export default {
210
211
  'pti_access_level',
211
212
  'salto_ks_access_group',
212
213
  'brivo_group',
214
+ 'salto_space_group',
213
215
  ],
214
216
  type: 'string',
215
217
  },
@@ -2135,7 +2137,10 @@ export default {
2135
2137
  {
2136
2138
  properties: {
2137
2139
  message: { type: 'string' },
2138
- type: { enum: ['no_card_on_encoder'], type: 'string' },
2140
+ type: {
2141
+ enum: ['no_credential_on_encoder'],
2142
+ type: 'string',
2143
+ },
2139
2144
  },
2140
2145
  required: ['type', 'message'],
2141
2146
  type: 'object',
@@ -2762,7 +2767,10 @@ export default {
2762
2767
  {
2763
2768
  properties: {
2764
2769
  message: { type: 'string' },
2765
- type: { enum: ['no_card_on_encoder'], type: 'string' },
2770
+ type: {
2771
+ enum: ['no_credential_on_encoder'],
2772
+ type: 'string',
2773
+ },
2766
2774
  },
2767
2775
  required: ['type', 'message'],
2768
2776
  type: 'object',
@@ -11660,6 +11668,7 @@ export default {
11660
11668
  'pti_access_level',
11661
11669
  'salto_ks_access_group',
11662
11670
  'brivo_group',
11671
+ 'salto_space_group',
11663
11672
  ],
11664
11673
  type: 'string',
11665
11674
  'x-deprecated': 'Use `external_type`.',
@@ -11692,6 +11701,7 @@ export default {
11692
11701
  'pti_access_level',
11693
11702
  'salto_ks_access_group',
11694
11703
  'brivo_group',
11704
+ 'salto_space_group',
11695
11705
  ],
11696
11706
  type: 'string',
11697
11707
  },
@@ -11792,6 +11802,7 @@ export default {
11792
11802
  'pti_access_level',
11793
11803
  'salto_ks_access_group',
11794
11804
  'brivo_group',
11805
+ 'salto_space_group',
11795
11806
  ],
11796
11807
  type: 'string',
11797
11808
  'x-deprecated': 'Use `external_type`.',
@@ -11824,6 +11835,7 @@ export default {
11824
11835
  'pti_access_level',
11825
11836
  'salto_ks_access_group',
11826
11837
  'brivo_group',
11838
+ 'salto_space_group',
11827
11839
  ],
11828
11840
  type: 'string',
11829
11841
  },
@@ -13600,7 +13612,7 @@ export default {
13600
13612
  'x-fern-sdk-method-name': 'encode_credential',
13601
13613
  'x-fern-sdk-return-value': 'action_attempt',
13602
13614
  'x-response-key': 'action_attempt',
13603
- 'x-undocumented': 'Encoding a card is currently unimplemented.',
13615
+ 'x-undocumented': 'Encoders are in alpha.',
13604
13616
  },
13605
13617
  },
13606
13618
  '/acs/encoders/list': {
@@ -13805,7 +13817,283 @@ export default {
13805
13817
  'x-fern-sdk-method-name': 'scan_credential',
13806
13818
  'x-fern-sdk-return-value': 'action_attempt',
13807
13819
  'x-response-key': 'action_attempt',
13808
- 'x-undocumented': 'Reading a card is currently unimplemented.',
13820
+ 'x-undocumented': 'Encoders are in alpha.',
13821
+ },
13822
+ },
13823
+ '/acs/encoders/simulate/next_credential_encode_will_fail': {
13824
+ post: {
13825
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillFailPost',
13826
+ requestBody: {
13827
+ content: {
13828
+ 'application/json': {
13829
+ schema: {
13830
+ oneOf: [
13831
+ {
13832
+ additionalProperties: false,
13833
+ properties: {
13834
+ acs_encoder_id: { format: 'uuid', type: 'string' },
13835
+ error_code: {
13836
+ default: 'no_credential_on_encoder',
13837
+ enum: ['no_credential_on_encoder'],
13838
+ type: 'string',
13839
+ },
13840
+ },
13841
+ required: ['acs_encoder_id'],
13842
+ type: 'object',
13843
+ },
13844
+ {
13845
+ additionalProperties: false,
13846
+ properties: {
13847
+ acs_credential_id: { format: 'uuid', type: 'string' },
13848
+ acs_encoder_id: { format: 'uuid', type: 'string' },
13849
+ error_code: {
13850
+ enum: ['uncategorized_error', 'action_attempt_expired'],
13851
+ type: 'string',
13852
+ },
13853
+ },
13854
+ required: ['acs_encoder_id', 'error_code'],
13855
+ type: 'object',
13856
+ },
13857
+ ],
13858
+ },
13859
+ },
13860
+ },
13861
+ },
13862
+ responses: {
13863
+ 200: {
13864
+ content: {
13865
+ 'application/json': {
13866
+ schema: {
13867
+ properties: { ok: { type: 'boolean' } },
13868
+ required: ['ok'],
13869
+ type: 'object',
13870
+ },
13871
+ },
13872
+ },
13873
+ description: 'OK',
13874
+ },
13875
+ 400: { description: 'Bad Request' },
13876
+ 401: { description: 'Unauthorized' },
13877
+ },
13878
+ security: [
13879
+ { api_key: [] },
13880
+ { pat_with_workspace: [] },
13881
+ { console_session_with_workspace: [] },
13882
+ ],
13883
+ summary: '/acs/encoders/simulate/next_credential_encode_will_fail',
13884
+ tags: ['/acs'],
13885
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
13886
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_fail',
13887
+ 'x-response-key': null,
13888
+ 'x-undocumented': 'Encoder simulations are in alpha.',
13889
+ },
13890
+ },
13891
+ '/acs/encoders/simulate/next_credential_encode_will_succeed': {
13892
+ post: {
13893
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillSucceedPost',
13894
+ requestBody: {
13895
+ content: {
13896
+ 'application/json': {
13897
+ schema: {
13898
+ additionalProperties: false,
13899
+ properties: {
13900
+ acs_encoder_id: { format: 'uuid', type: 'string' },
13901
+ scenario: {
13902
+ default: 'credential_is_issued',
13903
+ enum: ['credential_is_issued'],
13904
+ type: 'string',
13905
+ },
13906
+ },
13907
+ required: ['acs_encoder_id'],
13908
+ type: 'object',
13909
+ },
13910
+ },
13911
+ },
13912
+ },
13913
+ responses: {
13914
+ 200: {
13915
+ content: {
13916
+ 'application/json': {
13917
+ schema: {
13918
+ properties: { ok: { type: 'boolean' } },
13919
+ required: ['ok'],
13920
+ type: 'object',
13921
+ },
13922
+ },
13923
+ },
13924
+ description: 'OK',
13925
+ },
13926
+ 400: { description: 'Bad Request' },
13927
+ 401: { description: 'Unauthorized' },
13928
+ },
13929
+ security: [
13930
+ { api_key: [] },
13931
+ { pat_with_workspace: [] },
13932
+ { console_session_with_workspace: [] },
13933
+ ],
13934
+ summary: '/acs/encoders/simulate/next_credential_encode_will_succeed',
13935
+ tags: ['/acs'],
13936
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
13937
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_succeed',
13938
+ 'x-response-key': null,
13939
+ 'x-undocumented': 'Encoder simulations are in alpha.',
13940
+ },
13941
+ },
13942
+ '/acs/encoders/simulate/next_credential_scan_will_fail': {
13943
+ post: {
13944
+ operationId: 'acsEncodersSimulateNextCredentialScanWillFailPost',
13945
+ requestBody: {
13946
+ content: {
13947
+ 'application/json': {
13948
+ schema: {
13949
+ oneOf: [
13950
+ {
13951
+ additionalProperties: false,
13952
+ properties: {
13953
+ acs_encoder_id: { format: 'uuid', type: 'string' },
13954
+ error_code: {
13955
+ default: 'no_credential_on_encoder',
13956
+ enum: ['no_credential_on_encoder'],
13957
+ type: 'string',
13958
+ },
13959
+ },
13960
+ required: ['acs_encoder_id'],
13961
+ type: 'object',
13962
+ },
13963
+ {
13964
+ additionalProperties: false,
13965
+ properties: {
13966
+ acs_credential_id_on_seam: {
13967
+ format: 'uuid',
13968
+ type: 'string',
13969
+ },
13970
+ acs_encoder_id: { format: 'uuid', type: 'string' },
13971
+ error_code: {
13972
+ enum: ['uncategorized_error', 'action_attempt_expired'],
13973
+ type: 'string',
13974
+ },
13975
+ },
13976
+ required: ['acs_encoder_id', 'error_code'],
13977
+ type: 'object',
13978
+ },
13979
+ ],
13980
+ },
13981
+ },
13982
+ },
13983
+ },
13984
+ responses: {
13985
+ 200: {
13986
+ content: {
13987
+ 'application/json': {
13988
+ schema: {
13989
+ properties: { ok: { type: 'boolean' } },
13990
+ required: ['ok'],
13991
+ type: 'object',
13992
+ },
13993
+ },
13994
+ },
13995
+ description: 'OK',
13996
+ },
13997
+ 400: { description: 'Bad Request' },
13998
+ 401: { description: 'Unauthorized' },
13999
+ },
14000
+ security: [
14001
+ { api_key: [] },
14002
+ { pat_with_workspace: [] },
14003
+ { console_session_with_workspace: [] },
14004
+ ],
14005
+ summary: '/acs/encoders/simulate/next_credential_scan_will_fail',
14006
+ tags: ['/acs'],
14007
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14008
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_fail',
14009
+ 'x-response-key': null,
14010
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14011
+ },
14012
+ },
14013
+ '/acs/encoders/simulate/next_credential_scan_will_succeed': {
14014
+ post: {
14015
+ operationId: 'acsEncodersSimulateNextCredentialScanWillSucceedPost',
14016
+ requestBody: {
14017
+ content: {
14018
+ 'application/json': {
14019
+ schema: {
14020
+ oneOf: [
14021
+ {
14022
+ additionalProperties: false,
14023
+ properties: {
14024
+ acs_credential_id_on_seam: {
14025
+ format: 'uuid',
14026
+ type: 'string',
14027
+ },
14028
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14029
+ scenario: {
14030
+ default: 'credential_exists_on_seam',
14031
+ enum: [
14032
+ 'credential_exists_on_seam',
14033
+ 'credential_on_encoder_needs_update',
14034
+ ],
14035
+ type: 'string',
14036
+ },
14037
+ },
14038
+ required: ['acs_encoder_id'],
14039
+ type: 'object',
14040
+ },
14041
+ {
14042
+ additionalProperties: false,
14043
+ properties: {
14044
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14045
+ scenario: {
14046
+ enum: ['credential_does_not_exist_on_seam'],
14047
+ type: 'string',
14048
+ },
14049
+ },
14050
+ required: ['acs_encoder_id', 'scenario'],
14051
+ type: 'object',
14052
+ },
14053
+ {
14054
+ additionalProperties: false,
14055
+ properties: {
14056
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14057
+ scenario: {
14058
+ enum: ['credential_on_encoder_is_empty'],
14059
+ type: 'string',
14060
+ },
14061
+ },
14062
+ required: ['acs_encoder_id', 'scenario'],
14063
+ type: 'object',
14064
+ },
14065
+ ],
14066
+ },
14067
+ },
14068
+ },
14069
+ },
14070
+ responses: {
14071
+ 200: {
14072
+ content: {
14073
+ 'application/json': {
14074
+ schema: {
14075
+ properties: { ok: { type: 'boolean' } },
14076
+ required: ['ok'],
14077
+ type: 'object',
14078
+ },
14079
+ },
14080
+ },
14081
+ description: 'OK',
14082
+ },
14083
+ 400: { description: 'Bad Request' },
14084
+ 401: { description: 'Unauthorized' },
14085
+ },
14086
+ security: [
14087
+ { api_key: [] },
14088
+ { pat_with_workspace: [] },
14089
+ { console_session_with_workspace: [] },
14090
+ ],
14091
+ summary: '/acs/encoders/simulate/next_credential_scan_will_succeed',
14092
+ tags: ['/acs'],
14093
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14094
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_succeed',
14095
+ 'x-response-key': null,
14096
+ 'x-undocumented': 'Encoder simulations are in alpha.',
13809
14097
  },
13810
14098
  },
13811
14099
  '/acs/entrances/get': {