Package net.ygbstudio.jbrave.api.response

package net.ygbstudio.jbrave.api.response

Sealed response model returned by the Brave Search API.

The root ApiResponse interface permits exactly one implementation per search vertical (web, image, news, video, suggest, spellcheck) plus an ErrorResponse for API errors. Implementations provide JSON (de)serialization helpers so responses can be read from, and written to, strings, files, readers, and HTTP response bodies.

Author:

Yoham Gabriel Barboza B. (YGBStudio)

Class	Description
ApiResponse	Represents a response from the Brave Search API.
ErrorResponse	Error response object that the Brave Search API sends in case the client's request results in either 404, 422, or 429 http status codes.
ImageSearchApiResponse	Represents the response from the Brave Search API for image searches.
NewsSearchApiResponse	Represents the response from the Brave Search API for news searches.
RateLimitResponse	Constructs a RateLimitResponse with the given rate limit information.
SpellcheckSearchApiResponse	Represents the response from the Brave Search API for spell check.
SuggestSearchApiResponse	Represents the response from the Brave Search API for suggestions.
VideoSearchApiResponse	Represents the response from the Brave Search API for video searches.
WebSearchApiResponse	Represents the top-level response from the Brave Search API.