diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ee6e07c86..9862134f3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -274,6 +274,8 @@ * [List Connected Accounts](api/connected_accounts/list.md) * [Sync a Connected Account](api/connected_accounts/sync.md) * [Update a Connected Account](api/connected_accounts/update.md) + * [Simulate](api/connected_accounts/simulate/README.md) + * [Simulate Connected Account Disconnection](api/connected_accounts/simulate/disconnect.md) * [Customers](api/customers/README.md) * [Create Customer Portal](api/customers/create_portal.md) * [Delete Customer Data](api/customers/delete_data.md) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index e45a1127a..3cdac79de 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -26861,6 +26861,64 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/connected_accounts/simulate", + "name": "simulate", + "namespacePath": null, + "endpoints": [ + { + "title": "Simulate Connected Account Disconnection", + "name": "disconnect", + "path": "/connected_accounts/simulate/disconnect", + "parentPath": "/connected_accounts/simulate", + "description": "Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "void", + "description": "OK" + }, + "request": { + "methods": [ + "POST" + ], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connected_account_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/connected_accounts", + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, { "path": "/customers", "name": "customers", diff --git a/docs/api/_report.md b/docs/api/_report.md index f195c26c1..a2ba69e7d 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -378,6 +378,8 @@ Items that are intentionally undocumented are not included in this section. - `device_selection_mode` - `/connected_accounts/delete` - `sync` +- `/connected_accounts/simulate/disconnect` + - `connected_account_id` - `/customers/create_portal` - `features` - `customer_data` @@ -649,6 +651,7 @@ These items are deprecated. - `/access_methods/get_related` - `/access_methods/unmanaged/get` - `/access_methods/unmanaged/list` +- `/connected_accounts/simulate/disconnect` - `/customers/create_portal` - `/customers/delete_data` - `/customers/push_data` diff --git a/docs/api/connected_accounts/simulate/README.md b/docs/api/connected_accounts/simulate/README.md new file mode 100644 index 000000000..1d8c7756e --- /dev/null +++ b/docs/api/connected_accounts/simulate/README.md @@ -0,0 +1,10 @@ +# Simulate + +## Endpoints + + +[**`/connected_accounts/simulate/disconnect`**](./disconnect.md) + +Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + diff --git a/docs/api/connected_accounts/simulate/disconnect.md b/docs/api/connected_accounts/simulate/disconnect.md new file mode 100644 index 000000000..ebbf00fb2 --- /dev/null +++ b/docs/api/connected_accounts/simulate/disconnect.md @@ -0,0 +1,30 @@ +# Simulate Connected Account Disconnection + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`connected_account_id`** *String* (Required) + +--- + + +## Response + +void + diff --git a/package-lock.json b/package-lock.json index 781cadff7..ff1a88b9e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.643.0", + "@seamapi/types": "1.644.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.643.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.643.0.tgz", - "integrity": "sha512-ShPvGJ4gqxqVrED5NYlm5ZIewfzltGXV9WI949VxwTv2iTXuEkWk/tYrybVxkVCva2L57JiapipLrdemu5p71w==", + "version": "1.644.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.644.0.tgz", + "integrity": "sha512-ISxRW57R3YiAeSGcgy4xqFI9bTqHOEiAtr0SL13/dZmLkGz4dLZO3okDkj3pqjDiRGqP67Kp82hzElGx0BVJYw==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 7291c2e57..e8706d79a 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.643.0", + "@seamapi/types": "1.644.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",