@seamapi/types 1.233.0 → 1.235.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 (30) hide show
  1. package/dist/connect.cjs +678 -11
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1514 -169
  4. package/lib/seam/connect/models/acs/acs-access-group.d.ts +45 -2
  5. package/lib/seam/connect/models/acs/acs-access-group.js +7 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-credential.d.ts +160 -2
  8. package/lib/seam/connect/models/acs/acs-credential.js +7 -1
  9. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-user.d.ts +114 -1
  11. package/lib/seam/connect/models/acs/acs-user.js +7 -1
  12. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  13. package/lib/seam/connect/models/acs/metadata/visionline.d.ts +9 -0
  14. package/lib/seam/connect/models/acs/metadata/visionline.js +3 -0
  15. package/lib/seam/connect/models/acs/metadata/visionline.js.map +1 -1
  16. package/lib/seam/connect/openapi.d.ts +867 -41
  17. package/lib/seam/connect/openapi.js +638 -3
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +206 -1
  20. package/lib/seam/connect/schemas.d.ts +1 -1
  21. package/lib/seam/connect/schemas.js +1 -1
  22. package/lib/seam/connect/schemas.js.map +1 -1
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/acs/acs-access-group.ts +11 -1
  25. package/src/lib/seam/connect/models/acs/acs-credential.ts +14 -1
  26. package/src/lib/seam/connect/models/acs/acs-user.ts +14 -1
  27. package/src/lib/seam/connect/models/acs/metadata/visionline.ts +3 -0
  28. package/src/lib/seam/connect/openapi.ts +638 -3
  29. package/src/lib/seam/connect/route-types.ts +246 -1
  30. package/src/lib/seam/connect/schemas.ts +3 -0
@@ -2139,6 +2139,7 @@ export interface Routes {
2139
2139
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2140
2140
  external_type_display_name: string;
2141
2141
  created_at: string;
2142
+ is_managed: true;
2142
2143
  };
2143
2144
  };
2144
2145
  };
@@ -2168,6 +2169,7 @@ export interface Routes {
2168
2169
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2169
2170
  external_type_display_name: string;
2170
2171
  created_at: string;
2172
+ is_managed: true;
2171
2173
  }>;
2172
2174
  };
2173
2175
  };
@@ -2248,6 +2250,7 @@ export interface Routes {
2248
2250
  email?: string | undefined;
2249
2251
  email_address?: string | undefined;
2250
2252
  phone_number?: string | undefined;
2253
+ is_managed: true;
2251
2254
  }>;
2252
2255
  };
2253
2256
  };
@@ -2263,6 +2266,65 @@ export interface Routes {
2263
2266
  formData: {};
2264
2267
  jsonResponse: {};
2265
2268
  };
