@seamapi/types 1.236.0 → 1.237.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.
@@ -2245,7 +2245,16 @@ export interface Routes {
2245
2245
  created_at: string;
2246
2246
  message: string;
2247
2247
  warning_code: 'being_deleted';
2248
+ } | {
2249
+ created_at: string;
2250
+ message: string;
2251
+ warning_code: 'salto_ks_user_not_subscribed';
2252
+ } | {
2253
+ created_at: string;
2254
+ message: string;
2255
+ warning_code: 'salto_site_user_suspended';
2248
2256
  }>;
2257
+ errors?: any;
2249
2258
  full_name?: string | undefined;
2250
2259
  /**
2251
2260
  * @deprecated use email_address. */
@@ -3295,7 +3304,16 @@ export interface Routes {
3295
3304
  created_at: string;
3296
3305
  message: string;
3297
3306
  warning_code: 'being_deleted';
3307
+ } | {
3308
+ created_at: string;
3309
+ message: string;
3310
+ warning_code: 'salto_ks_user_not_subscribed';
3311
+ } | {
3312
+ created_at: string;
3313
+ message: string;
3314
+ warning_code: 'salto_site_user_suspended';
3298
3315
  }>;
3316
+ errors?: any;
3299
3317
  full_name?: string | undefined;
3300
3318
  /**
3301
3319
  * @deprecated use email_address. */
@@ -3351,7 +3369,16 @@ export interface Routes {
3351
3369
  created_at: string;
3352
3370
  message: string;
3353
3371
  warning_code: 'being_deleted';
3372
+ } | {
3373
+ created_at: string;
3374
+ message: string;
3375
+ warning_code: 'salto_ks_user_not_subscribed';
3376
+ } | {
3377
+ created_at: string;
3378
+ message: string;
3379
+ warning_code: 'salto_site_user_suspended';
3354
3380
  }>;
3381
+ errors?: any;
3355
3382
  full_name?: string | undefined;
3356
3383
  /**
3357
3384
  * @deprecated use email_address. */
@@ -3401,7 +3428,16 @@ export interface Routes {
3401
3428
  created_at: string;
3402
3429
  message: string;
3403
3430
  warning_code: 'being_deleted';
3431
+ } | {
3432
+ created_at: string;
3433
+ message: string;
3434
+ warning_code: 'salto_ks_user_not_subscribed';
3435
+ } | {
3436
+ created_at: string;
3437
+ message: string;
3438
+ warning_code: 'salto_site_user_suspended';
3404
3439
  }>;
3440
+ errors?: any;
3405
3441
  full_name?: string | undefined;
3406
3442
  /**
3407
3443
  * @deprecated use email_address. */
@@ -3516,7 +3552,16 @@ export interface Routes {
3516
3552
  created_at: string;
3517
3553
  message: string;
3518
3554
  warning_code: 'being_deleted';
3555
+ } | {
3556
+ created_at: string;
3557
+ message: string;
3558
+ warning_code: 'salto_ks_user_not_subscribed';
3559
+ } | {
3560
+ created_at: string;
3561
+ message: string;
3562
+ warning_code: 'salto_site_user_suspended';
3519
3563
  }>;
3564
+ errors?: any;
3520
3565
  full_name?: string | undefined;
3521
3566
  /**
3522
3567
  * @deprecated use email_address. */
@@ -3565,7 +3610,16 @@ export interface Routes {
3565
3610
  created_at: string;
3566
3611
  message: string;
3567
3612
  warning_code: 'being_deleted';
3613
+ } | {
3614
+ created_at: string;
3615
+ message: string;
3616
+ warning_code: 'salto_ks_user_not_subscribed';
3617
+ } | {
3618
+ created_at: string;
3619
+ message: string;
3620
+ warning_code: 'salto_site_user_suspended';
3568
3621
  }>;
3622
+ errors?: any;
3569
3623
  full_name?: string | undefined;
3570
3624
  /**
3571
3625
  * @deprecated use email_address. */
@@ -14547,7 +14601,16 @@ export interface Routes {
14547
14601
  created_at: string;
14548
14602
  message: string;
14549
14603
  warning_code: 'being_deleted';
14604
+ } | {
14605
+ created_at: string;
14606
+ message: string;
14607
+ warning_code: 'salto_ks_user_not_subscribed';
14608
+ } | {
14609
+ created_at: string;
14610
+ message: string;
14611
+ warning_code: 'salto_site_user_suspended';
14550
14612
  }>;
