@seamapi/types 1.465.0 → 1.466.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -70992,8 +70992,7 @@ export type Routes = {
70992
70992
  };
70993
70993
  formData: {};
70994
70994
  jsonResponse: {
70995
- /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
70996
- * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
70995
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
70997
70996
  enrollment_automation: {
70998
70997
  /** ID of the enrollment automation. */
70999
70998
  enrollment_automation_id: string;
@@ -71027,8 +71026,7 @@ export type Routes = {
71027
71026
  };
71028
71027
  formData: {};
71029
71028
  jsonResponse: {
71030
- /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
71031
- * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
71029
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
71032
71030
  enrollment_automation: {
71033
71031
  /** ID of the enrollment automation. */
71034
71032
  enrollment_automation_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.465.0",
3
+ "version": "1.466.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -44,7 +44,7 @@ export const enrollment_automation = z.object({
44
44
  }).describe(`
45
45
  ---
46
46
  route_path: /user_identities/enrollment_automations
47
- deprecated: Will be removed. Instead, link the \`user_identity\` to the \`acs_user\` in the access system in which you want to issue credentials.
47
+ undocumented: Will be removed.
48
48
  ---
49
49
  Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
50
50
  `)
@@ -129,6 +129,7 @@ export const thermostat_capability_properties = z
129
129
  .describe(`
130
130
  ---
131
131
  property_group_key: thermostats
132
+ undocumented: Unreleased.
132
133
  ---
133
134
  Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
134
135
  `),
@@ -136,6 +137,7 @@ export const thermostat_capability_properties = z
136
137
  .describe(`
137
138
  ---
138
139
  property_group_key: thermostats
140
+ undocumented: Unreleased.
139
141
  ---
140
142
  Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
141
143
  `),
@@ -51,6 +51,7 @@ export const thermostat_daily_program = z.object({
51
51
  }).describe(`
52
52
  ---
53
53
  route_path: /thermostats/daily_programs
54
+ undocumented: Unreleased.
54
55
  ---
55
56
  Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
56
57
  `)
@@ -12356,9 +12356,11 @@ export default {
12356
12356
  ],
12357
12357
  type: 'object',
12358
12358
  'x-route-path': '/thermostats/daily_programs',
12359
+ 'x-undocumented': 'Unreleased.',
12359
12360
  },
12360
12361
  type: 'array',
12361
12362
  'x-property-group-key': 'thermostats',
12363
+ 'x-undocumented': 'Unreleased.',
12362
12364
  },
12363
12365
  thermostat_weekly_program: {
12364
12366
  description:
@@ -12433,6 +12435,7 @@ export default {
12433
12435
  ],
12434
12436
  type: 'object',
12435
12437
  'x-property-group-key': 'thermostats',
12438
+ 'x-undocumented': 'Unreleased.',
12436
12439
  },
12437
12440
  },
12438
12441
  type: 'object',
@@ -13030,7 +13033,6 @@ export default {
13030
13033
  'x-route-path': '/devices',
13031
13034
  },
