#import <Foundation/Foundation.h>

/**
 @brief The error domain for BTHTTP errors
*/
extern NSString * const BTHTTPErrorDomain;

/**
 @brief Key for userInfo dictionary that contains the NSHTTPURLResponse from server when it returns an HTTP error
*/
extern NSString * const BTHTTPURLResponseKey;

/**
 @brief Key for userInfo dictionary that contains the BTJSON body of the HTTP error response
*/
extern NSString * const BTHTTPJSONResponseBodyKey;

/**
 @brief BTHTTP error codes
*/
typedef NS_ENUM(NSInteger, BTHTTPErrorCode) {
    /// Unknown error (reserved)
    BTHTTPErrorCodeUnknown = 0,
    /// The response had a Content-Type header that is not supported
    BTHTTPErrorCodeResponseContentTypeNotAcceptable,
    /// The response was a 4xx error, e.g. 422, indicating a problem with the client's request
    BTHTTPErrorCodeClientError,
    /// The response was a 403 server error
    BTHTTPErrorCodeServerError,
    /// The BTHTTP instance was missing a base URL
    BTHTTPErrorCodeMissingBaseURL,
    /// The response was a 429, indicating a rate limiting error
    BTHTTPErrorCodeRateLimitError
};