Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 95 additions & 80 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -51884,12 +51884,48 @@
"name": "connectors",
"namespacePath": "/seam/customer/v1",
"endpoints": [
{
"title": "List Connector Types",
"name": "connector_types",
"path": "/seam/customer/v1/connectors/connector_types",
"parentPath": "/seam/customer/v1/connectors",
"description": "Lists all available connector types and their required instance configuration schemas.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": true,
"undocumentedMessage": "Internal endpoint for Console.",
"isDraft": false,
"draftMessage": "",
"response": {
"responseType": "resource_list",
"responseKey": "connector_types",
"resourceType": "unknown",
"description": "OK",
"actionAttemptType": null
},
"request": {
"methods": [
"GET",
"POST"
],
"semanticMethod": "GET",
"preferredMethod": "GET",
"parameters": []
},
"hasPagination": false,
"authMethods": [
"api_key",
"client_session_token"
],
"workspaceScope": "required",
"codeSamples": []
},
{
"title": "Create Connector",
"name": "create",
"path": "/seam/customer/v1/connectors/create",
"parentPath": "/seam/customer/v1/connectors",
"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.",
"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 for the same customer, it will be updated instead of creating a new one.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": true,
Expand Down Expand Up @@ -51921,82 +51957,8 @@
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "object",
"jsonType": "object",
"parameters": [
{
"name": "access_token",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "client",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": true,
"default": "seam",
"format": "string",
"jsonType": "string"
},
{
"name": "client_token",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "enterprise_id",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"jsonType": "string"
},
{
"name": "enterprise_ids",
"description": "",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "list",
"jsonType": "array",
"itemFormat": "id"
}
]
"format": "record",
"jsonType": "object"
},
{
"name": "connector_type",
Expand All @@ -52012,6 +51974,16 @@
"format": "enum",
"jsonType": "string",
"values": [
{
"name": "mock",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "mews",
"description": "",
Expand All @@ -52023,7 +51995,7 @@
"draftMessage": ""
},
{
"name": "mock",
"name": "rms",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
Expand Down Expand Up @@ -52287,7 +52259,7 @@
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "id",
"format": "string",
"jsonType": "string"
},
{
Expand All @@ -52303,7 +52275,50 @@
"hasDefault": false,
"format": "list",
"jsonType": "array",
"itemFormat": "id"
"itemFormat": "string"
},
{
"name": "client_id",
"description": "RMS client ID for authentication",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "client_password",
"description": "RMS client password for authentication",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "property_id",
"description": "Optional property ID for single-property connectors",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "object",
"jsonType": "object",
"parameters": []
}
]
},
Expand Down
2 changes: 2 additions & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ These items are intentionally undocumented.
- `/seam/customer/v1/automations/delete`: Internal endpoint for customer portals.
- `/seam/customer/v1/automations/get`: Internal endpoint for customer portals.
- `/seam/customer/v1/automations/update`: Internal endpoint for customer portals.
- `/seam/customer/v1/connectors/connector_types`: Internal endpoint for Console.
- `/seam/customer/v1/connectors/create`: Internal endpoint for Console.
- `/seam/customer/v1/connectors/delete`: Internal endpoint for Console.
- `/seam/customer/v1/connectors/list`: Internal endpoint for Console.
Expand Down Expand Up @@ -615,6 +616,7 @@ These items are deprecated.
- `/seam/console/v1/get_resource_locator`: `resource_locator`
- `/seam/console/v1/timelines/get`: `timeline`
- `/seam/customer/v1/automation_runs/list`: `automation_runs`
- `/seam/customer/v1/connectors/connector_types`: `connector_types`
- `/seam/customer/v1/connectors/create`: `connector`
- `/seam/customer/v1/connectors/delete`: `connector`
- `/seam/customer/v1/connectors/list`: `connectors`
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.51.3",
"@seamapi/smith": "^0.5.2",
"@seamapi/types": "1.642.0",
"@seamapi/types": "1.643.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading