@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
|
@@ -16180,20 +16180,6 @@ declare const _default: {
|
|
|
16180
16180
|
description: string;
|
|
16181
16181
|
type: string;
|
|
16182
16182
|
};
|
|
16183
|
-
is_offline_access_code: {
|
|
16184
|
-
description: string;
|
|
16185
|
-
type: string;
|
|
16186
|
-
};
|
|
16187
|
-
is_one_time_use: {
|
|
16188
|
-
description: string;
|
|
16189
|
-
type: string;
|
|
16190
|
-
};
|
|
16191
|
-
max_time_rounding: {
|
|
16192
|
-
default: string;
|
|
16193
|
-
description: string;
|
|
16194
|
-
enum: string[];
|
|
16195
|
-
type: string;
|
|
16196
|
-
};
|
|
16197
16183
|
name: {
|
|
16198
16184
|
description: string;
|
|
16199
16185
|
type: string;
|
|
@@ -16211,15 +16197,6 @@ declare const _default: {
|
|
|
16211
16197
|
description: string;
|
|
16212
16198
|
type: string;
|
|
16213
16199
|
};
|
|
16214
|
-
use_backup_access_code_pool: {
|
|
16215
|
-
description: string;
|
|
16216
|
-
type: string;
|
|
16217
|
-
};
|
|
16218
|
-
use_offline_access_code: {
|
|
16219
|
-
deprecated: boolean;
|
|
16220
|
-
type: string;
|
|
16221
|
-
'x-deprecated': string;
|
|
16222
|
-
};
|
|
16223
16200
|
};
|
|
16224
16201
|
required: string[];
|
|
16225
16202
|
type: string;
|
|
@@ -16341,20 +16318,6 @@ declare const _default: {
|
|
|
16341
16318
|
description: string;
|
|
16342
16319
|
type: string;
|
|
16343
16320
|
};
|
|
16344
|
-
is_offline_access_code: {
|
|
16345
|
-
description: string;
|
|
16346
|
-
type: string;
|
|
16347
|
-
};
|
|
16348
|
-
is_one_time_use: {
|
|
16349
|
-
description: string;
|
|
16350
|
-
type: string;
|
|
16351
|
-
};
|
|
16352
|
-
max_time_rounding: {
|
|
16353
|
-
default: string;
|
|
16354
|
-
description: string;
|
|
16355
|
-
enum: string[];
|
|
16356
|
-
type: string;
|
|
16357
|
-
};
|
|
16358
16321
|
name: {
|
|
16359
16322
|
description: string;
|
|
16360
16323
|
type: string;
|
|
@@ -16372,15 +16335,6 @@ declare const _default: {
|
|
|
16372
16335
|
description: string;
|
|
16373
16336
|
type: string;
|
|
16374
16337
|
};
|
|
16375
|
-
use_backup_access_code_pool: {
|
|
16376
|
-
description: string;
|
|
16377
|
-
type: string;
|
|
16378
|
-
};
|
|
16379
|
-
use_offline_access_code: {
|
|
16380
|
-
deprecated: boolean;
|
|
16381
|
-
type: string;
|
|
16382
|
-
'x-deprecated': string;
|
|
16383
|
-
};
|
|
16384
16338
|
};
|
|
16385
16339
|
required: string[];
|
|
16386
16340
|
type: string;
|
|
@@ -24197,20 +24197,6 @@ export default {
|
|
|
24197
24197
|
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`.',
|
|
24198
24198
|
type: 'boolean',
|
|
24199
24199
|
},
|
|
24200
|
-
is_offline_access_code: {
|
|
24201
|
-
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).',
|
|
24202
|
-
type: 'boolean',
|
|
24203
|
-
},
|
|
24204
|
-
is_one_time_use: {
|
|
24205
|
-
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.',
|
|
24206
|
-
type: 'boolean',
|
|
24207
|
-
},
|
|
24208
|
-
max_time_rounding: {
|
|
24209
|
-
default: '1hour',
|
|
24210
|
-
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`.',
|
|
24211
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
24212
|
-
type: 'string',
|
|
24213
|
-
},
|
|
24214
24200
|
name: {
|
|
24215
24201
|
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).",
|
|
24216
24202
|
type: 'string',
|
|
@@ -24220,7 +24206,7 @@ export default {
|
|
|
24220
24206
|
type: 'boolean',
|
|
24221
24207
|
},
|
|
24222
24208
|
preferred_code_length: {
|
|
24223
|
-
description: 'Preferred code length.
|
|
24209
|
+
description: 'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
24224
24210
|
format: 'float',
|
|
24225
24211
|
type: 'number',
|
|
24226
24212
|
},
|
|
@@ -24228,15 +24214,6 @@ export default {
|
|
|
24228
24214
|
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.',
|
|
24229
24215
|
type: 'string',
|
|
24230
24216
|
},
|
|
24231
|
-
use_backup_access_code_pool: {
|
|
24232
|
-
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).',
|
|
24233
|
-
type: 'boolean',
|
|
24234
|
-
},
|
|
24235
|
-
use_offline_access_code: {
|
|
24236
|
-
deprecated: true,
|
|
24237
|
-
type: 'boolean',
|
|
24238
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
24239
|
-
},
|
|
24240
24217
|
},
|
|
24241
24218
|
required: ['device_ids'],
|
|
24242
24219
|
type: 'object',
|
|
@@ -24323,20 +24300,6 @@ export default {
|
|
|
24323
24300
|
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`.',
|
|
24324
24301
|
type: 'boolean',
|
|
24325
24302
|
},
|
|
24326
|
-
is_offline_access_code: {
|
|
24327
|
-
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).',
|
|
24328
|
-
type: 'boolean',
|
|
24329
|
-
},
|
|
24330
|
-
is_one_time_use: {
|
|
24331
|
-
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.',
|
|
24332
|
-
type: 'boolean',
|
|
24333
|
-
},
|
|
24334
|
-
max_time_rounding: {
|
|
24335
|
-
default: '1hour',
|
|
24336
|
-
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`.',
|
|
24337
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
24338
|
-
type: 'string',
|
|
24339
|
-
},
|
|
24340
24303
|
name: {
|
|
24341
24304
|
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).",
|
|
24342
24305
|
type: 'string',
|
|
@@ -24346,7 +24309,7 @@ export default {
|
|
|
24346
24309
|
type: 'boolean',
|
|
24347
24310
|
},
|
|
24348
24311
|
preferred_code_length: {
|
|
24349
|
-
description: 'Preferred code length.
|
|
24312
|
+
description: 'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
24350
24313
|
format: 'float',
|
|
24351
24314
|
type: 'number',
|
|
24352
24315
|
},
|
|
@@ -24354,15 +24317,6 @@ export default {
|
|
|
24354
24317
|
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.',
|
|
24355
24318
|
type: 'string',
|
|
24356
24319
|
},
|
|
24357
|
-
use_backup_access_code_pool: {
|
|
24358
|
-
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).',
|
|
24359
|
-
type: 'boolean',
|
|
24360
|
-
},
|
|
24361
|
-
use_offline_access_code: {
|
|
24362
|
-
deprecated: true,
|
|
24363
|
-
type: 'boolean',
|
|
24364
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
24365
|
-
},
|
|
24366
24320
|
},
|
|
24367
24321
|
required: ['device_ids'],
|
|
24368
24322
|
type: 'object',
|