Skip to content

Commit 872e7eb

Browse files
seambotseambot
authored
feat: Update to @seamapi/types@1.715.0 (#1036)
* feat: Update to @seamapi/types@1.715.0 * ci: Generate docs
1 parent 9672351 commit 872e7eb

5 files changed

Lines changed: 7 additions & 155 deletions

File tree

‎docs/api/_blueprint.json‎

Lines changed: 1 addition & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,91 +1064,6 @@
10641064
"format": "boolean",
10651065
"jsonType": "boolean"
10661066
},
1067-
{
1068-
"name": "is_offline_access_code",
1069-
"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).",
1070-
"isRequired": false,
1071-
"isDeprecated": false,
1072-
"deprecationMessage": "",
1073-
"isUndocumented": false,
1074-
"undocumentedMessage": "",
1075-
"isDraft": false,
1076-
"draftMessage": "",
1077-
"hasDefault": false,
1078-
"format": "boolean",
1079-
"jsonType": "boolean"
1080-
},
1081-
{
1082-
"name": "is_one_time_use",
1083-
"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.",
1084-
"isRequired": false,
1085-
"isDeprecated": false,
1086-
"deprecationMessage": "",
1087-
"isUndocumented": false,
1088-
"undocumentedMessage": "",
1089-
"isDraft": false,
1090-
"draftMessage": "",
1091-
"hasDefault": false,
1092-
"format": "boolean",
1093-
"jsonType": "boolean"
1094-
},
1095-
{
1096-
"name": "max_time_rounding",
1097-
"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`.",
1098-
"isRequired": false,
1099-
"isDeprecated": false,
1100-
"deprecationMessage": "",
1101-
"isUndocumented": false,
1102-
"undocumentedMessage": "",
1103-
"isDraft": false,
1104-
"draftMessage": "",
1105-
"hasDefault": true,
1106-
"default": "1hour",
1107-
"format": "enum",
1108-
"jsonType": "string",
1109-
"values": [
1110-
{
1111-
"name": "1hour",
1112-
"description": "",
1113-
"isDeprecated": false,
1114-
"deprecationMessage": "",
1115-
"isUndocumented": false,
1116-
"undocumentedMessage": "",
1117-
"isDraft": false,
1118-
"draftMessage": ""
1119-
},
1120-
{
1121-
"name": "1day",
1122-
"description": "",
1123-
"isDeprecated": false,
1124-
"deprecationMessage": "",
1125-
"isUndocumented": false,
1126-
"undocumentedMessage": "",
1127-
"isDraft": false,
1128-
"draftMessage": ""
1129-
},
1130-
{
1131-
"name": "1h",
1132-
"description": "",
1133-
"isDeprecated": false,
1134-
"deprecationMessage": "",
1135-
"isUndocumented": false,
1136-
"undocumentedMessage": "",
1137-
"isDraft": false,
1138-
"draftMessage": ""
1139-
},
1140-
{
1141-
"name": "1d",
1142-
"description": "",
1143-
"isDeprecated": false,
1144-
"deprecationMessage": "",
1145-
"isUndocumented": false,
1146-
"undocumentedMessage": "",
1147-
"isDraft": false,
1148-
"draftMessage": ""
1149-
}
1150-
]
1151-
},
11521067
{
11531068
"name": "name",
11541069
"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\nNote 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\nTo 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\nTo 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).",
@@ -1179,7 +1094,7 @@
11791094
},
11801095
{
11811096
"name": "preferred_code_length",
1182-
"description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
1097+
"description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
11831098
"isRequired": false,
11841099
"isDeprecated": false,
11851100
"deprecationMessage": "",
@@ -1204,34 +1119,6 @@
12041119
"hasDefault": false,
12051120
"format": "string",
12061121
"jsonType": "string"
1207-
},
1208-
{
1209-
"name": "use_backup_access_code_pool",
1210-
"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).",
1211-
"isRequired": false,
1212-
"isDeprecated": false,
1213-
"deprecationMessage": "",
1214-
"isUndocumented": false,
1215-
"undocumentedMessage": "",
1216-
"isDraft": false,
1217-
"draftMessage": "",
1218-
"hasDefault": false,
1219-
"format": "boolean",
1220-
"jsonType": "boolean"
1221-
},
1222-
{
1223-
"name": "use_offline_access_code",
1224-
"description": "",
1225-
"isRequired": false,
1226-
"isDeprecated": true,
1227-
"deprecationMessage": "Use `is_offline_access_code` instead.",
1228-
"isUndocumented": false,
1229-
"undocumentedMessage": "",
1230-
"isDraft": false,
1231-
"draftMessage": "",
1232-
"hasDefault": false,
1233-
"format": "boolean",
1234-
"jsonType": "boolean"
12351122
}
12361123
]
12371124
},

‎docs/api/_report.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,6 @@ Items that are intentionally undocumented are not included in this section.
352352
- `use_offline_access_code`
353353
- `/access_codes/create_multiple`
354354
- `attempt_for_offline_device`
355-
- `use_offline_access_code`
356355
- `/access_codes/delete`
357356
- `sync`
358357
- `/access_codes/update`
@@ -578,8 +577,6 @@ These items are deprecated.
578577

579578
- `/access_codes/create`
580579
- `use_offline_access_code`: Use `is_offline_access_code` instead.
581-
- `/access_codes/create_multiple`
582-
- `use_offline_access_code`: Use `is_offline_access_code` instead.
583580
- `/access_codes/update`
584581
- `use_offline_access_code`: Use `is_offline_access_code` instead.
585582
- `/access_grants/create`

‎docs/api/access_codes/create_multiple.md‎

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -378,24 +378,6 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability
378378

379379
---
380380

381-
**`is_offline_access_code`** *Boolean*
382-
383-
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
384-
385-
---
386-
387-
**`is_one_time_use`** *Boolean*
388-
389-
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.
390-
391-
---
392-
393-
**`max_time_rounding`** *String*
394-
395-
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`.
396-
397-
---
398-
399381
**`name`** *String*
400382

401383
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
@@ -416,7 +398,7 @@ Indicates whether [native scheduling](https://docs.seam.co/latest/capability-gui
416398

417399
**`preferred_code_length`** *Number*
418400

419-
Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
401+
Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.
420402

421403
---
422404

@@ -426,20 +408,6 @@ Date and time at which the validity of the new access code starts, in [ISO 8601]
426408

427409
---
428410

429-
**`use_backup_access_code_pool`** *Boolean*
430-
431-
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).
432-
433-
---
434-
435-
**`use_offline_access_code`** *Boolean*
436-
437-
{% hint style="warning" %}
438-
**Deprecated**. Use `is_offline_access_code` instead.
439-
{% endhint %}
440-
441-
---
442-
443411

444412
## Response
445413

‎package-lock.json‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"@prettier/plugin-ruby": "^4.0.4",
3333
"@seamapi/blueprint": "^0.53.0",
3434
"@seamapi/smith": "^0.5.2",
35-
"@seamapi/types": "1.714.0",
35+
"@seamapi/types": "1.715.0",
3636
"@types/command-exists": "^1.2.3",
3737
"change-case": "^5.4.4",
3838
"command-exists": "^1.2.9",

0 commit comments

Comments
 (0)