feat!: Pagination func filter passing refactored (#760)

* feat: pagination uses proper url formatting now

* pagination endpoint change

* encode before put in string

* handling if no values provided

* re add actual paging

* added overrrides

* debugging

* to pointer

* debugging

* debugging

* debugging

* debuggng

* Reworked paging params

* func comment

* a comment

* new line

* vars foramtting standardised

* error messages

* one lined the func name

* removed debug prints

* removed unnecessary constants

* renamed paginated response model

* empty type -> nil

* Added md and comments directing to it re url.Values usage

Author: thejoeker12

docs/url_queries.md

@@ -0,0 +1,77 @@
+# Querying the Jamf Pro API with RSQL
+
+Jamf Pro's **Jamf Pro API (v1+)** supports querying resources using **RSQL filters** via HTTP requests. This guide explains how to construct API queries using URLs with RSQL in Go.
+
+
+## 📘 Basic URL Format
+
+Jamf Pro API endpoints follow this pattern:
+
+```
+https://<jamf-host>/api/<resource-path>?page=0&page-size=50&sort=fieldName:asc&filter=<rsql-expression>
+```
+
+- `page`: zero-based page index.
+- `page-size`: number of results per page.
+- `sort`: optional; `fieldName:asc` or `fieldName:desc`.
+- `filter`: your RSQL query string (URL-encoded).
+
+---
+
+## 🔍 Example: Query Computers by Name
+
+**Goal:** Find all computers whose name contains `test`.
+
+**Endpoint:**
+
+```
+GET /api/v1/computers-inventory
+```
+
+**RSQL Filter:**
+
+```
+general.name==*test*
+```
+
+**Full URL (URL-encoded):**
+
+```
+https://your-jamf-url.com/api/v1/computers-inventory?filter=general.name%3D%3D%2Atest%2A
+```
+
+
+
+## 🧑‍💻 Creating an RSQL Query using `url.Values{}` in Go
+
+```go
+import (
+	"net/http"
+	"net/url"
+)
+
+func buildJamfQuery() (*http.Request, error) {
+	baseURL := "https://your-jamf-url.com/api/v1/computers-inventory"
+
+	params := url.Values{}
+	params.Set("page", "0")
+	params.Set("page-size", "50")
+	params.Set("sort", "general.name:asc")
+	params.Set("filter", `general.name==*test*`)
+
+	fullURL := baseURL + "?" + params.Encode()
+
+	req, err := http.NewRequest("GET", fullURL, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
+	return req, nil
+}
+```
+
+- `url.Values{}.Encode()` handles correct URL encoding for you.
+- The RSQL filter will be encoded automatically (e.g. `==` → `%3D%3D`, `*` → `%2A`).
+
+---

examples/bookmarks/GetBookmarks/GetBookmarks.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,8 +19,10 @@ func main() {
 		log.Fatalf("Failed to initialize Jamf Pro client: %v", err)
 	}
 
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+
 	// Call function
-	bookmarksList, err := client.GetBookmarks("")
+	bookmarksList, err := client.GetBookmarks(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching accounts: %v", err)
 	}

examples/buildings/GetBuildingResourceHistoryByID/GetBuildingResourceHistoryByID.go

@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,8 +19,9 @@ func main() {
 	}
 
 	// Example: Fetch the resource history of a building by ID
+	// For more information on how to add parameters to this request, see docs/url_queries.md
 	buildingID := "" // Replace with a real building ID
-	history, err := client.GetBuildingResourceHistoryByID(buildingID, "")
+	history, err := client.GetBuildingResourceHistoryByID(buildingID, url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching building resource history: %v", err)
 	}

examples/buildings/GetBuildings/GetBuildings.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,8 +19,10 @@ func main() {
 		log.Fatalf("Failed to initialize Jamf Pro client: %v", err)
 	}
 
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+
 	// Call GetBuildings function
-	accountsList, err := client.GetBuildings("")
+	accountsList, err := client.GetBuildings(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching accounts: %v", err)
 	}

examples/categories/GetCategories/GetCategories.go

@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,9 +19,10 @@ func main() {
 	}
 
 	// Define the sort and filter query parameters
-	// none
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+
 	// Call the GetCategories function
-	categories, err := client.GetCategories("") // Will return all results by default
+	categories, err := client.GetCategories(url.Values{}) // Will return all results by default
 	if err != nil {
 		fmt.Printf("Error fetching categories: %v\n", err)
 		return

examples/cloud_idp/GetCloudIdentityProviders/GetCloudIdentityProviders.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,10 +20,11 @@ func main() {
 	}
 
 	// Optional: Define sort filter (e.g., "id:asc" or "displayName:desc")
-	sortFilter := "id:desc"
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	params := url.Values{}
 
 	// Call GetCloudIdentityProviders function
-	cloudIdps, err := client.GetCloudIdentityProviders(sortFilter)
+	cloudIdps, err := client.GetCloudIdentityProviders(params)
 	if err != nil {
 		log.Fatalf("Error fetching cloud identity providers: %v", err)
 	}

examples/computer_extension_attributes/GetComputerExtensionAttributes/GetComputerExtensionAttributes.go

@@ -4,6 +4,7 @@ import (
 	"encoding/xml"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,7 +20,8 @@ func main() {
 	}
 
 	// Call GetComputerExtensionAttributes function
-	attributes, err := client.GetComputerExtensionAttributes("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	attributes, err := client.GetComputerExtensionAttributes(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching Computer Extension Attributes: %v", err)
 	}

examples/computer_inventory/GetComputersFileVaultInventory/GetComputersFileVaultInventory.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,10 +20,12 @@ func main() {
 	}
 
 	// Sort filter
-	sortFilter := "sort=id:desc"
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	params := url.Values{}
+	params.Add("sort", "id:desc")
 
 	// Call the GetComputersFileVaultInventory function
-	fileVaultInventory, err := client.GetComputersFileVaultInventory(sortFilter)
+	fileVaultInventory, err := client.GetComputersFileVaultInventory(params)
 	if err != nil {
 		log.Fatalf("Error fetching FileVault inventory: %v", err)
 	}

examples/computer_inventory/GetComputersInventory/GetComputersInventory.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -36,7 +37,8 @@ func main() {
 	// sections := []string{"GENERAL", "DISK_ENCRYPTION", "STORAGE"} // Example sections
 
 	// Call the GetComputersInventory function
-	inventoryList, err := client.GetComputersInventory("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	inventoryList, err := client.GetComputersInventory(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching computer inventory: %v", err)
 	}

examples/computer_prestages/GetComputerPrestages/GetComputerPrestages.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,10 +20,12 @@ func main() {
 	}
 
 	// Define sorting parameters
-	sortFilter := "name" // Example: "name" for sorting by name
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	params := url.Values{}
+	params.Add("sort", "name")
 
 	// Fetch computer prestages using the V3 API
-	prestages, err := client.GetComputerPrestages(sortFilter)
+	prestages, err := client.GetComputerPrestages(params)
 	if err != nil {
 		log.Fatalf("Error fetching computer prestages: %v", err)
 	}

examples/departments/DeleteAllDepartments/DeleteAllDepartments.go

@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,7 +19,8 @@ func main() {
 	}
 
 	// Fetch all departments
-	departments, err := client.GetDepartments("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	departments, err := client.GetDepartments(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching departments: %v", err)
 	}

examples/departments/GetDepartments/GetDepartments.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,7 +20,8 @@ func main() {
 	}
 
 	// Call GetDepartments function
-	departments, err := client.GetDepartments("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	departments, err := client.GetDepartments(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching departments: %v", err)
 	}

