Objects List

Reporter objects.

Instances of RestObject and RestManager corresponding to API models and their managers respectively.

class reporter.objects.Activity(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ActivityManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.Announcement(reporter, attrs)

Bases: RestObject

Placeholder type for announcements.

The announcements endpoint does not return a resource object; the manager’s AnnouncementManager.send() returns a plain dict instead.

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.AnnouncementManager(reporter, parent=None)

Bases: RestManager

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
send(attrs, **kwargs)

Send an announcement.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the announcement. Required fields: title, body, send_to, user_activity. Optional: channel, clients, active_since, ttl.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The raw response dict, e.g. {"success": True, "recipients": <int>}.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

Dict[str, Any]

class reporter.objects.ApiToken(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ApiTokenManager(reporter, parent=None)

Bases: RestManager, GetMixin, ListMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new API token.

The plaintext token is included once in the response and exposed as an attribute on the returned ApiToken.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object. Required: name, abilities. Optional: expires_at, scope, clients, assessments, user_id.

  • file (FileLike[str | bytes] | str | bytes | tuple[str | None, FileLike[str | bytes] | str | bytes] | tuple[str | None, FileLike[str | bytes] | str | bytes, str] | tuple[str | None, FileLike[str | bytes] | str | bytes, str, Mapping[str, str]] | None) – Unused; accepted for signature parity with reporter.mixins.CreateMixin.create().

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The created ApiToken, with the plaintext token attribute.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ApiToken

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

me(include=None, query_data=None, **kwargs)

Get the API token used to authenticate the current request.

Parameters:

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the ApiToken type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ApiToken

reporter: Reporter
class reporter.objects.Assessment(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

comments: AssessmentAssessmentCommentManager
findings: AssessmentFindingManager
output_files: AssessmentOutputFileManager
reporter: Reporter
sections: AssessmentAssessmentSectionManager
targets: AssessmentTargetManager
task_sets: AssessmentTaskSetManager
tasks: AssessmentTaskManager
users: AssessmentAssessmentUserManager
class reporter.objects.AssessmentAssessmentCommentManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentAssessmentSectionManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reorder(attrs, **kwargs)

Reorder all assessment sections within the parent assessment.

Parameters:

  • attrs (Mapping[str, Any]) – A mapping with a sections key containing a nested tree of sections by id (each entry may have a children list).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

reporter: Reporter
class reporter.objects.AssessmentAssessmentUserManager(reporter, parent=None)

Bases: RestManager, CreateMixin, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentComment(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: AssessmentCommentReplyManager
reporter: Reporter
class reporter.objects.AssessmentCommentManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentCommentReplyManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentFindingManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

create_from_template(template_id, attrs, **kwargs)

Create a new finding from a finding template

Parameters:

  • template_id (str) – The ID of the finding template.

  • attrs (Mapping[str, Any]) – Attributes for the created finding.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the Finding type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

Finding

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentManager(reporter, parent=None)

Bases: RestManager, GetMixin, ListMixin, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

duplicate(id, attrs=None, **kwargs)

Duplicate an assessment.

The duplication is performed asynchronously by the server. This method returns once the job has been queued.

Parameters:

  • id (str) – The ID of the assessment to duplicate.

  • attrs (Mapping[str, Any] | None) – Optional attributes controlling what to copy (e.g. targets, team_access, auto_assignments, client_access, checklists, findings).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

get_full_report(id, attrs=None, **kwargs)

Get the full PDF report of an assessment.

Parameters:

  • id (str) – The ID of the assessment

  • attrs (Mapping[str, Any] | None) – Attributes for the PDF report

  • **kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The full report as a bytestring.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

bytes

get_management_report(id, attrs=None, **kwargs)

Get the management PDF report of an assessment.

Parameters:

  • id (str) – The ID of the assessment

  • attrs (Mapping[str, Any] | None) – Attributes for the PDF report

  • **kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The management report as a bytestring.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

bytes

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentOutputFileManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentPhase(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.AssessmentPhaseManager(reporter, parent=None)

Bases: RestManager, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentRoleManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.AssessmentSection(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

comments: AssessmentSectionAssessmentSectionCommentManager
reporter: Reporter
class reporter.objects.AssessmentSectionAssessmentSectionCommentManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentSectionComment(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: AssessmentSectionEventReplyManager
reporter: Reporter
class reporter.objects.AssessmentSectionCommentManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentSectionEventReplyManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentSectionManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentSectionTemplate(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.AssessmentSectionTemplateManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentTargetManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentTaskManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentTaskSetManager(reporter, parent=None)

Bases: RestManager, CreateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.AssessmentTemplate(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
sections: AssessmentTemplateAssessmentSectionTemplateManager
class reporter.objects.AssessmentTemplateAssessmentSectionTemplateManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reorder(attrs, **kwargs)

Reorder all section templates within the parent assessment template.

Parameters:

  • attrs (Mapping[str, Any]) – A mapping with a sections key containing a nested tree of sections by id (each entry may have a children list).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

reporter: Reporter
class reporter.objects.AssessmentTemplateManager(reporter, parent=None)

Bases: RestManager, CreateMixin, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
add_translation(id, attrs, **kwargs)

Add a new language translation to an assessment template.

Parameters:

  • id (str) – The ID of the assessment template.

  • attrs (Mapping[str, Any]) – Attributes for the request. Must contain language_id; may contain source_language_id.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The updated assessment template.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

AssessmentTemplate

count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

destroy_translation(id, language_id, **kwargs)

Remove a language translation from an assessment template.

Parameters:

  • id (str) – The ID of the assessment template.

  • language_id (str) – The ID of the language whose translation to remove.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The updated assessment template.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

AssessmentTemplate

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.AssessmentUser(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.AutoAssignment(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.Client(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

account_managers: ClientAccountManagerManager
assessments: ClientAssessmentManager
client_managers: ClientClientManagerManager
reporter: Reporter
teams: ClientTeamManager
class reporter.objects.ClientAccountManagerManager(reporter, parent=None)

Bases: RestManager

Parameters:
assign(attrs, **kwargs)

Assign a user as account manager to the parent client.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the request. Must contain user_id; may contain assign_to_future_assessments (boolean).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

remove(user_id, attrs=None, **kwargs)

Remove an account manager from the parent client.

Parameters:

  • user_id (str) – The ID of the account manager to remove.

  • attrs (Mapping[str, Any] | None) – Optional attributes for the request. May contain unassign_from_assessments (a list of assessment IDs).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

reporter: Reporter
class reporter.objects.ClientAssessmentManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.ClientClientManagerManager(reporter, parent=None)

Bases: RestManager

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(attrs, **kwargs)

Replace the list of client managers for the parent client.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the request. Must contain client_managers (a list of user IDs).

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

class reporter.objects.ClientManager(reporter, parent=None)

Bases: RestManager, CrudMixin, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.ClientTeamManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.CustomField(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.CustomFieldManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.Document(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.DocumentManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, CreateMixin, GetRawMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – Object ID

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The raw response data.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

bytes

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.Finding(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

comments: FindingFindingCommentManager
reporter: Reporter
retestInquiries: FindingFindingRetestInquiryManager
retests: FindingFindingRetestManager
class reporter.objects.FindingAssigneeEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingComment(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: FindingEventReplyManager
reporter: Reporter
class reporter.objects.FindingCommentManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.FindingCreatedEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingEventManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.FindingEventReplyManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.FindingFindingCommentManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.FindingFindingRetestInquiryManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.FindingFindingRetestManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.FindingImportEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingLayout(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingLayoutField(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingLayoutManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.FindingManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.FindingPublishedEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingRemediationStatusChange(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingRetest(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: FindingEventReplyManager
reporter: Reporter
class reporter.objects.FindingRetestCancelledEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingRetestCancelledEventManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.FindingRetestInquiry(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: FindingEventReplyManager
reporter: Reporter
retestCancelledEvents: FindingRetestInquiryFindingRetestCancelledEventManager
class reporter.objects.FindingRetestInquiryFindingRetestCancelledEventManager(reporter, parent=None)

Bases: RestManager, CreateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.FindingRetestInquiryManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.FindingRetestManager(reporter, parent=None)

Bases: RestManager, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.FindingReviewEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingStatusChange(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingTemplate(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.FindingTemplateManager(reporter, parent=None)

Bases: RestManager, CrudMixin, ListMixin, SearchMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
search(term=None, filter=None, page=None, page_size=None, query_data=None, **kwargs)

Search for a list of objects.

Parameters:

  • term (str | None) – Term to search for

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.GlobalRoleManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.Language(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.LanguageManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.OutputFile(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.OutputFileManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.Reaction(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ReactionManager(reporter, parent=None)

Bases: RestManager, CreateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
class reporter.objects.ReportPage(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.Role(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.Target(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.TargetManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.Task(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.TaskManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.TaskSet(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.TaskSetManager(reporter, parent=None)

Bases: RestManager, CrudMixin, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.Team(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
users: TeamTeamUserManager
class reporter.objects.TeamManager(reporter, parent=None)

Bases: RestManager, DeleteMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.TeamTeamUserManager(reporter, parent=None)

Bases: RestManager, CreateMixin, UpdateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.TeamUser(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.TestCase(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.TestCaseManager(reporter, parent=None)

Bases: RestManager, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.Theme(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ThemeManager(reporter, parent=None)

Bases: RestManager, ListMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
class reporter.objects.ToolFinding(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ToolFindingManager(reporter, parent=None)

Bases: RestManager, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.ToolFindingTargetInfo(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ToolTarget(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.ToolTargetManager(reporter, parent=None)

Bases: RestManager, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.User(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.UserManager(reporter, parent=None)

Bases: RestManager, CreateMixin, GetMixin, ListMixin, UpdateMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

get(id, include=None, query_data=None, **kwargs)

Retrieve a single object.

Parameters:

  • id (str) – The ID of the object to retrieve.

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

list(filter=None, sort=None, include=None, page=None, page_size=None, query_data=None, **kwargs)

Retrieve a list of objects.

Parameters:

  • filter (Mapping[str, str | int | List[str | int] | None] | None) – query string parameters for HTTP request of the form filter[field]

  • sort (str | List[str] | None) – How to sort retrieved items

  • include (str | List[str] | None) – Types of related data to include

  • page (int | None) – ID of the page to return - page[number]

  • page_size (int | None) – Number of items to return per page - page[size]

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

A RestList of RestObject instances.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

RestList

me(include=None, query_data=None, **kwargs)

Get the user who owns the API token

Parameters:

  • include (str | List[str] | None) – Related data to include in the response.

  • query_data (Mapping[str, Any] | None) – Dict of additional query parameters

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the User type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

User

reporter: Reporter
update(id, attrs, **kwargs)

Update an object of type self._obj_cls.

Parameters:

  • id (str) – ID of the object to update

  • attrs (Mapping[str, Any]) – Attributes to update

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

class reporter.objects.Webhook(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.WebhookManager(reporter, parent=None)

Bases: RestManager, CreateMixin, DeleteMixin

Parameters:
count(value) → integer -- return number of occurrences of value
create(attrs, file=None, **kwargs)

Create a new object.

Parameters:

  • attrs (Mapping[str, Any]) – Attributes for the created object.

  • file (FileSpec | None) –

    A file to upload when creating the object, if any. Type: reporter.types.FileSpec.

    Examples:

    # Using file object (recommended)
manager.create(attrs, file=open("file.json", "rb"))

# Simple content (not recommended, loses filename)
manager.create(attrs, file="content")
manager.create(attrs, file=b"content")

# With filename
manager.create(attrs, file=("file.json", json_string))

# With filename and content-type
manager.create(attrs, file=("file.json", json_string, "application/json"))

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Returns:

The response from the server, serialized into the object type.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

ChildOfRestObject

delete(id, **kwargs)

Delete an object.

Parameters:

  • id (str) – The ID of the object to delete.

  • kwargs (Any) – Extra options to pass to the underlying reporter.Reporter.http_request() call.

Raises:

ReporterHttpError – If raised by the underlying call to reporter.Reporter.http_request().

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

reporter: Reporter