@seamapi/types 1.401.0 → 1.403.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.
Files changed (34) hide show
  1. package/dist/connect.cjs +652 -12
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +839 -69
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -2
  8. package/lib/seam/connect/models/devices/device-provider.js +2 -1
  9. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  10. package/lib/seam/connect/models/index.d.ts +1 -0
  11. package/lib/seam/connect/models/index.js +1 -0
  12. package/lib/seam/connect/models/index.js.map +1 -1
  13. package/lib/seam/connect/models/phones/index.d.ts +2 -0
  14. package/lib/seam/connect/models/phones/index.js +3 -0
  15. package/lib/seam/connect/models/phones/index.js.map +1 -0
  16. package/lib/seam/connect/models/phones/phone-registration.d.ts +18 -0
  17. package/lib/seam/connect/models/phones/phone-registration.js +13 -0
  18. package/lib/seam/connect/models/phones/phone-registration.js.map +1 -0
  19. package/lib/seam/connect/models/phones/phone-session.d.ts +2060 -0
  20. package/lib/seam/connect/models/phones/phone-session.js +21 -0
  21. package/lib/seam/connect/models/phones/phone-session.js.map +1 -0
  22. package/lib/seam/connect/openapi.d.ts +561 -0
  23. package/lib/seam/connect/openapi.js +648 -9
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +215 -6
  26. package/package.json +2 -2
  27. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  28. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
  29. package/src/lib/seam/connect/models/index.ts +1 -0
  30. package/src/lib/seam/connect/models/phones/index.ts +2 -0
  31. package/src/lib/seam/connect/models/phones/phone-registration.ts +15 -0
  32. package/src/lib/seam/connect/models/phones/phone-session.ts +27 -0
  33. package/src/lib/seam/connect/openapi.ts +715 -9
  34. package/src/lib/seam/connect/route-types.ts +269 -6
@@ -29842,6 +29842,475 @@ declare const _default: {
29842
29842
  type: string;
29843
29843
  'x-route-path': string;
29844
29844
  };
