@seamapi/types 1.413.0 → 1.414.1
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 +381 -1131
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +506 -1136
- package/lib/seam/connect/models/locations/location.js +6 -1
- package/lib/seam/connect/models/locations/location.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -14
- package/lib/seam/connect/models/phones/phone-session.js +4 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +73 -0
- package/lib/seam/connect/models/user-identities/user-identity.js +40 -0
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +437 -1168
- package/lib/seam/connect/openapi.js +355 -1133
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +63 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/locations/location.ts +6 -1
- package/src/lib/seam/connect/models/phones/phone-session.ts +4 -0
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +60 -0
- package/src/lib/seam/connect/openapi.ts +408 -1241
- package/src/lib/seam/connect/route-types.ts +63 -4
|
@@ -6579,6 +6579,142 @@ export default {
|
|
|
6579
6579
|
],
|
|
6580
6580
|
'x-route-path': '/action_attempts',
|
|
6581
6581
|
},
|
|
6582
|
+
bridge_client_session: {
|
|
6583
|
+
properties: {
|
|
6584
|
+
bridge_client_machine_identifier_key: { type: 'string' },
|
|
6585
|
+
bridge_client_name: { type: 'string' },
|
|
6586
|
+
bridge_client_session_id: { format: 'uuid', type: 'string' },
|
|
6587
|
+
bridge_client_session_token: { type: 'string' },
|
|
6588
|
+
bridge_client_time_zone: { type: 'string' },
|
|
6589
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
6590
|
+
errors: {
|
|
6591
|
+
items: {
|
|
6592
|
+
description: 'Error associated with the `bridge_client_session`.',
|
|
6593
|
+
discriminator: { propertyName: 'error_code' },
|
|
6594
|
+
oneOf: [
|
|
6595
|
+
{
|
|
6596
|
+
description: "Seam cannot reach the bridge's LAN",
|
|
6597
|
+
properties: {
|
|
6598
|
+
can_tailscale_proxy_reach_bridge: {
|
|
6599
|
+
description: 'Tailscale proxy cannot reach the bridge',
|
|
6600
|
+
nullable: true,
|
|
6601
|
+
type: 'boolean',
|
|
6602
|
+
},
|
|
6603
|
+
can_tailscale_proxy_reach_tailscale_network: {
|
|
6604
|
+
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
6605
|
+
nullable: true,
|
|
6606
|
+
type: 'boolean',
|
|
6607
|
+
},
|
|
6608
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
6609
|
+
error_code: {
|
|
6610
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
6611
|
+
enum: ['bridge_lan_unreachable'],
|
|
6612
|
+
type: 'string',
|
|
6613
|
+
},
|
|
6614
|
+
is_bridge_socks_server_healthy: {
|
|
6615
|
+
description: "Bridge's SOCKS server is unhealthy",
|
|
6616
|
+
nullable: true,
|
|
6617
|
+
type: 'boolean',
|
|
6618
|
+
},
|
|
6619
|
+
is_tailscale_proxy_reachable: {
|
|
6620
|
+
description: 'Seam cannot reach the tailscale proxy',
|
|
6621
|
+
nullable: true,
|
|
6622
|
+
type: 'boolean',
|
|
6623
|
+
},
|
|
6624
|
+
is_tailscale_proxy_socks_server_healthy: {
|
|
6625
|
+
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
6626
|
+
nullable: true,
|
|
6627
|
+
type: 'boolean',
|
|
6628
|
+
},
|
|
6629
|
+
message: { type: 'string' },
|
|
6630
|
+
},
|
|
6631
|
+
required: [
|
|
6632
|
+
'message',
|
|
6633
|
+
'created_at',
|
|
6634
|
+
'error_code',
|
|
6635
|
+
'is_tailscale_proxy_reachable',
|
|
6636
|
+
'is_tailscale_proxy_socks_server_healthy',
|
|
6637
|
+
'can_tailscale_proxy_reach_tailscale_network',
|
|
6638
|
+
'can_tailscale_proxy_reach_bridge',
|
|
6639
|
+
'is_bridge_socks_server_healthy',
|
|
6640
|
+
],
|
|
6641
|
+
type: 'object',
|
|
6642
|
+
},
|
|
6643
|
+
{
|
|
6644
|
+
description: 'Bridge has stopped communicating with Seam',
|
|
6645
|
+
properties: {
|
|
6646
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
6647
|
+
error_code: {
|
|
6648
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
6649
|
+
enum: ['no_communication_from_bridge'],
|
|
6650
|
+
type: 'string',
|
|
6651
|
+
},
|
|
6652
|
+
message: { type: 'string' },
|
|
6653
|
+
},
|
|
6654
|
+
required: ['message', 'created_at', 'error_code'],
|
|
6655
|
+
type: 'object',
|
|
6656
|
+
},
|
|
6657
|
+
],
|
|
6658
|
+
},
|
|
6659
|
+
type: 'array',
|
|
6660
|
+
},
|
|
6661
|
+
pairing_code: { maxLength: 6, minLength: 6, type: 'string' },
|
|
6662
|
+
pairing_code_expires_at: { format: 'date-time', type: 'string' },
|
|
6663
|
+
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
6664
|
+
tailscale_hostname: { type: 'string' },
|
|
6665
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
6666
|
+
telemetry_token_expires_at: {
|
|
6667
|
+
format: 'date-time',
|
|
6668
|
+
nullable: true,
|
|
6669
|
+
type: 'string',
|
|
6670
|
+
},
|
|
6671
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
6672
|
+
},
|
|
6673
|
+
required: [
|
|
6674
|
+
'created_at',
|
|
6675
|
+
'bridge_client_session_id',
|
|
6676
|
+
'bridge_client_session_token',
|
|
6677
|
+
'pairing_code',
|
|
6678
|
+
'pairing_code_expires_at',
|
|
6679
|
+
'tailscale_hostname',
|
|
6680
|
+
'tailscale_auth_key',
|
|
6681
|
+
'bridge_client_name',
|
|
6682
|
+
'bridge_client_time_zone',
|
|
6683
|
+
'bridge_client_machine_identifier_key',
|
|
6684
|
+
'errors',
|
|
6685
|
+
'telemetry_token',
|
|
6686
|
+
'telemetry_token_expires_at',
|
|
6687
|
+
'telemetry_url',
|
|
6688
|
+
],
|
|
6689
|
+
type: 'object',
|
|
6690
|
+
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
6691
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
6692
|
+
},
|
|
6693
|
+
bridge_connected_systems: {
|
|
6694
|
+
properties: {
|
|
6695
|
+
acs_system_display_name: { type: 'string' },
|
|
6696
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
6697
|
+
bridge_created_at: { format: 'date-time', type: 'string' },
|
|
6698
|
+
bridge_id: { format: 'uuid', type: 'string' },
|
|
6699
|
+
connected_account_created_at: { format: 'date-time', type: 'string' },
|
|
6700
|
+
connected_account_id: { format: 'uuid', type: 'string' },
|
|
6701
|
+
workspace_display_name: { type: 'string' },
|
|
6702
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
6703
|
+
},
|
|
6704
|
+
required: [
|
|
6705
|
+
'bridge_id',
|
|
6706
|
+
'bridge_created_at',
|
|
6707
|
+
'connected_account_id',
|
|
6708
|
+
'connected_account_created_at',
|
|
6709
|
+
'acs_system_id',
|
|
6710
|
+
'acs_system_display_name',
|
|
6711
|
+
'workspace_id',
|
|
6712
|
+
'workspace_display_name',
|
|
6713
|
+
],
|
|
6714
|
+
type: 'object',
|
|
6715
|
+
'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
|
|
6716
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
6717
|
+
},
|
|
6582
6718
|
client_session: {
|
|
6583
6719
|
description: "Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).",
|
|
6584
6720
|
properties: {
|
|
@@ -9536,7 +9672,7 @@ export default {
|
|
|
9536
9672
|
'created_at',
|
|
9537
9673
|
],
|
|
9538
9674
|
type: 'object',
|
|
9539
|
-
'x-route-path': '/thermostats/
|
|
9675
|
+
'x-route-path': '/thermostats/daily_programs',
|
|
9540
9676
|
},
|
|
9541
9677
|
type: 'array',
|
|
9542
9678
|
'x-property-group-key': 'thermostats',
|
|
@@ -14767,6 +14903,53 @@ export default {
|
|
|
14767
14903
|
'x-route-path': '/user_identities',
|
|
14768
14904
|
'x-undocumented': 'Unreleased.',
|
|
14769
14905
|
},
|
|
14906
|
+
location: {
|
|
14907
|
+
properties: {
|
|
14908
|
+
created_at: {
|
|
14909
|
+
description: 'Date and time at which the location object was created.',
|
|
14910
|
+
format: 'date-time',
|
|
14911
|
+
type: 'string',
|
|
14912
|
+
},
|
|
14913
|
+
display_name: {
|
|
14914
|
+
description: 'Display name of the location.',
|
|
14915
|
+
type: 'string',
|
|
14916
|
+
},
|
|
14917
|
+
geolocation: {
|
|
14918
|
+
description: 'Geographical location of the location.',
|
|
14919
|
+
properties: {
|
|
14920
|
+
latitude: { format: 'float', type: 'number' },
|
|
14921
|
+
longitude: { format: 'float', type: 'number' },
|
|
14922
|
+
},
|
|
14923
|
+
required: ['latitude', 'longitude'],
|
|
14924
|
+
type: 'object',
|
|
14925
|
+
},
|
|
14926
|
+
location_id: {
|
|
14927
|
+
description: 'Unique identifier for the location.',
|
|
14928
|
+
format: 'uuid',
|
|
14929
|
+
type: 'string',
|
|
14930
|
+
},
|
|
14931
|
+
name: { description: 'Name of the location.', type: 'string' },
|
|
14932
|
+
time_zone: {
|
|
14933
|
+
description: 'Time zone of the location.',
|
|
14934
|
+
type: 'string',
|
|
14935
|
+
},
|
|
14936
|
+
workspace_id: {
|
|
14937
|
+
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
14938
|
+
format: 'uuid',
|
|
14939
|
+
type: 'string',
|
|
14940
|
+
},
|
|
14941
|
+
},
|
|
14942
|
+
required: [
|
|
14943
|
+
'location_id',
|
|
14944
|
+
'workspace_id',
|
|
14945
|
+
'name',
|
|
14946
|
+
'display_name',
|
|
14947
|
+
'created_at',
|
|
14948
|
+
],
|
|
14949
|
+
type: 'object',
|
|
14950
|
+
'x-route-path': '/unstable_locations',
|
|
14951
|
+
'x-undocumented': 'Will be removed.',
|
|
14952
|
+
},
|
|
14770
14953
|
magic_link: {
|
|
14771
14954
|
properties: {
|
|
14772
14955
|
building_block_type: {
|
|
@@ -14862,6 +15045,33 @@ export default {
|
|
|
14862
15045
|
required: ['next_page_cursor', 'has_next_page', 'next_page_url'],
|
|
14863
15046
|
type: 'object',
|
|
14864
15047
|
},
|
|
15048
|
+
partner_resource: {
|
|
15049
|
+
properties: {
|
|
15050
|
+
custom_metadata: {
|
|
15051
|
+
additionalProperties: { type: 'string' },
|
|
15052
|
+
type: 'object',
|
|
15053
|
+
},
|
|
15054
|
+
customer_key: { type: 'string' },
|
|
15055
|
+
description: { type: 'string' },
|
|
15056
|
+
email_address: { type: 'string' },
|
|
15057
|
+
ends_at: { type: 'string' },
|
|
15058
|
+
location_keys: { items: { type: 'string' }, type: 'array' },
|
|
15059
|
+
name: { type: 'string' },
|
|
15060
|
+
partner_resource_key: { type: 'string' },
|
|
15061
|
+
partner_resource_type: { type: 'string' },
|
|
15062
|
+
phone_number: { type: 'string' },
|
|
15063
|
+
starts_at: { type: 'string' },
|
|
15064
|
+
user_identity_key: { type: 'string' },
|
|
15065
|
+
},
|
|
15066
|
+
required: [
|
|
15067
|
+
'partner_resource_type',
|
|
15068
|
+
'partner_resource_key',
|
|
15069
|
+
'customer_key',
|
|
15070
|
+
],
|
|
15071
|
+
type: 'object',
|
|
15072
|
+
'x-route-path': '/unstable_partner/resources',
|
|
15073
|
+
'x-undocumented': 'Unreleased.',
|
|
15074
|
+
},
|
|
14865
15075
|
phone: {
|
|
14866
15076
|
description: "Represents an app user's mobile phone.",
|
|
14867
15077
|
properties: {
|
|
@@ -15016,11 +15226,7 @@ export default {
|
|
|
15016
15226
|
enum: ['code', 'card', 'mobile_key'],
|
|
15017
15227
|
type: 'string',
|
|
15018
15228
|
},
|
|
15019
|
-
acs_credential_id: {
|
|
15020
|
-
description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15021
|
-
format: 'uuid',
|
|
15022
|
-
type: 'string',
|
|
15023
|
-
},
|
|
15229
|
+
acs_credential_id: { nullable: true, type: 'string' },
|
|
15024
15230
|
acs_credential_pool_id: {
|
|
15025
15231
|
format: 'uuid',
|
|
15026
15232
|
type: 'string',
|
|
@@ -15508,7 +15714,6 @@ export default {
|
|
|
15508
15714
|
},
|
|
15509
15715
|
},
|
|
15510
15716
|
required: [
|
|
15511
|
-
'acs_credential_id',
|
|
15512
15717
|
'acs_system_id',
|
|
15513
15718
|
'display_name',
|
|
15514
15719
|
'access_method',
|
|
@@ -15586,6 +15791,66 @@ export default {
|
|
|
15586
15791
|
'x-draft': 'Early access.',
|
|
15587
15792
|
'x-route-path': '/spaces',
|
|
15588
15793
|
},
|
|
15794
|
+
thermostat_daily_program: {
|
|
15795
|
+
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.',
|
|
15796
|
+
properties: {
|
|
15797
|
+
created_at: {
|
|
15798
|
+
description: 'Date and time at which the thermostat daily program was created.',
|
|
15799
|
+
format: 'date-time',
|
|
15800
|
+
type: 'string',
|
|
15801
|
+
},
|
|
15802
|
+
device_id: {
|
|
15803
|
+
description: 'ID of the thermostat device on which the thermostat daily program is configured.',
|
|
15804
|
+
format: 'uuid',
|
|
15805
|
+
type: 'string',
|
|
15806
|
+
},
|
|
15807
|
+
name: {
|
|
15808
|
+
description: 'User-friendly name to identify the thermostat daily program.',
|
|
15809
|
+
nullable: true,
|
|
15810
|
+
type: 'string',
|
|
15811
|
+
},
|
|
15812
|
+
periods: {
|
|
15813
|
+
description: 'Array of thermostat daily program periods.',
|
|
15814
|
+
items: {
|
|
15815
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
15816
|
+
properties: {
|
|
15817
|
+
climate_preset_key: {
|
|
15818
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
15819
|
+
type: 'string',
|
|
15820
|
+
},
|
|
15821
|
+
starts_at_time: {
|
|
15822
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
15823
|
+
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
15824
|
+
type: 'string',
|
|
15825
|
+
},
|
|
15826
|
+
},
|
|
15827
|
+
required: ['starts_at_time', 'climate_preset_key'],
|
|
15828
|
+
type: 'object',
|
|
15829
|
+
},
|
|
15830
|
+
type: 'array',
|
|
15831
|
+
},
|
|
15832
|
+
thermostat_daily_program_id: {
|
|
15833
|
+
description: 'ID of the thermostat daily program.',
|
|
15834
|
+
format: 'uuid',
|
|
15835
|
+
type: 'string',
|
|
15836
|
+
},
|
|
15837
|
+
workspace_id: {
|
|
15838
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.',
|
|
15839
|
+
format: 'uuid',
|
|
15840
|
+
type: 'string',
|
|
15841
|
+
},
|
|
15842
|
+
},
|
|
15843
|
+
required: [
|
|
15844
|
+
'thermostat_daily_program_id',
|
|
15845
|
+
'device_id',
|
|
15846
|
+
'name',
|
|
15847
|
+
'periods',
|
|
15848
|
+
'workspace_id',
|
|
15849
|
+
'created_at',
|
|
15850
|
+
],
|
|
15851
|
+
type: 'object',
|
|
15852
|
+
'x-route-path': '/thermostats/daily_programs',
|
|
15853
|
+
},
|
|
15589
15854
|
thermostat_schedule: {
|
|
15590
15855
|
description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
|
|
15591
15856
|
properties: {
|
|
@@ -18941,6 +19206,25 @@ export default {
|
|
|
18941
19206
|
nullable: true,
|
|
18942
19207
|
type: 'string',
|
|
18943
19208
|
},
|
|
19209
|
+
errors: {
|
|
19210
|
+
description: 'Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
19211
|
+
items: {
|
|
19212
|
+
properties: {
|
|
19213
|
+
created_at: {
|
|
19214
|
+
description: 'Date and time at which Seam created the error.',
|
|
19215
|
+
format: 'date-time',
|
|
19216
|
+
type: 'string',
|
|
19217
|
+
},
|
|
19218
|
+
message: {
|
|
19219
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
19220
|
+
type: 'string',
|
|
19221
|
+
},
|
|
19222
|
+
},
|
|
19223
|
+
required: ['created_at', 'message'],
|
|
19224
|
+
type: 'object',
|
|
19225
|
+
},
|
|
19226
|
+
type: 'array',
|
|
19227
|
+
},
|
|
18944
19228
|
full_name: { minLength: 1, nullable: true, type: 'string' },
|
|
18945
19229
|
phone_number: {
|
|
18946
19230
|
description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
@@ -18958,6 +19242,37 @@ export default {
|
|
|
18958
19242
|
nullable: true,
|
|
18959
19243
|
type: 'string',
|
|
18960
19244
|
},
|
|
19245
|
+
warnings: {
|
|
19246
|
+
description: 'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
19247
|
+
items: {
|
|
19248
|
+
description: 'Warnings associated with the user identity.',
|
|
19249
|
+
discriminator: { propertyName: 'warning_code' },
|
|
19250
|
+
oneOf: [
|
|
19251
|
+
{
|
|
19252
|
+
description: 'Indicates that the user identity is currently being deleted.',
|
|
19253
|
+
properties: {
|
|
19254
|
+
created_at: {
|
|
19255
|
+
description: 'Date and time at which Seam created the warning.',
|
|
19256
|
+
format: 'date-time',
|
|
19257
|
+
type: 'string',
|
|
19258
|
+
},
|
|
19259
|
+
message: {
|
|
19260
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
19261
|
+
type: 'string',
|
|
19262
|
+
},
|
|
19263
|
+
warning_code: {
|
|
19264
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
19265
|
+
enum: ['being_deleted'],
|
|
19266
|
+
type: 'string',
|
|
19267
|
+
},
|
|
19268
|
+
},
|
|
19269
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
19270
|
+
type: 'object',
|
|
19271
|
+
},
|
|
19272
|
+
],
|
|
19273
|
+
},
|
|
19274
|
+
type: 'array',
|
|
19275
|
+
},
|
|
18961
19276
|
workspace_id: {
|
|
18962
19277
|
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
18963
19278
|
format: 'uuid',
|
|
@@ -18973,6 +19288,8 @@ export default {
|
|
|
18973
19288
|
'full_name',
|
|
18974
19289
|
'created_at',
|
|
18975
19290
|
'workspace_id',
|
|
19291
|
+
'errors',
|
|
19292
|
+
'warnings',
|
|
18976
19293
|
],
|
|
18977
19294
|
type: 'object',
|
|
18978
19295
|
'x-route-path': '/user_identities',
|
|
@@ -23959,6 +24276,16 @@ export default {
|
|
|
23959
24276
|
'application/json': {
|
|
23960
24277
|
schema: {
|
|
23961
24278
|
properties: {
|
|
24279
|
+
access_grant_id: {
|
|
24280
|
+
description: 'ID of the access grant for which you want to retrieve all entrances.',
|
|
24281
|
+
format: 'uuid',
|
|
24282
|
+
type: 'string',
|
|
24283
|
+
},
|
|
24284
|
+
access_method_id: {
|
|
24285
|
+
description: 'ID of the access method for which you want to retrieve all entrances.',
|
|
24286
|
+
format: 'uuid',
|
|
24287
|
+
type: 'string',
|
|
24288
|
+
},
|
|
23962
24289
|
acs_credential_id: {
|
|
23963
24290
|
description: 'ID of the credential for which you want to retrieve all entrances.',
|
|
23964
24291
|
format: 'uuid',
|
|
@@ -30335,137 +30662,7 @@ export default {
|
|
|
30335
30662
|
schema: {
|
|
30336
30663
|
properties: {
|
|
30337
30664
|
bridge_client_session: {
|
|
30338
|
-
|
|
30339
|
-
bridge_client_machine_identifier_key: {
|
|
30340
|
-
type: 'string',
|
|
30341
|
-
},
|
|
30342
|
-
bridge_client_name: { type: 'string' },
|
|
30343
|
-
bridge_client_session_id: {
|
|
30344
|
-
format: 'uuid',
|
|
30345
|
-
type: 'string',
|
|
30346
|
-
},
|
|
30347
|
-
bridge_client_session_token: { type: 'string' },
|
|
30348
|
-
bridge_client_time_zone: { type: 'string' },
|
|
30349
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
30350
|
-
errors: {
|
|
30351
|
-
items: {
|
|
30352
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
30353
|
-
discriminator: { propertyName: 'error_code' },
|
|
30354
|
-
oneOf: [
|
|
30355
|
-
{
|
|
30356
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
30357
|
-
properties: {
|
|
30358
|
-
can_tailscale_proxy_reach_bridge: {
|
|
30359
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
30360
|
-
nullable: true,
|
|
30361
|
-
type: 'boolean',
|
|
30362
|
-
},
|
|
30363
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
30364
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
30365
|
-
nullable: true,
|
|
30366
|
-
type: 'boolean',
|
|
30367
|
-
},
|
|
30368
|
-
created_at: {
|
|
30369
|
-
format: 'date-time',
|
|
30370
|
-
type: 'string',
|
|
30371
|
-
},
|
|
30372
|
-
error_code: {
|
|
30373
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30374
|
-
enum: ['bridge_lan_unreachable'],
|
|
30375
|
-
type: 'string',
|
|
30376
|
-
},
|
|
30377
|
-
is_bridge_socks_server_healthy: {
|
|
30378
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
30379
|
-
nullable: true,
|
|
30380
|
-
type: 'boolean',
|
|
30381
|
-
},
|
|
30382
|
-
is_tailscale_proxy_reachable: {
|
|
30383
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
30384
|
-
nullable: true,
|
|
30385
|
-
type: 'boolean',
|
|
30386
|
-
},
|
|
30387
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
30388
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
30389
|
-
nullable: true,
|
|
30390
|
-
type: 'boolean',
|
|
30391
|
-
},
|
|
30392
|
-
message: { type: 'string' },
|
|
30393
|
-
},
|
|
30394
|
-
required: [
|
|
30395
|
-
'message',
|
|
30396
|
-
'created_at',
|
|
30397
|
-
'error_code',
|
|
30398
|
-
'is_tailscale_proxy_reachable',
|
|
30399
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
30400
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
30401
|
-
'can_tailscale_proxy_reach_bridge',
|
|
30402
|
-
'is_bridge_socks_server_healthy',
|
|
30403
|
-
],
|
|
30404
|
-
type: 'object',
|
|
30405
|
-
},
|
|
30406
|
-
{
|
|
30407
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
30408
|
-
properties: {
|
|
30409
|
-
created_at: {
|
|
30410
|
-
format: 'date-time',
|
|
30411
|
-
type: 'string',
|
|
30412
|
-
},
|
|
30413
|
-
error_code: {
|
|
30414
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30415
|
-
enum: ['no_communication_from_bridge'],
|
|
30416
|
-
type: 'string',
|
|
30417
|
-
},
|
|
30418
|
-
message: { type: 'string' },
|
|
30419
|
-
},
|
|
30420
|
-
required: [
|
|
30421
|
-
'message',
|
|
30422
|
-
'created_at',
|
|
30423
|
-
'error_code',
|
|
30424
|
-
],
|
|
30425
|
-
type: 'object',
|
|
30426
|
-
},
|
|
30427
|
-
],
|
|
30428
|
-
},
|
|
30429
|
-
type: 'array',
|
|
30430
|
-
},
|
|
30431
|
-
pairing_code: {
|
|
30432
|
-
maxLength: 6,
|
|
30433
|
-
minLength: 6,
|
|
30434
|
-
type: 'string',
|
|
30435
|
-
},
|
|
30436
|
-
pairing_code_expires_at: {
|
|
30437
|
-
format: 'date-time',
|
|
30438
|
-
type: 'string',
|
|
30439
|
-
},
|
|
30440
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
30441
|
-
tailscale_hostname: { type: 'string' },
|
|
30442
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
30443
|
-
telemetry_token_expires_at: {
|
|
30444
|
-
format: 'date-time',
|
|
30445
|
-
nullable: true,
|
|
30446
|
-
type: 'string',
|
|
30447
|
-
},
|
|
30448
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
30449
|
-
},
|
|
30450
|
-
required: [
|
|
30451
|
-
'created_at',
|
|
30452
|
-
'bridge_client_session_id',
|
|
30453
|
-
'bridge_client_session_token',
|
|
30454
|
-
'pairing_code',
|
|
30455
|
-
'pairing_code_expires_at',
|
|
30456
|
-
'tailscale_hostname',
|
|
30457
|
-
'tailscale_auth_key',
|
|
30458
|
-
'bridge_client_name',
|
|
30459
|
-
'bridge_client_time_zone',
|
|
30460
|
-
'bridge_client_machine_identifier_key',
|
|
30461
|
-
'errors',
|
|
30462
|
-
'telemetry_token',
|
|
30463
|
-
'telemetry_token_expires_at',
|
|
30464
|
-
'telemetry_url',
|
|
30465
|
-
],
|
|
30466
|
-
type: 'object',
|
|
30467
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
30468
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30665
|
+
$ref: '#/components/schemas/bridge_client_session',
|
|
30469
30666
|
},
|
|
30470
30667
|
ok: { type: 'boolean' },
|
|
30471
30668
|
},
|
|
@@ -30506,137 +30703,7 @@ export default {
|
|
|
30506
30703
|
schema: {
|
|
30507
30704
|
properties: {
|
|
30508
30705
|
bridge_client_session: {
|
|
30509
|
-
|
|
30510
|
-
bridge_client_machine_identifier_key: {
|
|
30511
|
-
type: 'string',
|
|
30512
|
-
},
|
|
30513
|
-
bridge_client_name: { type: 'string' },
|
|
30514
|
-
bridge_client_session_id: {
|
|
30515
|
-
format: 'uuid',
|
|
30516
|
-
type: 'string',
|
|
30517
|
-
},
|
|
30518
|
-
bridge_client_session_token: { type: 'string' },
|
|
30519
|
-
bridge_client_time_zone: { type: 'string' },
|
|
30520
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
30521
|
-
errors: {
|
|
30522
|
-
items: {
|
|
30523
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
30524
|
-
discriminator: { propertyName: 'error_code' },
|
|
30525
|
-
oneOf: [
|
|
30526
|
-
{
|
|
30527
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
30528
|
-
properties: {
|
|
30529
|
-
can_tailscale_proxy_reach_bridge: {
|
|
30530
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
30531
|
-
nullable: true,
|
|
30532
|
-
type: 'boolean',
|
|
30533
|
-
},
|
|
30534
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
30535
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
30536
|
-
nullable: true,
|
|
30537
|
-
type: 'boolean',
|
|
30538
|
-
},
|
|
30539
|
-
created_at: {
|
|
30540
|
-
format: 'date-time',
|
|
30541
|
-
type: 'string',
|
|
30542
|
-
},
|
|
30543
|
-
error_code: {
|
|
30544
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30545
|
-
enum: ['bridge_lan_unreachable'],
|
|
30546
|
-
type: 'string',
|
|
30547
|
-
},
|
|
30548
|
-
is_bridge_socks_server_healthy: {
|
|
30549
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
30550
|
-
nullable: true,
|
|
30551
|
-
type: 'boolean',
|
|
30552
|
-
},
|
|
30553
|
-
is_tailscale_proxy_reachable: {
|
|
30554
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
30555
|
-
nullable: true,
|
|
30556
|
-
type: 'boolean',
|
|
30557
|
-
},
|
|
30558
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
30559
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
30560
|
-
nullable: true,
|
|
30561
|
-
type: 'boolean',
|
|
30562
|
-
},
|
|
30563
|
-
message: { type: 'string' },
|
|
30564
|
-
},
|
|
30565
|
-
required: [
|
|
30566
|
-
'message',
|
|
30567
|
-
'created_at',
|
|
30568
|
-
'error_code',
|
|
30569
|
-
'is_tailscale_proxy_reachable',
|
|
30570
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
30571
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
30572
|
-
'can_tailscale_proxy_reach_bridge',
|
|
30573
|
-
'is_bridge_socks_server_healthy',
|
|
30574
|
-
],
|
|
30575
|
-
type: 'object',
|
|
30576
|
-
},
|
|
30577
|
-
{
|
|
30578
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
30579
|
-
properties: {
|
|
30580
|
-
created_at: {
|
|
30581
|
-
format: 'date-time',
|
|
30582
|
-
type: 'string',
|
|
30583
|
-
},
|
|
30584
|
-
error_code: {
|
|
30585
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30586
|
-
enum: ['no_communication_from_bridge'],
|
|
30587
|
-
type: 'string',
|
|
30588
|
-
},
|
|
30589
|
-
message: { type: 'string' },
|
|
30590
|
-
},
|
|
30591
|
-
required: [
|
|
30592
|
-
'message',
|
|
30593
|
-
'created_at',
|
|
30594
|
-
'error_code',
|
|
30595
|
-
],
|
|
30596
|
-
type: 'object',
|
|
30597
|
-
},
|
|
30598
|
-
],
|
|
30599
|
-
},
|
|
30600
|
-
type: 'array',
|
|
30601
|
-
},
|
|
30602
|
-
pairing_code: {
|
|
30603
|
-
maxLength: 6,
|
|
30604
|
-
minLength: 6,
|
|
30605
|
-
type: 'string',
|
|
30606
|
-
},
|
|
30607
|
-
pairing_code_expires_at: {
|
|
30608
|
-
format: 'date-time',
|
|
30609
|
-
type: 'string',
|
|
30610
|
-
},
|
|
30611
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
30612
|
-
tailscale_hostname: { type: 'string' },
|
|
30613
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
30614
|
-
telemetry_token_expires_at: {
|
|
30615
|
-
format: 'date-time',
|
|
30616
|
-
nullable: true,
|
|
30617
|
-
type: 'string',
|
|
30618
|
-
},
|
|
30619
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
30620
|
-
},
|
|
30621
|
-
required: [
|
|
30622
|
-
'created_at',
|
|
30623
|
-
'bridge_client_session_id',
|
|
30624
|
-
'bridge_client_session_token',
|
|
30625
|
-
'pairing_code',
|
|
30626
|
-
'pairing_code_expires_at',
|
|
30627
|
-
'tailscale_hostname',
|
|
30628
|
-
'tailscale_auth_key',
|
|
30629
|
-
'bridge_client_name',
|
|
30630
|
-
'bridge_client_time_zone',
|
|
30631
|
-
'bridge_client_machine_identifier_key',
|
|
30632
|
-
'errors',
|
|
30633
|
-
'telemetry_token',
|
|
30634
|
-
'telemetry_token_expires_at',
|
|
30635
|
-
'telemetry_url',
|
|
30636
|
-
],
|
|
30637
|
-
type: 'object',
|
|
30638
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
30639
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30706
|
+
$ref: '#/components/schemas/bridge_client_session',
|
|
30640
30707
|
},
|
|
30641
30708
|
ok: { type: 'boolean' },
|
|
30642
30709
|
},
|
|
@@ -30668,137 +30735,7 @@ export default {
|
|
|
30668
30735
|
schema: {
|
|
30669
30736
|
properties: {
|
|
30670
30737
|
bridge_client_session: {
|
|
30671
|
-
|
|
30672
|
-
bridge_client_machine_identifier_key: {
|
|
30673
|
-
type: 'string',
|
|
30674
|
-
},
|
|
30675
|
-
bridge_client_name: { type: 'string' },
|
|
30676
|
-
bridge_client_session_id: {
|
|
30677
|
-
format: 'uuid',
|
|
30678
|
-
type: 'string',
|
|
30679
|
-
},
|
|
30680
|
-
bridge_client_session_token: { type: 'string' },
|
|
30681
|
-
bridge_client_time_zone: { type: 'string' },
|
|
30682
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
30683
|
-
errors: {
|
|
30684
|
-
items: {
|
|
30685
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
30686
|
-
discriminator: { propertyName: 'error_code' },
|
|
30687
|
-
oneOf: [
|
|
30688
|
-
{
|
|
30689
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
30690
|
-
properties: {
|
|
30691
|
-
can_tailscale_proxy_reach_bridge: {
|
|
30692
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
30693
|
-
nullable: true,
|
|
30694
|
-
type: 'boolean',
|
|
30695
|
-
},
|
|
30696
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
30697
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
30698
|
-
nullable: true,
|
|
30699
|
-
type: 'boolean',
|
|
30700
|
-
},
|
|
30701
|
-
created_at: {
|
|
30702
|
-
format: 'date-time',
|
|
30703
|
-
type: 'string',
|
|
30704
|
-
},
|
|
30705
|
-
error_code: {
|
|
30706
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30707
|
-
enum: ['bridge_lan_unreachable'],
|
|
30708
|
-
type: 'string',
|
|
30709
|
-
},
|
|
30710
|
-
is_bridge_socks_server_healthy: {
|
|
30711
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
30712
|
-
nullable: true,
|
|
30713
|
-
type: 'boolean',
|
|
30714
|
-
},
|
|
30715
|
-
is_tailscale_proxy_reachable: {
|
|
30716
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
30717
|
-
nullable: true,
|
|
30718
|
-
type: 'boolean',
|
|
30719
|
-
},
|
|
30720
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
30721
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
30722
|
-
nullable: true,
|
|
30723
|
-
type: 'boolean',
|
|
30724
|
-
},
|
|
30725
|
-
message: { type: 'string' },
|
|
30726
|
-
},
|
|
30727
|
-
required: [
|
|
30728
|
-
'message',
|
|
30729
|
-
'created_at',
|
|
30730
|
-
'error_code',
|
|
30731
|
-
'is_tailscale_proxy_reachable',
|
|
30732
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
30733
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
30734
|
-
'can_tailscale_proxy_reach_bridge',
|
|
30735
|
-
'is_bridge_socks_server_healthy',
|
|
30736
|
-
],
|
|
30737
|
-
type: 'object',
|
|
30738
|
-
},
|
|
30739
|
-
{
|
|
30740
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
30741
|
-
properties: {
|
|
30742
|
-
created_at: {
|
|
30743
|
-
format: 'date-time',
|
|
30744
|
-
type: 'string',
|
|
30745
|
-
},
|
|
30746
|
-
error_code: {
|
|
30747
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30748
|
-
enum: ['no_communication_from_bridge'],
|
|
30749
|
-
type: 'string',
|
|
30750
|
-
},
|
|
30751
|
-
message: { type: 'string' },
|
|
30752
|
-
},
|
|
30753
|
-
required: [
|
|
30754
|
-
'message',
|
|
30755
|
-
'created_at',
|
|
30756
|
-
'error_code',
|
|
30757
|
-
],
|
|
30758
|
-
type: 'object',
|
|
30759
|
-
},
|
|
30760
|
-
],
|
|
30761
|
-
},
|
|
30762
|
-
type: 'array',
|
|
30763
|
-
},
|
|
30764
|
-
pairing_code: {
|
|
30765
|
-
maxLength: 6,
|
|
30766
|
-
minLength: 6,
|
|
30767
|
-
type: 'string',
|
|
30768
|
-
},
|
|
30769
|
-
pairing_code_expires_at: {
|
|
30770
|
-
format: 'date-time',
|
|
30771
|
-
type: 'string',
|
|
30772
|
-
},
|
|
30773
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
30774
|
-
tailscale_hostname: { type: 'string' },
|
|
30775
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
30776
|
-
telemetry_token_expires_at: {
|
|
30777
|
-
format: 'date-time',
|
|
30778
|
-
nullable: true,
|
|
30779
|
-
type: 'string',
|
|
30780
|
-
},
|
|
30781
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
30782
|
-
},
|
|
30783
|
-
required: [
|
|
30784
|
-
'created_at',
|
|
30785
|
-
'bridge_client_session_id',
|
|
30786
|
-
'bridge_client_session_token',
|
|
30787
|
-
'pairing_code',
|
|
30788
|
-
'pairing_code_expires_at',
|
|
30789
|
-
'tailscale_hostname',
|
|
30790
|
-
'tailscale_auth_key',
|
|
30791
|
-
'bridge_client_name',
|
|
30792
|
-
'bridge_client_time_zone',
|
|
30793
|
-
'bridge_client_machine_identifier_key',
|
|
30794
|
-
'errors',
|
|
30795
|
-
'telemetry_token',
|
|
30796
|
-
'telemetry_token_expires_at',
|
|
30797
|
-
'telemetry_url',
|
|
30798
|
-
],
|
|
30799
|
-
type: 'object',
|
|
30800
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
30801
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30738
|
+
$ref: '#/components/schemas/bridge_client_session',
|
|
30802
30739
|
},
|
|
30803
30740
|
ok: { type: 'boolean' },
|
|
30804
30741
|
},
|
|
@@ -30839,137 +30776,7 @@ export default {
|
|
|
30839
30776
|
schema: {
|
|
30840
30777
|
properties: {
|
|
30841
30778
|
bridge_client_session: {
|
|
30842
|
-
|
|
30843
|
-
bridge_client_machine_identifier_key: {
|
|
30844
|
-
type: 'string',
|
|
30845
|
-
},
|
|
30846
|
-
bridge_client_name: { type: 'string' },
|
|
30847
|
-
bridge_client_session_id: {
|
|
30848
|
-
format: 'uuid',
|
|
30849
|
-
type: 'string',
|
|
30850
|
-
},
|
|
30851
|
-
bridge_client_session_token: { type: 'string' },
|
|
30852
|
-
bridge_client_time_zone: { type: 'string' },
|
|
30853
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
30854
|
-
errors: {
|
|
30855
|
-
items: {
|
|
30856
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
30857
|
-
discriminator: { propertyName: 'error_code' },
|
|
30858
|
-
oneOf: [
|
|
30859
|
-
{
|
|
30860
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
30861
|
-
properties: {
|
|
30862
|
-
can_tailscale_proxy_reach_bridge: {
|
|
30863
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
30864
|
-
nullable: true,
|
|
30865
|
-
type: 'boolean',
|
|
30866
|
-
},
|
|
30867
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
30868
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
30869
|
-
nullable: true,
|
|
30870
|
-
type: 'boolean',
|
|
30871
|
-
},
|
|
30872
|
-
created_at: {
|
|
30873
|
-
format: 'date-time',
|
|
30874
|
-
type: 'string',
|
|
30875
|
-
},
|
|
30876
|
-
error_code: {
|
|
30877
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30878
|
-
enum: ['bridge_lan_unreachable'],
|
|
30879
|
-
type: 'string',
|
|
30880
|
-
},
|
|
30881
|
-
is_bridge_socks_server_healthy: {
|
|
30882
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
30883
|
-
nullable: true,
|
|
30884
|
-
type: 'boolean',
|
|
30885
|
-
},
|
|
30886
|
-
is_tailscale_proxy_reachable: {
|
|
30887
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
30888
|
-
nullable: true,
|
|
30889
|
-
type: 'boolean',
|
|
30890
|
-
},
|
|
30891
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
30892
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
30893
|
-
nullable: true,
|
|
30894
|
-
type: 'boolean',
|
|
30895
|
-
},
|
|
30896
|
-
message: { type: 'string' },
|
|
30897
|
-
},
|
|
30898
|
-
required: [
|
|
30899
|
-
'message',
|
|
30900
|
-
'created_at',
|
|
30901
|
-
'error_code',
|
|
30902
|
-
'is_tailscale_proxy_reachable',
|
|
30903
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
30904
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
30905
|
-
'can_tailscale_proxy_reach_bridge',
|
|
30906
|
-
'is_bridge_socks_server_healthy',
|
|
30907
|
-
],
|
|
30908
|
-
type: 'object',
|
|
30909
|
-
},
|
|
30910
|
-
{
|
|
30911
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
30912
|
-
properties: {
|
|
30913
|
-
created_at: {
|
|
30914
|
-
format: 'date-time',
|
|
30915
|
-
type: 'string',
|
|
30916
|
-
},
|
|
30917
|
-
error_code: {
|
|
30918
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30919
|
-
enum: ['no_communication_from_bridge'],
|
|
30920
|
-
type: 'string',
|
|
30921
|
-
},
|
|
30922
|
-
message: { type: 'string' },
|
|
30923
|
-
},
|
|
30924
|
-
required: [
|
|
30925
|
-
'message',
|
|
30926
|
-
'created_at',
|
|
30927
|
-
'error_code',
|
|
30928
|
-
],
|
|
30929
|
-
type: 'object',
|
|
30930
|
-
},
|
|
30931
|
-
],
|
|
30932
|
-
},
|
|
30933
|
-
type: 'array',
|
|
30934
|
-
},
|
|
30935
|
-
pairing_code: {
|
|
30936
|
-
maxLength: 6,
|
|
30937
|
-
minLength: 6,
|
|
30938
|
-
type: 'string',
|
|
30939
|
-
},
|
|
30940
|
-
pairing_code_expires_at: {
|
|
30941
|
-
format: 'date-time',
|
|
30942
|
-
type: 'string',
|
|
30943
|
-
},
|
|
30944
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
30945
|
-
tailscale_hostname: { type: 'string' },
|
|
30946
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
30947
|
-
telemetry_token_expires_at: {
|
|
30948
|
-
format: 'date-time',
|
|
30949
|
-
nullable: true,
|
|
30950
|
-
type: 'string',
|
|
30951
|
-
},
|
|
30952
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
30953
|
-
},
|
|
30954
|
-
required: [
|
|
30955
|
-
'created_at',
|
|
30956
|
-
'bridge_client_session_id',
|
|
30957
|
-
'bridge_client_session_token',
|
|
30958
|
-
'pairing_code',
|
|
30959
|
-
'pairing_code_expires_at',
|
|
30960
|
-
'tailscale_hostname',
|
|
30961
|
-
'tailscale_auth_key',
|
|
30962
|
-
'bridge_client_name',
|
|
30963
|
-
'bridge_client_time_zone',
|
|
30964
|
-
'bridge_client_machine_identifier_key',
|
|
30965
|
-
'errors',
|
|
30966
|
-
'telemetry_token',
|
|
30967
|
-
'telemetry_token_expires_at',
|
|
30968
|
-
'telemetry_url',
|
|
30969
|
-
],
|
|
30970
|
-
type: 'object',
|
|
30971
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
30972
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30779
|
+
$ref: '#/components/schemas/bridge_client_session',
|
|
30973
30780
|
},
|
|
30974
30781
|
ok: { type: 'boolean' },
|
|
30975
30782
|
},
|
|
@@ -31010,137 +30817,7 @@ export default {
|
|
|
31010
30817
|
schema: {
|
|
31011
30818
|
properties: {
|
|
31012
30819
|
bridge_client_session: {
|
|
31013
|
-
|
|
31014
|
-
bridge_client_machine_identifier_key: {
|
|
31015
|
-
type: 'string',
|
|
31016
|
-
},
|
|
31017
|
-
bridge_client_name: { type: 'string' },
|
|
31018
|
-
bridge_client_session_id: {
|
|
31019
|
-
format: 'uuid',
|
|
31020
|
-
type: 'string',
|
|
31021
|
-
},
|
|
31022
|
-
bridge_client_session_token: { type: 'string' },
|
|
31023
|
-
bridge_client_time_zone: { type: 'string' },
|
|
31024
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
31025
|
-
errors: {
|
|
31026
|
-
items: {
|
|
31027
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
31028
|
-
discriminator: { propertyName: 'error_code' },
|
|
31029
|
-
oneOf: [
|
|
31030
|
-
{
|
|
31031
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
31032
|
-
properties: {
|
|
31033
|
-
can_tailscale_proxy_reach_bridge: {
|
|
31034
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
31035
|
-
nullable: true,
|
|
31036
|
-
type: 'boolean',
|
|
31037
|
-
},
|
|
31038
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
31039
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
31040
|
-
nullable: true,
|
|
31041
|
-
type: 'boolean',
|
|
31042
|
-
},
|
|
31043
|
-
created_at: {
|
|
31044
|
-
format: 'date-time',
|
|
31045
|
-
type: 'string',
|
|
31046
|
-
},
|
|
31047
|
-
error_code: {
|
|
31048
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31049
|
-
enum: ['bridge_lan_unreachable'],
|
|
31050
|
-
type: 'string',
|
|
31051
|
-
},
|
|
31052
|
-
is_bridge_socks_server_healthy: {
|
|
31053
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
31054
|
-
nullable: true,
|
|
31055
|
-
type: 'boolean',
|
|
31056
|
-
},
|
|
31057
|
-
is_tailscale_proxy_reachable: {
|
|
31058
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
31059
|
-
nullable: true,
|
|
31060
|
-
type: 'boolean',
|
|
31061
|
-
},
|
|
31062
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
31063
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
31064
|
-
nullable: true,
|
|
31065
|
-
type: 'boolean',
|
|
31066
|
-
},
|
|
31067
|
-
message: { type: 'string' },
|
|
31068
|
-
},
|
|
31069
|
-
required: [
|
|
31070
|
-
'message',
|
|
31071
|
-
'created_at',
|
|
31072
|
-
'error_code',
|
|
31073
|
-
'is_tailscale_proxy_reachable',
|
|
31074
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
31075
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
31076
|
-
'can_tailscale_proxy_reach_bridge',
|
|
31077
|
-
'is_bridge_socks_server_healthy',
|
|
31078
|
-
],
|
|
31079
|
-
type: 'object',
|
|
31080
|
-
},
|
|
31081
|
-
{
|
|
31082
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
31083
|
-
properties: {
|
|
31084
|
-
created_at: {
|
|
31085
|
-
format: 'date-time',
|
|
31086
|
-
type: 'string',
|
|
31087
|
-
},
|
|
31088
|
-
error_code: {
|
|
31089
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31090
|
-
enum: ['no_communication_from_bridge'],
|
|
31091
|
-
type: 'string',
|
|
31092
|
-
},
|
|
31093
|
-
message: { type: 'string' },
|
|
31094
|
-
},
|
|
31095
|
-
required: [
|
|
31096
|
-
'message',
|
|
31097
|
-
'created_at',
|
|
31098
|
-
'error_code',
|
|
31099
|
-
],
|
|
31100
|
-
type: 'object',
|
|
31101
|
-
},
|
|
31102
|
-
],
|
|
31103
|
-
},
|
|
31104
|
-
type: 'array',
|
|
31105
|
-
},
|
|
31106
|
-
pairing_code: {
|
|
31107
|
-
maxLength: 6,
|
|
31108
|
-
minLength: 6,
|
|
31109
|
-
type: 'string',
|
|
31110
|
-
},
|
|
31111
|
-
pairing_code_expires_at: {
|
|
31112
|
-
format: 'date-time',
|
|
31113
|
-
type: 'string',
|
|
31114
|
-
},
|
|
31115
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
31116
|
-
tailscale_hostname: { type: 'string' },
|
|
31117
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
31118
|
-
telemetry_token_expires_at: {
|
|
31119
|
-
format: 'date-time',
|
|
31120
|
-
nullable: true,
|
|
31121
|
-
type: 'string',
|
|
31122
|
-
},
|
|
31123
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
31124
|
-
},
|
|
31125
|
-
required: [
|
|
31126
|
-
'created_at',
|
|
31127
|
-
'bridge_client_session_id',
|
|
31128
|
-
'bridge_client_session_token',
|
|
31129
|
-
'pairing_code',
|
|
31130
|
-
'pairing_code_expires_at',
|
|
31131
|
-
'tailscale_hostname',
|
|
31132
|
-
'tailscale_auth_key',
|
|
31133
|
-
'bridge_client_name',
|
|
31134
|
-
'bridge_client_time_zone',
|
|
31135
|
-
'bridge_client_machine_identifier_key',
|
|
31136
|
-
'errors',
|
|
31137
|
-
'telemetry_token',
|
|
31138
|
-
'telemetry_token_expires_at',
|
|
31139
|
-
'telemetry_url',
|
|
31140
|
-
],
|
|
31141
|
-
type: 'object',
|
|
31142
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
31143
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30820
|
+
$ref: '#/components/schemas/bridge_client_session',
|
|
31144
30821
|
},
|
|
31145
30822
|
ok: { type: 'boolean' },
|
|
31146
30823
|
},
|
|
@@ -31239,38 +30916,7 @@ export default {
|
|
|
31239
30916
|
properties: {
|
|
31240
30917
|
bridge_connected_systems: {
|
|
31241
30918
|
items: {
|
|
31242
|
-
|
|
31243
|
-
acs_system_display_name: { type: 'string' },
|
|
31244
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
31245
|
-
bridge_created_at: {
|
|
31246
|
-
format: 'date-time',
|
|
31247
|
-
type: 'string',
|
|
31248
|
-
},
|
|
31249
|
-
bridge_id: { format: 'uuid', type: 'string' },
|
|
31250
|
-
connected_account_created_at: {
|
|
31251
|
-
format: 'date-time',
|
|
31252
|
-
type: 'string',
|
|
31253
|
-
},
|
|
31254
|
-
connected_account_id: {
|
|
31255
|
-
format: 'uuid',
|
|
31256
|
-
type: 'string',
|
|
31257
|
-
},
|
|
31258
|
-
workspace_display_name: { type: 'string' },
|
|
31259
|
-
workspace_id: { format: 'uuid', type: 'string' },
|
|
31260
|
-
},
|
|
31261
|
-
required: [
|
|
31262
|
-
'bridge_id',
|
|
31263
|
-
'bridge_created_at',
|
|
31264
|
-
'connected_account_id',
|
|
31265
|
-
'connected_account_created_at',
|
|
31266
|
-
'acs_system_id',
|
|
31267
|
-
'acs_system_display_name',
|
|
31268
|
-
'workspace_id',
|
|
31269
|
-
'workspace_display_name',
|
|
31270
|
-
],
|
|
31271
|
-
type: 'object',
|
|
31272
|
-
'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
|
|
31273
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30919
|
+
$ref: '#/components/schemas/bridge_connected_systems',
|
|
31274
30920
|
},
|
|
31275
30921
|
type: 'array',
|
|
31276
30922
|
},
|
|
@@ -31301,42 +30947,11 @@ export default {
|
|
|
31301
30947
|
200: {
|
|
31302
30948
|
content: {
|
|
31303
30949
|
'application/json': {
|
|
31304
|
-
schema: {
|
|
31305
|
-
properties: {
|
|
31306
|
-
bridge_connected_systems: {
|
|
31307
|
-
items: {
|
|
31308
|
-
|
|
31309
|
-
acs_system_display_name: { type: 'string' },
|
|
31310
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
31311
|
-
bridge_created_at: {
|
|
31312
|
-
format: 'date-time',
|
|
31313
|
-
type: 'string',
|
|
31314
|
-
},
|
|
31315
|
-
bridge_id: { format: 'uuid', type: 'string' },
|
|
31316
|
-
connected_account_created_at: {
|
|
31317
|
-
format: 'date-time',
|
|
31318
|
-
type: 'string',
|
|
31319
|
-
},
|
|
31320
|
-
connected_account_id: {
|
|
31321
|
-
format: 'uuid',
|
|
31322
|
-
type: 'string',
|
|
31323
|
-
},
|
|
31324
|
-
workspace_display_name: { type: 'string' },
|
|
31325
|
-
workspace_id: { format: 'uuid', type: 'string' },
|
|
31326
|
-
},
|
|
31327
|
-
required: [
|
|
31328
|
-
'bridge_id',
|
|
31329
|
-
'bridge_created_at',
|
|
31330
|
-
'connected_account_id',
|
|
31331
|
-
'connected_account_created_at',
|
|
31332
|
-
'acs_system_id',
|
|
31333
|
-
'acs_system_display_name',
|
|
31334
|
-
'workspace_id',
|
|
31335
|
-
'workspace_display_name',
|
|
31336
|
-
],
|
|
31337
|
-
type: 'object',
|
|
31338
|
-
'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
|
|
31339
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
30950
|
+
schema: {
|
|
30951
|
+
properties: {
|
|
30952
|
+
bridge_connected_systems: {
|
|
30953
|
+
items: {
|
|
30954
|
+
$ref: '#/components/schemas/bridge_connected_systems',
|
|
31340
30955
|
},
|
|
31341
30956
|
type: 'array',
|
|
31342
30957
|
},
|
|
@@ -31664,36 +31279,7 @@ export default {
|
|
|
31664
31279
|
properties: {
|
|
31665
31280
|
ok: { type: 'boolean' },
|
|
31666
31281
|
partner_resources: {
|
|
31667
|
-
items: {
|
|
31668
|
-
properties: {
|
|
31669
|
-
custom_metadata: {
|
|
31670
|
-
additionalProperties: { type: 'string' },
|
|
31671
|
-
type: 'object',
|
|
31672
|
-
},
|
|
31673
|
-
customer_key: { type: 'string' },
|
|
31674
|
-
description: { type: 'string' },
|
|
31675
|
-
email_address: { type: 'string' },
|
|
31676
|
-
ends_at: { type: 'string' },
|
|
31677
|
-
location_keys: {
|
|
31678
|
-
items: { type: 'string' },
|
|
31679
|
-
type: 'array',
|
|
31680
|
-
},
|
|
31681
|
-
name: { type: 'string' },
|
|
31682
|
-
partner_resource_key: { type: 'string' },
|
|
31683
|
-
partner_resource_type: { type: 'string' },
|
|
31684
|
-
phone_number: { type: 'string' },
|
|
31685
|
-
starts_at: { type: 'string' },
|
|
31686
|
-
user_identity_key: { type: 'string' },
|
|
31687
|
-
},
|
|
31688
|
-
required: [
|
|
31689
|
-
'partner_resource_type',
|
|
31690
|
-
'partner_resource_key',
|
|
31691
|
-
'customer_key',
|
|
31692
|
-
],
|
|
31693
|
-
type: 'object',
|
|
31694
|
-
'x-route-path': '/unstable_partner/resources',
|
|
31695
|
-
'x-undocumented': 'Unreleased.',
|
|
31696
|
-
},
|
|
31282
|
+
items: { $ref: '#/components/schemas/partner_resource' },
|
|
31697
31283
|
type: 'array',
|
|
31698
31284
|
},
|
|
31699
31285
|
},
|
|
@@ -32693,64 +32279,7 @@ export default {
|
|
|
32693
32279
|
properties: {
|
|
32694
32280
|
ok: { type: 'boolean' },
|
|
32695
32281
|
thermostat_daily_program: {
|
|
32696
|
-
|
|
32697
|
-
properties: {
|
|
32698
|
-
created_at: {
|
|
32699
|
-
description: 'Date and time at which the thermostat daily program was created.',
|
|
32700
|
-
format: 'date-time',
|
|
32701
|
-
type: 'string',
|
|
32702
|
-
},
|
|
32703
|
-
device_id: {
|
|
32704
|
-
description: 'ID of the thermostat device on which the thermostat daily program is configured.',
|
|
32705
|
-
format: 'uuid',
|
|
32706
|
-
type: 'string',
|
|
32707
|
-
},
|
|
32708
|
-
name: {
|
|
32709
|
-
description: 'User-friendly name to identify the thermostat daily program.',
|
|
32710
|
-
nullable: true,
|
|
32711
|
-
type: 'string',
|
|
32712
|
-
},
|
|
32713
|
-
periods: {
|
|
32714
|
-
description: 'Array of thermostat daily program periods.',
|
|
32715
|
-
items: {
|
|
32716
|
-
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
32717
|
-
properties: {
|
|
32718
|
-
climate_preset_key: {
|
|
32719
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
32720
|
-
type: 'string',
|
|
32721
|
-
},
|
|
32722
|
-
starts_at_time: {
|
|
32723
|
-
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
32724
|
-
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
32725
|
-
type: 'string',
|
|
32726
|
-
},
|
|
32727
|
-
},
|
|
32728
|
-
required: ['starts_at_time', 'climate_preset_key'],
|
|
32729
|
-
type: 'object',
|
|
32730
|
-
},
|
|
32731
|
-
type: 'array',
|
|
32732
|
-
},
|
|
32733
|
-
thermostat_daily_program_id: {
|
|
32734
|
-
description: 'ID of the thermostat daily program.',
|
|
32735
|
-
format: 'uuid',
|
|
32736
|
-
type: 'string',
|
|
32737
|
-
},
|
|
32738
|
-
workspace_id: {
|
|
32739
|
-
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.',
|
|
32740
|
-
format: 'uuid',
|
|
32741
|
-
type: 'string',
|
|
32742
|
-
},
|
|
32743
|
-
},
|
|
32744
|
-
required: [
|
|
32745
|
-
'thermostat_daily_program_id',
|
|
32746
|
-
'device_id',
|
|
32747
|
-
'name',
|
|
32748
|
-
'periods',
|
|
32749
|
-
'workspace_id',
|
|
32750
|
-
'created_at',
|
|
32751
|
-
],
|
|
32752
|
-
type: 'object',
|
|
32753
|
-
'x-route-path': '/thermostats/thermostat_daily_programs',
|
|
32282
|
+
$ref: '#/components/schemas/thermostat_daily_program',
|
|
32754
32283
|
},
|
|
32755
32284
|
},
|
|
32756
32285
|
required: ['thermostat_daily_program', 'ok'],
|
|
@@ -35651,54 +35180,7 @@ export default {
|
|
|
35651
35180
|
'application/json': {
|
|
35652
35181
|
schema: {
|
|
35653
35182
|
properties: {
|
|
35654
|
-
location: {
|
|
35655
|
-
properties: {
|
|
35656
|
-
created_at: {
|
|
35657
|
-
description: 'Date and time at which the location object was created.',
|
|
35658
|
-
format: 'date-time',
|
|
35659
|
-
type: 'string',
|
|
35660
|
-
},
|
|
35661
|
-
display_name: {
|
|
35662
|
-
description: 'Display name of the location.',
|
|
35663
|
-
type: 'string',
|
|
35664
|
-
},
|
|
35665
|
-
geolocation: {
|
|
35666
|
-
description: 'Geographical location of the location.',
|
|
35667
|
-
properties: {
|
|
35668
|
-
latitude: { format: 'float', type: 'number' },
|
|
35669
|
-
longitude: { format: 'float', type: 'number' },
|
|
35670
|
-
},
|
|
35671
|
-
required: ['latitude', 'longitude'],
|
|
35672
|
-
type: 'object',
|
|
35673
|
-
},
|
|
35674
|
-
location_id: {
|
|
35675
|
-
description: 'Unique identifier for the location.',
|
|
35676
|
-
format: 'uuid',
|
|
35677
|
-
type: 'string',
|
|
35678
|
-
},
|
|
35679
|
-
name: {
|
|
35680
|
-
description: 'Name of the location.',
|
|
35681
|
-
type: 'string',
|
|
35682
|
-
},
|
|
35683
|
-
time_zone: {
|
|
35684
|
-
description: 'Time zone of the location.',
|
|
35685
|
-
type: 'string',
|
|
35686
|
-
},
|
|
35687
|
-
workspace_id: {
|
|
35688
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
35689
|
-
format: 'uuid',
|
|
35690
|
-
type: 'string',
|
|
35691
|
-
},
|
|
35692
|
-
},
|
|
35693
|
-
required: [
|
|
35694
|
-
'location_id',
|
|
35695
|
-
'workspace_id',
|
|
35696
|
-
'name',
|
|
35697
|
-
'display_name',
|
|
35698
|
-
'created_at',
|
|
35699
|
-
],
|
|
35700
|
-
type: 'object',
|
|
35701
|
-
},
|
|
35183
|
+
location: { $ref: '#/components/schemas/location' },
|
|
35702
35184
|
ok: { type: 'boolean' },
|
|
35703
35185
|
},
|
|
35704
35186
|
required: ['location', 'ok'],
|
|
@@ -35804,54 +35286,7 @@ export default {
|
|
|
35804
35286
|
'application/json': {
|
|
35805
35287
|
schema: {
|
|
35806
35288
|
properties: {
|
|
35807
|
-
location: {
|
|
35808
|
-
properties: {
|
|
35809
|
-
created_at: {
|
|
35810
|
-
description: 'Date and time at which the location object was created.',
|
|
35811
|
-
format: 'date-time',
|
|
35812
|
-
type: 'string',
|
|
35813
|
-
},
|
|
35814
|
-
display_name: {
|
|
35815
|
-
description: 'Display name of the location.',
|
|
35816
|
-
type: 'string',
|
|
35817
|
-
},
|
|
35818
|
-
geolocation: {
|
|
35819
|
-
description: 'Geographical location of the location.',
|
|
35820
|
-
properties: {
|
|
35821
|
-
latitude: { format: 'float', type: 'number' },
|
|
35822
|
-
longitude: { format: 'float', type: 'number' },
|
|
35823
|
-
},
|
|
35824
|
-
required: ['latitude', 'longitude'],
|
|
35825
|
-
type: 'object',
|
|
35826
|
-
},
|
|
35827
|
-
location_id: {
|
|
35828
|
-
description: 'Unique identifier for the location.',
|
|
35829
|
-
format: 'uuid',
|
|
35830
|
-
type: 'string',
|
|
35831
|
-
},
|
|
35832
|
-
name: {
|
|
35833
|
-
description: 'Name of the location.',
|
|
35834
|
-
type: 'string',
|
|
35835
|
-
},
|
|
35836
|
-
time_zone: {
|
|
35837
|
-
description: 'Time zone of the location.',
|
|
35838
|
-
type: 'string',
|
|
35839
|
-
},
|
|
35840
|
-
workspace_id: {
|
|
35841
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
35842
|
-
format: 'uuid',
|
|
35843
|
-
type: 'string',
|
|
35844
|
-
},
|
|
35845
|
-
},
|
|
35846
|
-
required: [
|
|
35847
|
-
'location_id',
|
|
35848
|
-
'workspace_id',
|
|
35849
|
-
'name',
|
|
35850
|
-
'display_name',
|
|
35851
|
-
'created_at',
|
|
35852
|
-
],
|
|
35853
|
-
type: 'object',
|
|
35854
|
-
},
|
|
35289
|
+
location: { $ref: '#/components/schemas/location' },
|
|
35855
35290
|
ok: { type: 'boolean' },
|
|
35856
35291
|
},
|
|
35857
35292
|
required: ['location', 'ok'],
|
|
@@ -35890,54 +35325,7 @@ export default {
|
|
|
35890
35325
|
schema: {
|
|
35891
35326
|
properties: {
|
|
35892
35327
|
locations: {
|
|
35893
|
-
items: {
|
|
35894
|
-
properties: {
|
|
35895
|
-
created_at: {
|
|
35896
|
-
description: 'Date and time at which the location object was created.',
|
|
35897
|
-
format: 'date-time',
|
|
35898
|
-
type: 'string',
|
|
35899
|
-
},
|
|
35900
|
-
display_name: {
|
|
35901
|
-
description: 'Display name of the location.',
|
|
35902
|
-
type: 'string',
|
|
35903
|
-
},
|
|
35904
|
-
geolocation: {
|
|
35905
|
-
description: 'Geographical location of the location.',
|
|
35906
|
-
properties: {
|
|
35907
|
-
latitude: { format: 'float', type: 'number' },
|
|
35908
|
-
longitude: { format: 'float', type: 'number' },
|
|
35909
|
-
},
|
|
35910
|
-
required: ['latitude', 'longitude'],
|
|
35911
|
-
type: 'object',
|
|
35912
|
-
},
|
|
35913
|
-
location_id: {
|
|
35914
|
-
description: 'Unique identifier for the location.',
|
|
35915
|
-
format: 'uuid',
|
|
35916
|
-
type: 'string',
|
|
35917
|
-
},
|
|
35918
|
-
name: {
|
|
35919
|
-
description: 'Name of the location.',
|
|
35920
|
-
type: 'string',
|
|
35921
|
-
},
|
|
35922
|
-
time_zone: {
|
|
35923
|
-
description: 'Time zone of the location.',
|
|
35924
|
-
type: 'string',
|
|
35925
|
-
},
|
|
35926
|
-
workspace_id: {
|
|
35927
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
35928
|
-
format: 'uuid',
|
|
35929
|
-
type: 'string',
|
|
35930
|
-
},
|
|
35931
|
-
},
|
|
35932
|
-
required: [
|
|
35933
|
-
'location_id',
|
|
35934
|
-
'workspace_id',
|
|
35935
|
-
'name',
|
|
35936
|
-
'display_name',
|
|
35937
|
-
'created_at',
|
|
35938
|
-
],
|
|
35939
|
-
type: 'object',
|
|
35940
|
-
},
|
|
35328
|
+
items: { $ref: '#/components/schemas/location' },
|
|
35941
35329
|
type: 'array',
|
|
35942
35330
|
},
|
|
35943
35331
|
ok: { type: 'boolean' },
|
|
@@ -35974,54 +35362,7 @@ export default {
|
|
|
35974
35362
|
schema: {
|
|
35975
35363
|
properties: {
|
|
35976
35364
|
locations: {
|
|
35977
|
-
items: {
|
|
35978
|
-
properties: {
|
|
35979
|
-
created_at: {
|
|
35980
|
-
description: 'Date and time at which the location object was created.',
|
|
35981
|
-
format: 'date-time',
|
|
35982
|
-
type: 'string',
|
|
35983
|
-
},
|
|
35984
|
-
display_name: {
|
|
35985
|
-
description: 'Display name of the location.',
|
|
35986
|
-
type: 'string',
|
|
35987
|
-
},
|
|
35988
|
-
geolocation: {
|
|
35989
|
-
description: 'Geographical location of the location.',
|
|
35990
|
-
properties: {
|
|
35991
|
-
latitude: { format: 'float', type: 'number' },
|
|
35992
|
-
longitude: { format: 'float', type: 'number' },
|
|
35993
|
-
},
|
|
35994
|
-
required: ['latitude', 'longitude'],
|
|
35995
|
-
type: 'object',
|
|
35996
|
-
},
|
|
35997
|
-
location_id: {
|
|
35998
|
-
description: 'Unique identifier for the location.',
|
|
35999
|
-
format: 'uuid',
|
|
36000
|
-
type: 'string',
|
|
36001
|
-
},
|
|
36002
|
-
name: {
|
|
36003
|
-
description: 'Name of the location.',
|
|
36004
|
-
type: 'string',
|
|
36005
|
-
},
|
|
36006
|
-
time_zone: {
|
|
36007
|
-
description: 'Time zone of the location.',
|
|
36008
|
-
type: 'string',
|
|
36009
|
-
},
|
|
36010
|
-
workspace_id: {
|
|
36011
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
36012
|
-
format: 'uuid',
|
|
36013
|
-
type: 'string',
|
|
36014
|
-
},
|
|
36015
|
-
},
|
|
36016
|
-
required: [
|
|
36017
|
-
'location_id',
|
|
36018
|
-
'workspace_id',
|
|
36019
|
-
'name',
|
|
36020
|
-
'display_name',
|
|
36021
|
-
'created_at',
|
|
36022
|
-
],
|
|
36023
|
-
type: 'object',
|
|
36024
|
-
},
|
|
35365
|
+
items: { $ref: '#/components/schemas/location' },
|
|
36025
35366
|
type: 'array',
|
|
36026
35367
|
},
|
|
36027
35368
|
ok: { type: 'boolean' },
|
|
@@ -36207,54 +35548,7 @@ export default {
|
|
|
36207
35548
|
'application/json': {
|
|
36208
35549
|
schema: {
|
|
36209
35550
|
properties: {
|
|
36210
|
-
location: {
|
|
36211
|
-
properties: {
|
|
36212
|
-
created_at: {
|
|
36213
|
-
description: 'Date and time at which the location object was created.',
|
|
36214
|
-
format: 'date-time',
|
|
36215
|
-
type: 'string',
|
|
36216
|
-
},
|
|
36217
|
-
display_name: {
|
|
36218
|
-
description: 'Display name of the location.',
|
|
36219
|
-
type: 'string',
|
|
36220
|
-
},
|
|
36221
|
-
geolocation: {
|
|
36222
|
-
description: 'Geographical location of the location.',
|
|
36223
|
-
properties: {
|
|
36224
|
-
latitude: { format: 'float', type: 'number' },
|
|
36225
|
-
longitude: { format: 'float', type: 'number' },
|
|
36226
|
-
},
|
|
36227
|
-
required: ['latitude', 'longitude'],
|
|
36228
|
-
type: 'object',
|
|
36229
|
-
},
|
|
36230
|
-
location_id: {
|
|
36231
|
-
description: 'Unique identifier for the location.',
|
|
36232
|
-
format: 'uuid',
|
|
36233
|
-
type: 'string',
|
|
36234
|
-
},
|
|
36235
|
-
name: {
|
|
36236
|
-
description: 'Name of the location.',
|
|
36237
|
-
type: 'string',
|
|
36238
|
-
},
|
|
36239
|
-
time_zone: {
|
|
36240
|
-
description: 'Time zone of the location.',
|
|
36241
|
-
type: 'string',
|
|
36242
|
-
},
|
|
36243
|
-
workspace_id: {
|
|
36244
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
36245
|
-
format: 'uuid',
|
|
36246
|
-
type: 'string',
|
|
36247
|
-
},
|
|
36248
|
-
},
|
|
36249
|
-
required: [
|
|
36250
|
-
'location_id',
|
|
36251
|
-
'workspace_id',
|
|
36252
|
-
'name',
|
|
36253
|
-
'display_name',
|
|
36254
|
-
'created_at',
|
|
36255
|
-
],
|
|
36256
|
-
type: 'object',
|
|
36257
|
-
},
|
|
35551
|
+
location: { $ref: '#/components/schemas/location' },
|
|
36258
35552
|
ok: { type: 'boolean' },
|
|
36259
35553
|
},
|
|
36260
35554
|
required: ['location', 'ok'],
|
|
@@ -36322,54 +35616,7 @@ export default {
|
|
|
36322
35616
|
'application/json': {
|
|
36323
35617
|
schema: {
|
|
36324
35618
|
properties: {
|
|
36325
|
-
location: {
|
|
36326
|
-
properties: {
|
|
36327
|
-
created_at: {
|
|
36328
|
-
description: 'Date and time at which the location object was created.',
|
|
36329
|
-
format: 'date-time',
|
|
36330
|
-
type: 'string',
|
|
36331
|
-
},
|
|
36332
|
-
display_name: {
|
|
36333
|
-
description: 'Display name of the location.',
|
|
36334
|
-
type: 'string',
|
|
36335
|
-
},
|
|
36336
|
-
geolocation: {
|
|
36337
|
-
description: 'Geographical location of the location.',
|
|
36338
|
-
properties: {
|
|
36339
|
-
latitude: { format: 'float', type: 'number' },
|
|
36340
|
-
longitude: { format: 'float', type: 'number' },
|
|
36341
|
-
},
|
|
36342
|
-
required: ['latitude', 'longitude'],
|
|
36343
|
-
type: 'object',
|
|
36344
|
-
},
|
|
36345
|
-
location_id: {
|
|
36346
|
-
description: 'Unique identifier for the location.',
|
|
36347
|
-
format: 'uuid',
|
|
36348
|
-
type: 'string',
|
|
36349
|
-
},
|
|
36350
|
-
name: {
|
|
36351
|
-
description: 'Name of the location.',
|
|
36352
|
-
type: 'string',
|
|
36353
|
-
},
|
|
36354
|
-
time_zone: {
|
|
36355
|
-
description: 'Time zone of the location.',
|
|
36356
|
-
type: 'string',
|
|
36357
|
-
},
|
|
36358
|
-
workspace_id: {
|
|
36359
|
-
description: 'Unique identifier for the Seam workspace associated with the location.',
|
|
36360
|
-
format: 'uuid',
|
|
36361
|
-
type: 'string',
|
|
36362
|
-
},
|
|
36363
|
-
},
|
|
36364
|
-
required: [
|
|
36365
|
-
'location_id',
|
|
36366
|
-
'workspace_id',
|
|
36367
|
-
'name',
|
|
36368
|
-
'display_name',
|
|
36369
|
-
'created_at',
|
|
36370
|
-
],
|
|
36371
|
-
type: 'object',
|
|
36372
|
-
},
|
|
35619
|
+
location: { $ref: '#/components/schemas/location' },
|
|
36373
35620
|
ok: { type: 'boolean' },
|
|
36374
35621
|
},
|
|
36375
35622
|
required: ['location', 'ok'],
|
|
@@ -36963,7 +36210,7 @@ export default {
|
|
|
36963
36210
|
},
|
|
36964
36211
|
'/user_identities/delete': {
|
|
36965
36212
|
post: {
|
|
36966
|
-
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
36213
|
+
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
|
|
36967
36214
|
operationId: 'userIdentitiesDeletePost',
|
|
36968
36215
|
requestBody: {
|
|
36969
36216
|
content: {
|
|
@@ -37168,32 +36415,7 @@ export default {
|
|
|
37168
36415
|
schema: {
|
|
37169
36416
|
properties: {
|
|
37170
36417
|
enrollment_automation: {
|
|
37171
|
-
|
|
37172
|
-
acs_credential_provisioning_automation_id: {
|
|
37173
|
-
format: 'uuid',
|
|
37174
|
-
type: 'string',
|
|
37175
|
-
},
|
|
37176
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
37177
|
-
credential_manager_acs_system_id: {
|
|
37178
|
-
format: 'uuid',
|
|
37179
|
-
type: 'string',
|
|
37180
|
-
},
|
|
37181
|
-
enrollment_automation_id: {
|
|
37182
|
-
format: 'uuid',
|
|
37183
|
-
type: 'string',
|
|
37184
|
-
},
|
|
37185
|
-
user_identity_id: { format: 'uuid', type: 'string' },
|
|
37186
|
-
workspace_id: { format: 'uuid', type: 'string' },
|
|
37187
|
-
},
|
|
37188
|
-
required: [
|
|
37189
|
-
'acs_credential_provisioning_automation_id',
|
|
37190
|
-
'credential_manager_acs_system_id',
|
|
37191
|
-
'user_identity_id',
|
|
37192
|
-
'created_at',
|
|
37193
|
-
'workspace_id',
|
|
37194
|
-
'enrollment_automation_id',
|
|
37195
|
-
],
|
|
37196
|
-
type: 'object',
|
|
36418
|
+
$ref: '#/components/schemas/enrollment_automation',
|
|
37197
36419
|
},
|
|
37198
36420
|
ok: { type: 'boolean' },
|
|
37199
36421
|
},
|