@seamapi/types 1.921.0 → 1.922.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.921.0",
3
+ "version": "1.922.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -29,7 +29,12 @@ const cannot_create_requested_access_methods_error =
29
29
  .describe(
30
30
  'IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.',
31
31
  ),
32
- })
32
+ }).describe(`
33
+ ---
34
+ resource_type: access_grant
35
+ ---
36
+ Indicates that Seam could not create one or more of the requested access methods for the access grant.
37
+ `)
33
38
 
34
39
  const common_access_grant_warning = z.object({
35
40
  created_at: z
@@ -15,8 +15,8 @@ const common_bridge_client_session_error = z.object({
15
15
  const error_code_description =
16
16
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
17
17
 
18
- export const bridge_lan_unreachable = common_bridge_client_session_error
19
- .extend({
18
+ export const bridge_lan_unreachable = common_bridge_client_session_error.extend(
19
+ {
20
20
  error_code: z
21
21
  .literal('bridge_lan_unreachable')
22
22
  .describe(error_code_description),
@@ -44,16 +44,25 @@ export const bridge_lan_unreachable = common_bridge_client_session_error
44
44
  .boolean()
45
45
  .nullable()
46
46
  .describe("Indicates whether Seam Bridge's SOCKS server is healthy."),
47
- })
48
- .describe("Indicates that Seam cannot reach Seam Bridge's LAN.")
47
+ },
48
+ ).describe(`
49
+ ---
50
+ resource_type: bridge_client_session
51
+ ---
52
+ Indicates that Seam cannot reach Seam Bridge's LAN.
53
+ `)
49
54
 
50
- export const no_communication_from_bridge = common_bridge_client_session_error
51
- .extend({
55
+ export const no_communication_from_bridge =
56
+ common_bridge_client_session_error.extend({
52
57
  error_code: z
53
58
  .literal('no_communication_from_bridge')
54
59
  .describe(error_code_description),
55
- })
56
- .describe('Indicates that Seam Bridge has stopped communicating with Seam.')
60
+ }).describe(`
61
+ ---
62
+ resource_type: bridge_client_session
63
+ ---
64
+ Indicates that Seam Bridge has stopped communicating with Seam.
65
+ `)
57
66
 
58
67
  export const bridge_client_session_error = z
59
68
  .discriminatedUnion('error_code', [
@@ -49,27 +49,28 @@ const acs_user_profile_does_not_match_user_identity =
49
49
  "Indicates that the ACS user's profile does not match the user identity's profile",
50
50
  )
51
51
 
52
- const user_identity_issue_with_acs_user = common_user_identity_error
53
- .extend({
54
- error_code: z
55
- .literal('issue_with_acs_user')
56
- .describe(
57
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
58
- ),
59
- acs_user_id: z
60
- .string()
61
- .uuid()
62
- .describe('ID of the access system user that has an issue.'),
63
- acs_system_id: z
64
- .string()
65
- .uuid()
66
- .describe(
67
- 'ID of the access system that the user identity is associated with.',
68
- ),
69
- })
70
- .describe(
71
- 'Indicates that there is an issue with an access system user associated with this user identity.',
72
- )
52
+ const user_identity_issue_with_acs_user = common_user_identity_error.extend({
53
+ error_code: z
54
+ .literal('issue_with_acs_user')
55
+ .describe(
56
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
57
+ ),
58
+ acs_user_id: z
59
+ .string()
60
+ .uuid()
61
+ .describe('ID of the access system user that has an issue.'),
62
+ acs_system_id: z
63
+ .string()
64
+ .uuid()
65
+ .describe(
66
+ 'ID of the access system that the user identity is associated with.',
67
+ ),
68
+ }).describe(`
69
+ ---
70
+ resource_type: user_identity
71
+ ---
72
+ Indicates that there is an issue with an access system user associated with this user identity.
73
+ `)
73
74
 
74
75
  const _user_identity_error_map = z.object({
75
76
  issue_with_acs_user: z
@@ -1926,6 +1926,8 @@ const openapi: OpenAPISpec = {
1926
1926
  discriminator: { propertyName: 'error_code' },
1927
1927
  oneOf: [
1928
1928
  {
1929
+ description:
1930
+ 'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
1929
1931
  properties: {
1930
1932
  created_at: {
1931
1933
  description:
@@ -1953,6 +1955,7 @@ const openapi: OpenAPISpec = {
1953
1955
  },
1954
1956
  required: ['created_at', 'message', 'error_code'],
1955
1957
  type: 'object',
1958
+ 'x-resource-type': 'access_grant',
1956
1959
  },
1957
1960
  ],
1958
1961
  },
@@ -11724,6 +11727,7 @@ const openapi: OpenAPISpec = {
11724
11727
  'is_bridge_socks_server_healthy',
11725
11728
  ],
11726
11729
  type: 'object',
11730
+ 'x-resource-type': 'bridge_client_session',
11727
11731
  },
11728
11732
  {
11729
11733
  description:
@@ -11749,6 +11753,7 @@ const openapi: OpenAPISpec = {
11749
11753
  },
11750
11754
  required: ['message', 'created_at', 'error_code'],
11751
11755
  type: 'object',
11756
+ 'x-resource-type': 'bridge_client_session',
11752
11757
  },
11753
11758
  ],
11754
11759
  },
@@ -28227,6 +28232,7 @@ const openapi: OpenAPISpec = {
28227
28232
  'acs_system_id',
28228
28233
  ],
28229
28234
  type: 'object',
28235
+ 'x-resource-type': 'user_identity',
28230
28236
  },
28231
28237
  ],
28232
28238
  },
@@ -33984,6 +33990,7 @@ const openapi: OpenAPISpec = {
33984
33990
  'acs_system_id',
33985
33991
  ],
33986
33992
  type: 'object',
33993
+ 'x-resource-type': 'user_identity',
33987
33994
  },
33988
33995
  ],
33989
33996
  },