29845
+ phone_registration: {
29846
+ properties: {
29847
+ is_being_activated: {
29848
+ type: string;
29849
+ };
29850
+ phone_registration_id: {
29851
+ type: string;
29852
+ };
29853
+ provider_name: {
29854
+ nullable: boolean;
29855
+ type: string;
29856
+ };
29857
+ provider_state: {};
29858
+ };
29859
+ required: string[];
29860
+ type: string;
29861
+ 'x-route-path': string;
29862
+ 'x-undocumented': string;
29863
+ };
29864
+ phone_session: {
29865
+ properties: {
29866
+ provider_sessions: {
29867
+ items: {
29868
+ properties: {
29869
+ acs_credentials: {
29870
+ items: {
29871
+ description: string;
29872
+ properties: {
29873
+ access_method: {
29874
+ description: string;
29875
+ enum: string[];
29876
+ type: string;
29877
+ };
29878
+ acs_credential_id: {
29879
+ description: string;
29880
+ format: string;
29881
+ type: string;
29882
+ };
29883
+ acs_credential_pool_id: {
29884
+ format: string;
29885
+ type: string;
29886
+ };
29887
+ acs_entrances: {
29888
+ items: {
29889
+ description: string;
29890
+ properties: {
29891
+ acs_entrance_id: {
29892
+ description: string;
29893
+ format: string;
29894
+ type: string;
29895
+ };
29896
+ acs_system_id: {
29897
+ description: string;
29898
+ format: string;
29899
+ type: string;
29900
+ };
29901
+ assa_abloy_vostio_metadata: {
29902
+ description: string;
29903
+ properties: {
29904
+ door_name: {
29905
+ type: string;
29906
+ };
29907
+ door_number: {
29908
+ format: string;
29909
+ type: string;
29910
+ };
29911
+ door_type: {
29912
+ enum: string[];
29913
+ type: string;
29914
+ };
29915
+ pms_id: {
29916
+ type: string;
29917
+ };
29918
+ stand_open: {
29919
+ type: string;
29920
+ };
29921
+ };
29922
+ required: string[];
29923
+ type: string;
29924
+ };
29925
+ created_at: {
29926
+ description: string;
29927
+ format: string;
29928
+ type: string;
29929
+ };
29930
+ display_name: {
29931
+ description: string;
29932
+ type: string;
29933
+ };
29934
+ dormakaba_community_metadata: {
29935
+ description: string;
29936
+ properties: {
29937
+ access_point_name: {
29938
+ type: string;
29939
+ };
29940
+ };
29941
+ required: string[];
29942
+ type: string;
29943
+ };
29944
+ errors: {
29945
+ description: string;
29946
+ items: {
29947
+ properties: {
29948
+ error_code: {
29949
+ description: string;
29950
+ type: string;
29951
+ };
29952
+ message: {
29953
+ description: string;
29954
+ type: string;
29955
+ };
29956
+ };
29957
+ required: string[];
29958
+ type: string;
29959
+ };
29960
+ type: string;
29961
+ };
29962
+ latch_metadata: {
29963
+ description: string;
29964
+ properties: {
29965
+ accessibility_type: {
29966
+ type: string;
29967
+ };
29968
+ door_name: {
29969
+ type: string;
29970
+ };
29971
+ door_type: {
29972
+ type: string;
29973
+ };
29974
+ is_connected: {
29975
+ type: string;
29976
+ };
29977
+ };
29978
+ required: string[];
29979
+ type: string;
29980
+ };
29981
+ salto_ks_metadata: {
29982
+ description: string;
29983
+ properties: {
29984
+ battery_level: {
29985
+ type: string;
29986
+ };
29987
+ door_name: {
29988
+ type: string;
29989
+ };
29990
+ intrusion_alarm: {
29991
+ type: string;
29992
+ };
29993
+ left_open_alarm: {
29994
+ type: string;
29995
+ };
29996
+ lock_type: {
29997
+ type: string;
29998
+ };
29999
+ locked_state: {
30000
+ type: string;
30001
+ };
30002
+ online: {
30003
+ type: string;
30004
+ };
30005
+ privacy_mode: {
30006
+ type: string;
30007
+ };
30008
+ };
30009
+ required: string[];
30010
+ type: string;
30011
+ };
30012
+ salto_space_metadata: {
30013
+ description: string;
30014
+ properties: {
30015
+ door_description: {
30016
+ type: string;
30017
+ };
30018
+ door_name: {
30019
+ type: string;
30020
+ };
30021
+ ext_door_id: {
30022
+ type: string;
30023
+ };
30024
+ };
30025
+ required: string[];
30026
+ type: string;
30027
+ };
30028
+ visionline_metadata: {
30029
+ description: string;
30030
+ properties: {
30031
+ door_category: {
30032
+ enum: string[];
30033
+ type: string;
30034
+ };
30035
+ door_name: {
30036
+ type: string;
30037
+ };
30038
+ profiles: {
30039
+ items: {
30040
+ properties: {
30041
+ visionline_door_profile_id: {
30042
+ type: string;
30043
+ };
30044
+ visionline_door_profile_type: {
30045
+ enum: string[];
30046
+ type: string;
30047
+ };
30048
+ };
30049
+ required: string[];
30050
+ type: string;
30051
+ };
30052
+ type: string;
30053
+ };
30054
+ };
30055
+ required: string[];
30056
+ type: string;
30057
+ };
30058
+ };
30059
+ required: string[];
30060
+ type: string;
30061
+ 'x-route-path': string;
30062
+ };
30063
+ type: string;
30064
+ };
30065
+ acs_system_id: {
30066
+ description: string;
30067
+ format: string;
30068
+ type: string;
30069
+ };
30070
+ acs_user_id: {
30071
+ description: string;
30072
+ format: string;
30073
+ type: string;
30074
+ };
30075
+ assa_abloy_vostio_metadata: {
30076
+ description: string;
30077
+ properties: {
30078
+ auto_join: {
30079
+ type: string;
30080
+ };
30081
+ door_names: {
30082
+ items: {
30083
+ type: string;
30084
+ };
30085
+ type: string;
30086
+ };
30087
+ endpoint_id: {
30088
+ type: string;
30089
+ };
30090
+ key_id: {
30091
+ type: string;
30092
+ };
30093
+ key_issuing_request_id: {
30094
+ type: string;
30095
+ };
30096
+ override_guest_acs_entrance_ids: {
30097
+ items: {
30098
+ type: string;
30099
+ };
30100
+ type: string;
30101
+ };
30102
+ };
30103
+ type: string;
30104
+ };
30105
+ card_number: {
30106
+ description: string;
30107
+ nullable: boolean;
30108
+ type: string;
30109
+ };
30110
+ code: {
30111
+ description: string;
30112
+ nullable: boolean;
30113
+ type: string;
30114
+ };
30115
+ created_at: {
30116
+ description: string;
30117
+ format: string;
30118
+ type: string;
30119
+ };
30120
+ display_name: {
30121
+ description: string;
30122
+ minLength: number;
30123
+ type: string;
30124
+ };
30125
+ ends_at: {
30126
+ description: string;
30127
+ type: string;
30128
+ };
30129
+ errors: {
30130
+ description: string;
30131
+ items: {
30132
+ properties: {
30133
+ error_code: {
30134
+ type: string;
30135
+ };
30136
+ message: {
30137
+ type: string;
30138
+ };
30139
+ };
30140
+ required: string[];
30141
+ type: string;
30142
+ };
30143
+ type: string;
30144
+ };
30145
+ external_type: {
30146
+ description: string;
30147
+ enum: string[];
30148
+ type: string;
30149
+ };
30150
+ external_type_display_name: {
30151
+ description: string;
30152
+ type: string;
30153
+ };
30154
+ is_issued: {
30155
+ description: string;
30156
+ type: string;
30157
+ };
30158
+ is_latest_desired_state_synced_with_provider: {
30159
+ description: string;
30160
+ nullable: boolean;
30161
+ type: string;
30162
+ };
30163
+ is_managed: {
30164
+ enum: boolean[];
30165
+ type: string;
30166
+ };
30167
+ is_multi_phone_sync_credential: {
30168
+ description: string;
30169
+ type: string;
30170
+ };
30171
+ is_one_time_use: {
30172
+ description: string;
30173
+ type: string;
30174
+ };
30175
+ issued_at: {
30176
+ description: string;
30177
+ format: string;
30178
+ nullable: boolean;
30179
+ type: string;
30180
+ };
30181
+ latest_desired_state_synced_with_provider_at: {
30182
+ description: string;
30183
+ format: string;
30184
+ nullable: boolean;
30185
+ type: string;
30186
+ };
30187
+ parent_acs_credential_id: {
30188
+ description: string;
30189
+ format: string;
30190
+ type: string;
30191
+ };
30192
+ starts_at: {
30193
+ description: string;
30194
+ type: string;
30195
+ };
30196
+ visionline_metadata: {
30197
+ description: string;
30198
+ properties: {
30199
+ auto_join: {
30200
+ type: string;
30201
+ };
30202
+ card_function_type: {
30203
+ enum: string[];
30204
+ type: string;
30205
+ };
30206
+ card_id: {
30207
+ type: string;
30208
+ };
30209
+ common_acs_entrance_ids: {
30210
+ items: {
30211
+ format: string;
30212
+ type: string;
30213
+ };
30214
+ type: string;
30215
+ };
30216
+ credential_id: {
30217
+ type: string;
30218
+ };
30219
+ guest_acs_entrance_ids: {
30220
+ items: {
30221
+ format: string;
30222
+ type: string;
30223
+ };
30224
+ type: string;
30225
+ };
30226
+ is_valid: {
30227
+ type: string;
30228
+ };
30229
+ joiner_acs_credential_ids: {
30230
+ items: {
30231
+ format: string;
30232
+ type: string;
30233
+ };
30234
+ type: string;
30235
+ };
30236
+ };
30237
+ required: string[];
30238
+ type: string;
30239
+ };
30240
+ warnings: {
30241
+ description: string;
30242
+ items: {
30243
+ description: string;
30244
+ discriminator: {
30245
+ propertyName: string;
30246
+ };
30247
+ oneOf: {
30248
+ description: string;
30249
+ properties: {
30250
+ created_at: {
30251
+ description: string;
30252
+ format: string;
30253
+ type: string;
30254
+ };
30255
+ message: {
30256
+ description: string;
30257
+ type: string;
30258
+ };
30259
+ warning_code: {
30260
+ description: string;
30261
+ enum: string[];
30262
+ type: string;
30263
+ };
30264
+ };
30265
+ required: string[];
30266
+ type: string;
30267
+ }[];
30268
+ };
30269
+ type: string;
30270
+ };
30271
+ workspace_id: {
30272
+ description: string;
30273
+ format: string;
30274
+ type: string;
30275
+ };
30276
+ };
30277
+ required: string[];
30278
+ type: string;
30279
+ 'x-route-path': string;
30280
+ };
30281
+ type: string;
30282
+ };
30283
+ phone_registration: {
30284
+ properties: {
30285
+ is_being_activated: {
30286
+ type: string;
30287
+ };
30288
+ phone_registration_id: {
30289
+ type: string;
30290
+ };
30291
+ provider_name: {
30292
+ nullable: boolean;
30293
+ type: string;
30294
+ };
30295
+ provider_state: {};
30296
+ };
30297
+ required: string[];
30298
+ type: string;
30299
+ 'x-route-path': string;
30300
+ 'x-undocumented': string;
30301
+ };
30302
+ };
30303
+ required: string[];
30304
+ type: string;
30305
+ };
30306
+ type: string;
30307
+ };
30308
+ };
30309
+ required: string[];
30310
+ type: string;
30311
+ 'x-route-path': string;
30312
+ 'x-undocumented': string;
30313
+ };
29845
30314
  thermostat_schedule: {
29846
30315
  description: string;
29847
30316
  properties: {
@@ -35415,6 +35884,11 @@ declare const _default: {
35415
35884
  format: string;
35416
35885
  type: string;
35417
35886
  };
35887
+ user_identity_id: {
35888
+ description: string;
35889
+ format: string;
35890
+ type: string;
35891
+ };
35418
35892
  };
35419
35893
  required: string[];
35420
35894
  type: string;
@@ -35486,6 +35960,11 @@ declare const _default: {
35486
35960
  format: string;
35487
35961
  type: string;
35488
35962
  };
35963
+ user_identity_id: {
35964
+ description: string;
35965
+ format: string;
35966
+ type: string;
35967
+ };
35489
35968
  };
