Struct Client 

pub struct Client<T: Transport = UreqTransport> { /* private fields */ }

A HackerOne API client.

Generic over its Transport so it can be unit-tested with a mock and embedded with a custom HTTP stack. The default transport is UreqTransport.

use hackerone_api::Client;

let client = Client::new("my-api-identifier", "my-api-token");
let me = client.me()?;
println!("{:?}", me.username);

Implementations

impl<T: Transport> Client<T>

pub fn with_transport(base_url: impl Into<String>, transport: T) -> Self

Build a client over a custom transport (no credentials yet).

pub fn with_credentials( self, identifier: impl Into<String>, token: impl Into<String>, ) -> Self

Attach HTTP Basic credentials (builder style).

pub fn base_url(&self) -> &str

The configured base URL.

pub fn me(&self) -> Result<User>

GET /v1/me — the authenticated user.

pub fn programs(&self) -> Result<Page<Program>>

GET /v1/me/programs — programs the token can access.

pub fn program(&self, id: &str) -> Result<Program>

GET /v1/programs/{id} — one program by handle or id.

pub fn structured_scopes( &self, program_id: &str, page: Option<(u32, u32)>, ) -> Result<Page<StructuredScope>>

GET /v1/programs/{id}/structured_scopes — a program’s scopes.

pub fn reports(&self, query: &ReportQuery) -> Result<Page<Report>>

GET /v1/reports — reports, filtered by query.

pub fn report(&self, id: &str) -> Result<Report>

GET /v1/reports/{id} — one report.

pub fn create_report(&self, report: &CreateReport) -> Result<Report>

POST /v1/reports — create a report.

pub fn add_comment( &self, report_id: &str, message: &str, ) -> Result<Resource<Value>>

POST /v1/reports/{id}/activities — add a comment.

pub fn change_state( &self, report_id: &str, state: ReportState, message: Option<&str>, ) -> Result<Resource<Value>>

POST /v1/reports/{id}/state_changes — change a report’s state.

pub fn weaknesses(&self) -> Result<Page<Weakness>>

GET /v1/weaknesses — the CWE catalog.

pub fn next_page<A: DeserializeOwned + Default>( &self, page: &Page<A>, ) -> Result<Option<Page<A>>>

Fetch the next page from a next link returned by a previous call.

pub fn get_raw(&self, path: &str, query: &[(String, String)]) -> Result<Value>

Escape hatch: a raw authenticated GET returning the parsed body.

impl Client<UreqTransport>

pub fn new(identifier: impl Into<String>, token: impl Into<String>) -> Self

A client with the default transport and credentials.

pub fn anonymous() -> Self

A client with the default transport and no credentials (public reads).