Skip to content

Commit 801b0ee

Browse files
seambotseambot
authored
feat: Update to @seamapi/types@1.712.0 (#1033)
* feat: Update to @seamapi/types@1.712.0 * ci: Generate docs
1 parent 8f3ca89 commit 801b0ee

4 files changed

Lines changed: 360 additions & 5 deletions

File tree

‎docs/api/_blueprint.json‎

Lines changed: 351 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126664,6 +126664,357 @@
126664126664
"format": "record",
126665126665
"jsonType": "object"
126666126666
},
126667+
{
126668+
"name": "connected_account_errors",
126669+
"description": "Errors associated with the connected account.",
126670+
"isDeprecated": false,
126671+
"deprecationMessage": "",
126672+
"isUndocumented": false,
126673+
"undocumentedMessage": "",
126674+
"isDraft": false,
126675+
"draftMessage": "",
126676+
"propertyGroupKey": null,
126677+
"format": "list",
126678+
"jsonType": "array",
126679+
"itemFormat": "discriminated_object",
126680+
"discriminator": "error_code",
126681+
"variantGroups": [],
126682+
"variants": [
126683+
{
126684+
"variantGroupKey": null,
126685+
"properties": [
126686+
{
126687+
"name": "created_at",
126688+
"description": "Date and time at which Seam created the error.",
126689+
"isDeprecated": false,
126690+
"deprecationMessage": "",
126691+
"isUndocumented": false,
126692+
"undocumentedMessage": "",
126693+
"isDraft": false,
126694+
"draftMessage": "",
126695+
"propertyGroupKey": null,
126696+
"format": "datetime",
126697+
"jsonType": "string"
126698+
},
126699+
{
126700+
"name": "error_code",
126701+
"description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
126702+
"isDeprecated": false,
126703+
"deprecationMessage": "",
126704+
"isUndocumented": false,
126705+
"undocumentedMessage": "",
126706+
"isDraft": false,
126707+
"draftMessage": "",
126708+
"propertyGroupKey": null,
126709+
"format": "enum",
126710+
"jsonType": "string",
126711+
"values": [
126712+
{
126713+
"name": "account_disconnected",
126714+
"description": "",
126715+
"isDeprecated": false,
126716+
"deprecationMessage": "",
126717+
"isUndocumented": false,
126718+
"undocumentedMessage": "",
126719+
"isDraft": false,
126720+
"draftMessage": ""
126721+
}
126722+
]
126723+
},
126724+
{
126725+
"name": "is_bridge_error",
126726+
"description": "Indicates whether the error is related to [Seam Bridge](../capability-guides/seam-bridge.md).",
126727+
"isDeprecated": false,
126728+
"deprecationMessage": "",
126729+
"isUndocumented": false,
126730+
"undocumentedMessage": "",
126731+
"isDraft": false,
126732+
"draftMessage": "",
126733+
"propertyGroupKey": null,
126734+
"format": "boolean",
126735+
"jsonType": "boolean"
126736+
},
126737+
{
126738+
"name": "is_connected_account_error",
126739+
"description": "Indicates whether the error is related specifically to the connected account.",
126740+
"isDeprecated": false,
126741+
"deprecationMessage": "",
126742+
"isUndocumented": false,
126743+
"undocumentedMessage": "",
126744+
"isDraft": false,
126745+
"draftMessage": "",
126746+
"propertyGroupKey": null,
126747+
"format": "boolean",
126748+
"jsonType": "boolean"
126749+
},
126750+
{
126751+
"name": "message",
126752+
"description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
126753+
"isDeprecated": false,
126754+
"deprecationMessage": "",
126755+
"isUndocumented": false,
126756+
"undocumentedMessage": "",
126757+
"isDraft": false,
126758+
"draftMessage": "",
126759+
"propertyGroupKey": null,
126760+
"format": "string",
126761+
"jsonType": "string"
126762+
}
126763+
],
126764+
"description": "Indicates that the account is disconnected."
126765+
},
126766+
{
126767+
"variantGroupKey": null,
126768+
"properties": [
126769+
{
126770+
"name": "created_at",
126771+
"description": "Date and time at which Seam created the error.",
126772+
"isDeprecated": false,
126773+
"deprecationMessage": "",
126774+
"isUndocumented": false,
126775+
"undocumentedMessage": "",
126776+
"isDraft": false,
126777+
"draftMessage": "",
126778+
"propertyGroupKey": null,
126779+
"format": "datetime",
126780+
"jsonType": "string"
126781+
},
126782+
{
126783+
"name": "error_code",
126784+
"description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
126785+
"isDeprecated": false,
126786+
"deprecationMessage": "",
126787+
"isUndocumented": false,
126788+
"undocumentedMessage": "",
126789+
"isDraft": false,
126790+
"draftMessage": "",
126791+
"propertyGroupKey": null,
126792+
"format": "enum",
126793+
"jsonType": "string",
126794+
"values": [
126795+
{
126796+
"name": "bridge_disconnected",
126797+
"description": "",
126798+
"isDeprecated": false,
126799+
"deprecationMessage": "",
126800+
"isUndocumented": false,
126801+
"undocumentedMessage": "",
126802+
"isDraft": false,
126803+
"draftMessage": ""
126804+
}
126805+
]
126806+
},
126807+
{
126808+
"name": "is_bridge_error",
126809+
"description": "Indicates whether the error is related to [Seam Bridge](../capability-guides/seam-bridge.md).",
126810+
"isDeprecated": false,
126811+
"deprecationMessage": "",
126812+
"isUndocumented": false,
126813+
"undocumentedMessage": "",
126814+
"isDraft": false,
126815+
"draftMessage": "",
126816+
"propertyGroupKey": null,
126817+
"format": "boolean",
126818+
"jsonType": "boolean"
126819+
},
126820+
{
126821+
"name": "is_connected_account_error",
126822+
"description": "Indicates whether the error is related specifically to the connected account.",
126823+
"isDeprecated": false,
126824+
"deprecationMessage": "",
126825+
"isUndocumented": false,
126826+
"undocumentedMessage": "",
126827+
"isDraft": false,
126828+
"draftMessage": "",
126829+
"propertyGroupKey": null,
126830+
"format": "boolean",
126831+
"jsonType": "boolean"
126832+
},
126833+
{
126834+
"name": "message",
126835+
"description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
126836+
"isDeprecated": false,
126837+
"deprecationMessage": "",
126838+
"isUndocumented": false,
126839+
"undocumentedMessage": "",
126840+
"isDraft": false,
126841+
"draftMessage": "",
126842+
"propertyGroupKey": null,
126843+
"format": "string",
126844+
"jsonType": "string"
126845+
}
126846+
],
126847+
"description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)."
126848+
},
126849+
{
126850+
"variantGroupKey": null,
126851+
"properties": [
126852+
{
126853+
"name": "created_at",
126854+
"description": "Date and time at which Seam created the error.",
126855+
"isDeprecated": false,
126856+
"deprecationMessage": "",
126857+
"isUndocumented": false,
126858+
"undocumentedMessage": "",
126859+
"isDraft": false,
126860+
"draftMessage": "",
126861+
"propertyGroupKey": null,
126862+
"format": "datetime",
126863+
"jsonType": "string"
126864+
},
126865+
{
126866+
"name": "error_code",
126867+
"description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
126868+
"isDeprecated": false,
126869+
"deprecationMessage": "",
126870+
"isUndocumented": false,
126871+
"undocumentedMessage": "",
126872+
"isDraft": false,
126873+
"draftMessage": "",
126874+
"propertyGroupKey": null,
126875+
"format": "enum",
126876+
"jsonType": "string",
126877+
"values": [
126878+
{
126879+
"name": "salto_ks_subscription_limit_exceeded",
126880+
"description": "",
126881+
"isDeprecated": false,
126882+
"deprecationMessage": "",
126883+
"isUndocumented": false,
126884+
"undocumentedMessage": "",
126885+
"isDraft": false,
126886+
"draftMessage": ""
126887+
}
126888+
]
126889+
},
126890+
{
126891+
"name": "is_bridge_error",
126892+
"description": "Indicates whether the error is related to [Seam Bridge](../capability-guides/seam-bridge.md).",
126893+
"isDeprecated": false,
126894+
"deprecationMessage": "",
126895+
"isUndocumented": false,
126896+
"undocumentedMessage": "",
126897+
"isDraft": false,
126898+
"draftMessage": "",
126899+
"propertyGroupKey": null,
126900+
"format": "boolean",
126901+
"jsonType": "boolean"
126902+
},
126903+
{
126904+
"name": "is_connected_account_error",
126905+
"description": "Indicates whether the error is related specifically to the connected account.",
126906+
"isDeprecated": false,
126907+
"deprecationMessage": "",
126908+
"isUndocumented": false,
126909+
"undocumentedMessage": "",
126910+
"isDraft": false,
126911+
"draftMessage": "",
126912+
"propertyGroupKey": null,
126913+
"format": "boolean",
126914+
"jsonType": "boolean"
126915+
},
126916+
{
126917+
"name": "message",
126918+
"description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
126919+
"isDeprecated": false,
126920+
"deprecationMessage": "",
126921+
"isUndocumented": false,
126922+
"undocumentedMessage": "",
126923+
"isDraft": false,
126924+
"draftMessage": "",
126925+
"propertyGroupKey": null,
126926+
"format": "string",
126927+
"jsonType": "string"
126928+
},
126929+
{
126930+
"name": "salto_ks_metadata",
126931+
"description": "Salto KS metadata associated with the connected account that has an error.",
126932+
"isDeprecated": false,
126933+
"deprecationMessage": "",
126934+
"isUndocumented": false,
126935+
"undocumentedMessage": "",
126936+
"isDraft": false,
126937+
"draftMessage": "",
126938+
"propertyGroupKey": null,
126939+
"format": "object",
126940+
"jsonType": "object",
126941+
"propertyGroups": [],
126942+
"properties": [
126943+
{
126944+
"name": "sites",
126945+
"description": "Salto sites associated with the connected account that has an error.",
126946+
"isDeprecated": false,
126947+
"deprecationMessage": "",
126948+
"isUndocumented": false,
126949+
"undocumentedMessage": "",
126950+
"isDraft": false,
126951+
"draftMessage": "",
126952+
"propertyGroupKey": null,
126953+
"format": "list",
126954+
"jsonType": "array",
126955+
"itemFormat": "object",
126956+
"itemProperties": [
126957+
{
126958+
"name": "site_id",
126959+
"description": "ID of a Salto site associated with the connected account that has an error.",
126960+
"isDeprecated": false,
126961+
"deprecationMessage": "",
126962+
"isUndocumented": false,
126963+
"undocumentedMessage": "",
126964+
"isDraft": false,
126965+
"draftMessage": "",
126966+
"propertyGroupKey": null,
126967+
"format": "string",
126968+
"jsonType": "string"
126969+
},
126970+
{
126971+
"name": "site_name",
126972+
"description": "Name of a Salto site associated with the connected account that has an error.",
126973+
"isDeprecated": false,
126974+
"deprecationMessage": "",
126975+
"isUndocumented": false,
126976+
"undocumentedMessage": "",
126977+
"isDraft": false,
126978+
"draftMessage": "",
126979+
"propertyGroupKey": null,
126980+
"format": "string",
126981+
"jsonType": "string"
126982+
},
126983+
{
126984+
"name": "site_user_subscription_limit",
126985+
"description": "Subscription limit of site users for a Salto site associated with the connected account that has an error.",
126986+
"isDeprecated": false,
126987+
"deprecationMessage": "",
126988+
"isUndocumented": false,
126989+
"undocumentedMessage": "",
126990+
"isDraft": false,
126991+
"draftMessage": "",
126992+
"propertyGroupKey": null,
126993+
"format": "number",
126994+
"jsonType": "number"
126995+
},
126996+
{
126997+
"name": "subscribed_site_user_count",
126998+
"description": "Count of subscribed site users for a Salto site associated with the connected account that has an error.",
126999+
"isDeprecated": false,
127000+
"deprecationMessage": "",
127001+
"isUndocumented": false,
127002+
"undocumentedMessage": "",
127003+
"isDraft": false,
127004+
"draftMessage": "",
127005+
"propertyGroupKey": null,
127006+
"format": "number",
127007+
"jsonType": "number"
127008+
}
127009+
]
127010+
}
127011+
]
127012+
}
127013+
],
127014+
"description": "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
127015+
}
127016+
]
127017+
},
126667127018
{
126668127019
"name": "connected_account_id",
126669127020
"description": "ID of the affected [connected account](../core-concepts/connected-accounts/README.md).",

‎docs/api/connected_accounts/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -731,6 +731,10 @@ A [connected account](../../core-concepts/connected-accounts/README.md) was disc
731731

732732
Custom metadata of the connected account, present when connected_account_id is provided.
733733

734+
<strong><code>connected_account_errors</code></strong> <i>List</i> <i>of Objects</i>
735+
736+
Errors associated with the connected account.
737+
734738
<strong><code>connected_account_id</code></strong> <i>UUID</i>
735739

736740
ID of the affected [connected account](../../core-concepts/connected-accounts/README.md).

‎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.53.0",
3434
"@seamapi/smith": "^0.5.2",
35-
"@seamapi/types": "1.711.0",
35+
"@seamapi/types": "1.712.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)