@seamapi/types 1.404.0 → 1.404.2

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.
@@ -1490,16 +1490,22 @@ export interface Routes {
1490
1490
  } | {
1491
1491
  /** Date and time at which Seam created the error. */
1492
1492
  created_at: string;
1493
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1493
1494
  message: string;
1495
+ /** Indicates whether the error is related specifically to the connected account. */
1494
1496
  is_connected_account_error?: boolean | undefined;
1497
+ /** Indicates whether the error is related to Seam Bridge. */
1495
1498
  is_bridge_error?: boolean | undefined;
1496
1499
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1497
1500
  error_code: 'invalid_credentials';
1498
1501
  } | {
1499
1502
  /** Date and time at which Seam created the error. */
1500
1503
  created_at: string;
1504
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1501
1505
  message: string;
1506
+ /** Indicates whether the error is related specifically to the connected account. */
1502
1507
  is_connected_account_error?: boolean | undefined;
1508
+ /** Indicates whether the error is related to Seam Bridge. */
1503
1509
  is_bridge_error?: boolean | undefined;
1504
1510
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1505
1511
  error_code: 'bridge_disconnected';
@@ -1992,16 +1998,22 @@ export interface Routes {
1992
1998
  } | {
1993
1999
  /** Date and time at which Seam created the error. */
1994
2000
  created_at: string;
2001
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1995
2002
  message: string;
2003
+ /** Indicates whether the error is related specifically to the connected account. */
1996
2004
  is_connected_account_error?: boolean | undefined;
2005
+ /** Indicates whether the error is related to Seam Bridge. */
1997
2006
  is_bridge_error?: boolean | undefined;
1998
2007
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1999
2008
  error_code: 'invalid_credentials';
2000
2009
  } | {
2001
2010
  /** Date and time at which Seam created the error. */
2002
2011
  created_at: string;
2012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2003
2013
  message: string;
2014
+ /** Indicates whether the error is related specifically to the connected account. */
2004
2015
  is_connected_account_error?: boolean | undefined;
2016
+ /** Indicates whether the error is related to Seam Bridge. */
2005
2017
  is_bridge_error?: boolean | undefined;
2006
2018
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2007
2019
  error_code: 'bridge_disconnected';
@@ -3608,16 +3620,22 @@ export interface Routes {
3608
3620
  } | {
3609
3621
  /** Date and time at which Seam created the error. */
3610
3622
  created_at: string;
3623
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3611
3624
  message: string;
3625
+ /** Indicates whether the error is related specifically to the connected account. */
3612
3626
  is_connected_account_error?: boolean | undefined;
3627
+ /** Indicates whether the error is related to Seam Bridge. */
3613
3628
  is_bridge_error?: boolean | undefined;
3614
3629
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3615
3630
  error_code: 'invalid_credentials';
3616
3631
  } | {
3617
3632
  /** Date and time at which Seam created the error. */
3618
3633
  created_at: string;
3634
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3619
3635
  message: string;
3636
+ /** Indicates whether the error is related specifically to the connected account. */
3620
3637
  is_connected_account_error?: boolean | undefined;
3638
+ /** Indicates whether the error is related to Seam Bridge. */
3621
3639
  is_bridge_error?: boolean | undefined;
3622
3640
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3623
3641
  error_code: 'bridge_disconnected';
@@ -4084,16 +4102,22 @@ export interface Routes {
4084
4102
  } | {
4085
4103
  /** Date and time at which Seam created the error. */
4086
4104
  created_at: string;
4105
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4087
4106
  message: string;
4107
+ /** Indicates whether the error is related specifically to the connected account. */
4088
4108
  is_connected_account_error?: boolean | undefined;
4109
+ /** Indicates whether the error is related to Seam Bridge. */
4089
4110
  is_bridge_error?: boolean | undefined;
4090
4111
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4091
4112
  error_code: 'invalid_credentials';
4092
4113
  } | {
4093
4114
  /** Date and time at which Seam created the error. */
4094
4115
  created_at: string;
4116
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4095
4117
  message: string;
4118
+ /** Indicates whether the error is related specifically to the connected account. */
4096
4119
  is_connected_account_error?: boolean | undefined;
4120
+ /** Indicates whether the error is related to Seam Bridge. */
4097
4121
  is_bridge_error?: boolean | undefined;
4098
4122
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4099
4123
  error_code: 'bridge_disconnected';
@@ -4568,16 +4592,22 @@ export interface Routes {
4568
4592
  } | {
4569
4593
  /** Date and time at which Seam created the error. */
4570
4594
  created_at: string;
4595
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4571
4596
  message: string;
4597
+ /** Indicates whether the error is related specifically to the connected account. */
4572
4598
  is_connected_account_error?: boolean | undefined;
4599
+ /** Indicates whether the error is related to Seam Bridge. */
4573
4600
  is_bridge_error?: boolean | undefined;
4574
4601
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4575
4602
  error_code: 'invalid_credentials';
4576
4603
  } | {
4577
4604
  /** Date and time at which Seam created the error. */
4578
4605
  created_at: string;
4606
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4579
4607
  message: string;
4608
+ /** Indicates whether the error is related specifically to the connected account. */
4580
4609
  is_connected_account_error?: boolean | undefined;
4610
+ /** Indicates whether the error is related to Seam Bridge. */
4581
4611
  is_bridge_error?: boolean | undefined;
4582
4612
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4583
4613
  error_code: 'bridge_disconnected';
@@ -5030,16 +5060,22 @@ export interface Routes {
5030
5060
  } | {
5031
5061
  /** Date and time at which Seam created the error. */
5032
5062
  created_at: string;
5063
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5033
5064
  message: string;
5065
+ /** Indicates whether the error is related specifically to the connected account. */
5034
5066
  is_connected_account_error?: boolean | undefined;
5067
+ /** Indicates whether the error is related to Seam Bridge. */
5035
5068
  is_bridge_error?: boolean | undefined;
5036
5069
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5037
5070
  error_code: 'invalid_credentials';
5038
5071
  } | {
5039
5072
  /** Date and time at which Seam created the error. */
5040
5073
  created_at: string;
5074
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5041
5075
  message: string;
5076
+ /** Indicates whether the error is related specifically to the connected account. */
5042
5077
  is_connected_account_error?: boolean | undefined;
5078
+ /** Indicates whether the error is related to Seam Bridge. */
5043
5079
  is_bridge_error?: boolean | undefined;
5044
5080
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5045
5081
  error_code: 'bridge_disconnected';
@@ -5525,16 +5561,22 @@ export interface Routes {
5525
5561
  } | {
5526
5562
  /** Date and time at which Seam created the error. */
5527
5563
  created_at: string;
5564
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5528
5565
  message: string;
5566
+ /** Indicates whether the error is related specifically to the connected account. */
5529
5567
  is_connected_account_error?: boolean | undefined;
5568
+ /** Indicates whether the error is related to Seam Bridge. */
5530
5569
  is_bridge_error?: boolean | undefined;
5531
5570
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5532
5571
  error_code: 'invalid_credentials';
5533
5572
  } | {
5534
5573
  /** Date and time at which Seam created the error. */
5535
5574
  created_at: string;
5575
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5536
5576
  message: string;
5577
+ /** Indicates whether the error is related specifically to the connected account. */
5537
5578
  is_connected_account_error?: boolean | undefined;
5579
+ /** Indicates whether the error is related to Seam Bridge. */
5538
5580
  is_bridge_error?: boolean | undefined;
5539
5581
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5540
5582
  error_code: 'bridge_disconnected';
@@ -7128,16 +7170,22 @@ export interface Routes {
7128
7170
  } | {
7129
7171
  /** Date and time at which Seam created the error. */
7130
7172
  created_at: string;
7173
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7131
7174
  message: string;
7175
+ /** Indicates whether the error is related specifically to the connected account. */
7132
7176
  is_connected_account_error?: boolean | undefined;
7177
+ /** Indicates whether the error is related to Seam Bridge. */
7133
7178
  is_bridge_error?: boolean | undefined;
7134
7179
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7135
7180
  error_code: 'invalid_credentials';
7136
7181
  } | {
7137
7182
  /** Date and time at which Seam created the error. */
7138
7183
  created_at: string;
7184
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7139
7185
  message: string;
7186
+ /** Indicates whether the error is related specifically to the connected account. */
7140
7187
  is_connected_account_error?: boolean | undefined;
7188
+ /** Indicates whether the error is related to Seam Bridge. */
7141
7189
  is_bridge_error?: boolean | undefined;
7142
7190
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7143
7191
  error_code: 'bridge_disconnected';
@@ -7580,16 +7628,22 @@ export interface Routes {
7580
7628
  } | {
7581
7629
  /** Date and time at which Seam created the error. */
7582
7630
  created_at: string;
7631
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7583
7632
  message: string;
7633
+ /** Indicates whether the error is related specifically to the connected account. */
7584
7634
  is_connected_account_error?: boolean | undefined;
7635
+ /** Indicates whether the error is related to Seam Bridge. */
7585
7636
  is_bridge_error?: boolean | undefined;
7586
7637
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7587
7638
  error_code: 'invalid_credentials';
7588
7639
  } | {
7589
7640
  /** Date and time at which Seam created the error. */
7590
7641
  created_at: string;
7642
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7591
7643
  message: string;
7644
+ /** Indicates whether the error is related specifically to the connected account. */
7592
7645
  is_connected_account_error?: boolean | undefined;
7646
+ /** Indicates whether the error is related to Seam Bridge. */
7593
7647
  is_bridge_error?: boolean | undefined;
7594
7648
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7595
7649
  error_code: 'bridge_disconnected';
@@ -15292,8 +15346,12 @@ export interface Routes {
15292
15346
  queryParams: {};
15293
15347
  jsonBody: {};
15294
15348
  commonParams: {
15295
- /** ID of the access system user that you want to delete. */
15296
- acs_user_id: string;
15349
+ /** ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id */
15350
+ acs_user_id?: string | undefined;
15351
+ /** ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
15352
+ user_identity_id?: string | undefined;
15353
+ /** ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. */
15354
+ acs_system_id?: string | undefined;
15297
15355
  };
15298
15356
  formData: {};
15299
15357
  jsonResponse: {};
@@ -15304,8 +15362,12 @@ export interface Routes {
15304
15362
  queryParams: {};
15305
15363
  jsonBody: {};
15306
15364
  commonParams: {
15307
- /** ID of the access system user that you want to get. */
15308
- acs_user_id: string;
15365
+ /** ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. */
15366
+ acs_user_id?: string | undefined;
15367
+ /** ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id. */
15368
+ user_identity_id?: string | undefined;
15369
+ /** ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. */
15370
+ acs_system_id?: string | undefined;
15309
15371
  };
15310
15372
  formData: {};
15311
15373
  jsonResponse: {
@@ -15801,8 +15863,10 @@ export interface Routes {
15801
15863
  queryParams: {};
15802
15864
  jsonBody: {};
15803
15865
  commonParams: {
15804
- /** ID of the access system user that you want to remove from an access group. */
15805
- acs_user_id: string;
15866
+ /** ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. */
15867
+ acs_user_id?: string | undefined;
15868
+ /** ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. */
15869
+ user_identity_id?: string | undefined;
15806
15870
  /** ID of the access group from which you want to remove an access system user. */
15807
15871
  acs_access_group_id: string;
15808
15872
  };
@@ -15814,8 +15878,12 @@ export interface Routes {
15814
15878
  method: 'POST';
15815
15879
  queryParams: {};
15816
15880
  jsonBody: {
15817
- /** ID of the access system user for whom you want to revoke access. */
15818
- acs_user_id: string;
15881
+ /** ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
15882
+ acs_user_id?: string | undefined;
15883
+ /** ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
15884
+ user_identity_id?: string | undefined;
15885
+ /** ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. */
15886
+ acs_system_id?: string | undefined;
15819
15887
  };
15820
15888
  commonParams: {};
15821
15889
  formData: {};
@@ -15827,8 +15895,12 @@ export interface Routes {
15827
15895
  queryParams: {};
15828
15896
  jsonBody: {};
15829
15897
  commonParams: {
15830
- /** ID of the access system user that you want to suspend. */
15831
- acs_user_id: string;
15898
+ /** ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
15899
+ acs_user_id?: string | undefined;
15900
+ /** ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
15901
+ user_identity_id?: string | undefined;
15902
+ /** ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
15903
+ acs_system_id?: string | undefined;
15832
15904
  };
15833
15905
  formData: {};
15834
15906
  jsonResponse: {};
@@ -16238,8 +16310,12 @@ export interface Routes {
16238
16310
  queryParams: {};
16239
16311
  jsonBody: {};
16240
16312
  commonParams: {
16241
- /** ID of the access system user that you want to unsuspend. */
16242
- acs_user_id: string;
16313
+ /** ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
16314
+ acs_user_id?: string | undefined;
16315
+ /** ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
16316
+ user_identity_id?: string | undefined;
16317
+ /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
16318
+ acs_system_id?: string | undefined;
16243
16319
  };
16244
16320
  formData: {};
16245
16321
  jsonResponse: {};
@@ -16256,8 +16332,12 @@ export interface Routes {
16256
16332
  /** Ending timestamp for the access system user's access. */
16257
16333
  ends_at: string;
16258
16334
  } | null) | undefined;
16259
- /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
16260
- acs_user_id: string;
16335
+ /** ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. */
16336
+ acs_user_id?: string | undefined;
16337
+ /** ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
16338
+ user_identity_id?: string | undefined;
16339
+ /** ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. */
16340
+ acs_system_id?: string | undefined;
16261
16341
  /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
16262
16342
  full_name?: string | undefined;
16263
16343
  /**
@@ -18794,12 +18874,18 @@ export interface Routes {
18794
18874
 
18795
18875
  To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
18796
18876
  connect_webview: {
18877
+ /** ID of the Connect Webview. */
18797
18878
  connect_webview_id: string;
18879
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
18798
18880
  workspace_id: string;
18881
+ /** Date and time at which the Connect Webview was created. */
18799
18882
  created_at: string;
18883
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
18800
18884
  connected_account_id: string | null;
18885
+ /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
18801
18886
  url: string;
18802
18887
  device_selection_mode: 'none' | 'single' | 'multiple';
18888
+ /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18803
18889
  accepted_providers: string[];
18804
18890
  /**
18805
18891
  * @deprecated Unused. Will be removed. */
@@ -18807,15 +18893,25 @@ export interface Routes {
18807
18893
  /**
18808
18894
  * @deprecated Unused. Will be removed. */
18809
18895
  any_device_allowed: boolean;
18896
+ /** Indicates whether any provider is allowed. */
18810
18897
  any_provider_allowed: boolean;
18898
+ /** Indicates whether the user logged in successfully using the Connect Webview. */
18811
18899
  login_successful: boolean;
18900
+ /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
18812
18901
  status: 'pending' | 'failed' | 'authorized';
18902
+ /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
18813
18903
  custom_redirect_url: string | null;
18904
+ /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
18814
18905
  custom_redirect_failure_url: string | null;
18906
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
18815
18907
  custom_metadata: Record<string, string | boolean>;
18908
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
18816
18909
  automatically_manage_new_devices: boolean;
18910
+ /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
18817
18911
  wait_for_device_creation: boolean;
18912
+ /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
18818
18913
  authorized_at: string | null;
18914
+ /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18819
18915
  selected_provider: string | null;
18820
18916
  };
18821
18917
  };
@@ -18855,12 +18951,18 @@ export interface Routes {
18855
18951
 
18856
18952
  To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
18857
18953
  connect_webview: {
18954
+ /** ID of the Connect Webview. */
18858
18955
  connect_webview_id: string;
18956
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
18859
18957
  workspace_id: string;
18958
+ /** Date and time at which the Connect Webview was created. */
18860
18959
  created_at: string;
18960
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
18861
18961
  connected_account_id: string | null;
18962
+ /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
18862
18963
  url: string;
18863
18964
  device_selection_mode: 'none' | 'single' | 'multiple';
18965
+ /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18864
18966
  accepted_providers: string[];
18865
18967
  /**
18866
18968
  * @deprecated Unused. Will be removed. */
@@ -18868,15 +18970,25 @@ export interface Routes {
18868
18970
  /**
18869
18971
  * @deprecated Unused. Will be removed. */
18870
18972
  any_device_allowed: boolean;
18973
+ /** Indicates whether any provider is allowed. */
18871
18974
  any_provider_allowed: boolean;
18975
+ /** Indicates whether the user logged in successfully using the Connect Webview. */
18872
18976
  login_successful: boolean;
18977
+ /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
18873
18978
  status: 'pending' | 'failed' | 'authorized';
18979
+ /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
18874
18980
  custom_redirect_url: string | null;
18981
+ /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
18875
18982
  custom_redirect_failure_url: string | null;
18983
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
18876
18984
  custom_metadata: Record<string, string | boolean>;
18985
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
18877
18986
  automatically_manage_new_devices: boolean;
18987
+ /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
18878
18988
  wait_for_device_creation: boolean;
18989
+ /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
18879
18990
  authorized_at: string | null;
18991
+ /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18880
18992
  selected_provider: string | null;
18881
18993
  };
18882
18994
  };
@@ -18897,12 +19009,18 @@ export interface Routes {
18897
19009
  formData: {};
18898
19010
  jsonResponse: {
18899
19011
  connect_webviews: Array<{
19012
+ /** ID of the Connect Webview. */
18900
19013
  connect_webview_id: string;
19014
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
18901
19015
  workspace_id: string;
19016
+ /** Date and time at which the Connect Webview was created. */
18902
19017
  created_at: string;
19018
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
18903
19019
  connected_account_id: string | null;
19020
+ /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
18904
19021
  url: string;
18905
19022
  device_selection_mode: 'none' | 'single' | 'multiple';
19023
+ /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18906
19024
  accepted_providers: string[];
18907
19025
  /**
18908
19026
  * @deprecated Unused. Will be removed. */
@@ -18910,15 +19028,25 @@ export interface Routes {
18910
19028
  /**
18911
19029
  * @deprecated Unused. Will be removed. */
18912
19030
  any_device_allowed: boolean;
19031
+ /** Indicates whether any provider is allowed. */
18913
19032
  any_provider_allowed: boolean;
19033
+ /** Indicates whether the user logged in successfully using the Connect Webview. */
18914
19034
  login_successful: boolean;
19035
+ /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
18915
19036
  status: 'pending' | 'failed' | 'authorized';
19037
+ /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
18916
19038
  custom_redirect_url: string | null;
19039
+ /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
18917
19040
  custom_redirect_failure_url: string | null;
19041
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
18918
19042
  custom_metadata: Record<string, string | boolean>;
19043
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
18919
19044
  automatically_manage_new_devices: boolean;
19045
+ /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
18920
19046
  wait_for_device_creation: boolean;
19047
+ /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
18921
19048
  authorized_at: string | null;
19049
+ /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
18922
19050
  selected_provider: string | null;
18923
19051
  }>;
18924
19052
  };
@@ -18953,86 +19081,127 @@ export interface Routes {
18953
19081
  jsonResponse: {
18954
19082
  /** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
18955
19083
  connected_account: {
19084
+ /** Unique identifier for the connected account. */
18956
19085
  connected_account_id?: string | undefined;
19086
+ /** Date and time at which the connected account was created. */
18957
19087
  created_at?: string | undefined;
19088
+ /** User identifier associated with the connected account. */
18958
19089
  user_identifier?: {
19090
+ /** Username of the user identifier associated with the connected account. */
18959
19091
  username?: string | undefined;
19092
+ /** API URL for the user identifier associated with the connected account. */
18960
19093
  api_url?: string | undefined;
19094
+ /** Email address of the user identifier associated with the connected account. */
18961
19095
  email?: string | undefined;
19096
+ /** Phone number of the user identifier associated with the connected account. */
18962
19097
  phone?: string | undefined;
19098
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
18963
19099
  exclusive?: boolean | undefined;
18964
19100
  } | undefined;
19101
+ /** Type of connected account. */
18965
19102
  account_type?: string | undefined;
19103
+ /** Display name for the connected account type. */
18966
19104
  account_type_display_name: string;
19105
+ /** Errors associated with the connected account. */
18967
19106
  errors: Array<{
18968
19107
  /** Date and time at which Seam created the error. */
18969
19108
  created_at: string;
19109
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18970
19110
  message: string;
19111
+ /** Indicates whether the error is related specifically to the connected account. */
18971
19112
  is_connected_account_error?: boolean | undefined;
19113
+ /** Indicates whether the error is related to Seam Bridge. */
18972
19114
  is_bridge_error?: boolean | undefined;
18973
19115
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18974
19116
  error_code: 'account_disconnected';
18975
19117
  } | {
18976
19118
  /** Date and time at which Seam created the error. */
18977
19119
  created_at: string;
19120
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18978
19121
  message: string;
19122
+ /** Indicates whether the error is related specifically to the connected account. */
18979
19123
  is_connected_account_error?: boolean | undefined;
19124
+ /** Indicates whether the error is related to Seam Bridge. */
18980
19125
  is_bridge_error?: boolean | undefined;
18981
19126
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18982
19127
  error_code: 'invalid_credentials';
18983
19128
  } | {
18984
19129
  /** Date and time at which Seam created the error. */
18985
19130
  created_at: string;
19131
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18986
19132
  message: string;
19133
+ /** Indicates whether the error is related specifically to the connected account. */
18987
19134
  is_connected_account_error?: boolean | undefined;
19135
+ /** Indicates whether the error is related to Seam Bridge. */
18988
19136
  is_bridge_error?: boolean | undefined;
18989
19137
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18990
19138
  error_code: 'bridge_disconnected';
18991
19139
  } | {
18992
19140
  /** Date and time at which Seam created the error. */
18993
19141
  created_at: string;
19142
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18994
19143
  message: string;
19144
+ /** Indicates whether the error is related specifically to the connected account. */
18995
19145
  is_connected_account_error?: boolean | undefined;
19146
+ /** Indicates whether the error is related to Seam Bridge. */
18996
19147
  is_bridge_error?: boolean | undefined;
18997
19148
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
18998
19149
  error_code: 'salto_ks_subscription_limit_exceeded';
19150
+ /** Salto KS metadata associated with the connected account that has an error. */
18999
19151
  salto_ks_metadata: {
19152
+ /** Salto sites associated with the connected account that has an error. */
19000
19153
  sites: Array<{
19154
+ /** ID of a Salto site associated with the connected account that has an error. */
19001
19155
  site_id: string;
19156
+ /** Name of a Salto site associated with the connected account that has an error. */
19002
19157
  site_name: string;
19158
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
19003
19159
  subscribed_site_user_count: number;
19160
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
19004
19161
  site_user_subscription_limit: number;
19005
19162
  }>;
19006
19163
  };
19007
19164
  }>;
19165
+ /** Warnings associated with the connected account. */
19008
19166
  warnings: Array<{
19009
19167
  /** Date and time at which Seam created the warning. */
19010
19168
  created_at: string;
19169
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19011
19170
  message: string;
19012
19171
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19013
19172
  warning_code: 'scheduled_maintenance_window';
19014
19173
  } | {
19015
19174
  /** Date and time at which Seam created the warning. */
19016
19175
  created_at: string;
19176
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19017
19177
  message: string;
19018
19178
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19019
19179
  warning_code: 'unknown_issue_with_connected_account';
19020
19180
  } | {
19021
19181
  /** Date and time at which Seam created the warning. */
19022
19182
  created_at: string;
19183
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19023
19184
  message: string;
19024
19185
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19025
19186
  warning_code: 'salto_ks_subscription_limit_almost_reached';
19187
+ /** Salto KS metadata associated with the connected account that has a warning. */
19026
19188
  salto_ks_metadata: {
19189
+ /** Salto sites associated with the connected account that has a warning. */
19027
19190
  sites: Array<{
19191
+ /** ID of a Salto site associated with the connected account that has a warning. */
19028
19192
  site_id: string;
19193
+ /** Name of a Salto site associated with the connected account that has a warning. */
19029
19194
  site_name: string;
19195
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
19030
19196
  site_user_subscription_limit: number;
19197
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
19031
19198
  subscribed_site_user_count: number;
19032
19199
  }>;
19033
19200
  };
19034
19201
  }>;
19202
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
19035
19203
  custom_metadata: Record<string, string | boolean>;
19204
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
19036
19205
  automatically_manage_new_devices: boolean;
19037
19206
  };
19038
19207
  };
@@ -19056,86 +19225,127 @@ export interface Routes {
19056
19225
  formData: {};
19057
19226
  jsonResponse: {
19058
19227
  connected_accounts: Array<{
19228
+ /** Unique identifier for the connected account. */
19059
19229
  connected_account_id?: string | undefined;
19230
+ /** Date and time at which the connected account was created. */
19060
19231
  created_at?: string | undefined;
19232
+ /** User identifier associated with the connected account. */
19061
19233
  user_identifier?: {
19234
+ /** Username of the user identifier associated with the connected account. */
19062
19235
  username?: string | undefined;
19236
+ /** API URL for the user identifier associated with the connected account. */
19063
19237
  api_url?: string | undefined;
19238
+ /** Email address of the user identifier associated with the connected account. */
19064
19239
  email?: string | undefined;
19240
+ /** Phone number of the user identifier associated with the connected account. */
19065
19241
  phone?: string | undefined;
19242
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
19066
19243
  exclusive?: boolean | undefined;
19067
19244
  } | undefined;
19245
+ /** Type of connected account. */
19068
19246
  account_type?: string | undefined;
19247
+ /** Display name for the connected account type. */
19069
19248
  account_type_display_name: string;
19249
+ /** Errors associated with the connected account. */
19070
19250
  errors: Array<{
19071
19251
  /** Date and time at which Seam created the error. */
19072
19252
  created_at: string;
19253
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19073
19254
  message: string;
19255
+ /** Indicates whether the error is related specifically to the connected account. */
19074
19256
  is_connected_account_error?: boolean | undefined;
19257
+ /** Indicates whether the error is related to Seam Bridge. */
19075
19258
  is_bridge_error?: boolean | undefined;
19076
19259
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19077
19260
  error_code: 'account_disconnected';
19078
19261
  } | {
19079
19262
  /** Date and time at which Seam created the error. */
19080
19263
  created_at: string;
19264
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19081
19265
  message: string;
19266
+ /** Indicates whether the error is related specifically to the connected account. */
19082
19267
  is_connected_account_error?: boolean | undefined;
19268
+ /** Indicates whether the error is related to Seam Bridge. */
19083
19269
  is_bridge_error?: boolean | undefined;
19084
19270
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19085
19271
  error_code: 'invalid_credentials';
19086
19272
  } | {
19087
19273
  /** Date and time at which Seam created the error. */
19088
19274
  created_at: string;
19275
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19089
19276
  message: string;
19277
+ /** Indicates whether the error is related specifically to the connected account. */
19090
19278
  is_connected_account_error?: boolean | undefined;
19279
+ /** Indicates whether the error is related to Seam Bridge. */
19091
19280
  is_bridge_error?: boolean | undefined;
19092
19281
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19093
19282
  error_code: 'bridge_disconnected';
19094
19283
  } | {
19095
19284
  /** Date and time at which Seam created the error. */
19096
19285
  created_at: string;
19286
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19097
19287
  message: string;
19288
+ /** Indicates whether the error is related specifically to the connected account. */
19098
19289
  is_connected_account_error?: boolean | undefined;
19290
+ /** Indicates whether the error is related to Seam Bridge. */
19099
19291
  is_bridge_error?: boolean | undefined;
19100
19292
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19101
19293
  error_code: 'salto_ks_subscription_limit_exceeded';
19294
+ /** Salto KS metadata associated with the connected account that has an error. */
19102
19295
  salto_ks_metadata: {
19296
+ /** Salto sites associated with the connected account that has an error. */
19103
19297
  sites: Array<{
19298
+ /** ID of a Salto site associated with the connected account that has an error. */
19104
19299
  site_id: string;
19300
+ /** Name of a Salto site associated with the connected account that has an error. */
19105
19301
  site_name: string;
19302
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
19106
19303
  subscribed_site_user_count: number;
19304
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
19107
19305
  site_user_subscription_limit: number;
19108
19306
  }>;
19109
19307
  };
19110
19308
  }>;
19309
+ /** Warnings associated with the connected account. */
19111
19310
  warnings: Array<{
19112
19311
  /** Date and time at which Seam created the warning. */
19113
19312
  created_at: string;
19313
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19114
19314
  message: string;
19115
19315
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19116
19316
  warning_code: 'scheduled_maintenance_window';
19117
19317
  } | {
19118
19318
  /** Date and time at which Seam created the warning. */
19119
19319
  created_at: string;
19320
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19120
19321
  message: string;
19121
19322
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19122
19323
  warning_code: 'unknown_issue_with_connected_account';
19123
19324
  } | {
19124
19325
  /** Date and time at which Seam created the warning. */
19125
19326
  created_at: string;
19327
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19126
19328
  message: string;
19127
19329
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19128
19330
  warning_code: 'salto_ks_subscription_limit_almost_reached';
19331
+ /** Salto KS metadata associated with the connected account that has a warning. */
19129
19332
  salto_ks_metadata: {
19333
+ /** Salto sites associated with the connected account that has a warning. */
19130
19334
  sites: Array<{
19335
+ /** ID of a Salto site associated with the connected account that has a warning. */
19131
19336
  site_id: string;
19337
+ /** Name of a Salto site associated with the connected account that has a warning. */
19132
19338
  site_name: string;
19339
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
19133
19340
  site_user_subscription_limit: number;
19341
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
19134
19342
  subscribed_site_user_count: number;
19135
19343
  }>;
19136
19344
  };
19137
19345
  }>;
19346
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
19138
19347
  custom_metadata: Record<string, string | boolean>;
19348
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
19139
19349
  automatically_manage_new_devices: boolean;
19140
19350
  }>;
19141
19351
  /** Information about the current page of results. */
@@ -19166,86 +19376,127 @@ export interface Routes {
19166
19376
  jsonResponse: {
19167
19377
  /** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
19168
19378
  connected_account: {
19379
+ /** Unique identifier for the connected account. */
19169
19380
  connected_account_id?: string | undefined;
19381
+ /** Date and time at which the connected account was created. */
19170
19382
  created_at?: string | undefined;
19383
+ /** User identifier associated with the connected account. */
19171
19384
  user_identifier?: {
19385
+ /** Username of the user identifier associated with the connected account. */
19172
19386
  username?: string | undefined;
19387
+ /** API URL for the user identifier associated with the connected account. */
19173
19388
  api_url?: string | undefined;
19389
+ /** Email address of the user identifier associated with the connected account. */
19174
19390
  email?: string | undefined;
19391
+ /** Phone number of the user identifier associated with the connected account. */
19175
19392
  phone?: string | undefined;
19393
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
19176
19394
  exclusive?: boolean | undefined;
19177
19395
  } | undefined;
19396
+ /** Type of connected account. */
19178
19397
  account_type?: string | undefined;
19398
+ /** Display name for the connected account type. */
19179
19399
  account_type_display_name: string;
19400
+ /** Errors associated with the connected account. */
19180
19401
  errors: Array<{
19181
19402
  /** Date and time at which Seam created the error. */
19182
19403
  created_at: string;
19404
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19183
19405
  message: string;
19406
+ /** Indicates whether the error is related specifically to the connected account. */
19184
19407
  is_connected_account_error?: boolean | undefined;
19408
+ /** Indicates whether the error is related to Seam Bridge. */
19185
19409
  is_bridge_error?: boolean | undefined;
19186
19410
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19187
19411
  error_code: 'account_disconnected';
19188
19412
  } | {
19189
19413
  /** Date and time at which Seam created the error. */
19190
19414
  created_at: string;
19415
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19191
19416
  message: string;
19417
+ /** Indicates whether the error is related specifically to the connected account. */
19192
19418
  is_connected_account_error?: boolean | undefined;
19419
+ /** Indicates whether the error is related to Seam Bridge. */
19193
19420
  is_bridge_error?: boolean | undefined;
19194
19421
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19195
19422
  error_code: 'invalid_credentials';
19196
19423
  } | {
19197
19424
  /** Date and time at which Seam created the error. */
19198
19425
  created_at: string;
19426
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19199
19427
  message: string;
19428
+ /** Indicates whether the error is related specifically to the connected account. */
19200
19429
  is_connected_account_error?: boolean | undefined;
19430
+ /** Indicates whether the error is related to Seam Bridge. */
19201
19431
  is_bridge_error?: boolean | undefined;
19202
19432
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19203
19433
  error_code: 'bridge_disconnected';
19204
19434
  } | {
19205
19435
  /** Date and time at which Seam created the error. */
19206
19436
  created_at: string;
19437
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19207
19438
  message: string;
19439
+ /** Indicates whether the error is related specifically to the connected account. */
19208
19440
  is_connected_account_error?: boolean | undefined;
19441
+ /** Indicates whether the error is related to Seam Bridge. */
19209
19442
  is_bridge_error?: boolean | undefined;
19210
19443
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19211
19444
  error_code: 'salto_ks_subscription_limit_exceeded';
19445
+ /** Salto KS metadata associated with the connected account that has an error. */
19212
19446
  salto_ks_metadata: {
19447
+ /** Salto sites associated with the connected account that has an error. */
19213
19448
  sites: Array<{
19449
+ /** ID of a Salto site associated with the connected account that has an error. */
19214
19450
  site_id: string;
19451
+ /** Name of a Salto site associated with the connected account that has an error. */
19215
19452
  site_name: string;
19453
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
19216
19454
  subscribed_site_user_count: number;
19455
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
19217
19456
  site_user_subscription_limit: number;
19218
19457
  }>;
19219
19458
  };
19220
19459
  }>;
19460
+ /** Warnings associated with the connected account. */
19221
19461
  warnings: Array<{
19222
19462
  /** Date and time at which Seam created the warning. */
19223
19463
  created_at: string;
19464
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19224
19465
  message: string;
19225
19466
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19226
19467
  warning_code: 'scheduled_maintenance_window';
19227
19468
  } | {
19228
19469
  /** Date and time at which Seam created the warning. */
19229
19470
  created_at: string;
19471
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19230
19472
  message: string;
19231
19473
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19232
19474
  warning_code: 'unknown_issue_with_connected_account';
19233
19475
  } | {
19234
19476
  /** Date and time at which Seam created the warning. */
19235
19477
  created_at: string;
19478
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19236
19479
  message: string;
19237
19480
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19238
19481
  warning_code: 'salto_ks_subscription_limit_almost_reached';
19482
+ /** Salto KS metadata associated with the connected account that has a warning. */
19239
19483
  salto_ks_metadata: {
19484
+ /** Salto sites associated with the connected account that has a warning. */
19240
19485
  sites: Array<{
19486
+ /** ID of a Salto site associated with the connected account that has a warning. */
19241
19487
  site_id: string;
19488
+ /** Name of a Salto site associated with the connected account that has a warning. */
19242
19489
  site_name: string;
19490
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
19243
19491
  site_user_subscription_limit: number;
19492
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
19244
19493
  subscribed_site_user_count: number;
19245
19494
  }>;
19246
19495
  };
19247
19496
  }>;
19497
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
19248
19498
  custom_metadata: Record<string, string | boolean>;
19499
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
19249
19500
  automatically_manage_new_devices: boolean;
19250
19501
  };
19251
19502
  };
@@ -19911,16 +20162,22 @@ export interface Routes {
19911
20162
  } | {
19912
20163
  /** Date and time at which Seam created the error. */
19913
20164
  created_at: string;
20165
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19914
20166
  message: string;
20167
+ /** Indicates whether the error is related specifically to the connected account. */
19915
20168
  is_connected_account_error?: boolean | undefined;
20169
+ /** Indicates whether the error is related to Seam Bridge. */
19916
20170
  is_bridge_error?: boolean | undefined;
19917
20171
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19918
20172
  error_code: 'invalid_credentials';
19919
20173
  } | {
19920
20174
  /** Date and time at which Seam created the error. */
19921
20175
  created_at: string;
20176
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19922
20177
  message: string;
20178
+ /** Indicates whether the error is related specifically to the connected account. */
19923
20179
  is_connected_account_error?: boolean | undefined;
20180
+ /** Indicates whether the error is related to Seam Bridge. */
19924
20181
  is_bridge_error?: boolean | undefined;
19925
20182
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19926
20183
  error_code: 'bridge_disconnected';
@@ -20016,6 +20273,7 @@ export interface Routes {
20016
20273
  created_at: string;
20017
20274
  /** Indicates whether Seam manages the device. */
20018
20275
  is_managed: true;
20276
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
20019
20277
  custom_metadata: Record<string, string | boolean>;
20020
20278
  can_remotely_unlock?: boolean | undefined;
20021
20279
  can_remotely_lock?: boolean | undefined;
@@ -20706,16 +20964,22 @@ export interface Routes {
20706
20964
  } | {
20707
20965
  /** Date and time at which Seam created the error. */
20708
20966
  created_at: string;
20967
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20709
20968
  message: string;
20969
+ /** Indicates whether the error is related specifically to the connected account. */
20710
20970
  is_connected_account_error?: boolean | undefined;
20971
+ /** Indicates whether the error is related to Seam Bridge. */
20711
20972
  is_bridge_error?: boolean | undefined;
20712
20973
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20713
20974
  error_code: 'invalid_credentials';
20714
20975
  } | {
20715
20976
  /** Date and time at which Seam created the error. */
20716
20977
  created_at: string;
20978
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20717
20979
  message: string;
20980
+ /** Indicates whether the error is related specifically to the connected account. */
20718
20981
  is_connected_account_error?: boolean | undefined;
20982
+ /** Indicates whether the error is related to Seam Bridge. */
20719
20983
  is_bridge_error?: boolean | undefined;
20720
20984
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20721
20985
  error_code: 'bridge_disconnected';
@@ -20811,6 +21075,7 @@ export interface Routes {
20811
21075
  created_at: string;
20812
21076
  /** Indicates whether Seam manages the device. */
20813
21077
  is_managed: true;
21078
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
20814
21079
  custom_metadata: Record<string, string | boolean>;
20815
21080
  can_remotely_unlock?: boolean | undefined;
20816
21081
  can_remotely_lock?: boolean | undefined;
@@ -21017,16 +21282,22 @@ export interface Routes {
21017
21282
  } | {
21018
21283
  /** Date and time at which Seam created the error. */
21019
21284
  created_at: string;
21285
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21020
21286
  message: string;
21287
+ /** Indicates whether the error is related specifically to the connected account. */
21021
21288
  is_connected_account_error?: boolean | undefined;
21289
+ /** Indicates whether the error is related to Seam Bridge. */
21022
21290
  is_bridge_error?: boolean | undefined;
21023
21291
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21024
21292
  error_code: 'invalid_credentials';
21025
21293
  } | {
21026
21294
  /** Date and time at which Seam created the error. */
21027
21295
  created_at: string;
21296
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21028
21297
  message: string;
21298
+ /** Indicates whether the error is related specifically to the connected account. */
21029
21299
  is_connected_account_error?: boolean | undefined;
21300
+ /** Indicates whether the error is related to Seam Bridge. */
21030
21301
  is_bridge_error?: boolean | undefined;
21031
21302
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21032
21303
  error_code: 'bridge_disconnected';
@@ -21327,16 +21598,22 @@ export interface Routes {
21327
21598
  } | {
21328
21599
  /** Date and time at which Seam created the error. */
21329
21600
  created_at: string;
21601
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21330
21602
  message: string;
21603
+ /** Indicates whether the error is related specifically to the connected account. */
21331
21604
  is_connected_account_error?: boolean | undefined;
21605
+ /** Indicates whether the error is related to Seam Bridge. */
21332
21606
  is_bridge_error?: boolean | undefined;
21333
21607
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21334
21608
  error_code: 'invalid_credentials';
21335
21609
  } | {
21336
21610
  /** Date and time at which Seam created the error. */
21337
21611
  created_at: string;
21612
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21338
21613
  message: string;
21614
+ /** Indicates whether the error is related specifically to the connected account. */
21339
21615
  is_connected_account_error?: boolean | undefined;
21616
+ /** Indicates whether the error is related to Seam Bridge. */
21340
21617
  is_bridge_error?: boolean | undefined;
21341
21618
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
21342
21619
  error_code: 'bridge_disconnected';
@@ -24945,16 +25222,22 @@ export interface Routes {
24945
25222
  } | {
24946
25223
  /** Date and time at which Seam created the error. */
24947
25224
  created_at: string;
25225
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24948
25226
  message: string;
25227
+ /** Indicates whether the error is related specifically to the connected account. */
24949
25228
  is_connected_account_error?: boolean | undefined;
25229
+ /** Indicates whether the error is related to Seam Bridge. */
24950
25230
  is_bridge_error?: boolean | undefined;
24951
25231
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24952
25232
  error_code: 'invalid_credentials';
24953
25233
  } | {
24954
25234
  /** Date and time at which Seam created the error. */
24955
25235
  created_at: string;
25236
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24956
25237
  message: string;
25238
+ /** Indicates whether the error is related specifically to the connected account. */
24957
25239
  is_connected_account_error?: boolean | undefined;
25240
+ /** Indicates whether the error is related to Seam Bridge. */
24958
25241
  is_bridge_error?: boolean | undefined;
24959
25242
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24960
25243
  error_code: 'bridge_disconnected';
@@ -25050,6 +25333,7 @@ export interface Routes {
25050
25333
  created_at: string;
25051
25334
  /** Indicates whether Seam manages the device. */
25052
25335
  is_managed: true;
25336
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
25053
25337
  custom_metadata: Record<string, string | boolean>;
25054
25338
  can_remotely_unlock?: boolean | undefined;
25055
25339
  can_remotely_lock?: boolean | undefined;
@@ -25699,16 +25983,22 @@ export interface Routes {
25699
25983
  } | {
25700
25984
  /** Date and time at which Seam created the error. */
25701
25985
  created_at: string;
25986
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25702
25987
  message: string;
25988
+ /** Indicates whether the error is related specifically to the connected account. */
25703
25989
  is_connected_account_error?: boolean | undefined;
25990
+ /** Indicates whether the error is related to Seam Bridge. */
25704
25991
  is_bridge_error?: boolean | undefined;
25705
25992
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25706
25993
  error_code: 'invalid_credentials';
25707
25994
  } | {
25708
25995
  /** Date and time at which Seam created the error. */
25709
25996
  created_at: string;
25997
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25710
25998
  message: string;
25999
+ /** Indicates whether the error is related specifically to the connected account. */
25711
26000
  is_connected_account_error?: boolean | undefined;
26001
+ /** Indicates whether the error is related to Seam Bridge. */
25712
26002
  is_bridge_error?: boolean | undefined;
25713
26003
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25714
26004
  error_code: 'bridge_disconnected';
@@ -25804,6 +26094,7 @@ export interface Routes {
25804
26094
  created_at: string;
25805
26095
  /** Indicates whether Seam manages the device. */
25806
26096
  is_managed: true;
26097
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
25807
26098
  custom_metadata: Record<string, string | boolean>;
25808
26099
  can_remotely_unlock?: boolean | undefined;
25809
26100
  can_remotely_lock?: boolean | undefined;
@@ -26494,16 +26785,22 @@ export interface Routes {
26494
26785
  } | {
26495
26786
  /** Date and time at which Seam created the error. */
26496
26787
  created_at: string;
26788
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
26497
26789
  message: string;
26790
+ /** Indicates whether the error is related specifically to the connected account. */
26498
26791
  is_connected_account_error?: boolean | undefined;
26792
+ /** Indicates whether the error is related to Seam Bridge. */
26499
26793
  is_bridge_error?: boolean | undefined;
26500
26794
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
26501
26795
  error_code: 'invalid_credentials';
26502
26796
  } | {
26503
26797
  /** Date and time at which Seam created the error. */
26504
26798
  created_at: string;
26799
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
26505
26800
  message: string;
26801
+ /** Indicates whether the error is related specifically to the connected account. */
26506
26802
  is_connected_account_error?: boolean | undefined;
26803
+ /** Indicates whether the error is related to Seam Bridge. */
26507
26804
  is_bridge_error?: boolean | undefined;
26508
26805
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
26509
26806
  error_code: 'bridge_disconnected';
@@ -26599,6 +26896,7 @@ export interface Routes {
26599
26896
  created_at: string;
26600
26897
  /** Indicates whether Seam manages the device. */
26601
26898
  is_managed: true;
26899
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
26602
26900
  custom_metadata: Record<string, string | boolean>;
26603
26901
  can_remotely_unlock?: boolean | undefined;
26604
26902
  can_remotely_lock?: boolean | undefined;
@@ -27247,16 +27545,22 @@ export interface Routes {
27247
27545
  } | {
27248
27546
  /** Date and time at which Seam created the error. */
27249
27547
  created_at: string;
27548
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27250
27549
  message: string;
27550
+ /** Indicates whether the error is related specifically to the connected account. */
27251
27551
  is_connected_account_error?: boolean | undefined;
27552
+ /** Indicates whether the error is related to Seam Bridge. */
27252
27553
  is_bridge_error?: boolean | undefined;
27253
27554
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
27254
27555
  error_code: 'invalid_credentials';
27255
27556
  } | {
27256
27557
  /** Date and time at which Seam created the error. */
27257
27558
  created_at: string;
27559
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27258
27560
  message: string;
27561
+ /** Indicates whether the error is related specifically to the connected account. */
27259
27562
  is_connected_account_error?: boolean | undefined;
27563
+ /** Indicates whether the error is related to Seam Bridge. */
27260
27564
  is_bridge_error?: boolean | undefined;
27261
27565
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
27262
27566
  error_code: 'bridge_disconnected';
@@ -27352,6 +27656,7 @@ export interface Routes {
27352
27656
  created_at: string;
27353
27657
  /** Indicates whether Seam manages the device. */
27354
27658
  is_managed: true;
27659
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
27355
27660
  custom_metadata: Record<string, string | boolean>;
27356
27661
  can_remotely_unlock?: boolean | undefined;
27357
27662
  can_remotely_lock?: boolean | undefined;
@@ -32540,16 +32845,22 @@ export interface Routes {
32540
32845
  } | {
32541
32846
  /** Date and time at which Seam created the error. */
32542
32847
  created_at: string;
32848
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32543
32849
  message: string;
32850
+ /** Indicates whether the error is related specifically to the connected account. */
32544
32851
  is_connected_account_error?: boolean | undefined;
32852
+ /** Indicates whether the error is related to Seam Bridge. */
32545
32853
  is_bridge_error?: boolean | undefined;
32546
32854
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
32547
32855
  error_code: 'invalid_credentials';
32548
32856
  } | {
32549
32857
  /** Date and time at which Seam created the error. */
32550
32858
  created_at: string;
32859
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32551
32860
  message: string;
32861
+ /** Indicates whether the error is related specifically to the connected account. */
32552
32862
  is_connected_account_error?: boolean | undefined;
32863
+ /** Indicates whether the error is related to Seam Bridge. */
32553
32864
  is_bridge_error?: boolean | undefined;
32554
32865
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
32555
32866
  error_code: 'bridge_disconnected';
@@ -32645,6 +32956,7 @@ export interface Routes {
32645
32956
  created_at: string;
32646
32957
  /** Indicates whether Seam manages the device. */
32647
32958
  is_managed: true;
32959
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
32648
32960
  custom_metadata: Record<string, string | boolean>;
32649
32961
  can_remotely_unlock?: boolean | undefined;
32650
32962
  can_remotely_lock?: boolean | undefined;
@@ -33293,16 +33605,22 @@ export interface Routes {
33293
33605
  } | {
33294
33606
  /** Date and time at which Seam created the error. */
33295
33607
  created_at: string;
33608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
33296
33609
  message: string;
33610
+ /** Indicates whether the error is related specifically to the connected account. */
33297
33611
  is_connected_account_error?: boolean | undefined;
33612
+ /** Indicates whether the error is related to Seam Bridge. */
33298
33613
  is_bridge_error?: boolean | undefined;
33299
33614
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
33300
33615
  error_code: 'invalid_credentials';
33301
33616
  } | {
33302
33617
  /** Date and time at which Seam created the error. */
33303
33618
  created_at: string;
33619
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
33304
33620
  message: string;
33621
+ /** Indicates whether the error is related specifically to the connected account. */
33305
33622
  is_connected_account_error?: boolean | undefined;
33623
+ /** Indicates whether the error is related to Seam Bridge. */
33306
33624
  is_bridge_error?: boolean | undefined;
33307
33625
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
33308
33626
  error_code: 'bridge_disconnected';
@@ -33398,6 +33716,7 @@ export interface Routes {
33398
33716
  created_at: string;
33399
33717
  /** Indicates whether Seam manages the device. */
33400
33718
  is_managed: true;
33719
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
33401
33720
  custom_metadata: Record<string, string | boolean>;
33402
33721
  can_remotely_unlock?: boolean | undefined;
33403
33722
  can_remotely_lock?: boolean | undefined;
@@ -41758,16 +42077,22 @@ export interface Routes {
41758
42077
  } | {
41759
42078
  /** Date and time at which Seam created the error. */
41760
42079
  created_at: string;
42080
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41761
42081
  message: string;
42082
+ /** Indicates whether the error is related specifically to the connected account. */
41762
42083
  is_connected_account_error?: boolean | undefined;
42084
+ /** Indicates whether the error is related to Seam Bridge. */
41763
42085
  is_bridge_error?: boolean | undefined;
41764
42086
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
41765
42087
  error_code: 'invalid_credentials';
41766
42088
  } | {
41767
42089
  /** Date and time at which Seam created the error. */
41768
42090
  created_at: string;
42091
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41769
42092
  message: string;
42093
+ /** Indicates whether the error is related specifically to the connected account. */
41770
42094
  is_connected_account_error?: boolean | undefined;
42095
+ /** Indicates whether the error is related to Seam Bridge. */
41771
42096
  is_bridge_error?: boolean | undefined;
41772
42097
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
41773
42098
  error_code: 'bridge_disconnected';
@@ -41863,6 +42188,7 @@ export interface Routes {
41863
42188
  created_at: string;
41864
42189
  /** Indicates whether Seam manages the device. */
41865
42190
  is_managed: true;
42191
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
41866
42192
  custom_metadata: Record<string, string | boolean>;
41867
42193
  can_remotely_unlock?: boolean | undefined;
41868
42194
  can_remotely_lock?: boolean | undefined;
@@ -44801,16 +45127,22 @@ export interface Routes {
44801
45127
  } | {
44802
45128
  /** Date and time at which Seam created the error. */
44803
45129
  created_at: string;
45130
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
44804
45131
  message: string;
45132
+ /** Indicates whether the error is related specifically to the connected account. */
44805
45133
  is_connected_account_error?: boolean | undefined;
45134
+ /** Indicates whether the error is related to Seam Bridge. */
44806
45135
  is_bridge_error?: boolean | undefined;
44807
45136
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
44808
45137
  error_code: 'invalid_credentials';
44809
45138
  } | {
44810
45139
  /** Date and time at which Seam created the error. */
44811
45140
  created_at: string;
45141
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
44812
45142
  message: string;
45143
+ /** Indicates whether the error is related specifically to the connected account. */
44813
45144
  is_connected_account_error?: boolean | undefined;
45145
+ /** Indicates whether the error is related to Seam Bridge. */
44814
45146
  is_bridge_error?: boolean | undefined;
44815
45147
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
44816
45148
  error_code: 'bridge_disconnected';
@@ -44906,6 +45238,7 @@ export interface Routes {
44906
45238
  created_at: string;
44907
45239
  /** Indicates whether Seam manages the device. */
44908
45240
  is_managed: true;
45241
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
44909
45242
  custom_metadata: Record<string, string | boolean>;
44910
45243
  can_remotely_unlock?: boolean | undefined;
44911
45244
  can_remotely_lock?: boolean | undefined;
@@ -45554,16 +45887,22 @@ export interface Routes {
45554
45887
  } | {
45555
45888
  /** Date and time at which Seam created the error. */
45556
45889
  created_at: string;
45890
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
45557
45891
  message: string;
45892
+ /** Indicates whether the error is related specifically to the connected account. */
45558
45893
  is_connected_account_error?: boolean | undefined;
45894
+ /** Indicates whether the error is related to Seam Bridge. */
45559
45895
  is_bridge_error?: boolean | undefined;
45560
45896
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
45561
45897
  error_code: 'invalid_credentials';
45562
45898
  } | {
45563
45899
  /** Date and time at which Seam created the error. */
45564
45900
  created_at: string;
45901
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
45565
45902
  message: string;
45903
+ /** Indicates whether the error is related specifically to the connected account. */
45566
45904
  is_connected_account_error?: boolean | undefined;
45905
+ /** Indicates whether the error is related to Seam Bridge. */
45567
45906
  is_bridge_error?: boolean | undefined;
45568
45907
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
45569
45908
  error_code: 'bridge_disconnected';
@@ -45659,6 +45998,7 @@ export interface Routes {
45659
45998
  created_at: string;
45660
45999
  /** Indicates whether Seam manages the device. */
45661
46000
  is_managed: true;
46001
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
45662
46002
  custom_metadata: Record<string, string | boolean>;
45663
46003
  can_remotely_unlock?: boolean | undefined;
45664
46004
  can_remotely_lock?: boolean | undefined;
@@ -51846,16 +52186,22 @@ export interface Routes {
51846
52186
  } | {
51847
52187
  /** Date and time at which Seam created the error. */
51848
52188
  created_at: string;
52189
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51849
52190
  message: string;
52191
+ /** Indicates whether the error is related specifically to the connected account. */
51850
52192
  is_connected_account_error?: boolean | undefined;
52193
+ /** Indicates whether the error is related to Seam Bridge. */
51851
52194
  is_bridge_error?: boolean | undefined;
51852
52195
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51853
52196
  error_code: 'invalid_credentials';
51854
52197
  } | {
51855
52198
  /** Date and time at which Seam created the error. */
51856
52199
  created_at: string;
52200
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51857
52201
  message: string;
52202
+ /** Indicates whether the error is related specifically to the connected account. */
51858
52203
  is_connected_account_error?: boolean | undefined;
52204
+ /** Indicates whether the error is related to Seam Bridge. */
51859
52205
  is_bridge_error?: boolean | undefined;
51860
52206
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51861
52207
  error_code: 'bridge_disconnected';
@@ -51951,6 +52297,7 @@ export interface Routes {
51951
52297
  created_at: string;
51952
52298
  /** Indicates whether Seam manages the device. */
51953
52299
  is_managed: true;
52300
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
51954
52301
  custom_metadata: Record<string, string | boolean>;
51955
52302
  can_remotely_unlock?: boolean | undefined;
51956
52303
  can_remotely_lock?: boolean | undefined;
@@ -52601,16 +52948,22 @@ export interface Routes {
52601
52948
  } | {
52602
52949
  /** Date and time at which Seam created the error. */
52603
52950
  created_at: string;
52951
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
52604
52952
  message: string;
52953
+ /** Indicates whether the error is related specifically to the connected account. */
52605
52954
  is_connected_account_error?: boolean | undefined;
52955
+ /** Indicates whether the error is related to Seam Bridge. */
52606
52956
  is_bridge_error?: boolean | undefined;
52607
52957
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
52608
52958
  error_code: 'invalid_credentials';
52609
52959
  } | {
52610
52960
  /** Date and time at which Seam created the error. */
52611
52961
  created_at: string;
52962
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
52612
52963
  message: string;
52964
+ /** Indicates whether the error is related specifically to the connected account. */
52613
52965
  is_connected_account_error?: boolean | undefined;
52966
+ /** Indicates whether the error is related to Seam Bridge. */
52614
52967
  is_bridge_error?: boolean | undefined;
52615
52968
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
52616
52969
  error_code: 'bridge_disconnected';
@@ -52706,6 +53059,7 @@ export interface Routes {
52706
53059
  created_at: string;
52707
53060
  /** Indicates whether Seam manages the device. */
52708
53061
  is_managed: true;
53062
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
52709
53063
  custom_metadata: Record<string, string | boolean>;
52710
53064
  can_remotely_unlock?: boolean | undefined;
52711
53065
  can_remotely_lock?: boolean | undefined;