Skip to content

Commit 2913816

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 47bbd01 commit 2913816

7 files changed

Lines changed: 1191 additions & 10 deletions

File tree

‎docs/api/_blueprint.json‎

Lines changed: 420 additions & 5 deletions
Large diffs are not rendered by default.

‎docs/api/_report.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -683,11 +683,6 @@ These items are deprecated.
683683
- `/connect_webviews/delete`
684684
- `/connect_webviews/get`
685685
- `/connect_webviews/list`
686-
- `/connected_accounts/delete`
687-
- `/connected_accounts/get`
688-
- `/connected_accounts/list`
689-
- `/connected_accounts/sync`
690-
- `/connected_accounts/update`
691686
- `/devices/delete`
692687
- `/devices/get`
693688
- `/devices/list`

‎docs/api/connected_accounts/delete.md‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,138 @@ ID of the connected account that you want to delete.
4242

4343
void
4444

45+
46+
---
47+
48+
## Examples
49+
50+
### Delete a connected account
51+
52+
Specify the `connected_account_id` of the connected account that you want to delete.
53+
54+
{% tabs %}
55+
{% tab title="JavaScript" %}
56+
#### Code
57+
58+
```javascript
59+
await seam.connectedAccounts.delete({
60+
connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c",
61+
});
62+
```
63+
64+
#### Output
65+
66+
```javascript
67+
// void
68+
```
69+
{% endtab %}
70+
71+
{% tab title="Python" %}
72+
#### Code
73+
74+
```python
75+
seam.connected_accounts.delete(
76+
connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c"
77+
)
78+
```
79+
80+
#### Output
81+
82+
```python
83+
None
84+
```
85+
{% endtab %}
86+
87+
{% tab title="Ruby" %}
88+
#### Code
89+
90+
```ruby
91+
seam.connected_accounts.delete(connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c")
92+
```
93+
94+
#### Output
95+
96+
```ruby
97+
nil
98+
```
99+
{% endtab %}
100+
101+
{% tab title="PHP" %}
102+
#### Code
103+
104+
```php
105+
<?php
106+
$seam->connected_accounts->delete(
107+
connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c"
108+
);
109+
```
110+
111+
#### Output
112+
113+
```php
114+
null
115+
```
116+
{% endtab %}
117+
118+
{% tab title="Seam CLI" %}
119+
#### Code
120+
121+
```seam_cli
122+
seam connected-accounts delete --connected_account_id "23e4eb21-6e93-48c4-a077-bf503246d47c"
123+
```
124+
125+
#### Output
126+
127+
```seam_cli
128+
{}
129+
```
130+
{% endtab %}
131+
132+
{% tab title="Go" %}
133+
#### Code
134+
135+
```go
136+
package main
137+
138+
import api "github.com/seamapi/go"
139+
140+
func main() {
141+
client.ConnectedAccounts.Delete(
142+
context.Background(),
143+
api.ConnectedAccountsDeleteRequest{
144+
ConnectedAccountId: api.String("23e4eb21-6e93-48c4-a077-bf503246d47c"),
145+
},
146+
)
147+
}
148+
```
149+
150+
#### Output
151+
152+
```go
153+
nil
154+
```
155+
{% endtab %}
156+
157+
{% tab title="cURL" %}
158+
#### Code
159+
160+
```curl
161+
curl --include --request POST "https://connect.getseam.com/connected_accounts/delete" \
162+
--header "Authorization: Bearer $SEAM_API_KEY" \
163+
--json @- <<EOF
164+
{
165+
"connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c"
166+
}
167+
EOF
168+
```
169+
170+
#### Output
171+
172+
```curl
173+
{}
174+
```
175+
{% endtab %}
176+
177+
{% endtabs %}
178+
179+

‎docs/api/connected_accounts/get.md‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,175 @@ Email address associated with the connected account that you want to get.
4545

4646
[connected\_account](./)
4747

48+
49+
---
50+
51+
## Examples
52+
53+
### Get a connected account
54+
55+
Specify the `connected_account_id` of the connected account that you want to get.
56+
57+
{% tabs %}
58+
{% tab title="JavaScript" %}
59+
#### Code
60+
61+
```javascript
62+
await seam.connectedAccounts.get({
63+
connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c",
64+
});
65+
```
66+
67+
#### Output
68+
69+
```javascript
70+
[
71+
{
72+
"connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
73+
"created_at": "2022-08-24T10:38:05.128Z",
74+
"account_type": "schlage"
75+
}
76+
]
77+
```
78+
{% endtab %}
79+
80+
{% tab title="Python" %}
81+
#### Code
82+
83+
```python
84+
seam.connected_accounts.get(connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c")
85+
```
86+
87+
#### Output
88+
89+
```python
90+
[
91+
ConnectedAccount(
92+
connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c",
93+
created_at="2022-08-24T10:38:05.128Z",
94+
account_type="schlage",
95+
)
96+
]
97+
```
98+
{% endtab %}
99+
100+
{% tab title="Ruby" %}
101+
#### Code
102+
103+
```ruby
104+
seam.connected_accounts.get(connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c")
105+
```
106+
107+
#### Output
108+
109+
```ruby
110+
[
111+
{
112+
"connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
113+
"created_at" => "2022-08-24T10:38:05.128Z",
114+
"account_type" => "schlage",
115+
},
116+
]
117+
```
118+
{% endtab %}
119+
120+
{% tab title="PHP" %}
121+
#### Code
122+
123+
```php
124+
<?php
125+
$seam->connected_accounts->get(
126+
connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c"
127+
);
128+
```
129+
130+
#### Output
131+
132+
```php
133+
<?php
134+
[
135+
[
136+
"connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
137+
"created_at" => "2022-08-24T10:38:05.128Z",
138+
"account_type" => "schlage",
139+
],
140+
];
141+
```
142+
{% endtab %}
143+
144+
{% tab title="Seam CLI" %}
145+
#### Code
146+
147+
```seam_cli
148+
seam connected-accounts get --connected_account_id "23e4eb21-6e93-48c4-a077-bf503246d47c"
149+
```
150+
151+
#### Output
152+
153+
```seam_cli
154+
[
155+
{
156+
"connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
157+
"created_at": "2022-08-24T10:38:05.128Z",
158+
"account_type": "schlage"
159+
}
160+
]
161+
```
162+
{% endtab %}
163+
164+
{% tab title="Go" %}
165+
#### Code
166+
167+
```go
168+
package main
169+
170+
import api "github.com/seamapi/go"
171+
172+
func main() {
173+
client.ConnectedAccounts.Get(
174+
context.Background(),
175+
api.ConnectedAccountsGetRequest{
176+
ConnectedAccountId: api.String("23e4eb21-6e93-48c4-a077-bf503246d47c"),
177+
},
178+
)
179+
}
180+
```
181+
182+
#### Output
183+
184+
```go
185+
[]api.ConnectedAccount{api.ConnectedAccount{ConnectedAccountId: "23e4eb21-6e93-48c4-a077-bf503246d47c", CreatedAt: "2022-08-24T10:38:05.128Z", AccountType: "schlage"}}
186+
```
187+
{% endtab %}
188+
189+
{% tab title="cURL" %}
190+
#### Code
191+
192+
```curl
193+
curl --include --request POST "https://connect.getseam.com/connected_accounts/get" \
194+
--header "Authorization: Bearer $SEAM_API_KEY" \
195+
--json @- <<EOF
196+
{
197+
"connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c"
198+
}
199+
EOF
200+
```
201+
202+
#### Output
203+
204+
```curl
205+
{
206+
"connected_account": [
207+
{
208+
"connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
209+
"created_at": "2022-08-24T10:38:05.128Z",
210+
"account_type": "schlage"
211+
}
212+
]
213+
}
214+
```
215+
{% endtab %}
216+
217+
{% endtabs %}
218+
219+

0 commit comments

Comments
 (0)