@seamapi/types 1.554.0 → 1.555.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.
@@ -10052,6 +10052,15 @@ export type Routes = {
10052
10052
  starts_at: string;
10053
10053
  /** Date and time at which the Access Grant ends. */
10054
10054
  ends_at: string | null;
10055
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
10056
+ warnings: {
10057
+ /** Date and time at which Seam created the warning. */
10058
+ created_at: string;
10059
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10060
+ message: string;
10061
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10062
+ warning_code: 'being_deleted';
10063
+ }[];
10055
10064
  /** ID of the customization profile associated with the Access Grant. */
10056
10065
  customization_profile_id?: string | undefined;
10057
10066
  };
@@ -10127,6 +10136,15 @@ export type Routes = {
10127
10136
  starts_at: string;
10128
10137
  /** Date and time at which the Access Grant ends. */
10129
10138
  ends_at: string | null;
10139
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
10140
+ warnings: {
10141
+ /** Date and time at which Seam created the warning. */
10142
+ created_at: string;
10143
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10144
+ message: string;
10145
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10146
+ warning_code: 'being_deleted';
10147
+ }[];
10130
10148
  /** ID of the customization profile associated with the Access Grant. */
10131
10149
  customization_profile_id?: string | undefined;
10132
10150
  };
@@ -11894,6 +11912,15 @@ export type Routes = {
11894
11912
  starts_at: string;
11895
11913
  /** Date and time at which the Access Grant ends. */
11896
11914
  ends_at: string | null;
11915
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11916
+ warnings: {
11917
+ /** Date and time at which Seam created the warning. */
11918
+ created_at: string;
11919
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11920
+ message: string;
11921
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11922
+ warning_code: 'being_deleted';
11923
+ }[];
11897
11924
  /** ID of the customization profile associated with the Access Grant. */
11898
11925
  customization_profile_id?: string | undefined;
11899
11926
  }[];
@@ -13224,6 +13251,15 @@ export type Routes = {
13224
13251
  is_encoding_required?: boolean | undefined;
13225
13252
  /** The actual PIN code for code access methods. */
13226
13253
  code?: (string | null) | undefined;
13254
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
13255
+ warnings: {
13256
+ /** Date and time at which Seam created the warning. */
13257
+ created_at: string;
13258
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13259
+ message: string;
13260
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13261
+ warning_code: 'being_deleted';
13262
+ }[];
13227
13263
  /** ID of the customization profile associated with the access method. */
13228
13264
  customization_profile_id?: string | undefined;
13229
13265
  };
@@ -17283,6 +17319,15 @@ export type Routes = {
17283
17319
  is_encoding_required?: boolean | undefined;
17284
17320
  /** The actual PIN code for code access methods. */
17285
17321
  code?: (string | null) | undefined;
17322
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
17323
+ warnings: {
17324
+ /** Date and time at which Seam created the warning. */
17325
+ created_at: string;
17326
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17327
+ message: string;
17328
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17329
+ warning_code: 'being_deleted';
17330
+ }[];
17286
17331
  /** ID of the customization profile associated with the access method. */
17287
17332
  customization_profile_id?: string | undefined;
17288
17333
  }[] | undefined;
@@ -17329,6 +17374,15 @@ export type Routes = {
17329
17374
  starts_at: string;
17330
17375
  /** Date and time at which the Access Grant ends. */
17331
17376
  ends_at: string | null;
17377
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
17378
+ warnings: {
17379
+ /** Date and time at which Seam created the warning. */
17380
+ created_at: string;
17381
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17382
+ message: string;
17383
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17384
+ warning_code: 'being_deleted';
17385
+ }[];
17332
17386
  /** ID of the customization profile associated with the Access Grant. */
17333
17387
  customization_profile_id?: string | undefined;
17334
17388
  }[] | undefined;
@@ -20369,6 +20423,15 @@ export type Routes = {
20369
20423
  is_encoding_required?: boolean | undefined;
20370
20424
  /** The actual PIN code for code access methods. */
20371
20425
  code?: (string | null) | undefined;
20426
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
20427
+ warnings: {
20428
+ /** Date and time at which Seam created the warning. */
20429
+ created_at: string;
20430
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20431
+ message: string;
20432
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20433
+ warning_code: 'being_deleted';
20434
+ }[];
20372
20435
  /** ID of the customization profile associated with the access method. */
20373
20436
  customization_profile_id?: string | undefined;
20374
20437
  }[];
@@ -83999,6 +84062,15 @@ export type Routes = {
83999
84062
  is_encoding_required?: boolean | undefined;
84000
84063
  /** The actual PIN code for code access methods. */
84001
84064
  code?: (string | null) | undefined;
84065
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
84066
+ warnings: {
84067
+ /** Date and time at which Seam created the warning. */
84068
+ created_at: string;
84069
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84070
+ message: string;
84071
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84072
+ warning_code: 'being_deleted';
84073
+ }[];
84002
84074
  /** ID of the customization profile associated with the access method. */
84003
84075
  customization_profile_id?: string | undefined;
84004
84076
  }[] | undefined;
@@ -84045,6 +84117,15 @@ export type Routes = {
84045
84117
  starts_at: string;
84046
84118
  /** Date and time at which the Access Grant ends. */
84047
84119
  ends_at: string | null;
84120
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
84121
+ warnings: {
84122
+ /** Date and time at which Seam created the warning. */
84123
+ created_at: string;
84124
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84125
+ message: string;
84126
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84127
+ warning_code: 'being_deleted';
84128
+ }[];
84048
84129
  /** ID of the customization profile associated with the Access Grant. */
84049
84130
  customization_profile_id?: string | undefined;
84050
84131
  }[] | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.554.0",
3
+ "version": "1.555.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -2,6 +2,41 @@ import { z } from 'zod'
2
2
 
3
3
  import { requested_access_method } from './requested-access-method.js'
4
4
 
