@seamapi/types 1.908.0 → 1.910.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.908.0",
3
+ "version": "1.910.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -59,6 +59,7 @@ export {
59
59
  magic_link,
60
60
  access_code as managed_access_code,
61
61
  device as managed_device,
62
+ message_overrides,
62
63
  neutral_resource,
63
64
  noise_sensor_device_type,
64
65
  noise_threshold,
@@ -30,37 +30,6 @@ const provider_issue = common_access_code_error
30
30
  'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
31
31
  )
32
32
 
33
- const smartthings_failed_to_set_access_code_error = common_access_code_error
34
- .extend({
35
- error_code: z
36
- .literal('smartthings_failed_to_set_access_code')
37
- .describe(error_code_description),
38
- })
39
- .describe(
40
- `
41
- ---
42
- deprecated: Handled by the generic \`failed_to_set_on_device\` system.
43
- ---
44
- Failed to set code on SmartThings device.
45
- `,
46
- )
47
-
48
- const smartthings_failed_to_set_after_multiple_retries =
49
- common_access_code_error
50
- .extend({
51
- error_code: z
52
- .literal('smartthings_failed_to_set_after_multiple_retries')
53
- .describe(error_code_description),
54
- })
55
- .describe(
56
- `
57
- ---
58
- deprecated: Handled by the generic \`failed_to_set_on_device\` system.
59
- ---
60
- Failed to set code after multiple retries.
61
- `,
62
- )
63
-
64
33
  const modified_field = z.object({
65
34
  field: z
66
35
  .string()
@@ -157,36 +126,6 @@ const access_code_state_unconfirmed = common_access_code_error
157
126
  'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
158
127
  )
159
128
 
160
- const kwikset_unable_to_confirm_code = common_access_code_error
161
- .extend({
162
- error_code: z
163
- .literal('kwikset_unable_to_confirm_code')
164
- .describe(error_code_description),
165
- })
166
- .describe(
167
- `
168
- ---
169
- deprecated: Use \`access_code_state_unconfirmed\` instead.
170
- ---
171
- Unable to confirm that the access code is set on Kwikset device.
172
- `,
173
- )
174
-
175
- const kwikset_unable_to_confirm_deletion = common_access_code_error
176
- .extend({
177
- error_code: z
178
- .literal('kwikset_unable_to_confirm_deletion')
179
- .describe(error_code_description),
180
- })
181
- .describe(
182
- `
183
- ---
184
- deprecated: Use \`access_code_state_unconfirmed\` instead.
185
- ---
186
- Unable to confirm the deletion of the access code on Kwikset device.
187
- `,
188
- )
189
-
190
129
  const insufficient_permissions = common_access_code_error
191
130
  .extend({
192
131
  error_code: z
@@ -197,51 +136,6 @@ const insufficient_permissions = common_access_code_error
197
136
  'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
198
137
  )
199
138
 
200
- const august_lock_invalid_code_length = common_access_code_error
201
- .extend({
202
- error_code: z
203
- .literal('august_lock_invalid_code_length')
204
- .describe(error_code_description),
205
- })
206
- .describe(
207
- `
208
- ---
209
- deprecated: Use \`provider_issue\` instead.
210
- ---
211
- Invalid code length for August lock.
212
- `,
213
- )
214
-
215
- const august_lock_temporarily_offline_error = common_access_code_error
216
- .extend({
217
- error_code: z
218
- .literal('august_lock_temporarily_offline')
219
- .describe(error_code_description),
220
- })
221
- .describe(
222
- `
223
- ---
224
- deprecated: Use \`provider_issue\` instead.
225
- ---
226
- August lock is temporarily offline.
227
- `,
228
- )
229
-
230
- const august_lock_missing_keypad = common_access_code_error
231
- .extend({
232
- error_code: z
233
- .literal('august_lock_missing_keypad')
234
- .describe(error_code_description),
235
- })
236
- .describe(
237
- `
238
- ---
239
- deprecated: Use \`provider_issue\` instead.
240
- ---
241
- August lock is missing a keypad.
242
- `,
243
- )
244
-
245
139
  const access_code_inactive_error = common_access_code_error
246
140
  .extend({
247
141
  error_code: z
@@ -267,66 +161,6 @@ const salto_ks_user_not_subscribed = common_access_code_error
267
161
  `,
268
162
  )
269
163
 
270
- const wyze_duplicate_code_name = common_access_code_error
271
- .extend({
272
- error_code: z
273
- .literal('wyze_duplicate_code_name')
274
- .describe(error_code_description),
275
- })
276
- .describe(
277
- `
278
- ---
279
- deprecated: Use \`duplicate_code_on_device\` instead.
280
- ---
281
- Duplicate access code name detected.
282
- `,
283
- )
284
-
285
- const wyze_potential_duplicate_code = common_access_code_error
286
- .extend({
287
- error_code: z
288
- .literal('wyze_potential_duplicate_code')
289
- .describe(error_code_description),
290
- })
291
- .describe(
292
- `
293
- ---
294
- deprecated: Use \`duplicate_code_on_device\` instead.
295
- ---
296
- Potential duplicate access code detected.
297
- `,
298
- )
299
-
300
- const dormakaba_oracode_invalid_time_range = common_access_code_error
301
- .extend({
302
- error_code: z
303
- .literal('dormakaba_oracode_invalid_time_range')
304
- .describe(error_code_description),
305
- })
306
- .describe(
307
- `
308
- ---
309
- deprecated: Use \`provider_issue\` instead.
310
- ---
311
- No Dormakaba Oracode user levels configured for the requested time range.
312
- `,
313
- )
314
-
315
- const keynest_unsupported_third_party_locker = common_access_code_error
316
- .extend({
317
- error_code: z
318
- .literal('keynest_unsupported_third_party_locker')
319
- .describe(error_code_description),
320
- })
321
- .describe(
322
- `
323
- ---
324
- deprecated: Use \`provider_issue\` instead.
325
- ---
326
- KeyNest locker is not supported.
327
- `,
328
- )
329
-
330
164
  const replaced_by_newer_access_code = common_access_code_error
331
165
  .extend({
332
166
  error_code: z
@@ -340,28 +174,16 @@ const replaced_by_newer_access_code = common_access_code_error
340
174
  const access_code_error = z
341
175
  .discriminatedUnion('error_code', [
342
176
  provider_issue,
343
- smartthings_failed_to_set_access_code_error,
344
- smartthings_failed_to_set_after_multiple_retries,
345
177
  failed_to_set_on_device,
346
178
  failed_to_remove_from_device,
347
179
  duplicate_code_on_device,
348
180
  duplicate_code_attempt_prevented,
349
181
  no_space_for_access_code_on_device,
350
182
  access_code_state_unconfirmed,
351
- kwikset_unable_to_confirm_code,
352
-
353
- kwikset_unable_to_confirm_deletion,
354
183
  code_modified_external_to_seam_error,
355
- august_lock_invalid_code_length,
356
- august_lock_missing_keypad,
357
- august_lock_temporarily_offline_error,
358
184
  access_code_inactive_error,
359
185
  salto_ks_user_not_subscribed,
360
- wyze_duplicate_code_name,
361
- wyze_potential_duplicate_code,
362
- dormakaba_oracode_invalid_time_range,
363
186
  insufficient_permissions,
364
- keynest_unsupported_third_party_locker,
365
187
  replaced_by_newer_access_code,
366
188
  ])
367
189
  .describe(
@@ -372,10 +194,6 @@ export type AccessCodeError = z.infer<typeof access_code_error>
372
194
 
373
195
  const _access_code_error_map = z.object({
374
196
  provider_issue: provider_issue.optional().nullable(),
375
- smartthings_failed_to_set_access_code:
376
- smartthings_failed_to_set_access_code_error.optional().nullable(),
377
- smartthings_failed_to_set_after_multiple_retries:
378
- smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
379
197
  failed_to_set_on_device: failed_to_set_on_device.optional().nullable(),
380
198
  failed_to_remove_from_device: failed_to_remove_from_device
381
199
  .optional()
@@ -390,37 +208,14 @@ const _access_code_error_map = z.object({
390
208
  access_code_state_unconfirmed: access_code_state_unconfirmed
391
209
  .optional()
392
210
  .nullable(),
393
- kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code
394
- .optional()
395
- .nullable(),
396
- kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion
397
- .optional()
398
- .nullable(),
399
211
  insufficient_permissions: insufficient_permissions.optional().nullable(),
400
212
  code_modified_external_to_seam_error: code_modified_external_to_seam_error
401
213
  .optional()
402
214
  .nullable(),
403
- august_lock_invalid_code_length: august_lock_invalid_code_length
404
- .optional()
405
- .nullable(),
406
- august_lock_temporarily_offline: august_lock_temporarily_offline_error
407
- .optional()
408
- .nullable(),
409
- august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(),
410
215
  access_code_inactive: access_code_inactive_error.optional().nullable(),
411
216
  salto_ks_user_not_subscribed: salto_ks_user_not_subscribed
412
217
  .optional()
413
218
  .nullable(),
414
- wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(),
415
- wyze_potential_duplicate_code: wyze_potential_duplicate_code
416
- .optional()
417
- .nullable(),
418
- dormakaba_oracode_invalid_time_range: dormakaba_oracode_invalid_time_range
419
- .optional()
420
- .nullable(),
421
- keynest_unsupported_third_party_locker: keynest_unsupported_third_party_locker
422
- .optional()
423
- .nullable(),
424
219
  replaced_by_newer_access_code: replaced_by_newer_access_code
425
220
  .optional()
426
221
  .nullable(),
@@ -444,22 +239,6 @@ const common_access_code_warning = z.object({
444
239
  const warning_code_description =
445
240
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
446
241
 
447
- const smartthings_failed_to_set_access_code_warning = common_access_code_warning
448
- .extend({
449
- warning_code: z
450
- .literal('smartthings_failed_to_set_access_code')
451
- .describe(warning_code_description),
452
- })
453
- .describe('Failed to set code on SmartThings device.')
454
-
455
- const august_lock_temporarily_offline_warning = common_access_code_warning
456
- .extend({
457
- warning_code: z
458
- .literal('august_lock_temporarily_offline')
459
- .describe(error_code_description),
460
- })
461
- .describe('August lock is temporarily offline.')
462
-
463
242
  const code_modified_external_to_seam_warning = common_access_code_warning
464
243
  .extend({
465
244
  warning_code: z
@@ -507,21 +286,6 @@ const provider_issue_warning = common_access_code_warning
507
286
  'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
508
287
  )
509
288
 
510
- const schlage_creation_outage = common_access_code_warning
511
- .extend({
512
- warning_code: z
513
- .literal('schlage_creation_outage')
514
- .describe(warning_code_description),
515
- })
516
- .describe(
517
- `
518
- ---
519
- deprecated: Use \`provider_issue\` instead.
520
- ---
521
- Received an error when attempting to create this code.
522
- `,
523
- )
524
-
525
289
  const schlage_access_code_ambiguous_timezone_dst_risk =
526
290
  common_access_code_warning
527
291
  .extend({
@@ -575,14 +339,6 @@ const management_transferred = common_access_code_warning
575
339
  })
576
340
  .describe('Management was transferred to another workspace.')
577
341
 
578
- const kwikset_unable_to_confirm_code_warning = common_access_code_warning
579
- .extend({
580
- warning_code: z
581
- .literal('kwikset_unable_to_confirm_code')
582
- .describe(warning_code_description),
583
- })
584
- .describe('Unable to confirm that the access code is set on Kwikset device.')
585
-
586
342
  const access_code_inactive = common_access_code_warning
587
343
  .extend({
588
344
  warning_code: z
@@ -593,21 +349,6 @@ const access_code_inactive = common_access_code_warning
593
349
  'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
594
350
  )
595
351
 
596
- const ultraloq_access_code_disabled = common_access_code_warning
597
- .extend({
598
- warning_code: z
599
- .literal('ultraloq_access_code_disabled')
600
- .describe(warning_code_description),
601
- })
602
- .describe(
603
- `
604
- ---
605
- deprecated: Use \`access_code_inactive\` instead.
606
- ---
607
- Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.
608
- `,
609
- )
610
-
611
352
  const using_backup_access_code = common_access_code_warning
612
353
  .extend({
613
354
  warning_code: z
@@ -627,20 +368,15 @@ const being_deleted = common_access_code_warning
627
368
  const access_code_warning = z
628
369
  .discriminatedUnion('warning_code', [
629
370
  provider_issue_warning,
630
- smartthings_failed_to_set_access_code_warning,
631
371
  schlage_detected_duplicate,
632
- schlage_creation_outage,
633
372
  schlage_access_code_ambiguous_timezone_dst_risk,
634
373
  code_modified_external_to_seam_warning,
635
374
  delay_in_setting_on_device,
636
375
  delay_in_removing_from_device,
637
376
  third_party_integration_detected,
638
- august_lock_temporarily_offline_warning,
639
377
  igloo_algopin_must_be_used_within_24_hours,
640
378
  management_transferred,
641
- kwikset_unable_to_confirm_code_warning,
642
379
  access_code_inactive,
643
- ultraloq_access_code_disabled,
644
380
  using_backup_access_code,
645
381
  being_deleted,
646
382
  ])
@@ -652,10 +388,7 @@ export type AccessCodeWarning = z.infer<typeof access_code_warning>
652
388
 
653
389
  const _access_code_warning_map = z.object({
654
390
  provider_issue: provider_issue_warning.optional().nullable(),
655
- smartthings_failed_to_set_access_code:
656
- smartthings_failed_to_set_access_code_warning.optional().nullable(),
657
391
  schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
658
- schlage_creation_outage: schlage_creation_outage.optional().nullable(),
659
392
  schlage_access_code_ambiguous_timezone_dst_risk:
660
393
  schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(),
661
394
  code_modified_external_to_seam_warning: code_modified_external_to_seam_warning
@@ -668,19 +401,10 @@ const _access_code_warning_map = z.object({
668
401
  third_party_integration_detected: third_party_integration_detected
669
402
  .optional()
670
403
  .nullable(),
671
- august_lock_temporarily_offline: august_lock_temporarily_offline_warning
672
- .optional()
673
- .nullable(),
674
404
  igloo_algopin_must_be_used_within_24_hours:
675
405
  igloo_algopin_must_be_used_within_24_hours.optional().nullable(),
676
406
  management_transferred: management_transferred.optional().nullable(),
677
- kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning
678
- .optional()
679
- .nullable(),
680
407
  access_code_inactive: access_code_inactive.optional().nullable(),
681
- ultraloq_access_code_disabled: ultraloq_access_code_disabled
682
- .optional()
683
- .nullable(),
684
408
  using_backup_access_code: using_backup_access_code.optional().nullable(),
685
409
  being_deleted: being_deleted.optional().nullable(),
686
410
  })
@@ -11,6 +11,14 @@ export const customer_portal_theme = z.object({
11
11
  mono_font_family: z.string().optional(),
12
12
  })
13
13
 
14
+ // Per-locale portal label/terminology overrides:
15
+ // { [locale]: { ["Namespace.key"]: "Override string" } }
16
+ // e.g. { "en-US": { "Reservations.reservation": "Booking" } }
17
+ export const message_overrides = z.record(
18
+ z.string(),
19
+ z.record(z.string(), z.string()),
20
+ )
21
+
14
22
  export const customization_profile = z.object({
15
23
  workspace_id: z.string().uuid(),
16
24
  name: z.string().nullable(),
@@ -20,6 +28,7 @@ export const customization_profile = z.object({
20
28
  primary_color: z.string().optional(),
21
29
  secondary_color: z.string().optional(),
22
30
  customer_portal_theme: customer_portal_theme.optional(),
31
+ message_overrides: message_overrides.optional(),
23
32
  }).describe(`
24
33
  ---
25
34
  title: Customization Profile