@seamapi/types 1.765.0 → 1.767.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 (40) hide show
  1. package/dist/connect.cjs +375 -106
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2881 -10
  4. package/dist/index.cjs +375 -106
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  9. package/lib/seam/connect/models/action-attempts/configure-auto-lock.d.ts +77 -0
  10. package/lib/seam/connect/models/action-attempts/configure-auto-lock.js +31 -0
  11. package/lib/seam/connect/models/action-attempts/configure-auto-lock.js.map +1 -0
  12. package/lib/seam/connect/models/batch.d.ts +166 -0
  13. package/lib/seam/connect/models/customer/customer-portal.d.ts +14 -0
  14. package/lib/seam/connect/models/customer/customer-portal.js +5 -0
  15. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  16. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +6 -0
  17. package/lib/seam/connect/models/devices/capability-properties/lock.d.ts +6 -0
  18. package/lib/seam/connect/models/devices/capability-properties/lock.js +12 -0
  19. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  20. package/lib/seam/connect/models/devices/device-metadata.d.ts +7 -0
  21. package/lib/seam/connect/models/devices/device-metadata.js +3 -0
  22. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
  24. package/lib/seam/connect/models/devices/device.d.ts +25 -0
  25. package/lib/seam/connect/models/devices/device.js +1 -0
  26. package/lib/seam/connect/models/devices/device.js.map +1 -1
  27. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +17 -0
  28. package/lib/seam/connect/openapi.d.ts +132 -0
  29. package/lib/seam/connect/openapi.js +229 -0
  30. package/lib/seam/connect/openapi.js.map +1 -1
  31. package/lib/seam/connect/route-types.d.ts +2762 -306
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  34. package/src/lib/seam/connect/models/action-attempts/configure-auto-lock.ts +46 -0
  35. package/src/lib/seam/connect/models/customer/customer-portal.ts +7 -0
  36. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +12 -0
  37. package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
  38. package/src/lib/seam/connect/models/devices/device.ts +1 -0
  39. package/src/lib/seam/connect/openapi.ts +246 -0
  40. package/src/lib/seam/connect/route-types.ts +3089 -330
@@ -7771,6 +7771,111 @@ export default {
7771
7771
  ],
7772
7772
  type: 'object',
7773
7773
  },
