@seamapi/types 1.373.3 → 1.375.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. package/dist/connect.cjs +158 -63
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +789 -116
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +93 -15
  5. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +93 -15
  6. package/lib/seam/connect/models/acs/acs-system.d.ts +61 -0
  7. package/lib/seam/connect/models/acs/acs-system.js +11 -1
  8. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  9. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +200 -48
  10. package/lib/seam/connect/models/connected-accounts/connected-account.js +9 -1
  11. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device.d.ts +118 -24
  13. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +61 -15
  14. package/lib/seam/connect/openapi.d.ts +66 -8
  15. package/lib/seam/connect/openapi.js +140 -61
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +322 -33
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/acs/acs-system.ts +12 -1
  20. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +10 -1
  21. package/src/lib/seam/connect/openapi.ts +159 -61
  22. package/src/lib/seam/connect/route-types.ts +353 -33
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -62,6 +62,7 @@ declare const _default: {
62
62
  };
63
63
  is_connected_account_error?: never;
64
64
  is_device_error?: never;
65
+ is_bridge_error?: never;
65
66
  };
66
67
  required: string[];
67
68
  type: string;
@@ -90,6 +91,7 @@ declare const _default: {
90
91
  type: string;
91
92
  };
92
93
  is_access_code_error?: never;
94
+ is_bridge_error?: never;
93
95
  };
94
96
  required: string[];
95
97
  type: string;
@@ -115,6 +117,7 @@ declare const _default: {
115
117
  };
116
118
  is_access_code_error?: never;
117
119
  is_connected_account_error?: never;
120
+ is_bridge_error?: never;
118
121
  };
119
122
  required: string[];
120
123
  type: string;
@@ -131,9 +134,12 @@ declare const _default: {
131
134
  enum: string[];
132
135
  type: string;
133
136
  };
137
+ is_bridge_error: {
138
+ type: string;
139
+ };
134
140
  is_connected_account_error: {
135
- enum: boolean[];
136
141
  type: string;
142
+ enum?: never;
137
143
  };
