@seamapi/types 1.406.3 → 1.406.5

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 (10) hide show
  1. package/dist/connect.cjs +88 -37
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +45 -12
  4. package/lib/seam/connect/openapi.d.ts +24 -0
  5. package/lib/seam/connect/openapi.js +81 -30
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +21 -12
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +92 -30
  10. package/src/lib/seam/connect/route-types.ts +21 -12
package/dist/connect.d.cts CHANGED
@@ -42939,6 +42939,7 @@ declare const _default: {
42939
42939
  };
42940
42940
  '/locks/get': {
42941
42941
  post: {
42942
+ description: string;
42942
42943
  operationId: string;
42943
42944
  requestBody: {
42944
42945
  content: {
@@ -42946,10 +42947,12 @@ declare const _default: {
42946
42947
  schema: {
42947
42948
  properties: {
42948
42949
  device_id: {
42950
+ description: string;
42949
42951
  format: string;
42950
42952
  type: string;
42951
42953
  };
42952
42954
  name: {
42955
+ description: string;
42953
42956
  type: string;
42954
42957
  };
42955
42958
  };
@@ -43016,10 +43019,12 @@ declare const _default: {
43016
43019
  'x-fern-sdk-method-name': string;
43017
43020
  'x-fern-sdk-return-value': string;
43018
43021
  'x-response-key': string;
43022
+ 'x-title': string;
43019
43023
  };
43020
43024
  };
43021
43025
  '/locks/list': {
43022
43026
  post: {
43027
+ description: string;
43023
43028
  operationId: string;
43024
43029
  requestBody: {
43025
43030
  content: {
@@ -43199,10 +43204,12 @@ declare const _default: {
43199
43204
  'x-fern-sdk-method-name': string;
43200
43205
  'x-fern-sdk-return-value': string;
43201
43206
  'x-response-key': string;
43207
+ 'x-title': string;
43202
43208
  };
43203
43209
  };
43204
43210
  '/locks/lock_door': {
43205
43211
  post: {
43212
+ description: string;
43206
43213
  operationId: string;
43207
43214
  requestBody: {
43208
43215
  content: {
@@ -43210,12 +43217,14 @@ declare const _default: {
43210
43217
  schema: {
43211
43218
  properties: {
43212
43219
  device_id: {
43220
+ description: string;
43213
43221
  format: string;
43214
43222
  type: string;
43215
43223
  };
43216
43224
  sync: {
43217
43225
  default: boolean;
43218
43226
  type: string;
43227
+ 'x-undocumented': string;
43219
43228
  };
43220
43229
  };
43221
43230
  required: string[];
@@ -43279,10 +43288,12 @@ declare const _default: {
43279
43288
  'x-fern-sdk-method-name': string;
43280
43289
  'x-fern-sdk-return-value': string;
43281
43290
  'x-response-key': string;
43291
+ 'x-title': string;
43282
43292
  };
43283
43293
  };
43284
43294
  '/locks/simulate/keypad_code_entry': {
43285
43295
  post: {
43296
+ description: string;
43286
43297
  operationId: string;
43287
43298
  requestBody: {
43288
43299
  content: {
@@ -43290,9 +43301,11 @@ declare const _default: {
43290
43301
  schema: {
43291
43302
  properties: {
43292
43303
  code: {
43304
+ description: string;
43293
43305
  type: string;
43294
43306
  };
43295
43307
  device_id: {
43308
+ description: string;
43296
43309
  format: string;
43297
43310
  type: string;
43298
43311
  };
@@ -43355,6 +43368,7 @@ declare const _default: {
43355
43368
  };
43356
43369
  '/locks/simulate/manual_lock_via_keypad': {
43357
43370
  post: {
43371
+ description: string;
43358
43372
  operationId: string;
43359
43373
  requestBody: {
43360
43374
  content: {
@@ -43362,6 +43376,7 @@ declare const _default: {
43362
43376
  schema: {
43363
43377
  properties: {
43364
43378
  device_id: {
43379
+ description: string;
43365
43380
  format: string;
43366
43381
  type: string;
43367
43382
  };
@@ -43424,6 +43439,7 @@ declare const _default: {
43424
43439
  };
43425
43440
  '/locks/unlock_door': {
43426
43441
  post: {
43442
+ description: string;
43427
43443
  operationId: string;
43428
43444
  requestBody: {
43429
43445
  content: {
@@ -43431,12 +43447,14 @@ declare const _default: {
43431
43447
  schema: {
43432
43448
  properties: {
43433
43449
  device_id: {
43450
+ description: string;
43434
43451
  format: string;
43435
43452
  type: string;
43436
43453
  };
43437
43454
  sync: {
43438
43455
  default: boolean;
43439
43456
  type: string;
43457
+ 'x-undocumented': string;
43440
43458
  };
43441
43459
  };
43442
43460
  required: string[];
@@ -43500,6 +43518,7 @@ declare const _default: {
43500
43518
  'x-fern-sdk-method-name': string;
43501
43519
  'x-fern-sdk-return-value': string;
43502
43520
  'x-response-key': string;
43521
+ 'x-title': string;
43503
43522
  };
43504
43523
  };
43505
43524
  '/networks/get': {
@@ -43563,10 +43582,12 @@ declare const _default: {
43563
43582
  })[];
43564
43583
  summary: string;
43565
43584
  tags: string[];
43585
+ 'x-deprecated': string;
43566
43586
  'x-fern-sdk-group-name': string[];
43567
43587
  'x-fern-sdk-method-name': string;
43568
43588
  'x-fern-sdk-return-value': string;
43569
43589
  'x-response-key': string;
43590
+ 'x-undocumented': string;
43570
43591
  };
43571
43592
  };
43572
43593
  '/networks/list': {
@@ -43627,10 +43648,12 @@ declare const _default: {
43627
43648
  })[];
43628
43649
  summary: string;
43629
43650
  tags: string[];
43651
+ 'x-deprecated': string;
43630
43652
  'x-fern-sdk-group-name': string[];
43631
43653
  'x-fern-sdk-method-name': string;
43632
43654
  'x-fern-sdk-return-value': string;
43633
43655
  'x-response-key': string;
43656
+ 'x-undocumented': string;
43634
43657
  };
43635
43658
  };
43636
43659
  '/noise_sensors/list': {
@@ -51625,6 +51648,7 @@ declare const _default: {
51625
51648
  'x-fern-sdk-return-value': string;
51626
51649
  'x-response-key': string;
51627
51650
  'x-title': string;
51651
+ 'x-undocumented': string;
51628
51652
  };
51629
51653
  };
51630
51654
  '/unstable_partner/resources/push': {
@@ -54422,11 +54446,11 @@ interface Routes {
54422
54446
  common_code_key?: string | undefined;
54423
54447
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
54424
54448
  prefer_native_scheduling?: boolean | undefined;
54425
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
54449
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
54426
54450
  use_backup_access_code_pool?: boolean | undefined;
54427
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
54451
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
54428
54452
  allow_external_modification?: boolean | undefined;
54429
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
54453
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
54430
54454
  is_external_modification_allowed?: boolean | undefined;
54431
54455
  /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
54432
54456
  preferred_code_length?: number | undefined;
@@ -56030,11 +56054,11 @@ interface Routes {
56030
56054
  attempt_for_offline_device?: boolean;
56031
56055
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
56032
56056
  prefer_native_scheduling?: boolean | undefined;
56033
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
56057
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
56034
56058
  use_backup_access_code_pool?: boolean | undefined;
56035
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
56059
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
56036
56060
  allow_external_modification?: boolean | undefined;
56037
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
56061
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
56038
56062
  is_external_modification_allowed?: boolean | undefined;
56039
56063
  use_offline_access_code?: boolean | undefined;
56040
56064
  /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
@@ -62117,11 +62141,11 @@ interface Routes {
62117
62141
  attempt_for_offline_device?: boolean;
62118
62142
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
62119
62143
  prefer_native_scheduling?: boolean | undefined;
62120
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
62144
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
62121
62145
  use_backup_access_code_pool?: boolean | undefined;
62122
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
62146
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
62123
62147
  allow_external_modification?: boolean | undefined;
62124
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
62148
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
62125
62149
  is_external_modification_allowed?: boolean | undefined;
62126
62150
  /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
62127
62151
  preferred_code_length?: number | undefined;
@@ -79861,7 +79885,9 @@ interface Routes {
79861
79885
  queryParams: {};
79862
79886
  jsonBody: {};
79863
79887
  commonParams: {
79888
+ /** ID of the lock that you want to get. */
79864
79889
  device_id?: string | undefined;
79890
+ /** Name of the lock that you want to get. */
79865
79891
  name?: string | undefined;
79866
79892
  };
79867
79893
  formData: {};
@@ -82289,11 +82315,11 @@ interface Routes {
82289
82315
  connected_account_ids?: string[] | undefined;
82290
82316
  /** ID of the Connect Webview for which you want to list devices. */
82291
82317
  connect_webview_id?: string | undefined;
82292
- /** Device type by which to filter devices. */
82318
+ /** Device type of the locks that you want to list. */
82293
82319
  device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | undefined;
82294
- /** Array of device types by which to filter devices. */
82320
+ /** Device types of the locks that you want to list. */
82295
82321
  device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
82296
- /** Manufacturer by which to filter devices. */
82322
+ /** Manufacturer of the locks that you want to list. */
82297
82323
  manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'kwikset2' | 'smartthings') | undefined;
82298
82324
  /** Array of device IDs for which you want to list devices. */
82299
82325
  device_ids?: string[] | undefined;
@@ -84729,7 +84755,9 @@ interface Routes {
84729
84755
  method: 'POST';
84730
84756
  queryParams: {};
84731
84757
  jsonBody: {
84758
+ /** ID of the lock that you want to lock. */
84732
84759
  device_id: string;
84760
+ /** */
84733
84761
  sync?: boolean;
84734
84762
  };
84735
84763
  commonParams: {};
@@ -85845,7 +85873,9 @@ interface Routes {
85845
85873
  method: 'POST';
85846
85874
  queryParams: {};
85847
85875
  jsonBody: {
85876
+ /** ID of the device for which you want to simulate a keypad code entry. */
85848
85877
  device_id: string;
85878
+ /** Code that you want to simulate entering on a keypad. */
85849
85879
  code: string;
85850
85880
  };
85851
85881
  commonParams: {};
@@ -86961,6 +86991,7 @@ interface Routes {
86961
86991
  method: 'POST';
86962
86992
  queryParams: {};
86963
86993
  jsonBody: {
86994
+ /** ID of the device for which you want to simulate a manual lock action using a keypad. */
86964
86995
  device_id: string;
86965
86996
  };
86966
86997
  commonParams: {};
@@ -88076,7 +88107,9 @@ interface Routes {
88076
88107
  method: 'POST';
88077
88108
  queryParams: {};
88078
88109
  jsonBody: {
88110
+ /** ID of the lock that you want to unlock. */
88079
88111
  device_id: string;
88112
+ /** */
88080
88113
  sync?: boolean;
88081
88114
  };
88082
88115
  commonParams: {};
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -21601,6 +21601,7 @@ declare const _default: {
21601
21601
  };
21602
21602
  '/locks/get': {
21603
21603
  post: {
21604
+ description: string;
21604
21605
  operationId: string;
21605
21606
  requestBody: {
21606
21607
  content: {
@@ -21608,10 +21609,12 @@ declare const _default: {
21608
21609
  schema: {
21609
21610
  properties: {
21610
21611
  device_id: {
21612
+ description: string;
21611
21613
  format: string;
21612
21614
  type: string;
21613
21615
  };
21614
21616
  name: {
21617
+ description: string;
21615
21618
  type: string;
21616
21619
  };
21617
21620
  };
@@ -21678,10 +21681,12 @@ declare const _default: {
21678
21681
  'x-fern-sdk-method-name': string;
21679
21682
  'x-fern-sdk-return-value': string;
21680
21683
  'x-response-key': string;
21684
+ 'x-title': string;
21681
21685
  };
21682
21686
  };
21683
21687
  '/locks/list': {
21684
21688
  post: {
21689
+ description: string;
21685
21690
  operationId: string;
21686
21691
  requestBody: {
21687
21692
  content: {
@@ -21861,10 +21866,12 @@ declare const _default: {
21861
21866
  'x-fern-sdk-method-name': string;
21862
21867
  'x-fern-sdk-return-value': string;
21863
21868
  'x-response-key': string;
21869
+ 'x-title': string;
21864
21870
  };
21865
21871
  };
21866
21872
  '/locks/lock_door': {
21867
21873
  post: {
21874
+ description: string;
21868
21875
  operationId: string;
21869
21876
  requestBody: {
21870
21877
  content: {
@@ -21872,12 +21879,14 @@ declare const _default: {
21872
21879
  schema: {
21873
21880
  properties: {
21874
21881
  device_id: {
21882
+ description: string;
21875
21883
  format: string;
21876
21884
  type: string;
21877
21885
  };
21878
21886
  sync: {
21879
21887
  default: boolean;
21880
21888
  type: string;
21889
+ 'x-undocumented': string;
21881
21890
  };
21882
21891
  };
21883
21892
  required: string[];
@@ -21941,10 +21950,12 @@ declare const _default: {
21941
21950
  'x-fern-sdk-method-name': string;
21942
21951
  'x-fern-sdk-return-value': string;
21943
21952
  'x-response-key': string;
21953
+ 'x-title': string;
21944
21954
  };
21945
21955
  };
21946
21956
  '/locks/simulate/keypad_code_entry': {
21947
21957
  post: {
21958
+ description: string;
21948
21959
  operationId: string;
21949
21960
  requestBody: {
21950
21961
  content: {
@@ -21952,9 +21963,11 @@ declare const _default: {
21952
21963
  schema: {
21953
21964
  properties: {
21954
21965
  code: {
21966
+ description: string;
21955
21967
  type: string;
21956
21968
  };
21957
21969
  device_id: {
21970
+ description: string;
21958
21971
  format: string;
21959
21972
  type: string;
21960
21973
  };
@@ -22017,6 +22030,7 @@ declare const _default: {
22017
22030
  };
22018
22031
  '/locks/simulate/manual_lock_via_keypad': {
22019
22032
  post: {
22033
+ description: string;
22020
22034
  operationId: string;
22021
22035
  requestBody: {
22022
22036
  content: {
@@ -22024,6 +22038,7 @@ declare const _default: {
22024
22038
  schema: {
22025
22039
  properties: {
22026
22040
  device_id: {
22041
+ description: string;
22027
22042
  format: string;
22028
22043
  type: string;
22029
22044
  };
@@ -22086,6 +22101,7 @@ declare const _default: {
22086
22101
  };
22087
22102
  '/locks/unlock_door': {
22088
22103
  post: {
22104
+ description: string;
22089
22105
  operationId: string;
22090
22106
  requestBody: {
22091
22107
  content: {
@@ -22093,12 +22109,14 @@ declare const _default: {
22093
22109
  schema: {
22094
22110
  properties: {
22095
22111
  device_id: {
22112
+ description: string;
22096
22113
  format: string;
22097
22114
  type: string;
22098
22115
  };
22099
22116
  sync: {
22100
22117
  default: boolean;
22101
22118
  type: string;
22119
+ 'x-undocumented': string;
22102
22120
  };
22103
22121
  };
22104
22122
  required: string[];
@@ -22162,6 +22180,7 @@ declare const _default: {
22162
22180
  'x-fern-sdk-method-name': string;
22163
22181
  'x-fern-sdk-return-value': string;
22164
22182
  'x-response-key': string;
22183
+ 'x-title': string;
22165
22184
  };
22166
22185
  };
22167
22186
  '/networks/get': {
@@ -22225,10 +22244,12 @@ declare const _default: {
22225
22244
  })[];
22226
22245
  summary: string;
22227
22246
  tags: string[];
22247
+ 'x-deprecated': string;
22228
22248
  'x-fern-sdk-group-name': string[];
22229
22249
  'x-fern-sdk-method-name': string;
22230
22250
  'x-fern-sdk-return-value': string;
22231
22251
  'x-response-key': string;
22252
+ 'x-undocumented': string;
22232
22253
  };
22233
22254
  };
22234
22255
  '/networks/list': {
@@ -22289,10 +22310,12 @@ declare const _default: {
22289
22310
  })[];
22290
22311
  summary: string;
22291
22312
  tags: string[];
22313
+ 'x-deprecated': string;
22292
22314
  'x-fern-sdk-group-name': string[];
22293
22315
  'x-fern-sdk-method-name': string;
22294
22316
  'x-fern-sdk-return-value': string;
22295
22317
  'x-response-key': string;
22318
+ 'x-undocumented': string;
22296
22319
  };
22297
22320
  };
22298
22321
  '/noise_sensors/list': {
@@ -30287,6 +30310,7 @@ declare const _default: {
30287
30310
  'x-fern-sdk-return-value': string;
30288
30311
  'x-response-key': string;
30289
30312
  'x-title': string;
30313
+ 'x-undocumented': string;
30290
30314
  };
30291
30315
  };
30292
30316
  '/unstable_partner/resources/push': {