@seamapi/types 1.1101.0 → 1.1103.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.
Files changed (29) hide show
  1. package/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
  2. package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
  3. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  4. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
  7. package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
  11. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  12. package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
  13. package/lib/seam/connect/models/devices/phone.js +4 -19
  14. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  15. package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
  16. package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
  17. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  18. package/lib/seam/connect/openapi.js +1329 -214
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1319 -353
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
  23. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
  24. package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
  25. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
  26. package/src/lib/seam/connect/models/devices/phone.ts +4 -27
  27. package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
  28. package/src/lib/seam/connect/openapi.ts +1505 -203
  29. package/src/lib/seam/connect/route-types.ts +1526 -428
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1101.0",
3
+ "version": "1.1103.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -94,21 +94,29 @@ const underprovisioned_access = common_access_grant_warning
94
94
  'Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.',
95
95
  )
96
96
 
97
+ export const access_code_revocation_failure_code = z
98
+ .enum(['offline_access_code_not_revocable'])
99
+ .describe('Reason the access code could not be revoked.')
100
+
101
+ export type AccessCodeRevocationFailureCode = z.infer<
102
+ typeof access_code_revocation_failure_code
103
+ >
104
+
97
105
  const overprovisioned_failed_device = z.object({
98
106
  device_id: z
99
107
  .string()
100
108
  .uuid()
101
109
  .describe('Device whose access code could not be revoked.'),
102
- error_code: z
103
- .string()
104
- .describe(
105
- 'Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).',
106
- ),
110
+ error_code: access_code_revocation_failure_code,
107
111
  message: z
108
112
  .string()
109
113
  .describe('Human-readable description of why revocation failed.'),
110
114
  })
111
115
 
116
+ export type AccessGrantOverprovisionedFailedDevice = z.infer<
117
+ typeof overprovisioned_failed_device
118
+ >
119
+
112
120
  const overprovisioned_access = common_access_grant_warning
