@seamapi/types 1.321.1 → 1.322.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.
- package/dist/connect.cjs +62 -9
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +475 -305
- package/lib/seam/connect/models/acs/acs-credential.d.ts +12 -12
- package/lib/seam/connect/models/acs/acs-credential.js +2 -0
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-user.d.ts +12 -12
- package/lib/seam/connect/models/acs/acs-user.js +5 -2
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +48 -48
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +20 -20
- package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +28 -28
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +26 -5
- package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +26 -5
- package/lib/seam/connect/models/devices/device.d.ts +34 -7
- package/lib/seam/connect/models/devices/phone.d.ts +26 -5
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +26 -5
- package/lib/seam/connect/models/thermostats/thermostat-schedule.d.ts +18 -3
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +4 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +54 -0
- package/lib/seam/connect/openapi.js +48 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +271 -218
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -0
- package/src/lib/seam/connect/models/acs/acs-user.ts +5 -2
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +6 -1
- package/src/lib/seam/connect/openapi.ts +49 -0
- package/src/lib/seam/connect/route-types.ts +341 -218
package/package.json
CHANGED
|
@@ -195,6 +195,7 @@ const common_acs_credential = z.object({
|
|
|
195
195
|
),
|
|
196
196
|
is_latest_desired_state_synced_with_provider: z
|
|
197
197
|
.boolean()
|
|
198
|
+
.nullable()
|
|
198
199
|
.optional()
|
|
199
200
|
.describe(
|
|
200
201
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
@@ -202,6 +203,7 @@ const common_acs_credential = z.object({
|
|
|
202
203
|
latest_desired_state_synced_with_provider_at: z
|
|
203
204
|
.string()
|
|
204
205
|
.datetime()
|
|
206
|
+
.nullable()
|
|
205
207
|
.optional()
|
|
206
208
|
.describe(
|
|
207
209
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
@@ -215,13 +215,16 @@ const common_acs_user = z
|
|
|
215
215
|
latest_desired_state_synced_with_provider_at: z
|
|
216
216
|
.string()
|
|
217
217
|
.datetime()
|
|
218
|
+
.nullable()
|
|
218
219
|
.optional().describe(`
|
|
219
220
|
---
|
|
220
221
|
undocumented: Only used internally.
|
|
221
222
|
---
|
|
222
223
|
`),
|
|
223
|
-
is_latest_desired_state_synced_with_provider: z
|
|
224
|
-
.
|
|
224
|
+
is_latest_desired_state_synced_with_provider: z
|
|
225
|
+
.boolean()
|
|
226
|
+
.nullable()
|
|
227
|
+
.optional().describe(`
|
|
225
228
|
---
|
|
226
229
|
undocumented: Only used internally.
|
|
227
230
|
---
|
|
@@ -53,7 +53,12 @@ export const thermostat_schedule = z
|
|
|
53
53
|
.datetime()
|
|
54
54
|
.describe('Date and time at which the thermostat schedule was created.'),
|
|
55
55
|
errors: z
|
|
56
|
-
.
|
|
56
|
+
.array(
|
|
57
|
+
z.object({
|
|
58
|
+
error_code: z.string(),
|
|
59
|
+
message: z.string(),
|
|
60
|
+
}),
|
|
61
|
+
)
|
|
57
62
|
.describe(
|
|
58
63
|
'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `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.',
|
|
59
64
|
),
|
|
@@ -377,6 +377,7 @@ export default {
|
|
|
377
377
|
is_latest_desired_state_synced_with_provider: {
|
|
378
378
|
description:
|
|
379
379
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
380
|
+
nullable: true,
|
|
380
381
|
type: 'boolean',
|
|
381
382
|
},
|
|
382
383
|
is_managed: { enum: [true], type: 'boolean' },
|
|
@@ -395,6 +396,7 @@ export default {
|
|
|
395
396
|
description:
|
|
396
397
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
397
398
|
format: 'date-time',
|
|
399
|
+
nullable: true,
|
|
398
400
|
type: 'string',
|
|
399
401
|
},
|
|
400
402
|
parent_acs_credential_id: {
|
|
@@ -1364,6 +1366,7 @@ export default {
|
|
|
1364
1366
|
},
|
|
1365
1367
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
1366
1368
|
is_latest_desired_state_synced_with_provider: {
|
|
1369
|
+
nullable: true,
|
|
1367
1370
|
type: 'boolean',
|
|
1368
1371
|
'x-undocumented': 'Only used internally.',
|
|
1369
1372
|
},
|
|
@@ -1375,6 +1378,7 @@ export default {
|
|
|
1375
1378
|
},
|
|
1376
1379
|
latest_desired_state_synced_with_provider_at: {
|
|
1377
1380
|
format: 'date-time',
|
|
1381
|
+
nullable: true,
|
|
1378
1382
|
type: 'string',
|
|
1379
1383
|
'x-undocumented': 'Only used internally.',
|
|
1380
1384
|
},
|
|
@@ -1828,6 +1832,7 @@ export default {
|
|
|
1828
1832
|
is_latest_desired_state_synced_with_provider: {
|
|
1829
1833
|
description:
|
|
1830
1834
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1835
|
+
nullable: true,
|
|
1831
1836
|
type: 'boolean',
|
|
1832
1837
|
},
|
|
1833
1838
|
is_managed: { enum: [true], type: 'boolean' },
|
|
@@ -1850,6 +1855,7 @@ export default {
|
|
|
1850
1855
|
description:
|
|
1851
1856
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1852
1857
|
format: 'date-time',
|
|
1858
|
+
nullable: true,
|
|
1853
1859
|
type: 'string',
|
|
1854
1860
|
},
|
|
1855
1861
|
parent_acs_credential_id: {
|
|
@@ -2157,6 +2163,7 @@ export default {
|
|
|
2157
2163
|
is_latest_desired_state_synced_with_provider: {
|
|
2158
2164
|
description:
|
|
2159
2165
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
2166
|
+
nullable: true,
|
|
2160
2167
|
type: 'boolean',
|
|
2161
2168
|
},
|
|
2162
2169
|
is_managed: { enum: [false], type: 'boolean' },
|
|
@@ -2179,6 +2186,7 @@ export default {
|
|
|
2179
2186
|
description:
|
|
2180
2187
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
2181
2188
|
format: 'date-time',
|
|
2189
|
+
nullable: true,
|
|
2182
2190
|
type: 'string',
|
|
2183
2191
|
},
|
|
2184
2192
|
parent_acs_credential_id: {
|
|
@@ -2619,6 +2627,7 @@ export default {
|
|
|
2619
2627
|
is_latest_desired_state_synced_with_provider: {
|
|
2620
2628
|
description:
|
|
2621
2629
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
2630
|
+
nullable: true,
|
|
2622
2631
|
type: 'boolean',
|
|
2623
2632
|
},
|
|
2624
2633
|
is_managed: { enum: [true], type: 'boolean' },
|
|
@@ -2641,6 +2650,7 @@ export default {
|
|
|
2641
2650
|
description:
|
|
2642
2651
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
2643
2652
|
format: 'date-time',
|
|
2653
|
+
nullable: true,
|
|
2644
2654
|
type: 'string',
|
|
2645
2655
|
},
|
|
2646
2656
|
parent_acs_credential_id: {
|
|
@@ -2945,6 +2955,7 @@ export default {
|
|
|
2945
2955
|
is_latest_desired_state_synced_with_provider: {
|
|
2946
2956
|
description:
|
|
2947
2957
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
2958
|
+
nullable: true,
|
|
2948
2959
|
type: 'boolean',
|
|
2949
2960
|
},
|
|
2950
2961
|
is_managed: { enum: [false], type: 'boolean' },
|
|
@@ -2967,6 +2978,7 @@ export default {
|
|
|
2967
2978
|
description:
|
|
2968
2979
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
2969
2980
|
format: 'date-time',
|
|
2981
|
+
nullable: true,
|
|
2970
2982
|
type: 'string',
|
|
2971
2983
|
},
|
|
2972
2984
|
parent_acs_credential_id: {
|
|
@@ -5307,6 +5319,15 @@ export default {
|
|
|
5307
5319
|
errors: {
|
|
5308
5320
|
description:
|
|
5309
5321
|
'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `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.',
|
|
5322
|
+
items: {
|
|
5323
|
+
properties: {
|
|
5324
|
+
error_code: { type: 'string' },
|
|
5325
|
+
message: { type: 'string' },
|
|
5326
|
+
},
|
|
5327
|
+
required: ['error_code', 'message'],
|
|
5328
|
+
type: 'object',
|
|
5329
|
+
},
|
|
5330
|
+
type: 'array',
|
|
5310
5331
|
},
|
|
5311
5332
|
max_override_period_minutes: {
|
|
5312
5333
|
description:
|
|
@@ -5345,6 +5366,7 @@ export default {
|
|
|
5345
5366
|
'starts_at',
|
|
5346
5367
|
'ends_at',
|
|
5347
5368
|
'created_at',
|
|
5369
|
+
'errors',
|
|
5348
5370
|
],
|
|
5349
5371
|
type: 'object',
|
|
5350
5372
|
},
|
|
@@ -10149,6 +10171,15 @@ export default {
|
|
|
10149
10171
|
errors: {
|
|
10150
10172
|
description:
|
|
10151
10173
|
'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `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.',
|
|
10174
|
+
items: {
|
|
10175
|
+
properties: {
|
|
10176
|
+
error_code: { type: 'string' },
|
|
10177
|
+
message: { type: 'string' },
|
|
10178
|
+
},
|
|
10179
|
+
required: ['error_code', 'message'],
|
|
10180
|
+
type: 'object',
|
|
10181
|
+
},
|
|
10182
|
+
type: 'array',
|
|
10152
10183
|
},
|
|
10153
10184
|
max_override_period_minutes: {
|
|
10154
10185
|
description:
|
|
@@ -10187,6 +10218,7 @@ export default {
|
|
|
10187
10218
|
'starts_at',
|
|
10188
10219
|
'ends_at',
|
|
10189
10220
|
'created_at',
|
|
10221
|
+
'errors',
|
|
10190
10222
|
],
|
|
10191
10223
|
type: 'object',
|
|
10192
10224
|
},
|
|
@@ -13070,6 +13102,15 @@ export default {
|
|
|
13070
13102
|
'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
13071
13103
|
type: 'boolean',
|
|
13072
13104
|
},
|
|
13105
|
+
salto_space_metadata: {
|
|
13106
|
+
description:
|
|
13107
|
+
'Salto Space-specific metadata for the new credential.',
|
|
13108
|
+
properties: {
|
|
13109
|
+
assign_new_key: { type: 'boolean' },
|
|
13110
|
+
update_current_key: { type: 'boolean' },
|
|
13111
|
+
},
|
|
13112
|
+
type: 'object',
|
|
13113
|
+
},
|
|
13073
13114
|
starts_at: {
|
|
13074
13115
|
description:
|
|
13075
13116
|
'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -13772,6 +13813,7 @@ export default {
|
|
|
13772
13813
|
is_latest_desired_state_synced_with_provider: {
|
|
13773
13814
|
description:
|
|
13774
13815
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
13816
|
+
nullable: true,
|
|
13775
13817
|
type: 'boolean',
|
|
13776
13818
|
},
|
|
13777
13819
|
is_managed: { enum: [false], type: 'boolean' },
|
|
@@ -13794,6 +13836,7 @@ export default {
|
|
|
13794
13836
|
description:
|
|
13795
13837
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
13796
13838
|
format: 'date-time',
|
|
13839
|
+
nullable: true,
|
|
13797
13840
|
type: 'string',
|
|
13798
13841
|
},
|
|
13799
13842
|
parent_acs_credential_id: {
|
|
@@ -14202,6 +14245,7 @@ export default {
|
|
|
14202
14245
|
is_latest_desired_state_synced_with_provider: {
|
|
14203
14246
|
description:
|
|
14204
14247
|
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
14248
|
+
nullable: true,
|
|
14205
14249
|
type: 'boolean',
|
|
14206
14250
|
},
|
|
14207
14251
|
is_managed: { enum: [false], type: 'boolean' },
|
|
@@ -14224,6 +14268,7 @@ export default {
|
|
|
14224
14268
|
description:
|
|
14225
14269
|
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
14226
14270
|
format: 'date-time',
|
|
14271
|
+
nullable: true,
|
|
14227
14272
|
type: 'string',
|
|
14228
14273
|
},
|
|
14229
14274
|
parent_acs_credential_id: {
|
|
@@ -16391,6 +16436,7 @@ export default {
|
|
|
16391
16436
|
},
|
|
16392
16437
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
16393
16438
|
is_latest_desired_state_synced_with_provider: {
|
|
16439
|
+
nullable: true,
|
|
16394
16440
|
type: 'boolean',
|
|
16395
16441
|
'x-undocumented': 'Only used internally.',
|
|
16396
16442
|
},
|
|
@@ -16402,6 +16448,7 @@ export default {
|
|
|
16402
16448
|
},
|
|
16403
16449
|
latest_desired_state_synced_with_provider_at: {
|
|
16404
16450
|
format: 'date-time',
|
|
16451
|
+
nullable: true,
|
|
16405
16452
|
type: 'string',
|
|
16406
16453
|
'x-undocumented': 'Only used internally.',
|
|
16407
16454
|
},
|
|
@@ -16786,6 +16833,7 @@ export default {
|
|
|
16786
16833
|
},
|
|
16787
16834
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
16788
16835
|
is_latest_desired_state_synced_with_provider: {
|
|
16836
|
+
nullable: true,
|
|
16789
16837
|
type: 'boolean',
|
|
16790
16838
|
'x-undocumented': 'Only used internally.',
|
|
16791
16839
|
},
|
|
@@ -16797,6 +16845,7 @@ export default {
|
|
|
16797
16845
|
},
|
|
16798
16846
|
latest_desired_state_synced_with_provider_at: {
|
|
16799
16847
|
format: 'date-time',
|
|
16848
|
+
nullable: true,
|
|
16800
16849
|
type: 'string',
|
|
16801
16850
|
'x-undocumented': 'Only used internally.',
|
|
16802
16851
|
},
|