Interface Warning

Warning returned when the request is successful, but there are important callouts based on which API clients should take defined actions.

interface Warning {
    code: string;
    details?: string;
    message: string;
}

Properties

code: string

An warning code that identifies the type of warning that occurred.

details?: string

Additional details that can help the caller understand or address the warning.

message: string

A message that describes the warning condition in a human-readable form.