@seamapi/types 1.665.0 → 1.667.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.
@@ -32392,7 +32392,7 @@ export type Routes = {
32392
32392
  /** Date and time at which the event occurred. */
32393
32393
  occurred_at: string;
32394
32394
  /** ID of the affected device. */
32395
- device_id: string;
32395
+ device_id?: string | undefined;
32396
32396
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
32397
32397
  connected_account_id: string;
32398
32398
  /** Custom metadata of the device, present when device_id is provided. */
@@ -32410,6 +32410,30 @@ export type Routes = {
32410
32410
  action_attempt_id?: string | undefined;
32411
32411
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
32412
32412
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
32413
+ /**
32414
+ undocumented: Unreleased.
32415
+ ---
32416
+ ID of the user identity associated with the unlock event.
32417
+ */
32418
+ user_identity_id?: string | undefined;
32419
+ /**
32420
+ undocumented: Unreleased.
32421
+ ---
32422
+ ID of the ACS system associated with the unlock event.
32423
+ */
32424
+ acs_system_id?: string | undefined;
32425
+ /**
32426
+ undocumented: Unreleased.
32427
+ ---
32428
+ ID of the ACS user associated with the unlock event.
32429
+ */
32430
+ acs_user_id?: string | undefined;
32431
+ /**
32432
+ undocumented: Unreleased.
32433
+ ---
32434
+ ID of the ACS entrance associated with the unlock event.
32435
+ */
32436
+ acs_entrance_id?: string | undefined;
32413
32437
  } | {
32414
32438
  /** ID of the event. */
32415
32439
  event_id: string;
@@ -34352,7 +34376,7 @@ export type Routes = {
34352
34376
  /** Date and time at which the event occurred. */
34353
34377
  occurred_at: string;
34354
34378
  /** ID of the affected device. */
34355
- device_id: string;
34379
+ device_id?: string | undefined;
34356
34380
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
34357
34381
  connected_account_id: string;
34358
34382
  /** Custom metadata of the device, present when device_id is provided. */
@@ -34370,6 +34394,30 @@ export type Routes = {
34370
34394
  action_attempt_id?: string | undefined;
34371
34395
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
34372
34396
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
34397
+ /**
34398
+ undocumented: Unreleased.
34399
+ ---
34400
+ ID of the user identity associated with the unlock event.
34401
+ */
34402
+ user_identity_id?: string | undefined;
34403
+ /**
34404
+ undocumented: Unreleased.
34405
+ ---
34406
+ ID of the ACS system associated with the unlock event.
34407
+ */
34408
+ acs_system_id?: string | undefined;
34409
+ /**
34410
+ undocumented: Unreleased.
34411
+ ---
34412
+ ID of the ACS user associated with the unlock event.
34413
+ */
34414
+ acs_user_id?: string | undefined;
34415
+ /**
34416
+ undocumented: Unreleased.
34417
+ ---
34418
+ ID of the ACS entrance associated with the unlock event.
34419
+ */
34420
+ acs_entrance_id?: string | undefined;
34373
34421
  } | {
34374
34422
  /** ID of the event. */
34375
34423
  event_id: string;
@@ -52183,7 +52231,7 @@ export type Routes = {
52183
52231
  jsonBody: {};
52184
52232
  commonParams: {
52185
52233
  /** Workspace slug */
52186
- workspace_slug: string;
52234
+ slug: string;
52187
52235
  /** Connector name/type. If not provided, workspace_slug will be used as connector_name */
52188
52236
  connector_name?: string | undefined;
52189
52237
  };
@@ -53996,7 +54044,7 @@ export type Routes = {
53996
54044
  /** Date and time at which the event occurred. */
53997
54045
  occurred_at: string;
53998
54046
  /** ID of the affected device. */
53999
- device_id: string;
54047
+ device_id?: string | undefined;
54000
54048
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
54001
54049
  connected_account_id: string;
54002
54050
  /** Custom metadata of the device, present when device_id is provided. */
@@ -54014,6 +54062,30 @@ export type Routes = {
54014
54062
  action_attempt_id?: string | undefined;
54015
54063
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
54016
54064
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
54065
+ /**
54066
+ undocumented: Unreleased.
54067
+ ---
54068
+ ID of the user identity associated with the unlock event.
54069
+ */
54070
+ user_identity_id?: string | undefined;
54071
+ /**
54072
+ undocumented: Unreleased.
54073
+ ---
54074
+ ID of the ACS system associated with the unlock event.
54075
+ */
54076
+ acs_system_id?: string | undefined;
54077
+ /**
54078
+ undocumented: Unreleased.
54079
+ ---
54080
+ ID of the ACS user associated with the unlock event.
54081
+ */
54082
+ acs_user_id?: string | undefined;
54083
+ /**
54084
+ undocumented: Unreleased.
54085
+ ---
54086
+ ID of the ACS entrance associated with the unlock event.
54087
+ */
54088
+ acs_entrance_id?: string | undefined;
54017
54089
  } | {
54018
54090
  /** ID of the event. */
54019
54091
  event_id: string;
@@ -54498,6 +54570,7 @@ export type Routes = {
54498
54570
  jsonResponse: {
54499
54571
  /** Business vertical of the customer portal. */
54500
54572
  business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
54573
+ slug?: (string | null) | undefined;
54501
54574
  };
54502
54575
  maxDuration: undefined;
54503
54576
  };
@@ -54508,6 +54581,8 @@ export type Routes = {
54508
54581
  jsonBody: {
54509
54582
  /** Business vertical to set on the workspace. */
54510
54583
  business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
54584
+ /** Slug to set on the workspace. */
54585
+ slug?: (string | null) | undefined;
54511
54586
  };
54512
54587
  commonParams: {};
54513
54588
  formData: {};
@@ -82508,7 +82583,7 @@ export type Routes = {
82508
82583
  /** Date and time at which the event occurred. */
82509
82584
  occurred_at: string;
82510
82585
  /** ID of the affected device. */
82511
- device_id: string;
82586
+ device_id?: string | undefined;
82512
82587
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
82513
82588
  connected_account_id: string;
82514
82589
  /** Custom metadata of the device, present when device_id is provided. */
@@ -82526,6 +82601,30 @@ export type Routes = {
82526
82601
  action_attempt_id?: string | undefined;
82527
82602
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
82528
82603
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
82604
+ /**
82605
+ undocumented: Unreleased.
82606
+ ---
82607
+ ID of the user identity associated with the unlock event.
82608
+ */
82609
+ user_identity_id?: string | undefined;
82610
+ /**
82611
+ undocumented: Unreleased.
82612
+ ---
82613
+ ID of the ACS system associated with the unlock event.
82614
+ */
82615
+ acs_system_id?: string | undefined;
82616
+ /**
82617
+ undocumented: Unreleased.
82618
+ ---
82619
+ ID of the ACS user associated with the unlock event.
82620
+ */
82621
+ acs_user_id?: string | undefined;
82622
+ /**
82623
+ undocumented: Unreleased.
82624
+ ---
82625
+ ID of the ACS entrance associated with the unlock event.
82626
+ */
82627
+ acs_entrance_id?: string | undefined;
82529
82628
  } | {
82530
82629
  /** ID of the event. */
82531
82630
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.665.0",
3
+ "version": "1.667.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -91,7 +91,7 @@
91
91
  "zod": "^3.24.0"
92
92
  },
93
93
  "devDependencies": {
94
- "@seamapi/blueprint": "^0.52.2",
94
+ "@seamapi/blueprint": "^0.53.0",
95
95
  "@swc/core": "^1.11.29",
96
96
  "@types/node": "^22.15.21",
97
97
  "concurrently": "^9.2.0",
@@ -411,6 +411,31 @@ export const lock_unlocked_event = device_event.extend({
411
411
  method: lock_method.describe(
412
412
  'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
413
413
  ),
414
+ user_identity_id: z.string().uuid().optional().describe(`
415
+ undocumented: Unreleased.
416
+ ---
417
+ ID of the user identity associated with the unlock event.
418
+ `),
419
+ acs_system_id: z.string().uuid().optional().describe(`
420
+ undocumented: Unreleased.
421
+ ---
422
+ ID of the ACS system associated with the unlock event.
423
+ `),
424
+ acs_user_id: z.string().uuid().optional().describe(`
425
+ undocumented: Unreleased.
426
+ ---
427
+ ID of the ACS user associated with the unlock event.
428
+ `),
429
+ acs_entrance_id: z.string().uuid().optional().describe(`
430
+ undocumented: Unreleased.
431
+ ---
432
+ ID of the ACS entrance associated with the unlock event.
433
+ `),
434
+ device_id: z
435
+ .string()
436
+ .uuid()
437
+ .optional()
438
+ .describe('ID of the affected device.'),
414
439
  }).describe(`
415
440
  ---
416
441
  route_path: /locks
@@ -18723,6 +18723,24 @@ export default {
18723
18723
  format: 'uuid',
18724
18724
  type: 'string',
18725
18725
  },
18726
+ acs_entrance_id: {
18727
+ description:
18728
+ '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the unlock event.\n ',
18729
+ format: 'uuid',
18730
+ type: 'string',
18731
+ },
18732
+ acs_system_id: {
18733
+ description:
18734
+ '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the unlock event.\n ',
18735
+ format: 'uuid',
18736
+ type: 'string',
18737
+ },
18738
+ acs_user_id: {
18739
+ description:
18740
+ '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the unlock event.\n ',
18741
+ format: 'uuid',
18742
+ type: 'string',
18743
+ },
18726
18744
  action_attempt_id: {
18727
18745
  description:
18728
18746
  'ID of the action attempt associated with the unlock action.',
@@ -18778,6 +18796,12 @@ export default {
18778
18796
  format: 'date-time',
18779
18797
  type: 'string',
18780
18798
  },
18799
+ user_identity_id: {
18800
+ description:
18801
+ '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the unlock event.\n ',
18802
+ format: 'uuid',
18803
+ type: 'string',
18804
+ },
18781
18805
  workspace_id: {
18782
18806
  description:
18783
18807
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
@@ -18790,7 +18814,6 @@ export default {
18790
18814
  'workspace_id',
18791
18815
  'created_at',
18792
18816
  'occurred_at',
18793
- 'device_id',
18794
18817
  'connected_account_id',
18795
18818
  'event_type',
18796
18819
  'method',
@@ -52841,7 +52864,7 @@ export default {
52841
52864
  parameters: [
52842
52865
  {
52843
52866
  in: 'query',
52844
- name: 'workspace_slug',
52867
+ name: 'slug',
52845
52868
  required: true,
52846
52869
  schema: {
52847
52870
  description: 'Workspace slug',
@@ -52911,13 +52934,13 @@ export default {
52911
52934
  minLength: 1,
52912
52935
  type: 'string',
52913
52936
  },
52914
- workspace_slug: {
52937
+ slug: {
52915
52938
  description: 'Workspace slug',
52916
52939
  minLength: 1,
52917
52940
  type: 'string',
52918
52941
  },
52919
52942
  },
52920
- required: ['workspace_slug'],
52943
+ required: ['slug'],
52921
52944
  type: 'object',
52922
52945
  },
52923
52946
  },
@@ -55402,6 +55425,7 @@ export default {
55402
55425
  type: 'string',
55403
55426
  },
55404
55427
  ok: { type: 'boolean' },
55428
+ slug: { nullable: true, type: 'string' },
55405
55429
  },
55406
55430
  required: ['ok'],
55407
55431
  type: 'object',
@@ -55444,6 +55468,7 @@ export default {
55444
55468
  type: 'string',
55445
55469
  },
55446
55470
  ok: { type: 'boolean' },
55471
+ slug: { nullable: true, type: 'string' },
55447
55472
  },
55448
55473
  required: ['ok'],
55449
55474
  type: 'object',
@@ -55486,6 +55511,11 @@ export default {
55486
55511
  ],
55487
55512
  type: 'string',
55488
55513
  },
55514
+ slug: {
55515
+ description: 'Slug to set on the workspace.',
55516
+ nullable: true,
55517
+ type: 'string',
55518
+ },
55489
55519
  },
55490
55520
  type: 'object',
55491
55521
  },
@@ -55536,6 +55566,11 @@ export default {
55536
55566
  ],
55537
55567
  type: 'string',
55538
55568
  },
55569
+ slug: {
55570
+ description: 'Slug to set on the workspace.',
55571
+ nullable: true,
55572
+ type: 'string',
55573
+ },
55539
55574
  },
55540
55575
  type: 'object',
55541
55576
  },
@@ -38159,7 +38159,7 @@ export type Routes = {
38159
38159
  /** Date and time at which the event occurred. */
38160
38160
  occurred_at: string
38161
38161
  /** ID of the affected device. */
38162
- device_id: string
38162
+ device_id?: string | undefined
38163
38163
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
38164
38164
  connected_account_id: string
38165
38165
  /** Custom metadata of the device, present when device_id is provided. */
@@ -38186,6 +38186,30 @@ export type Routes = {
38186
38186
  | 'automatic'
38187
38187
  | 'unknown'
38188
38188
  | 'seamapi'
38189
+ /**
38190
+ undocumented: Unreleased.
38191
+ ---
38192
+ ID of the user identity associated with the unlock event.
38193
+ */
38194
+ user_identity_id?: string | undefined
38195
+ /**
38196
+ undocumented: Unreleased.
38197
+ ---
38198
+ ID of the ACS system associated with the unlock event.
38199
+ */
38200
+ acs_system_id?: string | undefined
38201
+ /**
38202
+ undocumented: Unreleased.
38203
+ ---
38204
+ ID of the ACS user associated with the unlock event.
38205
+ */
38206
+ acs_user_id?: string | undefined
38207
+ /**
38208
+ undocumented: Unreleased.
38209
+ ---
38210
+ ID of the ACS entrance associated with the unlock event.
38211
+ */
38212
+ acs_entrance_id?: string | undefined
38189
38213
  }
38190
38214
  | {
38191
38215
  /** ID of the event. */
@@ -40648,7 +40672,7 @@ export type Routes = {
40648
40672
  /** Date and time at which the event occurred. */
40649
40673
  occurred_at: string
40650
40674
  /** ID of the affected device. */
40651
- device_id: string
40675
+ device_id?: string | undefined
40652
40676
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
40653
40677
  connected_account_id: string
40654
40678
  /** Custom metadata of the device, present when device_id is provided. */
@@ -40670,6 +40694,30 @@ export type Routes = {
40670
40694
  action_attempt_id?: string | undefined
40671
40695
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
40672
40696
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
40697
+ /**
40698
+ undocumented: Unreleased.
40699
+ ---
40700
+ ID of the user identity associated with the unlock event.
40701
+ */
40702
+ user_identity_id?: string | undefined
40703
+ /**
40704
+ undocumented: Unreleased.
40705
+ ---
40706
+ ID of the ACS system associated with the unlock event.
40707
+ */
40708
+ acs_system_id?: string | undefined
40709
+ /**
40710
+ undocumented: Unreleased.
40711
+ ---
40712
+ ID of the ACS user associated with the unlock event.
40713
+ */
40714
+ acs_user_id?: string | undefined
40715
+ /**
40716
+ undocumented: Unreleased.
40717
+ ---
40718
+ ID of the ACS entrance associated with the unlock event.
40719
+ */
40720
+ acs_entrance_id?: string | undefined
40673
40721
  }
40674
40722
  | {
40675
40723
  /** ID of the event. */
@@ -62029,7 +62077,7 @@ export type Routes = {
62029
62077
  jsonBody: {}
62030
62078
  commonParams: {
62031
62079
  /** Workspace slug */
62032
- workspace_slug: string
62080
+ slug: string
62033
62081
  /** Connector name/type. If not provided, workspace_slug will be used as connector_name */
62034
62082
  connector_name?: string | undefined
62035
62083
  }
@@ -64316,7 +64364,7 @@ export type Routes = {
64316
64364
  /** Date and time at which the event occurred. */
64317
64365
  occurred_at: string
64318
64366
  /** ID of the affected device. */
64319
- device_id: string
64367
+ device_id?: string | undefined
64320
64368
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64321
64369
  connected_account_id: string
64322
64370
  /** Custom metadata of the device, present when device_id is provided. */
@@ -64338,6 +64386,30 @@ export type Routes = {
64338
64386
  action_attempt_id?: string | undefined
64339
64387
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
64340
64388
  method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
64389
+ /**
64390
+ undocumented: Unreleased.
64391
+ ---
64392
+ ID of the user identity associated with the unlock event.
64393
+ */
64394
+ user_identity_id?: string | undefined
64395
+ /**
64396
+ undocumented: Unreleased.
64397
+ ---
64398
+ ID of the ACS system associated with the unlock event.
64399
+ */
64400
+ acs_system_id?: string | undefined
64401
+ /**
64402
+ undocumented: Unreleased.
64403
+ ---
64404
+ ID of the ACS user associated with the unlock event.
64405
+ */
64406
+ acs_user_id?: string | undefined
64407
+ /**
64408
+ undocumented: Unreleased.
64409
+ ---
64410
+ ID of the ACS entrance associated with the unlock event.
64411
+ */
64412
+ acs_entrance_id?: string | undefined
64341
64413
  }
64342
64414
  | {
64343
64415
  /** ID of the event. */
@@ -64910,6 +64982,7 @@ export type Routes = {
64910
64982
  | 'property_tours'
64911
64983
  )
64912
64984
  | undefined
64985
+ slug?: (string | null) | undefined
64913
64986
  }
64914
64987
  maxDuration: undefined
64915
64988
  }
@@ -64928,6 +65001,8 @@ export type Routes = {
64928
65001
  | 'property_tours'
64929
65002
  )
64930
65003
  | undefined
65004
+ /** Slug to set on the workspace. */
65005
+ slug?: (string | null) | undefined
64931
65006
  }
64932
65007
  commonParams: {}
64933
65008
  formData: {}
@@ -98145,7 +98220,7 @@ export type Routes = {
98145
98220
  /** Date and time at which the event occurred. */
98146
98221
  occurred_at: string
98147
98222
  /** ID of the affected device. */
98148
- device_id: string
98223
+ device_id?: string | undefined
98149
98224
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
98150
98225
  connected_account_id: string
98151
98226
  /** Custom metadata of the device, present when device_id is provided. */
@@ -98172,6 +98247,30 @@ export type Routes = {
98172
98247
  | 'automatic'
98173
98248
  | 'unknown'
98174
98249
  | 'seamapi'
98250
+ /**
98251
+ undocumented: Unreleased.
98252
+ ---
98253
+ ID of the user identity associated with the unlock event.
98254
+ */
98255
+ user_identity_id?: string | undefined
98256
+ /**
98257
+ undocumented: Unreleased.
98258
+ ---
98259
+ ID of the ACS system associated with the unlock event.
98260
+ */
98261
+ acs_system_id?: string | undefined
98262
+ /**
98263
+ undocumented: Unreleased.
98264
+ ---
98265
+ ID of the ACS user associated with the unlock event.
98266
+ */
98267
+ acs_user_id?: string | undefined
98268
+ /**
98269
+ undocumented: Unreleased.
98270
+ ---
98271
+ ID of the ACS entrance associated with the unlock event.
98272
+ */
98273
+ acs_entrance_id?: string | undefined
98175
98274
  }
98176
98275
  | {
98177
98276
  /** ID of the event. */