2269
+ '/acs/access_groups/unmanaged/get': {
2270
+ route: '/acs/access_groups/unmanaged/get';
2271
+ method: 'GET' | 'POST';
2272
+ queryParams: {};
2273
+ jsonBody: {};
2274
+ commonParams: {
2275
+ acs_access_group_id: string;
2276
+ };
2277
+ formData: {};
2278
+ jsonResponse: {
2279
+ acs_access_group: {
2280
+ acs_access_group_id: string;
2281
+ acs_system_id: string;
2282
+ workspace_id: string;
2283
+ name: string;
2284
+ /**
2285
+ * @deprecated use external_type */
2286
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2287
+ /**
2288
+ * @deprecated use external_type_display_name */
2289
+ access_group_type_display_name: string;
2290
+ display_name: string;
2291
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2292
+ external_type_display_name: string;
2293
+ created_at: string;
2294
+ is_managed: false;
2295
+ };
2296
+ };
2297
+ };
2298
+ '/acs/access_groups/unmanaged/list': {
2299
+ route: '/acs/access_groups/unmanaged/list';
2300
+ method: 'GET' | 'POST';
2301
+ queryParams: {};
2302
+ jsonBody: {};
2303
+ commonParams: {
2304
+ acs_system_id?: string | undefined;
2305
+ acs_user_id?: string | undefined;
2306
+ };
2307
+ formData: {};
2308
+ jsonResponse: {
2309
+ acs_access_groups: Array<{
2310
+ acs_access_group_id: string;
2311
+ acs_system_id: string;
2312
+ workspace_id: string;
2313
+ name: string;
2314
+ /**
2315
+ * @deprecated use external_type */
2316
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2317
+ /**
2318
+ * @deprecated use external_type_display_name */
2319
+ access_group_type_display_name: string;
2320
+ display_name: string;
2321
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
2322
+ external_type_display_name: string;
2323
+ created_at: string;
2324
+ is_managed: false;
2325
+ }>;
2326
+ };
2327
+ };
2266
2328
  '/acs/credential_pools/list': {
2267
2329
  route: '/acs/credential_pools/list';
2268
2330
  method: 'GET' | 'POST';
@@ -2349,7 +2411,11 @@ export interface Routes {
2349
2411
  joiner_acs_credential_ids?: string[] | undefined;
2350
2412
  guest_acs_entrance_ids?: string[] | undefined;
2351
2413
  common_acs_entrance_ids?: string[] | undefined;
2414
+ is_valid?: boolean | undefined;
2415
+ card_id?: string | undefined;
2416
+ credential_id?: string | undefined;
2352
2417
  } | undefined;
2418
+ is_managed: true;
2353
2419
  };
2354
2420
  };
2355
2421
  };
@@ -2411,7 +2477,11 @@ export interface Routes {
2411
2477
  joiner_acs_credential_ids?: string[] | undefined;
2412
2478
  guest_acs_entrance_ids?: string[] | undefined;
2413
2479
  common_acs_entrance_ids?: string[] | undefined;
2480
+ is_valid?: boolean | undefined;
2481
+ card_id?: string | undefined;
2482
+ credential_id?: string | undefined;
2414
2483
  } | undefined;
2484
+ is_managed: true;
2415
2485
  };
2416
2486
  };
2417
2487
  };
@@ -2467,7 +2537,11 @@ export interface Routes {
2467
2537
  joiner_acs_credential_ids?: string[] | undefined;
2468
2538
  guest_acs_entrance_ids?: string[] | undefined;
2469
2539
  common_acs_entrance_ids?: string[] | undefined;
2540
+ is_valid?: boolean | undefined;
2541
+ card_id?: string | undefined;
2542
+ credential_id?: string | undefined;
2470
2543
  } | undefined;
2544
+ is_managed: true;
2471
2545
  };
2472
2546
  };
2473
2547
  };
@@ -2523,7 +2597,11 @@ export interface Routes {
2523
2597
  joiner_acs_credential_ids?: string[] | undefined;
2524
2598
  guest_acs_entrance_ids?: string[] | undefined;
2525
2599
  common_acs_entrance_ids?: string[] | undefined;
2600
+ is_valid?: boolean | undefined;
2601
+ card_id?: string | undefined;
2602
+ credential_id?: string | undefined;
2526
2603
  } | undefined;
2604
+ is_managed: true;
2527
2605
  }>;
2528
2606
  };
2529
2607
  };
