@seamapi/types 1.1147.0 → 1.1149.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.
|
@@ -57922,9 +57922,9 @@ export type Routes = {
|
|
|
57922
57922
|
customer_key?: string | undefined;
|
|
57923
57923
|
/** Offset for the events that you want to list. */
|
|
57924
57924
|
unstable_offset?: number | undefined;
|
|
57925
|
-
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
|
|
57925
|
+
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago. */
|
|
57926
57926
|
since?: string | undefined;
|
|
57927
|
-
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
57927
|
+
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago. */
|
|
57928
57928
|
between?: string[] | undefined;
|
|
57929
57929
|
/** ID of the device for which you want to list events. */
|
|
57930
57930
|
device_id?: string | undefined;
|
|
@@ -92411,6 +92411,30 @@ export type Routes = {
|
|
|
92411
92411
|
};
|
|
92412
92412
|
maxDuration: undefined;
|
|
92413
92413
|
};
|
|
92414
|
+
'/seam/console/v1/workspace/get_summary': {
|
|
92415
|
+
route: '/seam/console/v1/workspace/get_summary';
|
|
92416
|
+
method: 'GET' | 'POST';
|
|
92417
|
+
queryParams: {};
|
|
92418
|
+
jsonBody: {};
|
|
92419
|
+
commonParams: {
|
|
92420
|
+
/** Customer key for which you want to summarize the workspace. */
|
|
92421
|
+
customer_key?: string | undefined;
|
|
92422
|
+
};
|
|
92423
|
+
formData: {};
|
|
92424
|
+
jsonResponse: {
|
|
92425
|
+
workspace_summary: {
|
|
92426
|
+
device_count: number;
|
|
92427
|
+
online_device_count: number;
|
|
92428
|
+
devices_needing_attention_count: number;
|
|
92429
|
+
active_access_code_count: number;
|
|
92430
|
+
access_code_delivery_7d: {
|
|
92431
|
+
delivered_count: number;
|
|
92432
|
+
failed_count: number;
|
|
92433
|
+
};
|
|
92434
|
+
};
|
|
92435
|
+
};
|
|
92436
|
+
maxDuration: undefined;
|
|
92437
|
+
};
|
|
92414
92438
|
'/seam/customer/v1/access_grants/list': {
|
|
92415
92439
|
route: '/seam/customer/v1/access_grants/list';
|
|
92416
92440
|
method: 'GET' | 'POST';
|
|
@@ -96061,9 +96085,9 @@ export type Routes = {
|
|
|
96061
96085
|
commonParams: {
|
|
96062
96086
|
/** ID of the space for which you want to list events. */
|
|
96063
96087
|
space_id: string;
|
|
96064
|
-
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
|
|
96088
|
+
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago. */
|
|
96065
96089
|
since?: string | undefined;
|
|
96066
|
-
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
96090
|
+
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago. */
|
|
96067
96091
|
between?: string[] | undefined;
|
|
96068
96092
|
/** Type of the events that you want to list. */
|
|
96069
96093
|
event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_delete' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
|
package/package.json
CHANGED
|
@@ -58660,7 +58660,7 @@ const openapi: OpenAPISpec = {
|
|
|
58660
58660
|
'/events/get': {
|
|
58661
58661
|
get: {
|
|
58662
58662
|
description:
|
|
58663
|
-
'Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.',
|
|
58663
|
+
'Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.',
|
|
58664
58664
|
operationId: 'eventsGetGet',
|
|
58665
58665
|
parameters: [
|
|
58666
58666
|
{
|
|
@@ -58735,7 +58735,7 @@ const openapi: OpenAPISpec = {
|
|
|
58735
58735
|
'/events/list': {
|
|
58736
58736
|
get: {
|
|
58737
58737
|
description:
|
|
58738
|
-
'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.',
|
|
58738
|
+
'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.',
|
|
58739
58739
|
operationId: 'eventsListGet',
|
|
58740
58740
|
parameters: [
|
|
58741
58741
|
{
|
|
@@ -58761,7 +58761,7 @@ const openapi: OpenAPISpec = {
|
|
|
58761
58761
|
name: 'since',
|
|
58762
58762
|
schema: {
|
|
58763
58763
|
description:
|
|
58764
|
-
'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
|
|
58764
|
+
'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.',
|
|
58765
58765
|
type: 'string',
|
|
58766
58766
|
},
|
|
58767
58767
|
},
|
|
@@ -58770,7 +58770,7 @@ const openapi: OpenAPISpec = {
|
|
|
58770
58770
|
name: 'between',
|
|
58771
58771
|
schema: {
|
|
58772
58772
|
description:
|
|
58773
|
-
'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
|
|
58773
|
+
'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.',
|
|
58774
58774
|
items: { type: 'string' },
|
|
58775
58775
|
maxItems: 2,
|
|
58776
58776
|
minItems: 2,
|
|
@@ -63913,6 +63913,76 @@ const openapi: OpenAPISpec = {
|
|
|
63913
63913
|
'x-undocumented': 'Internal endpoint for Console',
|
|
63914
63914
|
},
|
|
63915
63915
|
},
|
|
63916
|
+
'/seam/console/v1/workspace/get_summary': {
|
|
63917
|
+
get: {
|
|
63918
|
+
description:
|
|
63919
|
+
'Returns the device and access code counts shown on the Console home page.',
|
|
63920
|
+
operationId: 'seamConsoleV1WorkspaceGetSummaryGet',
|
|
63921
|
+
parameters: [
|
|
63922
|
+
{
|
|
63923
|
+
in: 'query',
|
|
63924
|
+
name: 'customer_key',
|
|
63925
|
+
schema: {
|
|
63926
|
+
description:
|
|
63927
|
+
'Customer key for which you want to summarize the workspace.',
|
|
63928
|
+
minLength: 1,
|
|
63929
|
+
type: 'string',
|
|
63930
|
+
},
|
|
63931
|
+
},
|
|
63932
|
+
],
|
|
63933
|
+
responses: {
|
|
63934
|
+
'200': {
|
|
63935
|
+
content: {
|
|
63936
|
+
'application/json': {
|
|
63937
|
+
schema: {
|
|
63938
|
+
properties: {
|
|
63939
|
+
ok: { type: 'boolean' },
|
|
63940
|
+
workspace_summary: {
|
|
63941
|
+
properties: {
|
|
63942
|
+
access_code_delivery_7d: {
|
|
63943
|
+
properties: {
|
|
63944
|
+
delivered_count: { type: 'integer' },
|
|
63945
|
+
failed_count: { type: 'integer' },
|
|
63946
|
+
},
|
|
63947
|
+
required: ['delivered_count', 'failed_count'],
|
|
63948
|
+
type: 'object',
|
|
63949
|
+
},
|
|
63950
|
+
active_access_code_count: { type: 'integer' },
|
|
63951
|
+
device_count: { type: 'integer' },
|
|
63952
|
+
devices_needing_attention_count: { type: 'integer' },
|
|
63953
|
+
online_device_count: { type: 'integer' },
|
|
63954
|
+
},
|
|
63955
|
+
required: [
|
|
63956
|
+
'device_count',
|
|
63957
|
+
'online_device_count',
|
|
63958
|
+
'devices_needing_attention_count',
|
|
63959
|
+
'active_access_code_count',
|
|
63960
|
+
'access_code_delivery_7d',
|
|
63961
|
+
],
|
|
63962
|
+
type: 'object',
|
|
63963
|
+
},
|
|
63964
|
+
},
|
|
63965
|
+
required: ['workspace_summary', 'ok'],
|
|
63966
|
+
type: 'object',
|
|
63967
|
+
},
|
|
63968
|
+
},
|
|
63969
|
+
},
|
|
63970
|
+
description: 'OK',
|
|
63971
|
+
},
|
|
63972
|
+
'400': { description: 'Bad Request' },
|
|
63973
|
+
'401': { description: 'Unauthorized' },
|
|
63974
|
+
},
|
|
63975
|
+
security: [{ console_session_with_workspace: [] }],
|
|
63976
|
+
summary: '/seam/console/v1/workspace/get_summary',
|
|
63977
|
+
tags: [],
|
|
63978
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
|
|
63979
|
+
'x-fern-sdk-method-name': 'get_summary',
|
|
63980
|
+
'x-fern-sdk-return-value': 'workspace_summary',
|
|
63981
|
+
'x-response-key': 'workspace_summary',
|
|
63982
|
+
'x-title': 'Get Workspace Summary',
|
|
63983
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
63984
|
+
},
|
|
63985
|
+
},
|
|
63916
63986
|
'/seam/customer/v1/access_grants/list': {
|
|
63917
63987
|
get: {
|
|
63918
63988
|
description: 'Gets an Access Grant.',
|
|
@@ -67957,7 +68027,7 @@ const openapi: OpenAPISpec = {
|
|
|
67957
68027
|
required: false,
|
|
67958
68028
|
schema: {
|
|
67959
68029
|
description:
|
|
67960
|
-
'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
|
|
68030
|
+
'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.',
|
|
67961
68031
|
type: 'string',
|
|
67962
68032
|
},
|
|
67963
68033
|
},
|
|
@@ -67967,7 +68037,7 @@ const openapi: OpenAPISpec = {
|
|
|
67967
68037
|
required: false,
|
|
67968
68038
|
schema: {
|
|
67969
68039
|
description:
|
|
67970
|
-
'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
|
|
68040
|
+
'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.',
|
|
67971
68041
|
items: { type: 'string' },
|
|
67972
68042
|
maxItems: 2,
|
|
67973
68043
|
minItems: 2,
|
|
@@ -69459,9 +69459,9 @@ export type Routes = {
|
|
|
69459
69459
|
customer_key?: string | undefined
|
|
69460
69460
|
/** Offset for the events that you want to list. */
|
|
69461
69461
|
unstable_offset?: number | undefined
|
|
69462
|
-
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
|
|
69462
|
+
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago. */
|
|
69463
69463
|
since?: string | undefined
|
|
69464
|
-
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
69464
|
+
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago. */
|
|
69465
69465
|
between?: string[] | undefined
|
|
69466
69466
|
/** ID of the device for which you want to list events. */
|
|
69467
69467
|
device_id?: string | undefined
|
|
@@ -110211,6 +110211,30 @@ export type Routes = {
|
|
|
110211
110211
|
}
|
|
110212
110212
|
maxDuration: undefined
|
|
110213
110213
|
}
|
|
110214
|
+
'/seam/console/v1/workspace/get_summary': {
|
|
110215
|
+
route: '/seam/console/v1/workspace/get_summary'
|
|
110216
|
+
method: 'GET' | 'POST'
|
|
110217
|
+
queryParams: {}
|
|
110218
|
+
jsonBody: {}
|
|
110219
|
+
commonParams: {
|
|
110220
|
+
/** Customer key for which you want to summarize the workspace. */
|
|
110221
|
+
customer_key?: string | undefined
|
|
110222
|
+
}
|
|
110223
|
+
formData: {}
|
|
110224
|
+
jsonResponse: {
|
|
110225
|
+
workspace_summary: {
|
|
110226
|
+
device_count: number
|
|
110227
|
+
online_device_count: number
|
|
110228
|
+
devices_needing_attention_count: number
|
|
110229
|
+
active_access_code_count: number
|
|
110230
|
+
access_code_delivery_7d: {
|
|
110231
|
+
delivered_count: number
|
|
110232
|
+
failed_count: number
|
|
110233
|
+
}
|
|
110234
|
+
}
|
|
110235
|
+
}
|
|
110236
|
+
maxDuration: undefined
|
|
110237
|
+
}
|
|
110214
110238
|
'/seam/customer/v1/access_grants/list': {
|
|
110215
110239
|
route: '/seam/customer/v1/access_grants/list'
|
|
110216
110240
|
method: 'GET' | 'POST'
|
|
@@ -114507,9 +114531,9 @@ export type Routes = {
|
|
|
114507
114531
|
commonParams: {
|
|
114508
114532
|
/** ID of the space for which you want to list events. */
|
|
114509
114533
|
space_id: string
|
|
114510
|
-
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
|
|
114534
|
+
/** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago. */
|
|
114511
114535
|
since?: string | undefined
|
|
114512
|
-
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
114536
|
+
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago. */
|
|
114513
114537
|
between?: string[] | undefined
|
|
114514
114538
|
/** Type of the events that you want to list. */
|
|
114515
114539
|
event_type?:
|