@seamapi/types 1.374.0 → 1.375.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.
Files changed (22) hide show
  1. package/dist/connect.cjs +156 -65
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +775 -124
  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 +58 -3
  7. package/lib/seam/connect/models/acs/acs-system.js +10 -2
  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 +59 -9
  15. package/lib/seam/connect/openapi.js +139 -62
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +318 -37
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/acs/acs-system.ts +11 -2
  20. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +10 -1
  21. package/src/lib/seam/connect/openapi.ts +158 -62
  22. package/src/lib/seam/connect/route-types.ts +349 -37
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;
@@ -859,7 +865,7 @@ declare const _default: {
859
865
  format: string;
860
866
  type: string;
861
867
  };
862
- acs_users_count: {
868
+ acs_user_count: {
863
869
  format: string;
864
870
  type: string;
865
871
  };
@@ -912,7 +918,7 @@ declare const _default: {
912
918
  discriminator: {
913
919
  propertyName: string;
914
920
  };
915
- oneOf: {
921
+ oneOf: ({
916
922
  description: string;
917
923
  properties: {
918
924
  created_at: {
@@ -929,10 +935,34 @@ declare const _default: {
929
935
  description: string;
930
936
  type: string;
931
937
  };
938
+ is_bridge_error?: never;
932
939
  };
933
940
  required: string[];
934
941
  type: string;
935
- }[];
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
+ })[];
936
966
  };
937
967
  type: string;
938
968
  };
@@ -2831,8 +2861,10 @@ declare const _default: {
2831
2861
  enum: string[];
2832
2862
  type: string;
2833
2863
  };
2864
+ is_bridge_error: {
2865
+ type: string;
2866
+ };
2834
2867
  is_connected_account_error: {
2835
- enum: boolean[];
2836
2868
  type: string;
2837
2869
  };
2838
2870
  message: {
@@ -2855,8 +2887,10 @@ declare const _default: {
2855
2887
  enum: string[];
2856
2888
  type: string;
2857
2889
  };
2890
+ is_bridge_error: {
2891
+ type: string;
2892
+ };
2858
2893
  is_connected_account_error: {
2859
- enum: boolean[];
2860
2894
  type: string;
2861
2895
  };
2862
2896
  message: {
@@ -3113,6 +3147,7 @@ declare const _default: {
3113
3147
  message: {
3114
3148
  type: string;
3115
3149
  };
3150
+ is_bridge_error?: never;
3116
3151
  };
3117
3152
  required: string[];
3118
3153
  type: string;
@@ -3137,6 +3172,7 @@ declare const _default: {
3137
3172
  type: string;
3138
3173
  };
3139
3174
  is_connected_account_error?: never;
3175
+ is_bridge_error?: never;
3140
3176
  };
3141
3177
  required: string[];
3142
3178
  type: string;
@@ -3153,9 +3189,12 @@ declare const _default: {
3153
3189
  enum: string[];
3154
3190
  type: string;
3155
3191
  };
3192
+ is_bridge_error: {
3193
+ type: string;
3194
+ };
3156
3195
  is_connected_account_error: {
3157
- enum: boolean[];
3158
3196
  type: string;
3197
+ enum?: never;
3159
3198
  };
3160
3199
  message: {
3161
3200
  type: string;
@@ -7889,6 +7928,7 @@ declare const _default: {
7889
7928
  };
7890
7929
  is_connected_account_error?: never;
7891
7930
  is_device_error?: never;
7931
+ is_bridge_error?: never;
7892
7932
  };
7893
7933
  required: string[];
7894
7934
  type: string;
@@ -7917,6 +7957,7 @@ declare const _default: {
7917
7957
  type: string;
7918
7958
  };
7919
7959
  is_access_code_error?: never;
7960
+ is_bridge_error?: never;
7920
7961
  };
7921
7962
  required: string[];
7922
7963
  type: string;
@@ -7942,6 +7983,7 @@ declare const _default: {
7942
7983
  };
7943
7984
  is_access_code_error?: never;
7944
7985
  is_connected_account_error?: never;
7986
+ is_bridge_error?: never;
7945
7987
  };
7946
7988
  required: string[];
7947
7989
  type: string;
@@ -7958,9 +8000,12 @@ declare const _default: {
7958
8000
  enum: string[];
7959
8001
  type: string;
7960
8002
  };
8003
+ is_bridge_error: {
8004
+ type: string;
8005
+ };
7961
8006
  is_connected_account_error: {
7962
- enum: boolean[];
7963
8007
  type: string;
8008
+ enum?: never;
7964
8009
  };
7965
8010
  message: {
7966
8011
  type: string;
@@ -8856,6 +8901,7 @@ declare const _default: {
8856
8901
  message: {
8857
8902
  type: string;
8858
8903
  };
8904
+ is_bridge_error?: never;
8859
8905
  };
8860
8906
  required: string[];
8861
8907
  type: string;
@@ -8880,6 +8926,7 @@ declare const _default: {
8880
8926
  type: string;
8881
8927
  };
8882
8928
  is_connected_account_error?: never;
8929
+ is_bridge_error?: never;
8883
8930
  };
8884
8931
  required: string[];
8885
8932
  type: string;
@@ -8896,9 +8943,12 @@ declare const _default: {
8896
8943
  enum: string[];
8897
8944
  type: string;
8898
8945
  };
8946
+ is_bridge_error: {
8947
+ type: string;
8948
+ };
8899
8949
  is_connected_account_error: {
8900
- enum: boolean[];
8901
8950
  type: string;
8951
+ enum?: never;
8902
8952
  };
8903
8953
  message: {
8904
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
  ],
@@ -1644,7 +1657,7 @@ export default {
1644
1657
  format: 'uuid',
1645
1658
  type: 'string',
1646
1659
  },
1647
- acs_users_count: { format: 'float', type: 'number' },
1660
+ acs_user_count: { format: 'float', type: 'number' },
1648
1661
  can_add_acs_users_to_acs_access_groups: {
1649
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).',
1650
1663
  type: 'boolean',
@@ -1691,7 +1704,7 @@ export default {
1691
1704
  discriminator: { propertyName: 'error_code' },
1692
1705
  oneOf: [
1693
1706
  {
1694
- 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).',
1695
1708
  properties: {
1696
1709
  created_at: {
1697
1710
  description: 'Date and time at which Seam created the error.',
@@ -1711,6 +1724,28 @@ export default {
1711
1724
  required: ['created_at', 'message', 'error_code'],
1712
1725
  type: 'object',
1713
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
+ },
1714
1749
  {
1715
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).',
1716
1751
  properties: {
@@ -5525,18 +5560,11 @@ export default {
5525
5560
  enum: ['account_disconnected'],
5526
5561
  type: 'string',
5527
5562
  },
5528
- is_connected_account_error: {
5529
- enum: [true],
5530
- type: 'boolean',
5531
- },
5563
+ is_bridge_error: { type: 'boolean' },
5564
+ is_connected_account_error: { type: 'boolean' },
5532
5565
  message: { type: 'string' },
5533
5566
  },
5534
- required: [
5535
- 'created_at',
5536
- 'message',
5537
- 'is_connected_account_error',
5538
- 'error_code',
5539
- ],
5567
+ required: ['created_at', 'message', 'error_code'],
5540
5568
  type: 'object',
5541
5569
  },
5542
5570
  {
@@ -5552,18 +5580,31 @@ export default {
5552
5580
  enum: ['invalid_credentials'],
5553
5581
  type: 'string',
5554
5582
  },
5555
- is_connected_account_error: {
5556
- enum: [true],
5557
- 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',
5558
5602
  },
5603
+ is_bridge_error: { type: 'boolean' },
5604
+ is_connected_account_error: { type: 'boolean' },
5559
5605
  message: { type: 'string' },
5560
5606
  },
5561
- required: [
5562
- 'created_at',
5563
- 'message',
5564
- 'is_connected_account_error',
5565
- 'error_code',
5566
- ],
5607
+ required: ['created_at', 'message', 'error_code'],
5567
5608
  type: 'object',
5568
5609
  },
5569
5610
  {
@@ -5579,10 +5620,8 @@ export default {
5579
5620
  enum: ['salto_ks_subscription_limit_exceeded'],
5580
5621
  type: 'string',
5581
5622
  },
5582
- is_connected_account_error: {
5583
- enum: [true],
5584
- type: 'boolean',
5585
- },
5623
+ is_bridge_error: { type: 'boolean' },
5624
+ is_connected_account_error: { type: 'boolean' },
5586
5625
  message: { type: 'string' },
5587
5626
  salto_ks_metadata: {
5588
5627
  properties: {
@@ -5618,7 +5657,6 @@ export default {
5618
5657
  required: [
5619
5658
  'created_at',
5620
5659
  'message',
5621
- 'is_connected_account_error',
5622
5660
  'error_code',
5623
5661
  'salto_ks_metadata',
5624
5662
  ],
@@ -6144,18 +6182,31 @@ export default {
6144
6182
  enum: ['invalid_credentials'],
6145
6183
  type: 'string',
6146
6184
  },
6147
- is_connected_account_error: {
6148
- enum: [true],
6149
- 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',
6150
6204
  },
6205
+ is_bridge_error: { type: 'boolean' },
6206
+ is_connected_account_error: { type: 'boolean' },
6151
6207
  message: { type: 'string' },
6152
6208
  },
6153
- required: [
6154
- 'created_at',
6155
- 'message',
6156
- 'is_connected_account_error',
6157
- 'error_code',
6158
- ],
6209
+ required: ['created_at', 'message', 'error_code'],
6159
6210
  type: 'object',
6160
6211
  },
6161
6212
  ],
@@ -12978,18 +13029,31 @@ export default {
12978
13029
  enum: ['invalid_credentials'],
12979
13030
  type: 'string',
12980
13031
  },
12981
- is_connected_account_error: {
12982
- enum: [true],
12983
- 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',
12984
13051
  },
13052
+ is_bridge_error: { type: 'boolean' },
13053
+ is_connected_account_error: { type: 'boolean' },
12985
13054
  message: { type: 'string' },
12986
13055
  },
12987
- required: [
12988
- 'created_at',
12989
- 'message',
12990
- 'is_connected_account_error',
12991
- 'error_code',
12992
- ],
13056
+ required: ['created_at', 'message', 'error_code'],
12993
13057
  type: 'object',
12994
13058
  },
12995
13059
  ],
@@ -14483,18 +14547,31 @@ export default {
14483
14547
  enum: ['invalid_credentials'],
14484
14548
  type: 'string',
14485
14549
  },
14486
- is_connected_account_error: {
14487
- enum: [true],
14488
- 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',
14489
14569
  },
14570
+ is_bridge_error: { type: 'boolean' },
14571
+ is_connected_account_error: { type: 'boolean' },
14490
14572
  message: { type: 'string' },
14491
14573
  },
14492
- required: [
14493
- 'created_at',
14494
- 'message',
14495
- 'is_connected_account_error',
14496
- 'error_code',
14497
- ],
14574
+ required: ['created_at', 'message', 'error_code'],
14498
14575
  type: 'object',
14499
14576
  },
14500
14577
  ],