@seamapi/types 1.460.0 → 1.460.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15483,21 +15483,6 @@ declare const batch: z.ZodObject<{
15483
15483
  room_description?: string | undefined;
15484
15484
  } | undefined;
15485
15485
  }[] | undefined;
15486
- workspaces?: {
15487
- name: string;
15488
- workspace_id: string;
15489
- is_suspended: boolean;
15490
- company_name: string;
15491
- is_sandbox: boolean;
15492
- connect_webview_customization: {
15493
- primary_button_color?: string | undefined;
15494
- primary_button_text_color?: string | undefined;
15495
- success_message?: string | undefined;
15496
- logo_shape?: "circle" | "square" | undefined;
15497
- inviter_logo_url?: string | undefined;
15498
- };
15499
- connect_partner_name: string | null;
15500
- }[] | undefined;
15501
15486
  user_identities?: {
15502
15487
  display_name: string;
15503
15488
  workspace_id: string;
@@ -15525,6 +15510,21 @@ declare const batch: z.ZodObject<{
15525
15510
  user_identity_key: string | null;
15526
15511
  acs_user_ids: string[];
15527
15512
  }[] | undefined;
15513
+ workspaces?: {
15514
+ name: string;
15515
+ workspace_id: string;
15516
+ is_suspended: boolean;
15517
+ company_name: string;
15518
+ is_sandbox: boolean;
15519
+ connect_webview_customization: {
15520
+ primary_button_color?: string | undefined;
15521
+ primary_button_text_color?: string | undefined;
15522
+ success_message?: string | undefined;
15523
+ logo_shape?: "circle" | "square" | undefined;
15524
+ inviter_logo_url?: string | undefined;
15525
+ };
15526
+ connect_partner_name: string | null;
15527
+ }[] | undefined;
15528
15528
  }, {
15529
15529
  batch_type: "spaces" | "access_grants" | "access_methods" | "workspaces";
15530
15530
  spaces?: {
@@ -16251,21 +16251,6 @@ declare const batch: z.ZodObject<{
16251
16251
  room_description?: string | undefined;
16252
16252
  } | undefined;
16253
16253
  }[] | undefined;
16254
- workspaces?: {
16255
- name: string;
16256
- workspace_id: string;
16257
- is_suspended: boolean;
16258
- company_name: string;
16259
- is_sandbox: boolean;
16260
- connect_webview_customization: {
16261
- primary_button_color?: string | undefined;
16262
- primary_button_text_color?: string | undefined;
16263
- success_message?: string | undefined;
16264
- logo_shape?: "circle" | "square" | undefined;
16265
- inviter_logo_url?: string | undefined;
16266
- };
16267
- connect_partner_name: string | null;
16268
- }[] | undefined;
16269
16254
  user_identities?: {
16270
16255
  display_name: string;
16271
16256
  workspace_id: string;
@@ -16293,6 +16278,21 @@ declare const batch: z.ZodObject<{
16293
16278
  user_identity_key: string | null;
16294
16279
  acs_user_ids: string[];
16295
16280
  }[] | undefined;
16281
+ workspaces?: {
16282
+ name: string;
16283
+ workspace_id: string;
16284
+ is_suspended: boolean;
16285
+ company_name: string;
16286
+ is_sandbox: boolean;
16287
+ connect_webview_customization: {
16288
+ primary_button_color?: string | undefined;
16289
+ primary_button_text_color?: string | undefined;
16290
+ success_message?: string | undefined;
16291
+ logo_shape?: "circle" | "square" | undefined;
16292
+ inviter_logo_url?: string | undefined;
16293
+ };
16294
+ connect_partner_name: string | null;
16295
+ }[] | undefined;
16296
16296
  }>;
16297
16297
  type Batch = z.infer<typeof batch>;
16298
16298
 
@@ -39976,6 +39976,138 @@ declare const _default: {
39976
39976
  };
39977
39977
  type: string;
39978
39978
  };
39979
+ user_identity: {
39980
+ description: string;
39981
+ properties: {
39982
+ acs_user_ids: {
39983
+ description: string;
39984
+ items: {
39985
+ format: string;
39986
+ type: string;
39987
+ };
39988
+ type: string;
39989
+ };
39990
+ created_at: {
39991
+ description: string;
39992
+ format: string;
39993
+ type: string;
39994
+ };
39995
+ display_name: {
39996
+ minLength: number;
39997
+ type: string;
39998
+ };
39999
+ email_address: {
40000
+ description: string;
40001
+ format: string;
40002
+ nullable: boolean;
40003
+ type: string;
40004
+ };
40005
+ errors: {
40006
+ description: string;
40007
+ items: {
40008
+ description: string;
40009
+ discriminator: {
40010
+ propertyName: string;
40011
+ };
40012
+ oneOf: {
40013
+ description: string;
40014
+ properties: {
40015
+ acs_system_id: {
40016
+ description: string;
40017
+ format: string;
40018
+ type: string;
40019
+ };
40020
+ acs_user_id: {
40021
+ description: string;
40022
+ format: string;
40023
+ type: string;
40024
+ };
40025
+ created_at: {
40026
+ description: string;
40027
+ format: string;
40028
+ type: string;
40029
+ };
40030
+ error_code: {
40031
+ description: string;
40032
+ enum: string[];
40033
+ type: string;
40034
+ };
40035
+ message: {
40036
+ description: string;
40037
+ type: string;
40038
+ };
40039
+ };
40040
+ required: string[];
40041
+ type: string;
40042
+ }[];
40043
+ };
40044
+ type: string;
40045
+ };
40046
+ full_name: {
40047
+ minLength: number;
40048
+ nullable: boolean;
40049
+ type: string;
40050
+ };
40051
+ phone_number: {
40052
+ description: string;
40053
+ nullable: boolean;
40054
+ type: string;
40055
+ };
40056
+ user_identity_id: {
40057
+ description: string;
40058
+ format: string;
40059
+ type: string;
40060
+ };
40061
+ user_identity_key: {
40062
+ description: string;
40063
+ minLength: number;
40064
+ nullable: boolean;
40065
+ type: string;
40066
+ };
40067
+ warnings: {
40068
+ description: string;
40069
+ items: {
40070
+ description: string;
40071
+ discriminator: {
40072
+ propertyName: string;
40073
+ };
40074
+ oneOf: {
40075
+ description: string;
40076
+ properties: {
40077
+ created_at: {
40078
+ description: string;
40079
+ format: string;
40080
+ type: string;
40081
+ };
40082
+ message: {
40083
+ description: string;
40084
+ type: string;
40085
+ };
40086
+ warning_code: {
40087
+ description: string;
40088
+ enum: string[];
40089
+ type: string;
40090
+ };
40091
+ };
40092
+ required: string[];
40093
+ type: string;
40094
+ }[];
40095
+ };
40096
+ type: string;
40097
+ };
40098
+ workspace_id: {
40099
+ description: string;
40100
+ format: string;
40101
+ type: string;
40102
+ };
40103
+ };
40104
+ required: string[];
40105
+ type: string;
40106
+ };
40107
+ workspace_id: {
40108
+ description: string;
40109
+ type: string;
40110
+ };
39979
40111
  };
