@seamapi/types 1.328.0 → 1.329.1

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.1",
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
@@ -599,26 +599,31 @@ export const temperature_reached_set_point_event = device_event.extend({
599
599
  event_type: z.literal('thermostat.temperature_reached_set_point'),
600
600
  temperature_celsius: z
601
601
  .number()
602
- .describe('Temperature, in °C, reported by the thermostat.'),
602
+ .describe(
603
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
604
+ ),
603
605
  temperature_fahrenheit: z
604
606
  .number()
605
- .describe('Temperature, in °F, reported by the thermostat.'),
607
+ .describe(
608
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
609
+ ),
606
610
  desired_temperature_celsius: z
607
611
  .number()
608
612
  .optional()
609
613
  .describe(
610
- "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
614
+ "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
611
615
  ),
612
616
  desired_temperature_fahrenheit: z
613
617
  .number()
614
618
  .optional()
615
619
  .describe(
616
- "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
620
+ "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
617
621
  ),
618
622
  }).describe(`
619
623
  ---
620
624
  route_path: /thermostats
621
625
  ---
626
+ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
622
627
  `)
623
628
 
624
629
  export type TemperatureReachedSetPointEvent = z.infer<
@@ -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.',
@@ -10361,6 +10553,8 @@ export default {
10361
10553
  'x-route-path': '/thermostats',
10362
10554
  },
10363
10555
  {
10556
+ description:
10557
+ "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10364
10558
  properties: {
10365
10559
  connected_account_id: {
10366
10560
  description:
@@ -10375,13 +10569,13 @@ export default {
10375
10569
  },
10376
10570
  desired_temperature_celsius: {
10377
10571
  description:
10378
- "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
10572
+ "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10379
10573
  format: 'float',
10380
10574
  type: 'number',
10381
10575
  },
10382
10576
  desired_temperature_fahrenheit: {
10383
10577
  description:
10384
- "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
10578
+ "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10385
10579
  format: 'float',
10386
10580
  type: 'number',
10387
10581
  },
@@ -10405,12 +10599,14 @@ export default {
10405
10599
  type: 'string',
10406
10600
  },
10407
10601
  temperature_celsius: {
10408
- description: 'Temperature, in °C, reported by the thermostat.',
10602
+ description:
10603
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
10409
10604
  format: 'float',
10410
10605
  type: 'number',
10411
10606
  },
10412
10607
  temperature_fahrenheit: {
10413
- description: 'Temperature, in °F, reported by the thermostat.',
10608
+ description:
10609
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
10414
10610
  format: 'float',
10415
10611
  type: 'number',
10416
10612
  },
@@ -15210,6 +15406,35 @@ export default {
15210
15406
  ],
15211
15407
  type: 'object',
15212
15408
  },
15409
+ {
15410
+ description:
15411
+ '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.',
15412
+ properties: {
15413
+ created_at: {
15414
+ description:
15415
+ 'Date and time at which Seam created the warning.',
15416
+ format: 'date-time',
15417
+ type: 'string',
15418
+ },
15419
+ message: {
15420
+ description:
15421
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
15422
+ type: 'string',
15423
+ },
15424
+ warning_code: {
15425
+ description:
15426
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
15427
+ enum: ['needs_to_be_reissued'],
15428
+ type: 'string',
15429
+ },
15430
+ },
15431
+ required: [
15432
+ 'created_at',
15433
+ 'message',
15434
+ 'warning_code',
15435
+ ],
15436
+ type: 'object',
15437
+ },
15213
15438
  ],
15214
15439
  },
15215
15440
  type: 'array',
@@ -15644,6 +15869,35 @@ export default {
15644
15869
  ],
15645
15870
  type: 'object',
15646
15871
  },
15872
+ {
15873
+ description:
15874
+ '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.',
15875
+ properties: {
15876
+ created_at: {
15877
+ description:
15878
+ 'Date and time at which Seam created the warning.',
15879
+ format: 'date-time',
15880
+ type: 'string',
15881
+ },
15882
+ message: {
15883
+ description:
15884
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
15885
+ type: 'string',
15886
+ },
15887
+ warning_code: {
15888
+ description:
15889
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
15890
+ enum: ['needs_to_be_reissued'],
15891
+ type: 'string',
15892
+ },
15893
+ },
15894
+ required: [
15895
+ 'created_at',
15896
+ 'message',
15897
+ 'warning_code',
15898
+ ],
15899
+ type: 'object',
15900
+ },
15647
15901
  ],
15648
15902
  },
15649
15903
  type: 'array',
@@ -20855,6 +21109,7 @@ export default {
20855
21109
  'acs_user.deleted',
20856
21110
  'acs_credential.deleted',
20857
21111
  'acs_credential.issued',
21112
+ 'acs_credential.reissued',
20858
21113
  'acs_encoder.added',
20859
21114
  'acs_encoder.removed',
20860
21115
  'enrollment_automation.deleted',
@@ -20934,6 +21189,7 @@ export default {
20934
21189
  'acs_user.deleted',
20935
21190
  'acs_credential.deleted',
20936
21191
  'acs_credential.issued',
21192
+ 'acs_credential.reissued',
20937
21193
  'acs_encoder.added',
20938
21194
  'acs_encoder.removed',
20939
21195
  'enrollment_automation.deleted',