138
144
  message: {
139
145
  type: string;
@@ -850,11 +856,19 @@ declare const _default: {
850
856
  acs_system: {
851
857
  description: string;
852
858
  properties: {
859
+ acs_access_group_count: {
860
+ format: string;
861
+ type: string;
862
+ };
853
863
  acs_system_id: {
854
864
  description: string;
855
865
  format: string;
856
866
  type: string;
857
867
  };
868
+ acs_users_count: {
869
+ format: string;
870
+ type: string;
871
+ };
858
872
  can_add_acs_users_to_acs_access_groups: {
859
873
  description: string;
860
874
  type: string;
@@ -904,7 +918,7 @@ declare const _default: {
904
918
  discriminator: {
905
919
  propertyName: string;
906
920
  };
907
- oneOf: {
921
+ oneOf: ({
908
922
  description: string;
909
923
  properties: {
910
924
  created_at: {
@@ -921,10 +935,34 @@ declare const _default: {
921
935
  description: string;
922
936
  type: string;
923
937
  };
938
+ is_bridge_error?: never;
924
939
  };
925
940
  required: string[];
926
941
  type: string;
927
- }[];
942
+ } | {
943
+ description: string;
944
+ properties: {
945
+ created_at: {
946
+ description: string;
947
+ format: string;
948
+ type: string;
949
+ };
950
+ error_code: {
951
+ description: string;
952
+ enum: string[];
953
+ type: string;
954
+ };
955
+ is_bridge_error: {
956
+ type: string;
957
+ };
958
+ message: {
959
+ description: string;
960
+ type: string;
961
+ };
962
+ };
963
+ required: string[];
964
+ type: string;
965
+ })[];
928
966
  };
929
967
  type: string;
930
968
  };
@@ -2823,8 +2861,10 @@ declare const _default: {
2823
2861
  enum: string[];
2824
2862
  type: string;
2825
2863
  };
2864
+ is_bridge_error: {
2865
+ type: string;
2866
+ };
2826
2867
  is_connected_account_error: {
2827
- enum: boolean[];
2828
2868
  type: string;
2829
2869
  };
2830
2870
  message: {
@@ -2847,8 +2887,10 @@ declare const _default: {
2847
2887
  enum: string[];
2848
2888
  type: string;
2849
2889
  };
2890
+ is_bridge_error: {
2891
+ type: string;
2892
+ };
2850
2893
  is_connected_account_error: {
2851
- enum: boolean[];
2852
2894
  type: string;
2853
2895
  };
2854
2896
  message: {
@@ -3105,6 +3147,7 @@ declare const _default: {
3105
3147
  message: {
3106
3148
  type: string;
3107
3149
  };
3150
+ is_bridge_error?: never;
3108
3151
  };
3109
3152
  required: string[];
3110
3153
  type: string;
@@ -3129,6 +3172,7 @@ declare const _default: {
3129
3172
  type: string;
3130
3173
  };
3131
3174
  is_connected_account_error?: never;
3175
+ is_bridge_error?: never;
3132
3176
  };
3133
3177
  required: string[];
3134
3178
  type: string;
@@ -3145,9 +3189,12 @@ declare const _default: {
3145
3189
  enum: string[];
3146
3190
  type: string;
3147
3191
  };
3192
+ is_bridge_error: {
3193
+ type: string;
3194
+ };
3148
3195
  is_connected_account_error: {
3149
- enum: boolean[];
3150
3196
  type: string;
3197
+ enum?: never;
3151
3198
  };
3152
3199
  message: {
3153
3200
  type: string;
@@ -7881,6 +7928,7 @@ declare const _default: {
7881
7928
  };
7882
7929
  is_connected_account_error?: never;
7883
7930
  is_device_error?: never;
7931
+ is_bridge_error?: never;
7884
7932
  };
7885
7933
  required: string[];
7886
7934
  type: string;
@@ -7909,6 +7957,7 @@ declare const _default: {
7909
7957
  type: string;
7910
7958
  };
7911
7959
  is_access_code_error?: never;
7960
+ is_bridge_error?: never;
7912
7961
  };
7913
7962
  required: string[];
7914
7963
  type: string;
@@ -7934,6 +7983,7 @@ declare const _default: {
7934
7983
  };
7935
7984
  is_access_code_error?: never;
7936
7985
  is_connected_account_error?: never;
7986
+ is_bridge_error?: never;
7937
7987
  };
7938
7988
  required: string[];
7939
7989
  type: string;
@@ -7950,9 +8000,12 @@ declare const _default: {
7950
8000
  enum: string[];
7951
8001
  type: string;
7952
8002
  };
8003
+ is_bridge_error: {
8004
+ type: string;
8005
+ };
7953
8006
  is_connected_account_error: {
7954
- enum: boolean[];
7955
8007
  type: string;
8008
+ enum?: never;
7956
8009
  };
7957
8010
  message: {
7958
8011
  type: string;
@@ -8848,6 +8901,7 @@ declare const _default: {
8848
8901
  message: {
8849
8902
  type: string;
8850
8903
  };
8904
+ is_bridge_error?: never;
8851
8905
  };
8852
8906
  required: string[];
8853
8907
  type: string;
@@ -8872,6 +8926,7 @@ declare const _default: {
8872
8926
  type: string;
8873
8927
  };
8874
8928
  is_connected_account_error?: never;
8929
+ is_bridge_error?: never;
8875
8930
  };
8876
8931
  required: string[];
8877
8932
  type: string;
@@ -8888,9 +8943,12 @@ declare const _default: {
8888
8943
  enum: string[];
8889
8944
  type: string;
8890
8945
  };
8946
+ is_bridge_error: {
8947
+ type: string;
8948
+ };
8891
8949
  is_connected_account_error: {
8892
- enum: boolean[];
8893
8950
  type: string;
8951
+ enum?: never;
8894
8952
  };
8895
8953
  message: {
8896
8954
  type: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -686,18 +686,31 @@ export default {
686
686
  enum: ['invalid_credentials'],
687
687
  type: 'string',
688
688
  },
689
- is_connected_account_error: {
690
- enum: [true],
691
- type: 'boolean',
689
+ is_bridge_error: { type: 'boolean' },
690
+ is_connected_account_error: { type: 'boolean' },
691
+ message: { type: 'string' },
692
+ },
693
+ required: ['created_at', 'message', 'error_code'],
694
+ type: 'object',
695
+ },
696
+ {
697
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
698
+ properties: {
699
+ created_at: {
700
+ description: 'Date and time at which Seam created the error.',
701
+ format: 'date-time',
702
+ type: 'string',
703
+ },
704
+ error_code: {
705
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
706
+ enum: ['bridge_disconnected'],
707
+ type: 'string',
692
708
  },
709
+ is_bridge_error: { type: 'boolean' },
710
+ is_connected_account_error: { type: 'boolean' },
693
711
  message: { type: 'string' },
694
712
  },
695
- required: [
696
- 'created_at',
697
- 'message',
698
- 'is_connected_account_error',
699
- 'error_code',
700
- ],
713
+ required: ['created_at', 'message', 'error_code'],
701
714
  type: 'object',
702
715
  },
703
716
  ],
@@ -1638,11 +1651,13 @@ export default {
1638
1651
  acs_system: {
1639
1652
  description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).',
1640
1653
  properties: {
1654
+ acs_access_group_count: { format: 'float', type: 'number' },
1641
1655
  acs_system_id: {
1642
1656
  description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1643
1657
  format: 'uuid',
1644
1658
  type: 'string',
1645
1659
  },
1660
+ acs_users_count: { format: 'float', type: 'number' },
1646
1661
  can_add_acs_users_to_acs_access_groups: {
1647
1662
  description: 'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1648
1663
  type: 'boolean',
@@ -1689,7 +1704,7 @@ export default {
1689
1704
  discriminator: { propertyName: 'error_code' },
1690
1705
  oneOf: [
1691
1706
  {
1692
- description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1707
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1693
1708
  properties: {
1694
1709
  created_at: {
1695
1710
  description: 'Date and time at which Seam created the error.',
@@ -1709,6 +1724,28 @@ export default {
1709
1724
  required: ['created_at', 'message', 'error_code'],
1710
1725
  type: 'object',
1711
1726
  },
1727
+ {
1728
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1729
+ properties: {
1730
+ created_at: {
1731
+ description: 'Date and time at which Seam created the error.',
1732
+ format: 'date-time',
1733
+ type: 'string',
1734
+ },
1735
+ error_code: {
1736
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
1737
+ enum: ['bridge_disconnected'],
1738
+ type: 'string',
1739
+ },
1740
+ is_bridge_error: { type: 'boolean' },
1741
+ message: {
1742
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
1743
+ type: 'string',
1744
+ },
1745
+ },
1746
+ required: ['created_at', 'message', 'error_code'],
1747
+ type: 'object',
1748
+ },
1712
1749
  {
1713
1750
  description: 'Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
1714
1751
  properties: {
@@ -5523,18 +5560,11 @@ export default {
5523
5560
  enum: ['account_disconnected'],
5524
5561
  type: 'string',
5525
5562
  },
5526
- is_connected_account_error: {
5527
- enum: [true],
5528
- type: 'boolean',
5529
- },
5563
+ is_bridge_error: { type: 'boolean' },
5564
+ is_connected_account_error: { type: 'boolean' },
5530
5565
  message: { type: 'string' },
5531
5566
  },
5532
- required: [
5533
- 'created_at',
5534
- 'message',
5535
- 'is_connected_account_error',
5536
- 'error_code',
5537
- ],
5567
+ required: ['created_at', 'message', 'error_code'],
5538
5568
  type: 'object',
5539
5569
  },
5540
5570
  {
@@ -5550,18 +5580,31 @@ export default {
5550
5580
  enum: ['invalid_credentials'],
5551
5581
  type: 'string',
5552
5582
  },
5553
- is_connected_account_error: {
5554
- enum: [true],
5555
- type: 'boolean',
5583
+ is_bridge_error: { type: 'boolean' },
5584
+ is_connected_account_error: { type: 'boolean' },
5585
+ message: { type: 'string' },
5586
+ },
5587
+ required: ['created_at', 'message', 'error_code'],
5588
+ type: 'object',
5589
+ },
5590
+ {
5591
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
5592
+ properties: {
5593
+ created_at: {
5594
+ description: 'Date and time at which Seam created the error.',
5595
+ format: 'date-time',
5596
+ type: 'string',
5597
+ },
5598
+ error_code: {
5599
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5600
+ enum: ['bridge_disconnected'],
5601
+ type: 'string',
5556
5602
  },
5603
+ is_bridge_error: { type: 'boolean' },
5604
+ is_connected_account_error: { type: 'boolean' },
5557
5605
  message: { type: 'string' },
5558
5606
  },
5559
- required: [
5560
- 'created_at',
5561
- 'message',
5562
- 'is_connected_account_error',
5563
- 'error_code',
5564
- ],
5607
+ required: ['created_at', 'message', 'error_code'],
5565
5608
  type: 'object',
5566
5609
  },
5567
5610
  {
@@ -5577,10 +5620,8 @@ export default {
5577
5620
  enum: ['salto_ks_subscription_limit_exceeded'],
5578
5621
  type: 'string',
5579
5622
  },
5580
- is_connected_account_error: {
5581
- enum: [true],
5582
- type: 'boolean',
5583
- },
5623
+ is_bridge_error: { type: 'boolean' },
5624
+ is_connected_account_error: { type: 'boolean' },
5584
5625
  message: { type: 'string' },
5585
5626
  salto_ks_metadata: {
5586
5627
  properties: {
@@ -5616,7 +5657,6 @@ export default {
5616
5657
  required: [
5617
5658
  'created_at',
5618
5659
  'message',
5619
- 'is_connected_account_error',
5620
5660
  'error_code',
5621
5661
  'salto_ks_metadata',
5622
5662
  ],
@@ -6142,18 +6182,31 @@ export default {
6142
6182
  enum: ['invalid_credentials'],
6143
6183
  type: 'string',
6144
6184
  },
6145
- is_connected_account_error: {
6146
- enum: [true],
6147
- type: 'boolean',
6185
+ is_bridge_error: { type: 'boolean' },
6186
+ is_connected_account_error: { type: 'boolean' },
6187
+ message: { type: 'string' },
6188
+ },
6189
+ required: ['created_at', 'message', 'error_code'],
6190
+ type: 'object',
6191
+ },
6192
+ {
6193
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
6194
+ properties: {
6195
+ created_at: {
6196
+ description: 'Date and time at which Seam created the error.',
6197
+ format: 'date-time',
6198
+ type: 'string',
6199
+ },
6200
+ error_code: {
6201
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
6202
+ enum: ['bridge_disconnected'],
6203
+ type: 'string',
6148
6204
  },
6205
+ is_bridge_error: { type: 'boolean' },
6206
+ is_connected_account_error: { type: 'boolean' },
6149
6207
  message: { type: 'string' },
6150
6208
  },
6151
- required: [
6152
- 'created_at',
6153
- 'message',
6154
- 'is_connected_account_error',
6155
- 'error_code',
6156
- ],
6209
+ required: ['created_at', 'message', 'error_code'],
6157
6210
  type: 'object',
6158
6211
  },
6159
6212
  ],
@@ -12976,18 +13029,31 @@ export default {
12976
13029
  enum: ['invalid_credentials'],
12977
13030
  type: 'string',
12978
13031
  },
12979
- is_connected_account_error: {
12980
- enum: [true],
12981
- type: 'boolean',
13032
+ is_bridge_error: { type: 'boolean' },
13033
+ is_connected_account_error: { type: 'boolean' },
13034
+ message: { type: 'string' },
13035
+ },
13036
+ required: ['created_at', 'message', 'error_code'],
13037
+ type: 'object',
13038
+ },
13039
+ {
13040
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
13041
+ properties: {
13042
+ created_at: {
13043
+ description: 'Date and time at which Seam created the error.',
13044
+ format: 'date-time',
13045
+ type: 'string',
13046
+ },
13047
+ error_code: {
13048
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13049
+ enum: ['bridge_disconnected'],
13050
+ type: 'string',
12982
13051
  },
13052
+ is_bridge_error: { type: 'boolean' },
13053
+ is_connected_account_error: { type: 'boolean' },
12983
13054
  message: { type: 'string' },
12984
13055
  },
12985
- required: [
12986
- 'created_at',
12987
- 'message',
12988
- 'is_connected_account_error',
12989
- 'error_code',
12990
- ],
13056
+ required: ['created_at', 'message', 'error_code'],
12991
13057
  type: 'object',
12992
13058
  },
12993
13059
  ],
@@ -14481,18 +14547,31 @@ export default {
14481
14547
  enum: ['invalid_credentials'],
14482
14548
  type: 'string',
14483
14549
  },
14484
- is_connected_account_error: {
14485
- enum: [true],
14486
- type: 'boolean',
14550
+ is_bridge_error: { type: 'boolean' },
14551
+ is_connected_account_error: { type: 'boolean' },
14552
+ message: { type: 'string' },
14553
+ },
14554
+ required: ['created_at', 'message', 'error_code'],
14555
+ type: 'object',
14556
+ },
14557
+ {
14558
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
14559
+ properties: {
14560
+ created_at: {
14561
+ description: 'Date and time at which Seam created the error.',
14562
+ format: 'date-time',
14563
+ type: 'string',
14564
+ },
14565
+ error_code: {
14566
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14567
+ enum: ['bridge_disconnected'],
14568
+ type: 'string',
14487
14569
  },
14570
+ is_bridge_error: { type: 'boolean' },
14571
+ is_connected_account_error: { type: 'boolean' },
14488
14572
  message: { type: 'string' },
14489
14573
  },
14490
- required: [
14491
- 'created_at',
14492
- 'message',
14493
- 'is_connected_account_error',
14494
- 'error_code',
14495
- ],
14574
+ required: ['created_at', 'message', 'error_code'],
14496
14575
  type: 'object',
14497
14576
  },
14498
14577
  ],