@seamapi/types 1.287.1 → 1.287.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/connect.cjs +66 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +85 -92
  4. package/lib/seam/connect/models/acs/acs-access-group.js +5 -7
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.js +2 -4
  7. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js +4 -2
  9. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-user.js +8 -4
  11. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device-metadata.d.ts +5 -5
  13. package/lib/seam/connect/models/devices/device-metadata.js +1 -1
  14. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device.d.ts +7 -7
  16. package/lib/seam/connect/models/devices/phone.d.ts +5 -5
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -5
  18. package/lib/seam/connect/models/schedule.js +8 -2
  19. package/lib/seam/connect/models/schedule.js.map +1 -1
  20. package/lib/seam/connect/openapi.d.ts +8 -1
  21. package/lib/seam/connect/openapi.js +44 -22
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +65 -79
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-access-group.ts +5 -7
  26. package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -4
  27. package/src/lib/seam/connect/models/acs/acs-entrance.ts +29 -25
  28. package/src/lib/seam/connect/models/acs/acs-user.ts +14 -6
  29. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -1
  30. package/src/lib/seam/connect/models/schedule.ts +12 -2
  31. package/src/lib/seam/connect/openapi.ts +51 -22
  32. package/src/lib/seam/connect/route-types.ts +65 -79
package/src/lib/seam/connect/models/acs/acs-user.ts CHANGED
@@ -235,15 +235,23 @@ const common_acs_user = z
235
235
  .merge(user_fields)
236
236
 
237
237
  export const acs_user = common_acs_user.merge(
238
- z.object({
239
- is_managed: z.literal(true),
240
- }),
238
+ z
239
+ .object({
240
+ is_managed: z.literal(true),
241
+ })
242
+ .describe(
243
+ 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
244
+ ),
241
245
  )
242
246
 
243
247
  export const unmanaged_acs_user = common_acs_user.merge(
244
- z.object({
245
- is_managed: z.literal(false),
246
- }),
248
+ z
249
+ .object({
250
+ is_managed: z.literal(false),
251
+ })
252
+ .describe(
253
+ 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
254
+ ),
247
255
  )
248
256
 
249
257
  export type AcsUser = z.output<typeof acs_user>
package/src/lib/seam/connect/models/devices/device-metadata.ts CHANGED
@@ -264,7 +264,7 @@ export const device_metadata = z
264
264
  _member_group_id: z.string().optional(),
265
265
  }),
266
266
  assa_abloy_vostio_metadata: z.object({
267
- encoder_id: z.string(),
267
+ encoder_name: z.string(),
268
268
  }),
269
269
  })
270
270
  .partial()
package/src/lib/seam/connect/models/schedule.ts CHANGED
@@ -1,8 +1,18 @@
1
1
  import { z } from 'zod'
2
2
 
3
3
  export const start_end_schedule = z.object({
4
- starts_at: z.string().datetime(),
5
- ends_at: z.string().datetime(),
4
+ starts_at: z
5
+ .string()
6
+ .datetime()
7
+ .describe(
8
+ "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
9
+ ),
10
+ ends_at: z
11
+ .string()
12
+ .datetime()
13
+ .describe(
14
+ "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15
+ ),
6
16
  })
7
17
 
8
18
  // export const schedule = z.union([
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -187,7 +187,7 @@ export default {
187
187
  },
