@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.
@@ -7318,6 +7318,146 @@ export default {
7318
7318
  ],
7319
7319
  'x-route-path': '/action_attempts',
7320
7320
  },
7321
+ bridge_client_session: {
7322
+ properties: {
7323
+ bridge_client_machine_identifier_key: { type: 'string' },
7324
+ bridge_client_name: { type: 'string' },
7325
+ bridge_client_session_id: { format: 'uuid', type: 'string' },
7326
+ bridge_client_session_token: { type: 'string' },
7327
+ bridge_client_time_zone: { type: 'string' },
7328
+ created_at: { format: 'date-time', type: 'string' },
7329
+ errors: {
7330
+ items: {
7331
+ description: 'Error associated with the `bridge_client_session`.',
7332
+ discriminator: { propertyName: 'error_code' },
7333
+ oneOf: [
7334
+ {
7335
+ description: "Seam cannot reach the bridge's LAN",
7336
+ properties: {
7337
+ can_tailscale_proxy_reach_bridge: {
7338
+ description: 'Tailscale proxy cannot reach the bridge',
7339
+ nullable: true,
7340
+ type: 'boolean',
7341
+ },
7342
+ can_tailscale_proxy_reach_tailscale_network: {
7343
+ description:
7344
+ 'Tailscale proxy cannot reach the Tailscale network',
7345
+ nullable: true,
7346
+ type: 'boolean',
7347
+ },
7348
+ created_at: { format: 'date-time', type: 'string' },
7349
+ error_code: {
7350
+ description:
7351
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
7352
+ enum: ['bridge_lan_unreachable'],
7353
+ type: 'string',
7354
+ },
7355
+ is_bridge_socks_server_healthy: {
7356
+ description: "Bridge's SOCKS server is unhealthy",
7357
+ nullable: true,
7358
+ type: 'boolean',
7359
+ },
7360
+ is_tailscale_proxy_reachable: {
7361
+ description: 'Seam cannot reach the tailscale proxy',
7362
+ nullable: true,
7363
+ type: 'boolean',
7364
+ },
7365
+ is_tailscale_proxy_socks_server_healthy: {
7366
+ description:
7367
+ "Tailscale proxy's SOCKS server is unhealthy",
7368
+ nullable: true,
7369
+ type: 'boolean',
7370
+ },
7371
+ message: { type: 'string' },
7372
+ },
7373
+ required: [
7374
+ 'message',
7375
+ 'created_at',
7376
+ 'error_code',
7377
+ 'is_tailscale_proxy_reachable',
7378
+ 'is_tailscale_proxy_socks_server_healthy',
7379
+ 'can_tailscale_proxy_reach_tailscale_network',
7380
+ 'can_tailscale_proxy_reach_bridge',
7381
+ 'is_bridge_socks_server_healthy',
7382
+ ],
7383
+ type: 'object',
7384
+ },
7385
+ {
7386
+ description: 'Bridge has stopped communicating with Seam',
7387
+ properties: {
7388
+ created_at: { format: 'date-time', type: 'string' },
7389
+ error_code: {
7390
+ description:
7391
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
7392
+ enum: ['no_communication_from_bridge'],
7393
+ type: 'string',
7394
+ },
7395
+ message: { type: 'string' },
7396
+ },
7397
+ required: ['message', 'created_at', 'error_code'],
7398
+ type: 'object',
7399
+ },
7400
+ ],
7401
+ },
7402
+ type: 'array',
7403
+ },
7404
+ pairing_code: { maxLength: 6, minLength: 6, type: 'string' },
7405
+ pairing_code_expires_at: { format: 'date-time', type: 'string' },
7406
+ tailscale_auth_key: { nullable: true, type: 'string' },
7407
+ tailscale_hostname: { type: 'string' },
7408
+ telemetry_token: { nullable: true, type: 'string' },
7409
+ telemetry_token_expires_at: {
7410
+ format: 'date-time',
7411
+ nullable: true,
7412
+ type: 'string',
7413
+ },
7414
+ telemetry_url: { nullable: true, type: 'string' },
7415
+ },
7416
+ required: [
7417
+ 'created_at',
7418
+ 'bridge_client_session_id',
7419
+ 'bridge_client_session_token',
7420
+ 'pairing_code',
7421
+ 'pairing_code_expires_at',
7422
+ 'tailscale_hostname',
7423
+ 'tailscale_auth_key',
7424
+ 'bridge_client_name',
7425
+ 'bridge_client_time_zone',
7426
+ 'bridge_client_machine_identifier_key',
7427
+ 'errors',
7428
+ 'telemetry_token',
7429
+ 'telemetry_token_expires_at',
7430
+ 'telemetry_url',
7431
+ ],
7432
+ type: 'object',
7433
+ 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
7434
+ 'x-undocumented': 'Seam Bridge Client only.',
7435
+ },
7436
+ bridge_connected_systems: {
7437
+ properties: {
7438
+ acs_system_display_name: { type: 'string' },
7439
+ acs_system_id: { format: 'uuid', type: 'string' },
7440
+ bridge_created_at: { format: 'date-time', type: 'string' },
7441
+ bridge_id: { format: 'uuid', type: 'string' },
7442
+ connected_account_created_at: { format: 'date-time', type: 'string' },
7443
+ connected_account_id: { format: 'uuid', type: 'string' },
7444
+ workspace_display_name: { type: 'string' },
7445
+ workspace_id: { format: 'uuid', type: 'string' },
7446
+ },
7447
+ required: [
7448
+ 'bridge_id',
7449
+ 'bridge_created_at',
7450
+ 'connected_account_id',
7451
+ 'connected_account_created_at',
7452
+ 'acs_system_id',
7453
+ 'acs_system_display_name',
7454
+ 'workspace_id',
7455
+ 'workspace_display_name',
7456
+ ],
7457
+ type: 'object',
7458
+ 'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
7459
+ 'x-undocumented': 'Seam Bridge Client only.',
7460
+ },
7321
7461
  client_session: {
7322
7462
  description:
7323
7463
  "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).",
@@ -10700,8 +10840,7 @@ export default {
10700
10840
  'created_at',
10701
10841
  ],
10702
10842
  type: 'object',
10703
- 'x-route-path':
10704
- '/thermostats/thermostat_daily_programs',
10843
+ 'x-route-path': '/thermostats/daily_programs',
10705
10844
  },
10706
10845
  type: 'array',
10707
10846
  'x-property-group-key': 'thermostats',
@@ -16167,6 +16306,55 @@ export default {
16167
16306
  'x-route-path': '/user_identities',
16168
16307
  'x-undocumented': 'Unreleased.',
16169
16308
  },
