Reference

Client Modules

• Base API Client
  • BaseAPIClient
    • BaseAPIClient.concurrency
    • BaseAPIClient.set_concurrency()
    • BaseAPIClient.execute()
    • BaseAPIClient.fetch_json()
    • BaseAPIClient.fetch_batch()
    • BaseAPIClient.fetch_basic_token()
    • BaseAPIClient.create_roles()
    • BaseAPIClient.create_client()
• API Client
  • ApiClient
    • ApiClient.get_policies()
    • ApiClient.get_summaries()
    • ApiClient.get_device_ids()
    • ApiClient.get_device_os_versions()
    • ApiClient.get_sofa_feed()
• Config Manager
  • ConfigManager
    • ConfigManager.get_credential()
    • ConfigManager.set_credential()
    • ConfigManager.load_token()
    • ConfigManager.attach_client()
    • ConfigManager.create_client()
• Report Manager
  • ReportManager
    • ReportManager.calculate_ios_on_latest()
    • ReportManager.process_reports()
• Setup
  • Setup
    • Setup.completed
    • Setup.prompt_method()
    • Setup.first_run()
    • Setup.launch()
    • Setup.reset()
• Token Manager
  • TokenManager
    • TokenManager.fetch_token()
    • TokenManager.token_valid()
    • TokenManager.ensure_valid_token()
• UI Config Manager
  • UIConfigManager
    • UIConfigManager.fonts_present
    • UIConfigManager.load_ui_config()
    • UIConfigManager.download_font()
    • UIConfigManager.create_default_config()
    • UIConfigManager.get_ui_config()
    • UIConfigManager.get()
    • UIConfigManager.reset_config()
    • UIConfigManager.setup_ui()
    • UIConfigManager.configure_font()
    • UIConfigManager.configure_logo()
    • UIConfigManager.save_ui_config()
    • UIConfigManager.get_logo_path()

Report Models

• Excel Report
  • ExcelReport
    • ExcelReport.export_to_excel()
• PDF Report
  • PDFReport
    • PDFReport.get_image_ratio()
    • PDFReport.trim_transparency()
    • PDFReport.header()
    • PDFReport.add_table_header()
    • PDFReport.footer()
    • PDFReport.calculate_column_widths()
    • PDFReport.export_excel_to_pdf()

Data Models

• Jamf Client
  • JamfClient
    • JamfClient.client_id
    • JamfClient.client_secret
    • JamfClient.server
    • JamfClient.token
    • JamfClient.not_empty()
    • JamfClient.valid_url()
    • JamfClient.validate_url()
    • JamfClient.base_url
    • JamfClient.headers
  • ApiRoleModel
    • ApiRoleModel.display_name
    • ApiRoleModel.privileges
  • ApiClientModel
    • ApiClientModel.auth_scopes
    • ApiClientModel.display_name
    • ApiClientModel.enabled
    • ApiClientModel.token_lifetime
• Patch Title
  • PatchTitle
    • PatchTitle.completion_percent
    • PatchTitle.hosts_patched
    • PatchTitle.latest_version
    • PatchTitle.missing_patch
    • PatchTitle.released
    • PatchTitle.title
    • PatchTitle.total_hosts
    • PatchTitle.calculate_completion_percent
• Access Token
  • AccessToken
    • AccessToken.expires
    • AccessToken.token
    • AccessToken.is_expired
    • AccessToken.seconds_remaining

Utilities

• Animation
  • Animation
    • Animation.start()
    • Animation.stop()
    • Animation.update_msg()
    • Animation.error_handling()
• Decorators
  • check_token()
• Exceptions
  • PatcherError
    • PatcherError.log_traceback()
    • PatcherError.display_message()
    • PatcherError.format_message()
  • DataframeError
  • InstallomatorError
  • TokenFetchError
  • TokenLifetimeError
  • DirectoryCreationError
  • PlistError
  • ExportError
  • PolicyFetchError
  • SummaryFetchError
  • DeviceIDFetchError
  • DeviceOSFetchError
  • SortError
  • SofaFeedError
  • APIResponseError
  • ShellCommandError
  • SetupError
• Logging
  • setup_logger()
  • setup_child_logger()
  • handle_traceback()
  • LogMe
    • LogMe.is_debug_enabled()
    • LogMe.debug()
    • LogMe.info()
    • LogMe.warning()
    • LogMe.error()

Command Line Interface (CLI)

• Command Line Interface
  • Parameters