@seamapi/types 1.464.5 → 1.466.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.
@@ -35301,6 +35301,18 @@ export type Routes = {
35301
35301
  })[];
35302
35302
  };
35303
35303
  };
35304
+ '/instant_keys/delete': {
35305
+ route: '/instant_keys/delete';
35306
+ method: 'DELETE' | 'POST';
35307
+ queryParams: {};
35308
+ jsonBody: {};
35309
+ commonParams: {
35310
+ /** ID of the Instant Key that you want to delete. */
35311
+ instant_key_id: string;
35312
+ };
35313
+ formData: {};
35314
+ jsonResponse: {};
35315
+ };
35304
35316
  '/instant_keys/get': {
35305
35317
  route: '/instant_keys/get';
35306
35318
  method: 'GET' | 'POST';
@@ -70980,8 +70992,7 @@ export type Routes = {
70980
70992
  };
70981
70993
  formData: {};
70982
70994
  jsonResponse: {
70983
- /** 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/).
70984
- * @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/). */
70985
70996
  enrollment_automation: {
70986
70997
  /** ID of the enrollment automation. */
70987
70998
  enrollment_automation_id: string;
@@ -71015,8 +71026,7 @@ export type Routes = {
71015
71026
  };
71016
71027
  formData: {};
71017
71028
  jsonResponse: {
71018
- /** 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/).
71019
- * @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/). */
71020
71030
  enrollment_automation: {
71021
71031
  /** ID of the enrollment automation. */
71022
71032
  enrollment_automation_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.464.5",
3
+ "version": "1.466.0",
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:
@@ -42911,6 +42913,102 @@ export default {
42911
42913
  'x-title': 'List Events',
42912
42914
  },
42913
42915
  },
42916
+ '/instant_keys/delete': {
42917
+ delete: {
42918
+ description:
42919
+ 'Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).',
42920
+ operationId: 'instantKeysDeleteDelete',
42921
+ parameters: [
42922
+ {
42923
+ in: 'query',
42924
+ name: 'instant_key_id',
42925
+ required: true,
42926
+ schema: {
42927
+ description: 'ID of the Instant Key that you want to delete.',
42928
+ format: 'uuid',
42929
+ type: 'string',
42930
+ },
42931
+ },
42932
+ ],
42933
+ responses: {
42934
+ 200: {
42935
+ content: {
42936
+ 'application/json': {
42937
+ schema: {
42938
+ properties: { ok: { type: 'boolean' } },
42939
+ required: ['ok'],
42940
+ type: 'object',
42941
+ },
42942
+ },
42943
+ },
42944
+ description: 'OK',
42945
+ },
42946
+ 400: { description: 'Bad Request' },
42947
+ 401: { description: 'Unauthorized' },
42948
+ },
42949
+ security: [
42950
+ { api_key: [] },
42951
+ { pat_with_workspace: [] },
42952
+ { console_session_with_workspace: [] },
42953
+ ],
42954
+ summary: '/instant_keys/delete',
42955
+ tags: [],
42956
+ 'x-fern-sdk-group-name': ['instant_keys'],
42957
+ 'x-fern-sdk-method-name': 'delete',
42958
+ 'x-response-key': null,
42959
+ 'x-title': 'Delete an Instant Key',
42960
+ },
42961
+ post: {
42962
+ description:
42963
+ 'Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).',
42964
+ operationId: 'instantKeysDeletePost',
42965
+ requestBody: {
42966
+ content: {
42967
+ 'application/json': {
42968
+ schema: {
42969
+ properties: {
42970
+ instant_key_id: {
42971
+ description:
42972
+ 'ID of the Instant Key that you want to delete.',
42973
+ format: 'uuid',
42974
+ type: 'string',
42975
+ },
42976
+ },
42977
+ required: ['instant_key_id'],
42978
+ type: 'object',
42979
+ },
42980
+ },
42981
+ },
42982
+ },
42983
+ responses: {
42984
+ 200: {
42985
+ content: {
42986
+ 'application/json': {
42987
+ schema: {
42988
+ properties: { ok: { type: 'boolean' } },
42989
+ required: ['ok'],
42990
+ type: 'object',
42991
+ },
42992
+ },
42993
+ },
42994
+ description: 'OK',
42995
+ },
42996
+ 400: { description: 'Bad Request' },
42997
+ 401: { description: 'Unauthorized' },
42998
+ },
42999
+ security: [
43000
+ { api_key: [] },
43001
+ { pat_with_workspace: [] },
43002
+ { console_session_with_workspace: [] },
43003
+ ],
43004
+ summary: '/instant_keys/delete',
43005
+ tags: [],
43006
+ 'x-fern-sdk-group-name': ['instant_keys'],
43007
+ 'x-fern-sdk-method-name': 'delete',
43008
+ 'x-response-key': null,
43009
+ 'x-title': 'Delete an Instant Key',
43010
+ },
43011
+ },
42914
43012
  '/instant_keys/get': {
42915
43013
  get: {
42916
43014
  description:
@@ -49550,6 +49648,7 @@ export default {
49550
49648
  'x-fern-sdk-return-value': 'thermostat_daily_program',
49551
49649
  'x-response-key': 'thermostat_daily_program',
49552
49650
  'x-title': 'Create a Thermostat Daily Program',
49651
+ 'x-undocumented': 'Unreleased.',
49553
49652
  },
49554
49653
  },
49555
49654
  '/thermostats/daily_programs/delete': {
@@ -49597,6 +49696,7 @@ export default {
49597
49696
  'x-fern-sdk-method-name': 'delete',
49598
49697
  'x-response-key': null,
49599
49698
  'x-title': 'Delete a Thermostat Daily Program',
49699
+ 'x-undocumented': 'Unreleased.',
49600
49700
  },
49601
49701
  post: {
49602
49702
  description: 'Deletes a thermostat daily program.',
@@ -49647,6 +49747,7 @@ export default {
49647
49747
  'x-fern-sdk-method-name': 'delete',
49648
49748
  'x-response-key': null,
49649
49749
  'x-title': 'Delete a Thermostat Daily Program',
49750
+ 'x-undocumented': 'Unreleased.',
49650
49751
  },
49651
49752
  },
49652
49753
  '/thermostats/daily_programs/update': {
@@ -49736,6 +49837,7 @@ export default {
49736
49837
  'x-fern-sdk-return-value': 'action_attempt',
49737
49838
  'x-response-key': 'action_attempt',
49738
49839
  'x-title': 'Update a Thermostat Daily Program',
49840
+ 'x-undocumented': 'Unreleased.',
49739
49841
  },
49740
49842
  post: {
49741
49843
  description:
@@ -49823,6 +49925,7 @@ export default {
49823
49925
  'x-fern-sdk-return-value': 'action_attempt',
49824
49926
  'x-response-key': 'action_attempt',
49825
49927
  'x-title': 'Update a Thermostat Daily Program',
49928
+ 'x-undocumented': 'Unreleased.',
49826
49929
  },
49827
49930
  },
49828
49931
  '/thermostats/delete_climate_preset': {
@@ -52507,6 +52610,7 @@ export default {
52507
52610
  'x-fern-sdk-return-value': 'action_attempt',
52508
52611
  'x-response-key': 'action_attempt',
52509
52612
  'x-title': 'Update the Thermostat Weekly Program',
52613
+ 'x-undocumented': 'Unreleased.',
52510
52614
  },
52511
52615
  },
52512
52616
  '/unstable_access_grants/create': {
@@ -55047,12 +55151,11 @@ export default {
55047
55151
  ],
55048
55152
  summary: '/user_identities/enrollment_automations/delete',
55049
55153
  tags: ['/user_identities'],
55050
- 'x-deprecated':
55051
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55052
55154
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55053
55155
  'x-fern-sdk-method-name': 'delete',
55054
55156
  'x-response-key': null,
55055
55157
  'x-title': 'Delete an Enrollment Automation',
55158
+ 'x-undocumented': 'Will be removed.',
55056
55159
  },
55057
55160
  post: {
55058
55161
  description:
@@ -55099,12 +55202,11 @@ export default {
55099
55202
  ],
55100
55203
  summary: '/user_identities/enrollment_automations/delete',
55101
55204
  tags: ['/user_identities'],
55102
- 'x-deprecated':
55103
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55104
55205
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55105
55206
  'x-fern-sdk-method-name': 'delete',
55106
55207
  'x-response-key': null,
55107
55208
  'x-title': 'Delete an Enrollment Automation',
55209
+ 'x-undocumented': 'Will be removed.',
55108
55210
  },
55109
55211
  },
55110
55212
  '/user_identities/enrollment_automations/get': {
@@ -55154,13 +55256,12 @@ export default {
55154
55256
  ],
55155
55257
  summary: '/user_identities/enrollment_automations/get',
55156
55258
  tags: ['/user_identities'],
55157
- 'x-deprecated':
55158
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55159
55259
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55160
55260
  'x-fern-sdk-method-name': 'get',
55161
55261
  'x-fern-sdk-return-value': 'enrollment_automation',
55162
55262
  'x-response-key': 'enrollment_automation',
55163
55263
  'x-title': 'Get an Enrollment Automation',
55264
+ 'x-undocumented': 'Will be removed.',
55164
55265
  },
55165
55266
  post: {
55166
55267
  description:
@@ -55213,13 +55314,12 @@ export default {
55213
55314
  ],
55214
55315
  summary: '/user_identities/enrollment_automations/get',
55215
55316
  tags: ['/user_identities'],
55216
- 'x-deprecated':
55217
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55218
55317
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55219
55318
  'x-fern-sdk-method-name': 'get',
55220
55319
  'x-fern-sdk-return-value': 'enrollment_automation',
55221
55320
  'x-response-key': 'enrollment_automation',
55222
55321
  'x-title': 'Get an Enrollment Automation',
55322
+ 'x-undocumented': 'Will be removed.',
55223
55323
  },
55224
55324
  },
55225
55325
  '/user_identities/enrollment_automations/launch': {
@@ -55299,13 +55399,12 @@ export default {
55299
55399
  ],
55300
55400
  summary: '/user_identities/enrollment_automations/launch',
55301
55401
  tags: ['/user_identities'],
55302
- 'x-deprecated':
55303
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55304
55402
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55305
55403
  'x-fern-sdk-method-name': 'launch',
55306
55404
  'x-fern-sdk-return-value': 'enrollment_automation',
55307
55405
  'x-response-key': 'enrollment_automation',
55308
55406
  'x-title': 'Launch an Enrollment Automation',
55407
+ 'x-undocumented': 'Will be removed.',
55309
55408
  },
55310
55409
  },
55311
55410
  '/user_identities/enrollment_automations/list': {
@@ -55358,13 +55457,12 @@ export default {
55358
55457
  ],
55359
55458
  summary: '/user_identities/enrollment_automations/list',
55360
55459
  tags: ['/user_identities'],
55361
- 'x-deprecated':
55362
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55363
55460
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55364
55461
  'x-fern-sdk-method-name': 'list',
55365
55462
  'x-fern-sdk-return-value': 'enrollment_automations',
55366
55463
  'x-response-key': 'enrollment_automations',
55367
55464
  'x-title': 'List Enrollment Automations',
55465
+ 'x-undocumented': 'Will be removed.',
55368
55466
  },
55369
55467
  post: {
55370
55468
  description:
@@ -55420,13 +55518,12 @@ export default {
55420
55518
  ],
55421
55519
  summary: '/user_identities/enrollment_automations/list',
55422
55520
  tags: ['/user_identities'],
55423
- 'x-deprecated':
55424
- 'Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.',
55425
55521
  'x-fern-sdk-group-name': ['user_identities', 'enrollment_automations'],
55426
55522
  'x-fern-sdk-method-name': 'list',
55427
55523
  'x-fern-sdk-return-value': 'enrollment_automations',
55428
55524
  'x-response-key': 'enrollment_automations',
55429
55525
  'x-title': 'List Enrollment Automations',
55526
+ 'x-undocumented': 'Will be removed.',
55430
55527
  },
55431
55528
  },
55432
55529
  '/user_identities/generate_instant_key': {
@@ -41692,6 +41692,18 @@ export type Routes = {
41692
41692
  )[]
41693
41693
  }
41694
41694
  }
41695
+ '/instant_keys/delete': {
41696
+ route: '/instant_keys/delete'
41697
+ method: 'DELETE' | 'POST'
41698
+ queryParams: {}
41699
+ jsonBody: {}
41700
+ commonParams: {
41701
+ /** ID of the Instant Key that you want to delete. */
41702
+ instant_key_id: string
41703
+ }
41704
+ formData: {}
41705
+ jsonResponse: {}
41706
+ }
41695
41707
  '/instant_keys/get': {
41696
41708
  route: '/instant_keys/get'
41697
41709
  method: 'GET' | 'POST'
@@ -83829,8 +83841,7 @@ export type Routes = {
83829
83841
  }
83830
83842
  formData: {}
83831
83843
  jsonResponse: {
83832
- /** 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/).
83833
- * @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/). */
83834
83845
  enrollment_automation: {
83835
83846
  /** ID of the enrollment automation. */
83836
83847
  enrollment_automation_id: string
@@ -83864,8 +83875,7 @@ export type Routes = {
83864
83875
  }
83865
83876
  formData: {}
83866
83877
  jsonResponse: {
83867
- /** 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/).
83868
- * @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/). */
83869
83879
  enrollment_automation: {
83870
83880
  /** ID of the enrollment automation. */
83871
83881
  enrollment_automation_id: string