feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 15
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/beeper%2Fbeeper-desktop-api-953cbc1ea1fe675bf2d32b18030a3ac509c521946921cb338c0d1c2cfef89424.yml
 openapi_spec_hash: b4d08ca2dc21bc00245c9c9408be89ef
-config_hash: 738402ade5ac9528c8ef1677aa1d70f7
+config_hash: 4fb2010b528ce4358300ddd10e750265

README.md

@@ -282,42 +282,9 @@ This library provides some conveniences for working with paginated list endpoint
 
 You can use `.ListAutoPaging()` methods to iterate through items across all pages:
 
-```go
-iter := client.Messages.SearchAutoPaging(context.TODO(), beeperdesktopapi.MessageSearchParams{
-	AccountIDs: []string{"local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"},
-	Limit:      beeperdesktopapi.Int(10),
-	Query:      beeperdesktopapi.String("deployment"),
-})
-// Automatically fetches more pages as needed.
-for iter.Next() {
-	message := iter.Current()
-	fmt.Printf("%+v\n", message)
-}
-if err := iter.Err(); err != nil {
-	panic(err.Error())
-}
-```
-
 Or you can use simple `.List()` methods to fetch a single page and receive a standard response object
 with additional helper methods like `.GetNextPage()`, e.g.:
 
-```go
-page, err := client.Messages.Search(context.TODO(), beeperdesktopapi.MessageSearchParams{
-	AccountIDs: []string{"local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI"},
-	Limit:      beeperdesktopapi.Int(10),
-	Query:      beeperdesktopapi.String("deployment"),
-})
-for page != nil {
-	for _, message := range page.Items {
-		fmt.Printf("%+v\n", message)
-	}
-	page, err = page.GetNextPage()
-}
-if err != nil {
-	panic(err.Error())
-}
-```
-
 ### Errors
 
 When the API returns a non-success status code, we return an error with type

api.md

@@ -67,10 +67,11 @@ Methods:
 
 Response Types:
 
