@seamapi/types 1.328.0 → 1.329.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.328.0",
3
+ "version": "1.329.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -81,6 +81,16 @@ export const unknown_issue_with_acs_credential = common_acs_credential_warning
81
81
  'This issue may affect the proper functioning of this credential.',
82
82
  )
83
83
 
84
+ const needs_to_be_reissued = common_acs_credential_warning
85
+ .extend({
86
+ warning_code: z
87
+ .literal('needs_to_be_reissued')
88
+ .describe(warning_code_description),
89
+ })
90
+ .describe(
91
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
92
+ )
93
+
84
94
  const acs_credential_warning = z
85
95
  .union([
86
96
  waiting_to_be_issued,
@@ -88,6 +98,7 @@ const acs_credential_warning = z
88
98
  schedule_modified,
89
99
  being_deleted,
90
100
  unknown_issue_with_acs_credential,
101
+ needs_to_be_reissued,
91
102
  ])
92
103
  .describe('Warning associated with the `acs_credential`.')
93
104
 
@@ -101,6 +112,7 @@ const acs_credential_warning_map = z.object({
101
112
  unknown_issue_with_acs_credential: unknown_issue_with_acs_credential
102
113
  .optional()
103
114
  .nullable(),
115
+ needs_to_be_reissued: needs_to_be_reissued.optional().nullable(),
104
116
  })
105
117
 
106
118
  export type AcsCredentialWarningMap = z.infer<typeof acs_credential_warning_map>