13032
13035
  enrollment_automation: {
13033
- deprecated: true,
13034
13036
  description:
13035
13037
  'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).',
13036
13038
  properties: {
@@ -13072,9 +13074,8 @@ export default {
13072
13074
  'workspace_id',
13073
13075
  ],
13074
13076
  type: 'object',
13075
- 'x-deprecated':
13076
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
13077
13077
  'x-route-path': '/user_identities/enrollment_automations',
13078
+ 'x-undocumented': 'Will be removed.',
13078
13079
  },
13079
13080
  event: {
13080
13081
  description:
@@ -20500,6 +20501,7 @@ export default {
20500
20501
  ],
20501
20502
  type: 'object',
20502
20503
  'x-route-path': '/thermostats/daily_programs',
20504
+ 'x-undocumented': 'Unreleased.',
20503
20505
  },
20504
20506
  thermostat_schedule: {
20505
20507
  description:
@@ -49646,6 +49648,7 @@ export default {
49646
49648
  'x-fern-sdk-return-value': 'thermostat_daily_program',
49647
49649
  'x-response-key': 'thermostat_daily_program',
49648
49650
  'x-title': 'Create a Thermostat Daily Program',
49651
+ 'x-undocumented': 'Unreleased.',
49649
49652
  },
49650
49653
  },
49651
49654
  '/thermostats/daily_programs/delete': {
@@ -49693,6 +49696,7 @@ export default {
49693
49696
  'x-fern-sdk-method-name': 'delete',
49694
49697
  'x-response-key': null,
49695
49698
  'x-title': 'Delete a Thermostat Daily Program',
49699
+ 'x-undocumented': 'Unreleased.',
49696
49700
  },
49697
49701
  post: {
49698
49702
  description: 'Deletes a thermostat daily program.',
@@ -49743,6 +49747,7 @@ export default {
49743
49747
  'x-fern-sdk-method-name': 'delete',
49744
49748
  'x-response-key': null,
49745
49749
  'x-title': 'Delete a Thermostat Daily Program',
49750
+ 'x-undocumented': 'Unreleased.',
49746
49751
  },
49747
49752
  },
49748
49753
  '/thermostats/daily_programs/update': {
@@ -49832,6 +49837,7 @@ export default {
49832
49837
  'x-fern-sdk-return-value': 'action_attempt',
49833
49838
  'x-response-key': 'action_attempt',
49834
49839
  'x-title': 'Update a Thermostat Daily Program',
49840
+ 'x-undocumented': 'Unreleased.',
49835
49841
  },
49836
49842
  post: {
49837
49843
  description:
@@ -49919,6 +49925,7 @@ export default {
49919
49925
  'x-fern-sdk-return-value': 'action_attempt',
49920
49926
  'x-response-key': 'action_attempt',
49921
49927
  'x-title': 'Update a Thermostat Daily Program',
49928
+ 'x-undocumented': 'Unreleased.',
49922
49929
  },
49923
49930
  },
49924
49931
  '/thermostats/delete_climate_preset': {
@@ -52603,6 +52610,7 @@ export default {
52603
52610
  'x-fern-sdk-return-value': 'action_attempt',
52604
52611
  'x-response-key': 'action_attempt',
52605
52612
  'x-title': 'Update the Thermostat Weekly Program',
52613
+ 'x-undocumented': 'Unreleased.',
52606
52614
  },
52607
52615
  },
52608
52616
  '/unstable_access_grants/create': {
@@ -55143,12 +55151,11 @@ export default {
55143
55151
  ],
55144
55152
  summary: '/user_identities/enrollment_automations/delete',
55145
55153
  tags: ['/user_identities'],
55146
- 'x-deprecated':
55147
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55148
55154
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55149
55155
  'x-fern-sdk-method-name': 'delete',
55150
55156
  'x-response-key': null,
55151
55157
  'x-title': 'Delete an Enrollment Automation',
55158
+ 'x-undocumented': 'Will be removed.',
55152
55159
  },
55153
55160
  post: {
55154
55161
  description:
@@ -55195,12 +55202,11 @@ export default {
55195
55202
  ],
55196
55203
  summary: '/user_identities/enrollment_automations/delete',
55197
55204
  tags: ['/user_identities'],
55198
- 'x-deprecated':
55199
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55200
55205
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55201
55206
  'x-fern-sdk-method-name': 'delete',
55202
55207
  'x-response-key': null,
55203
55208
  'x-title': 'Delete an Enrollment Automation',
55209
+ 'x-undocumented': 'Will be removed.',
55204
55210
  },
55205
55211
  },
55206
55212
  '/user_identities/enrollment_automations/get': {
@@ -55250,13 +55256,12 @@ export default {
55250
55256
  ],
55251
55257
  summary: '/user_identities/enrollment_automations/get',
55252
55258
  tags: ['/user_identities'],
55253
- 'x-deprecated':
55254
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55255
55259
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55256
55260
  'x-fern-sdk-method-name': 'get',
55257
55261
  'x-fern-sdk-return-value': 'enrollment_automation',
55258
55262
  'x-response-key': 'enrollment_automation',
55259
55263
  'x-title': 'Get an Enrollment Automation',
55264
+ 'x-undocumented': 'Will be removed.',
55260
55265
  },
55261
55266
  post: {
55262
55267
  description:
@@ -55309,13 +55314,12 @@ export default {
55309
55314
  ],
55310
55315
  summary: '/user_identities/enrollment_automations/get',
55311
55316
  tags: ['/user_identities'],
55312
- 'x-deprecated':
55313
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55314
55317
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55315
55318
  'x-fern-sdk-method-name': 'get',
55316
55319
  'x-fern-sdk-return-value': 'enrollment_automation',
55317
55320
  'x-response-key': 'enrollment_automation',
55318
55321
  'x-title': 'Get an Enrollment Automation',
55322
+ 'x-undocumented': 'Will be removed.',
55319
55323
  },
55320
55324
  },
55321
55325
  '/user_identities/enrollment_automations/launch': {
@@ -55395,13 +55399,12 @@ export default {
55395
55399
  ],
55396
55400
  summary: '/user_identities/enrollment_automations/launch',
55397
55401
  tags: ['/user_identities'],
55398
- 'x-deprecated':
55399
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55400
55402
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55401
55403
  'x-fern-sdk-method-name': 'launch',
55402
55404
  'x-fern-sdk-return-value': 'enrollment_automation',
55403
55405
  'x-response-key': 'enrollment_automation',
55404
55406
  'x-title': 'Launch an Enrollment Automation',
55407
+ 'x-undocumented': 'Will be removed.',
55405
55408
  },
55406
55409
  },