@@ -38487,6 +38494,8 @@ const openapi: OpenAPISpec = {
38487
38494
  discriminator: { propertyName: 'error_code' },
38488
38495
  oneOf: [
38489
38496
  {
38497
+ description:
38498
+ 'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
38490
38499
  properties: {
38491
38500
  created_at: {
38492
38501
  description:
@@ -38520,6 +38529,7 @@ const openapi: OpenAPISpec = {
38520
38529
  'error_code',
38521
38530
  ],
38522
38531
  type: 'object',
38532
+ 'x-resource-type': 'access_grant',
38523
38533
  },
38524
38534
  ],
38525
38535
  },
@@ -39196,6 +39206,8 @@ const openapi: OpenAPISpec = {
39196
39206
  discriminator: { propertyName: 'error_code' },
39197
39207
  oneOf: [
39198
39208
  {
39209
+ description:
39210
+ 'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
39199
39211
  properties: {
39200
39212
  created_at: {
39201
39213
  description:
@@ -39229,6 +39241,7 @@ const openapi: OpenAPISpec = {
39229
39241
  'error_code',
39230
39242
  ],
39231
39243
  type: 'object',
39244
+ 'x-resource-type': 'access_grant',
39232
39245
  },
39233
39246
  ],
39234
39247
  },
@@ -39951,6 +39964,8 @@ const openapi: OpenAPISpec = {
39951
39964
  discriminator: { propertyName: 'error_code' },
39952
39965
  oneOf: [
39953
39966
  {
39967
+ description:
39968
+ 'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
39954
39969
  properties: {
39955
39970
  created_at: {
39956
39971
  description:
@@ -39984,6 +39999,7 @@ const openapi: OpenAPISpec = {
39984
39999
  'error_code',
39985
40000
  ],
39986
40001
  type: 'object',
40002
+ 'x-resource-type': 'access_grant',
39987
40003
  },
39988
40004
  ],
39989
40005
  },
@@ -40698,6 +40714,8 @@ const openapi: OpenAPISpec = {
40698
40714
  discriminator: { propertyName: 'error_code' },
40699
40715
  oneOf: [
40700
40716
  {
40717
+ description:
40718
+ 'Indicates that Seam could not create one or more of the requested access methods for the access grant.',
40701
40719
  properties: {
40702
40720
  created_at: {
40703
40721
  description:
@@ -40731,6 +40749,7 @@ const openapi: OpenAPISpec = {
40731
40749
  'error_code',
40732
40750
  ],
40733
40751
  type: 'object',
40752
+ 'x-resource-type': 'access_grant',
40734
40753
  },
40735
40754
  ],
40736
40755
  },
@@ -85558,6 +85577,7 @@ const openapi: OpenAPISpec = {
85558
85577
  'acs_system_id',
85559
85578
  ],
85560
85579
  type: 'object',
85580
+ 'x-resource-type': 'user_identity',
85561
85581
  },
85562
85582
  ],
85563
85583
  },
@@ -85807,6 +85827,7 @@ const openapi: OpenAPISpec = {
85807
85827
  'acs_system_id',
85808
85828
  ],
85809
85829
  type: 'object',
85830
+ 'x-resource-type': 'user_identity',
85810
85831
  },
85811
85832
  ],
85812
85833
  },
@@ -86084,6 +86105,7 @@ const openapi: OpenAPISpec = {
86084
86105
  'acs_system_id',
86085
86106
  ],
86086
86107
  type: 'object',
86108
+ 'x-resource-type': 'user_identity',
86087
86109
  },
86088
86110
  ],
86089
86111
  },
@@ -86356,6 +86378,7 @@ const openapi: OpenAPISpec = {
86356
86378
  'acs_system_id',
86357
86379
  ],
86358
86380
  type: 'object',
86381
+ 'x-resource-type': 'user_identity',
86359
86382
  },
86360
86383
  ],
86361
86384
  },