@seamapi/types 1.766.0 → 1.768.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.
- package/dist/connect.cjs +410 -130
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2887 -10
- package/dist/index.cjs +410 -130
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/configure-auto-lock.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/configure-auto-lock.js +31 -0
- package/lib/seam/connect/models/action-attempts/configure-auto-lock.js.map +1 -0
- package/lib/seam/connect/models/batch.d.ts +166 -0
- package/lib/seam/connect/models/customer/customer-portal.js +6 -2
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/customer/user-identity-resources.js +1 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +6 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.d.ts +6 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.js +12 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.d.ts +7 -0
- package/lib/seam/connect/models/devices/device-metadata.js +3 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
- package/lib/seam/connect/models/devices/device.d.ts +25 -0
- package/lib/seam/connect/models/devices/device.js +1 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +17 -0
- package/lib/seam/connect/openapi.d.ts +142 -0
- package/lib/seam/connect/openapi.js +239 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2758 -306
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/configure-auto-lock.ts +46 -0
- package/src/lib/seam/connect/models/customer/customer-portal.ts +6 -4
- package/src/lib/seam/connect/models/customer/user-identity-resources.ts +1 -0
- package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +12 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
- package/src/lib/seam/connect/models/devices/device.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +264 -0
- package/src/lib/seam/connect/route-types.ts +3085 -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' },
|
|
@@ -22700,6 +22823,7 @@ export default {
|
|
|
22700
22823
|
required: ['name', 'staff_member_key'],
|
|
22701
22824
|
type: 'object',
|
|
22702
22825
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
22826
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
22703
22827
|
},
|
|
22704
22828
|
thermostat_daily_program: {
|
|
22705
22829
|
description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
|
|
@@ -25932,6 +26056,7 @@ export default {
|
|
|
25932
26056
|
unmanaged_device: {
|
|
25933
26057
|
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
26058
|
properties: {
|
|
26059
|
+
can_configure_auto_lock: { type: 'boolean' },
|
|
25935
26060
|
can_hvac_cool: { type: 'boolean' },
|
|
25936
26061
|
can_hvac_heat: { type: 'boolean' },
|
|
25937
26062
|
can_hvac_heat_cool: { type: 'boolean' },
|
|
@@ -28428,6 +28553,7 @@ export default {
|
|
|
28428
28553
|
},
|
|
28429
28554
|
timeline_events: {
|
|
28430
28555
|
items: {
|
|
28556
|
+
description: 'Timeline event for access code lifecycle activity.',
|
|
28431
28557
|
properties: {
|
|
28432
28558
|
actor: {
|
|
28433
28559
|
description: 'Information about who or what triggered this event.',
|
|
@@ -28487,6 +28613,7 @@ export default {
|
|
|
28487
28613
|
'access_code.unmanaged.failed_to_convert_to_managed',
|
|
28488
28614
|
],
|
|
28489
28615
|
type: 'string',
|
|
28616
|
+
'x-undocumented': 'Unreleased.',
|
|
28490
28617
|
},
|
|
28491
28618
|
occurred_at: {
|
|
28492
28619
|
description: 'ISO 8601 timestamp when the event occurred.',
|
|
@@ -28523,6 +28650,7 @@ export default {
|
|
|
28523
28650
|
'actor',
|
|
28524
28651
|
],
|
|
28525
28652
|
type: 'object',
|
|
28653
|
+
'x-undocumented': 'Unreleased.',
|
|
28526
28654
|
},
|
|
28527
28655
|
type: 'array',
|
|
28528
28656
|
},
|
|
@@ -28551,6 +28679,7 @@ export default {
|
|
|
28551
28679
|
'x-fern-sdk-return-value': 'timeline_events',
|
|
28552
28680
|
'x-response-key': 'timeline_events',
|
|
28553
28681
|
'x-title': 'Get Access Code Timeline',
|
|
28682
|
+
'x-undocumented': 'Unreleased.',
|
|
28554
28683
|
},
|
|
28555
28684
|
post: {
|
|
28556
28685
|
description: 'Returns a chronological timeline of events for an access code.\n\nThe timeline includes state changes (create, update, delete), delivery lifecycle events\n(programming attempts, success/failure), and related device events.',
|
|
@@ -28634,6 +28763,7 @@ export default {
|
|
|
28634
28763
|
},
|
|
28635
28764
|
timeline_events: {
|
|
28636
28765
|
items: {
|
|
28766
|
+
description: 'Timeline event for access code lifecycle activity.',
|
|
28637
28767
|
properties: {
|
|
28638
28768
|
actor: {
|
|
28639
28769
|
description: 'Information about who or what triggered this event.',
|
|
@@ -28693,6 +28823,7 @@ export default {
|
|
|
28693
28823
|
'access_code.unmanaged.failed_to_convert_to_managed',
|
|
28694
28824
|
],
|
|
28695
28825
|
type: 'string',
|
|
28826
|
+
'x-undocumented': 'Unreleased.',
|
|
28696
28827
|
},
|
|
28697
28828
|
occurred_at: {
|
|
28698
28829
|
description: 'ISO 8601 timestamp when the event occurred.',
|
|
@@ -28729,6 +28860,7 @@ export default {
|
|
|
28729
28860
|
'actor',
|
|
28730
28861
|
],
|
|
28731
28862
|
type: 'object',
|
|
28863
|
+
'x-undocumented': 'Unreleased.',
|
|
28732
28864
|
},
|
|
28733
28865
|
type: 'array',
|
|
28734
28866
|
},
|
|
@@ -28757,6 +28889,7 @@ export default {
|
|
|
28757
28889
|
'x-fern-sdk-return-value': 'timeline_events',
|
|
28758
28890
|
'x-response-key': 'timeline_events',
|
|
28759
28891
|
'x-title': 'Get Access Code Timeline',
|
|
28892
|
+
'x-undocumented': 'Unreleased.',
|
|
28760
28893
|
},
|
|
28761
28894
|
},
|
|
28762
28895
|
'/access_codes/list': {
|
|
@@ -44982,6 +45115,7 @@ export default {
|
|
|
44982
45115
|
},
|
|
44983
45116
|
required: ['resource_type', 'resource_key'],
|
|
44984
45117
|
type: 'object',
|
|
45118
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44985
45119
|
},
|
|
44986
45120
|
exclude_locale_picker: {
|
|
44987
45121
|
default: false,
|
|
@@ -45858,6 +45992,7 @@ export default {
|
|
|
45858
45992
|
required: ['name', 'staff_member_key'],
|
|
45859
45993
|
type: 'object',
|
|
45860
45994
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
45995
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
45861
45996
|
},
|
|
45862
45997
|
type: 'array',
|
|
45863
45998
|
},
|
|
@@ -46979,6 +47114,7 @@ export default {
|
|
|
46979
47114
|
required: ['name', 'staff_member_key'],
|
|
46980
47115
|
type: 'object',
|
|
46981
47116
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
47117
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
46982
47118
|
},
|
|
46983
47119
|
type: 'array',
|
|
46984
47120
|
},
|
|
@@ -47198,6 +47334,7 @@ export default {
|
|
|
47198
47334
|
'x-fern-sdk-return-value': 'deep_link',
|
|
47199
47335
|
'x-response-key': 'deep_link',
|
|
47200
47336
|
'x-title': 'Create Reservation Deep Link',
|
|
47337
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
47201
47338
|
},
|
|
47202
47339
|
},
|
|
47203
47340
|
'/devices/delete': {
|
|
@@ -47736,6 +47873,7 @@ export default {
|
|
|
47736
47873
|
'can_simulate_hub_connection',
|
|
47737
47874
|
'can_simulate_hub_disconnection',
|
|
47738
47875
|
'can_simulate_paid_subscription',
|
|
47876
|
+
'can_configure_auto_lock',
|
|
47739
47877
|
],
|
|
47740
47878
|
type: 'string',
|
|
47741
47879
|
},
|
|
@@ -47768,6 +47906,7 @@ export default {
|
|
|
47768
47906
|
'can_simulate_hub_connection',
|
|
47769
47907
|
'can_simulate_hub_disconnection',
|
|
47770
47908
|
'can_simulate_paid_subscription',
|
|
47909
|
+
'can_configure_auto_lock',
|
|
47771
47910
|
],
|
|
47772
47911
|
type: 'string',
|
|
47773
47912
|
},
|
|
@@ -48052,6 +48191,7 @@ export default {
|
|
|
48052
48191
|
'can_simulate_hub_connection',
|
|
48053
48192
|
'can_simulate_hub_disconnection',
|
|
48054
48193
|
'can_simulate_paid_subscription',
|
|
48194
|
+
'can_configure_auto_lock',
|
|
48055
48195
|
],
|
|
48056
48196
|
type: 'string',
|
|
48057
48197
|
},
|
|
@@ -48080,6 +48220,7 @@ export default {
|
|
|
48080
48220
|
'can_simulate_hub_connection',
|
|
48081
48221
|
'can_simulate_hub_disconnection',
|
|
48082
48222
|
'can_simulate_paid_subscription',
|
|
48223
|
+
'can_configure_auto_lock',
|
|
48083
48224
|
],
|
|
48084
48225
|
type: 'string',
|
|
48085
48226
|
},
|
|
@@ -49567,6 +49708,7 @@ export default {
|
|
|
49567
49708
|
'can_simulate_hub_connection',
|
|
49568
49709
|
'can_simulate_hub_disconnection',
|
|
49569
49710
|
'can_simulate_paid_subscription',
|
|
49711
|
+
'can_configure_auto_lock',
|
|
49570
49712
|
],
|
|
49571
49713
|
type: 'string',
|
|
49572
49714
|
},
|
|
@@ -49599,6 +49741,7 @@ export default {
|
|
|
49599
49741
|
'can_simulate_hub_connection',
|
|
49600
49742
|
'can_simulate_hub_disconnection',
|
|
49601
49743
|
'can_simulate_paid_subscription',
|
|
49744
|
+
'can_configure_auto_lock',
|
|
49602
49745
|
],
|
|
49603
49746
|
type: 'string',
|
|
49604
49747
|
},
|
|
@@ -49892,6 +50035,7 @@ export default {
|
|
|
49892
50035
|
'can_simulate_hub_connection',
|
|
49893
50036
|
'can_simulate_hub_disconnection',
|
|
49894
50037
|
'can_simulate_paid_subscription',
|
|
50038
|
+
'can_configure_auto_lock',
|
|
49895
50039
|
],
|
|
49896
50040
|
type: 'string',
|
|
49897
50041
|
},
|
|
@@ -49920,6 +50064,7 @@ export default {
|
|
|
49920
50064
|
'can_simulate_hub_connection',
|
|
49921
50065
|
'can_simulate_hub_disconnection',
|
|
49922
50066
|
'can_simulate_paid_subscription',
|
|
50067
|
+
'can_configure_auto_lock',
|
|
49923
50068
|
],
|
|
49924
50069
|
type: 'string',
|
|
49925
50070
|
},
|
|
@@ -51713,6 +51858,75 @@ export default {
|
|
|
51713
51858
|
'x-title': 'List Instant Keys',
|
|
51714
51859
|
},
|
|
51715
51860
|
},
|
|
51861
|
+
'/locks/configure_auto_lock': {
|
|
51862
|
+
post: {
|
|
51863
|
+
description: 'Configures the auto-lock setting for a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).',
|
|
51864
|
+
operationId: 'locksConfigureAutoLockPost',
|
|
51865
|
+
requestBody: {
|
|
51866
|
+
content: {
|
|
51867
|
+
'application/json': {
|
|
51868
|
+
schema: {
|
|
51869
|
+
properties: {
|
|
51870
|
+
auto_lock_delay_seconds: {
|
|
51871
|
+
description: 'Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.',
|
|
51872
|
+
format: 'float',
|
|
51873
|
+
maximum: 60,
|
|
51874
|
+
minimum: 1,
|
|
51875
|
+
type: 'number',
|
|
51876
|
+
},
|
|
51877
|
+
auto_lock_enabled: {
|
|
51878
|
+
description: 'Whether to enable or disable auto-lock.',
|
|
51879
|
+
type: 'boolean',
|
|
51880
|
+
},
|
|
51881
|
+
device_id: {
|
|
51882
|
+
description: 'ID of the lock for which you want to configure the auto-lock.',
|
|
51883
|
+
format: 'uuid',
|
|
51884
|
+
type: 'string',
|
|
51885
|
+
},
|
|
51886
|
+
},
|
|
51887
|
+
required: ['device_id', 'auto_lock_enabled'],
|
|
51888
|
+
type: 'object',
|
|
51889
|
+
},
|
|
51890
|
+
},
|
|
51891
|
+
},
|
|
51892
|
+
},
|
|
51893
|
+
responses: {
|
|
51894
|
+
200: {
|
|
51895
|
+
content: {
|
|
51896
|
+
'application/json': {
|
|
51897
|
+
schema: {
|
|
51898
|
+
properties: {
|
|
51899
|
+
action_attempt: {
|
|
51900
|
+
$ref: '#/components/schemas/action_attempt',
|
|
51901
|
+
},
|
|
51902
|
+
ok: { type: 'boolean' },
|
|
51903
|
+
},
|
|
51904
|
+
required: ['action_attempt', 'ok'],
|
|
51905
|
+
type: 'object',
|
|
51906
|
+
},
|
|
51907
|
+
},
|
|
51908
|
+
},
|
|
51909
|
+
description: 'OK',
|
|
51910
|
+
},
|
|
51911
|
+
400: { description: 'Bad Request' },
|
|
51912
|
+
401: { description: 'Unauthorized' },
|
|
51913
|
+
},
|
|
51914
|
+
security: [
|
|
51915
|
+
{ client_session: [] },
|
|
51916
|
+
{ pat_with_workspace: [] },
|
|
51917
|
+
{ console_session_with_workspace: [] },
|
|
51918
|
+
{ api_key: [] },
|
|
51919
|
+
],
|
|
51920
|
+
summary: '/locks/configure_auto_lock',
|
|
51921
|
+
tags: ['/locks'],
|
|
51922
|
+
'x-action-attempt-type': 'CONFIGURE_AUTO_LOCK',
|
|
51923
|
+
'x-fern-sdk-group-name': ['locks'],
|
|
51924
|
+
'x-fern-sdk-method-name': 'configure_auto_lock',
|
|
51925
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
51926
|
+
'x-response-key': 'action_attempt',
|
|
51927
|
+
'x-title': 'Configure Auto-Lock',
|
|
51928
|
+
},
|
|
51929
|
+
},
|
|
51716
51930
|
'/locks/get': {
|
|
51717
51931
|
get: {
|
|
51718
51932
|
description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).',
|
|
@@ -52068,6 +52282,7 @@ export default {
|
|
|
52068
52282
|
'can_simulate_hub_connection',
|
|
52069
52283
|
'can_simulate_hub_disconnection',
|
|
52070
52284
|
'can_simulate_paid_subscription',
|
|
52285
|
+
'can_configure_auto_lock',
|
|
52071
52286
|
],
|
|
52072
52287
|
type: 'string',
|
|
52073
52288
|
},
|
|
@@ -52100,6 +52315,7 @@ export default {
|
|
|
52100
52315
|
'can_simulate_hub_connection',
|
|
52101
52316
|
'can_simulate_hub_disconnection',
|
|
52102
52317
|
'can_simulate_paid_subscription',
|
|
52318
|
+
'can_configure_auto_lock',
|
|
52103
52319
|
],
|
|
52104
52320
|
type: 'string',
|
|
52105
52321
|
},
|
|
@@ -52313,6 +52529,7 @@ export default {
|
|
|
52313
52529
|
'can_simulate_hub_connection',
|
|
52314
52530
|
'can_simulate_hub_disconnection',
|
|
52315
52531
|
'can_simulate_paid_subscription',
|
|
52532
|
+
'can_configure_auto_lock',
|
|
52316
52533
|
],
|
|
52317
52534
|
type: 'string',
|
|
52318
52535
|
},
|
|
@@ -52341,6 +52558,7 @@ export default {
|
|
|
52341
52558
|
'can_simulate_hub_connection',
|
|
52342
52559
|
'can_simulate_hub_disconnection',
|
|
52343
52560
|
'can_simulate_paid_subscription',
|
|
52561
|
+
'can_configure_auto_lock',
|
|
52344
52562
|
],
|
|
52345
52563
|
type: 'string',
|
|
52346
52564
|
},
|
|
@@ -52859,6 +53077,7 @@ export default {
|
|
|
52859
53077
|
'can_simulate_hub_connection',
|
|
52860
53078
|
'can_simulate_hub_disconnection',
|
|
52861
53079
|
'can_simulate_paid_subscription',
|
|
53080
|
+
'can_configure_auto_lock',
|
|
52862
53081
|
],
|
|
52863
53082
|
type: 'string',
|
|
52864
53083
|
},
|
|
@@ -52891,6 +53110,7 @@ export default {
|
|
|
52891
53110
|
'can_simulate_hub_connection',
|
|
52892
53111
|
'can_simulate_hub_disconnection',
|
|
52893
53112
|
'can_simulate_paid_subscription',
|
|
53113
|
+
'can_configure_auto_lock',
|
|
52894
53114
|
],
|
|
52895
53115
|
type: 'string',
|
|
52896
53116
|
},
|
|
@@ -53048,6 +53268,7 @@ export default {
|
|
|
53048
53268
|
'can_simulate_hub_connection',
|
|
53049
53269
|
'can_simulate_hub_disconnection',
|
|
53050
53270
|
'can_simulate_paid_subscription',
|
|
53271
|
+
'can_configure_auto_lock',
|
|
53051
53272
|
],
|
|
53052
53273
|
type: 'string',
|
|
53053
53274
|
},
|
|
@@ -53076,6 +53297,7 @@ export default {
|
|
|
53076
53297
|
'can_simulate_hub_connection',
|
|
53077
53298
|
'can_simulate_hub_disconnection',
|
|
53078
53299
|
'can_simulate_paid_subscription',
|
|
53300
|
+
'can_configure_auto_lock',
|
|
53079
53301
|
],
|
|
53080
53302
|
type: 'string',
|
|
53081
53303
|
},
|
|
@@ -58773,6 +58995,7 @@ export default {
|
|
|
58773
58995
|
'x-fern-sdk-return-value': 'automation',
|
|
58774
58996
|
'x-response-key': 'automation',
|
|
58775
58997
|
'x-title': 'Get Customer Automation Configuration',
|
|
58998
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
58776
58999
|
},
|
|
58777
59000
|
post: {
|
|
58778
59001
|
description: 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
@@ -59069,6 +59292,7 @@ export default {
|
|
|
59069
59292
|
'x-fern-sdk-return-value': 'automation',
|
|
59070
59293
|
'x-response-key': 'automation',
|
|
59071
59294
|
'x-title': 'Get Customer Automation Configuration',
|
|
59295
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59072
59296
|
},
|
|
59073
59297
|
},
|
|
59074
59298
|
'/seam/customer/v1/customers/automations/update': {
|
|
@@ -59355,6 +59579,7 @@ export default {
|
|
|
59355
59579
|
'x-fern-sdk-method-name': 'update',
|
|
59356
59580
|
'x-response-key': null,
|
|
59357
59581
|
'x-title': 'Update Customer Automation Configuration',
|
|
59582
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59358
59583
|
},
|
|
59359
59584
|
post: {
|
|
59360
59585
|
description: 'Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.',
|
|
@@ -59639,6 +59864,7 @@ export default {
|
|
|
59639
59864
|
'x-fern-sdk-method-name': 'update',
|
|
59640
59865
|
'x-response-key': null,
|
|
59641
59866
|
'x-title': 'Update Customer Automation Configuration',
|
|
59867
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59642
59868
|
},
|
|
59643
59869
|
},
|
|
59644
59870
|
'/seam/customer/v1/customers/list': {
|
|
@@ -59817,6 +60043,7 @@ export default {
|
|
|
59817
60043
|
'x-fern-sdk-method-name': 'me',
|
|
59818
60044
|
'x-response-key': null,
|
|
59819
60045
|
'x-title': 'Me',
|
|
60046
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59820
60047
|
},
|
|
59821
60048
|
post: {
|
|
59822
60049
|
description: 'Returns the customer associated with the authenticated client session.',
|
|
@@ -59852,6 +60079,7 @@ export default {
|
|
|
59852
60079
|
'x-fern-sdk-method-name': 'me',
|
|
59853
60080
|
'x-response-key': null,
|
|
59854
60081
|
'x-title': 'Me',
|
|
60082
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59855
60083
|
},
|
|
59856
60084
|
},
|
|
59857
60085
|
'/seam/customer/v1/customers/open_portal': {
|
|
@@ -60696,6 +60924,7 @@ export default {
|
|
|
60696
60924
|
},
|
|
60697
60925
|
required: ['resource_type', 'resource_key'],
|
|
60698
60926
|
type: 'object',
|
|
60927
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
60699
60928
|
},
|
|
60700
60929
|
exclude_locale_picker: {
|
|
60701
60930
|
default: false,
|
|
@@ -61069,6 +61298,7 @@ export default {
|
|
|
61069
61298
|
},
|
|
61070
61299
|
required: ['resource_type', 'resource_key'],
|
|
61071
61300
|
type: 'object',
|
|
61301
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
61072
61302
|
},
|
|
61073
61303
|
exclude_locale_picker: {
|
|
61074
61304
|
default: false,
|
|
@@ -63680,6 +63910,7 @@ export default {
|
|
|
63680
63910
|
'x-fern-sdk-method-name': 'push_common_areas',
|
|
63681
63911
|
'x-response-key': null,
|
|
63682
63912
|
'x-title': 'Push Common Areas',
|
|
63913
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
63683
63914
|
},
|
|
63684
63915
|
},
|
|
63685
63916
|
'/seam/customer/v1/staff_members/get': {
|
|
@@ -63748,6 +63979,7 @@ export default {
|
|
|
63748
63979
|
required: ['staff_member_key', 'name'],
|
|
63749
63980
|
type: 'object',
|
|
63750
63981
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
63982
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
63751
63983
|
},
|
|
63752
63984
|
},
|
|
63753
63985
|
required: ['access_grant', 'spaces', 'staff_member', 'ok'],
|
|
@@ -63840,6 +64072,7 @@ export default {
|
|
|
63840
64072
|
required: ['staff_member_key', 'name'],
|
|
63841
64073
|
type: 'object',
|
|
63842
64074
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
64075
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
63843
64076
|
},
|
|
63844
64077
|
},
|
|
63845
64078
|
required: ['access_grant', 'spaces', 'staff_member', 'ok'],
|
|
@@ -63953,6 +64186,7 @@ export default {
|
|
|
63953
64186
|
required: ['staff_member_key', 'name'],
|
|
63954
64187
|
type: 'object',
|
|
63955
64188
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
64189
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
63956
64190
|
},
|
|
63957
64191
|
type: 'array',
|
|
63958
64192
|
},
|
|
@@ -64055,6 +64289,7 @@ export default {
|
|
|
64055
64289
|
required: ['staff_member_key', 'name'],
|
|
64056
64290
|
type: 'object',
|
|
64057
64291
|
'x-route-path': '/seam/customer/v1/staff_members',
|
|
64292
|
+
'x-undocumented': 'Internal resource for customer portals.',
|
|
64058
64293
|
},
|
|
64059
64294
|
type: 'array',
|
|
64060
64295
|
},
|
|
@@ -67316,6 +67551,7 @@ export default {
|
|
|
67316
67551
|
'can_simulate_hub_connection',
|
|
67317
67552
|
'can_simulate_hub_disconnection',
|
|
67318
67553
|
'can_simulate_paid_subscription',
|
|
67554
|
+
'can_configure_auto_lock',
|
|
67319
67555
|
],
|
|
67320
67556
|
type: 'string',
|
|
67321
67557
|
},
|
|
@@ -67348,6 +67584,7 @@ export default {
|
|
|
67348
67584
|
'can_simulate_hub_connection',
|
|
67349
67585
|
'can_simulate_hub_disconnection',
|
|
67350
67586
|
'can_simulate_paid_subscription',
|
|
67587
|
+
'can_configure_auto_lock',
|
|
67351
67588
|
],
|
|
67352
67589
|
type: 'string',
|
|
67353
67590
|
},
|
|
@@ -67519,6 +67756,7 @@ export default {
|
|
|
67519
67756
|
'can_simulate_hub_connection',
|
|
67520
67757
|
'can_simulate_hub_disconnection',
|
|
67521
67758
|
'can_simulate_paid_subscription',
|
|
67759
|
+
'can_configure_auto_lock',
|
|
67522
67760
|
],
|
|
67523
67761
|
type: 'string',
|
|
67524
67762
|
},
|
|
@@ -67547,6 +67785,7 @@ export default {
|
|
|
67547
67785
|
'can_simulate_hub_connection',
|
|
67548
67786
|
'can_simulate_hub_disconnection',
|
|
67549
67787
|
'can_simulate_paid_subscription',
|
|
67788
|
+
'can_configure_auto_lock',
|
|
67550
67789
|
],
|
|
67551
67790
|
type: 'string',
|
|
67552
67791
|
},
|