@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
|
@@ -1807,7 +1807,7 @@ export type Routes = {
|
|
|
1807
1807
|
device_ids: string[];
|
|
1808
1808
|
/** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
|
|
1809
1809
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
1810
|
-
/** Preferred code length.
|
|
1810
|
+
/** Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length. */
|
|
1811
1811
|
preferred_code_length?: number | undefined;
|
|
1812
1812
|
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1813
1813
|
|
|
@@ -1826,21 +1826,10 @@ export type Routes = {
|
|
|
1826
1826
|
attempt_for_offline_device?: boolean;
|
|
1827
1827
|
/** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
|
|
1828
1828
|
prefer_native_scheduling?: boolean | undefined;
|
|
1829
|
-
/** 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). */
|
|
1830
|
-
use_backup_access_code_pool?: boolean | undefined;
|
|
1831
1829
|
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
|
|
1832
1830
|
allow_external_modification?: boolean | undefined;
|
|
1833
1831
|
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
|
|
1834
1832
|
is_external_modification_allowed?: boolean | undefined;
|
|
1835
|
-
/**
|
|
1836
|
-
* @deprecated Use `is_offline_access_code` instead.*/
|
|
1837
|
-
use_offline_access_code?: boolean | undefined;
|
|
1838
|
-
/** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
|
|
1839
|
-
is_offline_access_code?: boolean | undefined;
|
|
1840
|
-
/** 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. */
|
|
1841
|
-
is_one_time_use?: boolean | undefined;
|
|
1842
|
-
/** 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`. */
|
|
1843
|
-
max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
|
|
1844
1833
|
};
|
|
1845
1834
|
commonParams: {};
|
|
1846
1835
|
formData: {};
|
package/package.json
CHANGED
|
@@ -27026,23 +27026,6 @@ export default {
|
|
|
27026
27026
|
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
27027
27027
|
type: 'boolean',
|
|
27028
27028
|
},
|
|
27029
|
-
is_offline_access_code: {
|
|
27030
|
-
description:
|
|
27031
|
-
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
27032
|
-
type: 'boolean',
|
|
27033
|
-
},
|
|
27034
|
-
is_one_time_use: {
|
|
27035
|
-
description:
|
|
27036
|
-
'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.',
|
|
27037
|
-
type: 'boolean',
|
|
27038
|
-
},
|
|
27039
|
-
max_time_rounding: {
|
|
27040
|
-
default: '1hour',
|
|
27041
|
-
description:
|
|
27042
|
-
'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`.',
|
|
27043
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
27044
|
-
type: 'string',
|
|
27045
|
-
},
|
|
27046
27029
|
name: {
|
|
27047
27030
|
description:
|
|
27048
27031
|
"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).",
|
|
@@ -27055,7 +27038,7 @@ export default {
|
|
|
27055
27038
|
},
|
|
27056
27039
|
preferred_code_length: {
|
|
27057
27040
|
description:
|
|
27058
|
-
'Preferred code length.
|
|
27041
|
+
'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
27059
27042
|
format: 'float',
|
|
27060
27043
|
type: 'number',
|
|
27061
27044
|
},
|
|
@@ -27064,16 +27047,6 @@ export default {
|
|
|
27064
27047
|
'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.',
|
|
27065
27048
|
type: 'string',
|
|
27066
27049
|
},
|
|
27067
|
-
use_backup_access_code_pool: {
|
|
27068
|
-
description:
|
|
27069
|
-
'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).',
|
|
27070
|
-
type: 'boolean',
|
|
27071
|
-
},
|
|
27072
|
-
use_offline_access_code: {
|
|
27073
|
-
deprecated: true,
|
|
27074
|
-
type: 'boolean',
|
|
27075
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
27076
|
-
},
|
|
27077
27050
|
},
|
|
27078
27051
|
required: ['device_ids'],
|
|
27079
27052
|
type: 'object',
|
|
@@ -27166,23 +27139,6 @@ export default {
|
|
|
27166
27139
|
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
27167
27140
|
type: 'boolean',
|
|
27168
27141
|
},
|
|
27169
|
-
is_offline_access_code: {
|
|
27170
|
-
description:
|
|
27171
|
-
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
27172
|
-
type: 'boolean',
|
|
27173
|
-
},
|
|
27174
|
-
is_one_time_use: {
|
|
27175
|
-
description:
|
|
27176
|
-
'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.',
|
|
27177
|
-
type: 'boolean',
|
|
27178
|
-
},
|
|
27179
|
-
max_time_rounding: {
|
|
27180
|
-
default: '1hour',
|
|
27181
|
-
description:
|
|
27182
|
-
'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`.',
|
|
27183
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
27184
|
-
type: 'string',
|
|
27185
|
-
},
|
|
27186
27142
|
name: {
|
|
27187
27143
|
description:
|
|
27188
27144
|
"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).",
|
|
@@ -27195,7 +27151,7 @@ export default {
|
|
|
27195
27151
|
},
|
|
27196
27152
|
preferred_code_length: {
|
|
27197
27153
|
description:
|
|
27198
|
-
'Preferred code length.
|
|
27154
|
+
'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
27199
27155
|
format: 'float',
|
|
27200
27156
|
type: 'number',
|
|
27201
27157
|
},
|
|
@@ -27204,16 +27160,6 @@ export default {
|
|
|
27204
27160
|
'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.',
|
|
27205
27161
|
type: 'string',
|
|
27206
27162
|
},
|
|
27207
|
-
use_backup_access_code_pool: {
|
|
27208
|
-
description:
|
|
27209
|
-
'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).',
|
|
27210
|
-
type: 'boolean',
|
|
27211
|
-
},
|
|
27212
|
-
use_offline_access_code: {
|
|
27213
|
-
deprecated: true,
|
|
27214
|
-
type: 'boolean',
|
|
27215
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
27216
|
-
},
|
|
27217
27163
|
},
|
|
27218
27164
|
required: ['device_ids'],
|
|
27219
27165
|
type: 'object',
|
|
@@ -2051,7 +2051,7 @@ export type Routes = {
|
|
|
2051
2051
|
device_ids: string[]
|
|
2052
2052
|
/** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
|
|
2053
2053
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
|
|
2054
|
-
/** Preferred code length.
|
|
2054
|
+
/** Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length. */
|
|
2055
2055
|
preferred_code_length?: number | undefined
|
|
2056
2056
|
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
2057
2057
|
|
|
@@ -2070,21 +2070,10 @@ export type Routes = {
|
|
|
2070
2070
|
attempt_for_offline_device?: boolean
|
|
2071
2071
|
/** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
|
|
2072
2072
|
prefer_native_scheduling?: boolean | undefined
|
|
2073
|
-
/** 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). */
|
|
2074
|
-
use_backup_access_code_pool?: boolean | undefined
|
|
2075
2073
|
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
|
|
2076
2074
|
allow_external_modification?: boolean | undefined
|
|
2077
2075
|
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
|
|
2078
2076
|
is_external_modification_allowed?: boolean | undefined
|
|
2079
|
-
/**
|
|
2080
|
-
* @deprecated Use `is_offline_access_code` instead.*/
|
|
2081
|
-
use_offline_access_code?: boolean | undefined
|
|
2082
|
-
/** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
|
|
2083
|
-
is_offline_access_code?: boolean | undefined
|
|
2084
|
-
/** 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. */
|
|
2085
|
-
is_one_time_use?: boolean | undefined
|
|
2086
|
-
/** 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`. */
|
|
2087
|
-
max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
|
|
2088
2077
|
}
|
|
2089
2078
|
commonParams: {}
|
|
2090
2079
|
formData: {}
|