add sorting to agent list and agent pool list

Author: twitnithegirl

agent.go

@@ -49,6 +49,9 @@ type AgentListOptions struct {
 
 	//Optional:
 	LastPingSince time.Time `url:"filter[last-ping-since],omitempty,iso8601"`
+
+	// Optional: Allows sorting the agents by "created-by"
+	Sort string `url:"sort,omitempty"`
 }
 
 // Read a single agent by its ID

agent_integration_test.go

@@ -23,6 +23,7 @@ func TestAgentsRead(t *testing.T) {
 	upgradeOrganizationSubscription(t, client, org)
 
 	agent, _, agentCleanup := createAgent(t, client, org)
+	agent2, _, agentCleanup := createAgent(t, client, org)
 
 	t.Cleanup(agentCleanup)
 
@@ -67,6 +68,24 @@ func TestAgentsList(t *testing.T) {
 		assert.NotEmpty(t, agent.Items[0].ID)
 	})
 
+	t.Run("with sorting", func(t *testing.T) {
+		agents, err := client.Agents.List(ctx, agentPool.ID, &AgentListOptions{
+			Sort: "created-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, agents)
+		require.Len(t, agents.Items, 2)
+		require.Equal(t, []string{agent1.ID, agent2.ID}, []string{agents.Items[0].ID, agents.Items[1].ID})
+
+		agents, err = client.Agents.List(ctx, agentPool.ID, &AgentListOptions{
+			Sort: "-created-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, agents)
+		require.Len(t, agents.Items, 2)
+		require.Equal(t, []string{agent2.ID, agent1.ID}, []string{agents.Items[0].ID, agents.Items[1].ID})
+	})
+
 	t.Run("without a valid agent pool ID", func(t *testing.T) {
 		agent, err := client.Agents.List(ctx, badIdentifier, nil)
 		assert.Nil(t, agent)

agent_pool.go

@@ -85,6 +85,9 @@ type AgentPoolListOptions struct {
 
 	// Optional: String (workspace name) used to filter the results.
 	AllowedWorkspacesName string `url:"filter[allowed_workspaces][name],omitempty"`
+
+	// Optional: Allows sorting the agent pools by "created-by" or "name"
+	Sort string `url:"sort,omitempty"`
 }
 
 // AgentPoolCreateOptions represents the options for creating an agent pool.

agent_pool_integration_test.go

@@ -22,6 +22,8 @@ func TestAgentPoolsList(t *testing.T) {
 
 	agentPool, agentPoolCleanup := createAgentPool(t, client, orgTest)
 	defer agentPoolCleanup()
+	agentPool2, agentPoolCleanup2 := createAgentPool(t, client, orgTest)
+	defer agentPoolCleanup2()
 
 	t.Run("without list options", func(t *testing.T) {
 		pools, err := client.AgentPools.List(ctx, orgTest.Name, nil)
@@ -64,6 +66,23 @@ func TestAgentPoolsList(t *testing.T) {
 		assert.Equal(t, 999, pools.CurrentPage)
 		assert.Equal(t, 1, pools.TotalCount)
 	})
+	t.Run("with sorting", func(t *testing.T) {
+		pools, err := client.AgentPools.List(ctx, orgTest.Name, &AgentPoolListOptions{
+			Sort: "created-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, pools)
+		require.Len(t, pools.Items, 2)
+		require.Equal(t, []string{agentPool.ID, agentPool2.ID}, []string{pools.Items[0].ID, pools.Items[1].ID})
+
+		pools, err = client.AgentPools.List(ctx, orgTest.Name, &AgentPoolListOptions{
+			Sort: "-created-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, pools)
+		require.Len(t, pools.Items, 2)
+		require.Equal(t, []string{agentPool2.ID, agentPool.ID}, []string{pools.Items[0].ID, pools.Items[1].ID})
+	})
 
 	t.Run("without a valid organization", func(t *testing.T) {
 		pools, err := client.AgentPools.List(ctx, badIdentifier, nil)