35490
35969
  required: string[];
35491
35970
  type: string;
@@ -36766,6 +37245,11 @@ declare const _default: {
36766
37245
  format: string;
36767
37246
  type: string;
36768
37247
  };
37248
+ user_identity_id: {
37249
+ description: string;
37250
+ format: string;
37251
+ type: string;
37252
+ };
36769
37253
  };
36770
37254
  required: string[];
36771
37255
  type: string;
@@ -44682,60 +45166,120 @@ declare const _default: {
44682
45166
  }[];
44683
45167
  summary: string;
44684
45168
  tags: never[];
44685
- 'x-fern-ignore': boolean;
45169
+ 'x-fern-ignore': boolean;
45170
+ 'x-response-key': string;
45171
+ 'x-title': string;
45172
+ 'x-undocumented': string;
45173
+ };
45174
+ post: {
45175
+ description: string;
45176
+ operationId: string;
45177
+ responses: {
45178
+ 200: {
45179
+ content: {
45180
+ 'application/json': {
45181
+ schema: {
45182
+ properties: {
45183
+ bridge_connected_systems: {
45184
+ items: {
45185
+ properties: {
45186
+ acs_system_display_name: {
45187
+ type: string;
45188
+ };
45189
+ acs_system_id: {
45190
+ format: string;
45191
+ type: string;
45192
+ };
45193
+ bridge_created_at: {
45194
+ format: string;
45195
+ type: string;
45196
+ };
45197
+ bridge_id: {
45198
+ format: string;
45199
+ type: string;
45200
+ };
45201
+ connected_account_created_at: {
45202
+ format: string;
45203
+ type: string;
45204
+ };
45205
+ connected_account_id: {
45206
+ format: string;
45207
+ type: string;
45208
+ };
45209
+ workspace_display_name: {
45210
+ type: string;
45211
+ };
45212
+ workspace_id: {
45213
+ format: string;
45214
+ type: string;
45215
+ };
45216
+ };
45217
+ required: string[];
45218
+ type: string;
45219
+ 'x-route-path': string;
45220
+ 'x-undocumented': string;
45221
+ };
45222
+ type: string;
45223
+ };
45224
+ ok: {
45225
+ type: string;
45226
+ };
45227
+ };
45228
+ required: string[];
45229
+ type: string;
45230
+ };
45231
+ };
45232
+ };
45233
+ description: string;
45234
+ };
45235
+ 400: {
45236
+ description: string;
45237
+ };
45238
+ 401: {
45239
+ description: string;
45240
+ };
45241
+ };
45242
+ security: {
45243
+ bridge_client_session: never[];
45244
+ }[];
45245
+ summary: string;
45246
+ tags: never[];
45247
+ 'x-fern-sdk-group-name': string[];
45248
+ 'x-fern-sdk-method-name': string;
45249
+ 'x-fern-sdk-return-value': string;
44686
45250
  'x-response-key': string;
44687
45251
  'x-title': string;
44688
45252
  'x-undocumented': string;
44689
45253
  };
