ordercloud-javascript-sdk
    Preparing search index...

    Class ErrorConfigs

    Index
    As Delete Get Patch Save Validate

    • Returns this

      enables impersonation by calling the subsequent method with the stored impersonation token

      ErrorConfigs.As().List() // lists ErrorConfigs using the impersonated users' token

    • Delete an error config Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    • Validates an error config Check out the docs for more info

      Parameters

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods