@seamapi/types 1.337.0 → 1.338.1

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 (28) hide show
  1. package/dist/connect.cjs +3798 -4561
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +807 -1132
  4. package/lib/seam/connect/models/acs/acs-access-group.js +5 -1
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.js +14 -8
  7. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-encoder.js +5 -1
  9. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-user.js +12 -9
  11. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device.d.ts +37 -0
  13. package/lib/seam/connect/models/devices/device.js +9 -0
  14. package/lib/seam/connect/models/devices/device.js.map +1 -1
  15. package/lib/seam/connect/models/devices/phone.d.ts +16 -0
  16. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +16 -0
  17. package/lib/seam/connect/openapi.d.ts +844 -1280
  18. package/lib/seam/connect/openapi.js +3157 -3947
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +69 -0
  21. package/package.json +2 -2
  22. package/src/lib/seam/connect/models/acs/acs-access-group.ts +5 -1
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +20 -14
  24. package/src/lib/seam/connect/models/acs/acs-encoder.ts +5 -1
  25. package/src/lib/seam/connect/models/acs/acs-user.ts +15 -14
  26. package/src/lib/seam/connect/models/devices/device.ts +12 -0
  27. package/src/lib/seam/connect/openapi.ts +4757 -5651
  28. package/src/lib/seam/connect/route-types.ts +86 -0
@@ -6228,6 +6228,7 @@ export interface Routes {
6228
6228
  };
6229
6229
  formData: {};
