Class ESPAPICallValidationError

Represents an API call validation error.

This class extends ESPBaseError and provides detailed error information related to validation issues encountered during API calls.

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? code label message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ESPAPICallValidationError(
        code:
            | "MISSING_GROUP_ID"
            | "MISSING_GROUP_NAME"
            | "MISSING_NODE_LIST"
            | "MISSING_NODE_ID"
            | "MISSING_SECRET_KEY"
            | "MISSING_GROUP_UPDATE_INFO"
            | "MISSING_DELETE_ENDPOINT_PARAMS"
            | "DEVICE_LIST_REFRESH_REQUIRED"
            | "NODE_UNREACHABLE"
            | "INVALID_EVENT_TYPE"
            | "MISSING_BASE_URL"
            | "INVALID_TIMEZONE_FORMAT"
            | "TIME_SERVICE_NOT_AVAILABLE"
            | "TIMEZONE_PARAM_NOT_AVAILABLE"
            | "MISSING_OTA_JOB_ID"
            | "INVALID_TS_PARAMETER"
            | "INVALID_SIMPLE_TS_PARAMETER"
            | "INVALID_TS_DATA_TYPE"
            | "INVALID_TS_PARAMETER_MIXED"
            | "MISSING_TS_TIMESTAMP"
            | "INVALID_TS_TIME_RANGE"
            | "INVALID_TS_RESULT_COUNT"
            | "INVALID_TS_TIMESTAMP"
            | "INVALID_NODE_REFERENCE"
            | "INVALID_TS_INTERVAL"
            | "INVALID_TS_AGGREGATION_INTERVAL"
            | "INVALID_TS_AGGREGATION"
            | "INVALID_TS_WEEK_START"
            | "INVALID_TS_DIFFERENTIAL"
            | "INVALID_TS_RESET_ON_NEGATIVE"
            | "INVALID_TS_TIMEZONE"
            | "MISSING_TS_AGGREGATION_INTERVAL"
            | "MISSING_AUTOMATION_NAME"
            | "MISSING_AUTOMATION_EVENTS"
            | "MISSING_AUTOMATION_ACTIONS"
            | "MISSING_LATITUDE"
            | "MISSING_LONGITUDE"
            | "MISSING_GEO_COORDINATES"
            | "INVALID_GEO_COORDINATES"
            | "MISSING_AUTOMATION_ID"
            | "MISSING_AUTOMATION_UPDATE_DETAILS"
            | "MISSING_OAUTH_ADAPTER"
            | "MISSING_IDENTITY_PROVIDER"
            | "MISSING_AUTH_URL"
            | "MISSING_REDIRECT_URL"
            | "MISSING_CLIENT_ID"
            | "INVALID_PARAMETER_VALUE",
    ): ESPAPICallValidationError

  • Constructs a new instance of ESPAPICallValidationError.

    Parameters

    • code:
          | "MISSING_GROUP_ID"
          | "MISSING_GROUP_NAME"
          | "MISSING_NODE_LIST"
          | "MISSING_NODE_ID"
          | "MISSING_SECRET_KEY"
          | "MISSING_GROUP_UPDATE_INFO"
          | "MISSING_DELETE_ENDPOINT_PARAMS"
          | "DEVICE_LIST_REFRESH_REQUIRED"
          | "NODE_UNREACHABLE"
          | "INVALID_EVENT_TYPE"
          | "MISSING_BASE_URL"
          | "INVALID_TIMEZONE_FORMAT"
          | "TIME_SERVICE_NOT_AVAILABLE"
          | "TIMEZONE_PARAM_NOT_AVAILABLE"
          | "MISSING_OTA_JOB_ID"
          | "INVALID_TS_PARAMETER"
          | "INVALID_SIMPLE_TS_PARAMETER"
          | "INVALID_TS_DATA_TYPE"
          | "INVALID_TS_PARAMETER_MIXED"
          | "MISSING_TS_TIMESTAMP"
          | "INVALID_TS_TIME_RANGE"
          | "INVALID_TS_RESULT_COUNT"
          | "INVALID_TS_TIMESTAMP"
          | "INVALID_NODE_REFERENCE"
          | "INVALID_TS_INTERVAL"
          | "INVALID_TS_AGGREGATION_INTERVAL"
          | "INVALID_TS_AGGREGATION"
          | "INVALID_TS_WEEK_START"
          | "INVALID_TS_DIFFERENTIAL"
          | "INVALID_TS_RESET_ON_NEGATIVE"
          | "INVALID_TS_TIMEZONE"
          | "MISSING_TS_AGGREGATION_INTERVAL"
          | "MISSING_AUTOMATION_NAME"
          | "MISSING_AUTOMATION_EVENTS"
          | "MISSING_AUTOMATION_ACTIONS"
          | "MISSING_LATITUDE"
          | "MISSING_LONGITUDE"
          | "MISSING_GEO_COORDINATES"
          | "INVALID_GEO_COORDINATES"
          | "MISSING_AUTOMATION_ID"
          | "MISSING_AUTOMATION_UPDATE_DETAILS"
          | "MISSING_OAUTH_ADAPTER"
          | "MISSING_IDENTITY_PROVIDER"
          | "MISSING_AUTH_URL"
          | "MISSING_REDIRECT_URL"
          | "MISSING_CLIENT_ID"
          | "INVALID_PARAMETER_VALUE"

      The error code corresponding to a specific validation error message from apiCallValidationErrorMessages.

    Returns ESPAPICallValidationError

Properties

Optionalcause

cause?: unknown

code

code: string

The specific error code associated with the error.

label

label: string

A label to classify the error type.

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods