@seamapi/types 1.411.1 → 1.413.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.
@@ -1475,6 +1475,12 @@ export interface Routes {
1475
1475
  created_at: string;
1476
1476
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1477
1477
  error_code: 'subscription_required';
1478
+ } | {
1479
+ message: string;
1480
+ is_device_error: true;
1481
+ created_at: string;
1482
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1483
+ error_code: 'lockly_missing_wifi_bridge';
1478
1484
  } | {
1479
1485
  /** Date and time at which Seam created the error. */
1480
1486
  created_at: string;
@@ -1971,6 +1977,12 @@ export interface Routes {
1971
1977
  created_at: string;
1972
1978
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1973
1979
  error_code: 'subscription_required';
1980
+ } | {
1981
+ message: string;
1982
+ is_device_error: true;
1983
+ created_at: string;
1984
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1985
+ error_code: 'lockly_missing_wifi_bridge';
1974
1986
  } | {
1975
1987
  /** Date and time at which Seam created the error. */
1976
1988
  created_at: string;
@@ -3587,6 +3599,12 @@ export interface Routes {
3587
3599
  created_at: string;
3588
3600
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3589
3601
  error_code: 'subscription_required';
3602
+ } | {
3603
+ message: string;
3604
+ is_device_error: true;
3605
+ created_at: string;
3606
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3607
+ error_code: 'lockly_missing_wifi_bridge';
3590
3608
  } | {
3591
3609
  /** Date and time at which Seam created the error. */
3592
3610
  created_at: string;
@@ -4064,6 +4082,12 @@ export interface Routes {
4064
4082
  created_at: string;
4065
4083
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4066
4084
  error_code: 'subscription_required';
4085
+ } | {
4086
+ message: string;
4087
+ is_device_error: true;
4088
+ created_at: string;
4089
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4090
+ error_code: 'lockly_missing_wifi_bridge';
4067
4091
  } | {
4068
4092
  /** Date and time at which Seam created the error. */
4069
4093
  created_at: string;
@@ -4548,6 +4572,12 @@ export interface Routes {
4548
4572
  created_at: string;
4549
4573
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4550
4574
  error_code: 'subscription_required';
4575
+ } | {
4576
+ message: string;
4577
+ is_device_error: true;
4578
+ created_at: string;
4579
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4580
+ error_code: 'lockly_missing_wifi_bridge';
4551
4581
  } | {
4552
4582
  /** Date and time at which Seam created the error. */
4553
4583
  created_at: string;
@@ -5010,6 +5040,12 @@ export interface Routes {
5010
5040
  created_at: string;
5011
5041
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5012
5042
  error_code: 'subscription_required';
5043
+ } | {
5044
+ message: string;
5045
+ is_device_error: true;
5046
+ created_at: string;
5047
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5048
+ error_code: 'lockly_missing_wifi_bridge';
5013
5049
  } | {
5014
5050
  /** Date and time at which Seam created the error. */
5015
5051
  created_at: string;
@@ -5505,6 +5541,12 @@ export interface Routes {
5505
5541
  created_at: string;
5506
5542
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5507
5543
  error_code: 'subscription_required';
5544
+ } | {
5545
+ message: string;
5546
+ is_device_error: true;
5547
+ created_at: string;
5548
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5549
+ error_code: 'lockly_missing_wifi_bridge';
5508
5550
  } | {
5509
5551
  /** Date and time at which Seam created the error. */
5510
5552
  created_at: string;
@@ -7108,6 +7150,12 @@ export interface Routes {
7108
7150
  created_at: string;
7109
7151
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7110
7152
  error_code: 'subscription_required';
7153
+ } | {
7154
+ message: string;
7155
+ is_device_error: true;
7156
+ created_at: string;
7157
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7158
+ error_code: 'lockly_missing_wifi_bridge';
7111
7159
  } | {
7112
7160
  /** Date and time at which Seam created the error. */
7113
7161
  created_at: string;
@@ -7560,6 +7608,12 @@ export interface Routes {
7560
7608
  created_at: string;
7561
7609
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7562
7610
  error_code: 'subscription_required';
7611
+ } | {
7612
+ message: string;
7613
+ is_device_error: true;
7614
+ created_at: string;
7615
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7616
+ error_code: 'lockly_missing_wifi_bridge';
7563
7617
  } | {
7564
7618
  /** Date and time at which Seam created the error. */
7565
7619
  created_at: string;
@@ -18816,8 +18870,11 @@ export interface Routes {
18816
18870
  connect_webview_ids?: string[] | undefined;
18817
18871
  /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
18818
18872
  connected_account_ids?: string[] | undefined;
18819
- /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
18873
+ /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
18874
+ * @deprecated Use `user_identity_id`. */
18820
18875
  user_identity_ids?: string[] | undefined;
18876
+ /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
18877
+ user_identity_id?: string | undefined;
18821
18878
  /** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
18822
18879
  expires_at?: Date | undefined;
18823
18880
  };
@@ -18844,7 +18901,9 @@ export interface Routes {
18844
18901
  customer_id?: string | undefined;
18845
18902
  connected_account_ids: string[];
18846
18903
  connect_webview_ids: string[];
18904
+ /** deprecated: Use `user_identity_id`. */
18847
18905
  user_identity_ids: string[];
18906
+ user_identity_id?: string | undefined;
18848
18907
  };
18849
18908
  };
18850
18909
  };
@@ -18893,7 +18952,9 @@ export interface Routes {
18893
18952
  customer_id?: string | undefined;
18894
18953
  connected_account_ids: string[];
18895
18954
  connect_webview_ids: string[];
18955
+ /** deprecated: Use `user_identity_id`. */
18896
18956
  user_identity_ids: string[];
18957
+ user_identity_id?: string | undefined;
18897
18958
  };
18898
18959
  };
18899
18960
  };
@@ -18908,8 +18969,11 @@ export interface Routes {
18908
18969
  connect_webview_ids?: string[] | undefined;
18909
18970
  /** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
18910
18971
  connected_account_ids?: string[] | undefined;
18911
- /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
18972
+ /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
18973
+ * @deprecated Use `user_identity_id`. */
18912
18974
  user_identity_ids?: string[] | undefined;
18975
+ /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
18976
+ user_identity_id?: string | undefined;
18913
18977
  /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
18914
18978
  expires_at?: Date | undefined;
18915
18979
  };
@@ -18936,7 +19000,9 @@ export interface Routes {
18936
19000
  customer_id?: string | undefined;
18937
19001
  connected_account_ids: string[];
18938
19002
  connect_webview_ids: string[];
19003
+ /** deprecated: Use `user_identity_id`. */
18939
19004
  user_identity_ids: string[];
19005
+ user_identity_id?: string | undefined;
18940
19006
  };
18941
19007
  };
18942
19008
  };
@@ -18954,8 +19020,11 @@ export interface Routes {
18954
19020
  connected_account_ids?: string[] | undefined;
18955
19021
  /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
18956
19022
  connect_webview_ids?: string[] | undefined;
18957
- /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
19023
+ /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
19024
+ * @deprecated Use `user_identity_id`. */
18958
19025
  user_identity_ids?: string[] | undefined;
19026
+ /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
19027
+ user_identity_id?: string | undefined;
18959
19028
  };
18960
19029
  formData: {};
18961
19030
  jsonResponse: {
@@ -18979,7 +19048,9 @@ export interface Routes {
18979
19048
  customer_id?: string | undefined;
18980
19049
  connected_account_ids: string[];
18981
19050
  connect_webview_ids: string[];
19051
+ /** deprecated: Use `user_identity_id`. */
18982
19052
  user_identity_ids: string[];
19053
+ user_identity_id?: string | undefined;
18983
19054
  };
18984
19055
  };
18985
19056
  };
@@ -19013,7 +19084,9 @@ export interface Routes {
19013
19084
  customer_id?: string | undefined;
19014
19085
  connected_account_ids: string[];
19015
19086
  connect_webview_ids: string[];
19087
+ /** deprecated: Use `user_identity_id`. */
19016
19088
  user_identity_ids: string[];
19089
+ user_identity_id?: string | undefined;
19017
19090
  }>;
19018
19091
  };
19019
19092
  };
