Skip to content

Commit 15ba429

Browse files
seambotseambot
authored
feat: Update to @seamapi/types@1.643.0 (#953)
* feat: Update to @seamapi/types@1.643.0 * ci: Generate docs
1 parent 54f723c commit 15ba429

File tree

4 files changed

+102
-85
lines changed

4 files changed

+102
-85
lines changed

‎docs/api/_blueprint.json‎

Lines changed: 95 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -51884,12 +51884,48 @@
5188451884
"name": "connectors",
5188551885
"namespacePath": "/seam/customer/v1",
5188651886
"endpoints": [
51887+
{
51888+
"title": "List Connector Types",
51889+
"name": "connector_types",
51890+
"path": "/seam/customer/v1/connectors/connector_types",
51891+
"parentPath": "/seam/customer/v1/connectors",
51892+
"description": "Lists all available connector types and their required instance configuration schemas.",
51893+
"isDeprecated": false,
51894+
"deprecationMessage": "",
51895+
"isUndocumented": true,
51896+
"undocumentedMessage": "Internal endpoint for Console.",
51897+
"isDraft": false,
51898+
"draftMessage": "",
51899+
"response": {
51900+
"responseType": "resource_list",
51901+
"responseKey": "connector_types",
51902+
"resourceType": "unknown",
51903+
"description": "OK",
51904+
"actionAttemptType": null
51905+
},
51906+
"request": {
51907+
"methods": [
51908+
"GET",
51909+
"POST"
51910+
],
51911+
"semanticMethod": "GET",
51912+
"preferredMethod": "GET",
51913+
"parameters": []
51914+
},
51915+
"hasPagination": false,
51916+
"authMethods": [
51917+
"api_key",
51918+
"client_session_token"
51919+
],
51920+
"workspaceScope": "required",
51921+
"codeSamples": []
51922+
},
5188751923
{
5188851924
"title": "Create Connector",
5188951925
"name": "create",
5189051926
"path": "/seam/customer/v1/connectors/create",
5189151927
"parentPath": "/seam/customer/v1/connectors",
51892-
"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.",
51928+
"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.",
5189351929
"isDeprecated": false,
5189451930
"deprecationMessage": "",
5189551931
"isUndocumented": true,
@@ -51921,82 +51957,8 @@
5192151957
"isDraft": false,
5192251958
"draftMessage": "",
5192351959
"hasDefault": false,
51924-
"format": "object",
51925-
"jsonType": "object",
51926-
"parameters": [
51927-
{
51928-
"name": "access_token",
51929-
"description": "",
51930-
"isRequired": false,
51931-
"isDeprecated": false,
51932-
"deprecationMessage": "",
51933-
"isUndocumented": false,
51934-
"undocumentedMessage": "",
51935-
"isDraft": false,
51936-
"draftMessage": "",
51937-
"hasDefault": false,
51938-
"format": "string",
51939-
"jsonType": "string"
51940-
},
51941-
{
51942-
"name": "client",
51943-
"description": "",
51944-
"isRequired": false,
51945-
"isDeprecated": false,
51946-
"deprecationMessage": "",
51947-
"isUndocumented": false,
51948-
"undocumentedMessage": "",
51949-
"isDraft": false,
51950-
"draftMessage": "",
51951-
"hasDefault": true,
51952-
"default": "seam",
51953-
"format": "string",
51954-
"jsonType": "string"
51955-
},
51956-
{
51957-
"name": "client_token",
51958-
"description": "",
51959-
"isRequired": false,
51960-
"isDeprecated": false,
51961-
"deprecationMessage": "",
51962-
"isUndocumented": false,
51963-
"undocumentedMessage": "",
51964-
"isDraft": false,
51965-
"draftMessage": "",
51966-
"hasDefault": false,
51967-
"format": "string",
51968-
"jsonType": "string"
51969-
},
51970-
{
51971-
"name": "enterprise_id",
51972-
"description": "",
51973-
"isRequired": false,
51974-
"isDeprecated": false,
51975-
"deprecationMessage": "",
51976-
"isUndocumented": false,
51977-
"undocumentedMessage": "",
51978-
"isDraft": false,
51979-
"draftMessage": "",
51980-
"hasDefault": false,
51981-
"format": "id",
51982-
"jsonType": "string"
51983-
},
51984-
{
51985-
"name": "enterprise_ids",
51986-
"description": "",
51987-
"isRequired": false,
51988-
"isDeprecated": false,
51989-
"deprecationMessage": "",
51990-
"isUndocumented": false,
51991-
"undocumentedMessage": "",
51992-
"isDraft": false,
51993-
"draftMessage": "",
51994-
"hasDefault": false,
51995-
"format": "list",
51996-
"jsonType": "array",
51997-
"itemFormat": "id"
51998-
}
51999-
]
51960+
"format": "record",
51961+
"jsonType": "object"
5200051962
},
5200151963
{
5200251964
"name": "connector_type",
@@ -52012,6 +51974,16 @@
5201251974
"format": "enum",
5201351975
"jsonType": "string",
5201451976
"values": [
51977+
{
51978+
"name": "mock",
51979+
"description": "",
51980+
"isDeprecated": false,
51981+
"deprecationMessage": "",
51982+
"isUndocumented": false,
51983+
"undocumentedMessage": "",
51984+
"isDraft": false,
51985+
"draftMessage": ""
51986+
},
5201551987
{
5201651988
"name": "mews",
5201751989
"description": "",
@@ -52023,7 +51995,7 @@
5202351995
"draftMessage": ""
5202451996
},
5202551997
{
52026-
"name": "mock",
51998+
"name": "rms",
5202751999
"description": "",
5202852000
"isDeprecated": false,
5202952001
"deprecationMessage": "",
@@ -52287,7 +52259,7 @@
5228752259
"isDraft": false,
5228852260
"draftMessage": "",
5228952261
"hasDefault": false,
52290-
"format": "id",
52262+
"format": "string",
5229152263
"jsonType": "string"
5229252264
},
5229352265
{
@@ -52303,7 +52275,50 @@
5230352275
"hasDefault": false,
5230452276
"format": "list",
5230552277
"jsonType": "array",
52306-
"itemFormat": "id"
52278+
"itemFormat": "string"
52279+
},
52280+
{
52281+
"name": "client_id",
52282+
"description": "RMS client ID for authentication",
52283+
"isRequired": false,
52284+
"isDeprecated": false,
52285+
"deprecationMessage": "",
52286+
"isUndocumented": false,
52287+
"undocumentedMessage": "",
52288+
"isDraft": false,
52289+
"draftMessage": "",
52290+
"hasDefault": false,
52291+
"format": "string",
52292+
"jsonType": "string"
52293+
},
52294+
{
52295+
"name": "client_password",
52296+
"description": "RMS client password for authentication",
52297+
"isRequired": false,
52298+
"isDeprecated": false,
52299+
"deprecationMessage": "",
52300+
"isUndocumented": false,
52301+
"undocumentedMessage": "",
52302+
"isDraft": false,
52303+
"draftMessage": "",
52304+
"hasDefault": false,
52305+
"format": "string",
52306+
"jsonType": "string"
52307+
},
52308+
{
52309+
"name": "property_id",
52310+
"description": "Optional property ID for single-property connectors",
52311+
"isRequired": false,
52312+
"isDeprecated": false,
52313+
"deprecationMessage": "",
52314+
"isUndocumented": false,
52315+
"undocumentedMessage": "",
52316+
"isDraft": false,
52317+
"draftMessage": "",
52318+
"hasDefault": false,
52319+
"format": "object",
52320+
"jsonType": "object",
52321+
"parameters": []
5230752322
}
5230852323
]
5230952324
},

‎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/connector_types`: Internal endpoint for Console.
99100
- `/seam/customer/v1/connectors/create`: Internal endpoint for Console.
100101
- `/seam/customer/v1/connectors/delete`: Internal endpoint for Console.
101102
- `/seam/customer/v1/connectors/list`: Internal endpoint for Console.
@@ -615,6 +616,7 @@ These items are deprecated.
615616
- `/seam/console/v1/get_resource_locator`: `resource_locator`
616617
- `/seam/console/v1/timelines/get`: `timeline`
617618
- `/seam/customer/v1/automation_runs/list`: `automation_runs`
619+
- `/seam/customer/v1/connectors/connector_types`: `connector_types`
618620
- `/seam/customer/v1/connectors/create`: `connector`
619621
- `/seam/customer/v1/connectors/delete`: `connector`
620622
- `/seam/customer/v1/connectors/list`: `connectors`

‎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.642.0",
35+
"@seamapi/types": "1.643.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)