5
+ const common_access_grant_warning = z.object({
6
+ created_at: z
7
+ .string()
8
+ .datetime()
9
+ .describe('Date and time at which Seam created the warning.'),
10
+ message: z
11
+ .string()
12
+ .describe(
13
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
14
+ ),
15
+ })
16
+
17
+ const warning_code_description =
18
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
19
+
20
+ const being_deleted = common_access_grant_warning
21
+ .extend({
22
+ warning_code: z.literal('being_deleted').describe(warning_code_description),
23
+ })
24
+ .describe(
25
+ 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
26
+ )
27
+
28
+ const access_grant_warning = z
29
+ .discriminatedUnion('warning_code', [being_deleted])
30
+ .describe(
31
+ 'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
32
+ )
33
+
34
+ const _access_grant_warning_map = z.object({
35
+ being_deleted: being_deleted.optional().nullable(),
36
+ })
37
+
38
+ export type AccessGrantWarningMap = z.infer<typeof _access_grant_warning_map>
39
+
5
40
  export const access_grant = z.object({
6
41
  workspace_id: z
7
42
  .string()
@@ -63,6 +98,11 @@ export const access_grant = z.object({
63
98
  .datetime()
64
99
  .nullable()
65
100
  .describe('Date and time at which the Access Grant ends.'),
101
+ warnings: z
102
+ .array(access_grant_warning)
103
+ .describe(
104
+ 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
105
+ ),
66
106
  customization_profile_id: z
67
107
  .string()
68
108
  .uuid()
@@ -1,5 +1,40 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ const common_access_method_warning = z.object({
4
+ created_at: z
5
+ .string()
6
+ .datetime()
7
+ .describe('Date and time at which Seam created the warning.'),
8
+ message: z
9
+ .string()
10
+ .describe(
11
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
12
+ ),
13
+ })
14
+
15
+ const warning_code_description =
16
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
17
+
18
+ const being_deleted = common_access_method_warning
19
+ .extend({
20
+ warning_code: z.literal('being_deleted').describe(warning_code_description),
21
+ })
22
+ .describe(
23
+ 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
24
+ )
25
+
26
+ const access_method_warning = z
27
+ .discriminatedUnion('warning_code', [being_deleted])
28
+ .describe(
29
+ 'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
30
+ )
31
+
32
+ const _access_method_warning_map = z.object({
33
+ being_deleted: being_deleted.optional().nullable(),
34
+ })
35
+
36
+ export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
37
+
3
38
  export const access_method = z.object({
4
39
  workspace_id: z
5
40
  .string()
@@ -44,6 +79,11 @@ export const access_method = z.object({
44
79
  .nullable()
45
80
  .optional()
46
81
  .describe('The actual PIN code for code access methods.'),
82
+ warnings: z
83
+ .array(access_method_warning)
84
+ .describe(
85
+ 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
86
+ ),
47
87
  customization_profile_id: z
48
88
  .string()
49
89
  .uuid()
@@ -1947,6 +1947,43 @@ export default {
1947
1947
  format: 'uuid',
1948
1948
  type: 'string',
1949
1949
  },
1950
+ warnings: {
1951
+ description:
1952
+ 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
1953
+ items: {
1954
+ description:
1955
+ 'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
1956
+ discriminator: { propertyName: 'warning_code' },
1957
+ oneOf: [
1958
+ {
1959
+ description:
1960
+ 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
1961
+ properties: {
1962
+ created_at: {
1963
+ description:
1964
+ 'Date and time at which Seam created the warning.',
1965
+ format: 'date-time',
1966
+ type: 'string',
1967
+ },
1968
+ message: {
1969
+ description:
1970
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1971
+ type: 'string',
1972
+ },
1973
+ warning_code: {
1974
+ description:
1975
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1976
+ enum: ['being_deleted'],
1977
+ type: 'string',
1978
+ },
1979
+ },
1980
+ required: ['created_at', 'message', 'warning_code'],
1981
+ type: 'object',
1982
+ },
1983
+ ],
1984
+ },
1985
+ type: 'array',
1986
+ },
1950
1987
  workspace_id: {
1951
1988
  description:
1952
1989
  'ID of the Seam workspace associated with the Access Grant.',
@@ -1967,6 +2004,7 @@ export default {
1967
2004
  'created_at',
1968
2005
  'starts_at',
1969
2006
  'ends_at',
2007
+ 'warnings',
1970
2008
  ],
1971
2009
  type: 'object',
1972
2010
  'x-draft': 'Early access.',
@@ -2034,6 +2072,43 @@ export default {
2034
2072
  enum: ['code', 'card', 'mobile_key'],
2035
2073
  type: 'string',
2036
2074
  },
2075
+ warnings: {
2076
+ description:
2077
+ 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
2078
+ items: {
2079
+ description:
2080
+ 'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
2081
+ discriminator: { propertyName: 'warning_code' },
2082
+ oneOf: [
2083
+ {
2084
+ description:
2085
+ 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
2086
+ properties: {
2087
+ created_at: {
2088
+ description:
2089
+ 'Date and time at which Seam created the warning.',
2090
+ format: 'date-time',
2091
+ type: 'string',
2092
+ },
2093
+ message: {
2094
+ description:
2095
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2096
+ type: 'string',
2097
+ },
2098
+ warning_code: {
2099
+ description:
2100
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2101
+ enum: ['being_deleted'],
2102
+ type: 'string',
2103
+ },
2104
+ },
2105
+ required: ['created_at', 'message', 'warning_code'],
2106
+ type: 'object',
2107
+ },
2108
+ ],
2109
+ },
2110
+ type: 'array',
2111
+ },
2037
2112
  workspace_id: {
2038
2113
  description:
2039
2114
  'ID of the Seam workspace associated with the access method.',
@@ -2049,6 +2124,7 @@ export default {
2049
2124
  'created_at',
2050
2125
  'issued_at',
2051
2126
  'is_issued',
2127
+ 'warnings',
2052
2128
  ],
2053
2129
  type: 'object',
2054
2130
  'x-draft': 'Early access.',
@@ -11308,6 +11308,15 @@ export type Routes = {
11308
11308
  starts_at: string
11309
11309
  /** Date and time at which the Access Grant ends. */
11310
11310
  ends_at: string | null
11311
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11312
+ warnings: {
11313
+ /** Date and time at which Seam created the warning. */
11314
+ created_at: string
11315
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11316
+ message: string
11317
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11318
+ warning_code: 'being_deleted'
11319
+ }[]
11311
11320
  /** ID of the customization profile associated with the Access Grant. */
11312
11321
  customization_profile_id?: string | undefined
11313
11322
  }
@@ -11385,6 +11394,15 @@ export type Routes = {
11385
11394
  starts_at: string
11386
11395
  /** Date and time at which the Access Grant ends. */
11387
11396
  ends_at: string | null
11397
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11398
+ warnings: {
11399
+ /** Date and time at which Seam created the warning. */
11400
+ created_at: string
11401
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11402
+ message: string
11403
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11404
+ warning_code: 'being_deleted'
11405
+ }[]
11388
11406
  /** ID of the customization profile associated with the Access Grant. */
11389
11407
  customization_profile_id?: string | undefined
11390
11408
  }
@@ -13620,6 +13638,15 @@ export type Routes = {
13620
13638
  starts_at: string
13621
13639
  /** Date and time at which the Access Grant ends. */
13622
13640
  ends_at: string | null
13641
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
13642
+ warnings: {
13643
+ /** Date and time at which Seam created the warning. */
13644
+ created_at: string
13645
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13646
+ message: string
13647
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13648
+ warning_code: 'being_deleted'
13649
+ }[]
13623
13650
  /** ID of the customization profile associated with the Access Grant. */
13624
13651
  customization_profile_id?: string | undefined
13625
13652
  }[]
@@ -15139,6 +15166,15 @@ export type Routes = {
15139
15166
  is_encoding_required?: boolean | undefined
15140
15167
  /** The actual PIN code for code access methods. */
15141
15168
  code?: (string | null) | undefined
15169
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
15170
+ warnings: {
15171
+ /** Date and time at which Seam created the warning. */
15172
+ created_at: string
15173
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15174
+ message: string
15175
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15176
+ warning_code: 'being_deleted'
15177
+ }[]
15142
15178
  /** ID of the customization profile associated with the access method. */
15143
15179
  customization_profile_id?: string | undefined
15144
15180
  }
@@ -20118,6 +20154,15 @@ export type Routes = {
20118
20154
  is_encoding_required?: boolean | undefined
20119
20155
  /** The actual PIN code for code access methods. */
20120
20156
  code?: (string | null) | undefined
20157
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
20158
+ warnings: {
20159
+ /** Date and time at which Seam created the warning. */
20160
+ created_at: string
20161
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20162
+ message: string
20163
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20164
+ warning_code: 'being_deleted'
20165
+ }[]
20121
20166
  /** ID of the customization profile associated with the access method. */
20122
20167
  customization_profile_id?: string | undefined
20123
20168
  }[]
@@ -20166,6 +20211,15 @@ export type Routes = {
20166
20211
  starts_at: string
20167
20212
  /** Date and time at which the Access Grant ends. */
20168
20213
  ends_at: string | null
20214
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
20215
+ warnings: {
20216
+ /** Date and time at which Seam created the warning. */
20217
+ created_at: string
20218
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20219
+ message: string
20220
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20221
+ warning_code: 'being_deleted'
20222
+ }[]
20169
20223
  /** ID of the customization profile associated with the Access Grant. */
20170
20224
  customization_profile_id?: string | undefined
20171
20225
  }[]
@@ -23677,6 +23731,15 @@ export type Routes = {
23677
23731
  is_encoding_required?: boolean | undefined
23678
23732
  /** The actual PIN code for code access methods. */
23679
23733
  code?: (string | null) | undefined
23734
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
23735
+ warnings: {
23736
+ /** Date and time at which Seam created the warning. */
23737
+ created_at: string
23738
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23739
+ message: string
23740
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23741
+ warning_code: 'being_deleted'
23742
+ }[]
23680
23743
  /** ID of the customization profile associated with the access method. */
23681
23744
  customization_profile_id?: string | undefined
23682
23745
  }[]
@@ -100009,6 +100072,15 @@ export type Routes = {
100009
100072
  is_encoding_required?: boolean | undefined
100010
100073
  /** The actual PIN code for code access methods. */
100011
100074
  code?: (string | null) | undefined
100075
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
100076
+ warnings: {
100077
+ /** Date and time at which Seam created the warning. */
100078
+ created_at: string
100079
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
100080
+ message: string
100081
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
100082
+ warning_code: 'being_deleted'
100083
+ }[]
100012
100084
  /** ID of the customization profile associated with the access method. */
100013
100085
  customization_profile_id?: string | undefined
100014
100086
  }[]
@@ -100057,6 +100129,15 @@ export type Routes = {
100057
100129
  starts_at: string
100058
100130
  /** Date and time at which the Access Grant ends. */
100059
100131
  ends_at: string | null
100132
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
100133
+ warnings: {
100134
+ /** Date and time at which Seam created the warning. */
100135
+ created_at: string
100136
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
100137
+ message: string
100138
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
100139
+ warning_code: 'being_deleted'
100140
+ }[]
100060
100141
  /** ID of the customization profile associated with the Access Grant. */
100061
100142
  customization_profile_id?: string | undefined
100062
100143
  }[]