16309
+ location: {
16310
+ properties: {
16311
+ created_at: {
16312
+ description:
16313
+ 'Date and time at which the location object was created.',
16314
+ format: 'date-time',
16315
+ type: 'string',
16316
+ },
16317
+ display_name: {
16318
+ description: 'Display name of the location.',
16319
+ type: 'string',
16320
+ },
16321
+ geolocation: {
16322
+ description: 'Geographical location of the location.',
16323
+ properties: {
16324
+ latitude: { format: 'float', type: 'number' },
16325
+ longitude: { format: 'float', type: 'number' },
16326
+ },
16327
+ required: ['latitude', 'longitude'],
16328
+ type: 'object',
16329
+ },
16330
+ location_id: {
16331
+ description: 'Unique identifier for the location.',
16332
+ format: 'uuid',
16333
+ type: 'string',
16334
+ },
16335
+ name: { description: 'Name of the location.', type: 'string' },
16336
+ time_zone: {
16337
+ description: 'Time zone of the location.',
16338
+ type: 'string',
16339
+ },
16340
+ workspace_id: {
16341
+ description:
16342
+ 'Unique identifier for the Seam workspace associated with the location.',
16343
+ format: 'uuid',
16344
+ type: 'string',
16345
+ },
16346
+ },
16347
+ required: [
16348
+ 'location_id',
16349
+ 'workspace_id',
16350
+ 'name',
16351
+ 'display_name',
16352
+ 'created_at',
16353
+ ],
16354
+ type: 'object',
16355
+ 'x-route-path': '/unstable_locations',
16356
+ 'x-undocumented': 'Will be removed.',
16357
+ },
16170
16358
  magic_link: {
16171
16359
  properties: {
16172
16360
  building_block_type: {
@@ -16269,6 +16457,33 @@ export default {
16269
16457
  required: ['next_page_cursor', 'has_next_page', 'next_page_url'],
16270
16458
  type: 'object',
16271
16459
  },
16460
+ partner_resource: {
16461
+ properties: {
16462
+ custom_metadata: {
16463
+ additionalProperties: { type: 'string' },
16464
+ type: 'object',
16465
+ },
16466
+ customer_key: { type: 'string' },
16467
+ description: { type: 'string' },
16468
+ email_address: { type: 'string' },
16469
+ ends_at: { type: 'string' },
16470
+ location_keys: { items: { type: 'string' }, type: 'array' },
16471
+ name: { type: 'string' },
16472
+ partner_resource_key: { type: 'string' },
16473
+ partner_resource_type: { type: 'string' },
16474
+ phone_number: { type: 'string' },
16475
+ starts_at: { type: 'string' },
16476
+ user_identity_key: { type: 'string' },
16477
+ },
16478
+ required: [
16479
+ 'partner_resource_type',
16480
+ 'partner_resource_key',
16481
+ 'customer_key',
16482
+ ],
16483
+ type: 'object',
16484
+ 'x-route-path': '/unstable_partner/resources',
16485
+ 'x-undocumented': 'Unreleased.',
16486
+ },
16272
16487
  phone: {
16273
16488
  description: "Represents an app user's mobile phone.",
16274
16489
  properties: {
@@ -16434,12 +16649,7 @@ export default {
16434
16649
  enum: ['code', 'card', 'mobile_key'],
16435
16650
  type: 'string',
16436
16651
  },
16437
- acs_credential_id: {
16438
- description:
16439
- 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
16440
- format: 'uuid',
16441
- type: 'string',
16442
- },
16652
+ acs_credential_id: { nullable: true, type: 'string' },
16443
16653
  acs_credential_pool_id: {
16444
16654
  format: 'uuid',
16445
16655
  type: 'string',
@@ -16988,7 +17198,6 @@ export default {
16988
17198
  },
16989
17199
  },
16990
17200
  required: [
16991
- 'acs_credential_id',
16992
17201
  'acs_system_id',
16993
17202
  'display_name',
16994
17203
  'access_method',
@@ -17067,6 +17276,74 @@ export default {
17067
17276
  'x-draft': 'Early access.',
17068
17277
  'x-route-path': '/spaces',
17069
17278
  },
17279
+ thermostat_daily_program: {
17280
+ description:
17281
+ '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.',
17282
+ properties: {
17283
+ created_at: {
17284
+ description:
17285
+ 'Date and time at which the thermostat daily program was created.',
17286
+ format: 'date-time',
17287
+ type: 'string',
17288
+ },
17289
+ device_id: {
17290
+ description:
17291
+ 'ID of the thermostat device on which the thermostat daily program is configured.',
17292
+ format: 'uuid',
17293
+ type: 'string',
17294
+ },
17295
+ name: {
17296
+ description:
17297
+ 'User-friendly name to identify the thermostat daily program.',
17298
+ nullable: true,
17299
+ type: 'string',
17300
+ },
17301
+ periods: {
17302
+ description: 'Array of thermostat daily program periods.',
17303
+ items: {
17304
+ description:
17305
+ '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.',
17306
+ properties: {
17307
+ climate_preset_key: {
17308
+ description:
17309
+ '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`.',
17310
+ type: 'string',
17311
+ },
17312
+ starts_at_time: {
17313
+ description:
17314
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17315
+ pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
17316
+ type: 'string',
17317
+ },
17318
+ },
17319
+ required: ['starts_at_time', 'climate_preset_key'],
17320
+ type: 'object',
17321
+ },
17322
+ type: 'array',
17323
+ },
17324
+ thermostat_daily_program_id: {
17325
+ description: 'ID of the thermostat daily program.',
17326
+ format: 'uuid',
17327
+ type: 'string',
17328
+ },
17329
+ workspace_id: {
17330
+ description:
17331
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.',
17332
+ format: 'uuid',
17333
+ type: 'string',
17334
+ },
17335
+ },
17336
+ required: [
17337
+ 'thermostat_daily_program_id',
17338
+ 'device_id',
17339
+ 'name',
17340
+ 'periods',
17341
+ 'workspace_id',
17342
+ 'created_at',
17343
+ ],
17344
+ type: 'object',
17345
+ 'x-route-path': '/thermostats/daily_programs',
17346
+ },
17070
17347
  thermostat_schedule: {
17071
17348
  description:
17072
17349
  '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.',
@@ -20821,6 +21098,27 @@ export default {
20821
21098
  nullable: true,
20822
21099
  type: 'string',
20823
21100
  },
21101
+ errors: {
21102
+ description:
21103
+ '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.',
21104
+ items: {
21105
+ properties: {
21106
+ created_at: {
21107
+ description: 'Date and time at which Seam created the error.',
21108
+ format: 'date-time',
21109
+ type: 'string',
21110
+ },
21111
+ message: {
21112
+ description:
21113
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21114
+ type: 'string',
21115
+ },
21116
+ },
21117
+ required: ['created_at', 'message'],
21118
+ type: 'object',
21119
+ },
21120
+ type: 'array',
21121
+ },
20824
21122
  full_name: { minLength: 1, nullable: true, type: 'string' },
20825
21123
  phone_number: {
20826
21124
  description:
@@ -20839,6 +21137,42 @@ export default {
20839
21137
  nullable: true,
20840
21138
  type: 'string',
20841
21139
  },
21140
+ warnings: {
21141
+ description:
21142
+ '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.',
21143
+ items: {
21144
+ description: 'Warnings associated with the user identity.',
21145
+ discriminator: { propertyName: 'warning_code' },
21146
+ oneOf: [
21147
+ {
21148
+ description:
21149
+ 'Indicates that the user identity is currently being deleted.',
21150
+ properties: {
21151
+ created_at: {
21152
+ description:
21153
+ 'Date and time at which Seam created the warning.',
21154
+ format: 'date-time',
21155
+ type: 'string',
21156
+ },
21157
+ message: {
21158
+ description:
21159
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21160
+ type: 'string',
21161
+ },
21162
+ warning_code: {
21163
+ description:
21164
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21165
+ enum: ['being_deleted'],
21166
+ type: 'string',
21167
+ },
21168
+ },
21169
+ required: ['created_at', 'message', 'warning_code'],
21170
+ type: 'object',
21171
+ },
21172
+ ],
21173
+ },
21174
+ type: 'array',
21175
+ },
20842
21176
  workspace_id: {
20843
21177
  description:
20844
21178
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
@@ -20855,6 +21189,8 @@ export default {
20855
21189
  'full_name',
20856
21190
  'created_at',
20857
21191
  'workspace_id',
21192
+ 'errors',
21193
+ 'warnings',
20858
21194
  ],
20859
21195
  type: 'object',
20860
21196
  'x-route-path': '/user_identities',
@@ -26156,6 +26492,18 @@ export default {
26156
26492
  'application/json': {
26157
26493
  schema: {
26158
26494
  properties: {
26495
+ access_grant_id: {
26496
+ description:
26497
+ 'ID of the access grant for which you want to retrieve all entrances.',
26498
+ format: 'uuid',
26499
+ type: 'string',
26500
+ },
26501
+ access_method_id: {
26502
+ description:
26503
+ 'ID of the access method for which you want to retrieve all entrances.',
26504
+ format: 'uuid',
26505
+ type: 'string',
26506
+ },
26159
26507
  acs_credential_id: {
26160
26508
  description:
26161
26509
  'ID of the credential for which you want to retrieve all entrances.',
@@ -32894,147 +33242,7 @@ export default {
32894
33242
  schema: {
32895
33243
  properties: {
32896
33244
  bridge_client_session: {
32897
- properties: {
32898
- bridge_client_machine_identifier_key: {
32899
- type: 'string',
32900
- },
32901
- bridge_client_name: { type: 'string' },
32902
- bridge_client_session_id: {
32903
- format: 'uuid',
32904
- type: 'string',
32905
- },
32906
- bridge_client_session_token: { type: 'string' },
32907
- bridge_client_time_zone: { type: 'string' },
32908
- created_at: { format: 'date-time', type: 'string' },
32909
- errors: {
32910
- items: {
32911
- description:
32912
- 'Error associated with the `bridge_client_session`.',
32913
- discriminator: { propertyName: 'error_code' },
32914
- oneOf: [
32915
- {
32916
- description:
32917
- "Seam cannot reach the bridge's LAN",
32918
- properties: {
32919
- can_tailscale_proxy_reach_bridge: {
32920
- description:
32921
- 'Tailscale proxy cannot reach the bridge',
32922
- nullable: true,
32923
- type: 'boolean',
32924
- },
32925
- can_tailscale_proxy_reach_tailscale_network: {
32926
- description:
32927
- 'Tailscale proxy cannot reach the Tailscale network',
32928
- nullable: true,
32929
- type: 'boolean',
32930
- },
32931
- created_at: {
32932
- format: 'date-time',
32933
- type: 'string',
32934
- },
32935
- error_code: {
32936
- description:
32937
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32938
- enum: ['bridge_lan_unreachable'],
32939
- type: 'string',
32940
- },
32941
- is_bridge_socks_server_healthy: {
32942
- description:
32943
- "Bridge's SOCKS server is unhealthy",
32944
- nullable: true,
32945
- type: 'boolean',
32946
- },
32947
- is_tailscale_proxy_reachable: {
32948
- description:
32949
- 'Seam cannot reach the tailscale proxy',
32950
- nullable: true,
32951
- type: 'boolean',
32952
- },
32953
- is_tailscale_proxy_socks_server_healthy: {
32954
- description:
32955
- "Tailscale proxy's SOCKS server is unhealthy",
32956
- nullable: true,
32957
- type: 'boolean',
32958
- },
32959
- message: { type: 'string' },
32960
- },
32961
- required: [
32962
- 'message',
32963
- 'created_at',
32964
- 'error_code',
32965
- 'is_tailscale_proxy_reachable',
32966
- 'is_tailscale_proxy_socks_server_healthy',
32967
- 'can_tailscale_proxy_reach_tailscale_network',
32968
- 'can_tailscale_proxy_reach_bridge',
32969
- 'is_bridge_socks_server_healthy',
32970
- ],
32971
- type: 'object',
32972
- },
32973
- {
32974
- description:
32975
- 'Bridge has stopped communicating with Seam',
32976
- properties: {
32977
- created_at: {
32978
- format: 'date-time',
32979
- type: 'string',
32980
- },
32981
- error_code: {
32982
- description:
32983
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32984
- enum: ['no_communication_from_bridge'],
32985
- type: 'string',
32986
- },
32987
- message: { type: 'string' },
32988
- },
32989
- required: [
32990
- 'message',
32991
- 'created_at',
32992
- 'error_code',
32993
- ],
32994
- type: 'object',
32995
- },
32996
- ],
32997
- },
32998
- type: 'array',
32999
- },
33000
- pairing_code: {
33001
- maxLength: 6,
33002
- minLength: 6,
33003
- type: 'string',
33004
- },
33005
- pairing_code_expires_at: {
33006
- format: 'date-time',
33007
- type: 'string',
33008
- },
33009
- tailscale_auth_key: { nullable: true, type: 'string' },
33010
- tailscale_hostname: { type: 'string' },
33011
- telemetry_token: { nullable: true, type: 'string' },
33012
- telemetry_token_expires_at: {
33013
- format: 'date-time',
33014
- nullable: true,
33015
- type: 'string',
33016
- },
33017
- telemetry_url: { nullable: true, type: 'string' },
33018
- },
33019
- required: [
33020
- 'created_at',
33021
- 'bridge_client_session_id',
33022
- 'bridge_client_session_token',
33023
- 'pairing_code',
33024
- 'pairing_code_expires_at',
33025
- 'tailscale_hostname',
33026
- 'tailscale_auth_key',
33027
- 'bridge_client_name',
33028
- 'bridge_client_time_zone',
33029
- 'bridge_client_machine_identifier_key',
33030
- 'errors',
33031
- 'telemetry_token',
33032
- 'telemetry_token_expires_at',
33033
- 'telemetry_url',
33034
- ],
33035
- type: 'object',
33036
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
33037
- 'x-undocumented': 'Seam Bridge Client only.',
33245
+ $ref: '#/components/schemas/bridge_client_session',
33038
33246
  },
33039
33247
  ok: { type: 'boolean' },
33040
33248
  },
@@ -33076,147 +33284,7 @@ export default {
33076
33284
  schema: {
33077
33285
  properties: {
33078
33286
  bridge_client_session: {
33079
- properties: {
33080
- bridge_client_machine_identifier_key: {
33081
- type: 'string',
33082
- },
33083
- bridge_client_name: { type: 'string' },
33084
- bridge_client_session_id: {
33085
- format: 'uuid',
33086
- type: 'string',
33087
- },
33088
- bridge_client_session_token: { type: 'string' },
33089
- bridge_client_time_zone: { type: 'string' },
33090
- created_at: { format: 'date-time', type: 'string' },
33091
- errors: {
33092
- items: {
33093
- description:
33094
- 'Error associated with the `bridge_client_session`.',
33095
- discriminator: { propertyName: 'error_code' },
33096
- oneOf: [
33097
- {
33098
- description:
33099
- "Seam cannot reach the bridge's LAN",
33100
- properties: {
33101
- can_tailscale_proxy_reach_bridge: {
33102
- description:
33103
- 'Tailscale proxy cannot reach the bridge',
33104
- nullable: true,
33105
- type: 'boolean',
33106
- },
33107
- can_tailscale_proxy_reach_tailscale_network: {
33108
- description:
33109
- 'Tailscale proxy cannot reach the Tailscale network',
33110
- nullable: true,
33111
- type: 'boolean',
33112
- },
33113
- created_at: {
33114
- format: 'date-time',
33115
- type: 'string',
33116
- },
33117
- error_code: {
33118
- description:
33119
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33120
- enum: ['bridge_lan_unreachable'],
33121
- type: 'string',
33122
- },
33123
- is_bridge_socks_server_healthy: {
33124
- description:
33125
- "Bridge's SOCKS server is unhealthy",
33126
- nullable: true,
33127
- type: 'boolean',
33128
- },
33129
- is_tailscale_proxy_reachable: {
33130
- description:
33131
- 'Seam cannot reach the tailscale proxy',
33132
- nullable: true,
33133
- type: 'boolean',
33134
- },
33135
- is_tailscale_proxy_socks_server_healthy: {
33136
- description:
33137
- "Tailscale proxy's SOCKS server is unhealthy",
33138
- nullable: true,
33139
- type: 'boolean',
33140
- },
33141
- message: { type: 'string' },
33142
- },
33143
- required: [
33144
- 'message',
33145
- 'created_at',
33146
- 'error_code',
33147
- 'is_tailscale_proxy_reachable',
33148
- 'is_tailscale_proxy_socks_server_healthy',
33149
- 'can_tailscale_proxy_reach_tailscale_network',
33150
- 'can_tailscale_proxy_reach_bridge',
33151
- 'is_bridge_socks_server_healthy',
33152
- ],
33153
- type: 'object',
33154
- },
33155
- {
33156
- description:
33157
- 'Bridge has stopped communicating with Seam',
33158
- properties: {
33159
- created_at: {
33160
- format: 'date-time',
33161
- type: 'string',
33162
- },
33163
- error_code: {
33164
- description:
33165
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33166
- enum: ['no_communication_from_bridge'],
33167
- type: 'string',
33168
- },
33169
- message: { type: 'string' },
33170
- },
33171
- required: [
33172
- 'message',
33173
- 'created_at',
33174
- 'error_code',
33175
- ],
33176
- type: 'object',
33177
- },
33178
- ],
33179
- },
33180
- type: 'array',
33181
- },
33182
- pairing_code: {
33183
- maxLength: 6,
33184
- minLength: 6,
33185
- type: 'string',
33186
- },
33187
- pairing_code_expires_at: {
33188
- format: 'date-time',
33189
- type: 'string',
33190
- },
33191
- tailscale_auth_key: { nullable: true, type: 'string' },
33192
- tailscale_hostname: { type: 'string' },
33193
- telemetry_token: { nullable: true, type: 'string' },
33194
- telemetry_token_expires_at: {
33195
- format: 'date-time',
33196
- nullable: true,
33197
- type: 'string',
33198
- },
33199
- telemetry_url: { nullable: true, type: 'string' },
33200
- },
33201
- required: [
33202
- 'created_at',
33203
- 'bridge_client_session_id',
33204
- 'bridge_client_session_token',
33205
- 'pairing_code',
33206
- 'pairing_code_expires_at',
33207
- 'tailscale_hostname',
33208
- 'tailscale_auth_key',
33209
- 'bridge_client_name',
33210
- 'bridge_client_time_zone',
33211
- 'bridge_client_machine_identifier_key',
33212
- 'errors',
33213
- 'telemetry_token',
33214
- 'telemetry_token_expires_at',
33215
- 'telemetry_url',
33216
- ],
33217
- type: 'object',
33218
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
33219
- 'x-undocumented': 'Seam Bridge Client only.',
33287
+ $ref: '#/components/schemas/bridge_client_session',
33220
33288
  },
33221
33289
  ok: { type: 'boolean' },
33222
33290
  },
@@ -33249,147 +33317,7 @@ export default {
33249
33317
  schema: {
33250
33318
  properties: {
33251
33319
  bridge_client_session: {
33252
- properties: {
33253
- bridge_client_machine_identifier_key: {
33254
- type: 'string',
33255
- },
33256
- bridge_client_name: { type: 'string' },
33257
- bridge_client_session_id: {
33258
- format: 'uuid',
33259
- type: 'string',
33260
- },
33261
- bridge_client_session_token: { type: 'string' },
33262
- bridge_client_time_zone: { type: 'string' },
33263
- created_at: { format: 'date-time', type: 'string' },
33264
- errors: {
33265
- items: {
33266
- description:
33267
- 'Error associated with the `bridge_client_session`.',
33268
- discriminator: { propertyName: 'error_code' },
33269
- oneOf: [
33270
- {
33271
- description:
33272
- "Seam cannot reach the bridge's LAN",
33273
- properties: {
33274
- can_tailscale_proxy_reach_bridge: {
33275
- description:
33276
- 'Tailscale proxy cannot reach the bridge',
33277
- nullable: true,
33278
- type: 'boolean',
33279
- },
33280
- can_tailscale_proxy_reach_tailscale_network: {
33281
- description:
33282
- 'Tailscale proxy cannot reach the Tailscale network',
33283
- nullable: true,
33284
- type: 'boolean',
33285
- },
33286
- created_at: {
33287
- format: 'date-time',
33288
- type: 'string',
33289
- },
33290
- error_code: {
33291
- description:
33292
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33293
- enum: ['bridge_lan_unreachable'],
33294
- type: 'string',
33295
- },
33296
- is_bridge_socks_server_healthy: {
33297
- description:
33298
- "Bridge's SOCKS server is unhealthy",
33299
- nullable: true,
33300
- type: 'boolean',
33301
- },
33302
- is_tailscale_proxy_reachable: {
33303
- description:
33304
- 'Seam cannot reach the tailscale proxy',
33305
- nullable: true,
33306
- type: 'boolean',
33307
- },
33308
- is_tailscale_proxy_socks_server_healthy: {
33309
- description:
33310
- "Tailscale proxy's SOCKS server is unhealthy",
33311
- nullable: true,
33312
- type: 'boolean',
33313
- },
33314
- message: { type: 'string' },
33315
- },
33316
- required: [
33317
- 'message',
33318
- 'created_at',
33319
- 'error_code',
33320
- 'is_tailscale_proxy_reachable',
33321
- 'is_tailscale_proxy_socks_server_healthy',
33322
- 'can_tailscale_proxy_reach_tailscale_network',
33323
- 'can_tailscale_proxy_reach_bridge',
33324
- 'is_bridge_socks_server_healthy',
33325
- ],
33326
- type: 'object',
33327
- },
33328
- {
33329
- description:
33330
- 'Bridge has stopped communicating with Seam',
33331
- properties: {
33332
- created_at: {
33333
- format: 'date-time',
33334
- type: 'string',
33335
- },
33336
- error_code: {
33337
- description:
33338
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33339
- enum: ['no_communication_from_bridge'],
33340
- type: 'string',
33341
- },
33342
- message: { type: 'string' },
33343
- },
33344
- required: [
33345
- 'message',
33346
- 'created_at',
33347
- 'error_code',
33348
- ],
33349
- type: 'object',
33350
- },
33351
- ],
33352
- },
33353
- type: 'array',
33354
- },
33355
- pairing_code: {
33356
- maxLength: 6,
33357
- minLength: 6,
33358
- type: 'string',
33359
- },
33360
- pairing_code_expires_at: {
33361
- format: 'date-time',
33362
- type: 'string',
33363
- },
33364
- tailscale_auth_key: { nullable: true, type: 'string' },
33365
- tailscale_hostname: { type: 'string' },
33366
- telemetry_token: { nullable: true, type: 'string' },
33367
- telemetry_token_expires_at: {
33368
- format: 'date-time',
33369
- nullable: true,
33370
- type: 'string',
33371
- },
33372
- telemetry_url: { nullable: true, type: 'string' },
33373
- },
33374
- required: [
33375
- 'created_at',
33376
- 'bridge_client_session_id',
33377
- 'bridge_client_session_token',
33378
- 'pairing_code',
33379
- 'pairing_code_expires_at',
33380
- 'tailscale_hostname',
33381
- 'tailscale_auth_key',
33382
- 'bridge_client_name',
33383
- 'bridge_client_time_zone',
33384
- 'bridge_client_machine_identifier_key',
33385
- 'errors',
33386
- 'telemetry_token',
33387
- 'telemetry_token_expires_at',
33388
- 'telemetry_url',
33389
- ],
33390
- type: 'object',
33391
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
33392
- 'x-undocumented': 'Seam Bridge Client only.',
33320
+ $ref: '#/components/schemas/bridge_client_session',
33393
33321
  },
33394
33322
  ok: { type: 'boolean' },
33395
33323
  },
@@ -33432,147 +33360,7 @@ export default {
33432
33360
  schema: {
33433
33361
  properties: {
33434
33362
  bridge_client_session: {
33435
- properties: {
33436
- bridge_client_machine_identifier_key: {
33437
- type: 'string',
33438
- },
33439
- bridge_client_name: { type: 'string' },
33440
- bridge_client_session_id: {
33441
- format: 'uuid',
33442
- type: 'string',
33443
- },
33444
- bridge_client_session_token: { type: 'string' },
33445
- bridge_client_time_zone: { type: 'string' },
33446
- created_at: { format: 'date-time', type: 'string' },
33447
- errors: {
33448
- items: {
33449
- description:
33450
- 'Error associated with the `bridge_client_session`.',
33451
- discriminator: { propertyName: 'error_code' },
33452
- oneOf: [
33453
- {
33454
- description:
33455
- "Seam cannot reach the bridge's LAN",
33456
- properties: {
33457
- can_tailscale_proxy_reach_bridge: {
33458
- description:
33459
- 'Tailscale proxy cannot reach the bridge',
33460
- nullable: true,
33461
- type: 'boolean',
33462
- },
33463
- can_tailscale_proxy_reach_tailscale_network: {
33464
- description:
33465
- 'Tailscale proxy cannot reach the Tailscale network',
33466
- nullable: true,
33467
- type: 'boolean',
33468
- },
33469
- created_at: {
33470
- format: 'date-time',
33471
- type: 'string',
33472
- },
33473
- error_code: {
33474
- description:
33475
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33476
- enum: ['bridge_lan_unreachable'],
33477
- type: 'string',
33478
- },
33479
- is_bridge_socks_server_healthy: {
33480
- description:
33481
- "Bridge's SOCKS server is unhealthy",
33482
- nullable: true,
33483
- type: 'boolean',
33484
- },
33485
- is_tailscale_proxy_reachable: {
33486
- description:
33487
- 'Seam cannot reach the tailscale proxy',
33488
- nullable: true,
33489
- type: 'boolean',
33490
- },
33491
- is_tailscale_proxy_socks_server_healthy: {
33492
- description:
33493
- "Tailscale proxy's SOCKS server is unhealthy",
33494
- nullable: true,
33495
- type: 'boolean',
33496
- },
33497
- message: { type: 'string' },
33498
- },
33499
- required: [
33500
- 'message',
33501
- 'created_at',
33502
- 'error_code',
33503
- 'is_tailscale_proxy_reachable',
33504
- 'is_tailscale_proxy_socks_server_healthy',
33505
- 'can_tailscale_proxy_reach_tailscale_network',
33506
- 'can_tailscale_proxy_reach_bridge',
33507
- 'is_bridge_socks_server_healthy',
33508
- ],
33509
- type: 'object',
33510
- },
33511
- {
33512
- description:
33513
- 'Bridge has stopped communicating with Seam',
33514
- properties: {
33515
- created_at: {
33516
- format: 'date-time',
33517
- type: 'string',
33518
- },
33519
- error_code: {
33520
- description:
33521
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33522
- enum: ['no_communication_from_bridge'],
33523
- type: 'string',
33524
- },
33525
- message: { type: 'string' },
33526
- },
33527
- required: [
33528
- 'message',
33529
- 'created_at',
33530
- 'error_code',
33531
- ],
33532
- type: 'object',
33533
- },
33534
- ],
33535
- },
33536
- type: 'array',
33537
- },
33538
- pairing_code: {
33539
- maxLength: 6,
33540
- minLength: 6,
33541
- type: 'string',
33542
- },
33543
- pairing_code_expires_at: {
33544
- format: 'date-time',
33545
- type: 'string',
33546
- },
33547
- tailscale_auth_key: { nullable: true, type: 'string' },
33548
- tailscale_hostname: { type: 'string' },
33549
- telemetry_token: { nullable: true, type: 'string' },
33550
- telemetry_token_expires_at: {
33551
- format: 'date-time',
33552
- nullable: true,
33553
- type: 'string',
33554
- },
33555
- telemetry_url: { nullable: true, type: 'string' },
33556
- },
33557
- required: [
33558
- 'created_at',
33559
- 'bridge_client_session_id',
33560
- 'bridge_client_session_token',
33561
- 'pairing_code',
33562
- 'pairing_code_expires_at',
33563
- 'tailscale_hostname',
33564
- 'tailscale_auth_key',
33565
- 'bridge_client_name',
33566
- 'bridge_client_time_zone',
33567
- 'bridge_client_machine_identifier_key',
33568
- 'errors',
33569
- 'telemetry_token',
33570
- 'telemetry_token_expires_at',
33571
- 'telemetry_url',
33572
- ],
33573
- type: 'object',
33574
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
33575
- 'x-undocumented': 'Seam Bridge Client only.',
33363
+ $ref: '#/components/schemas/bridge_client_session',
33576
33364
  },
33577
33365
  ok: { type: 'boolean' },
33578
33366
  },
@@ -33617,147 +33405,7 @@ export default {
33617
33405
  schema: {
33618
33406
  properties: {
33619
33407
  bridge_client_session: {
33620
- properties: {
33621
- bridge_client_machine_identifier_key: {
33622
- type: 'string',
33623
- },
33624
- bridge_client_name: { type: 'string' },
33625
- bridge_client_session_id: {
33626
- format: 'uuid',
33627
- type: 'string',
33628
- },
33629
- bridge_client_session_token: { type: 'string' },
33630
- bridge_client_time_zone: { type: 'string' },
33631
- created_at: { format: 'date-time', type: 'string' },
33632
- errors: {
33633
- items: {
33634
- description:
33635
- 'Error associated with the `bridge_client_session`.',
33636
- discriminator: { propertyName: 'error_code' },
33637
- oneOf: [
33638
- {
33639
- description:
33640
- "Seam cannot reach the bridge's LAN",
33641
- properties: {
33642
- can_tailscale_proxy_reach_bridge: {
33643
- description:
33644
- 'Tailscale proxy cannot reach the bridge',
33645
- nullable: true,
33646
- type: 'boolean',
33647
- },
33648
- can_tailscale_proxy_reach_tailscale_network: {
33649
- description:
33650
- 'Tailscale proxy cannot reach the Tailscale network',
33651
- nullable: true,
33652
- type: 'boolean',
33653
- },
33654
- created_at: {
33655
- format: 'date-time',
33656
- type: 'string',
33657
- },
33658
- error_code: {
33659
- description:
33660
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33661
- enum: ['bridge_lan_unreachable'],
33662
- type: 'string',
33663
- },
33664
- is_bridge_socks_server_healthy: {
33665
- description:
33666
- "Bridge's SOCKS server is unhealthy",
33667
- nullable: true,
33668
- type: 'boolean',
33669
- },
33670
- is_tailscale_proxy_reachable: {
33671
- description:
33672
- 'Seam cannot reach the tailscale proxy',
33673
- nullable: true,
33674
- type: 'boolean',
33675
- },
33676
- is_tailscale_proxy_socks_server_healthy: {
33677
- description:
33678
- "Tailscale proxy's SOCKS server is unhealthy",
33679
- nullable: true,
33680
- type: 'boolean',
33681
- },
33682
- message: { type: 'string' },
33683
- },
33684
- required: [
33685
- 'message',
33686
- 'created_at',
33687
- 'error_code',
33688
- 'is_tailscale_proxy_reachable',
33689
- 'is_tailscale_proxy_socks_server_healthy',
33690
- 'can_tailscale_proxy_reach_tailscale_network',
33691
- 'can_tailscale_proxy_reach_bridge',
33692
- 'is_bridge_socks_server_healthy',
33693
- ],
33694
- type: 'object',
33695
- },
33696
- {
33697
- description:
33698
- 'Bridge has stopped communicating with Seam',
33699
- properties: {
33700
- created_at: {
33701
- format: 'date-time',
33702
- type: 'string',
33703
- },
33704
- error_code: {
33705
- description:
33706
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
33707
- enum: ['no_communication_from_bridge'],
33708
- type: 'string',
33709
- },
33710
- message: { type: 'string' },
33711
- },
33712
- required: [
33713
- 'message',
33714
- 'created_at',
33715
- 'error_code',
33716
- ],
33717
- type: 'object',
33718
- },
33719
- ],
33720
- },
33721
- type: 'array',
33722
- },
33723
- pairing_code: {
33724
- maxLength: 6,
33725
- minLength: 6,
33726
- type: 'string',
33727
- },
33728
- pairing_code_expires_at: {
33729
- format: 'date-time',
33730
- type: 'string',
33731
- },
33732
- tailscale_auth_key: { nullable: true, type: 'string' },
33733
- tailscale_hostname: { type: 'string' },
33734
- telemetry_token: { nullable: true, type: 'string' },
33735
- telemetry_token_expires_at: {
33736
- format: 'date-time',
33737
- nullable: true,
33738
- type: 'string',
33739
- },
33740
- telemetry_url: { nullable: true, type: 'string' },
33741
- },
33742
- required: [
33743
- 'created_at',
33744
- 'bridge_client_session_id',
33745
- 'bridge_client_session_token',
33746
- 'pairing_code',
33747
- 'pairing_code_expires_at',
33748
- 'tailscale_hostname',
33749
- 'tailscale_auth_key',
33750
- 'bridge_client_name',
33751
- 'bridge_client_time_zone',
33752
- 'bridge_client_machine_identifier_key',
33753
- 'errors',
33754
- 'telemetry_token',
33755
- 'telemetry_token_expires_at',
33756
- 'telemetry_url',
33757
- ],
33758
- type: 'object',
33759
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
33760
- 'x-undocumented': 'Seam Bridge Client only.',
33408
+ $ref: '#/components/schemas/bridge_client_session',
33761
33409
  },
33762
33410
  ok: { type: 'boolean' },
33763
33411
  },
@@ -33859,39 +33507,7 @@ export default {
33859
33507
  properties: {
33860
33508
  bridge_connected_systems: {
33861
33509
  items: {
33862
- properties: {
33863
- acs_system_display_name: { type: 'string' },
33864
- acs_system_id: { format: 'uuid', type: 'string' },
33865
- bridge_created_at: {
33866
- format: 'date-time',
33867
- type: 'string',
33868
- },
33869
- bridge_id: { format: 'uuid', type: 'string' },
33870
- connected_account_created_at: {
33871
- format: 'date-time',
33872
- type: 'string',
33873
- },
33874
- connected_account_id: {
33875
- format: 'uuid',
33876
- type: 'string',
33877
- },
33878
- workspace_display_name: { type: 'string' },
33879
- workspace_id: { format: 'uuid', type: 'string' },
33880
- },
33881
- required: [
33882
- 'bridge_id',
33883
- 'bridge_created_at',
33884
- 'connected_account_id',
33885
- 'connected_account_created_at',
33886
- 'acs_system_id',
33887
- 'acs_system_display_name',
33888
- 'workspace_id',
33889
- 'workspace_display_name',
33890
- ],
33891
- type: 'object',
33892
- 'x-route-path':
33893
- '/seam/bridge/v1/bridge_connected_systems',
33894
- 'x-undocumented': 'Seam Bridge Client only.',
33510
+ $ref: '#/components/schemas/bridge_connected_systems',
33895
33511
  },
33896
33512
  type: 'array',
33897
33513
  },
@@ -33927,39 +33543,7 @@ export default {
33927
33543
  properties: {
33928
33544
  bridge_connected_systems: {
33929
33545
  items: {
33930
- properties: {
33931
- acs_system_display_name: { type: 'string' },
33932
- acs_system_id: { format: 'uuid', type: 'string' },
33933
- bridge_created_at: {
33934
- format: 'date-time',
33935
- type: 'string',
33936
- },
33937
- bridge_id: { format: 'uuid', type: 'string' },
33938
- connected_account_created_at: {
33939
- format: 'date-time',
33940
- type: 'string',
33941
- },
33942
- connected_account_id: {
33943
- format: 'uuid',
33944
- type: 'string',
33945
- },
33946
- workspace_display_name: { type: 'string' },
33947
- workspace_id: { format: 'uuid', type: 'string' },
33948
- },
33949
- required: [
33950
- 'bridge_id',
33951
- 'bridge_created_at',
33952
- 'connected_account_id',
33953
- 'connected_account_created_at',
33954
- 'acs_system_id',
33955
- 'acs_system_display_name',
33956
- 'workspace_id',
33957
- 'workspace_display_name',
33958
- ],
33959
- type: 'object',
33960
- 'x-route-path':
33961
- '/seam/bridge/v1/bridge_connected_systems',
33962
- 'x-undocumented': 'Seam Bridge Client only.',
33546
+ $ref: '#/components/schemas/bridge_connected_systems',
33963
33547
  },
33964
33548
  type: 'array',
33965
33549
  },
@@ -34295,36 +33879,7 @@ export default {
34295
33879
  properties: {
34296
33880
  ok: { type: 'boolean' },
34297
33881
  partner_resources: {
34298
- items: {
34299
- properties: {
34300
- custom_metadata: {
34301
- additionalProperties: { type: 'string' },
34302
- type: 'object',
34303
- },
34304
- customer_key: { type: 'string' },
34305
- description: { type: 'string' },
34306
- email_address: { type: 'string' },
34307
- ends_at: { type: 'string' },
34308
- location_keys: {
34309
- items: { type: 'string' },
34310
- type: 'array',
34311
- },
34312
- name: { type: 'string' },
34313
- partner_resource_key: { type: 'string' },
34314
- partner_resource_type: { type: 'string' },
34315
- phone_number: { type: 'string' },
34316
- starts_at: { type: 'string' },
34317
- user_identity_key: { type: 'string' },
34318
- },
34319
- required: [
34320
- 'partner_resource_type',
34321
- 'partner_resource_key',
34322
- 'customer_key',
34323
- ],
34324
- type: 'object',
34325
- 'x-route-path': '/unstable_partner/resources',
34326
- 'x-undocumented': 'Unreleased.',
34327
- },
33882
+ items: { $ref: '#/components/schemas/partner_resource' },
34328
33883
  type: 'array',
34329
33884
  },
34330
33885
  },
@@ -35324,115 +34879,48 @@ export default {
35324
34879
  type: 'string',
35325
34880
  },
35326
34881
  name: {
35327
- description: 'Name of the thermostat daily program.',
35328
- type: 'string',
35329
- },
35330
- periods: {
35331
- description: 'Array of thermostat daily program periods.',
35332
- items: {
35333
- description:
35334
- '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.',
35335
- properties: {
35336
- climate_preset_key: {
35337
- description:
35338
- '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`.',
35339
- type: 'string',
35340
- },
35341
- starts_at_time: {
35342
- description:
35343
- 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
35344
- pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
35345
- type: 'string',
35346
- },
35347
- },
35348
- required: ['starts_at_time', 'climate_preset_key'],
35349
- type: 'object',
35350
- },
35351
- type: 'array',
35352
- },
35353
- },
35354
- required: ['device_id', 'name', 'periods'],
35355
- type: 'object',
35356
- },
35357
- },
35358
- },
35359
- },
35360
- responses: {
35361
- 200: {
35362
- content: {
35363
- 'application/json': {
35364
- schema: {
35365
- properties: {
35366
- ok: { type: 'boolean' },
35367
- thermostat_daily_program: {
35368
- description:
35369
- '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.',
35370
- properties: {
35371
- created_at: {
35372
- description:
35373
- 'Date and time at which the thermostat daily program was created.',
35374
- format: 'date-time',
35375
- type: 'string',
35376
- },
35377
- device_id: {
35378
- description:
35379
- 'ID of the thermostat device on which the thermostat daily program is configured.',
35380
- format: 'uuid',
35381
- type: 'string',
35382
- },
35383
- name: {
35384
- description:
35385
- 'User-friendly name to identify the thermostat daily program.',
35386
- nullable: true,
35387
- type: 'string',
35388
- },
35389
- periods: {
35390
- description:
35391
- 'Array of thermostat daily program periods.',
35392
- items: {
35393
- description:
35394
- '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.',
35395
- properties: {
35396
- climate_preset_key: {
35397
- description:
35398
- '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`.',
35399
- type: 'string',
35400
- },
35401
- starts_at_time: {
35402
- description:
35403
- 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
35404
- pattern:
35405
- '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
35406
- type: 'string',
35407
- },
35408
- },
35409
- required: ['starts_at_time', 'climate_preset_key'],
35410
- type: 'object',
35411
- },
35412
- type: 'array',
35413
- },
35414
- thermostat_daily_program_id: {
35415
- description: 'ID of the thermostat daily program.',
35416
- format: 'uuid',
34882
+ description: 'Name of the thermostat daily program.',
34883
+ type: 'string',
34884
+ },
34885
+ periods: {
34886
+ description: 'Array of thermostat daily program periods.',
34887
+ items: {
34888
+ description:
34889
+ '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.',
34890
+ properties: {
34891
+ climate_preset_key: {
34892
+ description:
34893
+ '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`.',
35417
34894
  type: 'string',
35418
34895
  },
35419
- workspace_id: {
34896
+ starts_at_time: {
35420
34897
  description:
35421
- 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.',
35422
- format: 'uuid',
34898
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
34899
+ pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
35423
34900
  type: 'string',
35424
34901
  },
35425
34902
  },
35426
- required: [
35427
- 'thermostat_daily_program_id',
35428
- 'device_id',
35429
- 'name',
35430
- 'periods',
35431
- 'workspace_id',
35432
- 'created_at',
35433
- ],
34903
+ required: ['starts_at_time', 'climate_preset_key'],
35434
34904
  type: 'object',
35435
- 'x-route-path': '/thermostats/thermostat_daily_programs',
34905
+ },
34906
+ type: 'array',
34907
+ },
34908
+ },
34909
+ required: ['device_id', 'name', 'periods'],
34910
+ type: 'object',
34911
+ },
34912
+ },
34913
+ },
34914
+ },
34915
+ responses: {
34916
+ 200: {
34917
+ content: {
34918
+ 'application/json': {
34919
+ schema: {
34920
+ properties: {
34921
+ ok: { type: 'boolean' },
34922
+ thermostat_daily_program: {
34923
+ $ref: '#/components/schemas/thermostat_daily_program',
35436
34924
  },
35437
34925
  },
35438
34926
  required: ['thermostat_daily_program', 'ok'],
@@ -38521,56 +38009,7 @@ export default {
38521
38009
  'application/json': {
38522
38010
  schema: {
38523
38011
  properties: {
38524
- location: {
38525
- properties: {
38526
- created_at: {
38527
- description:
38528
- 'Date and time at which the location object was created.',
38529
- format: 'date-time',
38530
- type: 'string',
38531
- },
38532
- display_name: {
38533
- description: 'Display name of the location.',
38534
- type: 'string',
38535
- },
38536
- geolocation: {
38537
- description: 'Geographical location of the location.',
38538
- properties: {
38539
- latitude: { format: 'float', type: 'number' },
38540
- longitude: { format: 'float', type: 'number' },
38541
- },
38542
- required: ['latitude', 'longitude'],
38543
- type: 'object',
38544
- },
38545
- location_id: {
38546
- description: 'Unique identifier for the location.',
38547
- format: 'uuid',
38548
- type: 'string',
38549
- },
38550
- name: {
38551
- description: 'Name of the location.',
38552
- type: 'string',
38553
- },
38554
- time_zone: {
38555
- description: 'Time zone of the location.',
38556
- type: 'string',
38557
- },
38558
- workspace_id: {
38559
- description:
38560
- 'Unique identifier for the Seam workspace associated with the location.',
38561
- format: 'uuid',
38562
- type: 'string',
38563
- },
38564
- },
38565
- required: [
38566
- 'location_id',
38567
- 'workspace_id',
38568
- 'name',
38569
- 'display_name',
38570
- 'created_at',
38571
- ],
38572
- type: 'object',
38573
- },
38012
+ location: { $ref: '#/components/schemas/location' },
38574
38013
  ok: { type: 'boolean' },
38575
38014
  },
38576
38015
  required: ['location', 'ok'],
@@ -38676,56 +38115,7 @@ export default {
38676
38115
  'application/json': {
38677
38116
  schema: {
38678
38117
  properties: {
38679
- location: {
38680
- properties: {
38681
- created_at: {
38682
- description:
38683
- 'Date and time at which the location object was created.',
38684
- format: 'date-time',
38685
- type: 'string',
38686
- },
38687
- display_name: {
38688
- description: 'Display name of the location.',
38689
- type: 'string',
38690
- },
38691
- geolocation: {
38692
- description: 'Geographical location of the location.',
38693
- properties: {
38694
- latitude: { format: 'float', type: 'number' },
38695
- longitude: { format: 'float', type: 'number' },
38696
- },
38697
- required: ['latitude', 'longitude'],
38698
- type: 'object',
38699
- },
38700
- location_id: {
38701
- description: 'Unique identifier for the location.',
38702
- format: 'uuid',
38703
- type: 'string',
38704
- },
38705
- name: {
38706
- description: 'Name of the location.',
38707
- type: 'string',
38708
- },
38709
- time_zone: {
38710
- description: 'Time zone of the location.',
38711
- type: 'string',
38712
- },
38713
- workspace_id: {
38714
- description:
38715
- 'Unique identifier for the Seam workspace associated with the location.',
38716
- format: 'uuid',
38717
- type: 'string',
38718
- },
38719
- },
38720
- required: [
38721
- 'location_id',
38722
- 'workspace_id',
38723
- 'name',
38724
- 'display_name',
38725
- 'created_at',
38726
- ],
38727
- type: 'object',
38728
- },
38118
+ location: { $ref: '#/components/schemas/location' },
38729
38119
  ok: { type: 'boolean' },
38730
38120
  },
38731
38121
  required: ['location', 'ok'],
@@ -38764,57 +38154,7 @@ export default {
38764
38154
  schema: {
38765
38155
  properties: {
38766
38156
  locations: {
38767
- items: {
38768
- properties: {
38769
- created_at: {
38770
- description:
38771
- 'Date and time at which the location object was created.',
38772
- format: 'date-time',
38773
- type: 'string',
38774
- },
38775
- display_name: {
38776
- description: 'Display name of the location.',
38777
- type: 'string',
38778
- },
38779
- geolocation: {
38780
- description:
38781
- 'Geographical location of the location.',
38782
- properties: {
38783
- latitude: { format: 'float', type: 'number' },
38784
- longitude: { format: 'float', type: 'number' },
38785
- },
38786
- required: ['latitude', 'longitude'],
38787
- type: 'object',
38788
- },
38789
- location_id: {
38790
- description: 'Unique identifier for the location.',
38791
- format: 'uuid',
38792
- type: 'string',
38793
- },
38794
- name: {
38795
- description: 'Name of the location.',
38796
- type: 'string',
38797
- },
38798
- time_zone: {
38799
- description: 'Time zone of the location.',
38800
- type: 'string',
38801
- },
38802
- workspace_id: {
38803
- description:
38804
- 'Unique identifier for the Seam workspace associated with the location.',
38805
- format: 'uuid',
38806
- type: 'string',
38807
- },
38808
- },
38809
- required: [
38810
- 'location_id',
38811
- 'workspace_id',
38812
- 'name',
38813
- 'display_name',
38814
- 'created_at',
38815
- ],
38816
- type: 'object',
38817
- },
38157
+ items: { $ref: '#/components/schemas/location' },
38818
38158
  type: 'array',
38819
38159
  },
38820
38160
  ok: { type: 'boolean' },
@@ -38851,57 +38191,7 @@ export default {
38851
38191
  schema: {
38852
38192
  properties: {
38853
38193
  locations: {
38854
- items: {
38855
- properties: {
38856
- created_at: {
38857
- description:
38858
- 'Date and time at which the location object was created.',
38859
- format: 'date-time',
38860
- type: 'string',
38861
- },
38862
- display_name: {
38863
- description: 'Display name of the location.',
38864
- type: 'string',
38865
- },
38866
- geolocation: {
38867
- description:
38868
- 'Geographical location of the location.',
38869
- properties: {
38870
- latitude: { format: 'float', type: 'number' },
38871
- longitude: { format: 'float', type: 'number' },
38872
- },
38873
- required: ['latitude', 'longitude'],
38874
- type: 'object',
38875
- },
38876
- location_id: {
38877
- description: 'Unique identifier for the location.',
38878
- format: 'uuid',
38879
- type: 'string',
38880
- },
38881
- name: {
38882
- description: 'Name of the location.',
38883
- type: 'string',
38884
- },
38885
- time_zone: {
38886
- description: 'Time zone of the location.',
38887
- type: 'string',
38888
- },
38889
- workspace_id: {
38890
- description:
38891
- 'Unique identifier for the Seam workspace associated with the location.',
38892
- format: 'uuid',
38893
- type: 'string',
38894
- },
38895
- },
38896
- required: [
38897
- 'location_id',
38898
- 'workspace_id',
38899
- 'name',
38900
- 'display_name',
38901
- 'created_at',
38902
- ],
38903
- type: 'object',
38904
- },
38194
+ items: { $ref: '#/components/schemas/location' },
38905
38195
  type: 'array',
38906
38196
  },
38907
38197
  ok: { type: 'boolean' },
@@ -39091,56 +38381,7 @@ export default {
39091
38381
  'application/json': {
39092
38382
  schema: {
39093
38383
  properties: {
39094
- location: {
39095
- properties: {
39096
- created_at: {
39097
- description:
39098
- 'Date and time at which the location object was created.',
39099
- format: 'date-time',
39100
- type: 'string',
39101
- },
39102
- display_name: {
39103
- description: 'Display name of the location.',
39104
- type: 'string',
39105
- },
39106
- geolocation: {
39107
- description: 'Geographical location of the location.',
39108
- properties: {
39109
- latitude: { format: 'float', type: 'number' },
39110
- longitude: { format: 'float', type: 'number' },
39111
- },
39112
- required: ['latitude', 'longitude'],
39113
- type: 'object',
39114
- },
39115
- location_id: {
39116
- description: 'Unique identifier for the location.',
39117
- format: 'uuid',
39118
- type: 'string',
39119
- },
39120
- name: {
39121
- description: 'Name of the location.',
39122
- type: 'string',
39123
- },
39124
- time_zone: {
39125
- description: 'Time zone of the location.',
39126
- type: 'string',
39127
- },
39128
- workspace_id: {
39129
- description:
39130
- 'Unique identifier for the Seam workspace associated with the location.',
39131
- format: 'uuid',
39132
- type: 'string',
39133
- },
39134
- },
39135
- required: [
39136
- 'location_id',
39137
- 'workspace_id',
39138
- 'name',
39139
- 'display_name',
39140
- 'created_at',
39141
- ],
39142
- type: 'object',
39143
- },
38384
+ location: { $ref: '#/components/schemas/location' },
39144
38385
  ok: { type: 'boolean' },
39145
38386
  },
39146
38387
  required: ['location', 'ok'],
@@ -39208,56 +38449,7 @@ export default {
39208
38449
  'application/json': {
39209
38450
  schema: {
39210
38451
  properties: {
39211
- location: {
39212
- properties: {
39213
- created_at: {
39214
- description:
39215
- 'Date and time at which the location object was created.',
39216
- format: 'date-time',
39217
- type: 'string',
39218
- },
39219
- display_name: {
39220
- description: 'Display name of the location.',
39221
- type: 'string',
39222
- },
39223
- geolocation: {
39224
- description: 'Geographical location of the location.',
39225
- properties: {
39226
- latitude: { format: 'float', type: 'number' },
39227
- longitude: { format: 'float', type: 'number' },
39228
- },
39229
- required: ['latitude', 'longitude'],
39230
- type: 'object',
39231
- },
39232
- location_id: {
39233
- description: 'Unique identifier for the location.',
39234
- format: 'uuid',
39235
- type: 'string',
39236
- },
39237
- name: {
39238
- description: 'Name of the location.',
39239
- type: 'string',
39240
- },
39241
- time_zone: {
39242
- description: 'Time zone of the location.',
39243
- type: 'string',
39244
- },
39245
- workspace_id: {
39246
- description:
39247
- 'Unique identifier for the Seam workspace associated with the location.',
39248
- format: 'uuid',
39249
- type: 'string',
39250
- },
39251
- },
39252
- required: [
39253
- 'location_id',
39254
- 'workspace_id',
39255
- 'name',
39256
- 'display_name',
39257
- 'created_at',
39258
- ],
39259
- type: 'object',
39260
- },
38452
+ location: { $ref: '#/components/schemas/location' },
39261
38453
  ok: { type: 'boolean' },
39262
38454
  },
39263
38455
  required: ['location', 'ok'],
@@ -39879,7 +39071,7 @@ export default {
39879
39071
  '/user_identities/delete': {
39880
39072
  post: {
39881
39073
  description:
39882
- '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). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.',
39074
+ '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).',
39883
39075
  operationId: 'userIdentitiesDeletePost',
39884
39076
  requestBody: {
39885
39077
  content: {
@@ -40095,32 +39287,7 @@ export default {
40095
39287
  schema: {
40096
39288
  properties: {
40097
39289
  enrollment_automation: {
40098
- properties: {
40099
- acs_credential_provisioning_automation_id: {
40100
- format: 'uuid',
40101
- type: 'string',
40102
- },
40103
- created_at: { format: 'date-time', type: 'string' },
40104
- credential_manager_acs_system_id: {
40105
- format: 'uuid',
40106
- type: 'string',
40107
- },
40108
- enrollment_automation_id: {
40109
- format: 'uuid',
40110
- type: 'string',
40111
- },
40112
- user_identity_id: { format: 'uuid', type: 'string' },
40113
- workspace_id: { format: 'uuid', type: 'string' },
40114
- },
40115
- required: [
40116
- 'acs_credential_provisioning_automation_id',
40117
- 'credential_manager_acs_system_id',
40118
- 'user_identity_id',
40119
- 'created_at',
40120
- 'workspace_id',
40121
- 'enrollment_automation_id',
40122
- ],
40123
- type: 'object',
39290
+ $ref: '#/components/schemas/enrollment_automation',
40124
39291
  },
40125
39292
  ok: { type: 'boolean' },
40126
39293
  },