+- <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSearchResponse">MessageSearchResponse</a>
 - <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSendResponse">MessageSendResponse</a>
 
 Methods:
 
 - <code title="get /v1/messages">client.Messages.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageListParams">MessageListParams</a>) (<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/packages/pagination#Cursor">Cursor</a>[<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/shared#Message">Message</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="get /v1/messages/search">client.Messages.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageService.Search">Search</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSearchParams">MessageSearchParams</a>) (<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/packages/pagination#Cursor">Cursor</a>[<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go/shared#Message">Message</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
+- <code title="get /v1/messages/search">client.Messages.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageService.Search">Search</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSearchParams">MessageSearchParams</a>) (<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSearchResponse">MessageSearchResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="post /v1/messages">client.Messages.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageService.Send">Send</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSendParams">MessageSendParams</a>) (<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go">beeperdesktopapi</a>.<a href="https://pkg.go.dev/github.com/beeper/desktop-api-go#MessageSendResponse">MessageSendResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

message.go

@@ -63,26 +63,11 @@ func (r *MessageService) ListAutoPaging(ctx context.Context, query MessageListPa
 }
 
 // Search messages across chats using Beeper's message index
-func (r *MessageService) Search(ctx context.Context, query MessageSearchParams, opts ...option.RequestOption) (res *pagination.Cursor[shared.Message], err error) {
-	var raw *http.Response
+func (r *MessageService) Search(ctx context.Context, query MessageSearchParams, opts ...option.RequestOption) (res *MessageSearchResponse, err error) {
 	opts = append(r.Options[:], opts...)
-	opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
 	path := "v1/messages/search"
-	cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
-	if err != nil {
-		return nil, err
-	}
-	err = cfg.Execute()
-	if err != nil {
-		return nil, err
-	}
-	res.SetPageConfig(cfg, raw)
-	return res, nil
-}
-
-// Search messages across chats using Beeper's message index
-func (r *MessageService) SearchAutoPaging(ctx context.Context, query MessageSearchParams, opts ...option.RequestOption) *pagination.CursorAutoPager[shared.Message] {
-	return pagination.NewCursorAutoPager(r.Search(ctx, query, opts...))
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
+	return
 }
 
 // Send a text message to a specific chat. Supports replying to existing messages.
@@ -94,6 +79,37 @@ func (r *MessageService) Send(ctx context.Context, body MessageSendParams, opts
 	return
 }
 
+type MessageSearchResponse struct {
+	// Map of chatID -> chat details for chats referenced in items.
+	Chats map[string]Chat `json:"chats,required"`
+	// True if additional results can be fetched using the provided cursors.
+	HasMore bool `json:"hasMore,required"`
+	// Messages matching the query and filters.
+	Items []shared.Message `json:"items,required"`
+	// Cursor for fetching newer results (use with direction='after'). Opaque string;
+	// do not inspect.
+	NewestCursor string `json:"newestCursor,required"`
+	// Cursor for fetching older results (use with direction='before'). Opaque string;
+	// do not inspect.
+	OldestCursor string `json:"oldestCursor,required"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		Chats        respjson.Field
+		HasMore      respjson.Field
+		Items        respjson.Field
+		NewestCursor respjson.Field
+		OldestCursor respjson.Field
+		ExtraFields  map[string]respjson.Field
+		raw          string
+	} `json:"-"`
+}
+
+// Returns the unmodified JSON received from the API
+func (r MessageSearchResponse) RawJSON() string { return r.JSON.raw }
+func (r *MessageSearchResponse) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
 type MessageSendResponse struct {
 	// Unique identifier of the chat.
 	ChatID string `json:"chatID,required"`

packages/pagination/pagination.go

@@ -5,6 +5,7 @@ package pagination
 import (
 	"net/http"
 
+	"github.com/beeper/desktop-api-go"
 	"github.com/beeper/desktop-api-go/internal/apijson"
 	"github.com/beeper/desktop-api-go/internal/requestconfig"
 	"github.com/beeper/desktop-api-go/option"
@@ -125,3 +126,113 @@ func (r *CursorAutoPager[T]) Err() error {
 func (r *CursorAutoPager[T]) Index() int {
 	return r.run
 }
+
+type CursorWithChats[T any] struct {
+	Items        []T                              `json:"items"`
+	Chats        map[string]beeperdesktopapi.Chat `json:"chats"`
+	HasMore      bool                             `json:"hasMore"`
+	OldestCursor string                           `json:"oldestCursor,nullable"`
+	NewestCursor string                           `json:"newestCursor,nullable"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		Items        respjson.Field
+		Chats        respjson.Field
+		HasMore      respjson.Field
+		OldestCursor respjson.Field
+		NewestCursor respjson.Field
+		ExtraFields  map[string]respjson.Field
+		raw          string
+	} `json:"-"`
+	cfg *requestconfig.RequestConfig
+	res *http.Response
+}
+
+// Returns the unmodified JSON received from the API
+func (r CursorWithChats[T]) RawJSON() string { return r.JSON.raw }
+func (r *CursorWithChats[T]) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+// GetNextPage returns the next page as defined by this pagination style. When
+// there is no next page, this function will return a 'nil' for the page value, but
+// will not return an error
+func (r *CursorWithChats[T]) GetNextPage() (res *CursorWithChats[T], err error) {
+	if len(r.Items) == 0 {
+		return nil, nil
+	}
+
+	if r.JSON.HasMore.Valid() && r.HasMore == false {
+		return nil, nil
+	}
+	next := r.OldestCursor
+	if len(next) == 0 {
+		return nil, nil
+	}
+	cfg := r.cfg.Clone(r.cfg.Context)
+	err = cfg.Apply(option.WithQuery("cursor", next))
+	if err != nil {
+		return nil, err
+	}
+	var raw *http.Response
+	cfg.ResponseInto = &raw
+	cfg.ResponseBodyInto = &res
+	err = cfg.Execute()
+	if err != nil {
+		return nil, err
+	}
+	res.SetPageConfig(cfg, raw)
+	return res, nil
+}
+
+func (r *CursorWithChats[T]) SetPageConfig(cfg *requestconfig.RequestConfig, res *http.Response) {
+	if r == nil {
+		r = &CursorWithChats[T]{}
+	}
+	r.cfg = cfg
+	r.res = res
+}
+
+type CursorWithChatsAutoPager[T any] struct {
+	page *CursorWithChats[T]
+	cur  T
+	idx  int
+	run  int
+	err  error
+	paramObj
+}
+
+func NewCursorWithChatsAutoPager[T any](page *CursorWithChats[T], err error) *CursorWithChatsAutoPager[T] {
+	return &CursorWithChatsAutoPager[T]{
+		page: page,
+		err:  err,
+	}
+}
+
+func (r *CursorWithChatsAutoPager[T]) Next() bool {
+	if r.page == nil || len(r.page.Items) == 0 {
+		return false
+	}
+	if r.idx >= len(r.page.Items) {
+		r.idx = 0
+		r.page, r.err = r.page.GetNextPage()
+		if r.err != nil || r.page == nil || len(r.page.Items) == 0 {
+			return false
+		}
+	}
+	r.cur = r.page.Items[r.idx]
+	r.run += 1
+	r.idx += 1
+	return true
+}
+
+func (r *CursorWithChatsAutoPager[T]) Current() T {
+	return r.cur
+}
+
+func (r *CursorWithChatsAutoPager[T]) Err() error {
+	return r.err
+}
+
+func (r *CursorWithChatsAutoPager[T]) Index() int {
+	return r.run
+}