@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
package/dist/connect.cjs CHANGED
@@ -648,7 +648,11 @@ var device_metadata = zod.z.object({
648
648
  }),
649
649
  akiles_metadata: zod.z.object({
650
650
  gadget_name: zod.z.string(),
651
- gadget_id: zod.z.string()
651
+ gadget_id: zod.z.string(),
652
+ /**
653
+ * Group ID to add users to for this device
654
+ */
655
+ _member_group_id: zod.z.string().optional()
652
656
  })
653
657
  }).partial();
654
658
  var LOCK_DEVICE_TYPE = {
@@ -1218,15 +1222,14 @@ var unmanaged_acs_credential = common_acs_credential.merge(
1218
1222
  })
1219
1223
  );
1220
1224
  var acs_credential_on_encoder = zod.z.object({
1221
- created_at: zod.z.string().datetime().describe("Date and time the credential was created."),
1225
+ created_at: zod.z.string().datetime().nullable().describe("Date and time the credential was created."),
1222
1226
  is_issued: zod.z.boolean().nullable(),
1223
1227
  starts_at: zod.z.string().datetime().nullable().describe("Date and time the credential will become useable."),
1224
1228
  ends_at: zod.z.string().datetime().nullable().describe("Date and time the credential will stop being useable."),
1225
1229
  card_number: zod.z.string().nullable().describe("A number or string that physically identifies this card."),
1226
1230
  visionline_metadata: zod.z.object({
1227
1231
  card_id: zod.z.string(),
1228
- card_function_type: zod.z.enum(["guest", "staff"]),
1229
- // computed, looks at door ops, and checks is guest op is present.
1232
+ // TODO card_function_type: z.enum(["guest", "staff"]), // computed, looks at door ops, and checks is guest op is present.
1230
1233
  cancelled: zod.z.boolean(),
1231
1234
  discarded: zod.z.boolean(),
1232
1235
  expired: zod.z.boolean(),
@@ -1235,9 +1238,9 @@ var acs_credential_on_encoder = zod.z.object({
1235
1238
  pending_auto_update: zod.z.boolean(),
1236
1239
  card_format: zod.z.enum(["TLCode", "rfid48"]),
1237
1240
  card_holder: zod.z.string().optional(),
1238
- number_of_issued_cards: zod.z.number()
1239
- // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
1240
- // common_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
1241
+ number_of_issued_cards: zod.z.number(),
1242
+ guest_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional(),
1243
+ common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
1241
1244
  }).optional()
1242
1245
  });
1243
1246
  var acs_entrance = zod.z.object({
@@ -1349,6 +1352,7 @@ var acs_system = zod.z.object({
1349
1352
  external_type_display_name: zod.z.string().describe(
1350
1353
  "Display name that corresponds to the brand-specific terminology for the `acs_system` type."
1351
1354
  ).optional(),
1355
+ is_credential_manager: zod.z.boolean().describe("Indicates if the `acs_system` is a credential manager."),
1352
1356
  visionline_metadata: zod.z.object({
1353
1357
  mobile_access_uuid: zod.z.string().describe(
1354
1358
  "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset."
@@ -3167,6 +3171,10 @@ var openapi_default = {
3167
3171
  description: "URL for the image that represents the `acs_system`.",
3168
3172
  type: "string"
3169
3173
  },
3174
+ is_credential_manager: {
3175
+ description: "Indicates if the `acs_system` is a credential manager.",
3176
+ type: "boolean"
3177
+ },
3170
3178
  name: { description: "Name of the `acs_system`.", type: "string" },
3171
3179
  system_type: {
3172
3180
  deprecated: true,
@@ -3239,6 +3247,7 @@ var openapi_default = {
3239
3247
  },
3240
3248
  required: [
3241
3249
  "acs_system_id",
3250
+ "is_credential_manager",
3242
3251
  "name",
3243
3252
  "created_at",
3244
3253
  "workspace_id",
@@ -3709,6 +3718,7 @@ var openapi_default = {
3709
3718
  created_at: {
3710
3719
  description: "Date and time the credential was created.",
3711
3720
  format: "date-time",
3721
+ nullable: true,
3712
3722
  type: "string"
3713
3723
  },
3714
3724
  ends_at: {
@@ -3731,14 +3741,18 @@ var openapi_default = {
3731
3741
  enum: ["TLCode", "rfid48"],
3732
3742
  type: "string"
3733
3743
  },
3734
- card_function_type: {
3735
- enum: ["guest", "staff"],
3736
- type: "string"
3737
- },
3738
3744
  card_holder: { type: "string" },
3739
3745
  card_id: { type: "string" },
3746
+ common_acs_entrance_ids: {
3747
+ items: { format: "uuid", type: "string" },
3748
+ type: "array"
3749
+ },
3740
3750
  discarded: { type: "boolean" },
3741
3751
  expired: { type: "boolean" },
3752
+ guest_acs_entrance_ids: {
3753
+ items: { format: "uuid", type: "string" },
3754
+ type: "array"
3755
+ },
3742
3756
  number_of_issued_cards: {
3743
3757
  format: "float",
3744
3758
  type: "number"
@@ -3749,7 +3763,6 @@ var openapi_default = {
3749
3763
  },
3750
3764
  required: [
3751
3765
  "card_id",
3752
- "card_function_type",
3753
3766
  "cancelled",
3754
3767
  "discarded",
3755
3768
  "expired",
@@ -5712,6 +5725,7 @@ var openapi_default = {
5712
5725
  properties: {
5713
5726
  akiles_metadata: {
5714
5727
  properties: {
5728
+ _member_group_id: { type: "string" },
5715
5729
  gadget_id: { type: "string" },
5716
5730
  gadget_name: { type: "string" }
5717
5731
  },
@@ -10546,6 +10560,7 @@ var openapi_default = {
10546
10560
  },
10547
10561
  "/acs/entrances/get": {
10548
10562
  post: {
10563
+ description: "Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
10549
10564
  operationId: "acsEntrancesGetPost",
10550
10565
  requestBody: {
10551
10566
  content: {
@@ -10590,7 +10605,8 @@ var openapi_default = {
10590
10605
  "x-fern-sdk-group-name": ["acs", "entrances"],
10591
10606
  "x-fern-sdk-method-name": "get",
10592
10607
  "x-fern-sdk-return-value": "acs_entrance",
10593
- "x-response-key": "acs_entrance"
10608
+ "x-response-key": "acs_entrance",
10609
+ "x-title": "Get an Entrance"
10594
10610
  }
10595
10611
  },
10596
10612
  "/acs/entrances/grant_access": {
@@ -10640,6 +10656,7 @@ var openapi_default = {
10640
10656
  },
10641
10657
  "/acs/entrances/list": {
10642
10658
  post: {
10659
+ description: "Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
10643
10660
  operationId: "acsEntrancesListPost",
10644
10661
  requestBody: {
10645
10662
  content: {
@@ -10687,11 +10704,13 @@ var openapi_default = {
10687
10704
  "x-fern-sdk-group-name": ["acs", "entrances"],
10688
10705
  "x-fern-sdk-method-name": "list",
10689
10706
  "x-fern-sdk-return-value": "acs_entrances",
10690
- "x-response-key": "acs_entrances"
10707
+ "x-response-key": "acs_entrances",
10708
+ "x-title": "List Entrances"
10691
10709
  }
10692
10710
  },
10693
10711
  "/acs/entrances/list_credentials_with_access": {
10694
10712
  post: {
10713
+ description: "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).",
10695
10714
  operationId: "acsEntrancesListCredentialsWithAccessPost",
10696
10715
  requestBody: {
10697
10716
  content: {
@@ -10746,7 +10765,8 @@ var openapi_default = {
10746
10765
  "x-fern-sdk-group-name": ["acs", "entrances"],
10747
10766
  "x-fern-sdk-method-name": "list_credentials_with_access",
10748
10767
  "x-fern-sdk-return-value": "acs_credentials",
10749
- "x-response-key": "acs_credentials"
10768
+ "x-response-key": "acs_credentials",
10769
+ "x-title": "List Credentials with Access to an Entrance"
10750
10770
  }
10751
10771
  },
10752
10772
  "/acs/systems/get": {