@seamapi/types 1.714.0 → 1.715.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 +2 -48
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1 -58
- package/dist/index.cjs +2 -48
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -46
- package/lib/seam/connect/openapi.js +2 -48
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1 -12
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +2 -56
- package/src/lib/seam/connect/route-types.ts +1 -12
package/dist/connect.cjs
CHANGED
|
@@ -30207,20 +30207,6 @@ var openapi_default = {
|
|
|
30207
30207
|
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.",
|
|
30208
30208
|
type: "boolean"
|
|
30209
30209
|
},
|
|
30210
|
-
is_offline_access_code: {
|
|
30211
|
-
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
30212
|
-
type: "boolean"
|
|
30213
|
-
},
|
|
30214
|
-
is_one_time_use: {
|
|
30215
|
-
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
30216
|
-
type: "boolean"
|
|
30217
|
-
},
|
|
30218
|
-
max_time_rounding: {
|
|
30219
|
-
default: "1hour",
|
|
30220
|
-
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
30221
|
-
enum: ["1hour", "1day", "1h", "1d"],
|
|
30222
|
-
type: "string"
|
|
30223
|
-
},
|
|
30224
30210
|
name: {
|
|
30225
30211
|
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
30226
30212
|
type: "string"
|
|
@@ -30230,22 +30216,13 @@ var openapi_default = {
|
|
|
30230
30216
|
type: "boolean"
|
|
30231
30217
|
},
|
|
30232
30218
|
preferred_code_length: {
|
|
30233
|
-
description: "Preferred code length.
|
|
30219
|
+
description: "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
30234
30220
|
format: "float",
|
|
30235
30221
|
type: "number"
|
|
30236
30222
|
},
|
|
30237
30223
|
starts_at: {
|
|
30238
30224
|
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
30239
30225
|
type: "string"
|
|
30240
|
-
},
|
|
30241
|
-
use_backup_access_code_pool: {
|
|
30242
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
30243
|
-
type: "boolean"
|
|
30244
|
-
},
|
|
30245
|
-
use_offline_access_code: {
|
|
30246
|
-
deprecated: true,
|
|
30247
|
-
type: "boolean",
|
|
30248
|
-
"x-deprecated": "Use `is_offline_access_code` instead."
|
|
30249
30226
|
}
|
|
30250
30227
|
},
|
|
30251
30228
|
required: ["device_ids"],
|
|
@@ -30333,20 +30310,6 @@ var openapi_default = {
|
|
|
30333
30310
|
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.",
|
|
30334
30311
|
type: "boolean"
|
|
30335
30312
|
},
|
|
30336
|
-
is_offline_access_code: {
|
|
30337
|
-
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
30338
|
-
type: "boolean"
|
|
30339
|
-
},
|
|
30340
|
-
is_one_time_use: {
|
|
30341
|
-
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
30342
|
-
type: "boolean"
|
|
30343
|
-
},
|
|
30344
|
-
max_time_rounding: {
|
|
30345
|
-
default: "1hour",
|
|
30346
|
-
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
30347
|
-
enum: ["1hour", "1day", "1h", "1d"],
|
|
30348
|
-
type: "string"
|
|
30349
|
-
},
|
|
30350
30313
|
name: {
|
|
30351
30314
|
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
30352
30315
|
type: "string"
|
|
@@ -30356,22 +30319,13 @@ var openapi_default = {
|
|
|
30356
30319
|
type: "boolean"
|
|
30357
30320
|
},
|
|
30358
30321
|
preferred_code_length: {
|
|
30359
|
-
description: "Preferred code length.
|
|
30322
|
+
description: "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
30360
30323
|
format: "float",
|
|
30361
30324
|
type: "number"
|
|
30362
30325
|
},
|
|
30363
30326
|
starts_at: {
|
|
30364
30327
|
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
30365
30328
|
type: "string"
|
|
30366
|
-
},
|
|
30367
|
-
use_backup_access_code_pool: {
|
|
30368
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
30369
|
-
type: "boolean"
|
|
30370
|
-
},
|
|
30371
|
-
use_offline_access_code: {
|
|
30372
|
-
deprecated: true,
|
|
30373
|
-
type: "boolean",
|
|
30374
|
-
"x-deprecated": "Use `is_offline_access_code` instead."
|
|
30375
30329
|
}
|
|
30376
30330
|
},
|
|
30377
30331
|
required: ["device_ids"],
|