@seamapi/types 1.515.0 → 1.517.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/connect.cjs +17 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +70 -184
- package/dist/index.cjs +17 -60
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +5 -0
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -0
- package/lib/seam/connect/models/access-grants/requested-access-method.js +7 -0
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +14 -0
- package/lib/seam/connect/openapi.d.ts +46 -179
- package/lib/seam/connect/openapi.js +14 -60
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +12 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +9 -0
- package/src/lib/seam/connect/openapi.ts +16 -60
- package/src/lib/seam/connect/route-types.ts +12 -5
|
@@ -9995,6 +9995,8 @@ export type Routes = {
|
|
|
9995
9995
|
requested_access_methods: {
|
|
9996
9996
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
9997
9997
|
mode: 'code' | 'card' | 'mobile_key';
|
|
9998
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
9999
|
+
code?: string | undefined;
|
|
9998
10000
|
}[];
|
|
9999
10001
|
/** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10000
10002
|
starts_at?: string | undefined;
|
|
@@ -10026,6 +10028,8 @@ export type Routes = {
|
|
|
10026
10028
|
display_name: string;
|
|
10027
10029
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10028
10030
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10031
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
10032
|
+
code?: string | undefined;
|
|
10029
10033
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10030
10034
|
created_at: string;
|
|
10031
10035
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -10099,6 +10103,8 @@ export type Routes = {
|
|
|
10099
10103
|
display_name: string;
|
|
10100
10104
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10101
10105
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10106
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
10107
|
+
code?: string | undefined;
|
|
10102
10108
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10103
10109
|
created_at: string;
|
|
10104
10110
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -11810,6 +11816,8 @@ export type Routes = {
|
|
|
11810
11816
|
display_name: string;
|
|
11811
11817
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11812
11818
|
mode: 'code' | 'card' | 'mobile_key';
|
|
11819
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
11820
|
+
code?: string | undefined;
|
|
11813
11821
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11814
11822
|
created_at: string;
|
|
11815
11823
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -17186,6 +17194,8 @@ export type Routes = {
|
|
|
17186
17194
|
display_name: string;
|
|
17187
17195
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
17188
17196
|
mode: 'code' | 'card' | 'mobile_key';
|
|
17197
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
17198
|
+
code?: string | undefined;
|
|
17189
17199
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
17190
17200
|
created_at: string;
|
|
17191
17201
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -32717,7 +32727,6 @@ export type Routes = {
|
|
|
32717
32727
|
queryParams: {};
|
|
32718
32728
|
jsonBody: {};
|
|
32719
32729
|
commonParams: {
|
|
32720
|
-
customer_ids?: string[] | undefined;
|
|
32721
32730
|
/** Customer key for which you want to list devices. */
|
|
32722
32731
|
customer_key?: string | undefined;
|
|
32723
32732
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -34444,7 +34453,6 @@ export type Routes = {
|
|
|
34444
34453
|
queryParams: {};
|
|
34445
34454
|
jsonBody: {};
|
|
34446
34455
|
commonParams: {
|
|
34447
|
-
customer_ids?: string[] | undefined;
|
|
34448
34456
|
/** Customer key for which you want to list devices. */
|
|
34449
34457
|
customer_key?: string | undefined;
|
|
34450
34458
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -41097,7 +41105,6 @@ export type Routes = {
|
|
|
41097
41105
|
queryParams: {};
|
|
41098
41106
|
jsonBody: {};
|
|
41099
41107
|
commonParams: {
|
|
41100
|
-
customer_ids?: string[] | undefined;
|
|
41101
41108
|
/** Customer key for which you want to list devices. */
|
|
41102
41109
|
customer_key?: string | undefined;
|
|
41103
41110
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -48526,7 +48533,6 @@ export type Routes = {
|
|
|
48526
48533
|
queryParams: {};
|
|
48527
48534
|
jsonBody: {};
|
|
48528
48535
|
commonParams: {
|
|
48529
|
-
customer_ids?: string[] | undefined;
|
|
48530
48536
|
/** Customer key for which you want to list devices. */
|
|
48531
48537
|
customer_key?: string | undefined;
|
|
48532
48538
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -67440,7 +67446,6 @@ export type Routes = {
|
|
|
67440
67446
|
queryParams: {};
|
|
67441
67447
|
jsonBody: {};
|
|
67442
67448
|
commonParams: {
|
|
67443
|
-
customer_ids?: string[] | undefined;
|
|
67444
67449
|
/** Customer key for which you want to list devices. */
|
|
67445
67450
|
customer_key?: string | undefined;
|
|
67446
67451
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -82777,6 +82782,8 @@ export type Routes = {
|
|
|
82777
82782
|
display_name: string;
|
|
82778
82783
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
82779
82784
|
mode: 'code' | 'card' | 'mobile_key';
|
|
82785
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
82786
|
+
code?: string | undefined;
|
|
82780
82787
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
82781
82788
|
created_at: string;
|
|
82782
82789
|
/** IDs of the access methods created for the requested access method. */
|
package/package.json
CHANGED
|
@@ -7,6 +7,15 @@ export const requested_access_method = z.object({
|
|
|
7
7
|
.describe(
|
|
8
8
|
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
9
9
|
),
|
|
10
|
+
code: z
|
|
11
|
+
.string()
|
|
12
|
+
.min(4)
|
|
13
|
+
.max(9)
|
|
14
|
+
.regex(/^\d+$/, 'Must only contain digits')
|
|
15
|
+
.optional()
|
|
16
|
+
.describe(
|
|
17
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
18
|
+
),
|
|
10
19
|
created_at: z
|
|
11
20
|
.string()
|
|
12
21
|
.datetime()
|
|
@@ -1889,6 +1889,14 @@ export default {
|
|
|
1889
1889
|
'Access methods that the user requested for the Access Grant.',
|
|
1890
1890
|
items: {
|
|
1891
1891
|
properties: {
|
|
1892
|
+
code: {
|
|
1893
|
+
description:
|
|
1894
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
1895
|
+
maxLength: 9,
|
|
1896
|
+
minLength: 4,
|
|
1897
|
+
pattern: '^\\d+$',
|
|
1898
|
+
type: 'string',
|
|
1899
|
+
},
|
|
1892
1900
|
created_access_method_ids: {
|
|
1893
1901
|
description:
|
|
1894
1902
|
'IDs of the access methods created for the requested access method.',
|
|
@@ -27974,6 +27982,14 @@ export default {
|
|
|
27974
27982
|
requested_access_methods: {
|
|
27975
27983
|
items: {
|
|
27976
27984
|
properties: {
|
|
27985
|
+
code: {
|
|
27986
|
+
description:
|
|
27987
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
27988
|
+
maxLength: 9,
|
|
27989
|
+
minLength: 4,
|
|
27990
|
+
pattern: '^\\d+$',
|
|
27991
|
+
type: 'string',
|
|
27992
|
+
},
|
|
27977
27993
|
mode: {
|
|
27978
27994
|
description:
|
|
27979
27995
|
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -40247,14 +40263,6 @@ export default {
|
|
|
40247
40263
|
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
|
|
40248
40264
|
operationId: 'devicesListGet',
|
|
40249
40265
|
parameters: [
|
|
40250
|
-
{
|
|
40251
|
-
in: 'query',
|
|
40252
|
-
name: 'customer_ids',
|
|
40253
|
-
schema: {
|
|
40254
|
-
items: { format: 'uuid', type: 'string' },
|
|
40255
|
-
type: 'array',
|
|
40256
|
-
},
|
|
40257
|
-
},
|
|
40258
40266
|
{
|
|
40259
40267
|
in: 'query',
|
|
40260
40268
|
name: 'customer_key',
|
|
@@ -40720,10 +40728,6 @@ export default {
|
|
|
40720
40728
|
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
40721
40729
|
type: 'object',
|
|
40722
40730
|
},
|
|
40723
|
-
customer_ids: {
|
|
40724
|
-
items: { format: 'uuid', type: 'string' },
|
|
40725
|
-
type: 'array',
|
|
40726
|
-
},
|
|
40727
40731
|
customer_key: {
|
|
40728
40732
|
description:
|
|
40729
40733
|
'Customer key for which you want to list devices.',
|
|
@@ -41551,14 +41555,6 @@ export default {
|
|
|
41551
41555
|
'Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
|
|
41552
41556
|
operationId: 'devicesUnmanagedListGet',
|
|
41553
41557
|
parameters: [
|
|
41554
|
-
{
|
|
41555
|
-
in: 'query',
|
|
41556
|
-
name: 'customer_ids',
|
|
41557
|
-
schema: {
|
|
41558
|
-
items: { format: 'uuid', type: 'string' },
|
|
41559
|
-
type: 'array',
|
|
41560
|
-
},
|
|
41561
|
-
},
|
|
41562
41558
|
{
|
|
41563
41559
|
in: 'query',
|
|
41564
41560
|
name: 'customer_key',
|
|
@@ -42021,10 +42017,6 @@ export default {
|
|
|
42021
42017
|
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
42022
42018
|
type: 'object',
|
|
42023
42019
|
},
|
|
42024
|
-
customer_ids: {
|
|
42025
|
-
items: { format: 'uuid', type: 'string' },
|
|
42026
|
-
type: 'array',
|
|
42027
|
-
},
|
|
42028
42020
|
customer_key: {
|
|
42029
42021
|
description:
|
|
42030
42022
|
'Customer key for which you want to list devices.',
|
|
@@ -43933,14 +43925,6 @@ export default {
|
|
|
43933
43925
|
'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
|
|
43934
43926
|
operationId: 'locksListGet',
|
|
43935
43927
|
parameters: [
|
|
43936
|
-
{
|
|
43937
|
-
in: 'query',
|
|
43938
|
-
name: 'customer_ids',
|
|
43939
|
-
schema: {
|
|
43940
|
-
items: { format: 'uuid', type: 'string' },
|
|
43941
|
-
type: 'array',
|
|
43942
|
-
},
|
|
43943
|
-
},
|
|
43944
43928
|
{
|
|
43945
43929
|
in: 'query',
|
|
43946
43930
|
name: 'customer_key',
|
|
@@ -44342,10 +44326,6 @@ export default {
|
|
|
44342
44326
|
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
44343
44327
|
type: 'object',
|
|
44344
44328
|
},
|
|
44345
|
-
customer_ids: {
|
|
44346
|
-
items: { format: 'uuid', type: 'string' },
|
|
44347
|
-
type: 'array',
|
|
44348
|
-
},
|
|
44349
44329
|
customer_key: {
|
|
44350
44330
|
description:
|
|
44351
44331
|
'Customer key for which you want to list devices.',
|
|
@@ -44855,14 +44835,6 @@ export default {
|
|
|
44855
44835
|
'Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
44856
44836
|
operationId: 'noiseSensorsListGet',
|
|
44857
44837
|
parameters: [
|
|
44858
|
-
{
|
|
44859
|
-
in: 'query',
|
|
44860
|
-
name: 'customer_ids',
|
|
44861
|
-
schema: {
|
|
44862
|
-
items: { format: 'uuid', type: 'string' },
|
|
44863
|
-
type: 'array',
|
|
44864
|
-
},
|
|
44865
|
-
},
|
|
44866
44838
|
{
|
|
44867
44839
|
in: 'query',
|
|
44868
44840
|
name: 'customer_key',
|
|
@@ -45182,10 +45154,6 @@ export default {
|
|
|
45182
45154
|
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
45183
45155
|
type: 'object',
|
|
45184
45156
|
},
|
|
45185
|
-
customer_ids: {
|
|
45186
|
-
items: { format: 'uuid', type: 'string' },
|
|
45187
|
-
type: 'array',
|
|
45188
|
-
},
|
|
45189
45157
|
customer_key: {
|
|
45190
45158
|
description:
|
|
45191
45159
|
'Customer key for which you want to list devices.',
|
|
@@ -52133,14 +52101,6 @@ export default {
|
|
|
52133
52101
|
'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
52134
52102
|
operationId: 'thermostatsListGet',
|
|
52135
52103
|
parameters: [
|
|
52136
|
-
{
|
|
52137
|
-
in: 'query',
|
|
52138
|
-
name: 'customer_ids',
|
|
52139
|
-
schema: {
|
|
52140
|
-
items: { format: 'uuid', type: 'string' },
|
|
52141
|
-
type: 'array',
|
|
52142
|
-
},
|
|
52143
|
-
},
|
|
52144
52104
|
{
|
|
52145
52105
|
in: 'query',
|
|
52146
52106
|
name: 'customer_key',
|
|
@@ -52481,10 +52441,6 @@ export default {
|
|
|
52481
52441
|
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
52482
52442
|
type: 'object',
|
|
52483
52443
|
},
|
|
52484
|
-
customer_ids: {
|
|
52485
|
-
items: { format: 'uuid', type: 'string' },
|
|
52486
|
-
type: 'array',
|
|
52487
|
-
},
|
|
52488
52444
|
customer_key: {
|
|
52489
52445
|
description:
|
|
52490
52446
|
'Customer key for which you want to list devices.',
|
|
@@ -11235,6 +11235,8 @@ export type Routes = {
|
|
|
11235
11235
|
requested_access_methods: {
|
|
11236
11236
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11237
11237
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11238
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
11239
|
+
code?: string | undefined
|
|
11238
11240
|
}[]
|
|
11239
11241
|
/** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
11240
11242
|
starts_at?: string | undefined
|
|
@@ -11266,6 +11268,8 @@ export type Routes = {
|
|
|
11266
11268
|
display_name: string
|
|
11267
11269
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11268
11270
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11271
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
11272
|
+
code?: string | undefined
|
|
11269
11273
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11270
11274
|
created_at: string
|
|
11271
11275
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -11341,6 +11345,8 @@ export type Routes = {
|
|
|
11341
11345
|
display_name: string
|
|
11342
11346
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11343
11347
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11348
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
11349
|
+
code?: string | undefined
|
|
11344
11350
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11345
11351
|
created_at: string
|
|
11346
11352
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -13515,6 +13521,8 @@ export type Routes = {
|
|
|
13515
13521
|
display_name: string
|
|
13516
13522
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
13517
13523
|
mode: 'code' | 'card' | 'mobile_key'
|
|
13524
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
13525
|
+
code?: string | undefined
|
|
13518
13526
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
13519
13527
|
created_at: string
|
|
13520
13528
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -19966,6 +19974,8 @@ export type Routes = {
|
|
|
19966
19974
|
display_name: string
|
|
19967
19975
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
19968
19976
|
mode: 'code' | 'card' | 'mobile_key'
|
|
19977
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
19978
|
+
code?: string | undefined
|
|
19969
19979
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
19970
19980
|
created_at: string
|
|
19971
19981
|
/** IDs of the access methods created for the requested access method. */
|
|
@@ -38044,7 +38054,6 @@ export type Routes = {
|
|
|
38044
38054
|
queryParams: {}
|
|
38045
38055
|
jsonBody: {}
|
|
38046
38056
|
commonParams: {
|
|
38047
|
-
customer_ids?: string[] | undefined
|
|
38048
38057
|
/** Customer key for which you want to list devices. */
|
|
38049
38058
|
customer_key?: string | undefined
|
|
38050
38059
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -40388,7 +40397,6 @@ export type Routes = {
|
|
|
40388
40397
|
queryParams: {}
|
|
40389
40398
|
jsonBody: {}
|
|
40390
40399
|
commonParams: {
|
|
40391
|
-
customer_ids?: string[] | undefined
|
|
40392
40400
|
/** Customer key for which you want to list devices. */
|
|
40393
40401
|
customer_key?: string | undefined
|
|
40394
40402
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -48754,7 +48762,6 @@ export type Routes = {
|
|
|
48754
48762
|
queryParams: {}
|
|
48755
48763
|
jsonBody: {}
|
|
48756
48764
|
commonParams: {
|
|
48757
|
-
customer_ids?: string[] | undefined
|
|
48758
48765
|
/** Customer key for which you want to list devices. */
|
|
48759
48766
|
customer_key?: string | undefined
|
|
48760
48767
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -57658,7 +57665,6 @@ export type Routes = {
|
|
|
57658
57665
|
queryParams: {}
|
|
57659
57666
|
jsonBody: {}
|
|
57660
57667
|
commonParams: {
|
|
57661
|
-
customer_ids?: string[] | undefined
|
|
57662
57668
|
/** Customer key for which you want to list devices. */
|
|
57663
57669
|
customer_key?: string | undefined
|
|
57664
57670
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -80145,7 +80151,6 @@ export type Routes = {
|
|
|
80145
80151
|
queryParams: {}
|
|
80146
80152
|
jsonBody: {}
|
|
80147
80153
|
commonParams: {
|
|
80148
|
-
customer_ids?: string[] | undefined
|
|
80149
80154
|
/** Customer key for which you want to list devices. */
|
|
80150
80155
|
customer_key?: string | undefined
|
|
80151
80156
|
/** ID of the connected account for which you want to list devices. */
|
|
@@ -98523,6 +98528,8 @@ export type Routes = {
|
|
|
98523
98528
|
display_name: string
|
|
98524
98529
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
98525
98530
|
mode: 'code' | 'card' | 'mobile_key'
|
|
98531
|
+
/** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
|
|
98532
|
+
code?: string | undefined
|
|
98526
98533
|
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
98527
98534
|
created_at: string
|
|
98528
98535
|
/** IDs of the access methods created for the requested access method. */
|