@seamapi/types 1.422.0 → 1.423.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.
@@ -6,7 +6,13 @@ export interface Routes {
6
6
  jsonBody: {
7
7
  /** ID of the device for which you want to create the new access code. */
8
8
  device_id: string;
9
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
9
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10
+
11
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
12
+
13
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
14
+
15
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10
16
  name?: string | undefined;
11
17
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12
18
  starts_at?: string | undefined;
@@ -1865,7 +1871,13 @@ export interface Routes {
1865
1871
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
1866
1872
  /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
1867
1873
  preferred_code_length?: number | undefined;
1868
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
1874
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1875
+
1876
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
1877
+
1878
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
1879
+
1880
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
1869
1881
  name?: string | undefined;
1870
1882
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
1871
1883
  starts_at?: string | undefined;
@@ -8745,7 +8757,13 @@ export interface Routes {
8745
8757
  method: 'POST' | 'PATCH' | 'PUT';
8746
8758
  queryParams: {};
8747
8759
  jsonBody: {
8748
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
8760
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8761
+
8762
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
8763
+
8764
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
8765
+
8766
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
8749
8767
  name?: string | undefined;
8750
8768
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
8751
8769
  starts_at?: string | undefined;
@@ -10096,7 +10114,13 @@ export interface Routes {
10096
10114
  ends_at?: string | undefined;
10097
10115
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10098
10116
  starts_at?: string | undefined;
10099
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10117
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10118
+
10119
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
10120
+
10121
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
10122
+
10123
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
10100
10124
  name?: string | undefined;
10101
10125
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
10102
10126
  common_code_key: string;
@@ -23707,7 +23731,8 @@ export interface Routes {
23707
23731
  }> | undefined;
23708
23732
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
23709
23733
  fallback_climate_preset_key?: (string | null) | undefined;
23710
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23734
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
23735
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
23711
23736
  active_thermostat_schedule?: ({
23712
23737
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23713
23738
  thermostat_schedule_id: string;
@@ -23737,6 +23762,8 @@ export interface Routes {
23737
23762
  message: string;
23738
23763
  }>;
23739
23764
  } | null) | undefined;
23765
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23766
+ active_thermostat_schedule_id?: (string | null) | undefined;
23740
23767
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
23741
23768
  thermostat_daily_programs?: (Array<{
23742
23769
  /** ID of the thermostat daily program. */
@@ -24859,7 +24886,8 @@ export interface Routes {
24859
24886
  }> | undefined;
24860
24887
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
24861
24888
  fallback_climate_preset_key?: (string | null) | undefined;
24862
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
24889
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
24890
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
24863
24891
  active_thermostat_schedule?: ({
24864
24892
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
24865
24893
  thermostat_schedule_id: string;
@@ -24889,6 +24917,8 @@ export interface Routes {
24889
24917
  message: string;
24890
24918
  }>;
24891
24919
  } | null) | undefined;
24920
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
24921
+ active_thermostat_schedule_id?: (string | null) | undefined;
24892
24922
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
24893
24923
  thermostat_daily_programs?: (Array<{
24894
24924
  /** ID of the thermostat daily program. */
@@ -29772,7 +29802,8 @@ export interface Routes {
29772
29802
  }> | undefined;
29773
29803
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
29774
29804
  fallback_climate_preset_key?: (string | null) | undefined;
29775
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
29805
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
29806
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
29776
29807
  active_thermostat_schedule?: ({
29777
29808
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
29778
29809
  thermostat_schedule_id: string;
@@ -29802,6 +29833,8 @@ export interface Routes {
29802
29833
  message: string;
29803
29834
  }>;
29804
29835
  } | null) | undefined;
29836
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
29837
+ active_thermostat_schedule_id?: (string | null) | undefined;
29805
29838
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
29806
29839
  thermostat_daily_programs?: (Array<{
29807
29840
  /** ID of the thermostat daily program. */
@@ -30880,7 +30913,8 @@ export interface Routes {
30880
30913
  }> | undefined;
30881
30914
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
30882
30915
  fallback_climate_preset_key?: (string | null) | undefined;
30883
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
30916
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
30917
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
30884
30918
  active_thermostat_schedule?: ({
30885
30919
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
30886
30920
  thermostat_schedule_id: string;
@@ -30910,6 +30944,8 @@ export interface Routes {
30910
30944
  message: string;
30911
30945
  }>;
30912
30946
  } | null) | undefined;
30947
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
30948
+ active_thermostat_schedule_id?: (string | null) | undefined;
30913
30949
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
30914
30950
  thermostat_daily_programs?: (Array<{
30915
30951
  /** ID of the thermostat daily program. */
@@ -32032,7 +32068,8 @@ export interface Routes {
32032
32068
  }> | undefined;
32033
32069
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
32034
32070
  fallback_climate_preset_key?: (string | null) | undefined;
32035
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
32071
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
32072
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
32036
32073
  active_thermostat_schedule?: ({
32037
32074
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
32038
32075
  thermostat_schedule_id: string;
@@ -32062,6 +32099,8 @@ export interface Routes {
32062
32099
  message: string;
32063
32100
  }>;
32064
32101
  } | null) | undefined;
32102
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
32103
+ active_thermostat_schedule_id?: (string | null) | undefined;
32065
32104
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
32066
32105
  thermostat_daily_programs?: (Array<{
32067
32106
  /** ID of the thermostat daily program. */
@@ -33139,7 +33178,8 @@ export interface Routes {
33139
33178
  }> | undefined;
33140
33179
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
33141
33180
  fallback_climate_preset_key?: (string | null) | undefined;
33142
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
33181
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
33182
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
33143
33183
  active_thermostat_schedule?: ({
33144
33184
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
33145
33185
  thermostat_schedule_id: string;
@@ -33169,6 +33209,8 @@ export interface Routes {
33169
33209
  message: string;
33170
33210
  }>;
33171
33211
  } | null) | undefined;
33212
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
33213
+ active_thermostat_schedule_id?: (string | null) | undefined;
33172
33214
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
33173
33215
  thermostat_daily_programs?: (Array<{
33174
33216
  /** ID of the thermostat daily program. */
@@ -39584,7 +39626,8 @@ export interface Routes {
39584
39626
  }> | undefined;
39585
39627
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
39586
39628
  fallback_climate_preset_key?: (string | null) | undefined;
39587
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
39629
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
39630
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
39588
39631
  active_thermostat_schedule?: ({
39589
39632
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
39590
39633
  thermostat_schedule_id: string;
@@ -39614,6 +39657,8 @@ export interface Routes {
39614
39657
  message: string;
39615
39658
  }>;
39616
39659
  } | null) | undefined;
39660
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
39661
+ active_thermostat_schedule_id?: (string | null) | undefined;
39617
39662
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
39618
39663
  thermostat_daily_programs?: (Array<{
39619
39664
  /** ID of the thermostat daily program. */
@@ -40691,7 +40736,8 @@ export interface Routes {
40691
40736
  }> | undefined;
40692
40737
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
40693
40738
  fallback_climate_preset_key?: (string | null) | undefined;
40694
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
40739
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
40740
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
40695
40741
  active_thermostat_schedule?: ({
40696
40742
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
40697
40743
  thermostat_schedule_id: string;
@@ -40721,6 +40767,8 @@ export interface Routes {
40721
40767
  message: string;
40722
40768
  }>;
40723
40769
  } | null) | undefined;
40770
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
40771
+ active_thermostat_schedule_id?: (string | null) | undefined;
40724
40772
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
40725
40773
  thermostat_daily_programs?: (Array<{
40726
40774
  /** ID of the thermostat daily program. */
@@ -51167,7 +51215,8 @@ export interface Routes {
51167
51215
  }> | undefined;
51168
51216
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
51169
51217
  fallback_climate_preset_key?: (string | null) | undefined;
51170
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
51218
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
51219
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
51171
51220
  active_thermostat_schedule?: ({
51172
51221
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
51173
51222
  thermostat_schedule_id: string;
@@ -51197,6 +51246,8 @@ export interface Routes {
51197
51246
  message: string;
51198
51247
  }>;
51199
51248
  } | null) | undefined;
51249
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
51250
+ active_thermostat_schedule_id?: (string | null) | undefined;
51200
51251
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
51201
51252
  thermostat_daily_programs?: (Array<{
51202
51253
  /** ID of the thermostat daily program. */
@@ -54961,7 +55012,8 @@ export interface Routes {
54961
55012
  }> | undefined;
54962
55013
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
54963
55014
  fallback_climate_preset_key?: (string | null) | undefined;
54964
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
55015
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
55016
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
54965
55017
  active_thermostat_schedule?: ({
54966
55018
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
54967
55019
  thermostat_schedule_id: string;
@@ -54991,6 +55043,8 @@ export interface Routes {
54991
55043
  message: string;
54992
55044
  }>;
54993
55045
  } | null) | undefined;
55046
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
55047
+ active_thermostat_schedule_id?: (string | null) | undefined;
54994
55048
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
54995
55049
  thermostat_daily_programs?: (Array<{
54996
55050
  /** ID of the thermostat daily program. */
@@ -56068,7 +56122,8 @@ export interface Routes {
56068
56122
  }> | undefined;
56069
56123
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
56070
56124
  fallback_climate_preset_key?: (string | null) | undefined;
56071
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
56125
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
56126
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
56072
56127
  active_thermostat_schedule?: ({
56073
56128
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
56074
56129
  thermostat_schedule_id: string;
@@ -56098,6 +56153,8 @@ export interface Routes {
56098
56153
  message: string;
56099
56154
  }>;
56100
56155
  } | null) | undefined;
56156
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
56157
+ active_thermostat_schedule_id?: (string | null) | undefined;
56101
56158
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
56102
56159
  thermostat_daily_programs?: (Array<{
56103
56160
  /** ID of the thermostat daily program. */
@@ -63753,7 +63810,8 @@ export interface Routes {
63753
63810
  }> | undefined;
63754
63811
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
63755
63812
  fallback_climate_preset_key?: (string | null) | undefined;
63756
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
63813
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
63814
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
63757
63815
  active_thermostat_schedule?: ({
63758
63816
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
63759
63817
  thermostat_schedule_id: string;
@@ -63783,6 +63841,8 @@ export interface Routes {
63783
63841
  message: string;
63784
63842
  }>;
63785
63843
  } | null) | undefined;
63844
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
63845
+ active_thermostat_schedule_id?: (string | null) | undefined;
63786
63846
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
63787
63847
  thermostat_daily_programs?: (Array<{
63788
63848
  /** ID of the thermostat daily program. */
@@ -64862,7 +64922,8 @@ export interface Routes {
64862
64922
  }> | undefined;
64863
64923
  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
64864
64924
  fallback_climate_preset_key?: (string | null) | undefined;
64865
- /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
64925
+ /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
64926
+ * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
64866
64927
  active_thermostat_schedule?: ({
64867
64928
  /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
64868
64929
  thermostat_schedule_id: string;
@@ -64892,6 +64953,8 @@ export interface Routes {
64892
64953
  message: string;
64893
64954
  }>;
64894
64955
  } | null) | undefined;
64956
+ /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
64957
+ active_thermostat_schedule_id?: (string | null) | undefined;
64895
64958
  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
64896
64959
  thermostat_daily_programs?: (Array<{
64897
64960
  /** ID of the thermostat daily program. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.422.0",
3
+ "version": "1.423.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.24.0"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.50.1",
95
+ "@seamapi/blueprint": "^0.50.2",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -98,20 +98,25 @@ export const thermostat_capability_properties = z
98
98
  ---
99
99
  Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
100
100
  `),
101
- fallback_climate_preset_key: z.string().min(1).nullable().default(null)
102
- .describe(`
101
+ fallback_climate_preset_key: z.string().min(1).nullable().describe(`
103
102
  ---
104
103
  property_group_key: thermostats
105
104
  ---
106
105
  Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
107
106
  `),
108
- active_thermostat_schedule: thermostat_schedule.nullable().default(null)
109
- .describe(`
107
+ active_thermostat_schedule: thermostat_schedule.nullable().describe(`
110
108
  ---
111
109
  property_group_key: thermostats
110
+ deprecated: Use \`active_thermostat_schedule_id\` with \`/thermostats/schedules/get\` instead.
112
111
  ---
113
112
  Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
114
113
  `),
114
+ active_thermostat_schedule_id: z.string().uuid().nullable().describe(`
115
+ ---
116
+ property_group_key: thermostats
117
+ ---
118
+ ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
119
+ `),
115
120
  thermostat_daily_programs: z.array(thermostat_daily_program).optional()
116
121
  .describe(`
117
122
  ---
@@ -11538,7 +11538,7 @@ export default {
11538
11538
  {
11539
11539
  properties: {
11540
11540
  active_thermostat_schedule: {
11541
- default: null,
11541
+ deprecated: true,
11542
11542
  description:
11543
11543
  'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11544
11544
  nullable: true,
@@ -11637,9 +11637,19 @@ export default {
11637
11637
  'errors',
11638
11638
  ],
11639
11639
  type: 'object',
11640
+ 'x-deprecated':
11641
+ 'Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.',
11640
11642
  'x-property-group-key': 'thermostats',
11641
11643
  'x-route-path': '/thermostats/schedules',
11642
11644
  },
11645
+ active_thermostat_schedule_id: {
11646
+ description:
11647
+ 'ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11648
+ format: 'uuid',
11649
+ nullable: true,
11650
+ type: 'string',
11651
+ 'x-property-group-key': 'thermostats',
11652
+ },
11643
11653
  available_climate_presets: {
11644
11654
  description:
11645
11655
  'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
@@ -11924,7 +11934,6 @@ export default {
11924
11934
  'x-property-group-key': 'thermostats',
11925
11935
  },
11926
11936
  fallback_climate_preset_key: {
11927
- default: null,
11928
11937
  description:
11929
11938
  'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.',
11930
11939
  minLength: 1,
@@ -24081,7 +24090,7 @@ export default {
24081
24090
  },
24082
24091
  name: {
24083
24092
  description:
24084
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24093
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24085
24094
  type: 'string',
24086
24095
  },
24087
24096
  prefer_native_scheduling: {
@@ -24225,7 +24234,7 @@ export default {
24225
24234
  },
24226
24235
  name: {
24227
24236
  description:
24228
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24237
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24229
24238
  type: 'string',
24230
24239
  },
24231
24240
  prefer_native_scheduling: {
@@ -24360,7 +24369,7 @@ export default {
24360
24369
  },
24361
24370
  name: {
24362
24371
  description:
24363
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24372
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24364
24373
  type: 'string',
24365
24374
  },
24366
24375
  prefer_native_scheduling: {
@@ -25967,7 +25976,7 @@ export default {
25967
25976
  },
25968
25977
  name: {
25969
25978
  description:
25970
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
25979
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
25971
25980
  type: 'string',
25972
25981
  },
25973
25982
  prefer_native_scheduling: {
@@ -26117,7 +26126,7 @@ export default {
26117
26126
  },
26118
26127
  name: {
26119
26128
  description:
26120
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26129
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26121
26130
  type: 'string',
26122
26131
  },
26123
26132
  prefer_native_scheduling: {
@@ -26267,7 +26276,7 @@ export default {
26267
26276
  },
26268
26277
  name: {
26269
26278
  description:
26270
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26279
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26271
26280
  type: 'string',
26272
26281
  },
26273
26282
  prefer_native_scheduling: {
@@ -26369,7 +26378,7 @@ export default {
26369
26378
  },
26370
26379
  name: {
26371
26380
  description:
26372
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26381
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26373
26382
  type: 'string',
26374
26383
  },
26375
26384
  starts_at: {
@@ -26434,7 +26443,7 @@ export default {
26434
26443
  },
26435
26444
  name: {
26436
26445
  description:
26437
- "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26446
+ "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
26438
26447
  type: 'string',
26439
26448
  },
26440
26449
  starts_at: {