188
188
  acs_access_group: {
189
189
  description:
190
- '\n Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n \n The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n ',
190
+ 'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\nThe `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
191
191
  properties: {
192
192
  access_group_type: {
193
193
  deprecated: true,
@@ -198,12 +198,12 @@ export default {
198
198
  'brivo_group',
199
199
  ],
200
200
  type: 'string',
201
- 'x-deprecated': 'use external_type',
201
+ 'x-deprecated': 'Use `external_type`.',
202
202
  },
203
203
  access_group_type_display_name: {
204
204
  deprecated: true,
205
205
  type: 'string',
206
- 'x-deprecated': 'use external_type_display_name',
206
+ 'x-deprecated': 'Use `external_type_display_name`.',
207
207
  },
208
208
  acs_access_group_id: {
209
209
  description: 'ID of the access group.',
@@ -264,7 +264,7 @@ export default {
264
264
  },
265
265
  acs_credential: {
266
266
  description:
267
- 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
267
+ 'Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
268
268
  properties: {
269
269
  access_method: {
270
270
  description:
@@ -465,6 +465,8 @@ export default {
465
465
  type: 'object',
466
466
  },
467
467
  acs_entrance: {
468
+ description:
469
+ 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
468
470
  properties: {
469
471
  acs_entrance_id: {
470
472
  description: 'ID of the entrance.',
@@ -912,8 +914,18 @@ export default {
912
914
  description:
913
915
  "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
914
916
  properties: {
915
- ends_at: { format: 'date-time', type: 'string' },
916
- starts_at: { format: 'date-time', type: 'string' },
917
+ ends_at: {
918
+ description:
919
+ "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
920
+ format: 'date-time',
921
+ type: 'string',
922
+ },
923
+ starts_at: {
924
+ description:
925
+ "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
926
+ format: 'date-time',
927
+ type: 'string',
928
+ },
917
929
  },
918
930
  required: ['starts_at', 'ends_at'],
919
931
  type: 'object',
@@ -1473,7 +1485,7 @@ export default {
1473
1485
  oneOf: [
1474
1486
  {
1475
1487
  description:
1476
- 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1488
+ 'Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1477
1489
  properties: {
1478
1490
  access_method: {
1479
1491
  description:
@@ -1648,7 +1660,7 @@ export default {
1648
1660
  },
1649
1661
  {
1650
1662
  description:
1651
- 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1663
+ 'Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1652
1664
  properties: {
1653
1665
  access_method: {
1654
1666
  description:
@@ -1947,11 +1959,11 @@ export default {
1947
1959
  error: { nullable: true },
1948
1960
  result: {
1949
1961
  description:
1950
- 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1962
+ 'Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1951
1963
  oneOf: [
1952
1964
  {
1953
1965
  description:
1954
- 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1966
+ 'Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
1955
1967
  properties: {
1956
1968
  access_method: {
1957
1969
  description:
@@ -2125,7 +2137,7 @@ export default {
2125
2137
  },
2126
2138
  {
2127
2139
  description:
2128
- 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
2140
+ 'Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
2129
2141
  properties: {
2130
2142
  access_method: {
2131
2143
  description:
@@ -4001,8 +4013,8 @@ export default {
4001
4013
  type: 'object',
4002
4014
  },
4003
4015
  assa_abloy_vostio_metadata: {
4004
- properties: { encoder_id: { type: 'string' } },
4005
- required: ['encoder_id'],
4016
+ properties: { encoder_name: { type: 'string' } },
4017
+ required: ['encoder_name'],
4006
4018
  type: 'object',
4007
4019
  },
4008
4020
  august_metadata: {
@@ -7514,12 +7526,12 @@ export default {
7514
7526
  'brivo_group',
7515
7527
  ],
7516
7528
  type: 'string',
7517
- 'x-deprecated': 'use external_type',
7529
+ 'x-deprecated': 'Use `external_type`.',
7518
7530
  },
7519
7531
  access_group_type_display_name: {
7520
7532
  deprecated: true,
7521
7533
  type: 'string',
7522
- 'x-deprecated': 'use external_type_display_name',
7534
+ 'x-deprecated': 'Use `external_type_display_name`.',
7523
7535
  },
7524
7536
  acs_access_group_id: {
7525
7537
  description: 'ID of the access group.',
@@ -7655,12 +7667,12 @@ export default {
7655
7667
  'brivo_group',
7656
7668
  ],
7657
7669
  type: 'string',
7658
- 'x-deprecated': 'use external_type',
7670
+ 'x-deprecated': 'Use `external_type`.',
7659
7671
  },
7660
7672
  access_group_type_display_name: {
7661
7673
  deprecated: true,
7662
7674
  type: 'string',
7663
- 'x-deprecated': 'use external_type_display_name',
7675
+ 'x-deprecated': 'Use `external_type_display_name`.',
7664
7676
  },
7665
7677
  acs_access_group_id: {
7666
7678
  description: 'ID of the access group.',
@@ -8574,7 +8586,7 @@ export default {
8574
8586
  properties: {
8575
8587
  acs_credential: {
8576
8588
  description:
8577
- 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
8589
+ 'Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
8578
8590
  properties: {
8579
8591
  access_method: {
8580
8592
  description:
@@ -8851,7 +8863,7 @@ export default {
8851
8863
  acs_credentials: {
8852
8864
  items: {
8853
8865
  description:
8854
- 'Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
8866
+ 'Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
8855
8867
  properties: {
8856
8868
  access_method: {
8857
8869
  description:
@@ -10414,8 +10426,18 @@ export default {
10414
10426
  description:
10415
10427
  "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
10416
10428
  properties: {
10417
- ends_at: { format: 'date-time', type: 'string' },
10418
- starts_at: { format: 'date-time', type: 'string' },
10429
+ ends_at: {
10430
+ description:
10431
+ "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10432
+ format: 'date-time',
10433
+ type: 'string',
10434
+ },
10435
+ starts_at: {
10436
+ description:
10437
+ "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10438
+ format: 'date-time',
10439
+ type: 'string',
10440
+ },
10419
10441
  },
10420
10442
  required: ['starts_at', 'ends_at'],
10421
10443
  type: 'object',
@@ -10796,8 +10818,15 @@ export default {
10796
10818
  description:
10797
10819
  "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
10798
10820
  properties: {
10799
- ends_at: { format: 'date-time', type: 'string' },
10821
+ ends_at: {
10822
+ description:
10823
+ "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10824
+ format: 'date-time',
10825
+ type: 'string',
10826
+ },
10800
10827
  starts_at: {
10828
+ description:
10829
+ "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10801
10830
  format: 'date-time',
10802
10831
  type: 'string',
10803
10832
  },