Skip to content

Commit 555b2a3

Browse files
committed
ci: Generate docs
1 parent 295982d commit 555b2a3

File tree

4 files changed

+441
-0
lines changed

4 files changed

+441
-0
lines changed

docs/api/_summary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@
8282
* [List Connected Accounts](api/connected_accounts/list.md)
8383
* [Sync a Connected Account](api/connected_accounts/sync.md)
8484
* [Update a Connected Account](api/connected_accounts/update.md)
85+
* [Customers](api/customers/README.md)
86+
* [Create Customer Portal](api/customers/create_portal.md)
87+
* [Push Customer Data](api/customers/push_data.md)
8588
* [Phones](api/phones/README.md)
8689
* [Deactivate a Phone](api/phones/deactivate.md)
8790
* [Get a Phone](api/phones/get.md)

docs/api/customers/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Customers
2+
{% hint style="info" %}
3+
**Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [[email protected]](mailto:[email protected]). Expect breaking changes as we refine the design.
4+
{% endhint %}
5+
6+
## Endpoints
7+
8+
9+
[**`/customers/create_portal`**](./create_portal.md)
10+
11+
Creates a new customer portal magic link with configurable features.
12+
13+
14+
[**`/customers/push_data`**](./push_data.md)
15+
16+
Pushes customer data including resources like spaces, properties, rooms, users, etc.
17+
18+
Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,289 @@
1+
# Create Customer Portal
2+
{% hint style="info" %}
3+
**Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [[email protected]](mailto:[email protected]). Expect breaking changes as we refine the design.
4+
{% endhint %}
5+
6+
- [Request Parameters](#request-parameters)
7+
- [Response](#response)
8+
9+
Creates a new customer portal magic link with configurable features.
10+
11+
12+
<details>
13+
14+
<summary>Authentication Methods</summary>
15+
16+
- API key
17+
- Personal access token
18+
<br>Must also include the `seam-workspace` header in the request.
19+
20+
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
21+
</details>
22+
23+
## Request Parameters
24+
25+
**`customer_data`** *Object*
26+
27+
<details>
28+
29+
<summary><b><code>access_grants</code></b> <i>List</i></summary>
30+
31+
List of access grants.
32+
33+
</details>
34+
35+
---
36+
37+
38+
39+
<details>
40+
41+
<summary><b><code>bookings</code></b> <i>List</i></summary>
42+
43+
List of bookings.
44+
45+
</details>
46+
47+
---
48+
49+
50+
51+
<details>
52+
53+
<summary><b><code>buildings</code></b> <i>List</i></summary>
54+
55+
List of buildings.
56+
57+
</details>
58+
59+
---
60+
61+
62+
63+
<details>
64+
65+
<summary><b><code>common_areas</code></b> <i>List</i></summary>
66+
67+
List of shared common areas.
68+
69+
</details>
70+
71+
---
72+
73+
74+
75+
<details>
76+
77+
<summary><b><code>customer_key</code></b> <i>String</i></summary>
78+
79+
Your unique identifier for the customer.
80+
81+
</details>
82+
83+
---
84+
85+
86+
87+
<details>
88+
89+
<summary><b><code>facilities</code></b> <i>List</i></summary>
90+
91+
List of gym or fitness facilities.
92+
93+
</details>
94+
95+
---
96+
97+
98+
99+
<details>
100+
101+
<summary><b><code>guests</code></b> <i>List</i></summary>
102+
103+
List of guests.
104+
105+
</details>
106+
107+
---
108+
109+
110+
111+
<details>
112+
113+
<summary><b><code>listings</code></b> <i>List</i></summary>
114+
115+
List of property listings.
116+
117+
</details>
118+
119+
---
120+
121+
122+
123+
<details>
124+
125+
<summary><b><code>properties</code></b> <i>List</i></summary>
126+
127+
List of short-term rental properties.
128+
129+
</details>
130+
131+
---
132+
133+
134+
135+
<details>
136+
137+
<summary><b><code>reservations</code></b> <i>List</i></summary>
138+
139+
List of reservations.
140+
141+
</details>
142+
143+
---
144+
145+
146+
147+
<details>
148+
149+
<summary><b><code>residents</code></b> <i>List</i></summary>
150+
151+
List of residents.
152+
153+
</details>
154+
155+
---
156+
157+
158+
159+
<details>
160+
161+
<summary><b><code>rooms</code></b> <i>List</i></summary>
162+
163+
List of hotel or hospitality rooms.
164+
165+
</details>
166+
167+
---
168+
169+
170+
171+
<details>
172+
173+
<summary><b><code>spaces</code></b> <i>List</i></summary>
174+
175+
List of general spaces or areas.
176+
177+
</details>
178+
179+
---
180+
181+
182+
183+
<details>
184+
185+
<summary><b><code>tenants</code></b> <i>List</i></summary>
186+
187+
List of tenants.
188+
189+
</details>
190+
191+
---
192+
193+
194+
195+
<details>
196+
197+
<summary><b><code>units</code></b> <i>List</i></summary>
198+
199+
List of multi-family residential units.
200+
201+
</details>
202+
203+
---
204+
205+
206+
207+
<details>
208+
209+
<summary><b><code>user_identities</code></b> <i>List</i></summary>
210+
211+
List of user identities.
212+
213+
</details>
214+
215+
---
216+
217+
218+
219+
<details>
220+
221+
<summary><b><code>users</code></b> <i>List</i></summary>
222+
223+
List of users.
224+
225+
</details>
226+
227+
---
228+
229+
230+
**`features`** *Object*
231+
232+
<details>
233+
234+
<summary><b><code>connect</code></b> <i>Object</i></summary>
235+
236+
Configuration for the connect accounts feature.
237+
238+
</details>
239+
240+
---
241+
242+
243+
244+
<details>
245+
246+
<summary><b><code>manage_devices</code></b> <i>Object</i></summary>
247+
248+
Configuration for the manage devices feature.
249+
250+
</details>
251+
252+
---
253+
254+
255+
256+
<details>
257+
258+
<summary><b><code>organize</code></b> <i>Object</i></summary>
259+
260+
Configuration for the organize feature.
261+
262+
</details>
263+
264+
---
265+
266+
267+
268+
## Response
269+
270+
[magic\_link](./)
271+
272+
273+
{% tabs %}
274+
{% tab title="JSON" %}
275+
276+
277+
278+
```json
279+
{
280+
"building_block_type": "connect_accounts",
281+
"created_at": "2025-06-16T16:54:17.946594Z",
282+
"customer_key": "My Company",
283+
"expires_at": "2025-06-17T16:54:17.946594Z",
284+
"url": "https://se.am/1234",
285+
"workspace_id": "67c58f1f-f148-4415-a63c-dc6c145c6b91"
286+
}
287+
```
288+
{% endtab %}
289+
{% endtabs %}

0 commit comments

Comments
 (0)