Skip to content

Commit d9599cc

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 3fdf27b commit d9599cc

4 files changed

Lines changed: 274 additions & 0 deletions

File tree

‎docs/api-reference/_blueprint.json‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71299,6 +71299,64 @@
7129971299
"jsonType": "array",
7130071300
"itemFormat": "id"
7130171301
},
71302+
{
71303+
"name": "customer_data",
71304+
"description": "Reservation/stay-related defaults for the space.",
71305+
"isRequired": false,
71306+
"isDeprecated": false,
71307+
"deprecationMessage": "",
71308+
"isUndocumented": false,
71309+
"undocumentedMessage": "",
71310+
"isDraft": false,
71311+
"draftMessage": "",
71312+
"hasDefault": false,
71313+
"format": "object",
71314+
"jsonType": "object",
71315+
"parameters": [
71316+
{
71317+
"name": "default_checkin_time",
71318+
"description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.",
71319+
"isRequired": false,
71320+
"isDeprecated": false,
71321+
"deprecationMessage": "",
71322+
"isUndocumented": false,
71323+
"undocumentedMessage": "",
71324+
"isDraft": false,
71325+
"draftMessage": "",
71326+
"hasDefault": false,
71327+
"format": "string",
71328+
"jsonType": "string"
71329+
},
71330+
{
71331+
"name": "default_checkout_time",
71332+
"description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.",
71333+
"isRequired": false,
71334+
"isDeprecated": false,
71335+
"deprecationMessage": "",
71336+
"isUndocumented": false,
71337+
"undocumentedMessage": "",
71338+
"isDraft": false,
71339+
"draftMessage": "",
71340+
"hasDefault": false,
71341+
"format": "string",
71342+
"jsonType": "string"
71343+
},
71344+
{
71345+
"name": "time_zone",
71346+
"description": "IANA time zone for the space, e.g. America/Los_Angeles.",
71347+
"isRequired": false,
71348+
"isDeprecated": false,
71349+
"deprecationMessage": "",
71350+
"isUndocumented": false,
71351+
"undocumentedMessage": "",
71352+
"isDraft": false,
71353+
"draftMessage": "",
71354+
"hasDefault": false,
71355+
"format": "string",
71356+
"jsonType": "string"
71357+
}
71358+
]
71359+
},
7130271360
{
7130371361
"name": "customer_key",
7130471362
"description": "Customer key for which you want to create the space.",
@@ -72590,6 +72648,64 @@
7259072648
"jsonType": "array",
7259172649
"itemFormat": "id"
7259272650
},
72651+
{
72652+
"name": "customer_data",
72653+
"description": "Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.",
72654+
"isRequired": false,
72655+
"isDeprecated": false,
72656+
"deprecationMessage": "",
72657+
"isUndocumented": false,
72658+
"undocumentedMessage": "",
72659+
"isDraft": false,
72660+
"draftMessage": "",
72661+
"hasDefault": false,
72662+
"format": "object",
72663+
"jsonType": "object",
72664+
"parameters": [
72665+
{
72666+
"name": "default_checkin_time",
72667+
"description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.",
72668+
"isRequired": false,
72669+
"isDeprecated": false,
72670+
"deprecationMessage": "",
72671+
"isUndocumented": false,
72672+
"undocumentedMessage": "",
72673+
"isDraft": false,
72674+
"draftMessage": "",
72675+
"hasDefault": false,
72676+
"format": "string",
72677+
"jsonType": "string"
72678+
},
72679+
{
72680+
"name": "default_checkout_time",
72681+
"description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.",
72682+
"isRequired": false,
72683+
"isDeprecated": false,
72684+
"deprecationMessage": "",
72685+
"isUndocumented": false,
72686+
"undocumentedMessage": "",
72687+
"isDraft": false,
72688+
"draftMessage": "",
72689+
"hasDefault": false,
72690+
"format": "string",
72691+
"jsonType": "string"
72692+
},
72693+
{
72694+
"name": "time_zone",
72695+
"description": "IANA time zone for the space, e.g. America/Los_Angeles.",
72696+
"isRequired": false,
72697+
"isDeprecated": false,
72698+
"deprecationMessage": "",
72699+
"isUndocumented": false,
72700+
"undocumentedMessage": "",
72701+
"isDraft": false,
72702+
"draftMessage": "",
72703+
"hasDefault": false,
72704+
"format": "string",
72705+
"jsonType": "string"
72706+
}
72707+
]
72708+
},
7259372709
{
7259472710
"name": "customer_key",
7259572711
"description": "Customer key for which you want to update the space.",
@@ -119260,6 +119376,61 @@
119260119376
"format": "datetime",
119261119377
"jsonType": "string"
119262119378
},
119379+
{
119380+
"name": "customer_data",
119381+
"description": "Reservation/stay-related defaults for the space.",
119382+
"isDeprecated": false,
119383+
"deprecationMessage": "",
119384+
"isUndocumented": false,
119385+
"undocumentedMessage": "",
119386+
"isDraft": false,
119387+
"draftMessage": "",
119388+
"propertyGroupKey": null,
119389+
"format": "object",
119390+
"jsonType": "object",
119391+
"propertyGroups": [],
119392+
"properties": [
119393+
{
119394+
"name": "default_checkin_time",
119395+
"description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.",
119396+
"isDeprecated": false,
119397+
"deprecationMessage": "",
119398+
"isUndocumented": false,
119399+
"undocumentedMessage": "",
119400+
"isDraft": false,
119401+
"draftMessage": "",
119402+
"propertyGroupKey": null,
119403+
"format": "string",
119404+
"jsonType": "string"
119405+
},
119406+
{
119407+
"name": "default_checkout_time",
119408+
"description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.",
119409+
"isDeprecated": false,
119410+
"deprecationMessage": "",
119411+
"isUndocumented": false,
119412+
"undocumentedMessage": "",
119413+
"isDraft": false,
119414+
"draftMessage": "",
119415+
"propertyGroupKey": null,
119416+
"format": "string",
119417+
"jsonType": "string"
119418+
},
119419+
{
119420+
"name": "time_zone",
119421+
"description": "IANA time zone for the space, e.g. America/Los_Angeles.",
119422+
"isDeprecated": false,
119423+
"deprecationMessage": "",
119424+
"isUndocumented": false,
119425+
"undocumentedMessage": "",
119426+
"isDraft": false,
119427+
"draftMessage": "",
119428+
"propertyGroupKey": null,
119429+
"format": "string",
119430+
"jsonType": "string"
119431+
}
119432+
]
119433+
},
119263119434
{
119264119435
"name": "customer_key",
119265119436
"description": "Customer key associated with the space.",

‎docs/api-reference/spaces/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,31 @@ Date and time at which the space was created.
4545

4646

4747

48+
---
49+
50+
**`customer_data`** *Object*
51+
52+
Reservation/stay-related defaults for the space.
53+
54+
55+
56+
<details>
57+
<summary>Child Properties</summary>
58+
59+
- <strong><code>default_checkin_time</code></strong> <i>String</i>
60+
61+
Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
62+
63+
- <strong><code>default_checkout_time</code></strong> <i>String</i>
64+
65+
Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
66+
67+
- <strong><code>time_zone</code></strong> <i>String</i>
68+
69+
IANA time zone for the space, e.g. America/Los_Angeles.
70+
71+
</details>
72+
4873
---
4974

5075
**`customer_key`** *String*

‎docs/api-reference/spaces/create.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,45 @@ IDs of the entrances that you want to add to the new space.
204204

205205
---
206206

207+
**`customer_data`** *Object*
208+
209+
Reservation/stay-related defaults for the space.
210+
211+
<details>
212+
213+
<summary><b><code>default_checkin_time</code></b> <i>String</i></summary>
214+
215+
Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
216+
217+
</details>
218+
219+
---
220+
221+
222+
223+
<details>
224+
225+
<summary><b><code>default_checkout_time</code></b> <i>String</i></summary>
226+
227+
Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
228+
229+
</details>
230+
231+
---
232+
233+
234+
235+
<details>
236+
237+
<summary><b><code>time_zone</code></b> <i>String</i></summary>
238+
239+
IANA time zone for the space, e.g. America/Los_Angeles.
240+
241+
</details>
242+
243+
---
244+
245+
207246
**`customer_key`** *String*
208247

209248
Customer key for which you want to create the space.

‎docs/api-reference/spaces/update.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,45 @@ IDs of the entrances that you want to set for the space. If specified, this will
185185

186186
---
187187

188+
**`customer_data`** *Object*
189+
190+
Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.
191+
192+
<details>
193+
194+
<summary><b><code>default_checkin_time</code></b> <i>String</i></summary>
195+
196+
Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
197+
198+
</details>
199+
200+
---
201+
202+
203+
204+
<details>
205+
206+
<summary><b><code>default_checkout_time</code></b> <i>String</i></summary>
207+
208+
Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
209+
210+
</details>
211+
212+
---
213+
214+
215+
216+
<details>
217+
218+
<summary><b><code>time_zone</code></b> <i>String</i></summary>
219+
220+
IANA time zone for the space, e.g. America/Los_Angeles.
221+
222+
</details>
223+
224+
---
225+
226+
188227
**`customer_key`** *String*
189228

190229
Customer key for which you want to update the space.

0 commit comments

Comments
 (0)