@seamapi/types 1.345.1 → 1.346.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/connect.cjs +327 -687
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +269 -484
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/model-types.d.ts +1 -1
  8. package/lib/seam/connect/models/bridges/bridge.d.ts +15 -0
  9. package/lib/seam/connect/models/bridges/bridge.js +12 -0
  10. package/lib/seam/connect/models/bridges/bridge.js.map +1 -0
  11. package/lib/seam/connect/models/bridges/index.d.ts +1 -0
  12. package/lib/seam/connect/models/bridges/index.js +2 -0
  13. package/lib/seam/connect/models/bridges/index.js.map +1 -0
  14. package/lib/seam/connect/models/devices/device-type.js +3 -1
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/phone-properties.js +7 -3
  17. package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
  18. package/lib/seam/connect/models/devices/phone.d.ts +29 -2450
  19. package/lib/seam/connect/models/devices/phone.js +36 -15
  20. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  21. package/lib/seam/connect/models/index.d.ts +1 -0
  22. package/lib/seam/connect/models/index.js +1 -0
  23. package/lib/seam/connect/models/index.js.map +1 -1
  24. package/lib/seam/connect/openapi.d.ts +188 -141
  25. package/lib/seam/connect/openapi.js +273 -642
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +63 -341
  28. package/lib/seam/connect/schemas.d.ts +1 -1
  29. package/lib/seam/connect/schemas.js +1 -1
  30. package/lib/seam/connect/schemas.js.map +1 -1
  31. package/package.json +2 -2
  32. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  33. package/src/lib/seam/connect/model-types.ts +1 -0
  34. package/src/lib/seam/connect/models/bridges/bridge.ts +13 -0
  35. package/src/lib/seam/connect/models/bridges/index.ts +1 -0
  36. package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
  37. package/src/lib/seam/connect/models/devices/phone-properties.ts +36 -32
  38. package/src/lib/seam/connect/models/devices/phone.ts +53 -15
  39. package/src/lib/seam/connect/models/index.ts +1 -0
  40. package/src/lib/seam/connect/openapi.ts +269 -676
  41. package/src/lib/seam/connect/route-types.ts +63 -419
  42. package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs CHANGED
@@ -19,6 +19,7 @@ __export(schemas_exports, {
19
19
  acs_system: () => acs_system,
20
20
  acs_user: () => acs_user,
21
21
  action_attempt: () => action_attempt,
22
+ bridge: () => bridge,
22
23
  client_session: () => client_session,
23
24
  common_failed_action_attempt: () => common_failed_action_attempt,
24
25
  common_pending_action_attempt: () => common_pending_action_attempt,
@@ -796,9 +797,7 @@ var PHONE_DEVICE_TYPE = {
796
797
  var PHONE_DEVICE_TYPE_LIST = Object.values(
797
798
  PHONE_DEVICE_TYPE
798
799
  );
799
- var phone_device_type = zod.z.enum(
800
- Object.values(PHONE_DEVICE_TYPE_LIST)
801
- );
800
+ var phone_device_type = zod.z.enum(Object.values(PHONE_DEVICE_TYPE_LIST)).describe("Type of phone.");
802
801
  var any_device_type = zod.z.union([
803
802
  lock_device_type,
804
803
  noise_sensor_device_type,
@@ -822,7 +821,7 @@ var phone_specific_properties = zod.z.object({
822
821
  "Indicates whether the credential service has an active associated phone."
823
822
  )
824
823
  }).optional().describe("Salto Space credential service metadata for the phone.")
825
- });
824
+ }).describe("Properties of the phone.");
826
825
 
827
826
  // src/lib/seam/connect/models/devices/device.ts
