API Client

class ApiClient(config: ConfigManager, concurrency: int)

Provides methods for interacting with the Jamf API, specifically fetching patch data, device information, and OS versions.

Note

All methods of the ApiClient class will raise an APIResponseError if the API call is unsuccessful.

Parameters:

• config (ConfigManager) – Instance of ConfigManager for loading and storing credentials.

• concurrency (int) – Maximum number of concurrent API requests. See concurrency in Usage docs.

async get_policies() → list[str]

Retrieves a list of patch software title IDs from the Jamf API.

Returns:

A list of software title IDs.

Return type:

list[str]

async get_summaries(policy_ids: list[str]) → list[PatchTitle]

Retrieves patch summaries asynchronously for the specified policy IDs from the Jamf API.

Parameters:

policy_ids (list[str]) – list of policy IDs to retrieve summaries for.

Returns:

list of PatchTitle objects containing patch summaries.

Return type:

list[PatchTitle]

async get_title_report_csv(title_id: str) → list[PatchDevice]

Retrieve the complete patch report for a specific software title using the CSV export endpoint.

This method fetches all device data in a single CSV request, avoiding pagination entirely.

Parameters:

title_id (str) – The software title ID to retrieve the patch report for.

Returns:

List of all PatchDevice objects for the title.

Return type:

list[PatchDevice]

Raises:

APIResponseError – If the CSV export fails or returns non-200 status.

async get_title_reports(title_ids: list[str]) → dict[str, list[PatchDevice]]

Retrieves patch reports for multiple software titles.

Processes titles sequentially to avoid overwhelming the Jamf API. Each title’s pagination is handled by the underlying stream/fetch methods.

Parameters:

title_ids (list[str]) – List of software title IDs to retrieve reports for.

Returns:

Dictionary mapping title IDs to lists of PatchDevice objects.

Return type:

dict[str, list[PatchDevice]]

async get_device_ids() → list[int]

Asynchronously fetches the list of mobile device IDs from the Jamf Pro API.

Note

This method is only called if the iOS option is passed to the CLI.

Returns:

A list of mobile device IDs.

Return type:

list[int]

async get_device_os_versions(device_ids: list[int]) → list[dict[str, str]]

Asynchronously fetches the OS version and serial number for each device ID provided.

Note

This method is only called if the iOS option is passed to the CLI.

Parameters:

device_ids (list[int]) – A list of mobile device IDs to retrieve information for.

Returns:

A list of dictionaries containing the serial numbers and OS versions.

Return type:

list[dict[str, str]]

async get_app_names(patch_titles: list[PatchTitle]) → list[dict[str, Any]]

Fetches all possible app names for each PatchTitle object provided.

Parameters:

patch_titles (list[PatchTitle]) – list of PatchTitle objects.

Returns:

list of dictionaries containing the PatchTitle title and corresponding appName

Return type:

list[dict[str, Any]]

async get_sofa_feed() → list[dict[str, str]]

Fetches iOS Data feeds from SOFA and extracts latest OS version information.

To limit the amount of possible SSL verification checks, this method utilizes a subprocess call instead.

Note

This method is only called if the iOS option is passed to the CLI.

Returns:

A list of dictionaries containing base OS versions, latest iOS versions, and release dates.

Return type:

list[dict[str, str]]

Raises:

APIResponseError – If return code from SOFA is non-zero.