@seamapi/types 1.264.1 → 1.265.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.
Files changed (27) hide show
  1. package/dist/connect.cjs +35 -15
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +150 -60
  4. package/lib/seam/connect/models/acs/acs-credential.d.ts +13 -8
  5. package/lib/seam/connect/models/acs/acs-credential.js +4 -3
  6. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.d.ts +3 -0
  8. package/lib/seam/connect/models/acs/acs-system.js +3 -0
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +25 -16
  11. package/lib/seam/connect/models/action-attempts/scan-card.d.ts +25 -16
  12. package/lib/seam/connect/models/devices/device-metadata.d.ts +8 -0
  13. package/lib/seam/connect/models/devices/device-metadata.js +4 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device.d.ts +7 -0
  16. package/lib/seam/connect/models/devices/phone.d.ts +5 -0
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -0
  18. package/lib/seam/connect/openapi.d.ts +28 -4
  19. package/lib/seam/connect/openapi.js +21 -5
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +82 -40
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +4 -3
  24. package/src/lib/seam/connect/models/acs/acs-system.ts +3 -0
  25. package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
  26. package/src/lib/seam/connect/openapi.ts +25 -5
  27. package/src/lib/seam/connect/route-types.ts +82 -40
@@ -76,6 +76,7 @@ export const acs_credential_on_encoder = z.object({
76
76
  created_at: z
77
77
  .string()
78
78
  .datetime()
79
+ .nullable()
79
80
  .describe('Date and time the credential was created.'),
80
81
 
81
82
  is_issued: z.boolean().nullable(),
@@ -99,7 +100,7 @@ export const acs_credential_on_encoder = z.object({
99
100
  visionline_metadata: z
100
101
  .object({
101
102
  card_id: z.string(),
102
- card_function_type: z.enum(['guest', 'staff']), // computed, looks at door ops, and checks is guest op is present.
103
+ // TODO card_function_type: z.enum(["guest", "staff"]), // computed, looks at door ops, and checks is guest op is present.
103
104
 
104
105
  cancelled: z.boolean(),
105
106
  discarded: z.boolean(),
@@ -113,8 +114,8 @@ export const acs_credential_on_encoder = z.object({
113
114
 
114
115
  number_of_issued_cards: z.number(),
115
116
 
116
- // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
117
- // common_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
117
+ guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
118
+ common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
118
119
  })
119
120
  .optional(),
120
121
  })
@@ -166,6 +166,9 @@ export const acs_system = z
166
166
  'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
167
167
  )
168
168
  .optional(),
169
+ is_credential_manager: z
170
+ .boolean()
171
+ .describe('Indicates if the `acs_system` is a credential manager.'),
169
172
  visionline_metadata: z
170
173
  .object({
171
174
  mobile_access_uuid: z
@@ -245,6 +245,11 @@ export const device_metadata = z
245
245
  akiles_metadata: z.object({
246
246
  gadget_name: z.string(),
247
247
  gadget_id: z.string(),
248
+
249
+ /**
250
+ * Group ID to add users to for this device
251
+ */
252
+ _member_group_id: z.string().optional(),
248
253
  }),
249
254
  })
250
255
  .partial()
@@ -685,6 +685,11 @@ export default {
685
685
  description: 'URL for the image that represents the `acs_system`.',
686
686
  type: 'string',
687
687
  },
688
+ is_credential_manager: {
689
+ description:
690
+ 'Indicates if the `acs_system` is a credential manager.',
691
+ type: 'boolean',
692
+ },
688
693
  name: { description: 'Name of the `acs_system`.', type: 'string' },
689
694
  system_type: {
690
695
  deprecated: true,
@@ -764,6 +769,7 @@ export default {
764
769
  },
765
770
  required: [
766
771
  'acs_system_id',
772
+ 'is_credential_manager',
767
773
  'name',
768
774
  'created_at',
769
775
  'workspace_id',
@@ -1264,6 +1270,7 @@ export default {
1264
1270
  description:
1265
1271
  'Date and time the credential was created.',
1266
1272
  format: 'date-time',
1273
+ nullable: true,
1267
1274
  type: 'string',
1268
1275
  },
1269
1276
  ends_at: {
@@ -1288,14 +1295,18 @@ export default {
1288
1295
  enum: ['TLCode', 'rfid48'],
1289
1296
  type: 'string',
1290
1297
  },
1291
- card_function_type: {
1292
- enum: ['guest', 'staff'],
1293
- type: 'string',
1294
- },
1295
1298
  card_holder: { type: 'string' },
1296
1299
  card_id: { type: 'string' },
1300
+ common_acs_entrance_ids: {
1301
+ items: { format: 'uuid', type: 'string' },
1302
+ type: 'array',
1303
+ },
1297
1304
  discarded: { type: 'boolean' },
1298
1305
  expired: { type: 'boolean' },
1306
+ guest_acs_entrance_ids: {
1307
+ items: { format: 'uuid', type: 'string' },
1308
+ type: 'array',
1309
+ },
1299
1310
  number_of_issued_cards: {
1300
1311
  format: 'float',
1301
1312
  type: 'number',
@@ -1306,7 +1317,6 @@ export default {
1306
1317
  },
1307
1318
  required: [
1308
1319
  'card_id',
1309
- 'card_function_type',
1310
1320
  'cancelled',
1311
1321
  'discarded',
1312
1322
  'expired',
@@ -3296,6 +3306,7 @@ export default {
3296
3306
  properties: {
3297
3307
  akiles_metadata: {
3298
3308
  properties: {
3309
+ _member_group_id: { type: 'string' },
3299
3310
  gadget_id: { type: 'string' },
3300
3311
  gadget_name: { type: 'string' },
3301
3312
  },
@@ -8168,6 +8179,8 @@ export default {
8168
8179
  },
8169
8180
  '/acs/entrances/get': {
8170
8181
  post: {
8182
+ description:
8183
+ 'Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8171
8184
  operationId: 'acsEntrancesGetPost',
8172
8185
  requestBody: {
8173
8186
  content: {
@@ -8213,6 +8226,7 @@ export default {
8213
8226
  'x-fern-sdk-method-name': 'get',
8214
8227
  'x-fern-sdk-return-value': 'acs_entrance',
8215
8228
  'x-response-key': 'acs_entrance',
8229
+ 'x-title': 'Get an Entrance',
8216
8230
  },
8217
8231
  },
8218
8232
  '/acs/entrances/grant_access': {
@@ -8262,6 +8276,8 @@ export default {
8262
8276
  },
8263
8277
  '/acs/entrances/list': {
8264
8278
  post: {
8279
+ description:
8280
+ 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8265
8281
  operationId: 'acsEntrancesListPost',
8266
8282
  requestBody: {
8267
8283
  content: {
@@ -8310,10 +8326,13 @@ export default {
8310
8326
  'x-fern-sdk-method-name': 'list',
8311
8327
  'x-fern-sdk-return-value': 'acs_entrances',
8312
8328
  'x-response-key': 'acs_entrances',
8329
+ 'x-title': 'List Entrances',
8313
8330
  },
8314
8331
  },
8315
8332
  '/acs/entrances/list_credentials_with_access': {
8316
8333
  post: {
8334
+ description:
8335
+ 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
8317
8336
  operationId: 'acsEntrancesListCredentialsWithAccessPost',
8318
8337
  requestBody: {
8319
8338
  content: {
@@ -8369,6 +8388,7 @@ export default {
8369
8388
  'x-fern-sdk-method-name': 'list_credentials_with_access',
8370
8389
  'x-fern-sdk-return-value': 'acs_credentials',
8371
8390
  'x-response-key': 'acs_credentials',
8391
+ 'x-title': 'List Credentials with Access to an Entrance',
8372
8392
  },
8373
8393
  },
8374
8394
  '/acs/systems/get': {