@@ -2605,10 +2683,119 @@ export interface Routes {
2605
2683
  joiner_acs_credential_ids?: string[] | undefined;
2606
2684
  guest_acs_entrance_ids?: string[] | undefined;
2607
2685
  common_acs_entrance_ids?: string[] | undefined;
2686
+ is_valid?: boolean | undefined;
2687
+ card_id?: string | undefined;
2688
+ credential_id?: string | undefined;
2689
+ } | undefined;
2690
+ is_managed: true;
2691
+ };
2692
+ };
2693
+ };
2694
+ '/acs/credentials/unmanaged/get': {
2695
+ route: '/acs/credentials/unmanaged/get';
2696
+ method: 'GET' | 'POST';
2697
+ queryParams: {};
2698
+ jsonBody: {};
2699
+ commonParams: {
2700
+ acs_credential_id: string;
2701
+ };
2702
+ formData: {};
2703
+ jsonResponse: {
2704
+ acs_credential: {
2705
+ acs_credential_id: string;
2706
+ acs_user_id?: string | undefined;
2707
+ acs_credential_pool_id?: string | undefined;
2708
+ acs_system_id: string;
2709
+ parent_acs_credential_id?: string | undefined;
2710
+ display_name: string;
2711
+ code?: (string | undefined) | null;
2712
+ access_method: 'code' | 'card' | 'mobile_key';
2713
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
2714
+ external_type_display_name?: string | undefined;
2715
+ created_at: string;
2716
+ workspace_id: string;
2717
+ starts_at?: string | undefined;
2718
+ ends_at?: string | undefined;
2719
+ errors: Array<{
2720
+ error_code: string;
2721
+ message: string;
2722
+ }>;
2723
+ warnings: Array<{
2724
+ warning_code: string;
2725
+ message: string;
2726
+ }>;
2727
+ is_multi_phone_sync_credential?: boolean | undefined;
2728
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
2729
+ latest_desired_state_synced_with_provider_at?: string | undefined;
2730
+ visionline_metadata?: {
2731
+ card_function_type: 'guest' | 'staff';
2732
+ joiner_acs_credential_ids?: string[] | undefined;
2733
+ guest_acs_entrance_ids?: string[] | undefined;
2734
+ common_acs_entrance_ids?: string[] | undefined;
2735
+ is_valid?: boolean | undefined;
2736
+ card_id?: string | undefined;
2737
+ credential_id?: string | undefined;
2608
2738
  } | undefined;
2739
+ is_managed: false;
2609
2740
  };
2610
2741
  };
2611
2742
  };
2743
+ '/acs/credentials/unmanaged/list': {
2744
+ route: '/acs/credentials/unmanaged/list';
2745
+ method: 'GET' | 'POST';
2746
+ queryParams: {};
2747
+ jsonBody: {};
2748
+ commonParams: {
2749
+ acs_user_id: string;
2750
+ } | {
2751
+ acs_system_id: string;
2752
+ } | {
2753
+ acs_user_id: string;
2754
+ acs_system_id: string;
2755
+ } | {
2756
+ user_identity_id: string;
2757
+ };
2758
+ formData: {};
2759
+ jsonResponse: {
2760
+ acs_credentials: Array<{
2761
+ acs_credential_id: string;
2762
+ acs_user_id?: string | undefined;
2763
+ acs_credential_pool_id?: string | undefined;
2764
+ acs_system_id: string;
2765
+ parent_acs_credential_id?: string | undefined;
2766
+ display_name: string;
2767
+ code?: (string | undefined) | null;
2768
+ access_method: 'code' | 'card' | 'mobile_key';
2769
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
2770
+ external_type_display_name?: string | undefined;
2771
+ created_at: string;
2772
+ workspace_id: string;
2773
+ starts_at?: string | undefined;
2774
+ ends_at?: string | undefined;
2775
+ errors: Array<{
2776
+ error_code: string;
2777
+ message: string;
2778
+ }>;
2779
+ warnings: Array<{
2780
+ warning_code: string;
2781
+ message: string;
2782
+ }>;
2783
+ is_multi_phone_sync_credential?: boolean | undefined;
2784
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
2785
+ latest_desired_state_synced_with_provider_at?: string | undefined;
2786
+ visionline_metadata?: {
2787
+ card_function_type: 'guest' | 'staff';
2788
+ joiner_acs_credential_ids?: string[] | undefined;
2789
+ guest_acs_entrance_ids?: string[] | undefined;
2790
+ common_acs_entrance_ids?: string[] | undefined;
2791
+ is_valid?: boolean | undefined;
2792
+ card_id?: string | undefined;
2793
+ credential_id?: string | undefined;
2794
+ } | undefined;
2795
+ is_managed: false;
2796
+ }>;
2797
+ };
2798
+ };
2612
2799
  '/acs/credentials/update': {
2613
2800
  route: '/acs/credentials/update';
2614
2801
  method: 'PATCH' | 'POST';
@@ -2652,7 +2839,11 @@ export interface Routes {
2652
2839
  joiner_acs_credential_ids?: string[] | undefined;
2653
2840
  guest_acs_entrance_ids?: string[] | undefined;
2654
2841
  common_acs_entrance_ids?: string[] | undefined;
2842
+ is_valid?: boolean | undefined;
2843
+ card_id?: string | undefined;
2844
+ credential_id?: string | undefined;
2655
2845
  } | undefined;
2846
+ is_managed: true;
2656
2847
  };
