@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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.747.0",
3
+ "version": "1.749.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -33,10 +33,28 @@ const updating_access_times_warning = common_access_method_warning
33
33
  'Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated.',
34
34
  )
35
35
 
36
+ const pulled_backup_access_code_warning = common_access_method_warning
37
+ .extend({
38
+ warning_code: z
39
+ .literal('pulled_backup_access_code')
40
+ .describe(warning_code_description),
41
+ original_access_method_id: z
42
+ .string()
43
+ .uuid()
44
+ .optional()
45
+ .describe(
46
+ 'ID of the original access method from which this backup access method was split, if applicable.',
47
+ ),
48
+ })
49
+ .describe(
50
+ '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.',
51
+ )
52
+
36
53
  const access_method_warning = z
37
54
  .discriminatedUnion('warning_code', [
38
55
  being_deleted,
39
56
  updating_access_times_warning,
57
+ pulled_backup_access_code_warning,
40
58
  ])
41
59
  .describe(
42
60
  'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
@@ -45,6 +63,9 @@ const access_method_warning = z
45
63
  const _access_method_warning_map = z.object({
46
64
  being_deleted: being_deleted.optional().nullable(),
47
65
  updating_access_times: updating_access_times_warning.optional().nullable(),
66
+ pulled_backup_access_code: pulled_backup_access_code_warning
67
+ .optional()
68
+ .nullable(),
48
69
  })
49
70
 
50
71
  export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
@@ -9,6 +9,7 @@ import {
9
9
  export const acs_credential_external_type = z.enum([
10
10
  'pti_card',
11
11
  'brivo_credential',
12
+ 'brivo_digital_credential',
12
13
  'hid_credential',
13
14
  'visionline_card',
14
15
  'salto_ks_credential',
@@ -23,6 +24,7 @@ export const acs_credential_access_method_type = z.enum([
23
24
  'code',
24
25
  'card',
25
26
  'mobile_key',
27
+ 'cloud_key',
26
28
  ])
27
29
 
28
30
  export type AcsCredentialExternalType = z.infer<
@@ -214,7 +216,7 @@ const common_acs_credential = z.object({
214
216
  'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
215
217
  ),
216
218
  access_method: acs_credential_access_method_type.describe(
217
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
219
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
218
220
  ),
219
221
  external_type: acs_credential_external_type
220
222
  .optional()
@@ -2654,6 +2654,37 @@ export default {
2654
2654
  required: ['created_at', 'message', 'warning_code'],
2655
2655
  type: 'object',
2656
2656
  },
2657
+ {
2658
+ description:
2659
+ '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.',
2660
+ properties: {
2661
+ created_at: {
2662
+ description:
2663
+ 'Date and time at which Seam created the warning.',
2664
+ format: 'date-time',
2665
+ type: 'string',
2666
+ },
2667
+ message: {
2668
+ description:
2669
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2670
+ type: 'string',
2671
+ },
2672
+ original_access_method_id: {
2673
+ description:
2674
+ 'ID of the original access method from which this backup access method was split, if applicable.',
2675
+ format: 'uuid',
2676
+ type: 'string',
2677
+ },
2678
+ warning_code: {
2679
+ description:
2680
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2681
+ enum: ['pulled_backup_access_code'],
2682
+ type: 'string',
2683
+ },
2684
+ },
2685
+ required: ['created_at', 'message', 'warning_code'],
2686
+ type: 'object',
2687
+ },
2657
2688
  ],
2658
2689
  },
2659
2690
  type: 'array',
@@ -3215,8 +3246,8 @@ export default {
3215
3246
  properties: {
3216
3247
  access_method: {
3217
3248
  description:
3218
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
3219
- enum: ['code', 'card', 'mobile_key'],
3249
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
3250
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
3220
3251
  type: 'string',
3221
3252
  },
3222
3253
  acs_credential_id: {
@@ -3329,6 +3360,7 @@ export default {
3329
3360
  enum: [
3330
3361
  'pti_card',
3331
3362
  'brivo_credential',
3363
+ 'brivo_digital_credential',
3332
3364
  'hid_credential',
3333
3365
  'visionline_card',
3334
3366
  'salto_ks_credential',
@@ -5776,8 +5808,8 @@ export default {
5776
5808
  properties: {
5777
5809
  access_method: {
5778
5810
  description:
5779
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5780
- enum: ['code', 'card', 'mobile_key'],
5811
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
5812
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
5781
5813
  type: 'string',
5782
5814
  },
5783
5815
  acs_credential_id: {
@@ -5895,6 +5927,7 @@ export default {
5895
5927
  enum: [
5896
5928
  'pti_card',
5897
5929
  'brivo_credential',
5930
+ 'brivo_digital_credential',
5898
5931
  'hid_credential',
5899
5932
  'visionline_card',
5900
5933
  'salto_ks_credential',
@@ -6232,8 +6265,8 @@ export default {
6232
6265
  properties: {
6233
6266
  access_method: {
6234
6267
  description:
6235
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6236
- enum: ['code', 'card', 'mobile_key'],
6268
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
6269
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6237
6270
  type: 'string',
6238
6271
  },
6239
6272
  acs_credential_id: {
@@ -6351,6 +6384,7 @@ export default {
6351
6384
  enum: [
6352
6385
  'pti_card',
6353
6386
  'brivo_credential',
6387
+ 'brivo_digital_credential',
6354
6388
  'hid_credential',
6355
6389
  'visionline_card',
6356
6390
  'salto_ks_credential',
@@ -6907,8 +6941,8 @@ export default {
6907
6941
  properties: {
6908
6942
  access_method: {
6909
6943
  description:
6910
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6911
- enum: ['code', 'card', 'mobile_key'],
6944
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
6945
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6912
6946
  type: 'string',
6913
6947
  },
6914
6948
  acs_credential_id: {
@@ -7025,6 +7059,7 @@ export default {
7025
7059
  enum: [
7026
7060
  'pti_card',
7027
7061
  'brivo_credential',
7062
+ 'brivo_digital_credential',
7028
7063
  'hid_credential',
7029
7064
  'visionline_card',
7030
7065
  'salto_ks_credential',
@@ -7360,8 +7395,8 @@ export default {
7360
7395
  properties: {
7361
7396
  access_method: {
7362
7397
  description:
7363
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
7364
- enum: ['code', 'card', 'mobile_key'],
7398
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
7399
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
7365
7400
  type: 'string',
7366
7401
  },
7367
7402
  acs_credential_id: {
@@ -7478,6 +7513,7 @@ export default {
7478
7513
  enum: [
7479
7514
  'pti_card',
7480
7515
  'brivo_credential',
7516
+ 'brivo_digital_credential',
7481
7517
  'hid_credential',
7482
7518
  'visionline_card',
7483
7519
  'salto_ks_credential',
@@ -23954,8 +23990,8 @@ export default {
23954
23990
  properties: {
23955
23991
  access_method: {
23956
23992
  description:
23957
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
23958
- enum: ['code', 'card', 'mobile_key'],
23993
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
23994
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
23959
23995
  type: 'string',
23960
23996
  },
23961
23997
  acs_credential_id: { nullable: true, type: 'string' },
@@ -24449,6 +24485,7 @@ export default {
24449
24485
  enum: [
24450
24486
  'pti_card',
24451
24487
  'brivo_credential',
24488
+ 'brivo_digital_credential',
24452
24489
  'hid_credential',
24453
24490
  'visionline_card',
24454
24491
  'salto_ks_credential',
@@ -27598,8 +27635,8 @@ export default {
27598
27635
  properties: {
27599
27636
  access_method: {
27600
27637
  description:
27601
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
27602
- enum: ['code', 'card', 'mobile_key'],
27638
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
27639
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
27603
27640
  type: 'string',
27604
27641
  },
27605
27642
  acs_credential_id: {
@@ -27712,6 +27749,7 @@ export default {
27712
27749
  enum: [
27713
27750
  'pti_card',
27714
27751
  'brivo_credential',
27752
+ 'brivo_digital_credential',
27715
27753
  'hid_credential',
27716
27754
  'visionline_card',
27717
27755
  'salto_ks_credential',
@@ -38638,6 +38676,41 @@ export default {
38638
38676
  ],
38639
38677
  type: 'object',
38640
38678
  },
38679
+ {
38680
+ description:
38681
+ '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.',
38682
+ properties: {
38683
+ created_at: {
38684
+ description:
38685
+ 'Date and time at which Seam created the warning.',
38686
+ format: 'date-time',
38687
+ type: 'string',
38688
+ },
38689
+ message: {
38690
+ description:
38691
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
38692
+ type: 'string',
38693
+ },
38694
+ original_access_method_id: {
38695
+ description:
38696
+ 'ID of the original access method from which this backup access method was split, if applicable.',
38697
+ format: 'uuid',
38698
+ type: 'string',
38699
+ },
38700
+ warning_code: {
38701
+ description:
38702
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
38703
+ enum: ['pulled_backup_access_code'],
38704
+ type: 'string',
38705
+ },
38706
+ },
38707
+ required: [
38708
+ 'created_at',
38709
+ 'message',
38710
+ 'warning_code',
38711
+ ],
38712
+ type: 'object',
38713
+ },
38641
38714
  ],
38642
38715
  },
38643
38716
  type: 'array',
@@ -39043,6 +39116,41 @@ export default {
39043
39116
  ],
39044
39117
  type: 'object',
39045
39118
  },
39119
+ {
39120
+ description:
39121
+ '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.',
39122
+ properties: {
39123
+ created_at: {
39124
+ description:
39125
+ 'Date and time at which Seam created the warning.',
39126
+ format: 'date-time',
39127
+ type: 'string',
39128
+ },
39129
+ message: {
39130
+ description:
39131
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
39132
+ type: 'string',
39133
+ },
39134
+ original_access_method_id: {
39135
+ description:
39136
+ 'ID of the original access method from which this backup access method was split, if applicable.',
39137
+ format: 'uuid',
39138
+ type: 'string',
39139
+ },
39140
+ warning_code: {
39141
+ description:
39142
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
39143
+ enum: ['pulled_backup_access_code'],
39144
+ type: 'string',
39145
+ },
39146
+ },
39147
+ required: [
39148
+ 'created_at',
39149
+ 'message',
39150
+ 'warning_code',
39151
+ ],
39152
+ type: 'object',
39153
+ },
39046
39154
  ],
39047
39155
  },
39048
39156
  type: 'array',
@@ -39481,6 +39589,41 @@ export default {
39481
39589
  ],
39482
39590
  type: 'object',
39483
39591
  },
39592
+ {
39593
+ description:
39594
+ '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.',
39595
+ properties: {
39596
+ created_at: {
39597
+ description:
39598
+ 'Date and time at which Seam created the warning.',
39599
+ format: 'date-time',
39600
+ type: 'string',
39601
+ },
39602
+ message: {
39603
+ description:
39604
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
39605
+ type: 'string',
39606
+ },
39607
+ original_access_method_id: {
39608
+ description:
39609
+ 'ID of the original access method from which this backup access method was split, if applicable.',
39610
+ format: 'uuid',
39611
+ type: 'string',
39612
+ },
39613
+ warning_code: {
39614
+ description:
39615
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
39616
+ enum: ['pulled_backup_access_code'],
39617
+ type: 'string',
39618
+ },
39619
+ },
39620
+ required: [
39621
+ 'created_at',
39622
+ 'message',
39623
+ 'warning_code',
39624
+ ],
39625
+ type: 'object',
39626
+ },
39484
39627
  ],
39485
39628
  },
39486
39629
  type: 'array',
@@ -39909,6 +40052,41 @@ export default {
39909
40052
  ],
39910
40053
  type: 'object',
39911
40054
  },
40055
+ {
40056
+ description:
40057
+ '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.',
40058
+ properties: {
40059
+ created_at: {
40060
+ description:
40061
+ 'Date and time at which Seam created the warning.',
40062
+ format: 'date-time',
40063
+ type: 'string',
40064
+ },
40065
+ message: {
40066
+ description:
40067
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
40068
+ type: 'string',
40069
+ },
40070
+ original_access_method_id: {
40071
+ description:
40072
+ 'ID of the original access method from which this backup access method was split, if applicable.',
40073
+ format: 'uuid',
40074
+ type: 'string',
40075
+ },
40076
+ warning_code: {
40077
+ description:
40078
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
40079
+ enum: ['pulled_backup_access_code'],
40080
+ type: 'string',
40081
+ },
40082
+ },
40083
+ required: [
40084
+ 'created_at',
40085
+ 'message',
40086
+ 'warning_code',
40087
+ ],
40088
+ type: 'object',
40089
+ },
39912
40090
  ],
39913
40091
  },
39914
40092
  type: 'array',
@@ -41420,8 +41598,8 @@ export default {
41420
41598
  properties: {
41421
41599
  access_method: {
41422
41600
  description:
41423
- 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
41424
- enum: ['code', 'card', 'mobile_key'],
41601
+ 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
41602
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
41425
41603
  type: 'string',
41426
41604
  },
41427
41605
  acs_system_id: {