45254
+ };
45255
+ '/seam/instant_key/v1/client_sessions/exchange_short_code': {
44690
45256
  post: {
44691
45257
  description: string;
44692
45258
  operationId: string;
45259
+ requestBody: {
45260
+ content: {
45261
+ 'application/json': {
45262
+ schema: {
45263
+ properties: {
45264
+ short_code: {
45265
+ description: string;
45266
+ type: string;
45267
+ };
45268
+ };
45269
+ required: string[];
45270
+ type: string;
45271
+ };
45272
+ };
45273
+ };
45274
+ };
44693
45275
  responses: {
44694
45276
  200: {
44695
45277
  content: {
44696
45278
  'application/json': {
44697
45279
  schema: {
44698
45280
  properties: {
44699
- bridge_connected_systems: {
44700
- items: {
44701
- properties: {
44702
- acs_system_display_name: {
44703
- type: string;
44704
- };
44705
- acs_system_id: {
44706
- format: string;
44707
- type: string;
44708
- };
44709
- bridge_created_at: {
44710
- format: string;
44711
- type: string;
44712
- };
44713
- bridge_id: {
44714
- format: string;
44715
- type: string;
44716
- };
44717
- connected_account_created_at: {
44718
- format: string;
44719
- type: string;
44720
- };
44721
- connected_account_id: {
44722
- format: string;
44723
- type: string;
44724
- };
44725
- workspace_display_name: {
44726
- type: string;
44727
- };
44728
- workspace_id: {
44729
- format: string;
44730
- type: string;
44731
- };
44732
- };
44733
- required: string[];
44734
- type: string;
44735
- 'x-route-path': string;
44736
- 'x-undocumented': string;
44737
- };
44738
- type: string;
45281
+ client_session: {
45282
+ $ref: string;
44739
45283
  };
44740
45284
  ok: {
44741
45285
  type: string;
@@ -44756,10 +45300,10 @@ declare const _default: {
44756
45300
  };
44757
45301
  };
44758
45302
  security: {
44759
- bridge_client_session: never[];
45303
+ certified_client: never[];
44760
45304
  }[];
44761
45305
  summary: string;
44762
- tags: never[];
45306
+ tags: string[];
44763
45307
  'x-fern-sdk-group-name': string[];
44764
45308
  'x-fern-sdk-method-name': string;
44765
45309
  'x-fern-sdk-return-value': string;
@@ -44768,7 +45312,7 @@ declare const _default: {
44768
45312
  'x-undocumented': string;
44769
45313
  };
44770
45314
  };
44771
- '/seam/instant_key/v1/client_sessions/exchange_short_code': {
45315
+ '/seam/mobile_sdk/v1/acs/credentials/list': {
44772
45316
  post: {
44773
45317
  description: string;
44774
45318
  operationId: string;
@@ -44776,13 +45320,7 @@ declare const _default: {
44776
45320
  content: {
44777
45321
  'application/json': {
44778
45322
  schema: {
44779
- properties: {
44780
- short_code: {
44781
- description: string;
44782
- type: string;
44783
- };
44784
- };
44785
- required: string[];
45323
+ properties: {};
44786
45324
  type: string;
44787
45325
  };
44788
45326
  };
@@ -44794,8 +45332,11 @@ declare const _default: {
44794
45332
  'application/json': {
44795
45333
  schema: {
44796
45334
  properties: {
44797
- client_session: {
44798
- $ref: string;
45335
+ acs_credentials: {
45336
+ items: {
45337
+ $ref: string;
45338
+ };
45339
+ type: string;
44799
45340
  };
44800
45341
  ok: {
44801
45342
  type: string;
@@ -44816,7 +45357,7 @@ declare const _default: {
44816
45357
  };
44817
45358
  };
44818
45359
  security: {
44819
- certified_client: never[];
45360
+ client_session: never[];
44820
45361
  }[];
44821
45362
  summary: string;
44822
45363
  tags: string[];
@@ -44828,7 +45369,7 @@ declare const _default: {
44828
45369
  'x-undocumented': string;
44829
45370
  };
44830
45371
  };
44831
- '/seam/mobile_sdk/v1/acs/credentials/list': {
45372
+ '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
44832
45373
  post: {
44833
45374
  description: string;
44834
45375
  operationId: string;
@@ -44836,7 +45377,30 @@ declare const _default: {
44836
45377
  content: {
44837
45378
  'application/json': {
44838
45379
  schema: {
44839
- properties: {};
45380
+ properties: {
45381
+ custom_sdk_installation_id: {
45382
+ type: string;
45383
+ };
45384
+ phone_device_metadata: {
45385
+ properties: {
45386
+ manufacturer: {
45387
+ type: string;
45388
+ };
45389
+ model: {
45390
+ type: string;
45391
+ };
45392
+ os_version: {
45393
+ type: string;
45394
+ };
45395
+ };
45396
+ type: string;
45397
+ };
45398
+ phone_os: {
45399
+ enum: string[];
45400
+ type: string;
45401
+ };
45402
+ };
45403
+ required: string[];
44840
45404
  type: string;
44841
45405
  };
44842
45406
  };
@@ -44848,15 +45412,12 @@ declare const _default: {
44848
45412
  'application/json': {
44849
45413
  schema: {
44850
45414
  properties: {
44851
- acs_credentials: {
44852
- items: {
44853
- $ref: string;
44854
- };
44855
- type: string;
44856
- };
44857
45415
  ok: {
44858
45416
  type: string;
44859
45417
  };
45418
+ phone_session: {
45419
+ $ref: string;
45420
+ };
44860
45421
  };
44861
45422
  required: string[];
44862
45423
  type: string;
@@ -44876,7 +45437,7 @@ declare const _default: {
44876
45437
  client_session: never[];
44877
45438
  }[];
44878
45439
  summary: string;
44879
- tags: string[];
45440
+ tags: never[];
44880
45441
  'x-fern-sdk-group-name': string[];
44881
45442
  'x-fern-sdk-method-name': string;
44882
45443
  'x-fern-sdk-return-value': string;
@@ -62956,8 +63517,10 @@ interface Routes {
62956
63517
  method: 'PATCH' | 'POST';
62957
63518
  queryParams: {};
62958
63519
  jsonBody: {
62959
- /** ID of the access system user from which you want to unassign a credential. */
62960
- acs_user_id: string;
63520
+ /** ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. */
63521
+ acs_user_id?: string | undefined;
63522
+ /** ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. */
63523
+ user_identity_id?: string | undefined;
62961
63524
  /** ID of the credential that you want to unassign from an access system user. */
62962
63525
  acs_credential_id: string;
62963
63526
  };
@@ -67093,8 +67656,10 @@ interface Routes {
67093
67656
  jsonBody: {
67094
67657
  /** ID of the entrance to which you want to grant an access system user access. */
67095
67658
  acs_entrance_id: string;
67096
- /** ID of the access system user to whom you want to grant access to an entrance. */
67097
- acs_user_id: string;
67659
+ /** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
67660
+ user_identity_id?: string | undefined;
67661
+ /** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
67662
+ acs_user_id?: string | undefined;
67098
67663
  };
67099
67664
  commonParams: {};
67100
67665
  formData: {};
@@ -90131,6 +90696,211 @@ interface Routes {
90131
90696
  }>;
90132
90697
  };
90133
90698
  };
90699
+ '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
90700
+ route: '/seam/mobile_sdk/v1/phone_sessions/get_or_create';
90701
+ method: 'POST';
90702
+ queryParams: {};
90703
+ jsonBody: {
90704
+ custom_sdk_installation_id: string;
90705
+ phone_os: 'ios' | 'android';
90706
+ phone_device_metadata?: {
90707
+ os_version?: string | undefined;
90708
+ manufacturer?: string | undefined;
90709
+ model?: string | undefined;
90710
+ } | undefined;
90711
+ };
90712
+ commonParams: {};
90713
+ formData: {};
90714
+ jsonResponse: {
90715
+ /** */
90716
+ phone_session: {
90717
+ provider_sessions: Array<{
90718
+ /** */
90719
+ phone_registration: {
90720
+ phone_registration_id: string;
90721
+ provider_state?: any;
90722
+ provider_name: string | null;
90723
+ is_being_activated: boolean;
90724
+ };
90725
+ acs_credentials: Array<{
90726
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90727
+ acs_credential_id: string;
90728
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
90729
+ acs_user_id?: string | undefined;
90730
+ acs_credential_pool_id?: string | undefined;
90731
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90732
+ acs_system_id: string;
90733
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90734
+ parent_acs_credential_id?: string | undefined;
90735
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
90736
+ display_name: string;
90737
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90738
+ code?: (string | undefined) | null;
90739
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
90740
+ is_one_time_use?: boolean | undefined;
90741
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90742
+ card_number?: (string | undefined) | null;
90743
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
90744
+ is_issued?: boolean | undefined;
90745
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
90746
+ issued_at?: (string | undefined) | null;
90747
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
90748
+ access_method: 'code' | 'card' | 'mobile_key';
90749
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
90750
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
90751
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
90752
+ external_type_display_name?: string | undefined;
90753
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
90754
+ created_at: string;
90755
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90756
+ workspace_id: string;
90757
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
90758
+ starts_at?: string | undefined;
90759
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
90760
+ ends_at?: string | undefined;
90761
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90762
+ errors: Array<{
90763
+ error_code: string;
90764
+ message: string;
90765
+ }>;
90766
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90767
+ warnings: Array<{
90768
+ /** Date and time at which Seam created the warning. */
90769
+ created_at: string;
90770
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90771
+ message: string;
90772
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90773
+ warning_code: 'waiting_to_be_issued';
90774
+ } | {
90775
+ /** Date and time at which Seam created the warning. */
90776
+ created_at: string;
90777
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90778
+ message: string;
90779
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90780
+ warning_code: 'schedule_externally_modified';
90781
+ } | {
90782
+ /** Date and time at which Seam created the warning. */
90783
+ created_at: string;
90784
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90785
+ message: string;
90786
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90787
+ warning_code: 'schedule_modified';
90788
+ } | {
90789
+ /** Date and time at which Seam created the warning. */
90790
+ created_at: string;
90791
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90792
+ message: string;
90793
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90794
+ warning_code: 'being_deleted';
90795
+ } | {
90796
+ /** Date and time at which Seam created the warning. */
90797
+ created_at: string;
90798
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90799
+ message: string;
90800
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90801
+ warning_code: 'unknown_issue_with_acs_credential';
90802
+ } | {
90803
+ /** Date and time at which Seam created the warning. */
90804
+ created_at: string;
90805
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90806
+ message: string;
90807
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90808
+ warning_code: 'needs_to_be_reissued';
90809
+ }>;
90810
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
90811
+ is_multi_phone_sync_credential?: boolean | undefined;
90812
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
90813
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
90814
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
90815
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
90816
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90817
+ visionline_metadata?: {
90818
+ card_function_type: 'guest' | 'staff';
90819
+ joiner_acs_credential_ids?: string[] | undefined;
90820
+ guest_acs_entrance_ids?: string[] | undefined;
90821
+ common_acs_entrance_ids?: string[] | undefined;
90822
+ is_valid?: boolean | undefined;
90823
+ auto_join?: boolean | undefined;
90824
+ card_id?: string | undefined;
90825
+ credential_id?: string | undefined;
90826
+ } | undefined;
90827
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90828
+ assa_abloy_vostio_metadata?: {
90829
+ auto_join?: boolean | undefined;
90830
+ override_guest_acs_entrance_ids?: string[] | undefined;
90831
+ key_id?: string | undefined;
90832
+ key_issuing_request_id?: string | undefined;
90833
+ door_names?: string[] | undefined;
90834
+ endpoint_id?: string | undefined;
90835
+ } | undefined;
90836
+ is_managed: true;
90837
+ acs_entrances: Array<{
90838
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90839
+ acs_system_id: string;
90840
+ /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90841
+ acs_entrance_id: string;
90842
+ /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
90843
+ created_at: string;
90844
+ /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90845
+ display_name: string;
90846
+ /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90847
+ errors: Array<{
90848
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90849
+ error_code: string;
90850
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90851
+ message: string;
90852
+ }>;
90853
+ /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90854
+ latch_metadata?: {
90855
+ accessibility_type: string;
90856
+ door_name: string;
90857
+ door_type: string;
90858
+ is_connected: boolean;
90859
+ } | undefined;
90860
+ /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90861
+ visionline_metadata?: {
90862
+ door_name: string;
90863
+ door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
90864
+ profiles?: Array<{
90865
+ visionline_door_profile_id: string;
90866
+ visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
90867
+ }> | undefined;
90868
+ } | undefined;
90869
+ /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90870
+ salto_ks_metadata?: {
90871
+ door_name: string;
90872
+ locked_state: string;
90873
+ lock_type: string;
90874
+ online?: boolean | undefined;
90875
+ battery_level: string;
90876
+ left_open_alarm?: boolean | undefined;
90877
+ intrusion_alarm?: boolean | undefined;
90878
+ privacy_mode?: boolean | undefined;
90879
+ } | undefined;
90880
+ /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90881
+ dormakaba_community_metadata?: {
90882
+ access_point_name: string;
90883
+ } | undefined;
90884
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90885
+ assa_abloy_vostio_metadata?: {
90886
+ door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
90887
+ door_name: string;
90888
+ door_number?: number | undefined;
90889
+ stand_open?: boolean | undefined;
90890
+ pms_id?: string | undefined;
90891
+ } | undefined;
90892
+ /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90893
+ salto_space_metadata?: {
90894
+ door_name: string;
90895
+ ext_door_id: string;
90896
+ door_description?: string | undefined;
90897
+ } | undefined;
90898
+ }>;
90899
+ }>;
90900
+ }>;
90901
+ };
90902
+ };
90903
+ };
90134
90904
  '/thermostats/activate_climate_preset': {
90135
90905
  route: '/thermostats/activate_climate_preset';
90136
90906
  method: 'POST';
@@ -92410,7 +93180,7 @@ interface Routes {
92410
93180
  /** ID of the thermostat device for which you want to create a daily program. */
92411
93181
  device_id: string;
92412
93182
  /** User-friendly name to identify the thermostat daily program. */
92413
- name?: string | undefined;
93183
+ name: string;
92414
93184
  /** Array of thermostat daily program periods. */
92415
93185
  periods: Array<{
92416
93186
  /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -92464,7 +93234,7 @@ interface Routes {
92464
93234
  /** ID of the thermostat daily program that you want to update. */
92465
93235
  thermostat_daily_program_id: string;
92466
93236
  /** User-friendly name to identify the thermostat daily program that you want to update. */
92467
- name?: string | undefined;
93237
+ name: string;
92468
93238
  /** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
92469
93239
  periods: Array<{
92470
93240
  /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */