Skip to content

Commit 143146b

Browse files
authored
feat: Update to @seamapi/types@1.644.0 (#954)
* feat: Update to @seamapi/types@1.644.0 * ci: Generate docs
1 parent 15ba429 commit 143146b

File tree

7 files changed

+108
-5
lines changed

7 files changed

+108
-5
lines changed

docs/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,8 @@
274274
* [List Connected Accounts](api/connected_accounts/list.md)
275275
* [Sync a Connected Account](api/connected_accounts/sync.md)
276276
* [Update a Connected Account](api/connected_accounts/update.md)
277+
* [Simulate](api/connected_accounts/simulate/README.md)
278+
* [Simulate Connected Account Disconnection](api/connected_accounts/simulate/disconnect.md)
277279
* [Customers](api/customers/README.md)
278280
* [Create Customer Portal](api/customers/create_portal.md)
279281
* [Delete Customer Data](api/customers/delete_data.md)

docs/api/_blueprint.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26861,6 +26861,64 @@
2686126861
"isDeprecated": false,
2686226862
"isDraft": false
2686326863
},
26864+
{
26865+
"path": "/connected_accounts/simulate",
26866+
"name": "simulate",
26867+
"namespacePath": null,
26868+
"endpoints": [
26869+
{
26870+
"title": "Simulate Connected Account Disconnection",
26871+
"name": "disconnect",
26872+
"path": "/connected_accounts/simulate/disconnect",
26873+
"parentPath": "/connected_accounts/simulate",
26874+
"description": "Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).",
26875+
"isDeprecated": false,
26876+
"deprecationMessage": "",
26877+
"isUndocumented": false,
26878+
"undocumentedMessage": "",
26879+
"isDraft": false,
26880+
"draftMessage": "",
26881+
"response": {
26882+
"responseType": "void",
26883+
"description": "OK"
26884+
},
26885+
"request": {
26886+
"methods": [
26887+
"POST"
26888+
],
26889+
"semanticMethod": "POST",
26890+
"preferredMethod": "POST",
26891+
"parameters": [
26892+
{
26893+
"name": "connected_account_id",
26894+
"description": "",
26895+
"isRequired": true,
26896+
"isDeprecated": false,
26897+
"deprecationMessage": "",
26898+
"isUndocumented": false,
26899+
"undocumentedMessage": "",
26900+
"isDraft": false,
26901+
"draftMessage": "",
26902+
"hasDefault": false,
26903+
"format": "id",
26904+
"jsonType": "string"
26905+
}
26906+
]
26907+
},
26908+
"hasPagination": false,
26909+
"authMethods": [
26910+
"api_key",
26911+
"personal_access_token"
26912+
],
26913+
"workspaceScope": "required",
26914+
"codeSamples": []
26915+
}
26916+
],
26917+
"parentPath": "/connected_accounts",
26918+
"isUndocumented": false,
26919+
"isDeprecated": false,
26920+
"isDraft": false
26921+
},
2686426922
{
2686526923
"path": "/customers",
2686626924
"name": "customers",

docs/api/_report.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,8 @@ Items that are intentionally undocumented are not included in this section.
378378
- `device_selection_mode`
379379
- `/connected_accounts/delete`
380380
- `sync`
381+
- `/connected_accounts/simulate/disconnect`
382+
- `connected_account_id`
381383
- `/customers/create_portal`
382384
- `features`
383385
- `customer_data`
@@ -649,6 +651,7 @@ These items are deprecated.
649651
- `/access_methods/get_related`
650652
- `/access_methods/unmanaged/get`
651653
- `/access_methods/unmanaged/list`
654+
- `/connected_accounts/simulate/disconnect`
652655
- `/customers/create_portal`
653656
- `/customers/delete_data`
654657
- `/customers/push_data`
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Simulate
2+
3+
## Endpoints
4+
5+
6+
[**`/connected_accounts/simulate/disconnect`**](./disconnect.md)
7+
8+
Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../../../core-concepts/workspaces/README.md#sandbox-workspaces).
9+
10+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Simulate Connected Account Disconnection
2+
3+
- [Request Parameters](#request-parameters)
4+
- [Response](#response)
5+
6+
Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../../../core-concepts/workspaces/README.md#sandbox-workspaces).
7+
8+
9+
<details>
10+
11+
<summary>Authentication Methods</summary>
12+
13+
- API key
14+
- Personal access token
15+
<br>Must also include the `seam-workspace` header in the request.
16+
17+
To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
18+
</details>
19+
20+
## Request Parameters
21+
22+
**`connected_account_id`** *String* (Required)
23+
24+
---
25+
26+
27+
## Response
28+
29+
void
30+

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"@prettier/plugin-ruby": "^4.0.4",
3333
"@seamapi/blueprint": "^0.51.3",
3434
"@seamapi/smith": "^0.5.2",
35-
"@seamapi/types": "1.643.0",
35+
"@seamapi/types": "1.644.0",
3636
"@types/command-exists": "^1.2.3",
3737
"change-case": "^5.4.4",
3838
"command-exists": "^1.2.9",

0 commit comments

Comments
 (0)