2657
2848
  };
2658
2849
  };
@@ -2783,7 +2974,11 @@ export interface Routes {
2783
2974
  joiner_acs_credential_ids?: string[] | undefined;
2784
2975
  guest_acs_entrance_ids?: string[] | undefined;
2785
2976
  common_acs_entrance_ids?: string[] | undefined;
2977
+ is_valid?: boolean | undefined;
2978
+ card_id?: string | undefined;
2979
+ credential_id?: string | undefined;
2786
2980
  } | undefined;
2981
+ is_managed: true;
2787
2982
  }>;
2788
2983
  };
2789
2984
  };
@@ -3105,6 +3300,7 @@ export interface Routes {
3105
3300
  email?: string | undefined;
3106
3301
  email_address?: string | undefined;
3107
3302
  phone_number?: string | undefined;
3303
+ is_managed: true;
3108
3304
  };
3109
3305
  };
3110
3306
  };
@@ -3160,6 +3356,7 @@ export interface Routes {
3160
3356
  email?: string | undefined;
3161
3357
  email_address?: string | undefined;
3162
3358
  phone_number?: string | undefined;
3359
+ is_managed: true;
3163
3360
  };
3164
3361
  };
3165
3362
  };
@@ -3209,6 +3406,7 @@ export interface Routes {
3209
3406
  email?: string | undefined;
3210
3407
  email_address?: string | undefined;
3211
3408
  phone_number?: string | undefined;
3409
+ is_managed: true;
3212
3410
  }>;
3213
3411
  };
3214
3412
  };
@@ -3323,6 +3521,7 @@ export interface Routes {
3323
3521
  email?: string | undefined;
3324
3522
  email_address?: string | undefined;
3325
3523
  phone_number?: string | undefined;
3524
+ is_managed: true;
3326
3525
  };
3327
3526
  };
3328
3527
  };
@@ -3332,7 +3531,11 @@ export interface Routes {
3332
3531
  queryParams: {};
3333
3532
  jsonBody: {};
3334
3533
  commonParams: {
3335
- acs_system_id: string;
3534
+ user_identity_id?: string | undefined;
3535
+ user_identity_phone_number?: string | undefined;
3536
+ user_identity_email_address?: string | undefined;
3537
+ acs_system_id?: string | undefined;
3538
+ limit?: number;
3336
3539
  };
3337
3540
  formData: {};
3338
3541
  jsonResponse: {
@@ -3367,6 +3570,7 @@ export interface Routes {
3367
3570
  email?: string | undefined;
3368
3571
  email_address?: string | undefined;
3369
3572
  phone_number?: string | undefined;
3573
+ is_managed: false;
3370
3574
  }>;
3371
3575
  };
3372
3576
  };
@@ -14348,6 +14552,7 @@ export interface Routes {
14348
14552
  email?: string | undefined;
14349
14553
  email_address?: string | undefined;
14350
14554
  phone_number?: string | undefined;
14555
+ is_managed: true;
14351
14556
  }>;
14352
14557
  };
