@seamapi/types 1.747.0 → 1.749.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/index.cjs CHANGED
@@ -2704,15 +2704,25 @@ var updating_access_times_warning = common_access_method_warning.extend({
2704
2704
  }).describe(
2705
2705
  "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated."
2706
2706
  );
2707
+ var pulled_backup_access_code_warning = common_access_method_warning.extend({
2708
+ warning_code: zod.z.literal("pulled_backup_access_code").describe(warning_code_description5),
2709
+ original_access_method_id: zod.z.string().uuid().optional().describe(
2710
+ "ID of the original access method from which this backup access method was split, if applicable."
2711
+ )
2712
+ }).describe(
2713
+ "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time."
2714
+ );
2707
2715
  var access_method_warning = zod.z.discriminatedUnion("warning_code", [
2708
2716
  being_deleted4,
2709
- updating_access_times_warning
2717
+ updating_access_times_warning,
2718
+ pulled_backup_access_code_warning
2710
2719
  ]).describe(
2711
2720
  "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)."
2712
2721
  );
2713
2722
  zod.z.object({
2714
2723
  being_deleted: being_deleted4.optional().nullable(),
2715
- updating_access_times: updating_access_times_warning.optional().nullable()
2724
+ updating_access_times: updating_access_times_warning.optional().nullable(),
2725
+ pulled_backup_access_code: pulled_backup_access_code_warning.optional().nullable()
2716
2726
  });
