@seamapi/types 1.779.0 → 1.781.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.
@@ -12570,6 +12570,15 @@ export type Routes = {
12570
12570
  external_type_display_name: string;
12571
12571
  /** Date and time at which the access group was created. */
12572
12572
  created_at: string;
12573
+ /** Errors associated with the `acs_access_group`. */
12574
+ errors: {
12575
+ /** Date and time at which Seam created the error. */
12576
+ created_at: string;
12577
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
12578
+ message: string;
12579
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
12580
+ error_code: 'failed_to_create_on_acs_system';
12581
+ }[];
12573
12582
  /** Warnings associated with the `acs_access_group`. */
12574
12583
  warnings: ({
12575
12584
  /** Date and time at which Seam created the warning. */
@@ -12840,8 +12849,8 @@ export type Routes = {
12840
12849
  location_id?: string | undefined;
12841
12850
  /** ID of the space by which you want to filter the list of Access Grants. */
12842
12851
  space_id?: string | undefined;
12843
- /** Filter Access Grants by access_grant_key. */
12844
- access_grant_key?: string | undefined;
12852
+ /** Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key. */
12853
+ access_grant_key?: (string | null) | undefined;
12845
12854
  /** Filter Access Grants by reservation_key. */
12846
12855
  reservation_key?: string | undefined;
12847
12856
  };
@@ -17451,6 +17460,15 @@ export type Routes = {
17451
17460
  external_type_display_name: string;
17452
17461
  /** Date and time at which the access group was created. */
17453
17462
  created_at: string;
17463
+ /** Errors associated with the `acs_access_group`. */
17464
+ errors: {
17465
+ /** Date and time at which Seam created the error. */
17466
+ created_at: string;
17467
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17468
+ message: string;
17469
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
17470
+ error_code: 'failed_to_create_on_acs_system';
17471
+ }[];
17454
17472
  /** Warnings associated with the `acs_access_group`. */
17455
17473
  warnings: ({
17456
17474
  /** Date and time at which Seam created the warning. */
@@ -17626,6 +17644,15 @@ export type Routes = {
17626
17644
  external_type_display_name: string;
17627
17645
  /** Date and time at which the access group was created. */
17628
17646
  created_at: string;
17647
+ /** Errors associated with the `acs_access_group`. */
17648
+ errors: {
17649
+ /** Date and time at which Seam created the error. */
17650
+ created_at: string;
17651
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17652
+ message: string;
17653
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
17654
+ error_code: 'failed_to_create_on_acs_system';
17655
+ }[];
17629
17656
  /** Warnings associated with the `acs_access_group`. */
17630
17657
  warnings: ({
17631
17658
  /** Date and time at which Seam created the warning. */
@@ -18207,6 +18234,15 @@ export type Routes = {
18207
18234
  external_type_display_name: string;
18208
18235
  /** Date and time at which the access group was created. */
18209
18236
  created_at: string;
18237
+ /** Errors associated with the `acs_access_group`. */
18238
+ errors: {
18239
+ /** Date and time at which Seam created the error. */
18240
+ created_at: string;
18241
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18242
+ message: string;
18243
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18244
+ error_code: 'failed_to_create_on_acs_system';
18245
+ }[];
18210
18246
  /** Warnings associated with the `acs_access_group`. */
18211
18247
  warnings: ({
18212
18248
  /** Date and time at which Seam created the warning. */
@@ -18380,6 +18416,15 @@ export type Routes = {
18380
18416
  external_type_display_name: string;
18381
18417
  /** Date and time at which the access group was created. */
18382
18418
  created_at: string;
18419
+ /** Errors associated with the `acs_access_group`. */
18420
+ errors: {
18421
+ /** Date and time at which Seam created the error. */
18422
+ created_at: string;
18423
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18424
+ message: string;
18425
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18426
+ error_code: 'failed_to_create_on_acs_system';
18427
+ }[];
18383
18428
  /** Warnings associated with the `acs_access_group`. */
18384
18429
  warnings: ({
18385
18430
  /** Date and time at which Seam created the warning. */
@@ -92536,6 +92581,15 @@ export type Routes = {
92536
92581
  external_type_display_name: string;
92537
92582
  /** Date and time at which the access group was created. */
92538
92583
  created_at: string;
92584
+ /** Errors associated with the `acs_access_group`. */
92585
+ errors: {
92586
+ /** Date and time at which Seam created the error. */
92587
+ created_at: string;
92588
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
92589
+ message: string;
92590
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
92591
+ error_code: 'failed_to_create_on_acs_system';
92592
+ }[];
92539
92593
  /** Warnings associated with the `acs_access_group`. */
92540
92594
  warnings: ({
92541
92595
  /** Date and time at which Seam created the warning. */
@@ -94292,6 +94346,15 @@ export type Routes = {
94292
94346
  external_type_display_name: string;
94293
94347
  /** Date and time at which the access group was created. */
94294
94348
  created_at: string;
94349
+ /** Errors associated with the `acs_access_group`. */
94350
+ errors: {
94351
+ /** Date and time at which Seam created the error. */
94352
+ created_at: string;
94353
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
94354
+ message: string;
94355
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
94356
+ error_code: 'failed_to_create_on_acs_system';
94357
+ }[];
94295
94358
  /** Warnings associated with the `acs_access_group`. */
94296
94359
  warnings: ({
94297
94360
  /** Date and time at which Seam created the warning. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.779.0",
3
+ "version": "1.781.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -18,6 +18,45 @@ export type AcsAccessGroupExternalType = z.infer<
18
18
  typeof acs_access_group_external_type
19
19
  >
20
20
 
21
+ const common_acs_access_group_error = z.object({
22
+ created_at: z
23
+ .string()
24
+ .datetime()
25
+ .describe('Date and time at which Seam created the error.'),
26
+ message: z
27
+ .string()
28
+ .describe(
29
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
30
+ ),
31
+ })
32
+
33
+ const error_code_description =
34
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
35
+
36
+ const acs_access_groups_failed_to_create_on_acs_system =
37
+ common_acs_access_group_error
38
+ .extend({
39
+ error_code: z
40
+ .literal('failed_to_create_on_acs_system')
41
+ .describe(error_code_description),
42
+ })
43
+ .describe(
44
+ `Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
45
+ )
46
+
47
+ const acs_access_group_errors = z
48
+ .discriminatedUnion('error_code', [
49
+ acs_access_groups_failed_to_create_on_acs_system,
50
+ ])
51
+ .describe('Error associated with the `acs_access_group`.')
52
+
53
+ const _acs_access_group_error_map = z.object({
54
+ failed_to_create_on_acs_system:
55
+ acs_access_groups_failed_to_create_on_acs_system.optional().nullable(),
56
+ })
57
+
58
+ export type AcsAccessGroupErrorMap = z.infer<typeof _acs_access_group_error_map>
59
+
21
60
  const common_acs_access_group_warning = z.object({
22
61
  created_at: z
23
62
  .string()
@@ -111,6 +150,9 @@ const common_acs_access_group = z.object({
111
150
  .string()
112
151
  .datetime()
113
152
  .describe('Date and time at which the access group was created.'),
153
+ errors: z
154
+ .array(acs_access_group_errors)
155
+ .describe('Errors associated with the `acs_access_group`.'),
114
156
  warnings: z
115
157
  .array(acs_access_group_warning)
116
158
  .describe('Warnings associated with the `acs_access_group`.'),
@@ -2808,6 +2808,41 @@ export default {
2808
2808
  type: 'string',
2809
2809
  },
2810
2810
  display_name: { type: 'string' },
2811
+ errors: {
2812
+ description: 'Errors associated with the `acs_access_group`.',
2813
+ items: {
2814
+ description: 'Error associated with the `acs_access_group`.',
2815
+ discriminator: { propertyName: 'error_code' },
2816
+ oneOf: [
2817
+ {
2818
+ description:
2819
+ 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
2820
+ properties: {
2821
+ created_at: {
2822
+ description:
2823
+ 'Date and time at which Seam created the error.',
2824
+ format: 'date-time',
2825
+ type: 'string',
2826
+ },
2827
+ error_code: {
2828
+ description:
2829
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
2830
+ enum: ['failed_to_create_on_acs_system'],
2831
+ type: 'string',
2832
+ },
2833
+ message: {
2834
+ description:
2835
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
2836
+ type: 'string',
2837
+ },
2838
+ },
2839
+ required: ['created_at', 'message', 'error_code'],
2840
+ type: 'object',
2841
+ },
2842
+ ],
2843
+ },
2844
+ type: 'array',
2845
+ },
2811
2846
  external_type: {
2812
2847
  description:
2813
2848
  'Brand-specific terminology for the access group type.',
@@ -3263,6 +3298,7 @@ export default {
3263
3298
  'external_type',
3264
3299
  'external_type_display_name',
3265
3300
  'created_at',
3301
+ 'errors',
3266
3302
  'warnings',
3267
3303
  'pending_mutations',
3268
3304
  'is_managed',
@@ -27490,6 +27526,41 @@ export default {
27490
27526
  type: 'string',
27491
27527
  },
27492
27528
  display_name: { type: 'string' },
27529
+ errors: {
27530
+ description: 'Errors associated with the `acs_access_group`.',
27531
+ items: {
27532
+ description: 'Error associated with the `acs_access_group`.',
27533
+ discriminator: { propertyName: 'error_code' },
27534
+ oneOf: [
27535
+ {
27536
+ description:
27537
+ 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
27538
+ properties: {
27539
+ created_at: {
27540
+ description:
27541
+ 'Date and time at which Seam created the error.',
27542
+ format: 'date-time',
27543
+ type: 'string',
27544
+ },
27545
+ error_code: {
27546
+ description:
27547
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27548
+ enum: ['failed_to_create_on_acs_system'],
27549
+ type: 'string',
27550
+ },
27551
+ message: {
27552
+ description:
27553
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27554
+ type: 'string',
27555
+ },
27556
+ },
27557
+ required: ['created_at', 'message', 'error_code'],
27558
+ type: 'object',
27559
+ },
27560
+ ],
27561
+ },
27562
+ type: 'array',
27563
+ },
27493
27564
  external_type: {
27494
27565
  description:
27495
27566
  'Brand-specific terminology for the access group type.',
@@ -27945,6 +28016,7 @@ export default {
27945
28016
  'external_type',
27946
28017
  'external_type_display_name',
27947
28018
  'created_at',
28019
+ 'errors',
27948
28020
  'warnings',
27949
28021
  'pending_mutations',
27950
28022
  'is_managed',
@@ -34920,7 +34992,9 @@ export default {
34920
34992
  in: 'query',
34921
34993
  name: 'access_grant_key',
34922
34994
  schema: {
34923
- description: 'Filter Access Grants by access_grant_key.',
34995
+ description:
34996
+ 'Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.',
34997
+ nullable: true,
34924
34998
  type: 'string',
34925
34999
  },
34926
35000
  },
@@ -34985,7 +35059,9 @@ export default {
34985
35059
  type: 'array',
34986
35060
  },
34987
35061
  access_grant_key: {
34988
- description: 'Filter Access Grants by access_grant_key.',
35062
+ description:
35063
+ 'Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.',
35064
+ nullable: true,
34989
35065
  type: 'string',
34990
35066
  },
34991
35067
  acs_entrance_id: {
@@ -14488,6 +14488,15 @@ export type Routes = {
14488
14488
  external_type_display_name: string
14489
14489
  /** Date and time at which the access group was created. */
14490
14490
  created_at: string
14491
+ /** Errors associated with the `acs_access_group`. */
14492
+ errors: {
14493
+ /** Date and time at which Seam created the error. */
14494
+ created_at: string
14495
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14496
+ message: string
14497
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
14498
+ error_code: 'failed_to_create_on_acs_system'
14499
+ }[]
14491
14500
  /** Warnings associated with the `acs_access_group`. */
14492
14501
  warnings: (
14493
14502
  | {
@@ -14783,8 +14792,8 @@ export type Routes = {
14783
14792
  location_id?: string | undefined
14784
14793
  /** ID of the space by which you want to filter the list of Access Grants. */
14785
14794
  space_id?: string | undefined
14786
- /** Filter Access Grants by access_grant_key. */
14787
- access_grant_key?: string | undefined
14795
+ /** Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key. */
14796
+ access_grant_key?: (string | null) | undefined
14788
14797
  /** Filter Access Grants by reservation_key. */
14789
14798
  reservation_key?: string | undefined
14790
14799
  }
@@ -20162,6 +20171,15 @@ export type Routes = {
20162
20171
  external_type_display_name: string
20163
20172
  /** Date and time at which the access group was created. */
20164
20173
  created_at: string
20174
+ /** Errors associated with the `acs_access_group`. */
20175
+ errors: {
20176
+ /** Date and time at which Seam created the error. */
20177
+ created_at: string
20178
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20179
+ message: string
20180
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20181
+ error_code: 'failed_to_create_on_acs_system'
20182
+ }[]
20165
20183
  /** Warnings associated with the `acs_access_group`. */
20166
20184
  warnings: (
20167
20185
  | {
@@ -20365,6 +20383,15 @@ export type Routes = {
20365
20383
  external_type_display_name: string
20366
20384
  /** Date and time at which the access group was created. */
20367
20385
  created_at: string
20386
+ /** Errors associated with the `acs_access_group`. */
20387
+ errors: {
20388
+ /** Date and time at which Seam created the error. */
20389
+ created_at: string
20390
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20391
+ message: string
20392
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20393
+ error_code: 'failed_to_create_on_acs_system'
20394
+ }[]
20368
20395
  /** Warnings associated with the `acs_access_group`. */
20369
20396
  warnings: (
20370
20397
  | {
@@ -21040,6 +21067,15 @@ export type Routes = {
21040
21067
  external_type_display_name: string
21041
21068
  /** Date and time at which the access group was created. */
21042
21069
  created_at: string
21070
+ /** Errors associated with the `acs_access_group`. */
21071
+ errors: {
21072
+ /** Date and time at which Seam created the error. */
21073
+ created_at: string
21074
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21075
+ message: string
21076
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21077
+ error_code: 'failed_to_create_on_acs_system'
21078
+ }[]
21043
21079
  /** Warnings associated with the `acs_access_group`. */
21044
21080
  warnings: (
21045
21081
  | {
@@ -21241,6 +21277,15 @@ export type Routes = {
21241
21277
  external_type_display_name: string
21242
21278
  /** Date and time at which the access group was created. */
21243
21279
  created_at: string
21280
+ /** Errors associated with the `acs_access_group`. */
21281
+ errors: {
21282
+ /** Date and time at which Seam created the error. */
21283
+ created_at: string
21284
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21285
+ message: string
21286
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21287
+ error_code: 'failed_to_create_on_acs_system'
21288
+ }[]
21244
21289
  /** Warnings associated with the `acs_access_group`. */
21245
21290
  warnings: (
21246
21291
  | {
@@ -110002,6 +110047,15 @@ export type Routes = {
110002
110047
  external_type_display_name: string
110003
110048
  /** Date and time at which the access group was created. */
110004
110049
  created_at: string
110050
+ /** Errors associated with the `acs_access_group`. */
110051
+ errors: {
110052
+ /** Date and time at which Seam created the error. */
110053
+ created_at: string
110054
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110055
+ message: string
110056
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110057
+ error_code: 'failed_to_create_on_acs_system'
110058
+ }[]
110005
110059
  /** Warnings associated with the `acs_access_group`. */
110006
110060
  warnings: (
110007
110061
  | {
@@ -112077,6 +112131,15 @@ export type Routes = {
112077
112131
  external_type_display_name: string
112078
112132
  /** Date and time at which the access group was created. */
112079
112133
  created_at: string
112134
+ /** Errors associated with the `acs_access_group`. */
112135
+ errors: {
112136
+ /** Date and time at which Seam created the error. */
112137
+ created_at: string
112138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
112139
+ message: string
112140
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
112141
+ error_code: 'failed_to_create_on_acs_system'
112142
+ }[]
112080
112143
  /** Warnings associated with the `acs_access_group`. */
112081
112144
  warnings: (
112082
112145
  | {