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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.ActivityManager(reporter, parent=None)
Bases:
RestManager
,ListMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentAssessmentCommentManager(reporter, parent=None)
Bases:
RestManager
,CreateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentCommentManager(reporter, parent=None)
Bases:
RestManager
,UpdateMixin
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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, **kwargs)
Get the full PDF report of an assessment.
- Parameters:
id – The ID of the assessment
**kwargs (
Any
) – Extra options to pass to the underlyingreporter.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, **kwargs)
Get the management PDF report of an assessment.
- Parameters:
id – The ID of the assessment
**kwargs (
Any
) – Extra options to pass to the underlyingreporter.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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentPhaseManager(reporter, parent=None)
Bases:
RestManager
,UpdateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentSectionAssessmentSectionCommentManager(reporter, parent=None)
Bases:
RestManager
,CreateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentSectionCommentManager(reporter, parent=None)
Bases:
RestManager
,UpdateMixin
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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.AssessmentTemplate(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AssessmentTemplateManager(reporter, parent=None)
Bases:
RestManager
,GetMixin
,ListMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.AutoAssignment(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.Client(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.ClientAssessmentManager(reporter, parent=None)
Bases:
RestManager
,CreateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.DocumentManager(reporter, parent=None)
Bases:
RestManager
,DeleteMixin
,CreateMixin
,GetRawMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Raises:
ReporterHttpError – If raised by the underlying call to
reporter.Reporter.http_request()
.
- get(id, **kwargs)
Retrieve a single object.
- Parameters:
id (
str
) – Object IDkwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingComment(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingCommentManager(reporter, parent=None)
Bases:
RestManager
,UpdateMixin
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingEventReplyManager(reporter, parent=None)
Bases:
RestManager
,CreateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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.FindingRetest(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingRetestInquiry(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingRetestInquiryManager(reporter, parent=None)
Bases:
RestManager
,UpdateMixin
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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.FindingTemplate(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.FindingTemplateManager(reporter, parent=None)
Bases:
RestManager
,CrudMixin
,ListMixin
,SearchMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 forpage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.OutputFileManager(reporter, parent=None)
Bases:
RestManager
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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.Role(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.Target(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.TargetManager(reporter, parent=None)
Bases:
RestManager
,DeleteMixin
,GetMixin
,ListMixin
,UpdateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.TaskManager(reporter, parent=None)
Bases:
RestManager
,DeleteMixin
,GetMixin
,ListMixin
,UpdateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.TaskSetManager(reporter, parent=None)
Bases:
RestManager
,CrudMixin
,ListMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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.User(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.UserGroup(reporter, attrs)
Bases:
RestObject
- Parameters:
reporter (
Reporter
) –attrs (
Mapping
[str
,Any
]) –
- keys()
- reporter: Reporter
- class reporter.objects.UserGroupManager(reporter, parent=None)
Bases:
RestManager
,DeleteMixin
,GetMixin
,ListMixin
,UpdateMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 underlyingreporter.Reporter.http_request()
call.
- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Optional
[List
[str
]]) – Related data to include in the response.query_data (
Optional
[Mapping
[str
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
,str
]]) – query string parameters for HTTP request of the form filter[field]sort (
Optional
[List
[str
]]) – How to sort retrieved itemsinclude (
Optional
[List
[str
]]) – Types of related data to includepage (
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
,str
]]) – Dict of additional query parameterskwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
- Returns:
A
RestList
ofRestObject
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 updateattrs (
Mapping
[str
,Any
]) – Attributes to updatekwargs (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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
]) –
- keys()
- reporter: Reporter
- class reporter.objects.WebhookManager(reporter, parent=None)
Bases:
RestManager
,CreateMixin
,DeleteMixin
- Parameters:
reporter (
Reporter
) –parent (
Optional
[RestObject
]) –
- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- Return type:
TypeVar
(ChildOfRestObject
, bound=RestObject
)- 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 (
Any
) – Extra options to pass to the underlyingreporter.Reporter.http_request()
call.
- 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