examples/device_enrollments/GetDeviceEnrollmentHistory/GetDeviceEnrollmentHistory.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,8 +20,9 @@ func main() {
 	}
 
 	// Fetch Device Enrollment History
+	// For more information on how to add parameters to this request, see docs/url_queries.md
 	deviceEnrollmentID := "1" // Using the known device enrollment ID from the system
-	response, err := client.GetDeviceEnrollmentHistory(deviceEnrollmentID, "")
+	response, err := client.GetDeviceEnrollmentHistory(deviceEnrollmentID, url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching device enrollment history: %v", err)
 	}

examples/device_enrollments/GetDeviceEnrollments/GetDeviceEnrollments.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,7 +20,8 @@ func main() {
 	}
 
 	// Fetch Device Enrollments
-	response, err := client.GetDeviceEnrollments("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	response, err := client.GetDeviceEnrollments(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching Device enrollment instances: %v", err)
 	}

examples/enrollment/GetAccountDrivenUserEnrollmentAccessGroups/GetAccountDrivenUserEnrollmentAccessGroups.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -19,7 +20,8 @@ func main() {
 	}
 
 	// Call GetAccountDrivenUserEnrollmentAccessGroups function
-	ADUEAccessGroups, err := client.GetAccountDrivenUserEnrollmentAccessGroups("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	ADUEAccessGroups, err := client.GetAccountDrivenUserEnrollmentAccessGroups(url.Values{})
 	if err != nil {
 		log.Fatalf("Error fetching ADUE Access Groups: %v", err)
 	}

examples/enrollment/GetEnrollmentHistory/GetEnrollmentHistory.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -20,7 +21,8 @@ func main() {
 
 	// Call GetEnrollmentHistory function
 	// You can add sorting parameters like "sort=date:desc" to sort by date in descending order
-	history, err := client.GetEnrollmentHistory("")
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	history, err := client.GetEnrollmentHistory(url.Values{})
 	if err != nil {
 		log.Fatalf("Error getting enrollment history: %v", err)
 	}

examples/enrollment_customizations/GetEnrollmentCustomizations/GetEnrollmentCustomizations.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net/url"
 
 	"github.com/deploymenttheory/go-api-sdk-jamfpro/sdk/jamfpro"
 )
@@ -18,13 +19,9 @@ func main() {
 		log.Fatalf("Failed to initialize Jamf Pro client: %v", err)
 	}
 
-	// Optional: Define sort and filter parameters
-	// Example: sort=displayName:asc
-	// Leave empty string "" for no sorting/filtering
-	sortFilter := ""
-
 	// Get all enrollment customizations
-	customizations, err := client.GetEnrollmentCustomizations(sortFilter)
+	// For more information on how to add parameters to this request, see docs/url_queries.md
+	customizations, err := client.GetEnrollmentCustomizations(url.Values{})
 	if err != nil {
 		log.Fatalf("Failed to get enrollment customizations: %v", err)
 	}