Skip to content

Commit 95659ac

Browse files
authored
feat: Update to @seamapi/[email protected] (#931)
* feat: Update to @seamapi/[email protected] * ci: Generate docs
1 parent 9393171 commit 95659ac

File tree

6 files changed

+50
-105
lines changed

6 files changed

+50
-105
lines changed

docs/api/_blueprint.json

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51636,11 +51636,11 @@
5163651636
"name": "create",
5163751637
"path": "/seam/customer/v1/connectors/create",
5163851638
"parentPath": "/seam/customer/v1/connectors",
51639-
"description": "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.",
51639+
"description": "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists with the same unique_provider_resource_key, it will be updated instead of creating a new one.",
5164051640
"isDeprecated": false,
5164151641
"deprecationMessage": "",
51642-
"isUndocumented": false,
51643-
"undocumentedMessage": "",
51642+
"isUndocumented": true,
51643+
"undocumentedMessage": "Internal endpoint for Console.",
5164451644
"isDraft": false,
5164551645
"draftMessage": "",
5164651646
"response": {
@@ -51784,7 +51784,7 @@
5178451784
{
5178551785
"name": "customer_key",
5178651786
"description": "Key identifying the customer",
51787-
"isRequired": true,
51787+
"isRequired": false,
5178851788
"isDeprecated": false,
5178951789
"deprecationMessage": "",
5179051790
"isUndocumented": false,
@@ -51799,7 +51799,44 @@
5179951799
},
5180051800
"hasPagination": false,
5180151801
"authMethods": [
51802-
"api_key"
51802+
"api_key",
51803+
"client_session_token"
51804+
],
51805+
"workspaceScope": "required",
51806+
"codeSamples": []
51807+
},
51808+
{
51809+
"title": "List Connectors",
51810+
"name": "list",
51811+
"path": "/seam/customer/v1/connectors/list",
51812+
"parentPath": "/seam/customer/v1/connectors",
51813+
"description": "Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).",
51814+
"isDeprecated": false,
51815+
"deprecationMessage": "",
51816+
"isUndocumented": true,
51817+
"undocumentedMessage": "Internal endpoint for Console.",
51818+
"isDraft": false,
51819+
"draftMessage": "",
51820+
"response": {
51821+
"responseType": "resource_list",
51822+
"responseKey": "connectors",
51823+
"resourceType": "unknown",
51824+
"description": "OK",
51825+
"actionAttemptType": null
51826+
},
51827+
"request": {
51828+
"methods": [
51829+
"GET",
51830+
"POST"
51831+
],
51832+
"semanticMethod": "GET",
51833+
"preferredMethod": "GET",
51834+
"parameters": []
51835+
},
51836+
"hasPagination": false,
51837+
"authMethods": [
51838+
"api_key",
51839+
"client_session_token"
5180351840
],
5180451841
"workspaceScope": "required",
5180551842
"codeSamples": []

docs/api/_report.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ These items are intentionally undocumented.
9191
- `/seam/customer/v1/automations/delete`: Internal endpoint for customer portals.
9292
- `/seam/customer/v1/automations/get`: Internal endpoint for customer portals.
9393
- `/seam/customer/v1/automations/update`: Internal endpoint for customer portals.
94+
- `/seam/customer/v1/connectors/create`: Internal endpoint for Console.
95+
- `/seam/customer/v1/connectors/list`: Internal endpoint for Console.
9496
- `/seam/customer/v1/events/list`: Internal endpoint for customer portals.
9597
- `/seam/customer/v1/portals/get`: Internal endpoint for customer portals.
9698
- `/seam/customer/v1/reservations/get`: Internal endpoint for customer portals.
@@ -597,6 +599,7 @@ These items are deprecated.
597599
- `/seam/console/v1/timelines/get`: `timeline`
598600
- `/seam/customer/v1/automation_runs/list`: `automation_runs`
599601
- `/seam/customer/v1/connectors/create`: `connector`
602+
- `/seam/customer/v1/connectors/list`: `connectors`
600603
- `/seam/customer/v1/connectors/sync`: `connector_sync`
601604
- `/seam/customer/v1/portals/get`: `customer_portal`
602605
- `/seam/customer/v1/reservations/get`: `reservation`
@@ -632,7 +635,6 @@ These items are deprecated.
632635
- `/instant_keys/get`
633636
- `/instant_keys/list`
634637
- `/locks/get`
635-
- `/seam/customer/v1/connectors/create`
636638
- `/seam/customer/v1/connectors/sync`
637639
- `/seam/customer/v1/spaces/create`
638640
- `/seam/customer/v1/spaces/list`

docs/api/seam/customer/v1/connectors/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
## Endpoints
44

55

6-
[**`/seam/customer/v1/connectors/create`**](./create.md)
7-
8-
Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.
9-
10-
116
[**`/seam/customer/v1/connectors/sync`**](./sync.md)
127

138
Triggers an immediate data sync for a connector by scheduling a polling task.

docs/api/seam/customer/v1/connectors/create.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

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.623.0",
35+
"@seamapi/types": "1.624.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)