7774
+ {
7775
+ description: 'Configuring the auto-lock is pending.',
7776
+ properties: {
7777
+ action_attempt_id: {
7778
+ description: 'ID of the action attempt.',
7779
+ format: 'uuid',
7780
+ type: 'string',
7781
+ },
7782
+ action_type: {
7783
+ description: 'Action attempt to track the status of configuring the auto-lock on a lock.',
7784
+ enum: ['CONFIGURE_AUTO_LOCK'],
7785
+ type: 'string',
7786
+ },
7787
+ error: {
7788
+ description: 'Errors associated with the action attempt. Null for pending action attempts.',
7789
+ nullable: true,
7790
+ },
7791
+ result: {
7792
+ description: 'Result of the action attempt. Null for pending action attempts.',
7793
+ nullable: true,
7794
+ },
7795
+ status: { enum: ['pending'], type: 'string' },
7796
+ },
7797
+ required: [
7798
+ 'action_attempt_id',
7799
+ 'status',
7800
+ 'result',
7801
+ 'error',
7802
+ 'action_type',
7803
+ ],
7804
+ type: 'object',
7805
+ },
7806
+ {
7807
+ description: 'Configuring the auto-lock succeeded.',
7808
+ properties: {
7809
+ action_attempt_id: {
7810
+ description: 'ID of the action attempt.',
7811
+ format: 'uuid',
7812
+ type: 'string',
7813
+ },
7814
+ action_type: {
7815
+ description: 'Action attempt to track the status of configuring the auto-lock on a lock.',
7816
+ enum: ['CONFIGURE_AUTO_LOCK'],
7817
+ type: 'string',
7818
+ },
7819
+ error: {
7820
+ description: 'Errors associated with the action attempt. Null for successful action attempts.',
7821
+ nullable: true,
7822
+ },
7823
+ result: {
7824
+ description: 'Result of the action.',
7825
+ properties: {},
7826
+ type: 'object',
7827
+ },
7828
+ status: { enum: ['success'], type: 'string' },
7829
+ },
7830
+ required: [
7831
+ 'action_attempt_id',
7832
+ 'status',
7833
+ 'error',
7834
+ 'action_type',
7835
+ 'result',
7836
+ ],
7837
+ type: 'object',
7838
+ },
7839
+ {
7840
+ description: 'Configuring the auto-lock failed.',
7841
+ properties: {
7842
+ action_attempt_id: {
7843
+ description: 'ID of the action attempt.',
7844
+ format: 'uuid',
7845
+ type: 'string',
7846
+ },
7847
+ action_type: {
7848
+ description: 'Action attempt to track the status of configuring the auto-lock on a lock.',
7849
+ enum: ['CONFIGURE_AUTO_LOCK'],
7850
+ type: 'string',
7851
+ },
7852
+ error: {
7853
+ description: 'Error associated with the action.',
7854
+ properties: {
7855
+ message: {
7856
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
7857
+ type: 'string',
7858
+ },
7859
+ type: { description: 'Type of the error.', type: 'string' },
7860
+ },
7861
+ required: ['type', 'message'],
7862
+ type: 'object',
7863
+ },
7864
+ result: {
7865
+ description: 'Result of the action attempt. Null for failed action attempts.',
7866
+ nullable: true,
7867
+ },
7868
+ status: { enum: ['error'], type: 'string' },
7869
+ },
7870
+ required: [
7871
+ 'action_attempt_id',
7872
+ 'status',
7873
+ 'result',
7874
+ 'action_type',
7875
+ 'error',
7876
+ ],
7877
+ type: 'object',
7878
+ },
7774
7879
  {
7775
7880
  properties: {
7776
7881
  action_attempt_id: {
@@ -9531,6 +9636,7 @@ export default {
9531
9636
  device: {
9532
9637
  description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.',
9533
9638
  properties: {
9639
+ can_configure_auto_lock: { type: 'boolean' },
9534
9640
  can_hvac_cool: { type: 'boolean' },
9535
9641
  can_hvac_heat: { type: 'boolean' },
9536
9642
  can_hvac_heat_cool: { type: 'boolean' },
@@ -11519,6 +11625,10 @@ export default {
11519
11625
  features: {
11520
11626
  description: 'Features for a TTLock device.',
11521
11627
  properties: {
11628
+ auto_lock_time_config: {
11629
+ description: 'Indicates whether a TTLock device supports auto-lock time configuration.',
11630
+ type: 'boolean',
11631
+ },
11522
11632
  incomplete_keyboard_passcode: {
11523
11633
  description: 'Indicates whether a TTLock device supports an incomplete keyboard passcode.',
11524
11634
  type: 'boolean',
@@ -11551,6 +11661,7 @@ export default {
11551
11661
  'lock_command',
11552
11662
  'incomplete_keyboard_passcode',
11553
11663
  'wifi',
11664
+ 'auto_lock_time_config',
11554
11665
  ],
11555
11666
  type: 'object',
11556
11667
  },
@@ -11716,6 +11827,17 @@ export default {
11716
11827
  type: 'array',
11717
11828
  'x-undocumented': 'Marked as experimental.',
11718
11829
  },
11830
+ auto_lock_delay_seconds: {
11831
+ description: 'The delay in seconds before the lock automatically locks after being unlocked.',
11832
+ format: 'float',
11833
+ type: 'number',
11834
+ 'x-property-group-key': 'locks',
11835
+ },
11836
+ auto_lock_enabled: {
11837
+ description: 'Indicates whether automatic locking is enabled.',
11838
+ type: 'boolean',
11839
+ 'x-property-group-key': 'locks',
11840
+ },
11719
11841
  code_constraints: {
11720
11842
  description: 'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.',
11721
11843
  items: {
@@ -13161,6 +13283,7 @@ export default {
13161
13283
  },
13162
13284
  device_provider: {
13163
13285
  properties: {
13286
+ can_configure_auto_lock: { type: 'boolean' },
13164
13287
  can_hvac_cool: { type: 'boolean' },
13165
13288
  can_hvac_heat: { type: 'boolean' },
13166
13289
  can_hvac_heat_cool: { type: 'boolean' },
@@ -25932,6 +26055,7 @@ export default {
25932
26055
  unmanaged_device: {
25933
26056
  description: 'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
25934
26057
  properties: {
26058
+ can_configure_auto_lock: { type: 'boolean' },
25935
26059
  can_hvac_cool: { type: 'boolean' },
25936
26060
  can_hvac_heat: { type: 'boolean' },
25937
26061
  can_hvac_heat_cool: { type: 'boolean' },
@@ -44926,6 +45050,7 @@ export default {
44926
45050
  manage: {
44927
45051
  exclude: false,
44928
45052
  exclude_reservation_management: false,
45053
+ exclude_reservation_technical_details: false,
44929
45054
  exclude_staff_management: false,
44930
45055
  },
44931
45056
  manage_devices: { exclude: false },
@@ -45069,6 +45194,11 @@ export default {
45069
45194
  description: 'Indicates whether the customer can manage reservations for their properties.',
45070
45195
  type: 'boolean',
45071
45196
  },
45197
+ exclude_reservation_technical_details: {
45198
+ default: false,
45199
+ description: 'Indicates whether to exclude technical details from reservation views.',
45200
+ type: 'boolean',
45201
+ },
45072
45202
  exclude_staff_management: {
45073
45203
  default: false,
45074
45204
  description: 'Indicates whether the customer can manage staff for their properties.',
@@ -47730,6 +47860,7 @@ export default {
47730
47860
  'can_simulate_hub_connection',
47731
47861
  'can_simulate_hub_disconnection',
47732
47862
  'can_simulate_paid_subscription',
47863
+ 'can_configure_auto_lock',
47733
47864
  ],
47734
47865
  type: 'string',
47735
47866
  },
@@ -47762,6 +47893,7 @@ export default {
47762
47893
  'can_simulate_hub_connection',
47763
47894
  'can_simulate_hub_disconnection',
47764
47895
  'can_simulate_paid_subscription',
47896
+ 'can_configure_auto_lock',
47765
47897
  ],
47766
47898
  type: 'string',
47767
47899
  },
@@ -48046,6 +48178,7 @@ export default {
48046
48178
  'can_simulate_hub_connection',
48047
48179
  'can_simulate_hub_disconnection',
48048
48180
  'can_simulate_paid_subscription',
48181
+ 'can_configure_auto_lock',
48049
48182
  ],
48050
48183
  type: 'string',
48051
48184
  },
@@ -48074,6 +48207,7 @@ export default {
48074
48207
  'can_simulate_hub_connection',
48075
48208
  'can_simulate_hub_disconnection',
48076
48209
  'can_simulate_paid_subscription',
48210
+ 'can_configure_auto_lock',
48077
48211
  ],
48078
48212
  type: 'string',
48079
48213
  },
@@ -49561,6 +49695,7 @@ export default {
49561
49695
  'can_simulate_hub_connection',
49562
49696
  'can_simulate_hub_disconnection',
49563
49697
  'can_simulate_paid_subscription',
49698
+ 'can_configure_auto_lock',
49564
49699
  ],
49565
49700
  type: 'string',
49566
49701
  },
@@ -49593,6 +49728,7 @@ export default {
49593
49728
  'can_simulate_hub_connection',
49594
49729
  'can_simulate_hub_disconnection',
49595
49730
  'can_simulate_paid_subscription',
49731
+ 'can_configure_auto_lock',
49596
49732
  ],
49597
49733
  type: 'string',
49598
49734
  },
@@ -49886,6 +50022,7 @@ export default {
49886
50022
  'can_simulate_hub_connection',
49887
50023
  'can_simulate_hub_disconnection',
49888
50024
  'can_simulate_paid_subscription',
50025
+ 'can_configure_auto_lock',
49889
50026
  ],
49890
50027
  type: 'string',
49891
50028
  },
@@ -49914,6 +50051,7 @@ export default {
49914
50051
  'can_simulate_hub_connection',
49915
50052
  'can_simulate_hub_disconnection',
49916
50053
  'can_simulate_paid_subscription',
50054
+ 'can_configure_auto_lock',
49917
50055
  ],
49918
50056
  type: 'string',
49919
50057
  },
@@ -51707,6 +51845,75 @@ export default {
51707
51845
  'x-title': 'List Instant Keys',
51708
51846
  },
51709
51847
  },
51848
+ '/locks/configure_auto_lock': {
51849
+ post: {
51850
+ description: 'Configures the auto-lock setting for a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).',
51851
+ operationId: 'locksConfigureAutoLockPost',
51852
+ requestBody: {
51853
+ content: {
51854
+ 'application/json': {
51855
+ schema: {
51856
+ properties: {
51857
+ auto_lock_delay_seconds: {
51858
+ description: 'Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.',
51859
+ format: 'float',
51860
+ maximum: 60,
51861
+ minimum: 1,
51862
+ type: 'number',
51863
+ },
51864
+ auto_lock_enabled: {
51865
+ description: 'Whether to enable or disable auto-lock.',
51866
+ type: 'boolean',
51867
+ },
51868
+ device_id: {
51869
+ description: 'ID of the lock for which you want to configure the auto-lock.',
51870
+ format: 'uuid',
51871
+ type: 'string',
51872
+ },
51873
+ },
51874
+ required: ['device_id', 'auto_lock_enabled'],
51875
+ type: 'object',
51876
+ },
51877
+ },
51878
+ },
51879
+ },
51880
+ responses: {
51881
+ 200: {
51882
+ content: {
51883
+ 'application/json': {
51884
+ schema: {
51885
+ properties: {
51886
+ action_attempt: {
51887
+ $ref: '#/components/schemas/action_attempt',
51888
+ },
51889
+ ok: { type: 'boolean' },
51890
+ },
51891
+ required: ['action_attempt', 'ok'],
51892
+ type: 'object',
51893
+ },
51894
+ },
51895
+ },
51896
+ description: 'OK',
51897
+ },
51898
+ 400: { description: 'Bad Request' },
51899
+ 401: { description: 'Unauthorized' },
51900
+ },
51901
+ security: [
51902
+ { client_session: [] },
51903
+ { pat_with_workspace: [] },
51904
+ { console_session_with_workspace: [] },
51905
+ { api_key: [] },
51906
+ ],
51907
+ summary: '/locks/configure_auto_lock',
51908
+ tags: ['/locks'],
51909
+ 'x-action-attempt-type': 'CONFIGURE_AUTO_LOCK',
51910
+ 'x-fern-sdk-group-name': ['locks'],
51911
+ 'x-fern-sdk-method-name': 'configure_auto_lock',
51912
+ 'x-fern-sdk-return-value': 'action_attempt',
51913
+ 'x-response-key': 'action_attempt',
51914
+ 'x-title': 'Configure Auto-Lock',
51915
+ },
51916
+ },
51710
51917
  '/locks/get': {
51711
51918
  get: {
51712
51919
  description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).',
@@ -52062,6 +52269,7 @@ export default {
52062
52269
  'can_simulate_hub_connection',
52063
52270
  'can_simulate_hub_disconnection',
52064
52271
  'can_simulate_paid_subscription',
52272
+ 'can_configure_auto_lock',
52065
52273
  ],
52066
52274
  type: 'string',
52067
52275
  },
@@ -52094,6 +52302,7 @@ export default {
52094
52302
  'can_simulate_hub_connection',
52095
52303
  'can_simulate_hub_disconnection',
52096
52304
  'can_simulate_paid_subscription',
52305
+ 'can_configure_auto_lock',
52097
52306
  ],
52098
52307
  type: 'string',
52099
52308
  },
@@ -52307,6 +52516,7 @@ export default {
52307
52516
  'can_simulate_hub_connection',
52308
52517
  'can_simulate_hub_disconnection',
52309
52518
  'can_simulate_paid_subscription',
52519
+ 'can_configure_auto_lock',
52310
52520
  ],
52311
52521
  type: 'string',
52312
52522
  },
@@ -52335,6 +52545,7 @@ export default {
52335
52545
  'can_simulate_hub_connection',
52336
52546
  'can_simulate_hub_disconnection',
52337
52547
  'can_simulate_paid_subscription',
52548
+ 'can_configure_auto_lock',
52338
52549
  ],
52339
52550
  type: 'string',
52340
52551
  },
@@ -52853,6 +53064,7 @@ export default {
52853
53064
  'can_simulate_hub_connection',
52854
53065
  'can_simulate_hub_disconnection',
52855
53066
  'can_simulate_paid_subscription',
53067
+ 'can_configure_auto_lock',
52856
53068
  ],
52857
53069
  type: 'string',
52858
53070
  },
@@ -52885,6 +53097,7 @@ export default {
52885
53097
  'can_simulate_hub_connection',
52886
53098
  'can_simulate_hub_disconnection',
52887
53099
  'can_simulate_paid_subscription',
53100
+ 'can_configure_auto_lock',
52888
53101
  ],
52889
53102
  type: 'string',
52890
53103
  },
@@ -53042,6 +53255,7 @@ export default {
53042
53255
  'can_simulate_hub_connection',
53043
53256
  'can_simulate_hub_disconnection',
53044
53257
  'can_simulate_paid_subscription',
53258
+ 'can_configure_auto_lock',
53045
53259
  ],
53046
53260
  type: 'string',
53047
53261
  },
@@ -53070,6 +53284,7 @@ export default {
53070
53284
  'can_simulate_hub_connection',
53071
53285
  'can_simulate_hub_disconnection',
53072
53286
  'can_simulate_paid_subscription',
53287
+ 'can_configure_auto_lock',
53073
53288
  ],
53074
53289
  type: 'string',
53075
53290
  },
@@ -60784,6 +60999,11 @@ export default {
60784
60999
  description: 'Indicates whether the customer can manage reservations for their properties.',
60785
61000
  type: 'boolean',
60786
61001
  },
61002
+ exclude_reservation_technical_details: {
61003
+ default: false,
61004
+ description: 'Indicates whether to exclude technical details from reservation views.',
61005
+ type: 'boolean',
61006
+ },
60787
61007
  exclude_staff_management: {
60788
61008
  default: false,
60789
61009
  description: 'Indicates whether the customer can manage staff for their properties.',
@@ -61152,6 +61372,11 @@ export default {
61152
61372
  description: 'Indicates whether the customer can manage reservations for their properties.',
61153
61373
  type: 'boolean',
61154
61374
  },
61375
+ exclude_reservation_technical_details: {
61376
+ default: false,
61377
+ description: 'Indicates whether to exclude technical details from reservation views.',
61378
+ type: 'boolean',
61379
+ },
61155
61380
  exclude_staff_management: {
61156
61381
  default: false,
61157
61382
  description: 'Indicates whether the customer can manage staff for their properties.',
@@ -67300,6 +67525,7 @@ export default {
67300
67525
  'can_simulate_hub_connection',
67301
67526
  'can_simulate_hub_disconnection',
67302
67527
  'can_simulate_paid_subscription',
67528
+ 'can_configure_auto_lock',
67303
67529
  ],
67304
67530
  type: 'string',
67305
67531
  },
@@ -67332,6 +67558,7 @@ export default {
67332
67558
  'can_simulate_hub_connection',
67333
67559
  'can_simulate_hub_disconnection',
67334
67560
  'can_simulate_paid_subscription',
67561
+ 'can_configure_auto_lock',
67335
67562
  ],
67336
67563
  type: 'string',
67337
67564
  },
@@ -67503,6 +67730,7 @@ export default {
67503
67730
  'can_simulate_hub_connection',
67504
67731
  'can_simulate_hub_disconnection',
67505
67732
  'can_simulate_paid_subscription',
67733
+ 'can_configure_auto_lock',
67506
67734
  ],
67507
67735
  type: 'string',
67508
67736
  },
@@ -67531,6 +67759,7 @@ export default {
67531
67759
  'can_simulate_hub_connection',
67532
67760
  'can_simulate_hub_disconnection',
67533
67761
  'can_simulate_paid_subscription',
67762
+ 'can_configure_auto_lock',
67534
67763
  ],
67535
67764
  type: 'string',
67536
67765
  },