mirror of
https://github.com/brygphilomena/pyhuntress.git
synced 2026-02-06 01:37:29 +00:00
add pagination to campaign phishing attempts endpoint
This commit is contained in:
parent
9c92b3e274
commit
7532b475a7
@ -154,3 +154,7 @@ Contributions to the project are welcome. If you find any issues or have suggest
|
||||
|
||||
# Inspiration and Stolen Code
|
||||
The premise behind this came from the [pyConnectWise](https://github.com/HealthITAU/pyconnectwise) package and I stole **most** of the code and adapted it to the Huntress API endpoints.
|
||||
|
||||
# How to Build
|
||||
> python -m build
|
||||
> python -m twine upload dist/*
|
||||
@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "pyhuntress"
|
||||
version = "0.2.15"
|
||||
version = "0.2.16"
|
||||
authors = [
|
||||
{ name="Peter Annabel", email="peter.annabel@gmail.com" },
|
||||
]
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
from pyhuntress.endpoints.base.huntress_endpoint import HuntressEndpoint
|
||||
from pyhuntress.interfaces import (
|
||||
IGettable,
|
||||
IPaginateable,
|
||||
)
|
||||
from pyhuntress.models.managedsat import SATPhishingCampaignAttempts
|
||||
from pyhuntress.responses.paginated_response import PaginatedResponse
|
||||
from pyhuntress.types import (
|
||||
JSON,
|
||||
HuntressSATRequestParams,
|
||||
@ -12,10 +14,43 @@ from pyhuntress.types import (
|
||||
class PhishingCampaignsIdAttemptsEndpoint(
|
||||
HuntressEndpoint,
|
||||
IGettable[SATPhishingCampaignAttempts, HuntressSATRequestParams],
|
||||
IPaginateable[SATPhishingCampaignAttempts, HuntressSATRequestParams],
|
||||
):
|
||||
def __init__(self, client, parent_endpoint=None) -> None:
|
||||
HuntressEndpoint.__init__(self, client, "attempts", parent_endpoint=parent_endpoint)
|
||||
IGettable.__init__(self, SATPhishingCampaignAttempts)
|
||||
IPaginateable.__init__(self, SATPhishingCampaignAttempts)
|
||||
|
||||
def paginated(
|
||||
self,
|
||||
page: int,
|
||||
limit: int,
|
||||
params: HuntressSATRequestParams | None = None,
|
||||
) -> PaginatedResponse[SATPhishingCampaignAttempts]:
|
||||
"""
|
||||
Performs a GET request against the /phishing-campaign-scenarios/{id}/attempts endpoint and returns an initialized PaginatedResponse object.
|
||||
|
||||
Parameters:
|
||||
page (int): The page number to request.
|
||||
limit (int): The number of results to return per page.
|
||||
params (dict[str, int | str]): The parameters to send in the request query string.
|
||||
Returns:
|
||||
PaginatedResponse[SATPhishingCampaignAttempts]: The initialized PaginatedResponse object.
|
||||
"""
|
||||
if params:
|
||||
params["page[number]"] = page
|
||||
params["page[size]"] = limit
|
||||
else:
|
||||
params = {"page[number]": page, "page[size]": limit}
|
||||
return PaginatedResponse(
|
||||
super()._make_request("GET", params=params),
|
||||
SATPhishingCampaignAttempts,
|
||||
self,
|
||||
"data",
|
||||
page,
|
||||
limit,
|
||||
params,
|
||||
)
|
||||
|
||||
def get(
|
||||
self,
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user