Skip to content

Commit 7a129d4

Browse files
seambotseambot
committed
ci: Generate docs
1 parent f6d3e91 commit 7a129d4

5 files changed

Lines changed: 75 additions & 76 deletions

File tree

‎docs/api/_blueprint.json‎

Lines changed: 57 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"parameters": [
3434
{
3535
"name": "allow_external_modification",
36-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
36+
"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`.",
3737
"isRequired": false,
3838
"isDeprecated": false,
3939
"deprecationMessage": "",
@@ -118,7 +118,7 @@
118118
},
119119
{
120120
"name": "is_external_modification_allowed",
121-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
121+
"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`.",
122122
"isRequired": false,
123123
"isDeprecated": false,
124124
"deprecationMessage": "",
@@ -288,7 +288,7 @@
288288
},
289289
{
290290
"name": "use_backup_access_code_pool",
291-
"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-clients/access_codes/pull_backup_access_code).",
291+
"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).",
292292
"isRequired": false,
293293
"isDeprecated": false,
294294
"deprecationMessage": "",
@@ -353,7 +353,7 @@
353353
"parameters": [
354354
{
355355
"name": "allow_external_modification",
356-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
356+
"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`.",
357357
"isRequired": false,
358358
"isDeprecated": false,
359359
"deprecationMessage": "",
@@ -462,7 +462,7 @@
462462
},
463463
{
464464
"name": "is_external_modification_allowed",
465-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
465+
"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`.",
466466
"isRequired": false,
467467
"isDeprecated": false,
468468
"deprecationMessage": "",
@@ -617,7 +617,7 @@
617617
},
618618
{
619619
"name": "use_backup_access_code_pool",
620-
"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-clients/access_codes/pull_backup_access_code).",
620+
"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).",
621621
"isRequired": false,
622622
"isDeprecated": false,
623623
"deprecationMessage": "",
@@ -1145,7 +1145,7 @@
11451145
},
11461146
{
11471147
"name": "allow_external_modification",
1148-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
1148+
"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`.",
11491149
"isRequired": false,
11501150
"isDeprecated": false,
11511151
"deprecationMessage": "",
@@ -1216,7 +1216,7 @@
12161216
},
12171217
{
12181218
"name": "is_external_modification_allowed",
1219-
"description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
1219+
"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`.",
12201220
"isRequired": false,
12211221
"isDeprecated": false,
12221222
"deprecationMessage": "",
@@ -1436,7 +1436,7 @@
14361436
},
14371437
{
14381438
"name": "use_backup_access_code_pool",
1439-
"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-clients/access_codes/pull_backup_access_code).",
1439+
"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).",
14401440
"isRequired": false,
14411441
"isDeprecated": false,
14421442
"deprecationMessage": "",
@@ -11183,7 +11183,7 @@
1118311183
"jsonType": "object"
1118411184
},
1118511185
{
11186-
"name": "customer_id",
11186+
"name": "customer_ids",
1118711187
"description": "",
1118811188
"isRequired": false,
1118911189
"isDeprecated": false,
@@ -11193,8 +11193,9 @@
1119311193
"isDraft": false,
1119411194
"draftMessage": "",
1119511195
"hasDefault": false,
11196-
"format": "string",
11197-
"jsonType": "string"
11196+
"format": "list",
11197+
"jsonType": "array",
11198+
"itemFormat": "string"
1119811199
},
1119911200
{
1120011201
"name": "limit",
@@ -17615,10 +17616,10 @@
1761517616
"namespace": null,
1761617617
"endpoints": [
1761717618
{
17618-
"title": "",
17619+
"title": "Get a Lock",
1761917620
"name": "get",
1762017621
"path": "/locks/get",
17621-
"description": "",
17622+
"description": "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
1762217623
"isDeprecated": false,
1762317624
"deprecationMessage": "Use `/devices/get` instead.",
1762417625
"isUndocumented": false,
@@ -17641,7 +17642,7 @@
1764117642
"parameters": [
1764217643
{
1764317644
"name": "device_id",
17644-
"description": "",
17645+
"description": "ID of the lock that you want to get.",
1764517646
"isRequired": false,
1764617647
"isDeprecated": false,
1764717648
"deprecationMessage": "",
@@ -17655,7 +17656,7 @@
1765517656
},
1765617657
{
1765717658
"name": "name",
17658-
"description": "",
17659+
"description": "Name of the lock that you want to get.",
1765917660
"isRequired": false,
1766017661
"isDeprecated": false,
1766117662
"deprecationMessage": "",
@@ -17679,10 +17680,10 @@
1767917680
"codeSamples": []
1768017681
},
1768117682
{
17682-
"title": "",
17683+
"title": "List Locks",
1768317684
"name": "list",
1768417685
"path": "/locks/list",
17685-
"description": "",
17686+
"description": "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).",
1768617687
"isDeprecated": false,
1768717688
"deprecationMessage": "",
1768817689
"isUndocumented": false,
@@ -17806,7 +17807,7 @@
1780617807
},
1780717808
{
1780817809
"name": "device_type",
17809-
"description": "Device type by which to filter devices.",
17810+
"description": "Device type of the locks that you want to list.",
1781017811
"isRequired": false,
1781117812
"isDeprecated": false,
1781217813
"deprecationMessage": "",
@@ -18092,7 +18093,7 @@
1809218093
},
1809318094
{
1809418095
"name": "device_types",
18095-
"description": "Array of device types by which to filter devices.",
18096+
"description": "Device types of the locks that you want to list.",
1809618097
"isRequired": false,
1809718098
"isDeprecated": false,
1809818099
"deprecationMessage": "",
@@ -18648,7 +18649,7 @@
1864818649
},
1864918650
{
1865018651
"name": "manufacturer",
18651-
"description": "Manufacturer by which to filter devices.",
18652+
"description": "Manufacturer of the locks that you want to list.",
1865218653
"isRequired": false,
1865318654
"isDeprecated": false,
1865418655
"deprecationMessage": "",
@@ -18996,10 +18997,10 @@
1899618997
"codeSamples": []
1899718998
},
1899818999
{
18999-
"title": "",
19000+
"title": "Lock a Lock",
1900019001
"name": "lock_door",
1900119002
"path": "/locks/lock_door",
19002-
"description": "",
19003+
"description": "Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).",
1900319004
"isDeprecated": false,
1900419005
"deprecationMessage": "",
1900519006
"isUndocumented": false,
@@ -19022,7 +19023,7 @@
1902219023
"parameters": [
1902319024
{
1902419025
"name": "device_id",
19025-
"description": "",
19026+
"description": "ID of the lock that you want to lock.",
1902619027
"isRequired": true,
1902719028
"isDeprecated": false,
1902819029
"deprecationMessage": "",
@@ -19040,8 +19041,8 @@
1904019041
"isRequired": false,
1904119042
"isDeprecated": false,
1904219043
"deprecationMessage": "",
19043-
"isUndocumented": false,
19044-
"undocumentedMessage": "",
19044+
"isUndocumented": true,
19045+
"undocumentedMessage": "Only used internally.",
1904519046
"isDraft": false,
1904619047
"draftMessage": "",
1904719048
"hasDefault": true,
@@ -19061,10 +19062,10 @@
1906119062
"codeSamples": []
1906219063
},
1906319064
{
19064-
"title": "",
19065+
"title": "Unlock a Lock",
1906519066
"name": "unlock_door",
1906619067
"path": "/locks/unlock_door",
19067-
"description": "",
19068+
"description": "Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).",
1906819069
"isDeprecated": false,
1906919070
"deprecationMessage": "",
1907019071
"isUndocumented": false,
@@ -19087,7 +19088,7 @@
1908719088
"parameters": [
1908819089
{
1908919090
"name": "device_id",
19090-
"description": "",
19091+
"description": "ID of the lock that you want to unlock.",
1909119092
"isRequired": true,
1909219093
"isDeprecated": false,
1909319094
"deprecationMessage": "",
@@ -19105,8 +19106,8 @@
1910519106
"isRequired": false,
1910619107
"isDeprecated": false,
1910719108
"deprecationMessage": "",
19108-
"isUndocumented": false,
19109-
"undocumentedMessage": "",
19109+
"isUndocumented": true,
19110+
"undocumentedMessage": "Only used internally.",
1911019111
"isDraft": false,
1911119112
"draftMessage": "",
1911219113
"hasDefault": true,
@@ -19140,7 +19141,7 @@
1914019141
"title": "",
1914119142
"name": "keypad_code_entry",
1914219143
"path": "/locks/simulate/keypad_code_entry",
19143-
"description": "",
19144+
"description": "Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).",
1914419145
"isDeprecated": false,
1914519146
"deprecationMessage": "",
1914619147
"isUndocumented": true,
@@ -19163,7 +19164,7 @@
1916319164
"parameters": [
1916419165
{
1916519166
"name": "code",
19166-
"description": "",
19167+
"description": "Code that you want to simulate entering on a keypad.",
1916719168
"isRequired": true,
1916819169
"isDeprecated": false,
1916919170
"deprecationMessage": "",
@@ -19177,7 +19178,7 @@
1917719178
},
1917819179
{
1917919180
"name": "device_id",
19180-
"description": "",
19181+
"description": "ID of the device for which you want to simulate a keypad code entry.",
1918119182
"isRequired": true,
1918219183
"isDeprecated": false,
1918319184
"deprecationMessage": "",
@@ -19203,7 +19204,7 @@
1920319204
"title": "",
1920419205
"name": "manual_lock_via_keypad",
1920519206
"path": "/locks/simulate/manual_lock_via_keypad",
19206-
"description": "",
19207+
"description": "Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).",
1920719208
"isDeprecated": false,
1920819209
"deprecationMessage": "",
1920919210
"isUndocumented": true,
@@ -19226,7 +19227,7 @@
1922619227
"parameters": [
1922719228
{
1922819229
"name": "device_id",
19229-
"description": "",
19230+
"description": "ID of the device for which you want to simulate a manual lock action using a keypad.",
1923019231
"isRequired": true,
1923119232
"isDeprecated": false,
1923219233
"deprecationMessage": "",
@@ -19265,9 +19266,9 @@
1926519266
"path": "/networks/get",
1926619267
"description": "",
1926719268
"isDeprecated": false,
19268-
"deprecationMessage": "",
19269-
"isUndocumented": false,
19270-
"undocumentedMessage": "",
19269+
"deprecationMessage": "Will be removed.",
19270+
"isUndocumented": true,
19271+
"undocumentedMessage": "Deprecated.",
1927119272
"isDraft": false,
1927219273
"draftMessage": "",
1927319274
"response": {
@@ -19314,9 +19315,9 @@
1931419315
"path": "/networks/list",
1931519316
"description": "",
1931619317
"isDeprecated": false,
19317-
"deprecationMessage": "",
19318-
"isUndocumented": false,
19319-
"undocumentedMessage": "",
19318+
"deprecationMessage": "Will be removed.",
19319+
"isUndocumented": true,
19320+
"undocumentedMessage": "Deprecated.",
1932019321
"isDraft": false,
1932119322
"draftMessage": "",
1932219323
"response": {
@@ -19344,7 +19345,7 @@
1934419345
}
1934519346
],
1934619347
"subroutes": [],
19347-
"isUndocumented": false,
19348+
"isUndocumented": true,
1934819349
"isDeprecated": false,
1934919350
"isDraft": false
1935019351
},
@@ -40419,6 +40420,19 @@
4041940420
"format": "datetime",
4042040421
"jsonType": "string"
4042140422
},
40423+
{
40424+
"name": "customer_id",
40425+
"description": "",
40426+
"isDeprecated": false,
40427+
"deprecationMessage": "",
40428+
"isUndocumented": false,
40429+
"undocumentedMessage": "",
40430+
"isDraft": false,
40431+
"draftMessage": "",
40432+
"propertyGroupKey": null,
40433+
"format": "id",
40434+
"jsonType": "string"
40435+
},
4042240436
{
4042340437
"name": "device_count",
4042440438
"description": "",

0 commit comments

Comments
 (0)