113
121
  .extend({
114
122
  warning_code: z
@@ -47,7 +47,7 @@ const acs_access_groups_failed_to_create_on_acs_system =
47
47
  Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
48
48
  `)
49
49
 
50
- const acs_access_group_errors = z
50
+ const acs_access_group_error = z
51
51
  .discriminatedUnion('error_code', [
52
52
  acs_access_groups_failed_to_create_on_acs_system,
53
53
  ])
@@ -148,7 +148,7 @@ const common_acs_access_group = z.object({
148
148
  'Date and time at which the access group was created.',
149
149
  ),
150
150
  errors: z
151
- .array(acs_access_group_errors)
151
+ .array(acs_access_group_error)
152
152
  .describe('Errors associated with the `acs_access_group`.'),
153
153
  warnings: z
154
154
  .array(acs_access_group_warning)
@@ -15,6 +15,41 @@ import {
15
15
  } from './metadata/index.js'
16
16
  import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js'
17
17
 
18
+ const error_code_description =
19
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
20
+
21
+ const common_acs_entrance_error = z.object({
22
+ created_at: datetime.describe(
23
+ 'Date and time at which Seam created the error.',
24
+ ),
25
+ message: z
26
+ .string()
27
+ .describe(
28
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
29
+ ),
30
+ })
31
+
32
+ const entrance_removed = common_acs_entrance_error.extend({
33
+ error_code: z.literal('entrance_removed').describe(error_code_description),
34
+ }).describe(`
35
+ ---
36
+ resource_type: acs_entrance
37
+ ---
38
+ Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.
39
+ `)
40
+
41
+ const acs_entrance_error = z
42
+ .discriminatedUnion('error_code', [entrance_removed])
43
+ .describe(
44
+ 'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
45
+ )
46
+
47
+ const _acs_entrance_error_map = z.object({
48
+ entrance_removed: entrance_removed.optional().nullable(),
49
+ })
50
+
51
+ export type AcsEntranceErrorMap = z.infer<typeof _acs_entrance_error_map>
52
+
18
53
  const warning_code_description =
19
54
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
20
55
 
@@ -167,23 +202,7 @@ export const acs_entrance = z
167
202
  'ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
168
203
  ),
169
204
  errors: z
170
- .array(
171
- z.object({
172
- error_code: z
173
- .string()
174
- .describe(
175
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
176
- ),
177
- message: z
178
- .string()
179
- .describe(
180
- 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
181
- ),
182
- created_at: datetime.describe(
183
- 'Date and time at which Seam created the error.',
184
- ),
185
- }),
186
- )
205
+ .array(acs_entrance_error)
187
206
  .describe(
188
207
  'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
189
208
  ),
@@ -32,7 +32,7 @@ const common_acs_user_error = z.object({
32
32
  ),
33
33
  })
34
34
 
35
- const acs_users_deleted_externally = common_acs_user_error.extend({
35
+ const acs_user_deleted_externally = common_acs_user_error.extend({
36
36
  error_code: z.literal('deleted_externally'),
37
37
  }).describe(`
38
38
  ---
@@ -41,7 +41,7 @@ const acs_users_deleted_externally = common_acs_user_error.extend({
41
41
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam.
42
42
  `)
43
43
 
44
- const acs_users_salto_ks_subscription_limit_exceeded =
44
+ const acs_user_salto_ks_subscription_limit_exceeded =
45
45
  common_acs_user_error.extend({
46
46
  error_code: z.literal('salto_ks_subscription_limit_exceeded'),
47
47
  }).describe(`
@@ -51,7 +51,7 @@ const acs_users_salto_ks_subscription_limit_exceeded =
51
51
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
52
52
  `)
53
53
 
54
- const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
54
+ const acs_user_failed_to_create_on_acs_system = common_acs_user_error.extend({
55
55
  error_code: z.literal('failed_to_create_on_acs_system'),
56
56
  }).describe(`
57
57
  ---
@@ -60,7 +60,7 @@ const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
60
60
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
61
61
  `)
62
62
 
63
- const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
63
+ const acs_user_failed_to_update_on_acs_system = common_acs_user_error.extend({
64
64
  error_code: z.literal('failed_to_update_on_acs_system'),
65
65
  }).describe(`
66
66
  ---
@@ -69,7 +69,7 @@ const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
69
69
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
70
70
  `)
71
71
 
72
- const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
72
+ const acs_user_failed_to_delete_on_acs_system = common_acs_user_error.extend({
73
73
  error_code: z.literal('failed_to_delete_on_acs_system'),
74
74
  }).describe(`
75
75
  ---
@@ -78,48 +78,52 @@ const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
78
78
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
79
79
  `)
80
80
 
81
- const acs_users_latch_conflict_with_resident_user =
82
- common_acs_user_error.extend({
81
+ const acs_user_latch_conflict_with_resident_user = common_acs_user_error.extend(
82
+ {
83
83
  error_code: z.literal('latch_conflict_with_resident_user'),
84
- }).describe(`
84
+ },
85
+ ).describe(`
85
86
  ---
86
87
  resource_type: acs_user
87
88
  ---
88
89
  Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
89
90
  `)
90
91
 
91
- const acs_user_errors = z
92
+ const acs_user_error = z
92
93
  .discriminatedUnion('error_code', [
93
- acs_users_deleted_externally,
94
- acs_users_salto_ks_subscription_limit_exceeded,
95
- acs_users_failed_to_create_on_acs_system,
96
- acs_users_failed_to_update_on_acs_system,
97
- acs_users_failed_to_delete_on_acs_system,
98
- acs_users_latch_conflict_with_resident_user,
94
+ acs_user_deleted_externally,
95
+ acs_user_salto_ks_subscription_limit_exceeded,
96
+ acs_user_failed_to_create_on_acs_system,
97
+ acs_user_failed_to_update_on_acs_system,
98
+ acs_user_failed_to_delete_on_acs_system,
99
+ acs_user_latch_conflict_with_resident_user,
99
100
  ])
100
101
  .describe(
101
102
  'Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
102
103
  )
103
104
 
104
- const _acs_users_error_map = z.object({
105
- deleted_externally: acs_users_deleted_externally.optional().nullable(),
105
+ const _acs_user_error_map = z.object({
106
+ deleted_externally: acs_user_deleted_externally.optional().nullable(),
106
107
  salto_ks_subscription_limit_exceeded:
107
- acs_users_salto_ks_subscription_limit_exceeded.optional().nullable(),
108
- failed_to_create_on_acs_system: acs_users_failed_to_create_on_acs_system
108
+ acs_user_salto_ks_subscription_limit_exceeded.optional().nullable(),
109
+ failed_to_create_on_acs_system: acs_user_failed_to_create_on_acs_system
109
110
  .optional()
110
111
  .nullable(),
111
- failed_to_update_on_acs_system: acs_users_failed_to_update_on_acs_system
112
+ failed_to_update_on_acs_system: acs_user_failed_to_update_on_acs_system
112
113
  .optional()
113
114
  .nullable(),
114
- failed_to_delete_on_acs_system: acs_users_failed_to_delete_on_acs_system
115
+ failed_to_delete_on_acs_system: acs_user_failed_to_delete_on_acs_system
115
116
  .optional()
116
117
  .nullable(),
117
- latch_conflict_with_resident_user: acs_users_latch_conflict_with_resident_user
118
+ latch_conflict_with_resident_user: acs_user_latch_conflict_with_resident_user
118
119
  .optional()
119
120
  .nullable(),
120
121
  })
121
122
 
122
- export type AcsUsersErrorMap = z.infer<typeof _acs_users_error_map>
123
+ export type AcsUserErrorMap = z.infer<typeof _acs_user_error_map>
124
+
125
+ /** @deprecated Use AcsUserErrorMap. */
126
+ export type AcsUsersErrorMap = AcsUserErrorMap
123
127
 
124
128
  const common_acs_user_warning = z.object({
125
129
  created_at: datetime.describe(
@@ -132,7 +136,7 @@ const common_acs_user_warning = z.object({
132
136
  ),
133
137
  })
134
138
 
135
- const acs_users_being_deleted = common_acs_user_warning
139
+ const acs_user_being_deleted = common_acs_user_warning
136
140
  .extend({
137
141
  warning_code: z.literal('being_deleted'),
138
142
  })
@@ -140,7 +144,7 @@ const acs_users_being_deleted = common_acs_user_warning
140
144
  'Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.',
141
145
  )
142
146
 
143
- const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
147
+ const acs_user_salto_ks_user_not_subscribed = common_acs_user_warning
144
148
  .extend({
145
149
  warning_code: z.literal('salto_ks_user_not_subscribed'),
146
150
  })
@@ -172,9 +176,9 @@ export const latch_resident_user = common_acs_user_warning
172
176
  'Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
173
177
  )
174
178
 
175
- const _acs_users_warning_map = z.object({
176
- being_deleted: acs_users_being_deleted.optional().nullable(),
177
- salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
179
+ const _acs_user_warning_map = z.object({
180
+ being_deleted: acs_user_being_deleted.optional().nullable(),
181
+ salto_ks_user_not_subscribed: acs_user_salto_ks_user_not_subscribed
178
182
  .optional()
179
183
  .nullable(),
180
184
  acs_user_inactive: acs_user_inactive.optional().nullable(),
@@ -184,10 +188,10 @@ const _acs_users_warning_map = z.object({
184
188
  latch_resident_user: latch_resident_user.optional().nullable(),
185
189
  })
186
190
 
187
- export const acs_users_warnings = z
191
+ export const acs_user_warning = z
188
192
  .discriminatedUnion('warning_code', [
189
- acs_users_being_deleted,
190
- acs_users_salto_ks_user_not_subscribed,
193
+ acs_user_being_deleted,
194
+ acs_user_salto_ks_user_not_subscribed,
191
195
  acs_user_inactive,
192
196
  unknown_issue_with_acs_user,
193
197
  latch_resident_user,
@@ -196,7 +200,13 @@ export const acs_users_warnings = z
196
200
  'Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
197
201
  )
198
202
 
199
- export type AcsUsersWarningMap = z.infer<typeof _acs_users_warning_map>
203
+ export type AcsUserWarningMap = z.infer<typeof _acs_user_warning_map>
204
+
205
+ /** @deprecated Use acs_user_warning. */
206
+ export const acs_users_warnings = acs_user_warning
207
+
208
+ /** @deprecated Use AcsUserWarningMap. */
209
+ export type AcsUsersWarningMap = AcsUserWarningMap
200
210
 
201
211
  const user_fields = z.object({
202
212
  full_name: z
@@ -311,12 +321,12 @@ const common_acs_user = z
311
321
  'Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
312
322
  ),
313
323
  warnings: z
314
- .array(acs_users_warnings)
324
+ .array(acs_user_warning)
315
325
  .describe(
316
326
  'Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
317
327
  ),
318
328
  errors: z
319
- .array(acs_user_errors)
329
+ .array(acs_user_error)
320
330
  .describe(
321
331
  'Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
322
332
  ),
@@ -1,6 +1,5 @@
1
1
  import * as z from 'zod/v3'
2
2
 
3
- import { datetime } from '../datetime.js'
4
3
  import { device } from './device.js'
5
4
  import { phone_device_type } from './device-type.js'
6
5
  import { phone_specific_properties } from './phone-properties.js'
@@ -14,6 +13,8 @@ const basePhoneDeviceSchema = device.pick({
14
13
  workspace_id: true,
15
14
  created_at: true,
16
15
  custom_metadata: true,
16
+ errors: true,
17
+ warnings: true,
17
18
  })
18
19
 
19
20
  export const phone = z.object({
@@ -35,32 +36,8 @@ export const phone = z.object({
35
36
  .describe(`Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
36
37
  `),
37
38
 
38
- errors: z
39
- .array(
40
- z.object({
41
- error_code: z
42
- .string()
43
- .describe('Unique identifier of the type of error.'),
44
- message: z.string().describe('Detailed description of the error.'),
45
- created_at: datetime.describe(
46
- 'Date and time at which Seam created the error.',
47
- ),
48
- }),
49
- )
50
- .describe('Errors associated with the phone.'),
51
- warnings: z
52
- .array(
53
- z.object({
54
- warning_code: z
55
- .string()
56
- .describe('Unique identifier of the type of warning.'),
57
- message: z.string().describe('Detailed description of the warning.'),
58
- created_at: datetime.describe(
59
- 'Date and time at which Seam created the warning.',
60
- ),
61
- }),
62
- )
63
- .describe('Warnings associated with the phone.'),
39
+ errors: basePhoneDeviceSchema.shape.errors,
40
+ warnings: basePhoneDeviceSchema.shape.warnings,
64
41
  device_type: phone_device_type.describe(
65
42
  'Type of the phone device, such as `ios_phone` or `android_phone`.',
66
43
  ),
@@ -83,7 +83,7 @@ const _user_identity_error_map = z.object({
83
83
 
84
84
  export type UserIdentityErrorMap = z.infer<typeof _user_identity_error_map>
85
85
 
86
- const user_identity_warnings = z
86
+ const user_identity_warning = z
87
87
  .discriminatedUnion('warning_code', [
88
88
  user_identity_being_deleted,
89
89
  acs_user_profile_does_not_match_user_identity,
@@ -98,7 +98,7 @@ const _user_identity_warning_map = z.object({
98
98
 
99
99
  export type UserIdentityWarningMap = z.infer<typeof _user_identity_warning_map>
100
100
 
101
- const user_identity_errors = z
101
+ const user_identity_error = z
102
102
  .discriminatedUnion('error_code', [user_identity_issue_with_acs_user])
103
103
  .describe('Errors associated with the user identity.')
104
104
 
@@ -146,12 +146,12 @@ export const user_identity = z.object({
146
146
  .uuid()
147
147
  .describe('ID of the workspace that contains the user identity.'),
148
148
  errors: z
149
- .array(user_identity_errors)
149
+ .array(user_identity_error)
150
150
  .describe(
151
151
  'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
152
152
  ),
153
153
  warnings: z
154
- .array(user_identity_warnings)
154
+ .array(user_identity_warning)
155
155
  .describe(
156
156
  'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
157
157
  ),