@@ -28,7 +28,16 @@ export const acs_credential_issued = acs_credential_event.extend({
28
28
  An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.
29
29
  `)
30
30
 
31
+ export const acs_credential_reissued = acs_credential_event
32
+ .extend({
33
+ event_type: z.literal('acs_credential.reissued'),
34
+ })
35
+ .describe(
36
+ 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was reissued.',
37
+ )
38
+
31
39
  export const acs_credential_events = [
32
40
  acs_credential_deleted_event,
33
41
  acs_credential_issued,
42
+ acs_credential_reissued,
34
43
  ] as const
@@ -757,6 +757,31 @@ export default {
757
757
  required: ['created_at', 'message', 'warning_code'],
758
758
  type: 'object',
759
759
  },
760
+ {
761
+ description:
762
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
763
+ properties: {
764
+ created_at: {
765
+ description:
766
+ 'Date and time at which Seam created the warning.',
767
+ format: 'date-time',
768
+ type: 'string',
769
+ },
770
+ message: {
771
+ description:
772
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
773
+ type: 'string',
774
+ },
775
+ warning_code: {
776
+ description:
777
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
778
+ enum: ['needs_to_be_reissued'],
779
+ type: 'string',
780
+ },
781
+ },
782
+ required: ['created_at', 'message', 'warning_code'],
783
+ type: 'object',
784
+ },
760
785
  ],
761
786
  },
762
787
  type: 'array',
@@ -2246,6 +2271,35 @@ export default {
2246
2271
  ],
2247
2272
  type: 'object',
2248
2273
  },
2274
+ {
2275
+ description:
2276
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
2277
+ properties: {
2278
+ created_at: {
2279
+ description:
2280
+ 'Date and time at which Seam created the warning.',
2281
+ format: 'date-time',
2282
+ type: 'string',
2283
+ },
2284
+ message: {
2285
+ description:
2286
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2287
+ type: 'string',
2288
+ },
2289
+ warning_code: {
2290
+ description:
2291
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2292
+ enum: ['needs_to_be_reissued'],
2293
+ type: 'string',
2294
+ },
2295
+ },
2296
+ required: [
2297
+ 'created_at',
2298
+ 'message',
2299
+ 'warning_code',
2300
+ ],
2301
+ type: 'object',
2302
+ },
2249
2303
  ],
2250
2304
  },
2251
2305
  type: 'array',
@@ -2577,6 +2631,35 @@ export default {
2577
2631
  ],
2578
2632
  type: 'object',
2579
2633
  },
2634
+ {
2635
+ description:
2636
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
2637
+ properties: {
2638
+ created_at: {
2639
+ description:
2640
+ 'Date and time at which Seam created the warning.',
2641
+ format: 'date-time',
2642
+ type: 'string',
2643
+ },
2644
+ message: {
2645
+ description:
2646
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2647
+ type: 'string',
2648
+ },
2649
+ warning_code: {
2650
+ description:
2651
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2652
+ enum: ['needs_to_be_reissued'],
2653
+ type: 'string',
2654
+ },
2655
+ },
2656
+ required: [
2657
+ 'created_at',
2658
+ 'message',
2659
+ 'warning_code',
2660
+ ],
2661
+ type: 'object',
2662
+ },
2580
2663
  ],
2581
2664
  },
2582
2665
  type: 'array',
@@ -3039,6 +3122,35 @@ export default {
3039
3122
  ],
3040
3123
  type: 'object',
3041
3124
  },
3125
+ {
3126
+ description:
3127
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
3128
+ properties: {
3129
+ created_at: {
3130
+ description:
3131
+ 'Date and time at which Seam created the warning.',
3132
+ format: 'date-time',
3133
+ type: 'string',
3134
+ },
3135
+ message: {
3136
+ description:
3137
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
3138
+ type: 'string',
3139
+ },
3140
+ warning_code: {
3141
+ description:
3142
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
3143
+ enum: ['needs_to_be_reissued'],
3144
+ type: 'string',
3145
+ },
3146
+ },
3147
+ required: [
3148
+ 'created_at',
3149
+ 'message',
3150
+ 'warning_code',
3151
+ ],
3152
+ type: 'object',
3153
+ },
3042
3154
  ],
3043
3155
  },
3044
3156
  type: 'array',
@@ -3367,6 +3479,35 @@ export default {
3367
3479
  ],
3368
3480
  type: 'object',
3369
3481
  },
3482
+ {
3483
+ description:
3484
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
3485
+ properties: {
3486
+ created_at: {
3487
+ description:
3488
+ 'Date and time at which Seam created the warning.',
3489
+ format: 'date-time',
3490
+ type: 'string',
3491
+ },
3492
+ message: {
3493
+ description:
3494
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
3495
+ type: 'string',
3496
+ },
3497
+ warning_code: {
3498
+ description:
3499
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
3500
+ enum: ['needs_to_be_reissued'],
3501
+ type: 'string',
3502
+ },
3503
+ },
3504
+ required: [
3505
+ 'created_at',
3506
+ 'message',
3507
+ 'warning_code',
3508
+ ],
3509
+ type: 'object',
3510
+ },
3370
3511
  ],
3371
3512
  },
3372
3513
  type: 'array',
@@ -7599,6 +7740,57 @@ export default {
7599
7740
  type: 'object',
7600
7741
  'x-route-path': '/acs/credentials',
7601
7742
  },
7743
+ {
7744
+ description:
7745
+ 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was reissued.',
7746
+ properties: {
7747
+ acs_credential_id: { format: 'uuid', type: 'string' },
7748
+ acs_system_id: {
7749
+ description:
7750
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7751
+ format: 'uuid',
7752
+ type: 'string',
7753
+ },
7754
+ connected_account_id: {
7755
+ description:
7756
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7757
+ format: 'uuid',
7758
+ type: 'string',
7759
+ },
7760
+ created_at: {
7761
+ description: 'Date and time at which the event was created.',
7762
+ format: 'date-time',
7763
+ type: 'string',
7764
+ },
7765
+ event_id: {
7766
+ description: 'ID of the event.',
7767
+ format: 'uuid',
7768
+ type: 'string',
7769
+ },
7770
+ event_type: { enum: ['acs_credential.reissued'], type: 'string' },
7771
+ occurred_at: {
7772
+ description: 'Date and time at which the event occurred.',
7773
+ format: 'date-time',
7774
+ type: 'string',
7775
+ },
7776
+ workspace_id: {
7777
+ description:
7778
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7779
+ format: 'uuid',
7780
+ type: 'string',
7781
+ },
7782
+ },
7783
+ required: [
7784
+ 'event_id',
7785
+ 'workspace_id',
7786
+ 'created_at',
7787
+ 'occurred_at',
7788
+ 'acs_system_id',
7789
+ 'acs_credential_id',
7790
+ 'event_type',
7791
+ ],
7792
+ type: 'object',
7793
+ },
7602
7794
  {
7603
7795
  description:
7604
7796
  'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
@@ -15210,6 +15402,35 @@ export default {
15210
15402
  ],
15211
15403
  type: 'object',
15212
15404
  },
15405
+ {
15406
+ description:
15407
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
15408
+ properties: {
15409
+ created_at: {
15410
+ description:
15411
+ 'Date and time at which Seam created the warning.',
15412
+ format: 'date-time',
15413
+ type: 'string',
15414
+ },
15415
+ message: {
15416
+ description:
15417
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
15418
+ type: 'string',
15419
+ },
15420
+ warning_code: {
15421
+ description:
15422
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
15423
+ enum: ['needs_to_be_reissued'],
15424
+ type: 'string',
15425
+ },
15426
+ },
15427
+ required: [
15428
+ 'created_at',
15429
+ 'message',
15430
+ 'warning_code',
15431
+ ],
15432
+ type: 'object',
15433
+ },
15213
15434
  ],
15214
15435
  },
15215
15436
  type: 'array',
@@ -15644,6 +15865,35 @@ export default {
15644
15865
  ],
15645
15866
  type: 'object',
15646
15867
  },
15868
+ {
15869
+ description:
15870
+ 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
15871
+ properties: {
15872
+ created_at: {
15873
+ description:
15874
+ 'Date and time at which Seam created the warning.',
15875
+ format: 'date-time',
15876
+ type: 'string',
15877
+ },
15878
+ message: {
15879
+ description:
15880
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
15881
+ type: 'string',
15882
+ },
15883
+ warning_code: {
15884
+ description:
15885
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
15886
+ enum: ['needs_to_be_reissued'],
15887
+ type: 'string',
15888
+ },
15889
+ },
15890
+ required: [
15891
+ 'created_at',
15892
+ 'message',
15893
+ 'warning_code',
15894
+ ],
15895
+ type: 'object',
15896
+ },
15647
15897
  ],
15648
15898
  },
15649
15899
  type: 'array',
@@ -20855,6 +21105,7 @@ export default {
20855
21105
  'acs_user.deleted',
20856
21106
  'acs_credential.deleted',
20857
21107
  'acs_credential.issued',
21108
+ 'acs_credential.reissued',
20858
21109
  'acs_encoder.added',
20859
21110
  'acs_encoder.removed',
20860
21111
  'enrollment_automation.deleted',
@@ -20934,6 +21185,7 @@ export default {
20934
21185
  'acs_user.deleted',
20935
21186
  'acs_credential.deleted',
20936
21187
  'acs_credential.issued',
21188
+ 'acs_credential.reissued',
20937
21189
  'acs_encoder.added',
20938
21190
  'acs_encoder.removed',
20939
21191
  'enrollment_automation.deleted',