14613
+ errors?: any;
14551
14614
  full_name?: string | undefined;
14552
14615
  /**
14553
14616
  * @deprecated use email_address. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.236.0",
3
+ "version": "1.237.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.21.4"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.14.0",
95
+ "@seamapi/blueprint": "^0.16.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -22,15 +22,30 @@ const acs_users_being_deleted = common_acs_users_warning.extend({
22
22
  warning_code: z.literal('being_deleted'),
23
23
  })
24
24
 
25
+ const acs_users_salto_ks_user_not_subscribed = common_acs_users_warning.extend({
26
+ warning_code: z.literal('salto_ks_user_not_subscribed'),
27
+ })
28
+
29
+ // TODO: Some acs_users already have this warning, so we need to keep it here until we migrate
30
+ const acs_users_salto_site_user_suspended = common_acs_users_warning.extend({
31
+ warning_code: z.literal('salto_site_user_suspended'),
32
+ })
33
+
25
34
  export const acs_users_warning_map = z.object({
26
35
  being_deleted: acs_users_being_deleted.optional().nullable(),
36
+ salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
37
+ .optional()
38
+ .nullable(),
39
+ salto_site_user_suspended: acs_users_salto_site_user_suspended
40
+ .optional()
41
+ .nullable(),
27
42
  })
28
43
 
29
- export const acs_users_warning =
30
- // TODO: once we have more than one warning we should use z.union
31
- // z.union([
32
- acs_users_being_deleted
33
- // ])
44
+ export const acs_users_warning = z.union([
45
+ acs_users_being_deleted,
46
+ acs_users_salto_ks_user_not_subscribed,
47
+ acs_users_salto_site_user_suspended,
48
+ ])
34
49
 
35
50
  export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
36
51
 
@@ -67,6 +82,7 @@ const common_acs_user = z
67
82
  .optional(),
68
83
  is_latest_desired_state_synced_with_provider: z.boolean().optional(),
69
84
  warnings: z.array(acs_users_warning),
85
+ errors: z.any(),
70
86
  })
71
87
  .merge(user_fields)
72
88
 
@@ -695,6 +695,7 @@ export default {
695
695
  'x-deprecated': 'use email_address.',
696
696
  },
697
697
  email_address: { format: 'email', type: 'string' },
698
+ errors: {},
698
699
  external_type: {
699
700
  enum: [
700
701
  'pti_user',
@@ -722,13 +723,41 @@ export default {
722
723
  user_identity_phone_number: { nullable: true, type: 'string' },
723
724
  warnings: {
724
725
  items: {
725
- properties: {
726
- created_at: { format: 'date-time', type: 'string' },
727
- message: { type: 'string' },
728
- warning_code: { enum: ['being_deleted'], type: 'string' },
729
- },
730
- required: ['created_at', 'message', 'warning_code'],
731
- type: 'object',
726
+ oneOf: [
727
+ {
728
+ properties: {
729
+ created_at: { format: 'date-time', type: 'string' },
730
+ message: { type: 'string' },
731
+ warning_code: { enum: ['being_deleted'], type: 'string' },
732
+ },
733
+ required: ['created_at', 'message', 'warning_code'],
734
+ type: 'object',
735
+ },
736
+ {
737
+ properties: {
738
+ created_at: { format: 'date-time', type: 'string' },
739
+ message: { type: 'string' },
740
+ warning_code: {
741
+ enum: ['salto_ks_user_not_subscribed'],
742
+ type: 'string',
743
+ },
744
+ },
745
+ required: ['created_at', 'message', 'warning_code'],
746
+ type: 'object',
747
+ },
748
+ {
749
+ properties: {
750
+ created_at: { format: 'date-time', type: 'string' },
751
+ message: { type: 'string' },
752
+ warning_code: {
753
+ enum: ['salto_site_user_suspended'],
754
+ type: 'string',
755
+ },
756
+ },
757
+ required: ['created_at', 'message', 'warning_code'],
758
+ type: 'object',
759
+ },
760
+ ],
732
761
  },
733
762
  type: 'array',
734
763
  },
@@ -7630,6 +7659,7 @@ export default {
7630
7659
  'x-deprecated': 'use email_address.',
7631
7660
  },
7632
7661
  email_address: { format: 'email', type: 'string' },
7662
+ errors: { $ref: '#/components/schemas/access_code' },
7633
7663
  external_type: {
7634
7664
  enum: [
7635
7665
  'pti_user',
@@ -7668,19 +7698,65 @@ export default {
7668
7698
  },
7669
7699
  warnings: {
7670
7700
  items: {
7671
- properties: {
7672
- created_at: {
7673
- format: 'date-time',
7674
- type: 'string',
7701
+ oneOf: [
7702
+ {
7703
+ properties: {
7704
+ created_at: {
7705
+ format: 'date-time',
7706
+ type: 'string',
7707
+ },
7708
+ message: { type: 'string' },
7709
+ warning_code: {
7710
+ enum: ['being_deleted'],
7711
+ type: 'string',
7712
+ },
7713
+ },
7714
+ required: [
7715
+ 'created_at',
7716
+ 'message',
7717
+ 'warning_code',
7718
+ ],
7719
+ type: 'object',
7675
7720
  },
7676
- message: { type: 'string' },
7677
- warning_code: {
7678
- enum: ['being_deleted'],
7679
- type: 'string',
7721
+ {
7722
+ properties: {
7723
+ created_at: {
7724
+ format: 'date-time',
7725
+ type: 'string',
7726
+ },
7727
+ message: { type: 'string' },
7728
+ warning_code: {
7729
+ enum: ['salto_ks_user_not_subscribed'],
7730
+ type: 'string',
7731
+ },
7732
+ },
7733
+ required: [
7734
+ 'created_at',
7735
+ 'message',
7736
+ 'warning_code',
7737
+ ],
7738
+ type: 'object',
7680
7739
  },
7681
- },
7682
- required: ['created_at', 'message', 'warning_code'],
7683
- type: 'object',
7740
+ {
7741
+ properties: {
7742
+ created_at: {
7743
+ format: 'date-time',
7744
+ type: 'string',
7745
+ },
7746
+ message: { type: 'string' },
7747
+ warning_code: {
7748
+ enum: ['salto_site_user_suspended'],
7749
+ type: 'string',
7750
+ },
7751
+ },
7752
+ required: [
7753
+ 'created_at',
7754
+ 'message',
7755
+ 'warning_code',
7756
+ ],
7757
+ type: 'object',
7758
+ },
7759
+ ],
7684
7760
  },
7685
7761
  type: 'array',
7686
7762
  },
@@ -7772,6 +7848,7 @@ export default {
7772
7848
  'x-deprecated': 'use email_address.',
7773
7849
  },
7774
7850
  email_address: { format: 'email', type: 'string' },
7851
+ errors: { $ref: '#/components/schemas/access_code' },
7775
7852
  external_type: {
7776
7853
  enum: [
7777
7854
  'pti_user',
@@ -7810,23 +7887,65 @@ export default {
7810
7887
  },
7811
7888
  warnings: {
7812
7889
  items: {
7813
- properties: {
7814
- created_at: {
7815
- format: 'date-time',
7816
- type: 'string',
7890
+ oneOf: [
7891
+ {
7892
+ properties: {
7893
+ created_at: {
7894
+ format: 'date-time',
7895
+ type: 'string',
7896
+ },
7897
+ message: { type: 'string' },
7898
+ warning_code: {
7899
+ enum: ['being_deleted'],
7900
+ type: 'string',
7901
+ },
7902
+ },
7903
+ required: [
7904
+ 'created_at',
7905
+ 'message',
7906
+ 'warning_code',
7907
+ ],
7908
+ type: 'object',
7817
7909
  },
7818
- message: { type: 'string' },
7819
- warning_code: {
7820
- enum: ['being_deleted'],
7821
- type: 'string',
7910
+ {
7911
+ properties: {
7912
+ created_at: {
7913
+ format: 'date-time',
7914
+ type: 'string',
7915
+ },
7916
+ message: { type: 'string' },
7917
+ warning_code: {
7918
+ enum: ['salto_ks_user_not_subscribed'],
7919
+ type: 'string',
7920
+ },
7921
+ },
7922
+ required: [
7923
+ 'created_at',
7924
+ 'message',
7925
+ 'warning_code',
7926
+ ],
7927
+ type: 'object',
7928
+ },
7929
+ {
7930
+ properties: {
7931
+ created_at: {
7932
+ format: 'date-time',
7933
+ type: 'string',
7934
+ },
7935
+ message: { type: 'string' },
7936
+ warning_code: {
7937
+ enum: ['salto_site_user_suspended'],
7938
+ type: 'string',
7939
+ },
7940
+ },
7941
+ required: [
7942
+ 'created_at',
7943
+ 'message',
7944
+ 'warning_code',
7945
+ ],
7946
+ type: 'object',
7822
7947
  },
7823
- },
7824
- required: [
7825
- 'created_at',
7826
- 'message',
7827
- 'warning_code',
7828
7948
  ],
7829
- type: 'object',
7830
7949
  },
7831
7950
  type: 'array',
7832
7951
  },
@@ -2490,11 +2490,24 @@ export interface Routes {
2490
2490
  user_identity_phone_number?: (string | null) | undefined
2491
2491
  latest_desired_state_synced_with_provider_at?: string | undefined
2492
2492
  is_latest_desired_state_synced_with_provider?: boolean | undefined
2493
- warnings: Array<{
2494
- created_at: string
2495
- message: string
2496
- warning_code: 'being_deleted'
2497
- }>
2493
+ warnings: Array<
2494
+ | {
2495
+ created_at: string
2496
+ message: string
2497
+ warning_code: 'being_deleted'
2498
+ }
2499
+ | {
2500
+ created_at: string
2501
+ message: string
2502
+ warning_code: 'salto_ks_user_not_subscribed'
2503
+ }
2504
+ | {
2505
+ created_at: string
2506
+ message: string
2507
+ warning_code: 'salto_site_user_suspended'
2508
+ }
2509
+ >
2510
+ errors?: any
2498
2511
  full_name?: string | undefined
2499
2512
  /**
2500
2513
  * @deprecated use email_address. */