2717
2727
  var common_pending_mutation2 = zod.z.object({
2718
2728
  created_at: zod.z.string().datetime().describe("Date and time at which the mutation was created."),
@@ -3149,6 +3159,7 @@ var acs_credential_visionline_metadata = zod.z.object({
3149
3159
  var acs_credential_external_type = zod.z.enum([
3150
3160
  "pti_card",
3151
3161
  "brivo_credential",
3162
+ "brivo_digital_credential",
3152
3163
  "hid_credential",
3153
3164
  "visionline_card",
3154
3165
  "salto_ks_credential",
@@ -3161,7 +3172,8 @@ var acs_credential_external_type = zod.z.enum([
3161
3172
  var acs_credential_access_method_type = zod.z.enum([
3162
3173
  "code",
3163
3174
  "card",
3164
- "mobile_key"
3175
+ "mobile_key",
3176
+ "cloud_key"
3165
3177
  ]);
3166
3178
  var common_acs_credential_warning = zod.z.object({
3167
3179
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
@@ -3257,7 +3269,7 @@ var common_acs_credential = zod.z.object({
3257
3269
  "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card."
3258
3270
  ),
3259
3271
  access_method: acs_credential_access_method_type.describe(
3260
- "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`."
3272
+ "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`."
3261
3273
  ),
3262
3274
  external_type: acs_credential_external_type.optional().describe(
3263
3275
  "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`."
@@ -8860,6 +8872,32 @@ var openapi_default = {
8860
8872
  },
8861
8873
  required: ["created_at", "message", "warning_code"],
8862
8874
  type: "object"
8875
+ },
8876
+ {
8877
+ description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
8878
+ properties: {
8879
+ created_at: {
8880
+ description: "Date and time at which Seam created the warning.",
8881
+ format: "date-time",
8882
+ type: "string"
8883
+ },
8884
+ message: {
8885
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
8886
+ type: "string"
8887
+ },
8888
+ original_access_method_id: {
8889
+ description: "ID of the original access method from which this backup access method was split, if applicable.",
8890
+ format: "uuid",
8891
+ type: "string"
8892
+ },
8893
+ warning_code: {
8894
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8895
+ enum: ["pulled_backup_access_code"],
8896
+ type: "string"
8897
+ }
8898
+ },
8899
+ required: ["created_at", "message", "warning_code"],
8900
+ type: "object"
8863
8901
  }
8864
8902
  ]
8865
8903
  },
@@ -9375,8 +9413,8 @@ var openapi_default = {
9375
9413
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
9376
9414
  properties: {
9377
9415
  access_method: {
9378
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
9379
- enum: ["code", "card", "mobile_key"],
9416
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
9417
+ enum: ["code", "card", "mobile_key", "cloud_key"],
9380
9418
  type: "string"
9381
9419
  },
9382
9420
  acs_credential_id: {
@@ -9473,6 +9511,7 @@ var openapi_default = {
9473
9511
  enum: [
9474
9512
  "pti_card",
9475
9513
  "brivo_credential",
9514
+ "brivo_digital_credential",
9476
9515
  "hid_credential",
9477
9516
  "visionline_card",
9478
9517
  "salto_ks_credential",
@@ -11631,8 +11670,8 @@ var openapi_default = {
11631
11670
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
11632
11671
  properties: {
11633
11672
  access_method: {
11634
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
11635
- enum: ["code", "card", "mobile_key"],
11673
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
11674
+ enum: ["code", "card", "mobile_key", "cloud_key"],
11636
11675
  type: "string"
11637
11676
  },
11638
11677
  acs_credential_id: {
@@ -11732,6 +11771,7 @@ var openapi_default = {
11732
11771
  enum: [
11733
11772
  "pti_card",
11734
11773
  "brivo_credential",
11774
+ "brivo_digital_credential",
11735
11775
  "hid_credential",
11736
11776
  "visionline_card",
11737
11777
  "salto_ks_credential",
@@ -12021,8 +12061,8 @@ var openapi_default = {
12021
12061
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
12022
12062
  properties: {
12023
12063
  access_method: {
12024
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
12025
- enum: ["code", "card", "mobile_key"],
12064
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
12065
+ enum: ["code", "card", "mobile_key", "cloud_key"],
12026
12066
  type: "string"
12027
12067
  },
12028
12068
  acs_credential_id: {
@@ -12122,6 +12162,7 @@ var openapi_default = {
12122
12162
  enum: [
12123
12163
  "pti_card",
12124
12164
  "brivo_credential",
12165
+ "brivo_digital_credential",
12125
12166
  "hid_credential",
12126
12167
  "visionline_card",
12127
12168
  "salto_ks_credential",
@@ -12605,8 +12646,8 @@ var openapi_default = {
12605
12646
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
12606
12647
  properties: {
12607
12648
  access_method: {
12608
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
12609
- enum: ["code", "card", "mobile_key"],
12649
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
12650
+ enum: ["code", "card", "mobile_key", "cloud_key"],
12610
12651
  type: "string"
12611
12652
  },
12612
12653
  acs_credential_id: {
@@ -12706,6 +12747,7 @@ var openapi_default = {
12706
12747
  enum: [
12707
12748
  "pti_card",
12708
12749
  "brivo_credential",
12750
+ "brivo_digital_credential",
12709
12751
  "hid_credential",
12710
12752
  "visionline_card",
12711
12753
  "salto_ks_credential",
@@ -12993,8 +13035,8 @@ var openapi_default = {
12993
13035
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
12994
13036
  properties: {
12995
13037
  access_method: {
12996
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
12997
- enum: ["code", "card", "mobile_key"],
13038
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
13039
+ enum: ["code", "card", "mobile_key", "cloud_key"],
12998
13040
  type: "string"
12999
13041
  },
13000
13042
  acs_credential_id: {
@@ -13094,6 +13136,7 @@ var openapi_default = {
13094
13136
  enum: [
13095
13137
  "pti_card",
13096
13138
  "brivo_credential",
13139
+ "brivo_digital_credential",
13097
13140
  "hid_credential",
13098
13141
  "visionline_card",
13099
13142
  "salto_ks_credential",
@@ -28108,8 +28151,8 @@ var openapi_default = {
28108
28151
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
28109
28152
  properties: {
28110
28153
  access_method: {
28111
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
28112
- enum: ["code", "card", "mobile_key"],
28154
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
28155
+ enum: ["code", "card", "mobile_key", "cloud_key"],
28113
28156
  type: "string"
28114
28157
  },
28115
28158
  acs_credential_id: { nullable: true, type: "string" },
@@ -28531,6 +28574,7 @@ var openapi_default = {
28531
28574
  enum: [
28532
28575
  "pti_card",
28533
28576
  "brivo_credential",
28577
+ "brivo_digital_credential",
28534
28578
  "hid_credential",
28535
28579
  "visionline_card",
28536
28580
  "salto_ks_credential",
@@ -31297,8 +31341,8 @@ var openapi_default = {
31297
31341
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
31298
31342
  properties: {
31299
31343
  access_method: {
31300
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
31301
- enum: ["code", "card", "mobile_key"],
31344
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
31345
+ enum: ["code", "card", "mobile_key", "cloud_key"],
31302
31346
  type: "string"
31303
31347
  },
31304
31348
  acs_credential_id: {
@@ -31395,6 +31439,7 @@ var openapi_default = {
31395
31439
  enum: [
31396
31440
  "pti_card",
31397
31441
  "brivo_credential",
31442
+ "brivo_digital_credential",
31398
31443
  "hid_credential",
31399
31444
  "visionline_card",
31400
31445
  "salto_ks_credential",
@@ -41348,6 +41393,36 @@ var openapi_default = {
41348
41393
  "warning_code"
41349
41394
  ],
41350
41395
  type: "object"
41396
+ },
41397
+ {
41398
+ description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
41399
+ properties: {
41400
+ created_at: {
41401
+ description: "Date and time at which Seam created the warning.",
41402
+ format: "date-time",
41403
+ type: "string"
41404
+ },
41405
+ message: {
41406
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
41407
+ type: "string"
41408
+ },
41409
+ original_access_method_id: {
41410
+ description: "ID of the original access method from which this backup access method was split, if applicable.",
41411
+ format: "uuid",
41412
+ type: "string"
41413
+ },
41414
+ warning_code: {
41415
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
41416
+ enum: ["pulled_backup_access_code"],
41417
+ type: "string"
41418
+ }
41419
+ },
41420
+ required: [
41421
+ "created_at",
41422
+ "message",
41423
+ "warning_code"
41424
+ ],
41425
+ type: "object"
41351
41426
  }
41352
41427
  ]
41353
41428
  },
@@ -41710,6 +41785,36 @@ var openapi_default = {
41710
41785
  "warning_code"
41711
41786
  ],
41712
41787
  type: "object"
41788
+ },
41789
+ {
41790
+ description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
41791
+ properties: {
41792
+ created_at: {
41793
+ description: "Date and time at which Seam created the warning.",
41794
+ format: "date-time",
41795
+ type: "string"
41796
+ },
41797
+ message: {
41798
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
41799
+ type: "string"
41800
+ },
41801
+ original_access_method_id: {
41802
+ description: "ID of the original access method from which this backup access method was split, if applicable.",
41803
+ format: "uuid",
41804
+ type: "string"
41805
+ },
41806
+ warning_code: {
41807
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
41808
+ enum: ["pulled_backup_access_code"],
41809
+ type: "string"
41810
+ }
41811
+ },
41812
+ required: [
41813
+ "created_at",
41814
+ "message",
41815
+ "warning_code"
41816
+ ],
41817
+ type: "object"
41713
41818
  }
41714
41819
  ]
41715
41820
  },
@@ -42100,6 +42205,36 @@ var openapi_default = {
42100
42205
  "warning_code"
42101
42206
  ],
42102
42207
  type: "object"
42208
+ },
42209
+ {
42210
+ description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
42211
+ properties: {
42212
+ created_at: {
42213
+ description: "Date and time at which Seam created the warning.",
42214
+ format: "date-time",
42215
+ type: "string"
42216
+ },
42217
+ message: {
42218
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
42219
+ type: "string"
42220
+ },
42221
+ original_access_method_id: {
42222
+ description: "ID of the original access method from which this backup access method was split, if applicable.",
42223
+ format: "uuid",
42224
+ type: "string"
42225
+ },
42226
+ warning_code: {
42227
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
42228
+ enum: ["pulled_backup_access_code"],
42229
+ type: "string"
42230
+ }
42231
+ },
42232
+ required: [
42233
+ "created_at",
42234
+ "message",
42235
+ "warning_code"
42236
+ ],
42237
+ type: "object"
42103
42238
  }
42104
42239
  ]
42105
42240
  },
@@ -42480,6 +42615,36 @@ var openapi_default = {
42480
42615
  "warning_code"
42481
42616
  ],
42482
42617
  type: "object"
42618
+ },
42619
+ {
42620
+ description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
42621
+ properties: {
42622
+ created_at: {
42623
+ description: "Date and time at which Seam created the warning.",
42624
+ format: "date-time",
42625
+ type: "string"
42626
+ },
42627
+ message: {
42628
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
42629
+ type: "string"
42630
+ },
42631
+ original_access_method_id: {
42632
+ description: "ID of the original access method from which this backup access method was split, if applicable.",
42633
+ format: "uuid",
42634
+ type: "string"
42635
+ },
42636
+ warning_code: {
42637
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
42638
+ enum: ["pulled_backup_access_code"],
42639
+ type: "string"
42640
+ }
42641
+ },
42642
+ required: [
42643
+ "created_at",
42644
+ "message",
42645
+ "warning_code"
42646
+ ],
42647
+ type: "object"
42483
42648
  }
42484
42649
  ]
42485
42650
  },
@@ -43916,8 +44081,8 @@ var openapi_default = {
43916
44081
  schema: {
43917
44082
  properties: {
43918
44083
  access_method: {
43919
- description: "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.",
43920
- enum: ["code", "card", "mobile_key"],
44084
+ description: "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
44085
+ enum: ["code", "card", "mobile_key", "cloud_key"],
43921
44086
  type: "string"
43922
44087
  },
43923
44088
  acs_system_id: {