Module: Sophos::Client::Partner

Included in:
Sophos::Client
Defined in:
lib/sophos/client/partner.rb

Overview

Sophos Partner API module, providing access to tenants, roles, admins, and billing usage data.

See Also:

Instance Method Summary collapse

Instance Method Details

#admin_role_assignment(admin_id, assignment_id, params = {}) ⇒ Hash

Retrieve a specific role assignment for an admin by assignment ID.

Parameters:

  • admin_id (String) —

    Admin ID

  • assignment_id (String) —

    Role assignment ID

  • params (Hash) (defaults to: {}) —

    Optional query parameters

Returns:

  • (Hash) —

    Details of the specific role assignment

See Also:



38
39
40
 
# File 'lib/sophos/client/partner.rb', line 38

def admin_role_assignment(admin_id, assignment_id, params = {})
  get(Helper::partner_url("admins/#{admin_id}/role-assignments/#{assignment_id}"), params)
end

#admin_role_assignments(admin_id, params = {}) ⇒ Hash

Retrieve the role assignments for a given admin.

Parameters:

  • admin_id (String) —

    Admin ID for whom role assignments are requested

  • params (Hash) (defaults to: {}) —

    Optional query parameters

Returns:

  • (Hash) —

    List of role assignments

See Also:



28
29
30
 
# File 'lib/sophos/client/partner.rb', line 28

def admin_role_assignments(admin_id, params = {})
  get(Helper::partner_url("admins/#{admin_id}/role-assignments"), params)
end

#billing_usage(year, month, params = {}) ⇒ Hash

Retrieve the billing usage report for a specific year and month.

Parameters:

  • year (Integer) —

    Year of the billing report (e.g., 2025)

  • month (Integer) —

    Month of the billing report (e.g., 1 for January)

  • params (Hash) (defaults to: {}) —

    Optional query parameters

Returns:

  • (Hash) —

    Billing usage data for the specified month

See Also:



56
57
58
 
# File 'lib/sophos/client/partner.rb', line 56

def billing_usage(year, month, params = {})
  get_paged(Helper::partner_url("billing/usage/#{year}/#{month}"), params)
end

#permission_sets(params = {}) ⇒ Array<Hash>

Retrieve the list of permission sets.

Parameters:

  • params (Hash) (defaults to: {}) —

    Optional query parameters

Returns:

  • (Array<Hash>) —

    List of permission sets

See Also:



46
47
48
 
# File 'lib/sophos/client/partner.rb', line 46

def permission_sets(params = {})
  get(Helper::partner_url('roles/permission-sets'), params)
end