6230
6230
  jsonResponse: {
6231
+ /** */
6231
6232
  acs_access_group: {
6232
6233
  /** ID of the access group. */
6233
6234
  acs_access_group_id: string;
@@ -13722,6 +13723,10 @@ export interface Routes {
13722
13723
  message: string;
13723
13724
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13724
13725
  warning_code: 'salto_privacy_mode';
13726
+ } | {
13727
+ message: string;
13728
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13729
+ warning_code: 'unknown_issue_with_phone';
13725
13730
  }>;
13726
13731
  /** Date and time at which the device object was created. */
13727
13732
  created_at: string;
@@ -14403,6 +14408,10 @@ export interface Routes {
14403
14408
  message: string;
14404
14409
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14405
14410
  warning_code: 'salto_privacy_mode';
14411
+ } | {
14412
+ message: string;
14413
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14414
+ warning_code: 'unknown_issue_with_phone';
14406
14415
  }>;
14407
14416
  /** Date and time at which the device object was created. */
14408
14417
  created_at: string;
@@ -14653,6 +14662,10 @@ export interface Routes {
14653
14662
  message: string;
14654
14663
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14655
14664
  warning_code: 'salto_privacy_mode';
14665
+ } | {
14666
+ message: string;
14667
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14668
+ warning_code: 'unknown_issue_with_phone';
14656
14669
  }>;
14657
14670
  /** Date and time at which the device object was created. */
14658
14671
  created_at: string;
@@ -14912,6 +14925,10 @@ export interface Routes {
14912
14925
  message: string;
14913
14926
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14914
14927
  warning_code: 'salto_privacy_mode';
14928
+ } | {
14929
+ message: string;
14930
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14931
+ warning_code: 'unknown_issue_with_phone';
14915
14932
  }>;
14916
14933
  /** Date and time at which the device object was created. */
14917
14934
  created_at: string;
@@ -18022,6 +18039,10 @@ export interface Routes {
18022
18039
  message: string;
18023
18040
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18024
18041
  warning_code: 'salto_privacy_mode';
18042
+ } | {
18043
+ message: string;
18044
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18045
+ warning_code: 'unknown_issue_with_phone';
18025
18046
  }>;
18026
18047
  /** Date and time at which the device object was created. */
18027
18048
  created_at: string;
@@ -18667,6 +18688,10 @@ export interface Routes {
18667
18688
  message: string;
18668
18689
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18669
18690
  warning_code: 'salto_privacy_mode';
18691
+ } | {
18692
+ message: string;
18693
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18694
+ warning_code: 'unknown_issue_with_phone';
18670
18695
  }>;
18671
18696
  /** Date and time at which the device object was created. */
18672
18697
  created_at: string;
@@ -19348,6 +19373,10 @@ export interface Routes {
19348
19373
  message: string;
19349
19374
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19350
19375
  warning_code: 'salto_privacy_mode';
19376
+ } | {
19377
+ message: string;
19378
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19379
+ warning_code: 'unknown_issue_with_phone';
19351
19380
  }>;
19352
19381
  /** Date and time at which the device object was created. */
19353
19382
  created_at: string;
@@ -19992,6 +20021,10 @@ export interface Routes {
19992
20021
  message: string;
19993
20022
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19994
20023
  warning_code: 'salto_privacy_mode';
20024
+ } | {
20025
+ message: string;
20026
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20027
+ warning_code: 'unknown_issue_with_phone';
19995
20028
  }>;
19996
20029
  /** Date and time at which the device object was created. */
19997
20030
  created_at: string;
@@ -22446,6 +22479,10 @@ export interface Routes {
22446
22479
  message: string;
22447
22480
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22448
22481
  warning_code: 'salto_privacy_mode';
22482
+ } | {
22483
+ message: string;
22484
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22485
+ warning_code: 'unknown_issue_with_phone';
22449
22486
  }>;
22450
22487
  /** Date and time at which the device object was created. */
22451
22488
  created_at: string;
@@ -23090,6 +23127,10 @@ export interface Routes {
23090
23127
  message: string;
23091
23128
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23092
23129
  warning_code: 'salto_privacy_mode';
23130
+ } | {
23131
+ message: string;
23132
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23133
+ warning_code: 'unknown_issue_with_phone';
23093
23134
  }>;
23094
23135
  /** Date and time at which the device object was created. */
23095
23136
  created_at: string;
@@ -25982,6 +26023,10 @@ export interface Routes {
25982
26023
  message: string;
25983
26024
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25984
26025
  warning_code: 'salto_privacy_mode';
26026
+ } | {
26027
+ message: string;
26028
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26029
+ warning_code: 'unknown_issue_with_phone';
25985
26030
  }>;
25986
26031
  /** Date and time at which the device object was created. */
25987
26032
  created_at: string;
@@ -26194,6 +26239,10 @@ export interface Routes {
26194
26239
  message: string;
26195
26240
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26196
26241
  warning_code: 'salto_privacy_mode';
26242
+ } | {
26243
+ message: string;
26244
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26245
+ warning_code: 'unknown_issue_with_phone';
26197
26246
  }>;
26198
26247
  /** Date and time at which the device object was created. */
26199
26248
  created_at: string;
@@ -28645,6 +28694,10 @@ export interface Routes {
28645
28694
  message: string;
28646
28695
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
28647
28696
  warning_code: 'salto_privacy_mode';
28697
+ } | {
28698
+ message: string;
28699
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
28700
+ warning_code: 'unknown_issue_with_phone';
28648
28701
  }>;
28649
28702
  /** Date and time at which the device object was created. */
28650
28703
  created_at: string;
@@ -31080,6 +31133,10 @@ export interface Routes {
31080
31133
  message: string;
31081
31134
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31082
31135
  warning_code: 'salto_privacy_mode';
31136
+ } | {
31137
+ message: string;
31138
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31139
+ warning_code: 'unknown_issue_with_phone';
31083
31140
  }>;
31084
31141
  /** Date and time at which the device object was created. */
31085
31142
  created_at: string;
@@ -31724,6 +31781,10 @@ export interface Routes {
31724
31781
  message: string;
31725
31782
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31726
31783
  warning_code: 'salto_privacy_mode';
31784
+ } | {
31785
+ message: string;
31786
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31787
+ warning_code: 'unknown_issue_with_phone';
31727
31788
  }>;
31728
31789
  /** Date and time at which the device object was created. */
31729
31790
  created_at: string;
@@ -35484,6 +35545,10 @@ export interface Routes {
35484
35545
  message: string;
35485
35546
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
35486
35547
  warning_code: 'salto_privacy_mode';
35548
+ } | {
35549
+ message: string;
35550
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
35551
+ warning_code: 'unknown_issue_with_phone';
35487
35552
  }>;
35488
35553
  /** Date and time at which the device object was created. */
35489
35554
  created_at: string;
@@ -36130,6 +36195,10 @@ export interface Routes {
36130
36195
  message: string;
36131
36196
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36132
36197
  warning_code: 'salto_privacy_mode';
36198
+ } | {
36199
+ message: string;
36200
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36201
+ warning_code: 'unknown_issue_with_phone';
36133
36202
  }>;
36134
36203
  /** Date and time at which the device object was created. */
36135
36204
  created_at: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.337.0",
3
+ "version": "1.338.1",
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.33.0",
95
+ "@seamapi/blueprint": "^0.34.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -109,7 +109,11 @@ export const acs_access_group = common_acs_access_group.extend({
109
109
  `)
110
110
  export const unmanaged_acs_access_group = common_acs_access_group.extend({
111
111
  is_managed: z.literal(false),
112
- })
112
+ }).describe(`
113
+ ---
114
+ route_path: /acs/access_groups/unmanaged
115
+ ---
116
+ `)
113
117
 
114
118
  export type AcsAccessGroup = z.output<typeof acs_access_group>
115
119
  export type UnmanagedAcsAccessGroup = z.output<
@@ -233,21 +233,27 @@ const common_acs_credential = z.object({
233
233
  .describe('Vostio-specific metadata for the credential.'),
234
234
  })
235
235
 
236
- export const acs_credential = common_acs_credential
237
- .merge(
238
- z.object({
239
- is_managed: z.literal(true),
240
- }),
241
- )
242
- .describe(getAcsCredentialDescription())
236
+ export const acs_credential = common_acs_credential.merge(
237
+ z.object({
238
+ is_managed: z.literal(true),
239
+ }),
240
+ ).describe(`
241
+ ---
242
+ route_path: /acs/credentials
243
+ ---
244
+ ${getAcsCredentialDescription()}
245
+ `)
243
246
 
244
- export const unmanaged_acs_credential = common_acs_credential
245
- .merge(
246
- z.object({
247
- is_managed: z.literal(false),
248
- }),
249
- )
250
- .describe(getAcsCredentialDescription(false))
247
+ export const unmanaged_acs_credential = common_acs_credential.merge(
248
+ z.object({
249
+ is_managed: z.literal(false),
250
+ }),
251
+ ).describe(`
252
+ ---
253
+ route_path: /acs/credentials/unmanaged
254
+ ---
255
+ ${getAcsCredentialDescription(false)}
256
+ `)
251
257
 
252
258
  function getAcsCredentialDescription(is_managed = true): string {
253
259
  const resource_name = is_managed
@@ -53,6 +53,10 @@ export const acs_encoder = z.object({
53
53
  .datetime()
54
54
  .describe('Date and time at which the `acs_encoder` was created.'),
55
55
  display_name: z.string().describe('Display name for the `acs_encoder`.'),
56
- })
56
+ }).describe(`
57
+ ---
58
+ route_path: /acs/encoders
59
+ ---
60
+ `)
57
61
 
58
62
  export type AcsEncoder = z.infer<typeof acs_encoder>
@@ -295,21 +295,22 @@ export const acs_user = common_acs_user.merge(
295
295
  is_managed: z.literal(true),
296
296
  }),
297
297
  ).describe(`
298
- ---
299
- route_path: /acs/users
300
- ---
301
- Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
302
- `)
298
+ ---
299
+ route_path: /acs/users
300
+ ---
301
+ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
302
+ `)
303
303
 
304
- export const unmanaged_acs_user = common_acs_user
305
- .merge(
306
- z.object({
307
- is_managed: z.literal(false),
308
- }),
309
- )
310
- .describe(
311
- 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
312
- )
304
+ export const unmanaged_acs_user = common_acs_user.merge(
305
+ z.object({
306
+ is_managed: z.literal(false),
307
+ }),
308
+ ).describe(`
309
+ ---
310
+ route_path: /acs/users/unmanaged
311
+ ---
312
+ Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
313
+ `)
313
314
 
314
315
  export type AcsUser = z.output<typeof acs_user>
315
316
  export type AcsUnmanagedUser = z.output<typeof unmanaged_acs_user>
@@ -274,6 +274,17 @@ const device_has_flaky_connection = common_device_warning
274
274
  })
275
275
  .describe('Device has flaky connection.')
276
276
 
277
+ export const unknown_issue_with_phone = common_device_warning
278
+ .extend({
279
+ warning_code: z
280
+ .literal('unknown_issue_with_phone')
281
+ .describe(warning_code_description),
282
+ })
283
+ .describe(
284
+ 'An unknown issue occurred while syncing the state of this phone with the provider. ' +
285
+ 'This issue may affect the proper functioning of this phone.',
286
+ )
287
+
277
288
  const device_warning = z.union([
278
289
  partial_backup_access_code_pool,
279
290
  many_active_backup_codes,
@@ -290,6 +301,7 @@ const device_warning = z.union([
290
301
  device_has_flaky_connection,
291
302
  salto_office_mode,
292
303
  salto_privacy_mode,
304
+ unknown_issue_with_phone,
293
305
  ])
294
306
 
295
307
  export type DeviceWarning = z.infer<typeof device_warning>