pro scripts passes lint and test

docs/reference/models_pro.rst

@@ -94,3 +94,14 @@ Pagination
 
     Page
     FilterEntry
+
+
+Scripts
+-------
+
+.. currentmodule:: jamf_pro_sdk.models.pro.scripts
+
+.. autosummary::
+    :toctree: _autosummary
+
+    Script

src/jamf_pro_sdk/models/pro/api_options.py

@@ -223,3 +223,44 @@
     "SET_AUTO_ADMIN_PASSWORD",
     "UNKNOWN",
 ]
+
+
+get_scripts_v1_allowed_sort_criteria = [
+    "id",
+    "name",
+    "info",
+    "notes",
+    "priority",
+    "categoryId",
+    "categoryName",
+    "parameter4",
+    "parameter5",
+    "parameter6",
+    "parameter7",
+    "parameter8",
+    "parameter9",
+    "parameter10",
+    "parameter11",
+    "osRequirements",
+    "scriptContents",
+]
+
+get_scripts_v1_allowed_filter_criteria = [
+    "id",
+    "name",
+    "info",
+    "notes",
+    "priority",
+    "categoryId",
+    "categoryName",
+    "parameter4",
+    "parameter5",
+    "parameter6",
+    "parameter7",
+    "parameter8",
+    "parameter9",
+    "parameter10",
+    "parameter11",
+    "osRequirements",
+    "scriptContents",
+]

src/jamf_pro_sdk/models/pro/scripts.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+from pydantic import Extra
+
+from .. import BaseModel
+
+
+class Script(BaseModel, extra=Extra.allow):
+    """Represents a script record. The same data is
+    returned for both GET scripts and GET script by ID."""
+
+    id: Optional[int]
+    name: Optional[str]
+    info: Optional[str]
+    notes: Optional[str]
+    priority: Optional[str]
+    parameter4: Optional[str]
+    parameter5: Optional[str]
+    parameter6: Optional[str]
+    parameter7: Optional[str]
+    parameter8: Optional[str]
+    parameter9: Optional[str]
+    parameter10: Optional[str]
+    parameter11: Optional[str]
+    osRequirements: Optional[str]
+    scriptContents: Optional[str]
+    categoryId: Optional[int]
+    categoryName: Optional[str]

tests/models/test_models_pro_scripts.py

@@ -0,0 +1,58 @@
+import json
+
+from deepdiff import DeepDiff
+from src.jamf_pro_sdk.models.pro.scripts import Script
+
+SCRIPT_JSON = {
+    "script": {
+        "id": 73,
+        "name": "1_Set_Organization_Priorities-1.0.2.sh",
+        "info": "Some information",
+        "notes": "v1.0.2 31/1/2019",
+        "priority": "AFTER",
+        "parameter4": "",
+        "parameter5": "",
+        "parameter6": "",
+        "parameter7": "",
+        "parameter8": "",
+        "parameter9": "",
+        "parameter10": "",
+        "parameter11": "",
+        "osRequirements": "",
+        "scriptContents": '#!/bin/bash\n\norganization="My Organization"',
+        "categoryId": 15,
+        "categoryName": "CIS",
+    }
+}
+
+
+def test_script_model_parsings():
+    """Verify select attributes across the Script model."""
+    script = Script(**SCRIPT_JSON["script"])
+
+    assert script is not None  # mypy
+    assert script.id == 73
+    assert script.name == "1_Set_Organization_Priorities-1.0.2.sh"
+    assert script.info == "Some information"
+    assert script.notes == "v1.0.2 31/1/2019"
+    assert script.priority == "AFTER"
+    assert script.parameter4 == ""
+    assert script.parameter5 == ""
+    assert script.parameter6 == ""
+    assert script.parameter7 == ""
+    assert script.parameter8 == ""
+    assert script.parameter9 == ""
+    assert script.parameter10 == ""
+    assert script.parameter11 == ""
+    assert script.scriptContents == '#!/bin/bash\n\norganization="My Organization"'
+    assert script.categoryId == 15
+    assert script.categoryName == "CIS"
+
+
+def test_script_json_output_matches_input():
+    script = Script(**SCRIPT_JSON["script"])
+    serialized_output = json.loads(script.json(exclude_none=True))
+
+    diff = DeepDiff(SCRIPT_JSON["script"], serialized_output, ignore_order=True)
+
+    assert not diff