@@ -3788,11 +3801,24 @@ export interface Routes {
3788
3801
  user_identity_phone_number?: (string | null) | undefined
3789
3802
  latest_desired_state_synced_with_provider_at?: string | undefined
3790
3803
  is_latest_desired_state_synced_with_provider?: boolean | undefined
3791
- warnings: Array<{
3792
- created_at: string
3793
- message: string
3794
- warning_code: 'being_deleted'
3795
- }>
3804
+ warnings: Array<
3805
+ | {
3806
+ created_at: string
3807
+ message: string
3808
+ warning_code: 'being_deleted'
3809
+ }
3810
+ | {
3811
+ created_at: string
3812
+ message: string
3813
+ warning_code: 'salto_ks_user_not_subscribed'
3814
+ }
3815
+ | {
3816
+ created_at: string
3817
+ message: string
3818
+ warning_code: 'salto_site_user_suspended'
3819
+ }
3820
+ >
3821
+ errors?: any
3796
3822
  full_name?: string | undefined
3797
3823
  /**
3798
3824
  * @deprecated use email_address. */
@@ -3854,11 +3880,24 @@ export interface Routes {
3854
3880
  user_identity_phone_number?: (string | null) | undefined
3855
3881
  latest_desired_state_synced_with_provider_at?: string | undefined
3856
3882
  is_latest_desired_state_synced_with_provider?: boolean | undefined
3857
- warnings: Array<{
3858
- created_at: string
3859
- message: string
3860
- warning_code: 'being_deleted'
3861
- }>
3883
+ warnings: Array<
3884
+ | {
3885
+ created_at: string
3886
+ message: string
3887
+ warning_code: 'being_deleted'
3888
+ }
3889
+ | {
3890
+ created_at: string
3891
+ message: string
3892
+ warning_code: 'salto_ks_user_not_subscribed'
3893
+ }
3894
+ | {
3895
+ created_at: string
3896
+ message: string
3897
+ warning_code: 'salto_site_user_suspended'
3898
+ }
3899
+ >
3900
+ errors?: any
3862
3901
  full_name?: string | undefined
3863
3902
  /**
3864
3903
  * @deprecated use email_address. */
@@ -3914,11 +3953,24 @@ export interface Routes {
3914
3953
  user_identity_phone_number?: (string | null) | undefined
3915
3954
  latest_desired_state_synced_with_provider_at?: string | undefined
3916
3955
  is_latest_desired_state_synced_with_provider?: boolean | undefined
3917
- warnings: Array<{
3918
- created_at: string
3919
- message: string
3920
- warning_code: 'being_deleted'
3921
- }>
3956
+ warnings: Array<
3957
+ | {
3958
+ created_at: string
3959
+ message: string
3960
+ warning_code: 'being_deleted'
3961
+ }
3962
+ | {
3963
+ created_at: string
3964
+ message: string
3965
+ warning_code: 'salto_ks_user_not_subscribed'
3966
+ }
3967
+ | {
3968
+ created_at: string
3969
+ message: string
3970
+ warning_code: 'salto_site_user_suspended'
3971
+ }
3972
+ >
3973
+ errors?: any
3922
3974
  full_name?: string | undefined
3923
3975
  /**
3924
3976
  * @deprecated use email_address. */
@@ -4050,11 +4102,24 @@ export interface Routes {
4050
4102
  user_identity_phone_number?: (string | null) | undefined
4051
4103
  latest_desired_state_synced_with_provider_at?: string | undefined
4052
4104
  is_latest_desired_state_synced_with_provider?: boolean | undefined
4053
- warnings: Array<{
4054
- created_at: string
4055
- message: string
4056
- warning_code: 'being_deleted'
4057
- }>
4105
+ warnings: Array<
4106
+ | {
4107
+ created_at: string
4108
+ message: string
4109
+ warning_code: 'being_deleted'
4110
+ }
4111
+ | {
4112
+ created_at: string
4113
+ message: string
4114
+ warning_code: 'salto_ks_user_not_subscribed'
4115
+ }
4116
+ | {
4117
+ created_at: string
4118
+ message: string
4119
+ warning_code: 'salto_site_user_suspended'
4120
+ }
4121
+ >
4122
+ errors?: any
4058
4123
  full_name?: string | undefined
4059
4124
  /**
4060
4125
  * @deprecated use email_address. */
@@ -4109,11 +4174,24 @@ export interface Routes {
4109
4174
  user_identity_phone_number?: (string | null) | undefined
4110
4175
  latest_desired_state_synced_with_provider_at?: string | undefined
4111
4176
  is_latest_desired_state_synced_with_provider?: boolean | undefined
4112
- warnings: Array<{
4113
- created_at: string
4114
- message: string
4115
- warning_code: 'being_deleted'
4116
- }>
4177
+ warnings: Array<
4178
+ | {
4179
+ created_at: string
4180
+ message: string
4181
+ warning_code: 'being_deleted'
4182
+ }
4183
+ | {
4184
+ created_at: string
4185
+ message: string
4186
+ warning_code: 'salto_ks_user_not_subscribed'
4187
+ }
4188
+ | {
4189
+ created_at: string
4190
+ message: string
4191
+ warning_code: 'salto_site_user_suspended'
4192
+ }
4193
+ >
4194
+ errors?: any
4117
4195
  full_name?: string | undefined
4118
4196
  /**
4119
4197
  * @deprecated use email_address. */
@@ -18548,11 +18626,24 @@ export interface Routes {
18548
18626
  user_identity_phone_number?: (string | null) | undefined
18549
18627
  latest_desired_state_synced_with_provider_at?: string | undefined
18550
18628
  is_latest_desired_state_synced_with_provider?: boolean | undefined
18551
- warnings: Array<{
18552
- created_at: string
18553
- message: string
18554
- warning_code: 'being_deleted'
18555
- }>
18629
+ warnings: Array<
18630
+ | {
18631
+ created_at: string
18632
+ message: string
18633
+ warning_code: 'being_deleted'
18634
+ }
18635
+ | {
18636
+ created_at: string
18637
+ message: string
18638
+ warning_code: 'salto_ks_user_not_subscribed'
18639
+ }
18640
+ | {
18641
+ created_at: string
18642
+ message: string
18643
+ warning_code: 'salto_site_user_suspended'
18644
+ }
18645
+ >
18646
+ errors?: any
18556
18647
  full_name?: string | undefined
18557
18648
  /**
18558
18649
  * @deprecated use email_address. */