14353
14558
  };
@@ -1 +1 @@
1
- export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_unmanaged_user, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
@@ -1,2 +1,2 @@
1
- export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_unmanaged_user, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
2
2
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.233.0",
3
+ "version": "1.235.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -12,7 +12,7 @@ export type AcsAccessGroupExternalType = z.infer<
12
12
  typeof acs_access_group_external_type
13
13
  >
14
14
 
15
- export const acs_access_group = z.object({
15
+ const common_acs_access_group = z.object({
16
16
  acs_access_group_id: z.string().uuid(),
17
17
  acs_system_id: z.string().uuid(),
18
18
  workspace_id: z.string().uuid(),
@@ -33,4 +33,14 @@ export const acs_access_group = z.object({
33
33
  created_at: z.string().datetime(),
34
34
  })
35
35
 
36
+ export const acs_access_group = common_acs_access_group.extend({
37
+ is_managed: z.literal(true),
38
+ })
39
+ export const unmanaged_acs_access_group = common_acs_access_group.extend({
40
+ is_managed: z.literal(false),
41
+ })
42
+
36
43
  export type AcsAccessGroup = z.output<typeof acs_access_group>
44
+ export type UnmanagedAcsAccessGroup = z.output<
45
+ typeof unmanaged_acs_access_group
46
+ >
@@ -21,7 +21,7 @@ export type AcsCredentialExternalType = z.infer<
21
21
  typeof acs_credential_external_type
22
22
  >
23
23
 
24
- export const acs_credential = z.object({
24
+ const common_acs_credential = z.object({
25
25
  acs_credential_id: z.string().uuid(),
26
26
  acs_user_id: z.string().uuid().optional(),
27
27
  acs_credential_pool_id: z.string().uuid().optional(),
@@ -57,4 +57,17 @@ export const acs_credential = z.object({
57
57
  visionline_metadata: acs_credential_visionline_metadata.optional(),
58
58
  })
59
59
 
60
+ export const acs_credential = common_acs_credential.merge(
61
+ z.object({
62
+ is_managed: z.literal(true),
63
+ }),
64
+ )
65
+
66
+ export const unmanaged_acs_credential = common_acs_credential.merge(
67
+ z.object({
68
+ is_managed: z.literal(false),
69
+ }),
70
+ )
71
+
60
72
  export type AcsCredential = z.output<typeof acs_credential>
73
+ export type UnmanagedAcsCredential = z.output<typeof unmanaged_acs_credential>
@@ -45,7 +45,7 @@ const user_fields = z.object({
45
45
  phone_number: phone_number.optional(),
46
46
  })
47
47
 
48
- export const acs_user = z
48
+ const common_acs_user = z
49
49
  .object({
50
50
  acs_user_id: z.string().uuid(),
51
51
  acs_system_id: z.string().uuid(),
@@ -70,4 +70,17 @@ export const acs_user = z
70
70
  })
71
71
  .merge(user_fields)
72
72
 
73
+ export const acs_user = common_acs_user.merge(
74
+ z.object({
75
+ is_managed: z.literal(true),
76
+ }),
77
+ )
78
+
79
+ export const acs_unmanaged_user = common_acs_user.merge(
80
+ z.object({
81
+ is_managed: z.literal(false),
82
+ }),
83
+ )
84
+
73
85
  export type AcsUser = z.output<typeof acs_user>
86
+ export type AcsUnmanagedUser = z.output<typeof acs_unmanaged_user>
@@ -24,6 +24,9 @@ export const acs_credential_visionline_metadata = z.object({
24
24
  joiner_acs_credential_ids: z.array(z.string().uuid()).optional(),
25
25
  guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
26
26
  common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
27
+ is_valid: z.boolean().optional(),
28
+ card_id: z.string().optional(),
29
+ credential_id: z.string().optional(),
27
30
  })
28
31
 
29
32
  export type AcsCredentialVisionlineMetadata = z.infer<