@seamapi/types 1.711.0 → 1.712.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14885,6 +14885,148 @@ export default {
14885
14885
  description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
14886
14886
  type: 'object',
14887
14887
  },
14888
+ connected_account_errors: {
14889
+ description: 'Errors associated with the connected account.',
14890
+ items: {
14891
+ discriminator: { propertyName: 'error_code' },
14892
+ oneOf: [
14893
+ {
14894
+ description: 'Indicates that the account is disconnected.',
14895
+ properties: {
14896
+ created_at: {
14897
+ description: 'Date and time at which Seam created the error.',
14898
+ format: 'date-time',
14899
+ type: 'string',
14900
+ },
14901
+ error_code: {
14902
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14903
+ enum: ['account_disconnected'],
14904
+ type: 'string',
14905
+ },
14906
+ is_bridge_error: {
14907
+ description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
14908
+ type: 'boolean',
14909
+ },
14910
+ is_connected_account_error: {
14911
+ description: 'Indicates whether the error is related specifically to the connected account.',
14912
+ type: 'boolean',
14913
+ },
14914
+ message: {
14915
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
14916
+ type: 'string',
14917
+ },
14918
+ },
14919
+ required: ['created_at', 'message', 'error_code'],
14920
+ type: 'object',
14921
+ },
14922
+ {
14923
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), 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](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
14924
+ properties: {
14925
+ created_at: {
14926
+ description: 'Date and time at which Seam created the error.',
14927
+ format: 'date-time',
14928
+ type: 'string',
14929
+ },
14930
+ error_code: {
14931
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14932
+ enum: ['bridge_disconnected'],
14933
+ type: 'string',
14934
+ },
14935
+ is_bridge_error: {
14936
+ description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
14937
+ type: 'boolean',
14938
+ },
14939
+ is_connected_account_error: {
14940
+ description: 'Indicates whether the error is related specifically to the connected account.',
14941
+ type: 'boolean',
14942
+ },
14943
+ message: {
14944
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
14945
+ type: 'string',
14946
+ },
14947
+ },
14948
+ required: ['created_at', 'message', 'error_code'],
14949
+ type: 'object',
14950
+ },
14951
+ {
14952
+ 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.',
14953
+ properties: {
14954
+ created_at: {
14955
+ description: 'Date and time at which Seam created the error.',
14956
+ format: 'date-time',
14957
+ type: 'string',
14958
+ },
14959
+ error_code: {
14960
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14961
+ enum: ['salto_ks_subscription_limit_exceeded'],
14962
+ type: 'string',
14963
+ },
14964
+ is_bridge_error: {
14965
+ description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
14966
+ type: 'boolean',
14967
+ },
14968
+ is_connected_account_error: {
14969
+ description: 'Indicates whether the error is related specifically to the connected account.',
14970
+ type: 'boolean',
14971
+ },
14972
+ message: {
14973
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
14974
+ type: 'string',
14975
+ },
14976
+ salto_ks_metadata: {
14977
+ description: 'Salto KS metadata associated with the connected account that has an error.',
14978
+ properties: {
14979
+ sites: {
14980
+ description: 'Salto sites associated with the connected account that has an error.',
14981
+ items: {
14982
+ description: 'Salto site associated with the connected account that has an error.',
14983
+ properties: {
14984
+ site_id: {
14985
+ description: 'ID of a Salto site associated with the connected account that has an error.',
14986
+ type: 'string',
14987
+ },
14988
+ site_name: {
14989
+ description: 'Name of a Salto site associated with the connected account that has an error.',
14990
+ type: 'string',
14991
+ },
14992
+ site_user_subscription_limit: {
14993
+ description: 'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
14994
+ minimum: 0,
14995
+ type: 'integer',
14996
+ },
14997
+ subscribed_site_user_count: {
14998
+ description: 'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
14999
+ minimum: 0,
15000
+ type: 'integer',
15001
+ },
15002
+ },
15003
+ required: [
15004
+ 'site_id',
15005
+ 'site_name',
15006
+ 'subscribed_site_user_count',
15007
+ 'site_user_subscription_limit',
15008
+ ],
15009
+ type: 'object',
15010
+ },
15011
+ type: 'array',
15012
+ },
15013
+ },
15014
+ required: ['sites'],
15015
+ type: 'object',
15016
+ },
15017
+ },
15018
+ required: [
15019
+ 'created_at',
15020
+ 'message',
15021
+ 'error_code',
15022
+ 'salto_ks_metadata',
15023
+ ],
15024
+ type: 'object',
15025
+ },
15026
+ ],
15027
+ },
15028
+ type: 'array',
15029
+ },
14888
15030
  connected_account_id: {
14889
15031
  description: 'ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
14890
15032
  format: 'uuid',
@@ -14922,6 +15064,7 @@ export default {
14922
15064
  'occurred_at',
14923
15065
  'connected_account_id',
14924
15066
  'event_type',
15067
+ 'connected_account_errors',
14925
15068
  ],
14926
15069
  type: 'object',
14927
15070
  'x-route-path': '/connected_accounts',