pub type ApiError {
  Discord(
    status: Int,
    code: ErrorCode,
    message: String,
    fields: List(FieldError),
    raw: String,
  )
  RateLimited(status: Int, limit: RateLimit)
  OAuth(
    status: Int,
    error: OAuthError,
    description: option.Option(String),
  )
  Opaque(
    status: Int,
    content_type: option.Option(String),
    body: String,
  )
  NotText(
    status: Int,
    content_type: option.Option(String),
    bytes: Int,
  )
  Malformed(DecodeFailure)
}

Constructors

• Discord(
    status: Int,
    code: ErrorCode,
    message: String,
    fields: List(FieldError),
    raw: String,
  )

  A 4xx or 5xx carrying a Discord error object. fields is empty unless Discord sent a nested errors object, which in practice means 50035.

• RateLimited(status: Int, limit: RateLimit)

  A 429 from Discord itself. Its body has no code and no errors.

• OAuth(
    status: Int,
    error: OAuthError,
    description: option.Option(String),
  )

  The OAuth2 token endpoints answer in RFC 6749’s shape, which shares not one field with Discord’s own.

• Opaque(
    status: Int,
    content_type: option.Option(String),
    body: String,
  )

  A non-2xx whose body was none of the above: a Cloudflare ban page, an HTML 502, an empty body. A 429 lands here when its body is not Discord’s rate-limit shape, because that is a ban and retrying extends it.

• NotText(
    status: Int,
    content_type: option.Option(String),
    bytes: Int,
  )

  The bytes were not UTF-8, so there is no text to read or parse at all. Discord answers in UTF-8 everywhere, so this came from something in between. bytes is the length, because the body cannot be shown.

• Malformed(DecodeFailure)

  A 2xx whose payload did not match the decoder.

pub type CodeClass {
  TokenFatal
  PathTokenDead
  Forbidden
  Gone
  ResourceRateLimited
  Transient
  BadRequest
  Moderation
  UnknownClass
}

Constructors

• TokenFatal

  The client’s own token is finished: stop, do not retry.

• PathTokenDead

  The webhook or interaction token in the URL is gone. Says nothing about the client’s token, which is the whole point of keeping it apart.

• Forbidden

  Permanently wrong for this caller or this input.

• Gone

  The thing addressed is not there any more. Drop it from any cache.

• ResourceRateLimited

  Rate-limit shaped, but on a resource rather than a route bucket. Do not feed these to the limiter.

• Transient

  Discord’s own wording tells you to try again.

• BadRequest

  The request has to change before it can work.

• Moderation

  The content has to change, not the call.

• UnknownClass

  A code this build does not name, and general_error, which names no class either. Discord adds codes continuously.

pub type DecodeFailure {
  DecodeFailure(error: json.DecodeError, raw: String)
}

Constructors

• DecodeFailure(error: json.DecodeError, raw: String)

pub opaque type ErrorCode

pub type FieldError {
  FieldError(
    path: List(PathSegment),
    code: String,
    message: String,
  )
}

Constructors

• FieldError(
    path: List(PathSegment),
    code: String,
    message: String,
  )

pub type OAuthError {
  InvalidRequest
  InvalidClient
  InvalidGrant
  UnauthorizedClient
  UnsupportedGrantType
  InvalidScope
  UnknownOAuthError(String)
}

Constructors

• InvalidRequest

  The request is missing a parameter, or repeats one.

• InvalidClient

  The client id or secret is wrong. Re-authenticating with them will not work either.

• InvalidGrant

  The code, refresh token or grant is expired, revoked, or was issued to another client.

• UnauthorizedClient

  This client is not allowed this grant type.

• UnsupportedGrantType

  The grant type is one the endpoint does not support.

• InvalidScope

  A scope was unknown, malformed, or wider than the one already granted.

• UnknownOAuthError(String)

  A name RFC 6749 does not define, kept as sent.

pub type PathSegment {
  Key(String)
  Index(Int)
}

Constructors

• Key(String)

• Index(Int)

pub type RateLimit {
  RateLimit(
    retry_after: Float,
    scope: limiter.Scope,
    code: option.Option(ErrorCode),
    bucket: option.Option(String),
  )
}

Constructors

• RateLimit(
    retry_after: Float,
    scope: limiter.Scope,
    code: option.Option(ErrorCode),
    bucket: option.Option(String),
  )

  Arguments

  retry_after

  Seconds, from the body. The Retry-After header is the same number rounded up to a whole second.

  scope

  The answer headers.resolve_scope gives, from the scope header, the body’s global flag and the shape of the response. is_global asks the only question most callers have.

  code

  Present when the limit is on a resource, slowmode say, not a route.

  bucket

  Absent on a global 429, which carries no bucket headers at all.

pub type Retry {
  DoNotRetry
  RetryAfter(seconds: Float)
  RetryWithBackoff
}

Constructors

• DoNotRetry

• RetryAfter(seconds: Float)

  Wait this many seconds. The caller sleeps, because glyde has no clock.

• RetryWithBackoff