Struct ApiClient 

pub struct ApiClient { /* private fields */ }

HTTP client for the Socket Patch API.

Supports both the authenticated Socket API (api.socket.dev) and the public proxy (patches-api.socket.dev) which serves free patches without authentication.

Implementations

impl ApiClient

pub fn new(options: ApiClientOptions) -> Self

Create a new API client from the given options.

Constructs a reqwest::Client with proper default headers (User-Agent, Accept, and optionally Authorization).

pub fn api_token(&self) -> Option<&String>

Returns the API token, if set.

pub fn org_slug(&self) -> Option<&String>

Returns the org slug, if set.

pub async fn fetch_patch( &self, org_slug: Option<&str>, uuid: &str, ) -> Result<Option<PatchResponse>, ApiError>

Fetch a patch by UUID (full details with blob content).

Returns Ok(None) when the patch is not found (404).

pub async fn search_patches_by_cve( &self, org_slug: Option<&str>, cve_id: &str, ) -> Result<SearchResponse, ApiError>

Search patches by CVE ID.

pub async fn search_patches_by_ghsa( &self, org_slug: Option<&str>, ghsa_id: &str, ) -> Result<SearchResponse, ApiError>

Search patches by GHSA ID.

pub async fn search_patches_by_package( &self, org_slug: Option<&str>, purl: &str, ) -> Result<SearchResponse, ApiError>

Search patches by package PURL.

The PURL must be a valid Package URL starting with pkg:. Examples: pkg:npm/lodash@4.17.21, pkg:pypi/django@3.2.0

pub async fn search_patches_batch( &self, org_slug: Option<&str>, purls: &[String], ) -> Result<BatchSearchResponse, ApiError>

Search patches for multiple packages (batch).

For authenticated API, uses the POST /patches/batch endpoint. For the public proxy (which cannot cache POST bodies on CDN), falls back to individual GET requests per PURL with a concurrency limit of 10.

Maximum 500 PURLs per request.

pub async fn fetch_organizations( &self, ) -> Result<Vec<OrganizationInfo>, ApiError>

Fetch organizations accessible to the current API token.

pub async fn resolve_org_slug(&self) -> Result<String, ApiError>

Resolve the org slug from the API token by querying /v0/organizations.

If there is exactly one org, returns its slug. If there are multiple, picks the first and prints a warning. If there are none, returns an error.

pub async fn fetch_blob(&self, hash: &str) -> Result<Option<Vec<u8>>, ApiError>

Fetch a blob by its SHA-256 hash.

Returns the raw binary content, or Ok(None) if not found. Uses the authenticated endpoint when token and org slug are available, otherwise falls back to the public proxy.

pub async fn fetch_diff(&self, uuid: &str) -> Result<Option<Vec<u8>>, ApiError>

Fetch a per-file diff archive (tar.gz of bsdiff deltas) by patch UUID.

Returns the raw archive bytes, or Ok(None) if not found (404). The public proxy serves these under /patch/diff/<uuid>; the authenticated API serves them under /v0/orgs/<slug>/patches/diff/<uuid>.

pub async fn fetch_package( &self, uuid: &str, ) -> Result<Option<Vec<u8>>, ApiError>

Fetch a per-package patch archive (tar.gz of patched files) by patch UUID.

Returns the raw archive bytes, or Ok(None) if not found (404).

Trait Implementations

impl Clone for ApiClient

fn clone(&self) -> ApiClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.