Skip to content

Commit 7ffe399

Browse files
authored
feat: Update to @seamapi/[email protected] (#983)
* feat: Update to @seamapi/[email protected] * ci: Generate docs
1 parent 67d0f16 commit 7ffe399

File tree

4 files changed

+112
-9
lines changed

4 files changed

+112
-9
lines changed

docs/api/_blueprint.json

Lines changed: 105 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52184,6 +52184,69 @@
5218452184
"name": "connectors",
5218552185
"namespacePath": "/seam/customer/v1",
5218652186
"endpoints": [
52187+
{
52188+
"title": "Get OAuth Authorization URL for Global Connector",
52189+
"name": "authorize",
52190+
"path": "/seam/customer/v1/connectors/authorize",
52191+
"parentPath": "/seam/customer/v1/connectors",
52192+
"description": "Returns the OAuth authorization URL for a global connector.\nThis endpoint only works for global connectors (connectors that support multiple customers).",
52193+
"isDeprecated": false,
52194+
"deprecationMessage": "",
52195+
"isUndocumented": true,
52196+
"undocumentedMessage": "Internal endpoint for OAuth authorization.",
52197+
"isDraft": false,
52198+
"draftMessage": "",
52199+
"response": {
52200+
"responseType": "resource",
52201+
"responseKey": "connector_authorize",
52202+
"resourceType": "unknown",
52203+
"description": "OK",
52204+
"actionAttemptType": null,
52205+
"batchResourceTypes": null
52206+
},
52207+
"request": {
52208+
"methods": [
52209+
"GET",
52210+
"POST"
52211+
],
52212+
"semanticMethod": "GET",
52213+
"preferredMethod": "POST",
52214+
"parameters": [
52215+
{
52216+
"name": "connector_name",
52217+
"description": "Connector name/type. If not provided, workspace_slug will be used as connector_name",
52218+
"isRequired": false,
52219+
"isDeprecated": false,
52220+
"deprecationMessage": "",
52221+
"isUndocumented": false,
52222+
"undocumentedMessage": "",
52223+
"isDraft": false,
52224+
"draftMessage": "",
52225+
"hasDefault": false,
52226+
"format": "string",
52227+
"jsonType": "string"
52228+
},
52229+
{
52230+
"name": "workspace_slug",
52231+
"description": "Workspace slug",
52232+
"isRequired": true,
52233+
"isDeprecated": false,
52234+
"deprecationMessage": "",
52235+
"isUndocumented": false,
52236+
"undocumentedMessage": "",
52237+
"isDraft": false,
52238+
"draftMessage": "",
52239+
"hasDefault": false,
52240+
"format": "string",
52241+
"jsonType": "string"
52242+
}
52243+
]
52244+
},
52245+
"hasPagination": false,
52246+
"authMethods": [],
52247+
"workspaceScope": "none",
52248+
"codeSamples": []
52249+
},
5218752250
{
5218852251
"title": "List Connector Types",
5218952252
"name": "connector_types",
@@ -52305,6 +52368,16 @@
5230552368
"undocumentedMessage": "",
5230652369
"isDraft": false,
5230752370
"draftMessage": ""
52371+
},
52372+
{
52373+
"name": "cloudbeds",
52374+
"description": "",
52375+
"isDeprecated": false,
52376+
"deprecationMessage": "",
52377+
"isUndocumented": false,
52378+
"undocumentedMessage": "",
52379+
"isDraft": false,
52380+
"draftMessage": ""
5230852381
}
5230952382
]
5231052383
},
@@ -52513,7 +52586,7 @@
5251352586
"parameters": [
5251452587
{
5251552588
"name": "access_token",
52516-
"description": "",
52589+
"description": "OAuth2 access token for authentication",
5251752590
"isRequired": false,
5251852591
"isDeprecated": false,
5251952592
"deprecationMessage": "",
@@ -52583,6 +52656,21 @@
5258352656
"jsonType": "array",
5258452657
"itemFormat": "string"
5258552658
},
52659+
{
52660+
"name": "is_demo",
52661+
"description": "",
52662+
"isRequired": false,
52663+
"isDeprecated": false,
52664+
"deprecationMessage": "",
52665+
"isUndocumented": false,
52666+
"undocumentedMessage": "",
52667+
"isDraft": false,
52668+
"draftMessage": "",
52669+
"hasDefault": true,
52670+
"default": true,
52671+
"format": "boolean",
52672+
"jsonType": "boolean"
52673+
},
5258652674
{
5258752675
"name": "auth_token",
5258852676
"description": "",
@@ -52636,9 +52724,22 @@
5263652724
"isDraft": false,
5263752725
"draftMessage": "",
5263852726
"hasDefault": false,
52639-
"format": "object",
52640-
"jsonType": "object",
52641-
"parameters": []
52727+
"format": "string",
52728+
"jsonType": "string"
52729+
},
52730+
{
52731+
"name": "refresh_token",
52732+
"description": "OAuth2 refresh token for token refresh",
52733+
"isRequired": false,
52734+
"isDeprecated": false,
52735+
"deprecationMessage": "",
52736+
"isUndocumented": false,
52737+
"undocumentedMessage": "",
52738+
"isDraft": false,
52739+
"draftMessage": "",
52740+
"hasDefault": false,
52741+
"format": "string",
52742+
"jsonType": "string"
5264252743
}
5264352744
]
5264452745
},

docs/api/_report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ These items are intentionally undocumented.
9696
- `/seam/customer/v1/automations/delete`: Internal endpoint for customer portals.
9797
- `/seam/customer/v1/automations/get`: Internal endpoint for customer portals.
9898
- `/seam/customer/v1/automations/update`: Internal endpoint for customer portals.
99+
- `/seam/customer/v1/connectors/authorize`: Internal endpoint for OAuth authorization.
99100
- `/seam/customer/v1/connectors/connector_types`: Internal endpoint for Console.
100101
- `/seam/customer/v1/connectors/create`: Internal endpoint for Console.
101102
- `/seam/customer/v1/connectors/delete`: Internal endpoint for Console.
@@ -633,6 +634,7 @@ These items are deprecated.
633634
- `/seam/console/v1/get_resource_locator`: `resource_locator`
634635
- `/seam/console/v1/timelines/get`: `timeline`
635636
- `/seam/customer/v1/automation_runs/list`: `automation_runs`
637+
- `/seam/customer/v1/connectors/authorize`: `connector_authorize`
636638
- `/seam/customer/v1/connectors/connector_types`: `connector_types`
637639
- `/seam/customer/v1/connectors/create`: `connector`
638640
- `/seam/customer/v1/connectors/delete`: `connector`

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.52.2",
3434
"@seamapi/smith": "^0.5.2",
35-
"@seamapi/types": "1.664.0",
35+
"@seamapi/types": "1.665.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)