Structured error types for Fivetran API responses.

All API functions in Fivetrex return {:error, %Fivetrex.Error{}} on failure. This struct provides structured information about what went wrong, making it easy to pattern match on error types and handle them appropriately.

Error Types

The :type field indicates the category of error:

• :unauthorized - Invalid or missing API credentials (HTTP 401)
• :not_found - The requested resource does not exist (HTTP 404)
• :rate_limited - Too many requests; check :retry_after (HTTP 429)
• :server_error - Fivetran server error (HTTP 5xx)
• :unknown - Unexpected or unclassified error

Fields

• :type - The error category (see above)
• :message - Human-readable error message from Fivetran
• :status - The HTTP status code (if applicable)
• :retry_after - Seconds to wait before retrying (for :rate_limited errors)

Examples

Pattern matching on error types:

case Fivetrex.Connectors.get(client, "invalid_id") do
  {:ok, connector} ->
    # Handle success
    connector

  {:error, %Fivetrex.Error{type: :not_found}} ->
    # Resource doesn't exist
    nil

  {:error, %Fivetrex.Error{type: :unauthorized}} ->
    # Invalid credentials - re-authenticate
    raise "Invalid API credentials"

  {:error, %Fivetrex.Error{type: :rate_limited, retry_after: seconds}} ->
    # Wait and retry
    Process.sleep(seconds * 1000)
    Fivetrex.Connectors.get(client, "invalid_id")

  {:error, %Fivetrex.Error{type: :server_error, status: status}} ->
    # Log and maybe retry
    Logger.error("Fivetran server error: #{status}")
    {:error, :server_error}

  {:error, %Fivetrex.Error{message: message}} ->
    # Catch-all for other errors
    {:error, message}
end

Exception Behavior

Fivetrex.Error implements the Exception behaviour, so you can raise it:

{:error, error} = Fivetrex.Connectors.get(client, "invalid")
raise error
# => ** (Fivetrex.Error) Resource not found