nuki-api-js 1.1.1 → 1.2.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.
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +9475 -9462
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/{schemas-ihzqrsub.cjs → schemas-fong721w.cjs} +277 -276
- package/dist/{schemas-e6jr28te.js → schemas-geox71wk.js} +277 -276
- package/dist/schemas.cjs +1 -1
- package/dist/schemas.d.mts +9360 -9354
- package/dist/schemas.d.mts.map +1 -1
- package/dist/schemas.mjs +1 -1
- package/dist/types.d.mts +77 -70
- package/dist/types.d.mts.map +1 -1
- package/package.json +5 -5
|
@@ -29,13 +29,13 @@ const termsOfUseSchema = z.object({
|
|
|
29
29
|
acceptanceDate: z.iso.datetime().optional()
|
|
30
30
|
});
|
|
31
31
|
const accountSchema = z.object({
|
|
32
|
-
accountId: z.
|
|
33
|
-
type: z.
|
|
32
|
+
accountId: z.int32().describe("The account id"),
|
|
33
|
+
type: z.int32().describe("The type: 0 .. user, 1 .. company, 2 .. caretaker"),
|
|
34
34
|
email: z.string().describe("The email address"),
|
|
35
35
|
emailVerified: z.boolean().optional().describe("true, if the email is verified"),
|
|
36
36
|
name: z.string().describe("The name"),
|
|
37
|
-
masterAccountId: z.
|
|
38
|
-
rights: z.
|
|
37
|
+
masterAccountId: z.int32().optional().describe("The master account id if it's a sub account"),
|
|
38
|
+
rights: z.int32().optional().describe("The rights bitmask if it's a sub account: 1 .. manage smartlock, 2 .. operate smartlock, 4 .. manage smartlock config, 8 .. manage smartlock authorizations, 16 .. view smartlock logs, 32 .. manage sub accounts, 64 .. create smartlocks"),
|
|
39
39
|
language: z.string().optional().describe("The language code").meta({
|
|
40
40
|
examples: [
|
|
41
41
|
"de"
|
|
@@ -65,7 +65,7 @@ const accountIntegrationSchema = z.object({
|
|
|
65
65
|
]).describe("If the integration/device is an legacy or from the new oauth implementation"),
|
|
66
66
|
vendorKey: z.string().describe("Enum key identifying the integration/device, values are e.g. ALEXA, IOS, NUKI_WEB, API_TOKEN etc"),
|
|
67
67
|
subAccountName: z.string().optional().describe("Name of the sub-account or null if there is none, which is associated with this token"),
|
|
68
|
-
subAccountId: z.
|
|
68
|
+
subAccountId: z.int32().optional().describe("Id of the sub-account or null if there is none, which is associated with this token"),
|
|
69
69
|
subAccount: z.boolean().optional().describe("True if the integration is done via a sub-account"),
|
|
70
70
|
name: z.string().describe("Name of the token"),
|
|
71
71
|
description: z.string().optional().describe("Description given by the user, usually only set for api tokens"),
|
|
@@ -77,7 +77,7 @@ const accountIntegrationSchema = z.object({
|
|
|
77
77
|
advancedType: z.string().optional().describe("The enum advanced type (HEALTHCARE e.g.) if this integration is a advanced one"),
|
|
78
78
|
advancedState: z.string().optional().describe("The enum advanced state (TESTING e.g.) if this integration is a advanced one"),
|
|
79
79
|
clientId: z.string().describe("The clientId of this integration/device used for deleting the integration"),
|
|
80
|
-
sortOrder: z.
|
|
80
|
+
sortOrder: z.int32().optional().describe("Sort order by which the entry should be sorted, is being set by the vendor key enum"),
|
|
81
81
|
device: z.boolean().optional().describe("True this is a device and false this is an integration")
|
|
82
82
|
});
|
|
83
83
|
const accountOtpEnableSchema = z.object({
|
|
@@ -123,7 +123,7 @@ const accountSubCreateSchema = z.object({
|
|
|
123
123
|
}),
|
|
124
124
|
password: z.string().describe("The password (must be at least 7 chars long)"),
|
|
125
125
|
name: z.string().describe("The name of the sub account"),
|
|
126
|
-
rights: z.
|
|
126
|
+
rights: z.int32().describe("The right bitmask of the sub account: 1 .. operate smartlock, 2 .. change smartlock config, 4 .. manage smartlock users, 8 .. view smartlock logs, 16 .. manage sub accounts"),
|
|
127
127
|
language: z.string().describe("The language code").meta({
|
|
128
128
|
examples: [
|
|
129
129
|
"de"
|
|
@@ -139,7 +139,7 @@ const accountSubUpdateSchema = z.object({
|
|
|
139
139
|
}),
|
|
140
140
|
password: z.string().optional().describe("The new password (must be at least 7 chars long)"),
|
|
141
141
|
name: z.string().optional().describe("The new name of the sub account"),
|
|
142
|
-
rights: z.
|
|
142
|
+
rights: z.int32().optional().describe("The new right bitmask of the sub account: 1 .. operate smartlock, 2 .. change smartlock config, 4 .. manage smartlock users, 8 .. view smartlock logs, 16 .. manage sub accounts, 32 .. manage sub accounts, 64 .. create smartlocks"),
|
|
143
143
|
language: z.string().describe("The language code").meta({
|
|
144
144
|
examples: [
|
|
145
145
|
"de"
|
|
@@ -165,9 +165,9 @@ const accountUpdateSchema = z.object({
|
|
|
165
165
|
profile: accountProfileSchema.optional().describe("The optional profile")
|
|
166
166
|
});
|
|
167
167
|
const accountUserSchema = z.object({
|
|
168
|
-
accountUserId: z.
|
|
169
|
-
accountId: z.
|
|
170
|
-
type: z.
|
|
168
|
+
accountUserId: z.int32().describe("The account user id"),
|
|
169
|
+
accountId: z.int32().describe("The account id"),
|
|
170
|
+
type: z.int32().optional().describe("The optional type: 0 .. user, 1 .. company"),
|
|
171
171
|
email: z.string().describe("The email address"),
|
|
172
172
|
name: z.string().describe("The name"),
|
|
173
173
|
language: z.string().optional().describe("The language code").meta({
|
|
@@ -180,7 +180,7 @@ const accountUserSchema = z.object({
|
|
|
180
180
|
updateDate: z.iso.datetime().describe("The update date")
|
|
181
181
|
});
|
|
182
182
|
const accountUserCreateSchema = z.object({
|
|
183
|
-
type: z.
|
|
183
|
+
type: z.int32().optional().describe("The optional type - only allowed for caretakers: 0 .. user, 1 .. company"),
|
|
184
184
|
email: z.string().describe("The email address"),
|
|
185
185
|
name: z.string().describe("The name"),
|
|
186
186
|
language: z.enum([
|
|
@@ -213,8 +213,8 @@ const accountUserUpdateSchema = z.object({
|
|
|
213
213
|
]).optional().describe("The new language code")
|
|
214
214
|
});
|
|
215
215
|
const addressSchema = z.object({
|
|
216
|
-
addressId: z.
|
|
217
|
-
accountId: z.
|
|
216
|
+
addressId: z.int32().describe("The address id"),
|
|
217
|
+
accountId: z.int32().describe("The account id"),
|
|
218
218
|
name: z.string().describe("The name of the address"),
|
|
219
219
|
smartlockIds: z.array(z.coerce.bigint()).describe("The smartlocks for this address"),
|
|
220
220
|
serviceId: z.enum([
|
|
@@ -222,8 +222,8 @@ const addressSchema = z.object({
|
|
|
222
222
|
"bookingsync"
|
|
223
223
|
]).optional().describe("The optional service id if the address is from an partner service"),
|
|
224
224
|
timeZone: z.string().optional().describe("The timezone"),
|
|
225
|
-
checkInTime: z.
|
|
226
|
-
checkOutTime: z.
|
|
225
|
+
checkInTime: z.int32().optional().describe("The optional check in time (minutes of the day)"),
|
|
226
|
+
checkOutTime: z.int32().optional().describe("The optional check out time (minutes of the day)"),
|
|
227
227
|
settings: z.object({}).catchall(z.object({})).optional().describe("The optional settings object"),
|
|
228
228
|
creationDate: z.iso.datetime().describe("The creation date"),
|
|
229
229
|
updateDate: z.iso.datetime().describe("The update date")
|
|
@@ -234,12 +234,12 @@ const addressCreateSchema = z.object({
|
|
|
234
234
|
});
|
|
235
235
|
const addressReservationSchema = z.object({
|
|
236
236
|
id: z.string().describe("The id"),
|
|
237
|
-
addressId: z.
|
|
238
|
-
accountId: z.
|
|
237
|
+
addressId: z.int32().describe("The address id"),
|
|
238
|
+
accountId: z.int32().describe("The account id"),
|
|
239
239
|
email: z.string().describe("The email of the guest"),
|
|
240
240
|
name: z.string().describe("The name of the guest"),
|
|
241
|
-
guests: z.
|
|
242
|
-
guestsIssued: z.
|
|
241
|
+
guests: z.int32().describe("The number of guests"),
|
|
242
|
+
guestsIssued: z.int32().describe("The number of guests issued"),
|
|
243
243
|
keypadIssued: z.boolean().describe("True if a keypad authorization was issued"),
|
|
244
244
|
state: z.enum([
|
|
245
245
|
"canceled",
|
|
@@ -250,7 +250,7 @@ const addressReservationSchema = z.object({
|
|
|
250
250
|
"bookingsync"
|
|
251
251
|
]).optional().describe("The optional service id if the address is from an partner service"),
|
|
252
252
|
reference: z.string().optional().describe("The reference (booking code)"),
|
|
253
|
-
automation: z.
|
|
253
|
+
automation: z.int32().describe("The automation state"),
|
|
254
254
|
checkedIn: z.boolean().optional().describe("True if the user has checked in, false if the check in is pending, null if it isn't monitored"),
|
|
255
255
|
startDate: z.iso.datetime().describe("The start date"),
|
|
256
256
|
endDate: z.iso.datetime().describe("The end date"),
|
|
@@ -263,10 +263,10 @@ const addressReservationSchema = z.object({
|
|
|
263
263
|
});
|
|
264
264
|
const addressTokenSchema = z.object({
|
|
265
265
|
id: z.string().describe("The id"),
|
|
266
|
-
addressId: z.
|
|
266
|
+
addressId: z.int32().describe("The address id"),
|
|
267
267
|
creationDate: z.iso.datetime().describe("The creation date"),
|
|
268
268
|
redeemDate: z.iso.datetime().describe("The redeem date"),
|
|
269
|
-
redeemAccountId: z.
|
|
269
|
+
redeemAccountId: z.int32().describe("The redeem account id"),
|
|
270
270
|
inviteKeys: z.array(z.string()).optional().describe("The list of invite keys"),
|
|
271
271
|
redeemResult: z.enum([
|
|
272
272
|
"ok",
|
|
@@ -281,14 +281,14 @@ const addressTokenInfoSchema = z.object({
|
|
|
281
281
|
const addressUnitSchema = z.object({
|
|
282
282
|
id: z.string().optional().describe("The id"),
|
|
283
283
|
name: z.string().describe("The name of the address unit"),
|
|
284
|
-
addressId: z.
|
|
284
|
+
addressId: z.int32().optional().describe("The address id"),
|
|
285
285
|
addressTokenId: z.string().optional().describe("The address token id"),
|
|
286
286
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation")
|
|
287
287
|
});
|
|
288
288
|
const addressUnitResponseSchema = z.object({
|
|
289
289
|
id: z.string().optional().describe("The id"),
|
|
290
290
|
name: z.string().describe("The name of the address unit"),
|
|
291
|
-
addressId: z.
|
|
291
|
+
addressId: z.int32().optional().describe("The address id"),
|
|
292
292
|
addressTokenId: z.string().optional().describe("The address token id"),
|
|
293
293
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation"),
|
|
294
294
|
creationDate: z.iso.datetime().describe("The creation date"),
|
|
@@ -304,7 +304,7 @@ const addressUpdateSchema = z.object({
|
|
|
304
304
|
settings: z.object({}).catchall(z.object({})).optional().describe("The optional settings")
|
|
305
305
|
});
|
|
306
306
|
const advancedApiKeySchema = z.object({
|
|
307
|
-
name: z.string().describe("The name of the company for which you apply for access"),
|
|
307
|
+
name: z.string().describe("The name of the company for which you apply for access. Only the first 17 characters of your integration's name will be visible in the device's activity log."),
|
|
308
308
|
country: z.string().describe("The country of the headquarter or the country where you are mainly doing business in"),
|
|
309
309
|
description: z.string().describe("Describe the services and/or products you offer to your customers and how your customers would use Nuki devices in their processes"),
|
|
310
310
|
type: z.enum([
|
|
@@ -343,7 +343,7 @@ const advancedApiKeySchema = z.object({
|
|
|
343
343
|
updateDate: z.iso.datetime().describe("The update date")
|
|
344
344
|
});
|
|
345
345
|
const advancedApiKeyCreateSchema = z.object({
|
|
346
|
-
name: z.string().describe("The name of the company for which you apply for access"),
|
|
346
|
+
name: z.string().describe("The name of the company for which you apply for access. Only the first 17 characters of your integration's name will be visible in the device's activity log."),
|
|
347
347
|
country: z.string().describe("The country of the headquarter or the country where you are mainly doing business in"),
|
|
348
348
|
description: z.string().describe("Describe the services and/or products you offer to your customers and how your customers would use Nuki devices in their processes"),
|
|
349
349
|
type: z.enum([
|
|
@@ -390,8 +390,8 @@ const advancedConfirmationResponseSchema = z.object({
|
|
|
390
390
|
error: z.string().optional().describe("Contains error message and smartlock IDs, if auths can not be created because they need subscription.")
|
|
391
391
|
});
|
|
392
392
|
const apiKeySchema = z.object({
|
|
393
|
-
apiKeyId: z.
|
|
394
|
-
accountId: z.
|
|
393
|
+
apiKeyId: z.int32().describe("The id"),
|
|
394
|
+
accountId: z.int32().describe("The account id"),
|
|
395
395
|
description: z.string().optional().describe("The description"),
|
|
396
396
|
redirectUris: z.array(z.string()).optional().describe("The redirect uris"),
|
|
397
397
|
creationDate: z.iso.datetime().describe("The creation date"),
|
|
@@ -421,8 +421,8 @@ const apiKeyAdvancedSchema = z.object({
|
|
|
421
421
|
message: "Array entries must be unique"
|
|
422
422
|
}).optional(),
|
|
423
423
|
webhookUrl: z.string().optional(),
|
|
424
|
-
webhookSentSuccessfully: z.
|
|
425
|
-
webhookSentErroneous: z.
|
|
424
|
+
webhookSentSuccessfully: z.int32().optional(),
|
|
425
|
+
webhookSentErroneous: z.int32().optional(),
|
|
426
426
|
lastSuccessfulPost: z.iso.datetime().optional(),
|
|
427
427
|
lastPostDuration: z.coerce.bigint().optional(),
|
|
428
428
|
lastPostSuccesful: z.boolean().optional(),
|
|
@@ -446,7 +446,7 @@ const apiKeyCreateSchema = z.object({
|
|
|
446
446
|
});
|
|
447
447
|
const completableFutureListApiKeySchema = z.object({
|
|
448
448
|
completedExceptionally: z.boolean().optional(),
|
|
449
|
-
numberOfDependents: z.
|
|
449
|
+
numberOfDependents: z.int32().optional(),
|
|
450
450
|
done: z.boolean().optional(),
|
|
451
451
|
cancelled: z.boolean().optional()
|
|
452
452
|
});
|
|
@@ -455,7 +455,7 @@ const apiKeyServiceSchema = z.object({
|
|
|
455
455
|
});
|
|
456
456
|
const apiKeyTokenSchema = z.object({
|
|
457
457
|
id: z.string().describe("The id"),
|
|
458
|
-
accountId: z.
|
|
458
|
+
accountId: z.int32().describe("The account id"),
|
|
459
459
|
description: z.string().optional().describe("The description"),
|
|
460
460
|
accessToken: z.string().optional().describe("The access token"),
|
|
461
461
|
scopes: z.array(z.string()).describe("The list of scopes"),
|
|
@@ -540,10 +540,10 @@ const restletSchema = z.object({
|
|
|
540
540
|
get logger () {
|
|
541
541
|
return loggerSchema.optional();
|
|
542
542
|
},
|
|
543
|
+
stopped: z.boolean().optional(),
|
|
543
544
|
get application () {
|
|
544
545
|
return applicationSchema.optional();
|
|
545
|
-
}
|
|
546
|
-
stopped: z.boolean().optional()
|
|
546
|
+
}
|
|
547
547
|
});
|
|
548
548
|
const parameterSchema = z.object({
|
|
549
549
|
name: z.string().optional(),
|
|
@@ -606,6 +606,55 @@ const converterServiceSchema = z.object({
|
|
|
606
606
|
started: z.boolean().optional(),
|
|
607
607
|
stopped: z.boolean().optional()
|
|
608
608
|
});
|
|
609
|
+
const protocolSchema = z.object({
|
|
610
|
+
confidential: z.boolean().optional(),
|
|
611
|
+
defaultPort: z.int32().optional(),
|
|
612
|
+
description: z.string().optional(),
|
|
613
|
+
name: z.string().optional(),
|
|
614
|
+
schemeName: z.string().optional(),
|
|
615
|
+
technicalName: z.string().optional(),
|
|
616
|
+
version: z.string().optional()
|
|
617
|
+
});
|
|
618
|
+
const referenceSchema = z.object({
|
|
619
|
+
get baseRef () {
|
|
620
|
+
return referenceSchema.optional();
|
|
621
|
+
},
|
|
622
|
+
absolute: z.boolean().optional(),
|
|
623
|
+
scheme: z.string().optional(),
|
|
624
|
+
opaque: z.boolean().optional(),
|
|
625
|
+
authority: z.string().optional(),
|
|
626
|
+
relative: z.boolean().optional(),
|
|
627
|
+
query: z.string().optional(),
|
|
628
|
+
path: z.string().optional(),
|
|
629
|
+
userInfo: z.string().optional(),
|
|
630
|
+
schemeSpecificPart: z.string().optional(),
|
|
631
|
+
fragment: z.string().optional(),
|
|
632
|
+
extensions: z.string().optional(),
|
|
633
|
+
identifier: z.string().optional(),
|
|
634
|
+
matrix: z.string().optional(),
|
|
635
|
+
matrixAsForm: z.array(parameterSchema).optional(),
|
|
636
|
+
queryAsForm: z.array(parameterSchema).optional(),
|
|
637
|
+
extensionsAsArray: z.array(z.string()).optional(),
|
|
638
|
+
hierarchicalPart: z.string().optional(),
|
|
639
|
+
hostDomain: z.string().optional(),
|
|
640
|
+
hostIdentifier: z.string().optional(),
|
|
641
|
+
hostPort: z.int32().optional(),
|
|
642
|
+
lastSegment: z.string().optional(),
|
|
643
|
+
get parentRef () {
|
|
644
|
+
return referenceSchema.optional();
|
|
645
|
+
},
|
|
646
|
+
relativePart: z.string().optional(),
|
|
647
|
+
get relativeRef () {
|
|
648
|
+
return referenceSchema.optional();
|
|
649
|
+
},
|
|
650
|
+
remainingPart: z.string().optional(),
|
|
651
|
+
schemeProtocol: protocolSchema.optional(),
|
|
652
|
+
segments: z.array(z.string()).optional(),
|
|
653
|
+
get targetRef () {
|
|
654
|
+
return referenceSchema.optional();
|
|
655
|
+
},
|
|
656
|
+
hierarchical: z.boolean().optional()
|
|
657
|
+
});
|
|
609
658
|
const metadataSchema = z.object({
|
|
610
659
|
description: z.string().optional(),
|
|
611
660
|
name: z.string().optional(),
|
|
@@ -661,70 +710,13 @@ const metadataServiceSchema = z.object({
|
|
|
661
710
|
get defaultMediaType () {
|
|
662
711
|
return mediaTypeSchema.optional();
|
|
663
712
|
},
|
|
664
|
-
allCharacterSetExtensionNames: z.array(z.string()).optional(),
|
|
665
713
|
allEncodingExtensionNames: z.array(z.string()).optional(),
|
|
666
|
-
|
|
714
|
+
allCharacterSetExtensionNames: z.array(z.string()).optional(),
|
|
667
715
|
allExtensionNames: z.array(z.string()).optional(),
|
|
716
|
+
allLanguageExtensionNames: z.array(z.string()).optional(),
|
|
668
717
|
allMediaTypeExtensionNames: z.array(z.string()).optional(),
|
|
669
718
|
stopped: z.boolean().optional()
|
|
670
719
|
});
|
|
671
|
-
const rangeServiceSchema = z.object({
|
|
672
|
-
get context () {
|
|
673
|
-
return contextSchema.optional();
|
|
674
|
-
},
|
|
675
|
-
enabled: z.boolean().optional(),
|
|
676
|
-
started: z.boolean().optional(),
|
|
677
|
-
stopped: z.boolean().optional()
|
|
678
|
-
});
|
|
679
|
-
const protocolSchema = z.object({
|
|
680
|
-
confidential: z.boolean().optional(),
|
|
681
|
-
defaultPort: z.int().optional(),
|
|
682
|
-
description: z.string().optional(),
|
|
683
|
-
name: z.string().optional(),
|
|
684
|
-
schemeName: z.string().optional(),
|
|
685
|
-
technicalName: z.string().optional(),
|
|
686
|
-
version: z.string().optional()
|
|
687
|
-
});
|
|
688
|
-
const referenceSchema = z.object({
|
|
689
|
-
get baseRef () {
|
|
690
|
-
return referenceSchema.optional();
|
|
691
|
-
},
|
|
692
|
-
absolute: z.boolean().optional(),
|
|
693
|
-
scheme: z.string().optional(),
|
|
694
|
-
opaque: z.boolean().optional(),
|
|
695
|
-
authority: z.string().optional(),
|
|
696
|
-
relative: z.boolean().optional(),
|
|
697
|
-
query: z.string().optional(),
|
|
698
|
-
path: z.string().optional(),
|
|
699
|
-
userInfo: z.string().optional(),
|
|
700
|
-
schemeSpecificPart: z.string().optional(),
|
|
701
|
-
fragment: z.string().optional(),
|
|
702
|
-
extensions: z.string().optional(),
|
|
703
|
-
extensionsAsArray: z.array(z.string()).optional(),
|
|
704
|
-
hierarchicalPart: z.string().optional(),
|
|
705
|
-
hostDomain: z.string().optional(),
|
|
706
|
-
hostIdentifier: z.string().optional(),
|
|
707
|
-
hostPort: z.int().optional(),
|
|
708
|
-
lastSegment: z.string().optional(),
|
|
709
|
-
get parentRef () {
|
|
710
|
-
return referenceSchema.optional();
|
|
711
|
-
},
|
|
712
|
-
relativePart: z.string().optional(),
|
|
713
|
-
get relativeRef () {
|
|
714
|
-
return referenceSchema.optional();
|
|
715
|
-
},
|
|
716
|
-
remainingPart: z.string().optional(),
|
|
717
|
-
schemeProtocol: protocolSchema.optional(),
|
|
718
|
-
segments: z.array(z.string()).optional(),
|
|
719
|
-
get targetRef () {
|
|
720
|
-
return referenceSchema.optional();
|
|
721
|
-
},
|
|
722
|
-
hierarchical: z.boolean().optional(),
|
|
723
|
-
identifier: z.string().optional(),
|
|
724
|
-
matrix: z.string().optional(),
|
|
725
|
-
matrixAsForm: z.array(parameterSchema).optional(),
|
|
726
|
-
queryAsForm: z.array(parameterSchema).optional()
|
|
727
|
-
});
|
|
728
720
|
const statusServiceSchema = z.object({
|
|
729
721
|
get context () {
|
|
730
722
|
return contextSchema.optional();
|
|
@@ -747,13 +739,21 @@ const statusServiceSchema = z.object({
|
|
|
747
739
|
overwriting: z.boolean().optional(),
|
|
748
740
|
stopped: z.boolean().optional()
|
|
749
741
|
});
|
|
742
|
+
const rangeServiceSchema = z.object({
|
|
743
|
+
get context () {
|
|
744
|
+
return contextSchema.optional();
|
|
745
|
+
},
|
|
746
|
+
enabled: z.boolean().optional(),
|
|
747
|
+
started: z.boolean().optional(),
|
|
748
|
+
stopped: z.boolean().optional()
|
|
749
|
+
});
|
|
750
750
|
const taskServiceSchema = z.object({
|
|
751
751
|
get context () {
|
|
752
752
|
return contextSchema.optional();
|
|
753
753
|
},
|
|
754
754
|
enabled: z.boolean().optional(),
|
|
755
755
|
started: z.boolean().optional(),
|
|
756
|
-
corePoolSize: z.
|
|
756
|
+
corePoolSize: z.int32().optional(),
|
|
757
757
|
daemon: z.boolean().optional(),
|
|
758
758
|
shutdownAllowed: z.boolean().optional(),
|
|
759
759
|
terminated: z.boolean().optional(),
|
|
@@ -835,21 +835,21 @@ const applicationSchema = z.object({
|
|
|
835
835
|
get services () {
|
|
836
836
|
return z.array(serviceSchema).optional();
|
|
837
837
|
},
|
|
838
|
+
get statusService () {
|
|
839
|
+
return statusServiceSchema.optional();
|
|
840
|
+
},
|
|
838
841
|
get connegService () {
|
|
839
842
|
return connegServiceSchema.optional();
|
|
840
843
|
},
|
|
841
|
-
get converterService () {
|
|
842
|
-
return converterServiceSchema.optional();
|
|
843
|
-
},
|
|
844
844
|
get metadataService () {
|
|
845
845
|
return metadataServiceSchema.optional();
|
|
846
846
|
},
|
|
847
|
+
get converterService () {
|
|
848
|
+
return converterServiceSchema.optional();
|
|
849
|
+
},
|
|
847
850
|
get rangeService () {
|
|
848
851
|
return rangeServiceSchema.optional();
|
|
849
852
|
},
|
|
850
|
-
get statusService () {
|
|
851
|
-
return statusServiceSchema.optional();
|
|
852
|
-
},
|
|
853
853
|
get taskService () {
|
|
854
854
|
return taskServiceSchema.optional();
|
|
855
855
|
},
|
|
@@ -868,21 +868,21 @@ const applicationSchema = z.object({
|
|
|
868
868
|
get logger () {
|
|
869
869
|
return loggerSchema.optional();
|
|
870
870
|
},
|
|
871
|
+
stopped: z.boolean().optional(),
|
|
871
872
|
get application () {
|
|
872
873
|
return applicationSchema.optional();
|
|
873
|
-
}
|
|
874
|
-
stopped: z.boolean().optional()
|
|
874
|
+
}
|
|
875
875
|
});
|
|
876
876
|
const authenticationInfoSchema = z.object({
|
|
877
877
|
nextServerNonce: z.string().optional(),
|
|
878
|
-
nonceCount: z.
|
|
878
|
+
nonceCount: z.int32().optional(),
|
|
879
879
|
clientNonce: z.string().optional(),
|
|
880
880
|
quality: z.string().optional(),
|
|
881
881
|
responseDigest: z.string().optional()
|
|
882
882
|
});
|
|
883
883
|
const smartlockWebConfigSchema = z.object({
|
|
884
884
|
batteryWarningPerMailEnabled: z.boolean().optional().describe("True if a battery warning is send via email, if null/not send, the value is not being updated"),
|
|
885
|
-
dismissedLiftUpHandleWarning: z.array(z.
|
|
885
|
+
dismissedLiftUpHandleWarning: z.array(z.int32()).optional().describe("Contains the account ids which have dismissed the lift up handle warning, if null/not send, the value is not being updated. To clear send a empty array []")
|
|
886
886
|
});
|
|
887
887
|
const webConfigRequestSchema = z.object({
|
|
888
888
|
smartlockId: z.coerce.bigint().optional(),
|
|
@@ -944,7 +944,7 @@ const challengeResponseSchema = z.object({
|
|
|
944
944
|
quality: z.string().optional(),
|
|
945
945
|
secret: z.array(z.string()).optional(),
|
|
946
946
|
secretAlgorithm: z.string().optional(),
|
|
947
|
-
serverNounceCount: z.
|
|
947
|
+
serverNounceCount: z.int32().optional(),
|
|
948
948
|
timeIssued: z.coerce.bigint().optional(),
|
|
949
949
|
principal: principalSchema.optional(),
|
|
950
950
|
serverNounceCountAsHex: z.string().optional()
|
|
@@ -1007,16 +1007,16 @@ const clientInfoSchema = z.object({
|
|
|
1007
1007
|
expectations: z.array(expectationSchema).optional(),
|
|
1008
1008
|
forwardedAddresses: z.array(z.string()).optional(),
|
|
1009
1009
|
from: z.string().optional(),
|
|
1010
|
-
port: z.
|
|
1010
|
+
port: z.int32().optional(),
|
|
1011
1011
|
principals: z.array(principalSchema).optional(),
|
|
1012
1012
|
get roles () {
|
|
1013
1013
|
return z.array(roleSchema).optional();
|
|
1014
1014
|
},
|
|
1015
1015
|
user: userSchema.optional(),
|
|
1016
|
+
upstreamAddress: z.string().optional(),
|
|
1016
1017
|
agentName: z.string().optional(),
|
|
1017
1018
|
agentVersion: z.string().optional(),
|
|
1018
|
-
mainAgentProduct: productSchema.optional()
|
|
1019
|
-
upstreamAddress: z.string().optional()
|
|
1019
|
+
mainAgentProduct: productSchema.optional()
|
|
1020
1020
|
});
|
|
1021
1021
|
const companySchema = z.object({
|
|
1022
1022
|
name: z.string().optional(),
|
|
@@ -1024,7 +1024,7 @@ const companySchema = z.object({
|
|
|
1024
1024
|
});
|
|
1025
1025
|
const completableFutureSchema = z.object({
|
|
1026
1026
|
completedExceptionally: z.boolean().optional(),
|
|
1027
|
-
numberOfDependents: z.
|
|
1027
|
+
numberOfDependents: z.int32().optional(),
|
|
1028
1028
|
done: z.boolean().optional(),
|
|
1029
1029
|
cancelled: z.boolean().optional()
|
|
1030
1030
|
});
|
|
@@ -1045,22 +1045,22 @@ const cookieSchema = z.object({
|
|
|
1045
1045
|
name: z.string().optional(),
|
|
1046
1046
|
path: z.string().optional(),
|
|
1047
1047
|
value: z.string().optional(),
|
|
1048
|
-
version: z.
|
|
1048
|
+
version: z.int32().optional()
|
|
1049
1049
|
});
|
|
1050
1050
|
const cookieSettingSchema = z.object({
|
|
1051
1051
|
domain: z.string().optional(),
|
|
1052
1052
|
name: z.string().optional(),
|
|
1053
1053
|
path: z.string().optional(),
|
|
1054
1054
|
value: z.string().optional(),
|
|
1055
|
-
version: z.
|
|
1055
|
+
version: z.int32().optional(),
|
|
1056
1056
|
accessRestricted: z.boolean().optional(),
|
|
1057
1057
|
comment: z.string().optional(),
|
|
1058
|
-
maxAge: z.
|
|
1058
|
+
maxAge: z.int32().optional(),
|
|
1059
1059
|
secure: z.boolean().optional(),
|
|
1060
1060
|
description: z.string().optional()
|
|
1061
1061
|
});
|
|
1062
1062
|
const decentralWebhookSchema = z.object({
|
|
1063
|
-
id: z.
|
|
1063
|
+
id: z.int32().optional().describe("The identifier"),
|
|
1064
1064
|
secret: z.string().optional().describe("The secret to sign the webhook's payload"),
|
|
1065
1065
|
webhookUrl: z.string().describe("The URL where our webhooks (POST requests) should point to (needs to be https)"),
|
|
1066
1066
|
webhookFeatures: z.array(z.enum([
|
|
@@ -1098,13 +1098,13 @@ const methodSchema = z.object({
|
|
|
1098
1098
|
uri: z.string().optional()
|
|
1099
1099
|
});
|
|
1100
1100
|
const myAccountSchema = z.object({
|
|
1101
|
-
accountId: z.
|
|
1102
|
-
type: z.
|
|
1101
|
+
accountId: z.int32().describe("The account id"),
|
|
1102
|
+
type: z.int32().describe("The type: 0 .. user, 1 .. company, 2 .. caretaker"),
|
|
1103
1103
|
email: z.string().describe("The email address"),
|
|
1104
1104
|
emailVerified: z.boolean().optional().describe("true, if the email is verified"),
|
|
1105
1105
|
name: z.string().describe("The name"),
|
|
1106
|
-
masterAccountId: z.
|
|
1107
|
-
rights: z.
|
|
1106
|
+
masterAccountId: z.int32().optional().describe("The master account id if it's a sub account"),
|
|
1107
|
+
rights: z.int32().optional().describe("The rights bitmask if it's a sub account: 1 .. manage smartlock, 2 .. operate smartlock, 4 .. manage smartlock config, 8 .. manage smartlock authorizations, 16 .. view smartlock logs, 32 .. manage sub accounts, 64 .. create smartlocks"),
|
|
1108
1108
|
language: z.string().optional().describe("The language code").meta({
|
|
1109
1109
|
examples: [
|
|
1110
1110
|
"de"
|
|
@@ -1151,31 +1151,31 @@ const notificationSchema = z.object({
|
|
|
1151
1151
|
"8d41a187c3954f886f9de3a88c2ef22df0eac190"
|
|
1152
1152
|
]
|
|
1153
1153
|
}),
|
|
1154
|
-
os: z.
|
|
1154
|
+
os: z.int32().describe("The operating system: 0 .. Android, 1 .. iOS, 2 .. web hook"),
|
|
1155
1155
|
language: z.string().optional().describe("The language of push messages: cs, de, en (default), es, fr, it, nl, sk"),
|
|
1156
|
-
status: z.
|
|
1156
|
+
status: z.int32().optional().describe("Current state: 0 .. init, 1 .. active, 2 .. failed"),
|
|
1157
1157
|
lastActiveDate: z.iso.datetime().optional().describe("The last active date"),
|
|
1158
1158
|
settings: z.array(notificationSettingSchema).describe("Settings per Smart Lock")
|
|
1159
1159
|
});
|
|
1160
1160
|
const objectIdSchema = z.object({
|
|
1161
|
-
timestamp: z.
|
|
1162
|
-
counter: z.
|
|
1161
|
+
timestamp: z.int32().optional(),
|
|
1162
|
+
counter: z.int32().optional(),
|
|
1163
1163
|
time: z.coerce.bigint().optional(),
|
|
1164
1164
|
date: z.iso.datetime().optional(),
|
|
1165
|
-
machineIdentifier: z.
|
|
1166
|
-
processIdentifier: z.
|
|
1167
|
-
timeSecond: z.
|
|
1165
|
+
machineIdentifier: z.int32().optional(),
|
|
1166
|
+
processIdentifier: z.int32().optional(),
|
|
1167
|
+
timeSecond: z.int32().optional()
|
|
1168
1168
|
});
|
|
1169
1169
|
const openerIntercomBrandSchema = z.object({
|
|
1170
|
-
brandId: z.
|
|
1170
|
+
brandId: z.int32().describe("The brand ID"),
|
|
1171
1171
|
brand: z.string().describe("The brand name")
|
|
1172
1172
|
});
|
|
1173
1173
|
const openerIntercomModelSchema = z.object({
|
|
1174
|
-
intercomId: z.
|
|
1175
|
-
brandId: z.
|
|
1176
|
-
type: z.
|
|
1174
|
+
intercomId: z.int32().describe("The intercom ID"),
|
|
1175
|
+
brandId: z.int32().describe("The related brand ID"),
|
|
1176
|
+
type: z.int32().describe("The type of the model"),
|
|
1177
1177
|
model: z.string().describe("The model name"),
|
|
1178
|
-
verified: z.
|
|
1178
|
+
verified: z.int32().describe("Verified Nuki intercom: 1 .. verified to work, 2 .. may be compatible, but not verified, 3 .. not compatible"),
|
|
1179
1179
|
conGndBus: z.string().describe("Connection for ground BUS"),
|
|
1180
1180
|
conBusAudio: z.string().describe("Connection for audio BUS"),
|
|
1181
1181
|
conAudioout: z.string().describe("Connection for audio out"),
|
|
@@ -1183,18 +1183,18 @@ const openerIntercomModelSchema = z.object({
|
|
|
1183
1183
|
conDoorbellMinus: z.string().describe("Connection for doorbell minus"),
|
|
1184
1184
|
conOpendoor: z.string().describe("Connection for open the door"),
|
|
1185
1185
|
conGndAnalogue: z.string().describe("Connection for ground analogue"),
|
|
1186
|
-
busModeSwitch: z.
|
|
1187
|
-
busModeSwitchShortCircuitDuration: z.
|
|
1186
|
+
busModeSwitch: z.int32().describe("Settings value for BUS mode switch"),
|
|
1187
|
+
busModeSwitchShortCircuitDuration: z.int32().describe("Settings value for BUS mode switch short cicuit duration"),
|
|
1188
1188
|
creationDate: z.iso.datetime().optional().describe("The creation date"),
|
|
1189
1189
|
updateDate: z.iso.datetime().optional().describe("The update date")
|
|
1190
1190
|
});
|
|
1191
1191
|
const paginationSchema = z.object({
|
|
1192
1192
|
totalItems: z.coerce.bigint().optional(),
|
|
1193
|
-
totalPages: z.
|
|
1194
|
-
currentPage: z.
|
|
1193
|
+
totalPages: z.int32().optional(),
|
|
1194
|
+
currentPage: z.int32().optional(),
|
|
1195
1195
|
nextPage: z.string().optional(),
|
|
1196
1196
|
prevPage: z.string().optional(),
|
|
1197
|
-
pageSize: z.
|
|
1197
|
+
pageSize: z.int32().optional()
|
|
1198
1198
|
});
|
|
1199
1199
|
const paginatedResponseSchema = z.object({
|
|
1200
1200
|
results: z.array(z.object({})).optional(),
|
|
@@ -1231,9 +1231,9 @@ const selectableChannelSchema = z.object({
|
|
|
1231
1231
|
const wakeupListenerSchema = z.object({});
|
|
1232
1232
|
const selectionRegistrationSchema = z.object({
|
|
1233
1233
|
canceling: z.boolean().optional(),
|
|
1234
|
-
interestOperations: z.
|
|
1234
|
+
interestOperations: z.int32().optional(),
|
|
1235
1235
|
selectionListener: selectionListenerSchema.optional(),
|
|
1236
|
-
readyOperations: z.
|
|
1236
|
+
readyOperations: z.int32().optional(),
|
|
1237
1237
|
selectableChannel: selectableChannelSchema.optional(),
|
|
1238
1238
|
wakeupListener: wakeupListenerSchema.optional(),
|
|
1239
1239
|
readable: z.boolean().optional(),
|
|
@@ -1278,7 +1278,7 @@ const stackTraceElementSchema = z.object({
|
|
|
1278
1278
|
moduleVersion: z.string().optional(),
|
|
1279
1279
|
methodName: z.string().optional(),
|
|
1280
1280
|
fileName: z.string().optional(),
|
|
1281
|
-
lineNumber: z.
|
|
1281
|
+
lineNumber: z.int32().optional(),
|
|
1282
1282
|
className: z.string().optional(),
|
|
1283
1283
|
nativeMethod: z.boolean().optional()
|
|
1284
1284
|
});
|
|
@@ -1294,7 +1294,7 @@ const throwableSchema = z.object({
|
|
|
1294
1294
|
localizedMessage: z.string().optional()
|
|
1295
1295
|
});
|
|
1296
1296
|
const statusSchema = z.object({
|
|
1297
|
-
code: z.
|
|
1297
|
+
code: z.int32().optional(),
|
|
1298
1298
|
description: z.string().optional(),
|
|
1299
1299
|
reasonPhrase: z.string().optional(),
|
|
1300
1300
|
get throwable () {
|
|
@@ -1303,13 +1303,13 @@ const statusSchema = z.object({
|
|
|
1303
1303
|
uri: z.string().optional(),
|
|
1304
1304
|
error: z.boolean().optional(),
|
|
1305
1305
|
success: z.boolean().optional(),
|
|
1306
|
+
serverError: z.boolean().optional(),
|
|
1307
|
+
connectorError: z.boolean().optional(),
|
|
1308
|
+
clientError: z.boolean().optional(),
|
|
1306
1309
|
globalError: z.boolean().optional(),
|
|
1307
1310
|
informational: z.boolean().optional(),
|
|
1308
1311
|
redirection: z.boolean().optional(),
|
|
1309
|
-
recoverableError: z.boolean().optional()
|
|
1310
|
-
serverError: z.boolean().optional(),
|
|
1311
|
-
connectorError: z.boolean().optional(),
|
|
1312
|
-
clientError: z.boolean().optional()
|
|
1312
|
+
recoverableError: z.boolean().optional()
|
|
1313
1313
|
});
|
|
1314
1314
|
const warningSchema = z.object({
|
|
1315
1315
|
agent: z.string().optional(),
|
|
@@ -1338,7 +1338,7 @@ const requestSchema = z.object({
|
|
|
1338
1338
|
return referenceSchema.optional();
|
|
1339
1339
|
},
|
|
1340
1340
|
loggable: z.boolean().optional(),
|
|
1341
|
-
maxForwards: z.
|
|
1341
|
+
maxForwards: z.int32().optional(),
|
|
1342
1342
|
method: methodSchema.optional(),
|
|
1343
1343
|
onResponse: uniformSchema.optional(),
|
|
1344
1344
|
get originalRef () {
|
|
@@ -1356,23 +1356,23 @@ const requestSchema = z.object({
|
|
|
1356
1356
|
get rootRef () {
|
|
1357
1357
|
return referenceSchema.optional();
|
|
1358
1358
|
},
|
|
1359
|
+
confidential: z.boolean().optional(),
|
|
1359
1360
|
asynchronous: z.boolean().optional(),
|
|
1360
1361
|
entityAvailable: z.boolean().optional(),
|
|
1361
1362
|
expectingResponse: z.boolean().optional(),
|
|
1362
1363
|
synchronous: z.boolean().optional(),
|
|
1363
|
-
|
|
1364
|
-
entityAsText: z.string().optional()
|
|
1365
|
-
headers: z.array(headerSchema).optional()
|
|
1364
|
+
headers: z.array(headerSchema).optional(),
|
|
1365
|
+
entityAsText: z.string().optional()
|
|
1366
1366
|
});
|
|
1367
1367
|
const reservationAccessTimesUpdateSchema = z.object({
|
|
1368
|
-
checkInTime: z.
|
|
1369
|
-
checkOutTime: z.
|
|
1368
|
+
checkInTime: z.int32().optional().describe("Custom check in time in minutes from midnight"),
|
|
1369
|
+
checkOutTime: z.int32().optional().describe("Custom check out time in minutes from midnight")
|
|
1370
1370
|
});
|
|
1371
1371
|
const serverInfoSchema = z.object({
|
|
1372
1372
|
acceptingRanges: z.boolean().optional(),
|
|
1373
1373
|
address: z.string().optional(),
|
|
1374
1374
|
agent: z.string().optional(),
|
|
1375
|
-
port: z.
|
|
1375
|
+
port: z.int32().optional()
|
|
1376
1376
|
});
|
|
1377
1377
|
const responseSchema = z.object({
|
|
1378
1378
|
attributes: z.object({}).catchall(z.object({})).optional(),
|
|
@@ -1394,8 +1394,8 @@ const responseSchema = z.object({
|
|
|
1394
1394
|
accessControlExposeHeaders: z.array(z.string()).refine((items)=>new Set(items).size === items.length, {
|
|
1395
1395
|
message: "Array entries must be unique"
|
|
1396
1396
|
}).optional(),
|
|
1397
|
-
accessControlMaxAge: z.
|
|
1398
|
-
age: z.
|
|
1397
|
+
accessControlMaxAge: z.int32().optional(),
|
|
1398
|
+
age: z.int32().optional(),
|
|
1399
1399
|
allowedMethods: z.array(methodSchema).refine((items)=>new Set(items).size === items.length, {
|
|
1400
1400
|
message: "Array entries must be unique"
|
|
1401
1401
|
}).optional(),
|
|
@@ -1427,11 +1427,11 @@ const responseSchema = z.object({
|
|
|
1427
1427
|
serverInfo: serverInfoSchema.optional(),
|
|
1428
1428
|
status: statusSchema.optional(),
|
|
1429
1429
|
final: z.boolean().optional(),
|
|
1430
|
-
provisional: z.boolean().optional(),
|
|
1431
1430
|
confidential: z.boolean().optional(),
|
|
1431
|
+
provisional: z.boolean().optional(),
|
|
1432
|
+
headers: z.array(headerSchema).optional(),
|
|
1432
1433
|
entityAvailable: z.boolean().optional(),
|
|
1433
|
-
entityAsText: z.string().optional()
|
|
1434
|
-
headers: z.array(headerSchema).optional()
|
|
1434
|
+
entityAsText: z.string().optional()
|
|
1435
1435
|
});
|
|
1436
1436
|
const shsSubscriptionSchema = z.object({
|
|
1437
1437
|
type: z.enum([
|
|
@@ -1465,113 +1465,114 @@ const smartlockConfigSchema = z.object({
|
|
|
1465
1465
|
name: z.string().describe("The name of the smartlock for new users"),
|
|
1466
1466
|
latitude: z.number().describe("The latitude of the smartlock position"),
|
|
1467
1467
|
longitude: z.number().describe("The longitude of the smartlock position"),
|
|
1468
|
-
capabilities: z.
|
|
1468
|
+
capabilities: z.int32().optional().describe("The capabilities indicate whether door opening via app is possible, RTO is possible or both: 0 .. only door opening possible, 1 .. both possible, 2 .. only RTO possible (only for type=2)"),
|
|
1469
1469
|
autoUnlatch: z.boolean().optional().describe("True if the door should be unlatched on unlocking (knob) (only for type=1 and type=3)"),
|
|
1470
1470
|
liftUpHandle: z.boolean().optional().describe("True if the door has a lift up handle, which is required to be lifted up to lock the door"),
|
|
1471
1471
|
pairingEnabled: z.boolean().optional().describe("True if the pairing is allowed via the smartlock button"),
|
|
1472
1472
|
buttonEnabled: z.boolean().optional().describe("True if the button on the smartlock is enabled"),
|
|
1473
1473
|
ledEnabled: z.boolean().optional().describe("True if the LED on the smartlock is enabled"),
|
|
1474
|
-
ledBrightness: z.
|
|
1475
|
-
timezoneOffset: z.
|
|
1476
|
-
daylightSavingMode: z.
|
|
1474
|
+
ledBrightness: z.int32().optional().describe("The brightness of the LED: 0 .. off, 5 .. max (only for type=1 and type=3)"),
|
|
1475
|
+
timezoneOffset: z.int32().describe("[deprecated] The timezone offset (in minutes)"),
|
|
1476
|
+
daylightSavingMode: z.int32().optional().describe("[deprecated] The daylight saving mode: 0 .. off, 1 .. european"),
|
|
1477
1477
|
fobPaired: z.boolean().optional().describe("True if a fob is paired with the smartlock"),
|
|
1478
|
-
fobAction1: z.
|
|
1479
|
-
fobAction2: z.
|
|
1480
|
-
fobAction3: z.
|
|
1478
|
+
fobAction1: z.int32().optional().describe("The fob action if button is pressed once: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring"),
|
|
1479
|
+
fobAction2: z.int32().optional().describe("The fob action if button is pressed twice: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring"),
|
|
1480
|
+
fobAction3: z.int32().optional().describe("The fob action if button is pressed 3 times: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring"),
|
|
1481
1481
|
singleLock: z.boolean().describe("True if the smartlock should only lock once (instead of twice) (only for type=1)"),
|
|
1482
|
-
operatingMode: z.
|
|
1483
|
-
advertisingMode: z.
|
|
1482
|
+
operatingMode: z.int32().optional().describe("The operating mode of the opener (only for type=2): 0x00 .. generic door opener, 0x01 .. analogue intercom, 0x02 .. digital intercom, 0x03 .. digital intercom Siedle, 0x04 .. digital intercom TCS, 0x05 .. digital intercom Bticino, 0x06 .. analog intercom Siedle HTS, 0x07 .. digital intercom STR, 0x08 .. digital intercom Ritto, 0x09 .. digital intercom Fermax, 0x0A .. digital intercom Comelit, 0x0B .. digital intercom Urmet BiBus, 0x0C .. digital intercom Urmet 2Voice, 0x0D .. digital intercom Golmar, 0x0E .. digital intercom SKS, 0x0F .. digital intercom Spare"),
|
|
1483
|
+
advertisingMode: z.int32().describe("The advertising mode (battery saving): 0 .. automatic, 1 .. normal, 2 .. slow, 3 .. slowest"),
|
|
1484
1484
|
keypadPaired: z.boolean().optional().describe("True if a keypad is paired with the smartlock"),
|
|
1485
1485
|
keypad2Paired: z.boolean().optional().describe("True if a keypad 2 is paired with the smartlock"),
|
|
1486
|
-
homekitState: z.
|
|
1487
|
-
matterState: z.
|
|
1488
|
-
timezoneId: z.
|
|
1489
|
-
deviceType: z.
|
|
1486
|
+
homekitState: z.int32().optional().describe("The homekit state: 0 .. unavailable, 1 .. disabled, 2 .. enabled, 3 .. enabled & paired"),
|
|
1487
|
+
matterState: z.int32().optional().describe("The matter state: 0 .. not available, 1 .. disabled and no certificate available, 2 .. disabled, 3 .. enabled, 4 .. enabled & paired"),
|
|
1488
|
+
timezoneId: z.int32().describe("The timezone id (check https://developer.nuki.io for ids)"),
|
|
1489
|
+
deviceType: z.int32().optional().describe("The device type of a Nuki device"),
|
|
1490
1490
|
wifiEnabled: z.boolean().optional().describe("Flag that indicates if the devices internal WIFI module can be used"),
|
|
1491
1491
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation"),
|
|
1492
|
-
productVariant: z.
|
|
1492
|
+
productVariant: z.int32().optional().describe("The product variant for Smartlock 5: 1 .. Go, 2 .. Pro, 3 .. Ultra")
|
|
1493
1493
|
});
|
|
1494
1494
|
const smartlockAdvancedConfigSchema = z.object({
|
|
1495
|
-
lngTimeout: z.
|
|
1496
|
-
singleButtonPressAction: z.
|
|
1497
|
-
doubleButtonPressAction: z.
|
|
1495
|
+
lngTimeout: z.int32().optional().describe("Timeout in seconds for lock ‘n’ go"),
|
|
1496
|
+
singleButtonPressAction: z.int32().optional().describe("The desired action, if the button is pressed once: 0 .. no action, 1 .. intelligent, 2 .. unlock, 3 .. lock, 4 .. unlatch, 5 .. lock 'n' go, 6 .. show status"),
|
|
1497
|
+
doubleButtonPressAction: z.int32().optional().describe("The desired action, if the button is pressed twice: 0 .. no action, 1 .. intelligent, 2 .. unlock, 3 .. lock, 4 .. unlatch, 5 .. lock 'n' go, 6 .. show status"),
|
|
1498
1498
|
automaticBatteryTypeDetection: z.boolean().optional().describe("Flag that indicates if the automatic detection of the battery type is enabled"),
|
|
1499
|
-
unlatchDuration: z.
|
|
1499
|
+
unlatchDuration: z.int32().optional().describe("Duration in seconds for holding the latch in unlatched position"),
|
|
1500
1500
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation"),
|
|
1501
|
-
totalDegrees: z.
|
|
1502
|
-
singleLockedPositionOffsetDegrees: z.
|
|
1503
|
-
unlockedToLockedTransitionOffsetDegrees: z.
|
|
1504
|
-
unlockedPositionOffsetDegrees: z.
|
|
1505
|
-
lockedPositionOffsetDegrees: z.
|
|
1501
|
+
totalDegrees: z.int32().describe("The absolute total position in degrees that has been reached during calibration"),
|
|
1502
|
+
singleLockedPositionOffsetDegrees: z.int32().describe("Offset that alters the single locked position"),
|
|
1503
|
+
unlockedToLockedTransitionOffsetDegrees: z.int32().optional().describe("Offset that alters the position where transition from unlocked to locked happens"),
|
|
1504
|
+
unlockedPositionOffsetDegrees: z.int32().describe("Offset that alters the unlocked position"),
|
|
1505
|
+
lockedPositionOffsetDegrees: z.int32().describe("Offset that alters the locked position"),
|
|
1506
1506
|
detachedCylinder: z.boolean().optional().describe("Flag that indicates that the inner side of the used cylinder is detached from the outer side"),
|
|
1507
|
-
batteryType: z.
|
|
1507
|
+
batteryType: z.int32().describe("The type of the batteries present in the smart lock: 0 .. alkali, 1 .. accumulator, 2 .. lithium"),
|
|
1508
1508
|
autoLock: z.boolean().optional().describe("New separate flag with FW >= 2.7.8/1.9.1: The Auto Lock feature automatically locks your door when it has been unlocked for a certain period of time"),
|
|
1509
|
-
autoLockTimeout: z.
|
|
1509
|
+
autoLockTimeout: z.int32().optional().describe("Seconds until the smart lock relocks itself after it has been unlocked. FW < 2.7.8/1.9.1: No auto relock if value is 0, FW >= 2.7.8/1.9.1: has to be >=2 (defaults to 2 for values <2 if autoLock is set to true)"),
|
|
1510
1510
|
autoUpdateEnabled: z.boolean().optional().describe("Flag that indicates if available firmware updates for the deviceshould be installed automatically"),
|
|
1511
|
-
motorSpeed: z.
|
|
1511
|
+
motorSpeed: z.int32().optional().describe("Field used for setting the motor speed. 0x00 ... standard, 0x01 ... fast, 0x02 ... slow"),
|
|
1512
1512
|
enableSlowSpeedDuringNightmode: z.boolean().optional().describe("Flag indicating if the slow speed shall be applied during NightMode")
|
|
1513
1513
|
});
|
|
1514
1514
|
const smartlockOpenerAdvancedConfigSchema = z.object({
|
|
1515
|
-
intercomId: z.
|
|
1516
|
-
busModeSwitch: z.
|
|
1517
|
-
shortCircuitDuration: z.
|
|
1518
|
-
electricStrikeDelay: z.
|
|
1515
|
+
intercomId: z.int32().describe("The database ID of the connected intercom"),
|
|
1516
|
+
busModeSwitch: z.int32().describe("Method to switch between data and analogue mode"),
|
|
1517
|
+
shortCircuitDuration: z.int32().describe("Duration of the short circuit for BUS mode switching in ms"),
|
|
1518
|
+
electricStrikeDelay: z.int32().describe("Delay of electric strike activation in ms after lock action 3 'electric strike actuation'"),
|
|
1519
1519
|
randomElectricStrikeDelay: z.boolean().describe("Random electricStrikeDelay (range 3000 - 7000 ms) in order to simulate a person inside actuating the electric strike"),
|
|
1520
|
-
electricStrikeDuration: z.
|
|
1520
|
+
electricStrikeDuration: z.int32().describe("Duration in ms of electric strike actuation lock action 3 'electric strike actuation'"),
|
|
1521
1521
|
disableRtoAfterRing: z.boolean().describe("Flag to disable RTO after ring"),
|
|
1522
|
-
rtoTimeout: z.
|
|
1523
|
-
doorbellSuppression: z.
|
|
1524
|
-
doorbellSuppressionDuration: z.
|
|
1525
|
-
soundRing: z.
|
|
1526
|
-
soundOpen: z.
|
|
1527
|
-
soundRto: z.
|
|
1528
|
-
soundCm: z.
|
|
1529
|
-
soundConfirmation: z.
|
|
1530
|
-
soundLevel: z.
|
|
1531
|
-
singleButtonPressAction: z.
|
|
1532
|
-
doubleButtonPressAction: z.
|
|
1533
|
-
batteryType: z.
|
|
1522
|
+
rtoTimeout: z.int32().describe("After this period of time in minutes, RTO gets deactivated automatically"),
|
|
1523
|
+
doorbellSuppression: z.int32().describe("The doorbell supression bitmask: first bit (least significant) .. whenever the doorbell rings and CM and RTO are inactive, second bit .. RTO is active, third bit .. CM is active"),
|
|
1524
|
+
doorbellSuppressionDuration: z.int32().describe("Duration in ms of doorbell suppression (only in Operating mode 2 'digital Intercom')"),
|
|
1525
|
+
soundRing: z.int32().describe("The sound for ring: 0 .. no sound, 1 .. Sound1, 2 .. Sound2, 3 .. Sound3"),
|
|
1526
|
+
soundOpen: z.int32().describe("The sound for open: 0 .. no sound, 1 .. Sound1, 2 .. Sound2, 3 .. Sound3"),
|
|
1527
|
+
soundRto: z.int32().describe("The sound for RTO: 0 .. no sound, 1 .. Sound1, 2 .. Sound2, 3 .. Sound3"),
|
|
1528
|
+
soundCm: z.int32().describe("The sound for CM: 0 .. no sound, 1 .. Sound1, 2 .. Sound2, 3 .. Sound3"),
|
|
1529
|
+
soundConfirmation: z.int32().describe("The sound confirmation: 0 .. no sound, 1 .. sound"),
|
|
1530
|
+
soundLevel: z.int32().describe("The sound level"),
|
|
1531
|
+
singleButtonPressAction: z.int32().describe("The desired action, if the button is pressed once: 0 .. no action, 1 .. toggle RTO, 2 .. activate RTO, 3 .. deactivate RTO, 4 .. toggle CM, 5 .. activate CM, 6 .. deactivate CM, 7 .. open"),
|
|
1532
|
+
doubleButtonPressAction: z.int32().describe("The desired action, if the button is pressed twice: 0 .. no action, 1 .. toggle RTO, 2 .. activate RTO, 3 .. deactivate RTO, 4 .. toggle CM, 5 .. activate CM, 6 .. deactivate CM, 7 .. open"),
|
|
1533
|
+
batteryType: z.int32().describe("The type of the batteries present in the smart lock: 0 .. alkali, 1 .. accumulator, 2 .. lithium, 3 .. fixed"),
|
|
1534
1534
|
automaticBatteryTypeDetection: z.boolean().optional().describe("Flag that indicates if the automatic detection of the battery type is enabled"),
|
|
1535
1535
|
autoUpdateEnabled: z.boolean().optional().describe("Flag that indicates if available firmware updates for the deviceshould be installed automatically"),
|
|
1536
1536
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation")
|
|
1537
1537
|
});
|
|
1538
1538
|
const smartlockSmartdoorAdvancedConfigSchema = z.object({
|
|
1539
|
-
lngTimeout: z.
|
|
1540
|
-
singleButtonPressAction: z.
|
|
1541
|
-
doubleButtonPressAction: z.
|
|
1539
|
+
lngTimeout: z.int32().optional().describe("Timeout in seconds for lock ‘n’ go"),
|
|
1540
|
+
singleButtonPressAction: z.int32().optional().describe("The desired action, if the button is pressed once: 0 .. no action, 1 .. intelligent, 2 .. unlock, 3 .. lock, 4 .. unlatch, 5 .. lock 'n' go, 6 .. show status"),
|
|
1541
|
+
doubleButtonPressAction: z.int32().optional().describe("The desired action, if the button is pressed twice: 0 .. no action, 1 .. intelligent, 2 .. unlock, 3 .. lock, 4 .. unlatch, 5 .. lock 'n' go, 6 .. show status"),
|
|
1542
1542
|
automaticBatteryTypeDetection: z.boolean().optional().describe("Flag that indicates if the automatic detection of the battery type is enabled"),
|
|
1543
|
-
unlatchDuration: z.
|
|
1543
|
+
unlatchDuration: z.int32().optional().describe("Duration in seconds for holding the latch in unlatched position"),
|
|
1544
1544
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation"),
|
|
1545
|
-
buzzerVolume: z.
|
|
1546
|
-
supportedBatteryTypes: z.array(z.
|
|
1545
|
+
buzzerVolume: z.int32().optional().describe("The volume of the buzzer: 0 .. off, 1 .. low, 2 .. normal"),
|
|
1546
|
+
supportedBatteryTypes: z.array(z.int32()).refine((items)=>new Set(items).size === items.length, {
|
|
1547
1547
|
message: "Array entries must be unique"
|
|
1548
1548
|
}).optional().describe("Set of supported battery types: 0 .. alkali, 1 .. accumulator, 2 .. lithium, 3 .. fixed, 254 .. automatic, 255 .. unknown"),
|
|
1549
|
-
batteryType: z.
|
|
1550
|
-
autoLockTimeout: z.
|
|
1549
|
+
batteryType: z.int32().describe("The type of the batteries present in the smart lock: 0 .. alkali, 1 .. accumulator, 2 .. lithium, 3 .. fixed, 255 .. unknown"),
|
|
1550
|
+
autoLockTimeout: z.int32().optional().describe("Seconds until the smart lock relocks itself after it has been unlocked. No auto relock if value is 0"),
|
|
1551
1551
|
autoLock: z.boolean().describe("The Auto Lock feature automatically locks your door when it has been unlocked for a certain period of time")
|
|
1552
1552
|
});
|
|
1553
1553
|
const smartlockStateSchema = z.object({
|
|
1554
|
-
mode: z.
|
|
1555
|
-
state: z.
|
|
1556
|
-
trigger: z.
|
|
1557
|
-
lastAction: z.
|
|
1554
|
+
mode: z.int32().describe("The smartlock mode: 0 .. uninitialized, 1 .. pairing, 2 .. door (default), 3 .. continuous (type=2 only), 4 .. maintenance, 5 .. off-door charging"),
|
|
1555
|
+
state: z.int32().describe("The smartlock state: type=0/3/4: 0 .. uncalibrated, 1 .. locked, 2 .. unlocking, 3 .. unlocked, 4 .. locking, 5 .. unlatched, 6 .. unlocked (lock 'n' go), 7 .. unlatching, 224 .. Error wrong entry code, 225 .. Error wrong Fingerprint, 254 .. motor blocked, 255 .. undefined; type=2: 0 .. untrained, 1 .. online, 3 .. ring to open active, 5 .. open, 7 .. opening, 253 .. boot run, 255 .. undefined"),
|
|
1556
|
+
trigger: z.int32().describe(" The state trigger: 0 .. system, 1 .. manual, 2 .. button, 3 .. automatic, 4 .. web (type=1 only), 5 .. app (type=1 only), 6 .. continuous mode (type=2 only), 7 .. accessory (type=3 only)"),
|
|
1557
|
+
lastAction: z.int32().describe("The action: type=0/3/4: 1 .. unlock, 2 .. lock, 3 .. unlatch, 4 .. lock 'n' go, 5 .. lock 'n' go with unlatch; type=1: 1 .. unlock; type=2: 1 .. activate ring to open, 2 .. deactivate ring to open, 3 .. open (electric strike actuation)"),
|
|
1558
1558
|
batteryCritical: z.boolean().describe("True if the battery state of the device is critical"),
|
|
1559
1559
|
batteryCharging: z.boolean().optional().describe("True if a Nuki battery pack in a Smart Lock is currently charging"),
|
|
1560
|
-
batteryCharge: z.
|
|
1560
|
+
batteryCharge: z.int32().optional().describe("Remaining capacity of a Nuki battery pack in %"),
|
|
1561
1561
|
keypadBatteryCritical: z.boolean().optional().describe("True if the battery of a paired Keypad is critical (only available for supported devices)"),
|
|
1562
1562
|
doorsensorBatteryCritical: z.boolean().optional().describe("True if the battery of a paired doorsensor is critical (only available for supported devices)"),
|
|
1563
|
-
doorState: z.
|
|
1564
|
-
|
|
1563
|
+
doorState: z.int32().describe("The door state: 0 .. unavailable/not paired, 1 .. deactivated, 2 .. door closed, 3 .. door opened, 4 .. door state unknown, 5 .. calibrating, 16 .. uncalibrated, 240 .. removed, 255 .. unknown"),
|
|
1564
|
+
keypadMountingState: z.int32().optional().describe("The keypad mounting state: 0 .. unknown/disabled/n.a., 1 .. mounted, 2 .. moved (dismounted), 255 .. error (theft detection) (only available for supported devices)"),
|
|
1565
|
+
ringToOpenTimer: z.int32().describe("[deprecated] Remaining ring to open time; 0 if ring to open is not active (type=2 only)"),
|
|
1565
1566
|
ringToOpenEnd: z.iso.datetime().optional().describe("End date of ring to open timeout; null if ring to open is not active (type=2 only)"),
|
|
1566
1567
|
nightMode: z.boolean().describe("True if night mode currently active"),
|
|
1567
1568
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation")
|
|
1568
1569
|
});
|
|
1569
1570
|
const smartlockSchema = z.object({
|
|
1570
1571
|
smartlockId: z.coerce.bigint().describe("The smartlock id"),
|
|
1571
|
-
accountId: z.
|
|
1572
|
-
type: z.
|
|
1573
|
-
lmType: z.
|
|
1574
|
-
authId: z.
|
|
1572
|
+
accountId: z.int32().describe("The account id"),
|
|
1573
|
+
type: z.int32().describe("The type: 0 .. Smartlock 1/2, 1 .. Box, 2 .. Opener, 3 .. Smartdoor, 4 .. Smartlock 3/4, 5 .. Smartlock 5"),
|
|
1574
|
+
lmType: z.int32().optional().describe("The lock mechanism used in the smart door lock: 1 .. MyEVO, 2 .. KFV Genius (only for type = 3)"),
|
|
1575
|
+
authId: z.int32().describe("The authorization id"),
|
|
1575
1576
|
name: z.string().describe("The name of the smartlock"),
|
|
1576
1577
|
favorite: z.boolean().describe("The favorite flag"),
|
|
1577
1578
|
config: smartlockConfigSchema.optional().describe("The config"),
|
|
@@ -1580,107 +1581,107 @@ const smartlockSchema = z.object({
|
|
|
1580
1581
|
smartdoorAdvancedConfig: smartlockSmartdoorAdvancedConfigSchema.optional().describe("The smartdoor advanced config"),
|
|
1581
1582
|
webConfig: smartlockWebConfigSchema.optional().describe("The web config"),
|
|
1582
1583
|
state: smartlockStateSchema.optional().describe("The state"),
|
|
1583
|
-
firmwareVersion: z.
|
|
1584
|
-
hardwareVersion: z.
|
|
1584
|
+
firmwareVersion: z.int32().optional().describe("The firmware version"),
|
|
1585
|
+
hardwareVersion: z.int32().optional().describe("The hardware version"),
|
|
1585
1586
|
operationId: z.string().optional().describe("The operation id - if set it's locked for another operation"),
|
|
1586
|
-
serverState: z.
|
|
1587
|
-
adminPinState: z.
|
|
1587
|
+
serverState: z.int32().describe("The server state: 0 .. ok, 1 .. unregistered, 2 .. auth uuid invalid, 3 .. auth invalid, 4 .. offline"),
|
|
1588
|
+
adminPinState: z.int32().describe("The admin pin state: 0 .. ok, 1 .. missing, 2 .. invalid"),
|
|
1588
1589
|
virtualDevice: z.boolean().optional().describe("The flag indicating a virtual Smart Lock"),
|
|
1589
1590
|
creationDate: z.iso.datetime().optional().describe("The creation date"),
|
|
1590
1591
|
updateDate: z.iso.datetime().optional().describe("The update date"),
|
|
1591
1592
|
error: z.string().optional().describe("In case of any error, it contains the error message"),
|
|
1592
1593
|
previousSubscriptions: z.array(shsSubscriptionSchema).optional().describe("Previous Subscriptions"),
|
|
1593
1594
|
currentSubscription: shsSubscriptionSchema.optional().describe("Current Subscription"),
|
|
1594
|
-
region: z.
|
|
1595
|
-
mountingVariant: z.
|
|
1595
|
+
region: z.int32().optional().describe("The region"),
|
|
1596
|
+
mountingVariant: z.int32().optional().describe("The mounting variant"),
|
|
1596
1597
|
opener: z.boolean().optional(),
|
|
1597
1598
|
box: z.boolean().optional(),
|
|
1598
1599
|
smartDoor: z.boolean().optional(),
|
|
1599
1600
|
keyturner: z.boolean().optional()
|
|
1600
1601
|
});
|
|
1601
1602
|
const smartlockActionSchema = z.object({
|
|
1602
|
-
action: z.
|
|
1603
|
-
option: z.
|
|
1603
|
+
action: z.int32().describe("The action: type=0/3/4: 1 .. unlock, 2 .. lock, 3 .. unlatch, 4 .. lock 'n' go, 5 .. lock 'n' go with unlatch; type=1: 1 .. unlock; type=2: 1 activate ring to open, 2 .. deactivate ring to open, 3 .. open (electric strike actuation), 6 ... activate continuous mode, 7 ... deactivate continuous mode"),
|
|
1604
|
+
option: z.int32().optional().describe("The option mask: 0 .. none, 2 .. force, 4 .. full lock")
|
|
1604
1605
|
});
|
|
1605
1606
|
const smartlockAdminPinUpdateSchema = z.object({
|
|
1606
|
-
adminPin: z.
|
|
1607
|
+
adminPin: z.int32().describe("The admin pin")
|
|
1607
1608
|
});
|
|
1608
1609
|
const smartlockAuthSchema = z.object({
|
|
1609
1610
|
id: z.string().describe("The unique id for the smartlock authorization"),
|
|
1610
1611
|
smartlockId: z.coerce.bigint().describe("The smartlock id"),
|
|
1611
|
-
accountUserId: z.
|
|
1612
|
-
authId: z.
|
|
1613
|
-
code: z.
|
|
1612
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user"),
|
|
1613
|
+
authId: z.int32().optional().describe("The smartlock authorization id"),
|
|
1614
|
+
code: z.int32().optional().describe("The keypad code (only for type keypad)"),
|
|
1614
1615
|
fingerprints: z.object({}).catchall(z.string()).optional(),
|
|
1615
|
-
type: z.
|
|
1616
|
+
type: z.int32().describe("The type of the authorization: 0 .. app, 1 .. bridge, 2 .. fob, 3 .. keypad, 13 .. keypad code, 14 .. z-key, 15 .. virtual"),
|
|
1616
1617
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1617
1618
|
enabled: z.boolean().describe("True if the auth is enabled"),
|
|
1618
1619
|
remoteAllowed: z.boolean().describe("True if the auth has remote access"),
|
|
1619
|
-
lockCount: z.
|
|
1620
|
+
lockCount: z.int32().describe("The lock count"),
|
|
1620
1621
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1621
1622
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1622
|
-
allowedWeekDays: z.
|
|
1623
|
-
allowedFromTime: z.
|
|
1624
|
-
allowedUntilTime: z.
|
|
1623
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1624
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1625
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1625
1626
|
lastActiveDate: z.iso.datetime().optional().describe("The last active date"),
|
|
1626
1627
|
creationDate: z.iso.datetime().optional().describe("The creation date"),
|
|
1627
1628
|
updateDate: z.iso.datetime().optional().describe("The update date"),
|
|
1628
1629
|
operationId: objectIdSchema.optional().describe("The operation id - if set the auth is locked for another operations."),
|
|
1629
1630
|
error: z.string().optional().describe("In case of any error, it contains the error message"),
|
|
1630
|
-
appId: z.
|
|
1631
|
+
appId: z.int32().optional().describe("The ID of the Nuki App"),
|
|
1631
1632
|
authTypeAsString: z.string().optional()
|
|
1632
1633
|
});
|
|
1633
1634
|
const smartlockAuthCreateSchema = z.object({
|
|
1634
1635
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1635
1636
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1636
1637
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1637
|
-
allowedWeekDays: z.
|
|
1638
|
-
allowedFromTime: z.
|
|
1639
|
-
allowedUntilTime: z.
|
|
1640
|
-
accountUserId: z.
|
|
1638
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1639
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1640
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1641
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user (required if type is NOT 13 .. keypad)"),
|
|
1641
1642
|
remoteAllowed: z.boolean().describe("True if the auth has remote access"),
|
|
1642
1643
|
smartActionsEnabled: z.boolean().optional().describe("The smart actions enabled flag"),
|
|
1643
|
-
type: z.
|
|
1644
|
-
code: z.
|
|
1644
|
+
type: z.int32().optional().describe("The optional type of the auth 0 .. app (default), 2 .. fob, 13 .. keypad"),
|
|
1645
|
+
code: z.int32().optional().describe("The code of the keypad authorization (only for keypad)")
|
|
1645
1646
|
});
|
|
1646
1647
|
const smartlockAuthMultiUpdateSchema = z.object({
|
|
1647
1648
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1648
1649
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1649
1650
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1650
|
-
allowedWeekDays: z.
|
|
1651
|
-
allowedFromTime: z.
|
|
1652
|
-
allowedUntilTime: z.
|
|
1653
|
-
accountUserId: z.
|
|
1651
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1652
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1653
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1654
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user"),
|
|
1654
1655
|
enabled: z.boolean().optional().describe("True if the auth is enabled"),
|
|
1655
1656
|
remoteAllowed: z.boolean().optional().describe("True if the auth has remote access"),
|
|
1656
|
-
code: z.
|
|
1657
|
+
code: z.int32().optional().describe("The code of the keypad authorization (only for keypad)"),
|
|
1657
1658
|
id: z.string().describe("The unique id for the smartlock authorization")
|
|
1658
1659
|
});
|
|
1659
1660
|
const smartlockAuthUpdateSchema = z.object({
|
|
1660
1661
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1661
1662
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1662
1663
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1663
|
-
allowedWeekDays: z.
|
|
1664
|
-
allowedFromTime: z.
|
|
1665
|
-
allowedUntilTime: z.
|
|
1666
|
-
accountUserId: z.
|
|
1664
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1665
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1666
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1667
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user"),
|
|
1667
1668
|
enabled: z.boolean().optional().describe("True if the auth is enabled"),
|
|
1668
1669
|
remoteAllowed: z.boolean().optional().describe("True if the auth has remote access"),
|
|
1669
|
-
code: z.
|
|
1670
|
+
code: z.int32().optional().describe("The code of the keypad authorization (only for keypad)")
|
|
1670
1671
|
});
|
|
1671
1672
|
const smartlockAuthWithSharedKeyCreateSchema = z.object({
|
|
1672
1673
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1673
1674
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1674
1675
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1675
|
-
allowedWeekDays: z.
|
|
1676
|
-
allowedFromTime: z.
|
|
1677
|
-
allowedUntilTime: z.
|
|
1678
|
-
accountUserId: z.
|
|
1676
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1677
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1678
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1679
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user")
|
|
1679
1680
|
});
|
|
1680
1681
|
const smartlockLogOpenerLogSchema = z.object({
|
|
1681
1682
|
activeCm: z.boolean().describe("Flag indicating if continuous mode was active"),
|
|
1682
1683
|
activeRto: z.boolean().describe("Flag indicating if ring to open was active"),
|
|
1683
|
-
source: z.
|
|
1684
|
+
source: z.int32().describe("The cause of the activation of ring to open or continuous mode: 0 .. doorbell, 1 .. timecontrol, 2 .. app, 3 .. button, 4 .. fob, 5 .. bridge, 6 .. keypad"),
|
|
1684
1685
|
flagGeoFence: z.boolean().describe("Flag indicating a geo fence induced action"),
|
|
1685
1686
|
flagForce: z.boolean().describe("Flag indicating a force induced action"),
|
|
1686
1687
|
flagDoorbellSuppression: z.boolean().describe("Flag indicating if doorbell suppression was active")
|
|
@@ -1688,18 +1689,18 @@ const smartlockLogOpenerLogSchema = z.object({
|
|
|
1688
1689
|
const smartlockLogSchema = z.object({
|
|
1689
1690
|
id: z.string().describe("The unique id for the smartlock log"),
|
|
1690
1691
|
smartlockId: z.coerce.bigint().describe("The smartlock id"),
|
|
1691
|
-
deviceType: z.
|
|
1692
|
-
accountUserId: z.
|
|
1692
|
+
deviceType: z.int32().describe("The device type: 0 .. Smartlock 1/2 + Box, 2 .. Opener, 3 .. Smartdoor, 4 .. Smartlock 3/4, 5 .. Smartlock 5"),
|
|
1693
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user"),
|
|
1693
1694
|
authId: z.string().optional().describe("The id of the linked smartlock auth"),
|
|
1694
1695
|
name: z.string().describe("The name"),
|
|
1695
|
-
action: z.
|
|
1696
|
-
trigger: z.
|
|
1697
|
-
state: z.
|
|
1696
|
+
action: z.int32().describe("The action: 1 .. unlock, 2 .. lock, 3 .. unlatch, 4 .. lock'n'go, 5 .. lock'n'go with unlatch, 11 .. Restore reset to default setting, 208 .. door warning ajar, 209 door warning status mismatch, 224 .. doorbell recognition (only Opener), 240 .. door opened, 241 .. door closed, 242 .. door sensor jammed, 243 .. firmware update, 250 .. door log enabled, 251 .. door log disabled, 252 .. initialization, 253 .. calibration, 254 .. log enabled, 255 .. log disabled"),
|
|
1697
|
+
trigger: z.int32().describe("The trigger: 0 .. system, 1 .. manual, 2 .. button, 3 .. automatic, 4 .. web, 5 .. app, 6 .. auto lock, 7 .. accessory, 253 .. keypad error, 254 .. nuki mode, 255 .. keypad"),
|
|
1698
|
+
state: z.int32().describe("The completion state: 0 .. Success, 1 .. Motor blocked, 2 .. Canceled, 3 .. Too recent, 4 .. Busy, 5 .. Low motor voltage, 6 .. Clutch failure, 7 .. Motor power failure, 8 .. Incomplete, 9 .. Rejected, 10 .. Rejected night mode, 224 .. Invalid Code, 225 .. Invalid Fingerprint, 226 .. Invalid NFC Tag, 254 .. Other error, 255 .. Unknown error\nFor source=3 and trigger=253 the following states are used: 0 .. Access document revoked, 1 .. Send NFC failed, 2 .. Control flow, 3 .. Command time expired, 7 .. Invalid data content, 37 .. Invalid access rights, 255 .. Unknown"),
|
|
1698
1699
|
autoUnlock: z.boolean().describe("True if it was an auto unlock"),
|
|
1699
1700
|
date: z.iso.datetime().describe("The log date"),
|
|
1700
1701
|
openerLog: smartlockLogOpenerLogSchema.optional().describe("The opener specific log"),
|
|
1701
|
-
ajarTimeout: z.
|
|
1702
|
-
source: z.
|
|
1702
|
+
ajarTimeout: z.int32().optional().describe("The door sensor warning ajar timeout (in minutes, only for action = 208)"),
|
|
1703
|
+
source: z.int32().optional().describe("The source of action: 1 .. Keypad code, 2 .. Fingerprint, 3 .. Tap to Unlock, 0 .. Default"),
|
|
1703
1704
|
error: z.string().optional().describe("In case of any error, it contains the error message")
|
|
1704
1705
|
});
|
|
1705
1706
|
const smartlockUpdateSchema = z.object({
|
|
@@ -1710,10 +1711,10 @@ const smartlocksAuthAdvancedCreateSchema = z.object({
|
|
|
1710
1711
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1711
1712
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1712
1713
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1713
|
-
allowedWeekDays: z.
|
|
1714
|
-
allowedFromTime: z.
|
|
1715
|
-
allowedUntilTime: z.
|
|
1716
|
-
accountUserId: z.
|
|
1714
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1715
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1716
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1717
|
+
accountUserId: z.int32().describe("The id of the linked account user"),
|
|
1717
1718
|
smartlockIds: z.array(z.coerce.bigint()).describe("The list of smartlock ids"),
|
|
1718
1719
|
remoteAllowed: z.boolean().describe("True if the auth has remote access"),
|
|
1719
1720
|
smartActionsEnabled: z.boolean().optional().describe("The smart actions enabled flag")
|
|
@@ -1722,15 +1723,15 @@ const smartlocksAuthCreateSchema = z.object({
|
|
|
1722
1723
|
name: z.string().describe("The name of the authorization (max 32 chars)"),
|
|
1723
1724
|
allowedFromDate: z.iso.datetime().optional().describe("The allowed from date"),
|
|
1724
1725
|
allowedUntilDate: z.iso.datetime().optional().describe("The allowed until date"),
|
|
1725
|
-
allowedWeekDays: z.
|
|
1726
|
-
allowedFromTime: z.
|
|
1727
|
-
allowedUntilTime: z.
|
|
1728
|
-
accountUserId: z.
|
|
1726
|
+
allowedWeekDays: z.int32().optional().describe("The allowed weekdays bitmask: 64 .. monday, 32 .. tuesday, 16 .. wednesday, 8 .. thursday, 4 .. friday, 2 .. saturday, 1 .. sunday"),
|
|
1727
|
+
allowedFromTime: z.int32().optional().describe("The allowed from time (in minutes from midnight)"),
|
|
1728
|
+
allowedUntilTime: z.int32().optional().describe("The allowed until time (in minutes from midnight)"),
|
|
1729
|
+
accountUserId: z.int32().optional().describe("The id of the linked account user (required if type is NOT 13 .. keypad)"),
|
|
1729
1730
|
smartlockIds: z.array(z.coerce.bigint()).optional().describe("The list of smartlock ids"),
|
|
1730
1731
|
remoteAllowed: z.boolean().describe("True if the auth has remote access"),
|
|
1731
1732
|
smartActionsEnabled: z.boolean().optional().describe("The smart actions enabled flag"),
|
|
1732
|
-
type: z.
|
|
1733
|
-
code: z.
|
|
1733
|
+
type: z.int32().optional().describe("The optional type of the auth 0 .. app (default), 2 .. fob, 13 .. keypad"),
|
|
1734
|
+
code: z.int32().optional().describe("The code of the keypad authorization (only for keypad)")
|
|
1734
1735
|
});
|
|
1735
1736
|
const variantSchema = z.object({
|
|
1736
1737
|
characterSet: characterSetSchema.optional(),
|
|
@@ -1755,12 +1756,12 @@ const webhookLogSchema = z.object({
|
|
|
1755
1756
|
id: z.string().describe("The WebhookLog id"),
|
|
1756
1757
|
requestId: z.string().optional().describe("Request id, set when api-triggered request otherwise empty"),
|
|
1757
1758
|
succeeded: z.boolean().optional().describe("If the webhooks sends the data successfully"),
|
|
1758
|
-
responseStatus: z.
|
|
1759
|
+
responseStatus: z.int32().optional().describe("Http Status code of the webhook response"),
|
|
1759
1760
|
duration: z.coerce.bigint().optional().describe("The duration of the webhook in milli seconds"),
|
|
1760
|
-
accountId: z.
|
|
1761
|
+
accountId: z.int32().describe("The account id"),
|
|
1761
1762
|
request: webhookMessageSchema.optional().describe("Only set if webhook triggered by user"),
|
|
1762
1763
|
response: webhookMessageSchema.optional().describe("Set if webhook sent"),
|
|
1763
|
-
apiKeyId: z.
|
|
1764
|
+
apiKeyId: z.int32().describe("Used Api Key for the webhook"),
|
|
1764
1765
|
updated: z.iso.datetime().describe("last updated time"),
|
|
1765
1766
|
created: z.iso.datetime().describe("Creation Date")
|
|
1766
1767
|
});
|