@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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.373.3",
3
+ "version": "1.375.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/acs/acs-system.ts CHANGED
@@ -79,7 +79,14 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
79
79
  })
80
80
  .describe(`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.
81
81
  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
82
- 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).`)
82
+ 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).`)
83
+
84
+ const bridge_disconnected = common_acs_system_error.extend({
85
+ error_code: z.literal('bridge_disconnected').describe(error_code_description),
86
+ is_bridge_error: z.boolean().optional(),
87
+ })
88
+ .describe(`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.
89
+ 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).`)
83
90
 
84
91
  const visionline_instance_unreachable = common_acs_system_error.extend({
85
92
  error_code: z
@@ -132,6 +139,7 @@ const salto_ks_certification_expired = common_acs_system_error
132
139
  const acs_system_error = z
133
140
  .discriminatedUnion('error_code', [
134
141
  seam_bridge_disconnected,
142
+ bridge_disconnected,
135
143
  visionline_instance_unreachable,
136
144
  salto_ks_subscription_limit_exceeded,
137
145
  acs_system_disconnected,
@@ -144,6 +152,7 @@ const acs_system_error = z
144
152
 
145
153
  export const acs_system_error_map = z.object({
146
154
  seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
155
+ bridge_disconnected: bridge_disconnected.optional().nullable(),
147
156
  visionline_instance_unreachable: visionline_instance_unreachable
148
157
  .optional()
149
158
  .nullable(),
@@ -236,6 +245,8 @@ export const acs_system = z
236
245
  .describe(
237
246
  'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
238
247
  ),
248
+ acs_users_count: z.number().optional(),
249
+ acs_access_group_count: z.number().optional(),
239
250
  external_type: acs_system_external_type
240
251
  .describe(
241
252
  'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
package/src/lib/seam/connect/models/connected-accounts/connected-account.ts CHANGED
@@ -8,7 +8,8 @@ const common_connected_account_error = z.object({
8
8
  .datetime()
9
9
  .describe('Date and time at which Seam created the error.'),
10
10
  message: z.string(),
11
- is_connected_account_error: z.literal(true),
11
+ is_connected_account_error: z.boolean().optional(),
12
+ is_bridge_error: z.boolean().optional(),
12
13
  })
13
14
 
14
15
  const error_code_description =
@@ -41,6 +42,12 @@ export const invalid_credentials = common_connected_account_error
41
42
  })
42
43
  .describe('Credentials provided were invalid.')
43
44
 
45
+ export const bridge_disconnected = common_connected_account_error.extend({
46
+ error_code: z.literal('bridge_disconnected').describe(error_code_description),
47
+ })
48
+ .describe(`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.
49
+ 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).`)
50
+
44
51
  export const salto_ks_subscription_limit_exceeded =
45
52
  common_connected_account_error
46
53
  .extend({
@@ -65,12 +72,14 @@ export const salto_ks_subscription_limit_exceeded =
65
72
  export const connected_account_error = z.discriminatedUnion('error_code', [
66
73
  account_disconnected,
67
74
  invalid_credentials,
75
+ bridge_disconnected,
68
76
  salto_ks_subscription_limit_exceeded,
69
77
  ])
70
78
 
71
79
  const connected_account_error_map = z.object({
72
80
  account_disconnected: account_disconnected.nullable().optional(),
73
81
  invalid_credentials: invalid_credentials.nullable().optional(),
82
+ bridge_disconnected: bridge_disconnected.nullable().optional(),
74
83
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded
75
84
  .nullable()
76
85
  .optional(),
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -737,18 +737,34 @@ export default {
737
737
  enum: ['invalid_credentials'],
738
738
  type: 'string',
739
739
  },
740
- is_connected_account_error: {
741
- enum: [true],
742
- type: 'boolean',
740
+ is_bridge_error: { type: 'boolean' },
741
+ is_connected_account_error: { type: 'boolean' },
742
+ message: { type: 'string' },
743
+ },
744
+ required: ['created_at', 'message', 'error_code'],
745
+ type: 'object',
746
+ },
747
+ {
748
+ description:
749
+ '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).',
750
+ properties: {
751
+ created_at: {
752
+ description:
753
+ 'Date and time at which Seam created the error.',
754
+ format: 'date-time',
755
+ type: 'string',
743
756
  },
757
+ error_code: {
758
+ description:
759
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
760
+ enum: ['bridge_disconnected'],
761
+ type: 'string',
762
+ },
763
+ is_bridge_error: { type: 'boolean' },
764
+ is_connected_account_error: { type: 'boolean' },
744
765
  message: { type: 'string' },
745
766
  },
746
- required: [
747
- 'created_at',
748
- 'message',
749
- 'is_connected_account_error',
750
- 'error_code',
751
- ],
767
+ required: ['created_at', 'message', 'error_code'],
752
768
  type: 'object',
753
769
  },
754
770
  ],
@@ -1802,12 +1818,14 @@ export default {
1802
1818
  description:
1803
1819
  '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).',
1804
1820
  properties: {
1821
+ acs_access_group_count: { format: 'float', type: 'number' },
1805
1822
  acs_system_id: {
1806
1823
  description:
1807
1824
  'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1808
1825
  format: 'uuid',
1809
1826
  type: 'string',
1810
1827
  },
1828
+ acs_users_count: { format: 'float', type: 'number' },
1811
1829
  can_add_acs_users_to_acs_access_groups: {
1812
1830
  description:
1813
1831
  '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).',
@@ -1865,7 +1883,7 @@ export default {
1865
1883
  oneOf: [
1866
1884
  {
1867
1885
  description:
1868
- '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).',
1886
+ '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).',
1869
1887
  properties: {
1870
1888
  created_at: {
1871
1889
  description:
@@ -1888,6 +1906,32 @@ export default {
1888
1906
  required: ['created_at', 'message', 'error_code'],
1889
1907
  type: 'object',
1890
1908
  },
1909
+ {
1910
+ description:
1911
+ '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).',
1912
+ properties: {
1913
+ created_at: {
1914
+ description:
1915
+ 'Date and time at which Seam created the error.',
1916
+ format: 'date-time',
1917
+ type: 'string',
1918
+ },
1919
+ error_code: {
1920
+ description:
1921
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
1922
+ enum: ['bridge_disconnected'],
1923
+ type: 'string',
1924
+ },
1925
+ is_bridge_error: { type: 'boolean' },
1926
+ message: {
1927
+ description:
1928
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
1929
+ type: 'string',
1930
+ },
1931
+ },
1932
+ required: ['created_at', 'message', 'error_code'],
1933
+ type: 'object',
1934
+ },
1891
1935
  {
1892
1936
  description:
1893
1937
  '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).',
@@ -6091,18 +6135,11 @@ export default {
6091
6135
  enum: ['account_disconnected'],
6092
6136
  type: 'string',
6093
6137
  },
6094
- is_connected_account_error: {
6095
- enum: [true],
6096
- type: 'boolean',
6097
- },
6138
+ is_bridge_error: { type: 'boolean' },
6139
+ is_connected_account_error: { type: 'boolean' },
6098
6140
  message: { type: 'string' },
6099
6141
  },
6100
- required: [
6101
- 'created_at',
6102
- 'message',
6103
- 'is_connected_account_error',
6104
- 'error_code',
6105
- ],
6142
+ required: ['created_at', 'message', 'error_code'],
6106
6143
  type: 'object',
6107
6144
  },
6108
6145
  {
@@ -6120,18 +6157,34 @@ export default {
6120
6157
  enum: ['invalid_credentials'],
6121
6158
  type: 'string',
6122
6159
  },
6123
- is_connected_account_error: {
6124
- enum: [true],
6125
- type: 'boolean',
6160
+ is_bridge_error: { type: 'boolean' },
6161
+ is_connected_account_error: { type: 'boolean' },
6162
+ message: { type: 'string' },
6163
+ },
6164
+ required: ['created_at', 'message', 'error_code'],
6165
+ type: 'object',
6166
+ },
6167
+ {
6168
+ description:
6169
+ '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).',
6170
+ properties: {
6171
+ created_at: {
6172
+ description:
6173
+ 'Date and time at which Seam created the error.',
6174
+ format: 'date-time',
6175
+ type: 'string',
6176
+ },
6177
+ error_code: {
6178
+ description:
6179
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
6180
+ enum: ['bridge_disconnected'],
6181
+ type: 'string',
6126
6182
  },
6183
+ is_bridge_error: { type: 'boolean' },
6184
+ is_connected_account_error: { type: 'boolean' },
6127
6185
  message: { type: 'string' },
6128
6186
  },
6129
- required: [
6130
- 'created_at',
6131
- 'message',
6132
- 'is_connected_account_error',
6133
- 'error_code',
6134
- ],
6187
+ required: ['created_at', 'message', 'error_code'],
6135
6188
  type: 'object',
6136
6189
  },
6137
6190
  {
@@ -6150,10 +6203,8 @@ export default {
6150
6203
  enum: ['salto_ks_subscription_limit_exceeded'],
6151
6204
  type: 'string',
6152
6205
  },
6153
- is_connected_account_error: {
6154
- enum: [true],
6155
- type: 'boolean',
6156
- },
6206
+ is_bridge_error: { type: 'boolean' },
6207
+ is_connected_account_error: { type: 'boolean' },
6157
6208
  message: { type: 'string' },
6158
6209
  salto_ks_metadata: {
6159
6210
  properties: {
@@ -6189,7 +6240,6 @@ export default {
6189
6240
  required: [
6190
6241
  'created_at',
6191
6242
  'message',
6192
- 'is_connected_account_error',
6193
6243
  'error_code',
6194
6244
  'salto_ks_metadata',
6195
6245
  ],
@@ -6743,18 +6793,34 @@ export default {
6743
6793
  enum: ['invalid_credentials'],
6744
6794
  type: 'string',
6745
6795
  },
6746
- is_connected_account_error: {
6747
- enum: [true],
6748
- type: 'boolean',
6796
+ is_bridge_error: { type: 'boolean' },
6797
+ is_connected_account_error: { type: 'boolean' },
6798
+ message: { type: 'string' },
6799
+ },
6800
+ required: ['created_at', 'message', 'error_code'],
6801
+ type: 'object',
6802
+ },
6803
+ {
6804
+ description:
6805
+ '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).',
6806
+ properties: {
6807
+ created_at: {
6808
+ description:
6809
+ 'Date and time at which Seam created the error.',
6810
+ format: 'date-time',
6811
+ type: 'string',
6749
6812
  },
6813
+ error_code: {
6814
+ description:
6815
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
6816
+ enum: ['bridge_disconnected'],
6817
+ type: 'string',
6818
+ },
6819
+ is_bridge_error: { type: 'boolean' },
6820
+ is_connected_account_error: { type: 'boolean' },
6750
6821
  message: { type: 'string' },
6751
6822
  },
6752
- required: [
6753
- 'created_at',
6754
- 'message',
6755
- 'is_connected_account_error',
6756
- 'error_code',
6757
- ],
6823
+ required: ['created_at', 'message', 'error_code'],
6758
6824
  type: 'object',
6759
6825
  },
6760
6826
  ],
@@ -14096,18 +14162,34 @@ export default {
14096
14162
  enum: ['invalid_credentials'],
14097
14163
  type: 'string',
14098
14164
  },
14099
- is_connected_account_error: {
14100
- enum: [true],
14101
- type: 'boolean',
14165
+ is_bridge_error: { type: 'boolean' },
14166
+ is_connected_account_error: { type: 'boolean' },
14167
+ message: { type: 'string' },
14168
+ },
14169
+ required: ['created_at', 'message', 'error_code'],
14170
+ type: 'object',
14171
+ },
14172
+ {
14173
+ description:
14174
+ '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).',
14175
+ properties: {
14176
+ created_at: {
14177
+ description:
14178
+ 'Date and time at which Seam created the error.',
14179
+ format: 'date-time',
14180
+ type: 'string',
14102
14181
  },
14182
+ error_code: {
14183
+ description:
14184
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14185
+ enum: ['bridge_disconnected'],
14186
+ type: 'string',
14187
+ },
14188
+ is_bridge_error: { type: 'boolean' },
14189
+ is_connected_account_error: { type: 'boolean' },
14103
14190
  message: { type: 'string' },
14104
14191
  },
14105
- required: [
14106
- 'created_at',
14107
- 'message',
14108
- 'is_connected_account_error',
14109
- 'error_code',
14110
- ],
14192
+ required: ['created_at', 'message', 'error_code'],
14111
14193
  type: 'object',
14112
14194
  },
14113
14195
  ],
@@ -15750,18 +15832,34 @@ export default {
15750
15832
  enum: ['invalid_credentials'],
15751
15833
  type: 'string',
15752
15834
  },
15753
- is_connected_account_error: {
15754
- enum: [true],
15755
- type: 'boolean',
15835
+ is_bridge_error: { type: 'boolean' },
15836
+ is_connected_account_error: { type: 'boolean' },
15837
+ message: { type: 'string' },
15838
+ },
15839
+ required: ['created_at', 'message', 'error_code'],
15840
+ type: 'object',
15841
+ },
15842
+ {
15843
+ description:
15844
+ '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).',
15845
+ properties: {
15846
+ created_at: {
15847
+ description:
15848
+ 'Date and time at which Seam created the error.',
15849
+ format: 'date-time',
15850
+ type: 'string',
15851
+ },
15852
+ error_code: {
15853
+ description:
15854
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
15855
+ enum: ['bridge_disconnected'],
15856
+ type: 'string',
15756
15857
  },
15858
+ is_bridge_error: { type: 'boolean' },
15859
+ is_connected_account_error: { type: 'boolean' },
15757
15860
  message: { type: 'string' },
15758
15861
  },
15759
- required: [
15760
- 'created_at',
15761
- 'message',
15762
- 'is_connected_account_error',
15763
- 'error_code',
15764
- ],
15862
+ required: ['created_at', 'message', 'error_code'],
15765
15863
  type: 'object',
15766
15864
  },
15767
15865
  ],