Enum BrazeApiError 

pub enum BrazeApiError {
    Http {
        status: StatusCode,
        body: String,
    },
    Network(Error),
    Unauthorized,
    NotFound {
        resource: String,
    },
    RateLimitExhausted,
    PaginationNotImplemented {
        endpoint: &'static str,
        detail: String,
    },
    UnexpectedApiMessage {
        endpoint: &'static str,
        message: String,
    },
    DuplicateNameInListResponse {
        endpoint: &'static str,
        name: String,
    },
}

Variants

Http

Non-success HTTP status that wasn’t already mapped to a typed variant below. Carries the body so users have something to grep.

Fields

status: StatusCode

body: String

Network(Error)

Network / decode errors from reqwest. Includes JSON parse errors (reqwest::Error::is_decode) — the message will say so.

Unauthorized

401 from Braze. Almost always a wrong / missing API key.

NotFound

404 mapped from a get-by-name endpoint. Generic Http {404} from a list endpoint stays as Http; this variant is reserved for the “this specific resource doesn’t exist” case so callers can branch on it without string matching.

Fields

resource: String

RateLimitExhausted

MAX_RETRIES of 429 in a row. The caller should slow down (or raise the configured rate limit) rather than just retrying again.

PaginationNotImplemented

A list endpoint returned a truncated page and v0.2.0 does not yet implement pagination. Returned instead of silently dropping the missing results, because for content blocks that drop would let apply create duplicates of blocks living on page 2+ (and --archive-orphans would miss them entirely).

Fields

endpoint: &'static str

detail: String

UnexpectedApiMessage

Braze returned HTTP 200 with a non-success message field that does not match any known not-found phrase. Surfaced verbatim so an unexpected server-side failure is loud instead of being silently misclassified as NotFound — the wire shapes in v0.2.0 are ASSUMED per IMPLEMENTATION.md §8.3, so any unrecognised status message is exactly the signal the operator needs to see.

Fields

endpoint: &'static str

message: String

DuplicateNameInListResponse

A list endpoint returned two entries sharing the same name. Braze is expected to enforce name uniqueness for named resources (content blocks, email templates), so this is a contract violation rather than an operator-fixable condition. We surface it loudly because the diff/apply path indexes by name — silently keeping only one of a duplicate pair would hide a resource from every subsequent list/update/archive operation.

Fields

endpoint: &'static str

name: String

Trait Implementations

impl Debug for BrazeApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BrazeApiError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for BrazeApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BrazeApiError> for Error

fn from(source: BrazeApiError) -> Self

Converts to this type from the input type.

impl From<Error> for BrazeApiError

fn from(source: Error) -> Self

Converts to this type from the input type.