@seamapi/types 1.401.0 → 1.402.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 (30) hide show
  1. package/dist/connect.cjs +638 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +834 -71
  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/index.d.ts +1 -0
  8. package/lib/seam/connect/models/index.js +1 -0
  9. package/lib/seam/connect/models/index.js.map +1 -1
  10. package/lib/seam/connect/models/phones/index.d.ts +2 -0
  11. package/lib/seam/connect/models/phones/index.js +3 -0
  12. package/lib/seam/connect/models/phones/index.js.map +1 -0
  13. package/lib/seam/connect/models/phones/phone-registration.d.ts +18 -0
  14. package/lib/seam/connect/models/phones/phone-registration.js +13 -0
  15. package/lib/seam/connect/models/phones/phone-registration.js.map +1 -0
  16. package/lib/seam/connect/models/phones/phone-session.d.ts +2060 -0
  17. package/lib/seam/connect/models/phones/phone-session.js +21 -0
  18. package/lib/seam/connect/models/phones/phone-session.js.map +1 -0
  19. package/lib/seam/connect/openapi.d.ts +556 -0
  20. package/lib/seam/connect/openapi.js +638 -4
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +209 -2
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  25. package/src/lib/seam/connect/models/index.ts +1 -0
  26. package/src/lib/seam/connect/models/phones/index.ts +2 -0
  27. package/src/lib/seam/connect/models/phones/phone-registration.ts +15 -0
  28. package/src/lib/seam/connect/models/phones/phone-session.ts +27 -0
  29. package/src/lib/seam/connect/openapi.ts +704 -4
  30. package/src/lib/seam/connect/route-types.ts +263 -2
@@ -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;
@@ -44601,15 +45080,93 @@ declare const _default: {
44601
45080
  }[];
44602
45081
  summary: string;
44603
45082
  tags: never[];
44604
- 'x-fern-sdk-group-name': string[];
44605
- 'x-fern-sdk-method-name': string;
44606
- 'x-response-key': null;
45083
+ 'x-fern-sdk-group-name': string[];
45084
+ 'x-fern-sdk-method-name': string;
45085
+ 'x-response-key': null;
45086
+ 'x-title': string;
45087
+ 'x-undocumented': string;
45088
+ };
45089
+ };
45090
+ '/seam/bridge/v1/bridge_connected_systems/list': {
45091
+ get: {
45092
+ description: string;
45093
+ operationId: string;
45094
+ responses: {
45095
+ 200: {
45096
+ content: {
45097
+ 'application/json': {
45098
+ schema: {
45099
+ properties: {
45100
+ bridge_connected_systems: {
45101
+ items: {
45102
+ properties: {
45103
+ acs_system_display_name: {
45104
+ type: string;
45105
+ };
45106
+ acs_system_id: {
45107
+ format: string;
45108
+ type: string;
45109
+ };
45110
+ bridge_created_at: {
45111
+ format: string;
45112
+ type: string;
45113
+ };
45114
+ bridge_id: {
45115
+ format: string;
45116
+ type: string;
45117
+ };
45118
+ connected_account_created_at: {
45119
+ format: string;
45120
+ type: string;
45121
+ };
45122
+ connected_account_id: {
45123
+ format: string;
45124
+ type: string;
45125
+ };
45126
+ workspace_display_name: {
45127
+ type: string;
45128
+ };
45129
+ workspace_id: {
45130
+ format: string;
45131
+ type: string;
45132
+ };
45133
+ };
45134
+ required: string[];
45135
+ type: string;
45136
+ 'x-route-path': string;
45137
+ 'x-undocumented': string;
45138
+ };
45139
+ type: string;
45140
+ };
45141
+ ok: {
45142
+ type: string;
45143
+ };
45144
+ };
45145
+ required: string[];
45146
+ type: string;
45147
+ };
45148
+ };
45149
+ };
45150
+ description: string;
45151
+ };
45152
+ 400: {
45153
+ description: string;
45154
+ };
45155
+ 401: {
45156
+ description: string;
45157
+ };
45158
+ };
45159
+ security: {
45160
+ bridge_client_session: never[];
45161
+ }[];
45162
+ summary: string;
45163
+ tags: never[];
45164
+ 'x-fern-ignore': boolean;
45165
+ 'x-response-key': string;
44607
45166
  'x-title': string;
44608
45167
  'x-undocumented': string;
44609
45168
  };
44610
- };
44611
- '/seam/bridge/v1/bridge_connected_systems/list': {
44612
- get: {
45169
+ post: {
44613
45170
  description: string;
44614
45171
  operationId: string;
44615
45172
  responses: {
@@ -44682,60 +45239,42 @@ declare const _default: {
44682
45239
  }[];
44683
45240
  summary: string;
44684
45241
  tags: never[];
44685
- 'x-fern-ignore': boolean;
45242
+ 'x-fern-sdk-group-name': string[];
45243
+ 'x-fern-sdk-method-name': string;
45244
+ 'x-fern-sdk-return-value': string;
44686
45245
  'x-response-key': string;
44687
45246
  'x-title': string;
44688
45247
  'x-undocumented': string;
44689
45248
  };
45249
+ };
45250
+ '/seam/instant_key/v1/client_sessions/exchange_short_code': {
44690
45251
  post: {
44691
45252
  description: string;
44692
45253
  operationId: string;
45254
+ requestBody: {
45255
+ content: {
45256
+ 'application/json': {
45257
+ schema: {
45258
+ properties: {
45259
+ short_code: {
45260
+ description: string;
45261
+ type: string;
45262
+ };
45263
+ };
45264
+ required: string[];
45265
+ type: string;
45266
+ };
45267
+ };
45268
+ };
45269
+ };
44693
45270
  responses: {
44694
45271
  200: {
44695
45272
  content: {
44696
45273
  'application/json': {
44697
45274
  schema: {
44698
45275
  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;
45276
+ client_session: {
45277
+ $ref: string;
44739
45278
  };
44740
45279
  ok: {
44741
45280
  type: string;
@@ -44756,10 +45295,10 @@ declare const _default: {
44756
45295
  };
44757
45296
  };
44758
45297
  security: {
44759
- bridge_client_session: never[];
45298
+ certified_client: never[];
44760
45299
  }[];
44761
45300
  summary: string;
44762
- tags: never[];
45301
+ tags: string[];
44763
45302
  'x-fern-sdk-group-name': string[];
44764
45303
  'x-fern-sdk-method-name': string;
44765
45304
  'x-fern-sdk-return-value': string;
@@ -44768,7 +45307,7 @@ declare const _default: {
44768
45307
  'x-undocumented': string;
44769
45308
  };
44770
45309
  };
44771
- '/seam/instant_key/v1/client_sessions/exchange_short_code': {
45310
+ '/seam/mobile_sdk/v1/acs/credentials/list': {
44772
45311
  post: {
44773
45312
  description: string;
44774
45313
  operationId: string;
@@ -44776,13 +45315,7 @@ declare const _default: {
44776
45315
  content: {
44777
45316
  'application/json': {
44778
45317
  schema: {
44779
- properties: {
44780
- short_code: {
44781
- description: string;
44782
- type: string;
44783
- };
44784
- };
44785
- required: string[];
45318
+ properties: {};
44786
45319
  type: string;
44787
45320
  };
44788
45321
  };
@@ -44794,8 +45327,11 @@ declare const _default: {
44794
45327
  'application/json': {
44795
45328
  schema: {
44796
45329
  properties: {
44797
- client_session: {
44798
- $ref: string;
45330
+ acs_credentials: {
45331
+ items: {
45332
+ $ref: string;
45333
+ };
45334
+ type: string;
44799
45335
  };
44800
45336
  ok: {
44801
45337
  type: string;
@@ -44816,7 +45352,7 @@ declare const _default: {
44816
45352
  };
44817
45353
  };
44818
45354
  security: {
44819
- certified_client: never[];
45355
+ client_session: never[];
44820
45356
  }[];
44821
45357
  summary: string;
44822
45358
  tags: string[];
@@ -44828,7 +45364,7 @@ declare const _default: {
44828
45364
  'x-undocumented': string;
44829
45365
  };
44830
45366
  };
44831
- '/seam/mobile_sdk/v1/acs/credentials/list': {
45367
+ '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
44832
45368
  post: {
44833
45369
  description: string;
44834
45370
  operationId: string;
@@ -44836,7 +45372,30 @@ declare const _default: {
44836
45372
  content: {
44837
45373
  'application/json': {
44838
45374
  schema: {
44839
- properties: {};
45375
+ properties: {
45376
+ custom_sdk_installation_id: {
45377
+ type: string;
45378
+ };
45379
+ phone_device_metadata: {
45380
+ properties: {
45381
+ manufacturer: {
45382
+ type: string;
45383
+ };
45384
+ model: {
45385
+ type: string;
45386
+ };
45387
+ os_version: {
45388
+ type: string;
45389
+ };
45390
+ };
45391
+ type: string;
45392
+ };
45393
+ phone_os: {
45394
+ enum: string[];
45395
+ type: string;
45396
+ };
45397
+ };
45398
+ required: string[];
44840
45399
  type: string;
44841
45400
  };
44842
45401
  };
@@ -44848,15 +45407,12 @@ declare const _default: {
44848
45407
  'application/json': {
44849
45408
  schema: {
44850
45409
  properties: {
44851
- acs_credentials: {
44852
- items: {
44853
- $ref: string;
44854
- };
44855
- type: string;
44856
- };
44857
45410
  ok: {
44858
45411
  type: string;
44859
45412
  };
45413
+ phone_session: {
45414
+ $ref: string;
45415
+ };
44860
45416
  };
44861
45417
  required: string[];
44862
45418
  type: string;
@@ -44876,7 +45432,7 @@ declare const _default: {
44876
45432
  client_session: never[];
44877
45433
  }[];
44878
45434
  summary: string;
44879
- tags: string[];
45435
+ tags: never[];
44880
45436
  'x-fern-sdk-group-name': string[];
44881
45437
  'x-fern-sdk-method-name': string;
44882
45438
  'x-fern-sdk-return-value': string;
@@ -62956,8 +63512,10 @@ interface Routes {
62956
63512
  method: 'PATCH' | 'POST';
62957
63513
  queryParams: {};
62958
63514
  jsonBody: {
62959
- /** ID of the access system user from which you want to unassign a credential. */
62960
- acs_user_id: string;
63515
+ /** 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. */
63516
+ acs_user_id?: string | undefined;
63517
+ /** 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. */
63518
+ user_identity_id?: string | undefined;
62961
63519
  /** ID of the credential that you want to unassign from an access system user. */
62962
63520
  acs_credential_id: string;
62963
63521
  };
@@ -90131,6 +90689,211 @@ interface Routes {
90131
90689
  }>;
90132
90690
  };
90133
90691
  };
90692
+ '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
90693
+ route: '/seam/mobile_sdk/v1/phone_sessions/get_or_create';
90694
+ method: 'POST';
90695
+ queryParams: {};
90696
+ jsonBody: {
90697
+ custom_sdk_installation_id: string;
90698
+ phone_os: 'ios' | 'android';
90699
+ phone_device_metadata?: {
90700
+ os_version?: string | undefined;
90701
+ manufacturer?: string | undefined;
90702
+ model?: string | undefined;
90703
+ } | undefined;
90704
+ };
90705
+ commonParams: {};
90706
+ formData: {};
90707
+ jsonResponse: {
90708
+ /** */
90709
+ phone_session: {
90710
+ provider_sessions: Array<{
90711
+ /** */
90712
+ phone_registration: {
90713
+ phone_registration_id: string;
90714
+ provider_state?: any;
90715
+ provider_name: string | null;
90716
+ is_being_activated: boolean;
90717
+ };
90718
+ acs_credentials: Array<{
90719
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90720
+ acs_credential_id: string;
90721
+ /** 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. */
90722
+ acs_user_id?: string | undefined;
90723
+ acs_credential_pool_id?: string | undefined;
90724
+ /** 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). */
90725
+ acs_system_id: string;
90726
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90727
+ parent_acs_credential_id?: string | undefined;
90728
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
90729
+ display_name: string;
90730
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90731
+ code?: (string | undefined) | null;
90732
+ /** 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. */
90733
+ is_one_time_use?: boolean | undefined;
90734
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90735
+ card_number?: (string | undefined) | null;
90736
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
90737
+ is_issued?: boolean | undefined;
90738
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
90739
+ issued_at?: (string | undefined) | null;
90740
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
90741
+ access_method: 'code' | 'card' | 'mobile_key';
90742
+ /** 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`. */
90743
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
90744
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
90745
+ external_type_display_name?: string | undefined;
90746
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
90747
+ created_at: string;
90748
+ /** 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). */
90749
+ workspace_id: string;
90750
+ /** 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. */
90751
+ starts_at?: string | undefined;
90752
+ /** 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`. */
90753
+ ends_at?: string | undefined;
90754
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90755
+ errors: Array<{
90756
+ error_code: string;
90757
+ message: string;
90758
+ }>;
90759
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90760
+ warnings: Array<{
90761
+ /** Date and time at which Seam created the warning. */
90762
+ created_at: string;
90763
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90764
+ message: string;
90765
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90766
+ warning_code: 'waiting_to_be_issued';
90767
+ } | {
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: 'schedule_externally_modified';
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_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: 'being_deleted';
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: 'unknown_issue_with_acs_credential';
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: 'needs_to_be_reissued';
90802
+ }>;
90803
+ /** 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). */
90804
+ is_multi_phone_sync_credential?: boolean | undefined;
90805
+ /** 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. */
90806
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
90807
+ /** 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. */
90808
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
90809
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90810
+ visionline_metadata?: {
90811
+ card_function_type: 'guest' | 'staff';
90812
+ joiner_acs_credential_ids?: string[] | undefined;
90813
+ guest_acs_entrance_ids?: string[] | undefined;
90814
+ common_acs_entrance_ids?: string[] | undefined;
90815
+ is_valid?: boolean | undefined;
90816
+ auto_join?: boolean | undefined;
90817
+ card_id?: string | undefined;
90818
+ credential_id?: string | undefined;
90819
+ } | undefined;
90820
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
90821
+ assa_abloy_vostio_metadata?: {
90822
+ auto_join?: boolean | undefined;
90823
+ override_guest_acs_entrance_ids?: string[] | undefined;
90824
+ key_id?: string | undefined;
90825
+ key_issuing_request_id?: string | undefined;
90826
+ door_names?: string[] | undefined;
90827
+ endpoint_id?: string | undefined;
90828
+ } | undefined;
90829
+ is_managed: true;
90830
+ acs_entrances: Array<{
90831
+ /** 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). */
90832
+ acs_system_id: string;
90833
+ /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90834
+ acs_entrance_id: string;
90835
+ /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
90836
+ created_at: string;
90837
+ /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90838
+ display_name: string;
90839
+ /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90840
+ errors: Array<{
90841
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90842
+ error_code: string;
90843
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90844
+ message: string;
90845
+ }>;
90846
+ /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90847
+ latch_metadata?: {
90848
+ accessibility_type: string;
90849
+ door_name: string;
90850
+ door_type: string;
90851
+ is_connected: boolean;
90852
+ } | undefined;
90853
+ /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90854
+ visionline_metadata?: {
90855
+ door_name: string;
90856
+ door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
90857
+ profiles?: Array<{
90858
+ visionline_door_profile_id: string;
90859
+ visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
90860
+ }> | undefined;
90861
+ } | undefined;
90862
+ /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90863
+ salto_ks_metadata?: {
90864
+ door_name: string;
90865
+ locked_state: string;
90866
+ lock_type: string;
90867
+ online?: boolean | undefined;
90868
+ battery_level: string;
90869
+ left_open_alarm?: boolean | undefined;
90870
+ intrusion_alarm?: boolean | undefined;
90871
+ privacy_mode?: boolean | undefined;
90872
+ } | undefined;
90873
+ /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90874
+ dormakaba_community_metadata?: {
90875
+ access_point_name: string;
90876
+ } | undefined;
90877
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90878
+ assa_abloy_vostio_metadata?: {
90879
+ door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
90880
+ door_name: string;
90881
+ door_number?: number | undefined;
90882
+ stand_open?: boolean | undefined;
90883
+ pms_id?: string | undefined;
90884
+ } | undefined;
90885
+ /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
90886
+ salto_space_metadata?: {
90887
+ door_name: string;
90888
+ ext_door_id: string;
90889
+ door_description?: string | undefined;
90890
+ } | undefined;
90891
+ }>;
90892
+ }>;
90893
+ }>;
90894
+ };
90895
+ };
90896
+ };
90134
90897
  '/thermostats/activate_climate_preset': {
90135
90898
  route: '/thermostats/activate_climate_preset';
90136
90899
  method: 'POST';