diff --git a/pyproject.toml b/pyproject.toml index e08fff9..ca9c1b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "pyhuntress" -version = "0.2.12" +version = "0.2.13" authors = [ { name="Peter Annabel", email="peter.annabel@gmail.com" }, ] diff --git a/src/pyhuntress/endpoints/managedsat/PhishingCampaignScenariosIdAttemptsEndpoint.py b/src/pyhuntress/endpoints/managedsat/PhishingCampaignScenariosIdAttemptsEndpoint.py index 9cd9627..2adbcac 100644 --- a/src/pyhuntress/endpoints/managedsat/PhishingCampaignScenariosIdAttemptsEndpoint.py +++ b/src/pyhuntress/endpoints/managedsat/PhishingCampaignScenariosIdAttemptsEndpoint.py @@ -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 PhishingCampaignScenariosIdAttemptsEndpoint( 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,