55407
55410
  '/user_identities/enrollment_automations/list': {
@@ -55454,13 +55457,12 @@ export default {
55454
55457
  ],
55455
55458
  summary: '/user_identities/enrollment_automations/list',
55456
55459
  tags: ['/user_identities'],
55457
- 'x-deprecated':
55458
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55459
55460
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55460
55461
  'x-fern-sdk-method-name': 'list',
55461
55462
  'x-fern-sdk-return-value': 'enrollment_automations',
55462
55463
  'x-response-key': 'enrollment_automations',
55463
55464
  'x-title': 'List Enrollment Automations',
55465
+ 'x-undocumented': 'Will be removed.',
55464
55466
  },
55465
55467
  post: {
55466
55468
  description:
@@ -55516,13 +55518,12 @@ export default {
55516
55518
  ],
55517
55519
  summary: '/user_identities/enrollment_automations/list',
55518
55520
  tags: ['/user_identities'],
55519
- 'x-deprecated':
55520
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55521
55521
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55522
55522
  'x-fern-sdk-method-name': 'list',
55523
55523
  'x-fern-sdk-return-value': 'enrollment_automations',
55524
55524
  'x-response-key': 'enrollment_automations',
55525
55525
  'x-title': 'List Enrollment Automations',
55526
+ 'x-undocumented': 'Will be removed.',
55526
55527
  },
55527
55528
  },
55528
55529
  '/user_identities/generate_instant_key': {
@@ -83841,8 +83841,7 @@ export type Routes = {
83841
83841
  }
83842
83842
  formData: {}
83843
83843
  jsonResponse: {
83844
- /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
83845
- * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
83844
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
83846
83845
  enrollment_automation: {
83847
83846
  /** ID of the enrollment automation. */
83848
83847
  enrollment_automation_id: string
@@ -83876,8 +83875,7 @@ export type Routes = {
83876
83875
  }
83877
83876
  formData: {}
83878
83877
  jsonResponse: {
83879
- /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
83880
- * @deprecated Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.*/
83878
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/). */
83881
83879
  enrollment_automation: {
83882
83880
  /** ID of the enrollment automation. */
83883
83881
  enrollment_automation_id: string