828
827
  var device_capability_flags2 = models_exports.device_capability_flags.extend({
@@ -2509,6 +2508,16 @@ var action_attempt = zod.z.union([
2509
2508
  route_path: /action_attempts
2510
2509
  ---
2511
2510
  `);
2511
+ var bridge = zod.z.object({
2512
+ bridge_id: zod.z.string().uuid(),
2513
+ workspace_id: zod.z.string().uuid(),
2514
+ created_at: zod.z.string().datetime()
2515
+ }).describe(`
2516
+ ---
2517
+ undocumented: Unreleased.
2518
+ route_path: /bridges
2519
+ ---
2520
+ `);
2512
2521
  var client_session = zod.z.object({
2513
2522
  client_session_id: zod.z.string().uuid(),
2514
2523
  workspace_id: zod.z.string().uuid(),
@@ -8639,7 +8648,11 @@ var openapi_default = {
8639
8648
  ],
8640
8649
  type: "string"
8641
8650
  },
8642
- { enum: ["ios_phone", "android_phone"], type: "string" }
8651
+ {
8652
+ description: "Type of phone.",
8653
+ enum: ["ios_phone", "android_phone"],
8654
+ type: "string"
8655
+ }
8643
8656
  ]
8644
8657
  },
8645
8658
  display_name: {
@@ -9057,6 +9070,7 @@ var openapi_default = {
9057
9070
  type: "object"
9058
9071
  },
9059
9072
  {
9073
+ description: "Properties of the phone.",
9060
9074
  properties: {
9061
9075
  assa_abloy_credential_service_metadata: {
9062
9076
  description: "ASSA ABLOY Credential Service metadata for the phone.",
@@ -14545,36 +14559,10 @@ var openapi_default = {
14545
14559
  "x-route-path": "/noise_sensors/noise_thresholds"
14546
14560
  },
14547
14561
  phone: {
14548
- description: "Properties of the phone.",
14562
+ description: "Represents an app user's mobile phone.",
14549
14563
  properties: {
14550
- can_hvac_cool: { type: "boolean" },
14551
- can_hvac_heat: { type: "boolean" },
14552
- can_hvac_heat_cool: { type: "boolean" },
14553
- can_program_offline_access_codes: { type: "boolean" },
14554
- can_program_online_access_codes: { type: "boolean" },
14555
- can_remotely_lock: { type: "boolean" },
14556
- can_remotely_unlock: { type: "boolean" },
14557
- can_simulate_connection: { type: "boolean" },
14558
- can_simulate_disconnection: { type: "boolean" },
14559
- can_simulate_removal: { type: "boolean" },
14560
- can_turn_off_hvac: { type: "boolean" },
14561
- capabilities_supported: {
14562
- description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
14563
- items: {
14564
- enum: [
14565
- "access_code",
14566
- "lock",
14567
- "noise_detection",
14568
- "thermostat",
14569
- "battery",
14570
- "phone"
14571
- ],
14572
- type: "string"
14573
- },
14574
- type: "array"
14575
- },
14576
14564
  created_at: {
14577
- description: "Date and time at which the device object was created.",
14565
+ description: "Date and time at which the `phone` was created.",
14578
14566
  format: "date-time",
14579
14567
  type: "string"
14580
14568
  },
@@ -14582,705 +14570,272 @@ var openapi_default = {
14582
14570
  additionalProperties: {
14583
14571
  oneOf: [{ type: "string" }, { type: "boolean" }]
14584
14572
  },
14573
+ description: "Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.",
14585
14574
  type: "object"
14586
14575
  },
14587
14576
  device_id: {
14588
- description: "Unique identifier for the device.",
14577
+ description: "ID of the `phone`.",
14589
14578
  format: "uuid",
14590
14579
  type: "string"
14591
14580
  },
14592
14581
  device_type: {
14593
14582
  description: "Type of phone.",
14594
- enum: ["android_phone", "ios_phone"],
14583
+ enum: ["ios_phone", "android_phone"],
14595
14584
  type: "string"
14596
14585
  },
14597
14586
  display_name: {
14598
- description: "Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.",
14587
+ description: "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.",
14599
14588
  type: "string"
14600
14589
  },
14601
14590
  errors: {
14602
- description: 'Array of errors associated with the device. 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.',
14591
+ description: "Errors associated with the `phone`.",
14592
+ items: {
14593
+ properties: {
14594
+ error_code: { type: "string" },
14595
+ message: { type: "string" }
14596
+ },
14597
+ required: ["error_code", "message"],
14598
+ type: "object"
14599
+ },
14600
+ type: "array"
14601
+ },
14602
+ nickname: {
14603
+ description: "Optional nickname to describe the phone, settable through Seam.",
14604
+ type: "string"
14605
+ },
14606
+ properties: {
14607
+ description: "Properties of the phone.",
14608
+ properties: {
14609
+ assa_abloy_credential_service_metadata: {
14610
+ description: "ASSA ABLOY Credential Service metadata for the phone.",
14611
+ properties: {
14612
+ endpoints: {
14613
+ description: "Endpoints associated with the phone.",
14614
+ items: {
14615
+ properties: {
14616
+ endpoint_id: {
14617
+ description: "ID of the associated endpoint.",
14618
+ type: "string"
14619
+ },
14620
+ is_active: {
14621
+ description: "Indicated whether the endpoint is active.",
14622
+ type: "boolean"
14623
+ }
14624
+ },
14625
+ required: ["endpoint_id", "is_active"],
14626
+ type: "object"
14627
+ },
14628
+ type: "array"
14629
+ },
14630
+ has_active_endpoint: {
14631
+ description: "Indicates whether the credential service has active endpoints associated with the phone.",
14632
+ type: "boolean"
14633
+ }
14634
+ },
14635
+ required: ["has_active_endpoint", "endpoints"],
14636
+ type: "object"
14637
+ },
14638
+ salto_space_credential_service_metadata: {
14639
+ description: "Salto Space credential service metadata for the phone.",
14640
+ properties: {
14641
+ has_active_phone: {
14642
+ description: "Indicates whether the credential service has an active associated phone.",
14643
+ type: "boolean"
14644
+ }
14645
+ },
14646
+ required: ["has_active_phone"],
14647
+ type: "object"
14648
+ }
14649
+ },
14650
+ type: "object"
14651
+ },
14652
+ warnings: {
14653
+ description: "Warnings associated with the `phone`.",
14654
+ items: {
14655
+ properties: {
14656
+ message: { type: "string" },
14657
+ warning_code: { type: "string" }
14658
+ },
14659
+ required: ["warning_code", "message"],
14660
+ type: "object"
14661
+ },
14662
+ type: "array"
14663
+ },
14664
+ workspace_id: {
14665
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.",
14666
+ format: "uuid",
14667
+ type: "string"
14668
+ }
14669
+ },
14670
+ required: [
14671
+ "device_id",
14672
+ "display_name",
14673
+ "workspace_id",
14674
+ "created_at",
14675
+ "custom_metadata",
14676
+ "errors",
14677
+ "warnings",
14678
+ "device_type",
14679
+ "properties"
14680
+ ],
14681
+ type: "object",
14682
+ "x-route-path": "/phones"
14683
+ },
14684
+ thermostat_schedule: {
14685
+ 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.",
14686
+ properties: {
14687
+ climate_preset_key: {
14688
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
14689
+ type: "string"
14690
+ },
14691
+ created_at: {
14692
+ description: "Date and time at which the thermostat schedule was created.",
14693
+ format: "date-time",
14694
+ type: "string"
14695
+ },
14696
+ device_id: {
14697
+ description: "ID of the desired thermostat device.",
14698
+ format: "uuid",
14699
+ type: "string"
14700
+ },
14701
+ ends_at: {
14702
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
14703
+ format: "date-time",
14704
+ type: "string"
14705
+ },
14706
+ errors: {
14707
+ description: "Array of errors associated with the thermostat schedule. 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.",
14708
+ items: {
14709
+ properties: {
14710
+ error_code: { type: "string" },
14711
+ message: { type: "string" }
14712
+ },
14713
+ required: ["error_code", "message"],
14714
+ type: "object"
14715
+ },
14716
+ type: "array"
14717
+ },
14718
+ max_override_period_minutes: {
14719
+ description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
14720
+ minimum: 0,
14721
+ type: "integer"
14722
+ },
14723
+ name: {
14724
+ description: "User-friendly name to identify the thermostat schedule.",
14725
+ type: "string"
14726
+ },
14727
+ starts_at: {
14728
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
14729
+ format: "date-time",
14730
+ type: "string"
14731
+ },
14732
+ thermostat_schedule_id: {
14733
+ description: "ID of the thermostat schedule.",
14734
+ format: "uuid",
14735
+ type: "string"
14736
+ },
14737
+ unstable_is_override_allowed: {
14738
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
14739
+ type: "boolean",
14740
+ "x-undocumented": "Unstable"
14741
+ }
14742
+ },
14743
+ required: [
14744
+ "thermostat_schedule_id",
14745
+ "device_id",
14746
+ "climate_preset_key",
14747
+ "max_override_period_minutes",
14748
+ "starts_at",
14749
+ "ends_at",
14750
+ "created_at",
14751
+ "errors"
14752
+ ],
14753
+ type: "object",
14754
+ "x-route-path": "/thermostats/schedules"
14755
+ },
14756
+ unmanaged_access_code: {
14757
+ properties: {
14758
+ access_code_id: {
14759
+ description: "Unique identifier for the access code.",
14760
+ format: "uuid",
14761
+ type: "string"
14762
+ },
14763
+ code: {
14764
+ description: "Code used for access. Typically, a numeric or alphanumeric string.",
14765
+ nullable: true,
14766
+ type: "string"
14767
+ },
14768
+ created_at: {
14769
+ description: "Date and time at which the access code was created.",
14770
+ format: "date-time",
14771
+ type: "string"
14772
+ },
14773
+ device_id: {
14774
+ description: "Unique identifier for the device associated with the access code.",
14775
+ format: "uuid",
14776
+ type: "string"
14777
+ },
14778
+ ends_at: {
14779
+ description: "Date and time after which the time-bound access code becomes inactive.",
14780
+ format: "date-time",
14781
+ nullable: true,
14782
+ type: "string"
14783
+ },
14784
+ errors: {
14785
+ description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
14603
14786
  items: {
14604
14787
  discriminator: { propertyName: "error_code" },
14605
14788
  oneOf: [
14606
14789
  {
14607
- description: "Device is offline",
14790
+ description: "Failed to set code on Smart Things device.",
14608
14791
  properties: {
14609
14792
  error_code: {
14610
14793
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14611
- enum: ["device_offline"],
14794
+ enum: ["smartthings_failed_to_set_access_code"],
14612
14795
  type: "string"
14613
14796
  },
14614
- is_device_error: { enum: [true], type: "boolean" },
14797
+ is_access_code_error: { enum: [true], type: "boolean" },
14615
14798
  message: { type: "string" }
14616
14799
  },
14617
- required: ["message", "is_device_error", "error_code"],
14800
+ required: ["message", "is_access_code_error", "error_code"],
14618
14801
  type: "object"
14619
14802
  },
14620
14803
  {
14621
- description: "Device has been removed",
14804
+ description: "Failed to set code after multiple retries.",
14622
14805
  properties: {
14623
14806
  error_code: {
14624
14807
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14625
- enum: ["device_removed"],
14808
+ enum: [
14809
+ "smartthings_failed_to_set_after_multiple_retries"
14810
+ ],
14626
14811
  type: "string"
14627
14812
  },
14628
- is_device_error: { enum: [true], type: "boolean" },
14813
+ is_access_code_error: { enum: [true], type: "boolean" },
14629
14814
  message: { type: "string" }
14630
14815
  },
14631
- required: ["message", "is_device_error", "error_code"],
14816
+ required: ["message", "is_access_code_error", "error_code"],
14632
14817
  type: "object"
14633
14818
  },
14634
14819
  {
14635
- description: "Hub is disconnected",
14820
+ description: "Failed to set code on device.",
14636
14821
  properties: {
14637
14822
  error_code: {
14638
14823
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14639
- enum: ["hub_disconnected"],
14824
+ enum: ["failed_to_set_on_device"],
14640
14825
  type: "string"
14641
14826
  },
14642
- is_device_error: { enum: [true], type: "boolean" },
14827
+ is_access_code_error: { enum: [true], type: "boolean" },
14643
14828
  message: { type: "string" }
14644
14829
  },
14645
- required: ["message", "is_device_error", "error_code"],
14830
+ required: ["message", "is_access_code_error", "error_code"],
14646
14831
  type: "object"
14647
14832
  },
14648
14833
  {
14649
- description: "Device is disconnected",
14834
+ description: "Failed to remove code from device.",
14650
14835
  properties: {
14651
14836
  error_code: {
14652
14837
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14653
- enum: ["device_disconnected"],
14654
- type: "string"
14655
- },
14656
- is_device_error: { enum: [true], type: "boolean" },
14657
- message: { type: "string" }
14658
- },
14659
- required: ["message", "is_device_error", "error_code"],
14660
- type: "object"
14661
- },
14662
- {
14663
- description: "The backup access code pool is empty.",
14664
- properties: {
14665
- error_code: {
14666
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14667
- enum: ["empty_backup_access_code_pool"],
14668
- type: "string"
14669
- },
14670
- is_device_error: { enum: [true], type: "boolean" },
14671
- message: { type: "string" }
14672
- },
14673
- required: ["message", "is_device_error", "error_code"],
14674
- type: "object"
14675
- },
14676
- {
14677
- description: "User is not authorized to use the August Lock.",
14678
- properties: {
14679
- error_code: {
14680
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14681
- enum: ["august_lock_not_authorized"],
14682
- type: "string"
14683
- },
14684
- is_device_error: { enum: [true], type: "boolean" },
14685
- message: { type: "string" }
14686
- },
14687
- required: ["message", "is_device_error", "error_code"],
14688
- type: "object"
14689
- },
14690
- {
14691
- description: "Lock is not connected to the Seam Bridge.",
14692
- properties: {
14693
- error_code: {
14694
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14695
- enum: ["august_lock_missing_bridge"],
14696
- type: "string"
14697
- },
14698
- is_device_error: { enum: [true], type: "boolean" },
14699
- message: { type: "string" }
14700
- },
14701
- required: ["message", "is_device_error", "error_code"],
14702
- type: "object"
14703
- },
14704
- {
14705
- description: "Salto site user limit reached.",
14706
- properties: {
14707
- error_code: {
14708
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14709
- enum: ["salto_site_user_limit_reached"],
14710
- type: "string"
14711
- },
14712
- is_device_error: { enum: [true], type: "boolean" },
14713
- message: { type: "string" }
14714
- },
14715
- required: ["message", "is_device_error", "error_code"],
14716
- type: "object"
14717
- },
14718
- {
14719
- description: "Lock is not paired with a Gateway.",
14720
- properties: {
14721
- error_code: {
14722
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14723
- enum: ["ttlock_lock_not_paired_to_gateway"],
14724
- type: "string"
14725
- },
14726
- is_device_error: { enum: [true], type: "boolean" },
14727
- message: { type: "string" }
14728
- },
14729
- required: ["message", "is_device_error", "error_code"],
14730
- type: "object"
14731
- },
14732
- {
14733
- description: "Missing device credentials.",
14734
- properties: {
14735
- error_code: {
14736
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14737
- enum: ["missing_device_credentials"],
14738
- type: "string"
14739
- },
14740
- is_device_error: { enum: [true], type: "boolean" },
14741
- message: { type: "string" }
14742
- },
14743
- required: ["message", "is_device_error", "error_code"],
14744
- type: "object"
14745
- },
14746
- {
14747
- description: "The auxiliary heat is running.",
14748
- properties: {
14749
- error_code: {
14750
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14751
- enum: ["auxiliary_heat_running"],
14752
- type: "string"
14753
- },
14754
- is_device_error: { enum: [true], type: "boolean" },
14755
- message: { type: "string" }
14756
- },
14757
- required: ["message", "is_device_error", "error_code"],
14758
- type: "object"
14759
- },
14760
- {
14761
- description: "Subscription required to connect.",
14762
- properties: {
14763
- error_code: {
14764
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14765
- enum: ["subscription_required"],
14766
- type: "string"
14767
- },
14768
- is_device_error: { enum: [true], type: "boolean" },
14769
- message: { type: "string" }
14770
- },
14771
- required: ["message", "is_device_error", "error_code"],
14772
- type: "object"
14773
- },
14774
- {
14775
- description: "Account is disconnected.",
14776
- properties: {
14777
- error_code: {
14778
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14779
- enum: ["account_disconnected"],
14780
- type: "string"
14781
- },
14782
- is_connected_account_error: {
14783
- enum: [true],
14784
- type: "boolean"
14785
- },
14786
- message: { type: "string" }
14787
- },
14788
- required: [
14789
- "message",
14790
- "is_connected_account_error",
14791
- "error_code"
14792
- ],
14793
- type: "object"
14794
- },
14795
- {
14796
- description: "Credentials provided were invalid.",
14797
- properties: {
14798
- error_code: {
14799
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14800
- enum: ["invalid_credentials"],
14801
- type: "string"
14802
- },
14803
- is_connected_account_error: {
14804
- enum: [true],
14805
- type: "boolean"
14806
- },
14807
- message: { type: "string" }
14808
- },
14809
- required: [
14810
- "message",
14811
- "is_connected_account_error",
14812
- "error_code"
14813
- ],
14814
- type: "object"
14815
- }
14816
- ]
14817
- },
14818
- type: "array"
14819
- },
14820
- is_managed: {
14821
- description: "Indicates whether Seam manages the device.",
14822
- enum: [true],
14823
- type: "boolean"
14824
- },
14825
- location: {
14826
- description: "Location information for the device.",
14827
- nullable: true,
14828
- properties: {
14829
- location_name: {
14830
- description: "Name of the device location.",
14831
- type: "string"
14832
- },
14833
- timezone: {
14834
- description: "Time zone of the device location.",
14835
- type: "string"
14836
- }
14837
- },
14838
- type: "object"
14839
- },
14840
- nickname: {
14841
- description: "Optional nickname to describe the device, settable through Seam",
14842
- type: "string"
14843
- },
14844
- properties: {
14845
- properties: {
14846
- assa_abloy_credential_service_metadata: {
14847
- description: "ASSA ABLOY Credential Service metadata for the phone.",
14848
- properties: {
14849
- endpoints: {
14850
- description: "Endpoints associated with the phone.",
14851
- items: {
14852
- properties: {
14853
- endpoint_id: {
14854
- description: "ID of the associated endpoint.",
14855
- type: "string"
14856
- },
14857
- is_active: {
14858
- description: "Indicated whether the endpoint is active.",
14859
- type: "boolean"
14860
- }
14861
- },
14862
- required: ["endpoint_id", "is_active"],
14863
- type: "object"
14864
- },
14865
- type: "array"
14866
- },
14867
- has_active_endpoint: {
14868
- description: "Indicates whether the credential service has active endpoints associated with the phone.",
14869
- type: "boolean"
14870
- }
14871
- },
14872
- required: ["has_active_endpoint", "endpoints"],
14873
- type: "object"
14874
- },
14875
- salto_space_credential_service_metadata: {
14876
- description: "Salto Space credential service metadata for the phone.",
14877
- properties: {
14878
- has_active_phone: {
14879
- description: "Indicates whether the credential service has an active associated phone.",
14880
- type: "boolean"
14881
- }
14882
- },
14883
- required: ["has_active_phone"],
14884
- type: "object"
14885
- }
14886
- },
14887
- type: "object"
14888
- },
14889
- warnings: {
14890
- description: 'Array of warnings associated with the device. 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.',
14891
- items: {
14892
- discriminator: { propertyName: "warning_code" },
14893
- oneOf: [
14894
- {
14895
- description: "Backup access code unhealthy.",
14896
- properties: {
14897
- message: { type: "string" },
14898
- warning_code: {
14899
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14900
- enum: ["partial_backup_access_code_pool"],
14901
- type: "string"
14902
- }
14903
- },
14904
- required: ["message", "warning_code"],
14905
- type: "object"
14906
- },
14907
- {
14908
- description: "Too many backup codes.",
14909
- properties: {
14910
- message: { type: "string" },
14911
- warning_code: {
14912
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14913
- enum: ["many_active_backup_codes"],
14914
- type: "string"
14915
- }
14916
- },
14917
- required: ["message", "warning_code"],
14918
- type: "object"
14919
- },
14920
- {
14921
- description: "A Salto Lock displaying an unknown device type.",
14922
- properties: {
14923
- message: { type: "string" },
14924
- warning_code: {
14925
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14926
- enum: ["salto_unknown_device_type"],
14927
- type: "string"
14928
- }
14929
- },
14930
- required: ["message", "warning_code"],
14931
- type: "object"
14932
- },
14933
- {
14934
- description: "Wyze Lock is not connected to a gateway.",
14935
- properties: {
14936
- message: { type: "string" },
14937
- warning_code: {
14938
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14939
- enum: ["wyze_device_missing_gateway"],
14940
- type: "string"
14941
- }
14942
- },
14943
- required: ["message", "warning_code"],
14944
- type: "object"
14945
- },
14946
- {
14947
- description: "Device is offline, but has some functionality available.",
14948
- properties: {
14949
- message: { type: "string" },
14950
- warning_code: {
14951
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14952
- enum: ["functional_offline_device"],
14953
- type: "string"
14954
- }
14955
- },
14956
- required: ["message", "warning_code"],
14957
- type: "object"
14958
- },
14959
- {
14960
- description: "Third-party integration detected.",
14961
- properties: {
14962
- message: { type: "string" },
14963
- warning_code: {
14964
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14965
- enum: ["third_party_integration_detected"],
14966
- type: "string"
14967
- }
14968
- },
14969
- required: ["message", "warning_code"],
14970
- type: "object"
14971
- },
14972
- {
14973
- description: "Nest thermostat in manual eco mode.",
14974
- properties: {
14975
- message: { type: "string" },
14976
- warning_code: {
14977
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14978
- enum: ["nest_thermostat_in_manual_eco_mode"],
14979
- type: "string"
14980
- }
14981
- },
14982
- required: ["message", "warning_code"],
14983
- type: "object"
14984
- },
14985
- {
14986
- description: "Remote Unlock feature not enabled in settings.",
14987
- properties: {
14988
- message: { type: "string" },
14989
- warning_code: {
14990
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14991
- enum: ["ttlock_lock_gateway_unlocking_not_enabled"],
14992
- type: "string"
14993
- }
14994
- },
14995
- required: ["message", "warning_code"],
14996
- type: "object"
14997
- },
14998
- {
14999
- description: "Gateway signal is weak.",
15000
- properties: {
15001
- message: { type: "string" },
15002
- warning_code: {
15003
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15004
- enum: ["ttlock_weak_gateway_signal"],
15005
- type: "string"
15006
- }
15007
- },
15008
- required: ["message", "warning_code"],
15009
- type: "object"
15010
- },
15011
- {
15012
- description: "Temperature threshold exceeded.",
15013
- properties: {
15014
- message: { type: "string" },
15015
- warning_code: {
15016
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15017
- enum: ["temperature_threshold_exceeded"],
15018
- type: "string"
15019
- }
15020
- },
15021
- required: ["message", "warning_code"],
15022
- type: "object"
15023
- },
15024
- {
15025
- description: "Device appears to be unresponsive.",
15026
- properties: {
15027
- message: { type: "string" },
15028
- warning_code: {
15029
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15030
- enum: ["device_communication_degraded"],
15031
- type: "string"
15032
- }
15033
- },
15034
- required: ["message", "warning_code"],
15035
- type: "object"
15036
- },
15037
- {
15038
- description: "Scheduled maintenance window detected.",
15039
- properties: {
15040
- message: { type: "string" },
15041
- warning_code: {
15042
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15043
- enum: ["scheduled_maintenance_window"],
15044
- type: "string"
15045
- }
15046
- },
15047
- required: ["message", "warning_code"],
15048
- type: "object"
15049
- },
15050
- {
15051
- description: "Device has flaky connection.",
15052
- properties: {
15053
- message: { type: "string" },
15054
- warning_code: {
15055
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15056
- enum: ["device_has_flaky_connection"],
15057
- type: "string"
15058
- }
15059
- },
15060
- required: ["message", "warning_code"],
15061
- type: "object"
15062
- },
15063
- {
15064
- description: "Lock is in Office Mode. Access Codes will not unlock doors.",
15065
- properties: {
15066
- message: { type: "string" },
15067
- warning_code: {
15068
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15069
- enum: ["salto_office_mode"],
15070
- type: "string"
15071
- }
15072
- },
15073
- required: ["message", "warning_code"],
15074
- type: "object"
15075
- },
15076
- {
15077
- description: "Lock is in Privacy Mode. Access Codes will not unlock doors.",
15078
- properties: {
15079
- message: { type: "string" },
15080
- warning_code: {
15081
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15082
- enum: ["salto_privacy_mode"],
15083
- type: "string"
15084
- }
15085
- },
15086
- required: ["message", "warning_code"],
15087
- type: "object"
15088
- },
15089
- {
15090
- description: "An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone.",
15091
- properties: {
15092
- message: { type: "string" },
15093
- warning_code: {
15094
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15095
- enum: ["unknown_issue_with_phone"],
15096
- type: "string"
15097
- }
15098
- },
15099
- required: ["message", "warning_code"],
15100
- type: "object"
15101
- }
15102
- ]
15103
- },
15104
- type: "array"
15105
- },
15106
- workspace_id: {
15107
- description: "Unique identifier for the Seam workspace associated with the device.",
15108
- format: "uuid",
15109
- type: "string"
15110
- }
15111
- },
15112
- required: [
15113
- "device_id",
15114
- "device_type",
15115
- "display_name",
15116
- "capabilities_supported",
15117
- "properties",
15118
- "location",
15119
- "workspace_id",
15120
- "errors",
15121
- "warnings",
15122
- "created_at",
15123
- "is_managed",
15124
- "custom_metadata"
15125
- ],
15126
- type: "object",
15127
- "x-route-path": "/phones"
15128
- },
15129
- thermostat_schedule: {
15130
- 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.",
15131
- properties: {
15132
- climate_preset_key: {
15133
- description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
15134
- type: "string"
15135
- },
15136
- created_at: {
15137
- description: "Date and time at which the thermostat schedule was created.",
15138
- format: "date-time",
15139
- type: "string"
15140
- },
15141
- device_id: {
15142
- description: "ID of the desired thermostat device.",
15143
- format: "uuid",
15144
- type: "string"
15145
- },
15146
- ends_at: {
15147
- description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15148
- format: "date-time",
15149
- type: "string"
15150
- },
15151
- errors: {
15152
- description: "Array of errors associated with the thermostat schedule. 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.",
15153
- items: {
15154
- properties: {
15155
- error_code: { type: "string" },
15156
- message: { type: "string" }
15157
- },
15158
- required: ["error_code", "message"],
15159
- type: "object"
15160
- },
15161
- type: "array"
15162
- },
15163
- max_override_period_minutes: {
15164
- description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
15165
- minimum: 0,
15166
- type: "integer"
15167
- },
15168
- name: {
15169
- description: "User-friendly name to identify the thermostat schedule.",
15170
- type: "string"
15171
- },
15172
- starts_at: {
15173
- description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15174
- format: "date-time",
15175
- type: "string"
15176
- },
15177
- thermostat_schedule_id: {
15178
- description: "ID of the thermostat schedule.",
15179
- format: "uuid",
15180
- type: "string"
15181
- },
15182
- unstable_is_override_allowed: {
15183
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
15184
- type: "boolean",
15185
- "x-undocumented": "Unstable"
15186
- }
15187
- },
15188
- required: [
15189
- "thermostat_schedule_id",
15190
- "device_id",
15191
- "climate_preset_key",
15192
- "max_override_period_minutes",
15193
- "starts_at",
15194
- "ends_at",
15195
- "created_at",
15196
- "errors"
15197
- ],
15198
- type: "object",
15199
- "x-route-path": "/thermostats/schedules"
15200
- },
15201
- unmanaged_access_code: {
15202
- properties: {
15203
- access_code_id: {
15204
- description: "Unique identifier for the access code.",
15205
- format: "uuid",
15206
- type: "string"
15207
- },
15208
- code: {
15209
- description: "Code used for access. Typically, a numeric or alphanumeric string.",
15210
- nullable: true,
15211
- type: "string"
15212
- },
15213
- created_at: {
15214
- description: "Date and time at which the access code was created.",
15215
- format: "date-time",
15216
- type: "string"
15217
- },
15218
- device_id: {
15219
- description: "Unique identifier for the device associated with the access code.",
15220
- format: "uuid",
15221
- type: "string"
15222
- },
15223
- ends_at: {
15224
- description: "Date and time after which the time-bound access code becomes inactive.",
15225
- format: "date-time",
15226
- nullable: true,
15227
- type: "string"
15228
- },
15229
- errors: {
15230
- description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
15231
- items: {
15232
- discriminator: { propertyName: "error_code" },
15233
- oneOf: [
15234
- {
15235
- description: "Failed to set code on Smart Things device.",
15236
- properties: {
15237
- error_code: {
15238
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15239
- enum: ["smartthings_failed_to_set_access_code"],
15240
- type: "string"
15241
- },
15242
- is_access_code_error: { enum: [true], type: "boolean" },
15243
- message: { type: "string" }
15244
- },
15245
- required: ["message", "is_access_code_error", "error_code"],
15246
- type: "object"
15247
- },
15248
- {
15249
- description: "Failed to set code after multiple retries.",
15250
- properties: {
15251
- error_code: {
15252
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15253
- enum: [
15254
- "smartthings_failed_to_set_after_multiple_retries"
15255
- ],
15256
- type: "string"
15257
- },
15258
- is_access_code_error: { enum: [true], type: "boolean" },
15259
- message: { type: "string" }
15260
- },
15261
- required: ["message", "is_access_code_error", "error_code"],
15262
- type: "object"
15263
- },
15264
- {
15265
- description: "Failed to set code on device.",
15266
- properties: {
15267
- error_code: {
15268
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15269
- enum: ["failed_to_set_on_device"],
15270
- type: "string"
15271
- },
15272
- is_access_code_error: { enum: [true], type: "boolean" },
15273
- message: { type: "string" }
15274
- },
15275
- required: ["message", "is_access_code_error", "error_code"],
15276
- type: "object"
15277
- },
15278
- {
15279
- description: "Failed to remove code from device.",
15280
- properties: {
15281
- error_code: {
15282
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15283
- enum: ["failed_to_remove_from_device"],
14838
+ enum: ["failed_to_remove_from_device"],
15284
14839
  type: "string"
15285
14840
  },
15286
14841
  is_access_code_error: { enum: [true], type: "boolean" },
@@ -16679,7 +16234,11 @@ var openapi_default = {
16679
16234
  ],
16680
16235
  type: "string"
16681
16236
  },
16682
- { enum: ["ios_phone", "android_phone"], type: "string" }
16237
+ {
16238
+ description: "Type of phone.",
16239
+ enum: ["ios_phone", "android_phone"],
16240
+ type: "string"
16241
+ }
16683
16242
  ]
16684
16243
  },
16685
16244
  errors: {
@@ -22257,6 +21816,62 @@ var openapi_default = {
22257
21816
  "x-response-key": "action_attempts"
22258
21817
  }
22259
21818
  },
21819
+ "/bridges/get": {
21820
+ post: {
21821
+ operationId: "bridgesGetPost",
21822
+ requestBody: {
21823
+ content: {
21824
+ "application/json": {
21825
+ schema: {
21826
+ properties: { bridge_id: { format: "uuid", type: "string" } },
21827
+ required: ["bridge_id"],
21828
+ type: "object"
21829
+ }
21830
+ }
21831
+ }
21832
+ },
21833
+ responses: {
21834
+ 200: {
21835
+ content: {
21836
+ "application/json": {
21837
+ schema: {
21838
+ properties: {
21839
+ bridge: {
21840
+ properties: {
21841
+ bridge_id: { format: "uuid", type: "string" },
21842
+ created_at: { format: "date-time", type: "string" },
21843
+ workspace_id: { format: "uuid", type: "string" }
21844
+ },
21845
+ required: ["bridge_id", "workspace_id", "created_at"],
21846
+ type: "object",
21847
+ "x-route-path": "/bridges",
21848
+ "x-undocumented": "Unreleased."
21849
+ },
21850
+ ok: { type: "boolean" }
21851
+ },
21852
+ required: ["bridge", "ok"],
21853
+ type: "object"
21854
+ }
21855
+ }
21856
+ },
21857
+ description: "OK"
21858
+ },
21859
+ 400: { description: "Bad Request" },
21860
+ 401: { description: "Unauthorized" }
21861
+ },
21862
+ security: [
21863
+ { pat_with_workspace: [] },
21864
+ { console_session_with_workspace: [] },
21865
+ { api_key: [] }
21866
+ ],
21867
+ summary: "/bridges/get",
21868
+ tags: [],
21869
+ "x-fern-sdk-group-name": ["bridges"],
21870
+ "x-fern-sdk-method-name": "get",
21871
+ "x-fern-sdk-return-value": "bridge",
21872
+ "x-response-key": "bridge"
21873
+ }
21874
+ },
22260
21875
  "/client_sessions/create": {
22261
21876
  post: {
22262
21877
  operationId: "clientSessionsCreatePost",
@@ -23455,7 +23070,11 @@ var openapi_default = {
23455
23070
  ],
23456
23071
  type: "string"
23457
23072
  },
23458
- { enum: ["ios_phone", "android_phone"], type: "string" }
23073
+ {
23074
+ description: "Type of phone.",
23075
+ enum: ["ios_phone", "android_phone"],
23076
+ type: "string"
23077
+ }
23459
23078
  ]
23460
23079
  },
23461
23080
  device_types: {
@@ -23508,6 +23127,7 @@ var openapi_default = {
23508
23127
  type: "string"
23509
23128
  },
23510
23129
  {
23130
+ description: "Type of phone.",
23511
23131
  enum: ["ios_phone", "android_phone"],
23512
23132
  type: "string"
23513
23133
  }
@@ -23973,7 +23593,11 @@ var openapi_default = {
23973
23593
  ],
23974
23594
  type: "string"
23975
23595
  },
23976
- { enum: ["ios_phone", "android_phone"], type: "string" }
23596
+ {
23597
+ description: "Type of phone.",
23598
+ enum: ["ios_phone", "android_phone"],
23599
+ type: "string"
23600
+ }
23977
23601
  ]
23978
23602
  },
23979
23603
  device_types: {
@@ -24026,6 +23650,7 @@ var openapi_default = {
24026
23650
  type: "string"
24027
23651
  },
24028
23652
  {
23653
+ description: "Type of phone.",
24029
23654
  enum: ["ios_phone", "android_phone"],
24030
23655
  type: "string"
24031
23656
  }
@@ -24806,7 +24431,11 @@ var openapi_default = {
24806
24431
  ],
24807
24432
  type: "string"
24808
24433
  },
24809
- { enum: ["ios_phone", "android_phone"], type: "string" }
24434
+ {
24435
+ description: "Type of phone.",
24436
+ enum: ["ios_phone", "android_phone"],
24437
+ type: "string"
24438
+ }
24810
24439
  ]
24811
24440
  },
24812
24441
  device_types: {
@@ -24859,6 +24488,7 @@ var openapi_default = {
24859
24488
  type: "string"
24860
24489
  },
24861
24490
  {
24491
+ description: "Type of phone.",
24862
24492
  enum: ["ios_phone", "android_phone"],
24863
24493
  type: "string"
24864
24494
  }
@@ -25287,7 +24917,11 @@ var openapi_default = {
25287
24917
  ],
25288
24918
  type: "string"
25289
24919
  },
25290
- { enum: ["ios_phone", "android_phone"], type: "string" }
24920
+ {
24921
+ description: "Type of phone.",
24922
+ enum: ["ios_phone", "android_phone"],
24923
+ type: "string"
24924
+ }
25291
24925
  ]
25292
24926
  },
25293
24927
  device_types: {
@@ -25340,6 +24974,7 @@ var openapi_default = {
25340
24974
  type: "string"
25341
24975
  },
25342
24976
  {
24977
+ description: "Type of phone.",
25343
24978
  enum: ["ios_phone", "android_phone"],
25344
24979
  type: "string"
25345
24980
  }
@@ -26732,7 +26367,11 @@ var openapi_default = {
26732
26367
  ],
26733
26368
  type: "string"
26734
26369
  },
26735
- { enum: ["ios_phone", "android_phone"], type: "string" }
26370
+ {
26371
+ description: "Type of phone.",
26372
+ enum: ["ios_phone", "android_phone"],
26373
+ type: "string"
26374
+ }
26736
26375
  ]
26737
26376
  },
26738
26377
  device_types: {
@@ -26785,6 +26424,7 @@ var openapi_default = {
26785
26424
  type: "string"
26786
26425
  },
26787
26426
  {
26427
+ description: "Type of phone.",
26788
26428
  enum: ["ios_phone", "android_phone"],
26789
26429
  type: "string"
26790
26430
  }