39980
40112
  required: string[];
39981
40113
  type: string;
@@ -45780,7 +45912,6 @@ declare const _default: {
45780
45912
  schema: {
45781
45913
  properties: {
45782
45914
  batch: {
45783
- description: string;
45784
45915
  properties: {
45785
45916
  acs_entrances: {
45786
45917
  items: {
@@ -45788,29 +45919,35 @@ declare const _default: {
45788
45919
  };
45789
45920
  type: string;
45790
45921
  };
45922
+ acs_systems: {
45923
+ items: {
45924
+ $ref: string;
45925
+ };
45926
+ type: string;
45927
+ };
45791
45928
  batch_type: {
45792
45929
  enum: string[];
45793
45930
  type: string;
45794
45931
  };
45795
- devices: {
45932
+ connected_accounts: {
45796
45933
  items: {
45797
45934
  $ref: string;
45798
45935
  };
45799
45936
  type: string;
45800
45937
  };
45801
- spaces: {
45938
+ devices: {
45802
45939
  items: {
45803
45940
  $ref: string;
45804
45941
  };
45805
45942
  type: string;
45806
45943
  };
45807
- user_identities: {
45944
+ spaces: {
45808
45945
  items: {
45809
45946
  $ref: string;
45810
45947
  };
45811
45948
  type: string;
45812
45949
  };
45813
- workspaces: {
45950
+ user_identities: {
45814
45951
  items: {
45815
45952
  $ref: string;
45816
45953
  };
@@ -45819,7 +45956,6 @@ declare const _default: {
45819
45956
  };
45820
45957
  required: string[];
45821
45958
  type: string;
45822
- 'x-route-path': string;
45823
45959
  };
45824
45960
  ok: {
45825
45961
  type: string;
@@ -45906,7 +46042,6 @@ declare const _default: {
45906
46042
  schema: {
45907
46043
  properties: {
45908
46044
  batch: {
45909
- description: string;
45910
46045
  properties: {
45911
46046
  acs_entrances: {
45912
46047
  items: {
@@ -45914,29 +46049,35 @@ declare const _default: {
45914
46049
  };
45915
46050
  type: string;
45916
46051
  };
46052
+ acs_systems: {
46053
+ items: {
46054
+ $ref: string;
46055
+ };
46056
+ type: string;
46057
+ };
45917
46058
  batch_type: {
45918
46059
  enum: string[];
45919
46060
  type: string;
45920
46061
  };
45921
- devices: {
46062
+ connected_accounts: {
45922
46063
  items: {
45923
46064
  $ref: string;
45924
46065
  };
45925
46066
  type: string;
45926
46067
  };
45927
- spaces: {
46068
+ devices: {
45928
46069
  items: {
45929
46070
  $ref: string;
45930
46071
  };
45931
46072
  type: string;
45932
46073
  };
45933
- user_identities: {
46074
+ spaces: {
45934
46075
  items: {
45935
46076
  $ref: string;
45936
46077
  };
45937
46078
  type: string;
45938
46079
  };
45939
- workspaces: {
46080
+ user_identities: {
45940
46081
  items: {
45941
46082
  $ref: string;
45942
46083
  };
@@ -45945,7 +46086,6 @@ declare const _default: {
45945
46086
  };
45946
46087
  required: string[];
45947
46088
  type: string;
45948
- 'x-route-path': string;
45949
46089
  };
45950
46090
  ok: {
45951
46091
  type: string;
@@ -64705,7 +64845,7 @@ declare const _default: {
64705
64845
  'x-undocumented': string;
64706
64846
  };
64707
64847
  };
64708
- '/seam/console/v1/get_resource_type': {
64848
+ '/seam/console/v1/get_resource_locator': {
64709
64849
  get: {
64710
64850
  description: string;
64711
64851
  operationId: string;
@@ -64727,7 +64867,21 @@ declare const _default: {
64727
64867
  ok: {
64728
64868
  type: string;
64729
64869
  };
64730
- resource_type: {
64870
+ resource_locator: {
64871
+ properties: {
64872
+ acs_system_id: {
64873
+ format: string;
64874
+ type: string;
64875
+ };
64876
+ device_id: {
64877
+ format: string;
64878
+ type: string;
64879
+ };
64880
+ resource_type: {
64881
+ type: string;
64882
+ };
64883
+ };
64884
+ required: string[];
64731
64885
  type: string;
64732
64886
  };
64733
64887
  };
@@ -64796,7 +64950,21 @@ declare const _default: {
64796
64950
  ok: {
64797
64951
  type: string;
64798
64952
  };
64799
- resource_type: {
64953
+ resource_locator: {
64954
+ properties: {
64955
+ acs_system_id: {
64956
+ format: string;
64957
+ type: string;
64958
+ };
64959
+ device_id: {
64960
+ format: string;
64961
+ type: string;
64962
+ };
64963
+ resource_type: {
64964
+ type: string;
64965
+ };
64966
+ };
64967
+ required: string[];
64800
64968
  type: string;
64801
64969
  };
64802
64970
  };
@@ -67293,29 +67461,29 @@ declare const _default: {
67293
67461
  };
67294
67462
  type: string;
67295
67463
  };
67296
- batch_type: {
67297
- enum: string[];
67298
- type: string;
67299
- };
67300
- devices: {
67464
+ acs_systems: {
67301
67465
  items: {
67302
67466
  $ref: string;
67303
67467
  };
67304
67468
  type: string;
67305
67469
  };
67306
- spaces: {
67470
+ batch_type: {
67471
+ enum: string[];
67472
+ type: string;
67473
+ };
67474
+ connected_accounts: {
67307
67475
  items: {
67308
67476
  $ref: string;
67309
67477
  };
67310
67478
  type: string;
67311
67479
  };
67312
- user_identities: {
67480
+ devices: {
67313
67481
  items: {
67314
67482
  $ref: string;
67315
67483
  };
67316
67484
  type: string;
67317
67485
  };
67318
- workspaces: {
67486
+ spaces: {
67319
67487
  items: {
67320
67488
  $ref: string;
67321
67489
  };
@@ -67324,7 +67492,6 @@ declare const _default: {
67324
67492
  };
67325
67493
  required: string[];
67326
67494
  type: string;
67327
- 'x-route-path': string;
67328
67495
  };
67329
67496
  ok: {
67330
67497
  type: string;
@@ -67419,29 +67586,29 @@ declare const _default: {
67419
67586
  };
67420
67587
  type: string;
67421
67588
  };
67422
- batch_type: {
67423
- enum: string[];
67424
- type: string;
67425
- };
67426
- devices: {
67589
+ acs_systems: {
67427
67590
  items: {
67428
67591
  $ref: string;
67429
67592
  };
67430
67593
  type: string;
67431
67594
  };
67432
- spaces: {
67595
+ batch_type: {
67596
+ enum: string[];
67597
+ type: string;
67598
+ };
67599
+ connected_accounts: {
67433
67600
  items: {
67434
67601
  $ref: string;
67435
67602
  };
67436
67603
  type: string;
67437
67604
  };
67438
- user_identities: {
67605
+ devices: {
67439
67606
  items: {
67440
67607
  $ref: string;
67441
67608
  };
67442
67609
  type: string;
67443
67610
  };
67444
- workspaces: {
67611
+ spaces: {
67445
67612
  items: {
67446
67613
  $ref: string;
67447
67614
  };
@@ -67450,7 +67617,6 @@ declare const _default: {
67450
67617
  };
67451
67618
  required: string[];
67452
67619
  type: string;
67453
- 'x-route-path': string;
67454
67620
  };
67455
67621
  ok: {
67456
67622
  type: string;
@@ -88598,88 +88764,13 @@ interface Routes {
88598
88764
  commonParams: {
88599
88765
  /** IDs of the access grants that you want to get along with their related resources. */
88600
88766
  access_grant_ids: string[];
88601
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
88602
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
88767
+ include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
88768
+ exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
88603
88769
  };
88604
88770
  formData: {};
88605
88771
  jsonResponse: {
88606
- /** Represents a resource batch. */
88607
88772
  batch: {
88608
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces';
88609
- user_identities?: Array<{
88610
- /** ID of the user identity. */
88611
- user_identity_id: string;
88612
- /** Unique key for the user identity. */
88613
- user_identity_key: string | null;
88614
- /** Unique email address for the user identity. */
88615
- email_address: string | null;
88616
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
88617
- phone_number: string | null;
88618
- display_name: string;
88619
- full_name: string | null;
88620
- /** Date and time at which the user identity was created. */
88621
- created_at: string;
88622
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
88623
- workspace_id: string;
88624
- /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
88625
- errors: Array<{
88626
- /** Date and time at which Seam created the error. */
88627
- created_at: string;
88628
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
88629
- message: string;
88630
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
88631
- error_code: 'issue_with_acs_user';
88632
- /** ID of the access system user that has an issue. */
88633
- acs_user_id: string;
88634
- /** ID of the access system that the user identity is associated with. */
88635
- acs_system_id: string;
88636
- }>;
88637
- /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
88638
- warnings: Array<{
88639
- /** Date and time at which Seam created the warning. */
88640
- created_at: string;
88641
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
88642
- message: string;
88643
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
88644
- warning_code: 'being_deleted';
88645
- } | {
88646
- /** Date and time at which Seam created the warning. */
88647
- created_at: string;
88648
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
88649
- message: string;
88650
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
88651
- warning_code: 'acs_user_profile_does_not_match_user_identity';
88652
- }>;
88653
- /** Array of access system user IDs associated with the user identity. */
88654
- acs_user_ids: string[];
88655
- }> | undefined;
88656
- workspaces?: Array<{
88657
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
88658
- workspace_id: string;
88659
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
88660
- name: string;
88661
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
88662
- company_name: string;
88663
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
88664
- is_sandbox: boolean;
88665
- connect_webview_customization: {
88666
- /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
88667
- primary_button_color?: string | undefined;
88668
- /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
88669
- primary_button_text_color?: string | undefined;
88670
- /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
88671
- success_message?: string | undefined;
88672
- /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
88673
- logo_shape?: ('circle' | 'square') | undefined;
88674
- /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
88675
- inviter_logo_url?: string | undefined;
88676
- };
88677
- /** Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
88678
- is_suspended: boolean;
88679
- /**
88680
- * @deprecated Use `company_name` instead. */
88681
- connect_partner_name: (string | null) | null;
88682
- }> | undefined;
88773
+ batch_type: 'access_grants';
88683
88774
  spaces?: Array<{
88684
88775
  /** ID of the space. */
88685
88776
  space_id: string;
@@ -90004,6 +90095,299 @@ interface Routes {
90004
90095
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
90005
90096
  can_unlock_with_code?: boolean | undefined;
90006
90097
  }> | undefined;
90098
+ user_identities?: Array<{
90099
+ /** ID of the user identity. */
90100
+ user_identity_id: string;
90101
+ /** Unique key for the user identity. */
90102
+ user_identity_key: string | null;
90103
+ /** Unique email address for the user identity. */
90104
+ email_address: string | null;
90105
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
90106
+ phone_number: string | null;
90107
+ display_name: string;
90108
+ full_name: string | null;
90109
+ /** Date and time at which the user identity was created. */
90110
+ created_at: string;
90111
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
90112
+ workspace_id: string;
90113
+ /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
90114
+ errors: Array<{
90115
+ /** Date and time at which Seam created the error. */
90116
+ created_at: string;
90117
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90118
+ message: string;
90119
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90120
+ error_code: 'issue_with_acs_user';
90121
+ /** ID of the access system user that has an issue. */
90122
+ acs_user_id: string;
90123
+ /** ID of the access system that the user identity is associated with. */
90124
+ acs_system_id: string;
90125
+ }>;
90126
+ /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
90127
+ warnings: Array<{
90128
+ /** Date and time at which Seam created the warning. */
90129
+ created_at: string;
90130
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90131
+ message: string;
90132
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90133
+ warning_code: 'being_deleted';
90134
+ } | {
90135
+ /** Date and time at which Seam created the warning. */
90136
+ created_at: string;
90137
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90138
+ message: string;
90139
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90140
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
90141
+ }>;
90142
+ /** Array of access system user IDs associated with the user identity. */
90143
+ acs_user_ids: string[];
90144
+ }> | undefined;
90145
+ connected_accounts?: Array<{
90146
+ /** ID of the connected account. */
90147
+ connected_account_id?: string | undefined;
90148
+ /** Date and time at which the connected account was created. */
90149
+ created_at?: string | undefined;
90150
+ /** User identifier associated with the connected account. */
90151
+ user_identifier?: {
90152
+ /** Username of the user identifier associated with the connected account. */
90153
+ username?: string | undefined;
90154
+ /** API URL for the user identifier associated with the connected account. */
90155
+ api_url?: string | undefined;
90156
+ /** Email address of the user identifier associated with the connected account. */
90157
+ email?: string | undefined;
90158
+ /** Phone number of the user identifier associated with the connected account. */
90159
+ phone?: string | undefined;
90160
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
90161
+ exclusive?: boolean | undefined;
90162
+ } | undefined;
90163
+ /** Type of connected account. */
90164
+ account_type?: string | undefined;
90165
+ /** Display name for the connected account type. */
90166
+ account_type_display_name: string;
90167
+ /** Errors associated with the connected account. */
90168
+ errors: Array<{
90169
+ /** Date and time at which Seam created the error. */
90170
+ created_at: string;
90171
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90172
+ message: string;
90173
+ /** Indicates whether the error is related specifically to the connected account. */
90174
+ is_connected_account_error?: boolean | undefined;
90175
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
90176
+ is_bridge_error?: boolean | undefined;
90177
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90178
+ error_code: 'account_disconnected';
90179
+ } | {
90180
+ /** Date and time at which Seam created the error. */
90181
+ created_at: string;
90182
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90183
+ message: string;
90184
+ /** Indicates whether the error is related specifically to the connected account. */
90185
+ is_connected_account_error?: boolean | undefined;
90186
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
90187
+ is_bridge_error?: boolean | undefined;
90188
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90189
+ error_code: 'invalid_credentials';
90190
+ } | {
90191
+ /** Date and time at which Seam created the error. */
90192
+ created_at: string;
90193
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90194
+ message: string;
90195
+ /** Indicates whether the error is related specifically to the connected account. */
90196
+ is_connected_account_error?: boolean | undefined;
90197
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
90198
+ is_bridge_error?: boolean | undefined;
90199
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90200
+ error_code: 'bridge_disconnected';
90201
+ } | {
90202
+ /** Date and time at which Seam created the error. */
90203
+ created_at: string;
90204
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90205
+ message: string;
90206
+ /** Indicates whether the error is related specifically to the connected account. */
90207
+ is_connected_account_error?: boolean | undefined;
90208
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
90209
+ is_bridge_error?: boolean | undefined;
90210
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90211
+ error_code: 'salto_ks_subscription_limit_exceeded';
90212
+ /** Salto KS metadata associated with the connected account that has an error. */
90213
+ salto_ks_metadata: {
90214
+ /** Salto sites associated with the connected account that has an error. */
90215
+ sites: Array<{
90216
+ /** ID of a Salto site associated with the connected account that has an error. */
90217
+ site_id: string;
90218
+ /** Name of a Salto site associated with the connected account that has an error. */
90219
+ site_name: string;
90220
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
90221
+ subscribed_site_user_count: number;
90222
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
90223
+ site_user_subscription_limit: number;
90224
+ }>;
90225
+ };
90226
+ }>;
90227
+ /** Warnings associated with the connected account. */
90228
+ warnings: Array<{
90229
+ /** Date and time at which Seam created the warning. */
90230
+ created_at: string;
90231
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90232
+ message: string;
90233
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90234
+ warning_code: 'scheduled_maintenance_window';
90235
+ } | {
90236
+ /** Date and time at which Seam created the warning. */
90237
+ created_at: string;
90238
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90239
+ message: string;
90240
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90241
+ warning_code: 'unknown_issue_with_connected_account';
90242
+ } | {
90243
+ /** Date and time at which Seam created the warning. */
90244
+ created_at: string;
90245
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90246
+ message: string;
90247
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90248
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
90249
+ /** Salto KS metadata associated with the connected account that has a warning. */
90250
+ salto_ks_metadata: {
90251
+ /** Salto sites associated with the connected account that has a warning. */
90252
+ sites: Array<{
90253
+ /** ID of a Salto site associated with the connected account that has a warning. */
90254
+ site_id: string;
90255
+ /** Name of a Salto site associated with the connected account that has a warning. */
90256
+ site_name: string;
90257
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
90258
+ site_user_subscription_limit: number;
90259
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
90260
+ subscribed_site_user_count: number;
90261
+ }>;
90262
+ };
90263
+ }>;
90264
+ /** 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. */
90265
+ custom_metadata: Record<string, string | boolean>;
90266
+ /** 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 management by the Seam API. */
90267
+ automatically_manage_new_devices: boolean;
90268
+ /** Your unique key for the customer associated with this connected account. */
90269
+ customer_key?: string | undefined;
90270
+ /** List of capabilities that were accepted during the account connection process. */
90271
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
90272
+ }> | undefined;
90273
+ acs_systems?: Array<{
90274
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90275
+ default_credential_manager_acs_system_id?: (string | null) | undefined;
90276
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90277
+ acs_system_id: string;
90278
+ acs_user_count?: number | undefined;
90279
+ acs_access_group_count?: number | undefined;
90280
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
90281
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
90282
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
90283
+ external_type_display_name?: string | undefined;
90284
+ /** Indicates whether the `acs_system` is a credential manager. */
90285
+ is_credential_manager: boolean;
90286
+ visionline_metadata?: {
90287
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
90288
+ mobile_access_uuid: string;
90289
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
90290
+ system_id: string;
90291
+ /** IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network. */
90292
+ lan_address: string;
90293
+ } | undefined;
90294
+ /**
90295
+ * @deprecated Use `external_type`. */
90296
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
90297
+ /**
90298
+ * @deprecated Use `external_type_display_name`. */
90299
+ system_type_display_name?: string | undefined;
90300
+ location: {
90301
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
90302
+ time_zone: string | null;
90303
+ };
90304
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90305
+ name: string;
90306
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
90307
+ created_at: string;
90308
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90309
+ workspace_id: string;
90310
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
90311
+ * @deprecated Use `connected_account_id`. */
90312
+ connected_account_ids: string[];
90313
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90314
+ connected_account_id: string;
90315
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90316
+ image_url: string;
90317
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
90318
+ image_alt_text: string;
90319
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90320
+ errors: Array<{
90321
+ /** Date and time at which Seam created the error. */
90322
+ created_at: string;
90323
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90324
+ message: string;
90325
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90326
+ error_code: 'seam_bridge_disconnected';
90327
+ } | {
90328
+ /** Date and time at which Seam created the error. */
90329
+ created_at: string;
90330
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90331
+ message: string;
90332
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90333
+ error_code: 'bridge_disconnected';
90334
+ is_bridge_error?: boolean | undefined;
90335
+ } | {
90336
+ /** Date and time at which Seam created the error. */
90337
+ created_at: string;
90338
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90339
+ message: string;
90340
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90341
+ error_code: 'visionline_instance_unreachable';
90342
+ } | {
90343
+ /** Date and time at which Seam created the error. */
90344
+ created_at: string;
90345
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90346
+ message: string;
90347
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90348
+ error_code: 'salto_ks_subscription_limit_exceeded';
90349
+ } | {
90350
+ /** Date and time at which Seam created the error. */
90351
+ created_at: string;
90352
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90353
+ message: string;
90354
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90355
+ error_code: 'acs_system_disconnected';
90356
+ } | {
90357
+ /** Date and time at which Seam created the error. */
90358
+ created_at: string;
90359
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90360
+ message: string;
90361
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90362
+ error_code: 'account_disconnected';
90363
+ } | {
90364
+ /** Date and time at which Seam created the error. */
90365
+ created_at: string;
90366
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90367
+ message: string;
90368
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
90369
+ error_code: 'salto_ks_certification_expired';
90370
+ }>;
90371
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
90372
+ warnings: Array<{
90373
+ /** Date and time at which Seam created the warning. */
90374
+ created_at: string;
90375
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90376
+ message: string;
90377
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90378
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
90379
+ } | {
90380
+ /** Date and time at which Seam created the warning. */
90381
+ created_at: string;
90382
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
90383
+ message: string;
90384
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
90385
+ warning_code: 'time_zone_does_not_match_location';
90386
+ /**
90387
+ * @deprecated this field is deprecated. */
90388
+ misconfigured_acs_entrance_ids?: string[] | undefined;
90389
+ }>;
90390
+ }> | undefined;
90007
90391
  };
90008
90392
  };
90009
90393
  };
@@ -103690,8 +104074,8 @@ interface Routes {
103690
104074
  }> | undefined;
103691
104075
  /** List of reservations. */
103692
104076
  reservations?: Array<{
103693
- /** Your display name for this access grant resource. */
103694
- name: string;
104077
+ /** Your name for this access grant resource. */
104078
+ name?: string | undefined;
103695
104079
  /** Starting date and time for the access grant. */
103696
104080
  starts_at?: string | undefined;
103697
104081
  /** Ending date and time for the access grant. */
@@ -103727,8 +104111,8 @@ interface Routes {
103727
104111
  }> | undefined;
103728
104112
  /** List of bookings. */
103729
104113
  bookings?: Array<{
103730
- /** Your display name for this access grant resource. */
103731
- name: string;
104114
+ /** Your name for this access grant resource. */
104115
+ name?: string | undefined;
103732
104116
  /** Starting date and time for the access grant. */
103733
104117
  starts_at?: string | undefined;
103734
104118
  /** Ending date and time for the access grant. */
@@ -103764,8 +104148,8 @@ interface Routes {
103764
104148
  }> | undefined;
103765
104149
  /** List of access grants. */
103766
104150
  access_grants?: Array<{
103767
- /** Your display name for this access grant resource. */
103768
- name: string;
104151
+ /** Your name for this access grant resource. */
104152
+ name?: string | undefined;
103769
104153
  /** Starting date and time for the access grant. */
103770
104154
  starts_at?: string | undefined;
103771
104155
  /** Ending date and time for the access grant. */
@@ -103950,8 +104334,8 @@ interface Routes {
103950
104334
  }> | undefined;
103951
104335
  /** List of reservations. */
103952
104336
  reservations?: Array<{
103953
- /** Your display name for this access grant resource. */
103954
- name: string;
104337
+ /** Your name for this access grant resource. */
104338
+ name?: string | undefined;
103955
104339
  /** Starting date and time for the access grant. */
103956
104340
  starts_at?: string | undefined;
103957
104341
  /** Ending date and time for the access grant. */
@@ -103987,8 +104371,8 @@ interface Routes {
103987
104371
  }> | undefined;
103988
104372
  /** List of bookings. */
103989
104373
  bookings?: Array<{
103990
- /** Your display name for this access grant resource. */
103991
- name: string;
104374
+ /** Your name for this access grant resource. */
104375
+ name?: string | undefined;
103992
104376
  /** Starting date and time for the access grant. */
103993
104377
  starts_at?: string | undefined;
103994
104378
  /** Ending date and time for the access grant. */
@@ -104024,8 +104408,8 @@ interface Routes {
104024
104408
  }> | undefined;
104025
104409
  /** List of access grants. */
104026
104410
  access_grants?: Array<{
104027
- /** Your display name for this access grant resource. */
104028
- name: string;
104411
+ /** Your name for this access grant resource. */
104412
+ name?: string | undefined;
104029
104413
  /** Starting date and time for the access grant. */
104030
104414
  starts_at?: string | undefined;
104031
104415
  /** Ending date and time for the access grant. */
@@ -127625,8 +128009,8 @@ interface Routes {
127625
128009
  }>;
127626
128010
  };
127627
128011
  };
127628
- '/seam/console/v1/get_resource_type': {
127629
- route: '/seam/console/v1/get_resource_type';
128012
+ '/seam/console/v1/get_resource_locator': {
128013
+ route: '/seam/console/v1/get_resource_locator';
127630
128014
  method: 'GET' | 'POST';
127631
128015
  queryParams: {
127632
128016
  uuid: string;
@@ -127635,7 +128019,11 @@ interface Routes {
127635
128019
  commonParams: {};
127636
128020
  formData: {};
127637
128021
  jsonResponse: {
127638
- resource_type: string;
128022
+ resource_locator: {
128023
+ resource_type: string;
128024
+ acs_system_id?: string | undefined;
128025
+ device_id?: string | undefined;
128026
+ };
127639
128027
  };
127640
128028
  };
127641
128029
  '/seam/customer/v1/automation_runs/list': {
@@ -127716,11 +128104,11 @@ interface Routes {
127716
128104
  } | undefined;
127717
128105
  reservation_time_updated?: {
127718
128106
  rule: 'reservation_time_updated';
127719
- config: {};
128107
+ config?: {} | undefined;
127720
128108
  } | undefined;
127721
128109
  reservation_deleted?: {
127722
128110
  rule: 'reservation_deleted';
127723
- config: {};
128111
+ config?: {} | undefined;
127724
128112
  } | undefined;
127725
128113
  } | undefined;
127726
128114
  };
@@ -127741,11 +128129,11 @@ interface Routes {
127741
128129
  } | undefined;
127742
128130
  reservation_time_updated?: {
127743
128131
  rule: 'reservation_time_updated';
127744
- config: {};
128132
+ config?: {} | undefined;
127745
128133
  } | undefined;
127746
128134
  reservation_deleted?: {
127747
128135
  rule: 'reservation_deleted';
127748
- config: {};
128136
+ config?: {} | undefined;
127749
128137
  } | undefined;
127750
128138
  } | undefined;
127751
128139
  };
@@ -128253,6 +128641,56 @@ interface Routes {
128253
128641
  }>;
128254
128642
  }>;
128255
128643
  }>;
128644
+ /** User identity. */
128645
+ user_identity: {
128646
+ /** ID of the user identity. */
128647
+ user_identity_id: string;
128648
+ /** Unique key for the user identity. */
128649
+ user_identity_key: string | null;
128650
+ /** Unique email address for the user identity. */
128651
+ email_address: string | null;
128652
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
128653
+ phone_number: string | null;
128654
+ display_name: string;
128655
+ full_name: string | null;
128656
+ /** Date and time at which the user identity was created. */
128657
+ created_at: string;
128658
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
128659
+ workspace_id: string;
128660
+ /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
128661
+ errors: Array<{
128662
+ /** Date and time at which Seam created the error. */
128663
+ created_at: string;
128664
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
128665
+ message: string;
128666
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
128667
+ error_code: 'issue_with_acs_user';
128668
+ /** ID of the access system user that has an issue. */
128669
+ acs_user_id: string;
128670
+ /** ID of the access system that the user identity is associated with. */
128671
+ acs_system_id: string;
128672
+ }>;
128673
+ /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
128674
+ warnings: Array<{
128675
+ /** Date and time at which Seam created the warning. */
128676
+ created_at: string;
128677
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
128678
+ message: string;
128679
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
128680
+ warning_code: 'being_deleted';
128681
+ } | {
128682
+ /** Date and time at which Seam created the warning. */
128683
+ created_at: string;
128684
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
128685
+ message: string;
128686
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
128687
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
128688
+ }>;
128689
+ /** Array of access system user IDs associated with the user identity. */
128690
+ acs_user_ids: string[];
128691
+ };
128692
+ /** Workspace ID. */
128693
+ workspace_id: string;
128256
128694
  };
128257
128695
  };
128258
128696
  };
@@ -128405,88 +128843,14 @@ interface Routes {
128405
128843
  commonParams: {
128406
128844
  /** IDs of the spaces that you want to get along with their related resources. */
128407
128845
  space_ids: string[];
128408
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
128409
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
128846
+ include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
128847
+ exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
128410
128848
  };
128411
128849
  formData: {};
128412
128850
  jsonResponse: {
128413
- /** Represents a resource batch. */
128851
+ /** ID of the affected access system user. */
128414
128852
  batch: {
128415
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces';
128416
- user_identities?: Array<{
128417
- /** ID of the user identity. */
128418
- user_identity_id: string;
128419
- /** Unique key for the user identity. */
128420
- user_identity_key: string | null;
128421
- /** Unique email address for the user identity. */
128422
- email_address: string | null;
128423
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
128424
- phone_number: string | null;
128425
- display_name: string;
128426
- full_name: string | null;
128427
- /** Date and time at which the user identity was created. */
128428
- created_at: string;
128429
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
128430
- workspace_id: string;
128431
- /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
128432
- errors: Array<{
128433
- /** Date and time at which Seam created the error. */
128434
- created_at: string;
128435
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
128436
- message: string;
128437
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
128438
- error_code: 'issue_with_acs_user';
128439
- /** ID of the access system user that has an issue. */
128440
- acs_user_id: string;
128441
- /** ID of the access system that the user identity is associated with. */
128442
- acs_system_id: string;
128443
- }>;
128444
- /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
128445
- warnings: Array<{
128446
- /** Date and time at which Seam created the warning. */
128447
- created_at: string;
128448
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
128449
- message: string;
128450
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
128451
- warning_code: 'being_deleted';
128452
- } | {
128453
- /** Date and time at which Seam created the warning. */
128454
- created_at: string;
128455
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
128456
- message: string;
128457
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
128458
- warning_code: 'acs_user_profile_does_not_match_user_identity';
128459
- }>;
128460
- /** Array of access system user IDs associated with the user identity. */
128461
- acs_user_ids: string[];
128462
- }> | undefined;
128463
- workspaces?: Array<{
128464
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
128465
- workspace_id: string;
128466
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
128467
- name: string;
128468
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
128469
- company_name: string;
128470
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
128471
- is_sandbox: boolean;
128472
- connect_webview_customization: {
128473
- /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
128474
- primary_button_color?: string | undefined;
128475
- /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
128476
- primary_button_text_color?: string | undefined;
128477
- /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
128478
- success_message?: string | undefined;
128479
- /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
128480
- logo_shape?: ('circle' | 'square') | undefined;
128481
- /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
128482
- inviter_logo_url?: string | undefined;
128483
- };
128484
- /** Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
128485
- is_suspended: boolean;
128486
- /**
128487
- * @deprecated Use `company_name` instead. */
128488
- connect_partner_name: (string | null) | null;
128489
- }> | undefined;
128853
+ batch_type: 'spaces';
128490
128854
  spaces?: Array<{
128491
128855
  /** ID of the space. */
128492
128856
  space_id: string;
@@ -129811,6 +130175,252 @@ interface Routes {
129811
130175
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
129812
130176
  can_unlock_with_code?: boolean | undefined;
129813
130177
  }> | undefined;
130178
+ connected_accounts?: Array<{
130179
+ /** ID of the connected account. */
130180
+ connected_account_id?: string | undefined;
130181
+ /** Date and time at which the connected account was created. */
130182
+ created_at?: string | undefined;
130183
+ /** User identifier associated with the connected account. */
130184
+ user_identifier?: {
130185
+ /** Username of the user identifier associated with the connected account. */
130186
+ username?: string | undefined;
130187
+ /** API URL for the user identifier associated with the connected account. */
130188
+ api_url?: string | undefined;
130189
+ /** Email address of the user identifier associated with the connected account. */
130190
+ email?: string | undefined;
130191
+ /** Phone number of the user identifier associated with the connected account. */
130192
+ phone?: string | undefined;
130193
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
130194
+ exclusive?: boolean | undefined;
130195
+ } | undefined;
130196
+ /** Type of connected account. */
130197
+ account_type?: string | undefined;
130198
+ /** Display name for the connected account type. */
130199
+ account_type_display_name: string;
130200
+ /** Errors associated with the connected account. */
130201
+ errors: Array<{
130202
+ /** Date and time at which Seam created the error. */
130203
+ created_at: string;
130204
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130205
+ message: string;
130206
+ /** Indicates whether the error is related specifically to the connected account. */
130207
+ is_connected_account_error?: boolean | undefined;
130208
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
130209
+ is_bridge_error?: boolean | undefined;
130210
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130211
+ error_code: 'account_disconnected';
130212
+ } | {
130213
+ /** Date and time at which Seam created the error. */
130214
+ created_at: string;
130215
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130216
+ message: string;
130217
+ /** Indicates whether the error is related specifically to the connected account. */
130218
+ is_connected_account_error?: boolean | undefined;
130219
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
130220
+ is_bridge_error?: boolean | undefined;
130221
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130222
+ error_code: 'invalid_credentials';
130223
+ } | {
130224
+ /** Date and time at which Seam created the error. */
130225
+ created_at: string;
130226
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130227
+ message: string;
130228
+ /** Indicates whether the error is related specifically to the connected account. */
130229
+ is_connected_account_error?: boolean | undefined;
130230
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
130231
+ is_bridge_error?: boolean | undefined;
130232
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130233
+ error_code: 'bridge_disconnected';
130234
+ } | {
130235
+ /** Date and time at which Seam created the error. */
130236
+ created_at: string;
130237
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130238
+ message: string;
130239
+ /** Indicates whether the error is related specifically to the connected account. */
130240
+ is_connected_account_error?: boolean | undefined;
130241
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
130242
+ is_bridge_error?: boolean | undefined;
130243
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130244
+ error_code: 'salto_ks_subscription_limit_exceeded';
130245
+ /** Salto KS metadata associated with the connected account that has an error. */
130246
+ salto_ks_metadata: {
130247
+ /** Salto sites associated with the connected account that has an error. */
130248
+ sites: Array<{
130249
+ /** ID of a Salto site associated with the connected account that has an error. */
130250
+ site_id: string;
130251
+ /** Name of a Salto site associated with the connected account that has an error. */
130252
+ site_name: string;
130253
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
130254
+ subscribed_site_user_count: number;
130255
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
130256
+ site_user_subscription_limit: number;
130257
+ }>;
130258
+ };
130259
+ }>;
130260
+ /** Warnings associated with the connected account. */
130261
+ warnings: Array<{
130262
+ /** Date and time at which Seam created the warning. */
130263
+ created_at: string;
130264
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
130265
+ message: string;
130266
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
130267
+ warning_code: 'scheduled_maintenance_window';
130268
+ } | {
130269
+ /** Date and time at which Seam created the warning. */
130270
+ created_at: string;
130271
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
130272
+ message: string;
130273
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
130274
+ warning_code: 'unknown_issue_with_connected_account';
130275
+ } | {
130276
+ /** Date and time at which Seam created the warning. */
130277
+ created_at: string;
130278
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
130279
+ message: string;
130280
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
130281
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
130282
+ /** Salto KS metadata associated with the connected account that has a warning. */
130283
+ salto_ks_metadata: {
130284
+ /** Salto sites associated with the connected account that has a warning. */
130285
+ sites: Array<{
130286
+ /** ID of a Salto site associated with the connected account that has a warning. */
130287
+ site_id: string;
130288
+ /** Name of a Salto site associated with the connected account that has a warning. */
130289
+ site_name: string;
130290
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
130291
+ site_user_subscription_limit: number;
130292
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
130293
+ subscribed_site_user_count: number;
130294
+ }>;
130295
+ };
130296
+ }>;
130297
+ /** 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. */
130298
+ custom_metadata: Record<string, string | boolean>;
130299
+ /** 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 management by the Seam API. */
130300
+ automatically_manage_new_devices: boolean;
130301
+ /** Your unique key for the customer associated with this connected account. */
130302
+ customer_key?: string | undefined;
130303
+ /** List of capabilities that were accepted during the account connection process. */
130304
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
130305
+ }> | undefined;
130306
+ acs_systems?: Array<{
130307
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130308
+ default_credential_manager_acs_system_id?: (string | null) | undefined;
130309
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130310
+ acs_system_id: string;
130311
+ acs_user_count?: number | undefined;
130312
+ acs_access_group_count?: number | undefined;
130313
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
130314
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
130315
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
130316
+ external_type_display_name?: string | undefined;
130317
+ /** Indicates whether the `acs_system` is a credential manager. */
130318
+ is_credential_manager: boolean;
130319
+ visionline_metadata?: {
130320
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
130321
+ mobile_access_uuid: string;
130322
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
130323
+ system_id: string;
130324
+ /** IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network. */
130325
+ lan_address: string;
130326
+ } | undefined;
130327
+ /**
130328
+ * @deprecated Use `external_type`. */
130329
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
130330
+ /**
130331
+ * @deprecated Use `external_type_display_name`. */
130332
+ system_type_display_name?: string | undefined;
130333
+ location: {
130334
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
130335
+ time_zone: string | null;
130336
+ };
130337
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130338
+ name: string;
130339
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
130340
+ created_at: string;
130341
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130342
+ workspace_id: string;
130343
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
130344
+ * @deprecated Use `connected_account_id`. */
130345
+ connected_account_ids: string[];
130346
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130347
+ connected_account_id: string;
130348
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130349
+ image_url: string;
130350
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
130351
+ image_alt_text: string;
130352
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130353
+ errors: Array<{
130354
+ /** Date and time at which Seam created the error. */
130355
+ created_at: string;
130356
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130357
+ message: string;
130358
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130359
+ error_code: 'seam_bridge_disconnected';
130360
+ } | {
130361
+ /** Date and time at which Seam created the error. */
130362
+ created_at: string;
130363
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130364
+ message: string;
130365
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130366
+ error_code: 'bridge_disconnected';
130367
+ is_bridge_error?: boolean | undefined;
130368
+ } | {
130369
+ /** Date and time at which Seam created the error. */
130370
+ created_at: string;
130371
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130372
+ message: string;
130373
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130374
+ error_code: 'visionline_instance_unreachable';
130375
+ } | {
130376
+ /** Date and time at which Seam created the error. */
130377
+ created_at: string;
130378
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130379
+ message: string;
130380
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130381
+ error_code: 'salto_ks_subscription_limit_exceeded';
130382
+ } | {
130383
+ /** Date and time at which Seam created the error. */
130384
+ created_at: string;
130385
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130386
+ message: string;
130387
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130388
+ error_code: 'acs_system_disconnected';
130389
+ } | {
130390
+ /** Date and time at which Seam created the error. */
130391
+ created_at: string;
130392
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130393
+ message: string;
130394
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130395
+ error_code: 'account_disconnected';
130396
+ } | {
130397
+ /** Date and time at which Seam created the error. */
130398
+ created_at: string;
130399
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130400
+ message: string;
130401
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
130402
+ error_code: 'salto_ks_certification_expired';
130403
+ }>;
130404
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
130405
+ warnings: Array<{
130406
+ /** Date and time at which Seam created the warning. */
130407
+ created_at: string;
130408
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
130409
+ message: string;
130410
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
130411
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
130412
+ } | {
130413
+ /** Date and time at which Seam created the warning. */
130414
+ created_at: string;
130415
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
130416
+ message: string;
130417
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
130418
+ warning_code: 'time_zone_does_not_match_location';
130419
+ /**
130420
+ * @deprecated this field is deprecated. */
130421
+ misconfigured_acs_entrance_ids?: string[] | undefined;
130422
+ }>;
130423
+ }> | undefined;
129814
130424
  };
129815
130425
  };
129816
130426
  };