@@ -20816,6 +20889,12 @@ export interface Routes {
20816
20889
  created_at: string;
20817
20890
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20818
20891
  error_code: 'subscription_required';
20892
+ } | {
20893
+ message: string;
20894
+ is_device_error: true;
20895
+ created_at: string;
20896
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20897
+ error_code: 'lockly_missing_wifi_bridge';
20819
20898
  } | {
20820
20899
  /** Date and time at which Seam created the error. */
20821
20900
  created_at: string;
@@ -22064,6 +22143,12 @@ export interface Routes {
22064
22143
  created_at: string;
22065
22144
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22066
22145
  error_code: 'subscription_required';
22146
+ } | {
22147
+ message: string;
22148
+ is_device_error: true;
22149
+ created_at: string;
22150
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22151
+ error_code: 'lockly_missing_wifi_bridge';
22067
22152
  } | {
22068
22153
  /** Date and time at which Seam created the error. */
22069
22154
  created_at: string;
@@ -22386,6 +22471,12 @@ export interface Routes {
22386
22471
  created_at: string;
22387
22472
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22388
22473
  error_code: 'subscription_required';
22474
+ } | {
22475
+ message: string;
22476
+ is_device_error: true;
22477
+ created_at: string;
22478
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22479
+ error_code: 'lockly_missing_wifi_bridge';
22389
22480
  } | {
22390
22481
  /** Date and time at which Seam created the error. */
22391
22482
  created_at: string;
@@ -22727,6 +22818,12 @@ export interface Routes {
22727
22818
  created_at: string;
22728
22819
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22729
22820
  error_code: 'subscription_required';
22821
+ } | {
22822
+ message: string;
22823
+ is_device_error: true;
22824
+ created_at: string;
22825
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22826
+ error_code: 'lockly_missing_wifi_bridge';
22730
22827
  } | {
22731
22828
  /** Date and time at which Seam created the error. */
22732
22829
  created_at: string;
@@ -26867,6 +26964,12 @@ export interface Routes {
26867
26964
  created_at: string;
26868
26965
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
26869
26966
  error_code: 'subscription_required';
26967
+ } | {
26968
+ message: string;
26969
+ is_device_error: true;
26970
+ created_at: string;
26971
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
26972
+ error_code: 'lockly_missing_wifi_bridge';
26870
26973
  } | {
26871
26974
  /** Date and time at which Seam created the error. */
26872
26975
  created_at: string;
@@ -28071,6 +28174,12 @@ export interface Routes {
28071
28174
  created_at: string;
28072
28175
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
28073
28176
  error_code: 'subscription_required';
28177
+ } | {
28178
+ message: string;
28179
+ is_device_error: true;
28180
+ created_at: string;
28181
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
28182
+ error_code: 'lockly_missing_wifi_bridge';
28074
28183
  } | {
28075
28184
  /** Date and time at which Seam created the error. */
28076
28185
  created_at: string;
@@ -29319,6 +29428,12 @@ export interface Routes {
29319
29428
  created_at: string;
29320
29429
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29321
29430
  error_code: 'subscription_required';
29431
+ } | {
29432
+ message: string;
29433
+ is_device_error: true;
29434
+ created_at: string;
29435
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29436
+ error_code: 'lockly_missing_wifi_bridge';
29322
29437
  } | {
29323
29438
  /** Date and time at which Seam created the error. */
29324
29439
  created_at: string;
@@ -30522,6 +30637,12 @@ export interface Routes {
30522
30637
  created_at: string;
30523
30638
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
30524
30639
  error_code: 'subscription_required';
30640
+ } | {
30641
+ message: string;
30642
+ is_device_error: true;
30643
+ created_at: string;
30644
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
30645
+ error_code: 'lockly_missing_wifi_bridge';
30525
30646
  } | {
30526
30647
  /** Date and time at which Seam created the error. */
30527
30648
  created_at: string;
@@ -36275,6 +36396,12 @@ export interface Routes {
36275
36396
  created_at: string;
36276
36397
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
36277
36398
  error_code: 'subscription_required';
36399
+ } | {
36400
+ message: string;
36401
+ is_device_error: true;
36402
+ created_at: string;
36403
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
36404
+ error_code: 'lockly_missing_wifi_bridge';
36278
36405
  } | {
36279
36406
  /** Date and time at which Seam created the error. */
36280
36407
  created_at: string;
@@ -37478,6 +37605,12 @@ export interface Routes {
37478
37605
  created_at: string;
37479
37606
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
37480
37607
  error_code: 'subscription_required';
37608
+ } | {
37609
+ message: string;
37610
+ is_device_error: true;
37611
+ created_at: string;
37612
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
37613
+ error_code: 'lockly_missing_wifi_bridge';
37481
37614
  } | {
37482
37615
  /** Date and time at which Seam created the error. */
37483
37616
  created_at: string;
@@ -41584,7 +41717,9 @@ export interface Routes {
41584
41717
  customer_id?: string | undefined;
41585
41718
  connected_account_ids: string[];
41586
41719
  connect_webview_ids: string[];
41720
+ /** deprecated: Use `user_identity_id`. */
41587
41721
  user_identity_ids: string[];
41722
+ user_identity_id?: string | undefined;
41588
41723
  };
41589
41724
  };
41590
41725
  };
@@ -46700,6 +46835,12 @@ export interface Routes {
46700
46835
  created_at: string;
46701
46836
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
46702
46837
  error_code: 'subscription_required';
46838
+ } | {
46839
+ message: string;
46840
+ is_device_error: true;
46841
+ created_at: string;
46842
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
46843
+ error_code: 'lockly_missing_wifi_bridge';
46703
46844
  } | {
46704
46845
  /** Date and time at which Seam created the error. */
46705
46846
  created_at: string;
@@ -50196,6 +50337,12 @@ export interface Routes {
50196
50337
  created_at: string;
50197
50338
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
50198
50339
  error_code: 'subscription_required';
50340
+ } | {
50341
+ message: string;
50342
+ is_device_error: true;
50343
+ created_at: string;
50344
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
50345
+ error_code: 'lockly_missing_wifi_bridge';
50199
50346
  } | {
50200
50347
  /** Date and time at which Seam created the error. */
50201
50348
  created_at: string;
@@ -51399,6 +51546,12 @@ export interface Routes {
51399
51546
  created_at: string;
51400
51547
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51401
51548
  error_code: 'subscription_required';
51549
+ } | {
51550
+ message: string;
51551
+ is_device_error: true;
51552
+ created_at: string;
51553
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51554
+ error_code: 'lockly_missing_wifi_bridge';
51402
51555
  } | {
51403
51556
  /** Date and time at which Seam created the error. */
51404
51557
  created_at: string;
@@ -58314,6 +58467,12 @@ export interface Routes {
58314
58467
  created_at: string;
58315
58468
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
58316
58469
  error_code: 'subscription_required';
58470
+ } | {
58471
+ message: string;
58472
+ is_device_error: true;
58473
+ created_at: string;
58474
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
58475
+ error_code: 'lockly_missing_wifi_bridge';
58317
58476
  } | {
58318
58477
  /** Date and time at which Seam created the error. */
58319
58478
  created_at: string;
@@ -59519,6 +59678,12 @@ export interface Routes {
59519
59678
  created_at: string;
59520
59679
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
59521
59680
  error_code: 'subscription_required';
59681
+ } | {
59682
+ message: string;
59683
+ is_device_error: true;
59684
+ created_at: string;
59685
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
59686
+ error_code: 'lockly_missing_wifi_bridge';
59522
59687
  } | {
59523
59688
  /** Date and time at which Seam created the error. */
59524
59689
  created_at: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.411.1",
3
+ "version": "1.413.0",
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.24.0"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.44.0",
95
+ "@seamapi/blueprint": "^0.48.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -11,7 +11,10 @@ export const client_session = z.object({
11
11
  customer_id: z.string().uuid().optional(),
12
12
  connected_account_ids: z.array(z.string().uuid()),
13
13
  connect_webview_ids: z.array(z.string().uuid()),
14
- user_identity_ids: z.array(z.string().uuid()),
14
+ user_identity_ids: z
15
+ .array(z.string().uuid())
16
+ .describe('deprecated: Use `user_identity_id`.'),
17
+ user_identity_id: z.string().uuid().optional(),
15
18
  }).describe(`
16
19
  ---
17
20
  route_path: /client_sessions
@@ -134,6 +134,14 @@ const subscription_required = common_device_error
134
134
  })
135
135
  .describe('Subscription required to connect.')
136
136
 
137
+ const lockly_missing_wifi_bridge = common_device_error
138
+ .extend({
139
+ error_code: z
140
+ .literal('lockly_missing_wifi_bridge')
141
+ .describe(error_code_description),
142
+ })
143
+ .describe('Lockly lock is not connected to a Wi-Fi bridge.')
144
+
137
145
  export const device_error = z
138
146
  .discriminatedUnion('error_code', [
139
147
  account_disconnected,
@@ -149,6 +157,7 @@ export const device_error = z
149
157
  missing_device_credentials,
150
158
  auxiliary_heat_running,
151
159
  subscription_required,
160
+ lockly_missing_wifi_bridge,
152
161
  ])
153
162
  .describe('Error associated with the `device`.')
154
163
 
@@ -174,6 +183,7 @@ const device_error_map = z.object({
174
183
  missing_device_credentials: missing_device_credentials.optional().nullable(),
175
184
  auxiliary_heat_running: auxiliary_heat_running.optional().nullable(),
176
185
  subscription_required: subscription_required.optional().nullable(),
186
+ lockly_missing_wifi_bridge: lockly_missing_wifi_bridge.optional().nullable(),
177
187
  })
178
188
 
179
189
  export type DeviceErrorMap = z.infer<typeof device_error_map>