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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

comments: reporter.objects.assessment_comment.AssessmentAssessmentCommentManager
findings: reporter.objects.finding.AssessmentFindingManager
output_files: reporter.objects.output_file.AssessmentOutputFileManager
reporter: Reporter
targets: reporter.objects.target.AssessmentTargetManager
task_sets: reporter.objects.task_set.AssessmentTaskSetManager
tasks: reporter.objects.task.AssessmentTaskManager
users: reporter.objects.assessment_user.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

Finding

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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

Get the full PDF report of an assessment.

Parameters:

  • id (str) – The ID of the assessment

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

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

Return type:

bytes

Returns:

The full report as a bytestring.

Raises:

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

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

Get the management PDF report of an assessment.

Parameters:

  • id (str) – The ID of the assessment

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

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

Return type:

bytes

Returns:

The management report as a bytestring.

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

comments: reporter.objects.assessment_section_comment.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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, GetMixin, 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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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
class reporter.objects.AssessmentTemplateManager(reporter, parent=None)

Bases: RestManager, GetMixin, ListMixin

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

reporter: Reporter
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])

assessments: reporter.objects.assessment.ClientAssessmentManager
reporter: Reporter
user_groups: reporter.objects.user_group.ClientUserGroupManager
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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

class reporter.objects.ClientUserGroupManager(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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

bytes

Returns:

The raw response data.

Raises:

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

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: reporter.objects.finding_comment.FindingFindingCommentManager
reporter: Reporter
retestInquiries: reporter.objects.finding_retest_inquiry.FindingFindingRetestInquiryManager
retests: reporter.objects.finding_retest.FindingFindingRetestManager
class reporter.objects.FindingCloneEvent(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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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.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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

class reporter.objects.FindingResolverEvent(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: reporter.objects.finding_comment.FindingEventReplyManager
reporter: Reporter
class reporter.objects.FindingRetestCancelledEvent(reporter, attrs)

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

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

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

replies: reporter.objects.finding_comment.FindingEventReplyManager
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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

Search for a list of objects.

Parameters:

  • term (Optional[str]) – Term to search for

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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.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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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.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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

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

Bases: RestObject

Parameters:

  • reporter (Reporter)

  • attrs (Mapping[str, Any])

reporter: Reporter
class reporter.objects.UserGroupManager(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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

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 (Union[str, List[str], None]) – Related data to include in the response.

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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

Retrieve a single object.

Parameters:

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

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

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

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Mapping[str, Union[str, int, List[Union[str, int]]]]]) – query string parameters for HTTP request of the form filter[field]

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

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

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

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

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

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

  • **kwargs (Any)

Return type:

RestList

Returns:

A RestList of RestObject instances.

Raises:

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

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

Get the user who owns the API token

Parameters:

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

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

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

  • **kwargs (Any)

Return type:

User

Returns:

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

Raises:

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

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 – Extra options to pass to the underlying reporter.Reporter.http_request() call.

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

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 (Optional[Any]) – A file to upload when creating the object, if any.

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

  • **kwargs (Any)

Return type:

~ChildOfRestObject

Returns:

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

Raises:

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

delete(id, **kwargs)

Delete an object.

Parameters:

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

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

  • **kwargs (Any)

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