@seamapi/types 1.812.0 → 1.814.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 +240 -6
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +455 -24
- package/dist/index.cjs +240 -6
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +20 -10
- package/lib/seam/connect/models/events/devices.d.ts +25 -13
- package/lib/seam/connect/models/events/devices.js +8 -2
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +12 -6
- package/lib/seam/connect/openapi.d.ts +353 -0
- package/lib/seam/connect/openapi.js +230 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +70 -8
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/devices.ts +8 -2
- package/src/lib/seam/connect/openapi.ts +244 -2
- package/src/lib/seam/connect/route-types.ts +70 -8
|
@@ -38559,7 +38559,11 @@ export type Routes = {
|
|
|
38559
38559
|
/** ID of the action attempt associated with the lock action. */
|
|
38560
38560
|
action_attempt_id?: string | undefined;
|
|
38561
38561
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
38562
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
38562
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
38563
|
+
/**
|
|
38564
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38565
|
+
*/
|
|
38566
|
+
is_bluetooth_action?: boolean | undefined;
|
|
38563
38567
|
} | {
|
|
38564
38568
|
/** ID of the event. */
|
|
38565
38569
|
event_id: string;
|
|
@@ -38591,7 +38595,7 @@ export type Routes = {
|
|
|
38591
38595
|
/** ID of the action attempt associated with the unlock action. */
|
|
38592
38596
|
action_attempt_id?: string | undefined;
|
|
38593
38597
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
38594
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
38598
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
38595
38599
|
/**
|
|
38596
38600
|
undocumented: Unreleased.
|
|
38597
38601
|
---
|
|
@@ -38616,6 +38620,10 @@ export type Routes = {
|
|
|
38616
38620
|
ID of the ACS entrance associated with the unlock event.
|
|
38617
38621
|
*/
|
|
38618
38622
|
acs_entrance_id?: string | undefined;
|
|
38623
|
+
/**
|
|
38624
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38625
|
+
*/
|
|
38626
|
+
is_bluetooth_action?: boolean | undefined;
|
|
38619
38627
|
} | {
|
|
38620
38628
|
/** ID of the event. */
|
|
38621
38629
|
event_id: string;
|
|
@@ -41387,7 +41395,11 @@ export type Routes = {
|
|
|
41387
41395
|
/** ID of the action attempt associated with the lock action. */
|
|
41388
41396
|
action_attempt_id?: string | undefined;
|
|
41389
41397
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
41390
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
41398
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
41399
|
+
/**
|
|
41400
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41401
|
+
*/
|
|
41402
|
+
is_bluetooth_action?: boolean | undefined;
|
|
41391
41403
|
} | {
|
|
41392
41404
|
/** ID of the event. */
|
|
41393
41405
|
event_id: string;
|
|
@@ -41419,7 +41431,7 @@ export type Routes = {
|
|
|
41419
41431
|
/** ID of the action attempt associated with the unlock action. */
|
|
41420
41432
|
action_attempt_id?: string | undefined;
|
|
41421
41433
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
41422
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
41434
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
41423
41435
|
/**
|
|
41424
41436
|
undocumented: Unreleased.
|
|
41425
41437
|
---
|
|
@@ -41444,6 +41456,10 @@ export type Routes = {
|
|
|
41444
41456
|
ID of the ACS entrance associated with the unlock event.
|
|
41445
41457
|
*/
|
|
41446
41458
|
acs_entrance_id?: string | undefined;
|
|
41459
|
+
/**
|
|
41460
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41461
|
+
*/
|
|
41462
|
+
is_bluetooth_action?: boolean | undefined;
|
|
41447
41463
|
} | {
|
|
41448
41464
|
/** ID of the event. */
|
|
41449
41465
|
event_id: string;
|
|
@@ -66470,7 +66486,11 @@ export type Routes = {
|
|
|
66470
66486
|
/** ID of the action attempt associated with the lock action. */
|
|
66471
66487
|
action_attempt_id?: string | undefined;
|
|
66472
66488
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
66473
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
66489
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
66490
|
+
/**
|
|
66491
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66492
|
+
*/
|
|
66493
|
+
is_bluetooth_action?: boolean | undefined;
|
|
66474
66494
|
} | {
|
|
66475
66495
|
/** ID of the event. */
|
|
66476
66496
|
event_id: string;
|
|
@@ -66502,7 +66522,7 @@ export type Routes = {
|
|
|
66502
66522
|
/** ID of the action attempt associated with the unlock action. */
|
|
66503
66523
|
action_attempt_id?: string | undefined;
|
|
66504
66524
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
66505
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
66525
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
66506
66526
|
/**
|
|
66507
66527
|
undocumented: Unreleased.
|
|
66508
66528
|
---
|
|
@@ -66527,6 +66547,10 @@ export type Routes = {
|
|
|
66527
66547
|
ID of the ACS entrance associated with the unlock event.
|
|
66528
66548
|
*/
|
|
66529
66549
|
acs_entrance_id?: string | undefined;
|
|
66550
|
+
/**
|
|
66551
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66552
|
+
*/
|
|
66553
|
+
is_bluetooth_action?: boolean | undefined;
|
|
66530
66554
|
} | {
|
|
66531
66555
|
/** ID of the event. */
|
|
66532
66556
|
event_id: string;
|
|
@@ -68719,6 +68743,21 @@ export type Routes = {
|
|
|
68719
68743
|
jsonResponse: {};
|
|
68720
68744
|
maxDuration: undefined;
|
|
68721
68745
|
};
|
|
68746
|
+
'/spaces/add_connected_account': {
|
|
68747
|
+
route: '/spaces/add_connected_account';
|
|
68748
|
+
method: 'POST' | 'PUT';
|
|
68749
|
+
queryParams: {};
|
|
68750
|
+
jsonBody: {
|
|
68751
|
+
/** ID of the space to which you want to add the connected account. */
|
|
68752
|
+
space_id: string;
|
|
68753
|
+
/** ID of the connected account that you want to add to the space. */
|
|
68754
|
+
connected_account_id: string;
|
|
68755
|
+
};
|
|
68756
|
+
commonParams: {};
|
|
68757
|
+
formData: {};
|
|
68758
|
+
jsonResponse: {};
|
|
68759
|
+
maxDuration: undefined;
|
|
68760
|
+
};
|
|
68722
68761
|
'/spaces/add_devices': {
|
|
68723
68762
|
route: '/spaces/add_devices';
|
|
68724
68763
|
method: 'POST' | 'PUT';
|
|
@@ -70819,6 +70858,21 @@ export type Routes = {
|
|
|
70819
70858
|
jsonResponse: {};
|
|
70820
70859
|
maxDuration: undefined;
|
|
70821
70860
|
};
|
|
70861
|
+
'/spaces/remove_connected_account': {
|
|
70862
|
+
route: '/spaces/remove_connected_account';
|
|
70863
|
+
method: 'POST' | 'DELETE';
|
|
70864
|
+
queryParams: {};
|
|
70865
|
+
jsonBody: {};
|
|
70866
|
+
commonParams: {
|
|
70867
|
+
/** ID of the space from which you want to remove the connected account. */
|
|
70868
|
+
space_id: string;
|
|
70869
|
+
/** ID of the connected account that you want to remove from the space. */
|
|
70870
|
+
connected_account_id: string;
|
|
70871
|
+
};
|
|
70872
|
+
formData: {};
|
|
70873
|
+
jsonResponse: {};
|
|
70874
|
+
maxDuration: undefined;
|
|
70875
|
+
};
|
|
70822
70876
|
'/spaces/remove_devices': {
|
|
70823
70877
|
route: '/spaces/remove_devices';
|
|
70824
70878
|
method: 'POST' | 'DELETE';
|
|
@@ -98858,7 +98912,11 @@ export type Routes = {
|
|
|
98858
98912
|
/** ID of the action attempt associated with the lock action. */
|
|
98859
98913
|
action_attempt_id?: string | undefined;
|
|
98860
98914
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
98861
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
98915
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
98916
|
+
/**
|
|
98917
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
98918
|
+
*/
|
|
98919
|
+
is_bluetooth_action?: boolean | undefined;
|
|
98862
98920
|
} | {
|
|
98863
98921
|
/** ID of the event. */
|
|
98864
98922
|
event_id: string;
|
|
@@ -98890,7 +98948,7 @@ export type Routes = {
|
|
|
98890
98948
|
/** ID of the action attempt associated with the unlock action. */
|
|
98891
98949
|
action_attempt_id?: string | undefined;
|
|
98892
98950
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
98893
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
98951
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
98894
98952
|
/**
|
|
98895
98953
|
undocumented: Unreleased.
|
|
98896
98954
|
---
|
|
@@ -98915,6 +98973,10 @@ export type Routes = {
|
|
|
98915
98973
|
ID of the ACS entrance associated with the unlock event.
|
|
98916
98974
|
*/
|
|
98917
98975
|
acs_entrance_id?: string | undefined;
|
|
98976
|
+
/**
|
|
98977
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
98978
|
+
*/
|
|
98979
|
+
is_bluetooth_action?: boolean | undefined;
|
|
98918
98980
|
} | {
|
|
98919
98981
|
/** ID of the event. */
|
|
98920
98982
|
event_id: string;
|
package/package.json
CHANGED
|
@@ -66,9 +66,9 @@ const device_event_issue_properties = {
|
|
|
66
66
|
}
|
|
67
67
|
|
|
68
68
|
export const lock_method = z
|
|
69
|
-
.enum(['keycode', 'manual', 'automatic', 'unknown', '
|
|
69
|
+
.enum(['keycode', 'manual', 'automatic', 'unknown', 'remote'])
|
|
70
70
|
.describe(
|
|
71
|
-
'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
|
|
71
|
+
'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. The `remote` method indicates any remote (un)lock action, including Bluetooth, mobile app, or Seam API. For Seam-initiated remote (un)locks, look up the `action_attempt_id`.',
|
|
72
72
|
)
|
|
73
73
|
export type LockMethod = z.infer<typeof lock_method>
|
|
74
74
|
|
|
@@ -424,6 +424,9 @@ export const lock_locked_event = device_event.extend({
|
|
|
424
424
|
method: lock_method.describe(
|
|
425
425
|
'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
|
|
426
426
|
),
|
|
427
|
+
is_bluetooth_action: z.boolean().optional().describe(`
|
|
428
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
429
|
+
`),
|
|
427
430
|
}).describe(`
|
|
428
431
|
---
|
|
429
432
|
route_path: /locks
|
|
@@ -481,6 +484,9 @@ export const lock_unlocked_event = device_event.extend({
|
|
|
481
484
|
.uuid()
|
|
482
485
|
.optional()
|
|
483
486
|
.describe('ID of the affected device.'),
|
|
487
|
+
is_bluetooth_action: z.boolean().optional().describe(`
|
|
488
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
489
|
+
`),
|
|
484
490
|
}).describe(`
|
|
485
491
|
---
|
|
486
492
|
route_path: /locks
|
|
@@ -22973,10 +22973,15 @@ export default {
|
|
|
22973
22973
|
type: 'string',
|
|
22974
22974
|
},
|
|
22975
22975
|
event_type: { enum: ['lock.locked'], type: 'string' },
|
|
22976
|
+
is_bluetooth_action: {
|
|
22977
|
+
description:
|
|
22978
|
+
"\n Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
|
|
22979
|
+
type: 'boolean',
|
|
22980
|
+
},
|
|
22976
22981
|
method: {
|
|
22977
22982
|
description:
|
|
22978
22983
|
'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
|
|
22979
|
-
enum: ['keycode', 'manual', 'automatic', 'unknown', '
|
|
22984
|
+
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
|
|
22980
22985
|
type: 'string',
|
|
22981
22986
|
},
|
|
22982
22987
|
occurred_at: {
|
|
@@ -23086,10 +23091,15 @@ export default {
|
|
|
23086
23091
|
type: 'string',
|
|
23087
23092
|
},
|
|
23088
23093
|
event_type: { enum: ['lock.unlocked'], type: 'string' },
|
|
23094
|
+
is_bluetooth_action: {
|
|
23095
|
+
description:
|
|
23096
|
+
"\n Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
|
|
23097
|
+
type: 'boolean',
|
|
23098
|
+
},
|
|
23089
23099
|
method: {
|
|
23090
23100
|
description:
|
|
23091
23101
|
'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
|
|
23092
|
-
enum: ['keycode', 'manual', 'automatic', 'unknown', '
|
|
23102
|
+
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
|
|
23093
23103
|
type: 'string',
|
|
23094
23104
|
},
|
|
23095
23105
|
occurred_at: {
|
|
@@ -73771,6 +73781,122 @@ export default {
|
|
|
73771
73781
|
'x-title': 'Add Entrances to a Space',
|
|
73772
73782
|
},
|
|
73773
73783
|
},
|
|
73784
|
+
'/spaces/add_connected_account': {
|
|
73785
|
+
post: {
|
|
73786
|
+
description:
|
|
73787
|
+
'Adds a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) to a specific space.',
|
|
73788
|
+
operationId: 'spacesAddConnectedAccountPost',
|
|
73789
|
+
requestBody: {
|
|
73790
|
+
content: {
|
|
73791
|
+
'application/json': {
|
|
73792
|
+
schema: {
|
|
73793
|
+
properties: {
|
|
73794
|
+
connected_account_id: {
|
|
73795
|
+
description:
|
|
73796
|
+
'ID of the connected account that you want to add to the space.',
|
|
73797
|
+
format: 'uuid',
|
|
73798
|
+
type: 'string',
|
|
73799
|
+
},
|
|
73800
|
+
space_id: {
|
|
73801
|
+
description:
|
|
73802
|
+
'ID of the space to which you want to add the connected account.',
|
|
73803
|
+
format: 'uuid',
|
|
73804
|
+
type: 'string',
|
|
73805
|
+
},
|
|
73806
|
+
},
|
|
73807
|
+
required: ['space_id', 'connected_account_id'],
|
|
73808
|
+
type: 'object',
|
|
73809
|
+
},
|
|
73810
|
+
},
|
|
73811
|
+
},
|
|
73812
|
+
},
|
|
73813
|
+
responses: {
|
|
73814
|
+
200: {
|
|
73815
|
+
content: {
|
|
73816
|
+
'application/json': {
|
|
73817
|
+
schema: {
|
|
73818
|
+
properties: { ok: { type: 'boolean' } },
|
|
73819
|
+
required: ['ok'],
|
|
73820
|
+
type: 'object',
|
|
73821
|
+
},
|
|
73822
|
+
},
|
|
73823
|
+
},
|
|
73824
|
+
description: 'OK',
|
|
73825
|
+
},
|
|
73826
|
+
400: { description: 'Bad Request' },
|
|
73827
|
+
401: { description: 'Unauthorized' },
|
|
73828
|
+
},
|
|
73829
|
+
security: [
|
|
73830
|
+
{ pat_with_workspace: [] },
|
|
73831
|
+
{ console_session_with_workspace: [] },
|
|
73832
|
+
{ api_key: [] },
|
|
73833
|
+
{ client_session_with_customer: [] },
|
|
73834
|
+
],
|
|
73835
|
+
summary: '/spaces/add_connected_account',
|
|
73836
|
+
tags: [],
|
|
73837
|
+
'x-fern-sdk-group-name': ['spaces'],
|
|
73838
|
+
'x-fern-sdk-method-name': 'add_connected_account',
|
|
73839
|
+
'x-response-key': null,
|
|
73840
|
+
'x-title': 'Add a Connected Account to a Space',
|
|
73841
|
+
},
|
|
73842
|
+
put: {
|
|
73843
|
+
description:
|
|
73844
|
+
'Adds a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) to a specific space.',
|
|
73845
|
+
operationId: 'spacesAddConnectedAccountPut',
|
|
73846
|
+
requestBody: {
|
|
73847
|
+
content: {
|
|
73848
|
+
'application/json': {
|
|
73849
|
+
schema: {
|
|
73850
|
+
properties: {
|
|
73851
|
+
connected_account_id: {
|
|
73852
|
+
description:
|
|
73853
|
+
'ID of the connected account that you want to add to the space.',
|
|
73854
|
+
format: 'uuid',
|
|
73855
|
+
type: 'string',
|
|
73856
|
+
},
|
|
73857
|
+
space_id: {
|
|
73858
|
+
description:
|
|
73859
|
+
'ID of the space to which you want to add the connected account.',
|
|
73860
|
+
format: 'uuid',
|
|
73861
|
+
type: 'string',
|
|
73862
|
+
},
|
|
73863
|
+
},
|
|
73864
|
+
required: ['space_id', 'connected_account_id'],
|
|
73865
|
+
type: 'object',
|
|
73866
|
+
},
|
|
73867
|
+
},
|
|
73868
|
+
},
|
|
73869
|
+
},
|
|
73870
|
+
responses: {
|
|
73871
|
+
200: {
|
|
73872
|
+
content: {
|
|
73873
|
+
'application/json': {
|
|
73874
|
+
schema: {
|
|
73875
|
+
properties: { ok: { type: 'boolean' } },
|
|
73876
|
+
required: ['ok'],
|
|
73877
|
+
type: 'object',
|
|
73878
|
+
},
|
|
73879
|
+
},
|
|
73880
|
+
},
|
|
73881
|
+
description: 'OK',
|
|
73882
|
+
},
|
|
73883
|
+
400: { description: 'Bad Request' },
|
|
73884
|
+
401: { description: 'Unauthorized' },
|
|
73885
|
+
},
|
|
73886
|
+
security: [
|
|
73887
|
+
{ pat_with_workspace: [] },
|
|
73888
|
+
{ console_session_with_workspace: [] },
|
|
73889
|
+
{ api_key: [] },
|
|
73890
|
+
{ client_session_with_customer: [] },
|
|
73891
|
+
],
|
|
73892
|
+
summary: '/spaces/add_connected_account',
|
|
73893
|
+
tags: [],
|
|
73894
|
+
'x-fern-sdk-group-name': ['spaces'],
|
|
73895
|
+
'x-fern-sdk-method-name': 'add_connected_account',
|
|
73896
|
+
'x-response-key': null,
|
|
73897
|
+
'x-title': 'Add a Connected Account to a Space',
|
|
73898
|
+
},
|
|
73899
|
+
},
|
|
73774
73900
|
'/spaces/add_devices': {
|
|
73775
73901
|
post: {
|
|
73776
73902
|
description: 'Adds devices to a specific space.',
|
|
@@ -74765,6 +74891,122 @@ export default {
|
|
|
74765
74891
|
'x-title': 'Remove Entrances from a Space',
|
|
74766
74892
|
},
|
|
74767
74893
|
},
|
|
74894
|
+
'/spaces/remove_connected_account': {
|
|
74895
|
+
delete: {
|
|
74896
|
+
description:
|
|
74897
|
+
'Removes a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) from a specific space.',
|
|
74898
|
+
operationId: 'spacesRemoveConnectedAccountDelete',
|
|
74899
|
+
parameters: [
|
|
74900
|
+
{
|
|
74901
|
+
in: 'query',
|
|
74902
|
+
name: 'space_id',
|
|
74903
|
+
required: true,
|
|
74904
|
+
schema: {
|
|
74905
|
+
description:
|
|
74906
|
+
'ID of the space from which you want to remove the connected account.',
|
|
74907
|
+
format: 'uuid',
|
|
74908
|
+
type: 'string',
|
|
74909
|
+
},
|
|
74910
|
+
},
|
|
74911
|
+
{
|
|
74912
|
+
in: 'query',
|
|
74913
|
+
name: 'connected_account_id',
|
|
74914
|
+
required: true,
|
|
74915
|
+
schema: {
|
|
74916
|
+
description:
|
|
74917
|
+
'ID of the connected account that you want to remove from the space.',
|
|
74918
|
+
format: 'uuid',
|
|
74919
|
+
type: 'string',
|
|
74920
|
+
},
|
|
74921
|
+
},
|
|
74922
|
+
],
|
|
74923
|
+
responses: {
|
|
74924
|
+
200: {
|
|
74925
|
+
content: {
|
|
74926
|
+
'application/json': {
|
|
74927
|
+
schema: {
|
|
74928
|
+
properties: { ok: { type: 'boolean' } },
|
|
74929
|
+
required: ['ok'],
|
|
74930
|
+
type: 'object',
|
|
74931
|
+
},
|
|
74932
|
+
},
|
|
74933
|
+
},
|
|
74934
|
+
description: 'OK',
|
|
74935
|
+
},
|
|
74936
|
+
400: { description: 'Bad Request' },
|
|
74937
|
+
401: { description: 'Unauthorized' },
|
|
74938
|
+
},
|
|
74939
|
+
security: [
|
|
74940
|
+
{ pat_with_workspace: [] },
|
|
74941
|
+
{ console_session_with_workspace: [] },
|
|
74942
|
+
{ api_key: [] },
|
|
74943
|
+
{ client_session_with_customer: [] },
|
|
74944
|
+
],
|
|
74945
|
+
summary: '/spaces/remove_connected_account',
|
|
74946
|
+
tags: [],
|
|
74947
|
+
'x-fern-sdk-group-name': ['spaces'],
|
|
74948
|
+
'x-fern-sdk-method-name': 'remove_connected_account',
|
|
74949
|
+
'x-response-key': null,
|
|
74950
|
+
'x-title': 'Remove a Connected Account from a Space',
|
|
74951
|
+
},
|
|
74952
|
+
post: {
|
|
74953
|
+
description:
|
|
74954
|
+
'Removes a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) from a specific space.',
|
|
74955
|
+
operationId: 'spacesRemoveConnectedAccountPost',
|
|
74956
|
+
requestBody: {
|
|
74957
|
+
content: {
|
|
74958
|
+
'application/json': {
|
|
74959
|
+
schema: {
|
|
74960
|
+
properties: {
|
|
74961
|
+
connected_account_id: {
|
|
74962
|
+
description:
|
|
74963
|
+
'ID of the connected account that you want to remove from the space.',
|
|
74964
|
+
format: 'uuid',
|
|
74965
|
+
type: 'string',
|
|
74966
|
+
},
|
|
74967
|
+
space_id: {
|
|
74968
|
+
description:
|
|
74969
|
+
'ID of the space from which you want to remove the connected account.',
|
|
74970
|
+
format: 'uuid',
|
|
74971
|
+
type: 'string',
|
|
74972
|
+
},
|
|
74973
|
+
},
|
|
74974
|
+
required: ['space_id', 'connected_account_id'],
|
|
74975
|
+
type: 'object',
|
|
74976
|
+
},
|
|
74977
|
+
},
|
|
74978
|
+
},
|
|
74979
|
+
},
|
|
74980
|
+
responses: {
|
|
74981
|
+
200: {
|
|
74982
|
+
content: {
|
|
74983
|
+
'application/json': {
|
|
74984
|
+
schema: {
|
|
74985
|
+
properties: { ok: { type: 'boolean' } },
|
|
74986
|
+
required: ['ok'],
|
|
74987
|
+
type: 'object',
|
|
74988
|
+
},
|
|
74989
|
+
},
|
|
74990
|
+
},
|
|
74991
|
+
description: 'OK',
|
|
74992
|
+
},
|
|
74993
|
+
400: { description: 'Bad Request' },
|
|
74994
|
+
401: { description: 'Unauthorized' },
|
|
74995
|
+
},
|
|
74996
|
+
security: [
|
|
74997
|
+
{ pat_with_workspace: [] },
|
|
74998
|
+
{ console_session_with_workspace: [] },
|
|
74999
|
+
{ api_key: [] },
|
|
75000
|
+
{ client_session_with_customer: [] },
|
|
75001
|
+
],
|
|
75002
|
+
summary: '/spaces/remove_connected_account',
|
|
75003
|
+
tags: [],
|
|
75004
|
+
'x-fern-sdk-group-name': ['spaces'],
|
|
75005
|
+
'x-fern-sdk-method-name': 'remove_connected_account',
|
|
75006
|
+
'x-response-key': null,
|
|
75007
|
+
'x-title': 'Remove a Connected Account from a Space',
|
|
75008
|
+
},
|
|
75009
|
+
},
|
|
74768
75010
|
'/spaces/remove_devices': {
|
|
74769
75011
|
delete: {
|
|
74770
75012
|
description: 'Removes devices from a specific space.',
|
|
@@ -46096,7 +46096,11 @@ export type Routes = {
|
|
|
46096
46096
|
| 'manual'
|
|
46097
46097
|
| 'automatic'
|
|
46098
46098
|
| 'unknown'
|
|
46099
|
-
| '
|
|
46099
|
+
| 'remote'
|
|
46100
|
+
/**
|
|
46101
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46102
|
+
*/
|
|
46103
|
+
is_bluetooth_action?: boolean | undefined
|
|
46100
46104
|
}
|
|
46101
46105
|
| {
|
|
46102
46106
|
/** ID of the event. */
|
|
@@ -46138,7 +46142,7 @@ export type Routes = {
|
|
|
46138
46142
|
| 'manual'
|
|
46139
46143
|
| 'automatic'
|
|
46140
46144
|
| 'unknown'
|
|
46141
|
-
| '
|
|
46145
|
+
| 'remote'
|
|
46142
46146
|
/**
|
|
46143
46147
|
undocumented: Unreleased.
|
|
46144
46148
|
---
|
|
@@ -46163,6 +46167,10 @@ export type Routes = {
|
|
|
46163
46167
|
ID of the ACS entrance associated with the unlock event.
|
|
46164
46168
|
*/
|
|
46165
46169
|
acs_entrance_id?: string | undefined
|
|
46170
|
+
/**
|
|
46171
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46172
|
+
*/
|
|
46173
|
+
is_bluetooth_action?: boolean | undefined
|
|
46166
46174
|
}
|
|
46167
46175
|
| {
|
|
46168
46176
|
/** ID of the event. */
|
|
@@ -49493,7 +49501,11 @@ export type Routes = {
|
|
|
49493
49501
|
/** ID of the action attempt associated with the lock action. */
|
|
49494
49502
|
action_attempt_id?: string | undefined
|
|
49495
49503
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
49496
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
49504
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
49505
|
+
/**
|
|
49506
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49507
|
+
*/
|
|
49508
|
+
is_bluetooth_action?: boolean | undefined
|
|
49497
49509
|
}
|
|
49498
49510
|
| {
|
|
49499
49511
|
/** ID of the event. */
|
|
@@ -49530,7 +49542,7 @@ export type Routes = {
|
|
|
49530
49542
|
/** ID of the action attempt associated with the unlock action. */
|
|
49531
49543
|
action_attempt_id?: string | undefined
|
|
49532
49544
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
49533
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
49545
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
49534
49546
|
/**
|
|
49535
49547
|
undocumented: Unreleased.
|
|
49536
49548
|
---
|
|
@@ -49555,6 +49567,10 @@ export type Routes = {
|
|
|
49555
49567
|
ID of the ACS entrance associated with the unlock event.
|
|
49556
49568
|
*/
|
|
49557
49569
|
acs_entrance_id?: string | undefined
|
|
49570
|
+
/**
|
|
49571
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49572
|
+
*/
|
|
49573
|
+
is_bluetooth_action?: boolean | undefined
|
|
49558
49574
|
}
|
|
49559
49575
|
| {
|
|
49560
49576
|
/** ID of the event. */
|
|
@@ -79437,7 +79453,11 @@ export type Routes = {
|
|
|
79437
79453
|
/** ID of the action attempt associated with the lock action. */
|
|
79438
79454
|
action_attempt_id?: string | undefined
|
|
79439
79455
|
/** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
|
|
79440
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
79456
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
79457
|
+
/**
|
|
79458
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79459
|
+
*/
|
|
79460
|
+
is_bluetooth_action?: boolean | undefined
|
|
79441
79461
|
}
|
|
79442
79462
|
| {
|
|
79443
79463
|
/** ID of the event. */
|
|
@@ -79474,7 +79494,7 @@ export type Routes = {
|
|
|
79474
79494
|
/** ID of the action attempt associated with the unlock action. */
|
|
79475
79495
|
action_attempt_id?: string | undefined
|
|
79476
79496
|
/** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
|
|
79477
|
-
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | '
|
|
79497
|
+
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
79478
79498
|
/**
|
|
79479
79499
|
undocumented: Unreleased.
|
|
79480
79500
|
---
|
|
@@ -79499,6 +79519,10 @@ export type Routes = {
|
|
|
79499
79519
|
ID of the ACS entrance associated with the unlock event.
|
|
79500
79520
|
*/
|
|
79501
79521
|
acs_entrance_id?: string | undefined
|
|
79522
|
+
/**
|
|
79523
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79524
|
+
*/
|
|
79525
|
+
is_bluetooth_action?: boolean | undefined
|
|
79502
79526
|
}
|
|
79503
79527
|
| {
|
|
79504
79528
|
/** ID of the event. */
|
|
@@ -81995,6 +82019,21 @@ export type Routes = {
|
|
|
81995
82019
|
jsonResponse: {}
|
|
81996
82020
|
maxDuration: undefined
|
|
81997
82021
|
}
|
|
82022
|
+
'/spaces/add_connected_account': {
|
|
82023
|
+
route: '/spaces/add_connected_account'
|
|
82024
|
+
method: 'POST' | 'PUT'
|
|
82025
|
+
queryParams: {}
|
|
82026
|
+
jsonBody: {
|
|
82027
|
+
/** ID of the space to which you want to add the connected account. */
|
|
82028
|
+
space_id: string
|
|
82029
|
+
/** ID of the connected account that you want to add to the space. */
|
|
82030
|
+
connected_account_id: string
|
|
82031
|
+
}
|
|
82032
|
+
commonParams: {}
|
|
82033
|
+
formData: {}
|
|
82034
|
+
jsonResponse: {}
|
|
82035
|
+
maxDuration: undefined
|
|
82036
|
+
}
|
|
81998
82037
|
'/spaces/add_devices': {
|
|
81999
82038
|
route: '/spaces/add_devices'
|
|
82000
82039
|
method: 'POST' | 'PUT'
|
|
@@ -84597,6 +84636,21 @@ export type Routes = {
|
|
|
84597
84636
|
jsonResponse: {}
|
|
84598
84637
|
maxDuration: undefined
|
|
84599
84638
|
}
|
|
84639
|
+
'/spaces/remove_connected_account': {
|
|
84640
|
+
route: '/spaces/remove_connected_account'
|
|
84641
|
+
method: 'POST' | 'DELETE'
|
|
84642
|
+
queryParams: {}
|
|
84643
|
+
jsonBody: {}
|
|
84644
|
+
commonParams: {
|
|
84645
|
+
/** ID of the space from which you want to remove the connected account. */
|
|
84646
|
+
space_id: string
|
|
84647
|
+
/** ID of the connected account that you want to remove from the space. */
|
|
84648
|
+
connected_account_id: string
|
|
84649
|
+
}
|
|
84650
|
+
formData: {}
|
|
84651
|
+
jsonResponse: {}
|
|
84652
|
+
maxDuration: undefined
|
|
84653
|
+
}
|
|
84600
84654
|
'/spaces/remove_devices': {
|
|
84601
84655
|
route: '/spaces/remove_devices'
|
|
84602
84656
|
method: 'POST' | 'DELETE'
|
|
@@ -117715,7 +117769,11 @@ export type Routes = {
|
|
|
117715
117769
|
| 'manual'
|
|
117716
117770
|
| 'automatic'
|
|
117717
117771
|
| 'unknown'
|
|
117718
|
-
| '
|
|
117772
|
+
| 'remote'
|
|
117773
|
+
/**
|
|
117774
|
+
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117775
|
+
*/
|
|
117776
|
+
is_bluetooth_action?: boolean | undefined
|
|
117719
117777
|
}
|
|
117720
117778
|
| {
|
|
117721
117779
|
/** ID of the event. */
|
|
@@ -117757,7 +117815,7 @@ export type Routes = {
|
|
|
117757
117815
|
| 'manual'
|
|
117758
117816
|
| 'automatic'
|
|
117759
117817
|
| 'unknown'
|
|
117760
|
-
| '
|
|
117818
|
+
| 'remote'
|
|
117761
117819
|
/**
|
|
117762
117820
|
undocumented: Unreleased.
|
|
117763
117821
|
---
|
|
@@ -117782,6 +117840,10 @@ export type Routes = {
|
|
|
117782
117840
|
ID of the ACS entrance associated with the unlock event.
|
|
117783
117841
|
*/
|
|
117784
117842
|
acs_entrance_id?: string | undefined
|
|
117843
|
+
/**
|
|
117844
|
+
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117845
|
+
*/
|
|
117846
|
+
is_bluetooth_action?: boolean | undefined
|
|
117785
117847
|
}
|
|
117786
117848
|
| {
|
|
117787
117849
|
/** ID of the event. */
|