Skip to content

Commit e17bc42

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 8fe19dd commit e17bc42

File tree

7 files changed

+136
-6
lines changed

7 files changed

+136
-6
lines changed

‎docs/api/_blueprint.json‎

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4561,6 +4561,20 @@
45614561
"jsonType": "array",
45624562
"itemFormat": "id"
45634563
},
4564+
{
4565+
"name": "name",
4566+
"description": "Name for the access grant.",
4567+
"isRequired": false,
4568+
"isDeprecated": false,
4569+
"deprecationMessage": "",
4570+
"isUndocumented": false,
4571+
"undocumentedMessage": "",
4572+
"isDraft": false,
4573+
"draftMessage": "",
4574+
"hasDefault": false,
4575+
"format": "string",
4576+
"jsonType": "string"
4577+
},
45644578
{
45654579
"name": "requested_access_methods",
45664580
"description": "",
@@ -5771,6 +5785,20 @@
57715785
"format": "datetime",
57725786
"jsonType": "string"
57735787
},
5788+
{
5789+
"name": "name",
5790+
"description": "Display name for the access grant.",
5791+
"isRequired": false,
5792+
"isDeprecated": false,
5793+
"deprecationMessage": "",
5794+
"isUndocumented": false,
5795+
"undocumentedMessage": "",
5796+
"isDraft": false,
5797+
"draftMessage": "",
5798+
"hasDefault": false,
5799+
"format": "string",
5800+
"jsonType": "string"
5801+
},
57745802
{
57755803
"name": "starts_at",
57765804
"description": "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
@@ -48690,7 +48718,8 @@
4869048718
"hasPagination": false,
4869148719
"authMethods": [
4869248720
"personal_access_token",
48693-
"api_key"
48721+
"api_key",
48722+
"client_session_token"
4869448723
],
4869548724
"workspaceScope": "required",
4869648725
"codeSamples": [
@@ -48844,7 +48873,8 @@
4884448873
"hasPagination": false,
4884548874
"authMethods": [
4884648875
"personal_access_token",
48847-
"api_key"
48876+
"api_key",
48877+
"client_session_token"
4884848878
],
4884948879
"workspaceScope": "required",
4885048880
"codeSamples": [
@@ -48967,6 +48997,36 @@
4896748997
"semanticMethod": "PATCH",
4896848998
"preferredMethod": "PATCH",
4896948999
"parameters": [
49000+
{
49001+
"name": "acs_entrance_ids",
49002+
"description": "IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.",
49003+
"isRequired": false,
49004+
"isDeprecated": false,
49005+
"deprecationMessage": "",
49006+
"isUndocumented": false,
49007+
"undocumentedMessage": "",
49008+
"isDraft": false,
49009+
"draftMessage": "",
49010+
"hasDefault": false,
49011+
"format": "list",
49012+
"jsonType": "array",
49013+
"itemFormat": "id"
49014+
},
49015+
{
49016+
"name": "device_ids",
49017+
"description": "IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.",
49018+
"isRequired": false,
49019+
"isDeprecated": false,
49020+
"deprecationMessage": "",
49021+
"isUndocumented": false,
49022+
"undocumentedMessage": "",
49023+
"isDraft": false,
49024+
"draftMessage": "",
49025+
"hasDefault": false,
49026+
"format": "list",
49027+
"jsonType": "array",
49028+
"itemFormat": "id"
49029+
},
4897049030
{
4897149031
"name": "name",
4897249032
"description": "Name of the space.",
@@ -48984,7 +49044,7 @@
4898449044
{
4898549045
"name": "space_id",
4898649046
"description": "ID of the space that you want to update.",
48987-
"isRequired": true,
49047+
"isRequired": false,
4898849048
"isDeprecated": false,
4898949049
"deprecationMessage": "",
4899049050
"isUndocumented": false,
@@ -48994,13 +49054,28 @@
4899449054
"hasDefault": false,
4899549055
"format": "id",
4899649056
"jsonType": "string"
49057+
},
49058+
{
49059+
"name": "space_key",
49060+
"description": "Unique key of the space that you want to update.",
49061+
"isRequired": false,
49062+
"isDeprecated": false,
49063+
"deprecationMessage": "",
49064+
"isUndocumented": false,
49065+
"undocumentedMessage": "",
49066+
"isDraft": false,
49067+
"draftMessage": "",
49068+
"hasDefault": false,
49069+
"format": "string",
49070+
"jsonType": "string"
4899749071
}
4899849072
]
4899949073
},
4900049074
"hasPagination": false,
4900149075
"authMethods": [
4900249076
"personal_access_token",
49003-
"api_key"
49077+
"api_key",
49078+
"client_session_token"
4900449079
],
4900549080
"workspaceScope": "required",
4900649081
"codeSamples": [
@@ -67343,6 +67418,19 @@
6734367418
"jsonType": "array",
6734467419
"itemFormat": "id"
6734567420
},
67421+
{
67422+
"name": "name",
67423+
"description": "Name of the Access Grant. If not provided, the display name will be computed.",
67424+
"isDeprecated": false,
67425+
"deprecationMessage": "",
67426+
"isUndocumented": false,
67427+
"undocumentedMessage": "",
67428+
"isDraft": false,
67429+
"draftMessage": "",
67430+
"propertyGroupKey": null,
67431+
"format": "string",
67432+
"jsonType": "string"
67433+
},
6734667434
{
6734767435
"name": "requested_access_methods",
6734867436
"description": "Access methods that the user requested for the Access Grant.",

‎docs/api/access_grants/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,15 @@ Instant Key URL. Only returned if the Access Grant has a single mobile_key acces
145145

146146

147147

148+
---
149+
150+
**`name`** *String*
151+
152+
Name of the Access Grant. If not provided, the display name will be computed.
153+
154+
155+
156+
148157
---
149158

150159
**`requested_access_methods`** *List* *of Objects*

‎docs/api/access_grants/create.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,12 @@ Name of the location.
506506

507507
---
508508

509+
**`name`** *String*
510+
511+
Name for the access grant.
512+
513+
---
514+
509515
**`space_ids`** *Array* *of UUIDs*
510516

511517
Set of IDs of existing spaces to which access is being granted.

‎docs/api/access_grants/update.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,12 @@ Date and time at which the validity of the grant ends, in [ISO 8601](https://www
165165

166166
---
167167

168+
**`name`** *String*
169+
170+
Display name for the access grant.
171+
172+
---
173+
168174
**`starts_at`** *String*
169175

170176
Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

‎docs/api/spaces/remove_acs_entrances.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ seam spaces remove-acs-entrances --space_id "674e511a-06c6-4734-b4ce-af467496d5f
141141
<summary>Authentication Methods</summary>
142142

143143
- API key
144+
- Client session token
144145
- Personal access token
145146
<br>Must also include the `seam-workspace` header in the request.
146147

‎docs/api/spaces/remove_devices.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ seam spaces remove-devices --space_id "6df14344-4114-4d74-9ef4-2e1208378cda" --d
141141
<summary>Authentication Methods</summary>
142142

143143
- API key
144+
- Client session token
144145
- Personal access token
145146
<br>Must also include the `seam-workspace` header in the request.
146147

‎docs/api/spaces/update.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ seam spaces update --space_id "d3513c20-dc89-4e19-8713-1c3ab01aec81" --name "My
173173
<summary>Authentication Methods</summary>
174174

175175
- API key
176+
- Client session token
176177
- Personal access token
177178
<br>Must also include the `seam-workspace` header in the request.
178179

@@ -181,9 +182,15 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
181182

182183
## Request Parameters
183184

184-
**`space_id`** *String* (Required)
185+
**`acs_entrance_ids`** *Array* *of UUIDs*
185186

186-
ID of the space that you want to update.
187+
IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.
188+
189+
---
190+
191+
**`device_ids`** *Array* *of UUIDs*
192+
193+
IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.
187194

188195
---
189196

@@ -193,6 +200,18 @@ Name of the space.
193200

194201
---
195202

203+
**`space_id`** *String*
204+
205+
ID of the space that you want to update.
206+
207+
---
208+
209+
**`space_key`** *String*
210+
211+
Unique key of the space that you want to update.
212+
213+
---
214+
196215

197216
## Response
198217

0 commit comments

Comments
 (0)