Merge pull request #196 from jmeridth/add-search-count-endpoint-to-sdk

Add Search Results Count to sdk

.gitignore

@@ -16,7 +16,8 @@ vendor/
 
 # coverage by go test
 coverage.txt
+profile.cov
 
 .idea
 *.iml
-.pre-commit-config.yaml
+.pre-commit-config.yaml

README.md

@@ -51,6 +51,10 @@ func main() {
 go-zendesk has a [mock package](https://pkg.go.dev/github.com/nukosuke/go-zendesk/zendesk/mock) generated by [golang/mock](https://github.com/golang/mock).  
 You can simulate the response from Zendesk API with it.
 
+## To regenerate the mock client
+
+`go generate ./...`
+
 ## Authors
 - [nukosuke](https://github.com/nukosuke)
 - [tamccall](https://github.com/tamccall)

fixture/GET/search_count_ticket.json

@@ -0,0 +1,3 @@
+{
+  "count": 10
+}

zendesk/search.go

@@ -16,8 +16,16 @@ type SearchOptions struct {
 	SortOrder string `url:"sort_order,omitempty"`
 }
 
+// CountOptions are the options that can be provided to the search results count API
+//
+// ref: https://developer.zendesk.com/rest_api/docs/support/search#show-results-count
+type CountOptions struct {
+	Query string `url:"query"`
+}
+
 type SearchAPI interface {
 	Search(ctx context.Context, opts *SearchOptions) (SearchResults, Page, error)
+	SearchCount(ctx context.Context, opts *CountOptions) (int, error)
 }
 
 type SearchResults struct {
@@ -140,3 +148,33 @@ func (z *Client) Search(ctx context.Context, opts *SearchOptions) (SearchResults
 
 	return data.Results, data.Page, nil
 }
+
+// SearchCount allows users to get count of results of a query of zendesk's unified search api.
+//
+// ref: https://developer.zendesk.com/rest_api/docs/support/search#show-results-count
+func (z *Client) SearchCount(ctx context.Context, opts *CountOptions) (int, error) {
+	var data struct {
+		Count int `json:"count"`
+	}
+
+	if opts == nil {
+		return 0, &OptionsError{opts}
+	}
+
+	u, err := addOptions("/search/count.json", opts)
+	if err != nil {
+		return 0, err
+	}
+
+	body, err := z.get(ctx, u)
+	if err != nil {
+		return 0, err
+	}
+
+	err = json.Unmarshal(body, &data)
+	if err != nil {
+		return 0, err
+	}
+
+	return data.Count, nil
+}

zendesk/search_test.go

@@ -33,6 +33,22 @@ func TestSearchTickets(t *testing.T) {
 	}
 }
 
+func TestCountTickets(t *testing.T) {
+	mockAPI := newMockAPI(http.MethodGet, "search_count_ticket.json")
+	client := newTestClient(mockAPI)
+	defer mockAPI.Close()
+
+	count, err := client.SearchCount(ctx, &CountOptions{})
+	if err != nil {
+		t.Fatalf("Failed to get count: %s", err)
+	}
+
+	expected := 10
+	if count != expected {
+		t.Fatalf("expected count of tickets is %d, but got %d", expected, count)
+	}
+}
+
 func BenchmarkUnmarshalSearchResults(b *testing.B) {
 	file := readFixture("ticket_result.json")
 	for i := 0; i < b.N; i++ {