jamf-pro-sdk-python icon indicating copy to clipboard operation
jamf-pro-sdk-python copied to clipboard

[Feature Request] Pass a model to the Classic and Pro API request methods as the return type.

Open brysontyrrell opened this issue 1 year ago • 1 comments

Proposal

When using the classic_api_request and pro_api_request methods on the client directly users have to take the response and cast it to an SDK model themselves.

resp = jamf_client.classic_api_request(
    method="get",
    resource_path=f"computergroups/name/{group_name}"
)
group = ClassicComputerGroup(**resp.json()["computer_group"])

Both methods should optionally accept an SDK model as an optional response type. When set, the requests response object is not returned, but the method attempts to instantiate the provided model from the data.

group = jamf_client.classic_api_request(
    method="get",
    resource_path=f"computergroups/name/{group_name}",
    return_model=ClassicComputerGroup
)

brysontyrrell avatar Jul 24 '24 20:07 brysontyrrell

Makes sense. Would also be nice to make use of Generic/TypeVar in a few choice places (e.g., Page, Pagination).

macserv avatar Nov 04 '24 22:11 macserv