@seamapi/types 1.264.2 → 1.266.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.
package/dist/connect.cjs CHANGED
@@ -1229,8 +1229,7 @@ var acs_credential_on_encoder = zod.z.object({
1229
1229
  card_number: zod.z.string().nullable().describe("A number or string that physically identifies this card."),
1230
1230
  visionline_metadata: zod.z.object({
1231
1231
  card_id: zod.z.string(),
1232
- card_function_type: zod.z.enum(["guest", "staff"]),
1233
- // 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.
1234
1233
  cancelled: zod.z.boolean(),
1235
1234
  discarded: zod.z.boolean(),
1236
1235
  expired: zod.z.boolean(),
@@ -1239,9 +1238,9 @@ var acs_credential_on_encoder = zod.z.object({
1239
1238
  pending_auto_update: zod.z.boolean(),
1240
1239
  card_format: zod.z.enum(["TLCode", "rfid48"]),
1241
1240
  card_holder: zod.z.string().optional(),
1242
- number_of_issued_cards: zod.z.number()
1243
- // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
1244
- // 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()
1245
1244
  }).optional()
1246
1245
  });
1247
1246
  var acs_entrance = zod.z.object({
@@ -1348,11 +1347,20 @@ zod.z.object({
1348
1347
  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.optional().nullable()
1349
1348
  });
1350
1349
  var acs_system = zod.z.object({
1350
+ default_credential_manager_acs_system_id: zod.z.string().uuid().nullable().optional().describe(
1351
+ `
1352
+ ---
1353
+ draft: Needs review
1354
+ ---
1355
+ ID of the default credential manager acs_system for this access control system.
1356
+ `
1357
+ ),
1351
1358
  acs_system_id: zod.z.string().uuid().describe("ID of the `acs_system`."),
1352
1359
  external_type: acs_system_external_type.describe("Brand-specific terminology for the `acs_system` type.").optional(),
1353
1360
  external_type_display_name: zod.z.string().describe(
1354
1361
  "Display name that corresponds to the brand-specific terminology for the `acs_system` type."
1355
1362
  ).optional(),
1363
+ is_credential_manager: zod.z.boolean().describe("Indicates if the `acs_system` is a credential manager."),
1356
1364
  visionline_metadata: zod.z.object({
1357
1365
  mobile_access_uuid: zod.z.string().describe(
1358
1366
  "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset."
@@ -3034,6 +3042,13 @@ var openapi_default = {
3034
3042
  format: "date-time",
3035
3043
  type: "string"
3036
3044
  },
3045
+ default_credential_manager_acs_system_id: {
3046
+ description: "ID of the default credential manager acs_system for this access control system.",
3047
+ format: "uuid",
3048
+ nullable: true,
3049
+ type: "string",
3050
+ "x-draft": "Needs review"
3051
+ },
3037
3052
  errors: {
3038
3053
  description: "Errors associated with the `acs_system`.",
3039
3054
  items: {
@@ -3171,6 +3186,10 @@ var openapi_default = {
3171
3186
  description: "URL for the image that represents the `acs_system`.",
3172
3187
  type: "string"
3173
3188
  },
3189
+ is_credential_manager: {
3190
+ description: "Indicates if the `acs_system` is a credential manager.",
3191
+ type: "boolean"
3192
+ },
3174
3193
  name: { description: "Name of the `acs_system`.", type: "string" },
3175
3194
  system_type: {
3176
3195
  deprecated: true,
@@ -3243,6 +3262,7 @@ var openapi_default = {
3243
3262
  },
3244
3263
  required: [
3245
3264
  "acs_system_id",
3265
+ "is_credential_manager",
3246
3266
  "name",
3247
3267
  "created_at",
3248
3268
  "workspace_id",
@@ -3736,14 +3756,18 @@ var openapi_default = {
3736
3756
  enum: ["TLCode", "rfid48"],
3737
3757
  type: "string"
3738
3758
  },
3739
- card_function_type: {
3740
- enum: ["guest", "staff"],
3741
- type: "string"
3742
- },
3743
3759
  card_holder: { type: "string" },
3744
3760
  card_id: { type: "string" },
3761
+ common_acs_entrance_ids: {
3762
+ items: { format: "uuid", type: "string" },
3763
+ type: "array"
3764
+ },
3745
3765
  discarded: { type: "boolean" },
3746
3766
  expired: { type: "boolean" },
3767
+ guest_acs_entrance_ids: {
3768
+ items: { format: "uuid", type: "string" },
3769
+ type: "array"
3770
+ },
3747
3771
  number_of_issued_cards: {
3748
3772
  format: "float",
3749
3773
  type: "number"
@@ -3754,7 +3778,6 @@ var openapi_default = {
3754
3778
  },
3755
3779
  required: [
3756
3780
  "card_id",
3757
- "card_function_type",
3758
3781
  "cancelled",
3759
3782
  "discarded",
3760
3783
  "expired",
@@ -10552,6 +10575,7 @@ var openapi_default = {
10552
10575
  },
10553
10576
  "/acs/entrances/get": {
10554
10577
  post: {
10578
+ description: "Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
10555
10579
  operationId: "acsEntrancesGetPost",
10556
10580
  requestBody: {
10557
10581
  content: {
@@ -10596,7 +10620,8 @@ var openapi_default = {
10596
10620
  "x-fern-sdk-group-name": ["acs", "entrances"],
10597
10621
  "x-fern-sdk-method-name": "get",
10598
10622
  "x-fern-sdk-return-value": "acs_entrance",
10599
- "x-response-key": "acs_entrance"
10623
+ "x-response-key": "acs_entrance",
10624
+ "x-title": "Get an Entrance"
10600
10625
  }
10601
10626
  },
10602
10627
  "/acs/entrances/grant_access": {
@@ -10646,6 +10671,7 @@ var openapi_default = {
10646
10671
  },
10647
10672
  "/acs/entrances/list": {
10648
10673
  post: {
10674
+ description: "Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
10649
10675
  operationId: "acsEntrancesListPost",
10650
10676
  requestBody: {
10651
10677
  content: {
@@ -10693,11 +10719,13 @@ var openapi_default = {
10693
10719
  "x-fern-sdk-group-name": ["acs", "entrances"],
10694
10720
  "x-fern-sdk-method-name": "list",
10695
10721
  "x-fern-sdk-return-value": "acs_entrances",
10696
- "x-response-key": "acs_entrances"
10722
+ "x-response-key": "acs_entrances",
10723
+ "x-title": "List Entrances"
10697
10724
  }
10698
10725
  },
10699
10726
  "/acs/entrances/list_credentials_with_access": {
10700
10727
  post: {
10728
+ 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).",
10701
10729
  operationId: "acsEntrancesListCredentialsWithAccessPost",
10702
10730
  requestBody: {
10703
10731
  content: {
@@ -10752,7 +10780,8 @@ var openapi_default = {
10752
10780
  "x-fern-sdk-group-name": ["acs", "entrances"],
10753
10781
  "x-fern-sdk-method-name": "list_credentials_with_access",
10754
10782
  "x-fern-sdk-return-value": "acs_credentials",
10755
- "x-response-key": "acs_credentials"
10783
+ "x-response-key": "acs_credentials",
10784
+ "x-title": "List Credentials with Access to an Entrance"
10756
10785
  }
10757
10786
  },
10758
10787
  "/acs/systems/get": {