blueticks 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62b2a3ae7e59ee684634e2e2e26883fa47db18da62aa74eda711efd088d4e868
-  data.tar.gz: 392f498378faa47fa4be6f73fbefad15a5642ab16718ec2fdd9787a8aa5951a4
+  metadata.gz: 80ac68082d0098a0ceae9ace729c7d019bbeca7f4714b5f8f11c4846af84ac04
+  data.tar.gz: f8d39230912328f38e8e9dda9034cc5d0d9192b47f7ed7857063d2a173fd32ec
 SHA512:
-  metadata.gz: e3a873bb77d76820cf1946483f11eabf2c53169c3930f1578fbbaa86679193e6428071aed414d4d9c41f5f99beb3dfd7bac411e9db84ebcad3e66b364e5f9def
-  data.tar.gz: 681cf759086355b74cdba8fec69cf515b62705b7a8a0039916c25a267dc34928d2f24c2a62dc948e3c04ea909c45f618cb0803677cc3efe0a56a2568447576d4
+  metadata.gz: fc539e01c948edc214d396f4bb8aafb09eacc7a450a370c5e4675a23021c3705b829b467332c19a1e2c5b4c3ab53d88af64930e122e205b980f1a3354ca4cfb0
+  data.tar.gz: ebe45c16ef9311b23600ca225dcaffb1924e64f1df5681966383053a8be2d50d05791abc199db390de7fc30404d87a386892b0086631ecf269187e1ddef21736

data/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to the Blueticks Ruby SDK are documented here. The format
 follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.1.1 — 2026-11-07
+
+### Fixed
+- Publish workflow now runs on a GitHub-hosted runner (`ubuntu-24.04`); the 2.1.0 publish failed on the self-hosted runner, so 2.1.1 is the first published release with `groups.get_picture` / `groups.remove_picture`.
+
+## 2.1.0 — 2026-11-07
+
+### Added
+
+- Group picture: `groups.get_picture` (get the current picture URL) and `groups.remove_picture` (remove the picture; Gateway/Baileys engine only — Chrome-extension-only accounts get `501 unsupported_command`). `groups.set_picture` already existed.
+
 ## 1.2.0 — 2026-05-22
 
 OpenAPI parity pass. The SDK now matches `backend/openapi.json`

data/lib/blueticks/client.rb

@@ -4,14 +4,18 @@ require_relative "errors"
 require_relative "transport"
 require_relative "resources/account"
 require_relative "resources/audiences"
+require_relative "resources/boards"
 require_relative "resources/campaigns"
 require_relative "resources/chats"
 require_relative "resources/contacts"
 require_relative "resources/engines"
 require_relative "resources/groups"
+require_relative "resources/identity"
+require_relative "resources/latest_chats"
 require_relative "resources/messages"
 require_relative "resources/newsletters"
 require_relative "resources/ping"
+require_relative "resources/realtime"
 require_relative "resources/scheduled_messages"
 require_relative "resources/suno"
 require_relative "resources/utils"
@@ -100,6 +104,22 @@ module Blueticks
       @messages ||= Resources::MessagesResource.new(self)
     end
 
+    def boards
+      @boards ||= Resources::BoardsResource.new(self)
+    end
+
+    def identity
+      @identity ||= Resources::IdentityResource.new(self)
+    end
+
+    def latest_chats
+      @latest_chats ||= Resources::LatestChatsResource.new(self)
+    end
+
+    def realtime
+      @realtime ||= Resources::RealtimeResource.new(self)
+    end
+
     def suno
       @suno ||= Resources::SunoResource.new(self)
     end

data/lib/blueticks/resources/boards.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative "../base_resource"
+require_relative "../types/boards"
+require_relative "../types/paginated"
+
+module Blueticks
+  module Resources
+    class BoardsResource < BaseResource
+      # List boards, newest first. Offset-paginated (Board rows).
+      #
+      # Requires the `boards:read` scope.
+      def list(order: nil, skip: nil, limit: nil)
+        params = {}
+        params["order"] = order unless order.nil?
+        params["skip"] = skip unless skip.nil?
+        params["limit"] = limit unless limit.nil?
+        env = client.request("GET", "/v1/boards", params: params.empty? ? nil : params)
+        Types::PaginatedPage.from_hash(env, item_type: Types::Board)
+      end
+
+      # Create or find a board.
+      #
+      # Returns the existing board for the given `domain`/`entity_kind` when one
+      # exists, otherwise creates it. Requires the `boards:write` scope.
+      def create(domain: nil, entity_kind: nil, name: nil, description: nil,
+                 agent_id: nil, memory_retention_days: nil)
+        body = {}
+        body["domain"] = domain unless domain.nil?
+        body["entity_kind"] = entity_kind unless entity_kind.nil?
+        body["name"] = name unless name.nil?
+        body["description"] = description unless description.nil?
+        body["agent_id"] = agent_id unless agent_id.nil?
+        body["memory_retention_days"] = memory_retention_days unless memory_retention_days.nil?
+        env = client.request("POST", "/v1/boards", body: body)
+        Types::BoardDetail.from_hash(env && env["data"])
+      end
+
+      # Get a board (with its columns) by id.
+      #
+      # Requires the `boards:read` scope.
+      def retrieve(board_id)
+        env = client.request("GET", "/v1/boards/#{board_id}")
+        Types::BoardDetail.from_hash(env && env["data"])
+      end
+
+      # List a board's items (tasks). Offset-paginated (BoardItem rows).
+      #
+      # Pass `active_only: true` to return only items updated within the
+      # retention window whose status is non-terminal. Filter by `status` label
+      # or `updated_since`. Requires the `boards:read` scope.
+      def list_items(board_id, status: nil, order: nil, active_only: nil,
+                     updated_since: nil, skip: nil, limit: nil)
+        params = {}
+        params["status"] = status unless status.nil?
+        params["order"] = order unless order.nil?
+        params["active_only"] = active_only unless active_only.nil?
+        params["updated_since"] = updated_since unless updated_since.nil?
+        params["skip"] = skip unless skip.nil?
+        params["limit"] = limit unless limit.nil?
+        env = client.request("GET", "/v1/boards/#{board_id}/items",
+                             params: params.empty? ? nil : params)
+        Types::PaginatedPage.from_hash(env, item_type: Types::BoardItem)
+      end
+
+      # Create a board item.
+      #
+      # Requires the `boards:write` scope.
+      def create_item(board_id, text:, status: nil, priority: nil, due_date: nil, cells: nil,
+                      source: nil, confidence: nil, allow_duplicate: nil)
+        body = { "text" => text }
+        body["status"] = status unless status.nil?
+        body["priority"] = priority unless priority.nil?
+        body["due_date"] = due_date unless due_date.nil?
+        body["cells"] = cells unless cells.nil?
+        body["source"] = source unless source.nil?
+        body["confidence"] = confidence unless confidence.nil?
+        body["allow_duplicate"] = allow_duplicate unless allow_duplicate.nil?
+        env = client.request("POST", "/v1/boards/#{board_id}/items", body: body)
+        Types::BoardItem.from_hash(env && env["data"])
+      end
+
+      # Update a board item. Pass any subset of the editable fields.
+      #
+      # Requires the `boards:write` scope.
+      def update_item(board_id, item_id, text: nil, status: nil, priority: nil, due_date: nil,
+                      cells: nil, source: nil, confidence: nil, deleted: nil, note: nil)
+        body = {}
+        body["text"] = text unless text.nil?
+        body["status"] = status unless status.nil?
+        body["priority"] = priority unless priority.nil?
+        body["due_date"] = due_date unless due_date.nil?
+        body["cells"] = cells unless cells.nil?
+        body["source"] = source unless source.nil?
+        body["confidence"] = confidence unless confidence.nil?
+        body["deleted"] = deleted unless deleted.nil?
+        body["note"] = note unless note.nil?
+        env = client.request("PATCH", "/v1/boards/#{board_id}/items/#{item_id}", body: body)
+        Types::BoardItem.from_hash(env && env["data"])
+      end
+
+      # Bulk upsert board items.
+      #
+      # `items` is an Array of item Hashes (same keys as `create_item`, string
+      # keys on the wire). Requires the `boards:write` scope.
+      def bulk_upsert_items(board_id, items:, mode: nil)
+        body = { "items" => items }
+        body["mode"] = mode unless mode.nil?
+        env = client.request("POST", "/v1/boards/#{board_id}/items/bulk", body: body)
+        Types::BulkItemsResult.from_hash(env && env["data"])
+      end
+
+      # Find existing board items similar to the given candidates.
+      #
+      # `candidates` is an Array of `{ "text" => "..." }` Hashes. Requires the
+      # `boards:read` scope.
+      def find_similar_items(board_id, candidates:)
+        env = client.request("POST", "/v1/boards/#{board_id}/items/find-similar",
+                             body: { "candidates" => candidates })
+        Types::FindSimilarResult.from_hash(env && env["data"])
+      end
+    end
+  end
+end

data/lib/blueticks/resources/chats.rb

@@ -9,9 +9,12 @@ module Blueticks
   module Resources
     class ChatsResource < BaseResource
       # List/search chats, newest first. Offset-paginated.
+      #
+      # `kinds` is an Array of chat kinds to keep (`%w[contact group newsletter]`);
+      # `since` keeps only chats whose last message is at/after that ISO 8601 instant.
       def list(search_token: nil, filter: nil, include_last_message: nil,
                include_extended_info: nil, include_without_name: nil,
-               include_archive: nil, skip: nil, limit: nil)
+               include_archive: nil, skip: nil, limit: nil, kinds: nil, since: nil)
         params = {}
         params["searchToken"] = search_token unless search_token.nil?
         params["filter"] = filter unless filter.nil?
@@ -21,6 +24,8 @@ module Blueticks
         params["includeArchive"] = include_archive unless include_archive.nil?
         params["skip"] = skip unless skip.nil?
         params["limit"] = limit unless limit.nil?
+        params["kinds"] = kinds unless kinds.nil? || kinds.empty?
+        params["since"] = since unless since.nil?
         env = client.request("GET", "/v1/chats", params: params.empty? ? nil : params)
         Types::PaginatedPage.from_hash(env, item_type: Types::Chat)
       end

data/lib/blueticks/resources/groups.rb

@@ -88,6 +88,21 @@ module Blueticks
         Types::Group.from_hash(env && env["data"])
       end
 
+      # Get the current group picture as a short-lived WhatsApp CDN `url`, or
+      # `url: nil` when the group has none. Requires `groups:read`.
+      def get_picture(group_id)
+        env = client.request("GET", "/v1/groups/#{group_id}/picture")
+        Types::GroupPicture.from_hash(env && env["data"])
+      end
+
+      # Remove the group picture. Gateway (Baileys) engine only: a
+      # Chrome-extension-only account gets 501 `unsupported_command`. Requires
+      # `groups:write`.
+      def remove_picture(group_id)
+        env = client.request("DELETE", "/v1/groups/#{group_id}/picture")
+        Types::GroupPictureRemoved.from_hash(env && env["data"])
+      end
+
       # Leave the group as the authenticated identity. Idempotent (204).
       def leave(group_id)
         client.request("DELETE", "/v1/groups/#{group_id}/members/me")

data/lib/blueticks/resources/identity.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../base_resource"
+require_relative "../types/identity"
+
+module Blueticks
+  module Resources
+    class IdentityResource < BaseResource
+      # Resolve an identity.
+      #
+      # Maps a WhatsApp JID (phone, `@lid` or group) to its canonical form and
+      # aliases. Requires the `contacts:read` scope.
+      def retrieve(id)
+        env = client.request("GET", "/v1/identity/#{id}")
+        Types::Identity.from_hash(env && env["data"])
+      end
+
+      # Resolve identities (batch).
+      #
+      # Resolves many JIDs in one call. Requires the `contacts:read` scope.
+      def resolve_batch(ids:)
+        env = client.request("POST", "/v1/identity/resolve", body: { "ids" => ids })
+        Types::IdentityBatch.from_hash(env && env["data"])
+      end
+    end
+  end
+end

data/lib/blueticks/resources/latest_chats.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../base_resource"
+require_relative "../types/latest_chats"
+
+module Blueticks
+  module Resources
+    class LatestChatsResource < BaseResource
+      # Get latest chats & messages.
+      #
+      # Returns the most recent chats, each with its latest messages, in one
+      # call. Requires the `chats:read` scope.
+      def retrieve(number_of_chats: nil, number_of_messages: nil)
+        params = {}
+        params["numberOfChats"] = number_of_chats unless number_of_chats.nil?
+        params["numberOfMessages"] = number_of_messages unless number_of_messages.nil?
+        env = client.request("GET", "/v1/latest-chats", params: params.empty? ? nil : params)
+        Types::LatestChats.from_hash(env && env["data"])
+      end
+    end
+  end
+end

data/lib/blueticks/resources/messages.rb

@@ -10,10 +10,13 @@ module Blueticks
     class MessagesResource < BaseResource
       # Query messages from the WhatsApp store, newest first. Offset-paginated
       # (PublicMessage rows). `message_types` is an Array of wire message types
-      # (e.g. `%w[chat image]`).
+      # (e.g. `%w[chat image]`). `query_any` is an Array of keywords matched with OR
+      # semantics; `mime`, `filename_contains`, `has_media` and `sender` narrow the
+      # result further.
       def list(chat_id: nil, search_token: nil, order: nil, since: nil, until_: nil,
                message_types: nil, load_from_phone_if_needed: nil,
-               include_media_content: nil, skip: nil, limit: nil)
+               include_media_content: nil, skip: nil, limit: nil,
+               query_any: nil, mime: nil, filename_contains: nil, has_media: nil, sender: nil)
         params = {}
         params["chatId"] = chat_id unless chat_id.nil?
         params["searchToken"] = search_token unless search_token.nil?
@@ -25,6 +28,11 @@ module Blueticks
         params["includeMediaContent"] = include_media_content unless include_media_content.nil?
         params["skip"] = skip unless skip.nil?
         params["limit"] = limit unless limit.nil?
+        params["queryAny"] = query_any unless query_any.nil? || query_any.empty?
+        params["mime"] = mime unless mime.nil?
+        params["filenameContains"] = filename_contains unless filename_contains.nil?
+        params["hasMedia"] = has_media unless has_media.nil?
+        params["sender"] = sender unless sender.nil?
         env = client.request("GET", "/v1/messages", params: params.empty? ? nil : params)
         Types::PaginatedPage.from_hash(env, item_type: Types::PublicMessage)
       end
@@ -54,8 +62,15 @@ module Blueticks
       end
 
       # Ask the engine to pull older history from the connected phone.
-      def load_older(chat_id)
-        env = client.request("POST", "/v1/messages/load_older/#{chat_id}")
+      #
+      # `pages` (1-10, default 1) is how many older pages to pull in one call;
+      # `until_date` (ISO 8601 string or epoch seconds/ms) stops paging once the
+      # oldest loaded message is at/before that date.
+      def load_older(chat_id, pages: nil, until_date: nil)
+        body = {}
+        body["pages"] = pages unless pages.nil?
+        body["until_date"] = until_date unless until_date.nil?
+        env = client.request("POST", "/v1/messages/load_older/#{chat_id}", body: body.empty? ? nil : body)
         Types::LoadOlderResult.from_hash(env && env["data"])
       end
 
@@ -105,7 +120,8 @@ module Blueticks
       def create(chat_id, type:, text: nil, media_url: nil, media_base64: nil,
                  media_kind: nil, media_filename: nil, poll_question: nil,
                  poll_options: nil, poll_allow_multiple: nil, reply_to: nil,
-                 secret: nil, with_typing: nil, typing_seconds: nil, idempotency_key: nil)
+                 secret: nil, with_typing: nil, typing_seconds: nil, idempotency_key: nil,
+                 mentions: nil)
         body = { "type" => type }
         body["text"] = text unless text.nil?
         body["mediaUrl"] = media_url unless media_url.nil?
@@ -119,6 +135,7 @@ module Blueticks
         body["secret"] = secret unless secret.nil?
         body["withTyping"] = with_typing unless with_typing.nil?
         body["typingSeconds"] = typing_seconds unless typing_seconds.nil?
+        body["mentions"] = mentions unless mentions.nil?
         env = client.request("POST", "/v1/messages/#{chat_id}", body: body, idempotency_key: idempotency_key)
         Types::Message.from_hash(env && env["data"])
       end

data/lib/blueticks/resources/realtime.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../base_resource"
+require_relative "../types/realtime"
+
+module Blueticks
+  module Resources
+    class RealtimeResource < BaseResource
+      # Get MQTT credentials for receiving messages in real time.
+      #
+      # Returns short-lived broker credentials and the topic to subscribe to.
+      # Requires the `chats:read` scope.
+      def create_token
+        env = client.request("POST", "/v1/realtime/token")
+        Types::RealtimeToken.from_hash(env && env["data"])
+      end
+    end
+  end
+end

data/lib/blueticks/resources/scheduled_messages.rb

@@ -15,6 +15,9 @@ module Blueticks
       # Omit `send_at` to dispatch as soon as possible, or pass an ISO-8601
       # timestamp to schedule it.
       #
+      # `mentions` is an Array of participant JIDs to @mention in a group;
+      # `recipient_name` is an optional display name for the scheduled-message list.
+      #
       # - `type: "text"`  — requires `text`.
       # - `type: "media"` — requires `media_url` or `media_base64`; optional
       #   `media_kind`, `media_filename`.
@@ -23,7 +26,8 @@ module Blueticks
       def create(chat_id, type:, text: nil, media_url: nil, media_base64: nil,
                  media_kind: nil, media_filename: nil, poll_question: nil,
                  poll_options: nil, poll_allow_multiple: nil, reply_to: nil,
-                 secret: nil, send_at: nil, idempotency_key: nil)
+                 secret: nil, send_at: nil, idempotency_key: nil,
+                 mentions: nil, recipient_name: nil)
         body = { "type" => type }
         body["text"] = text unless text.nil?
         body["mediaUrl"] = media_url unless media_url.nil?
@@ -36,6 +40,8 @@ module Blueticks
         body["replyTo"] = reply_to unless reply_to.nil?
         body["secret"] = secret unless secret.nil?
         body["sendAt"] = send_at unless send_at.nil?
+        body["mentions"] = mentions unless mentions.nil?
+        body["recipientName"] = recipient_name unless recipient_name.nil?
         env = client.request("POST", "/v1/scheduled-messages/#{chat_id}", body: body,
                                                                           idempotency_key: idempotency_key)
         Types::ScheduledMessage.from_hash(env && env["data"])
@@ -67,7 +73,7 @@ module Blueticks
       def update(message_id, type: nil, text: nil, media_url: nil, media_base64: nil,
                  media_kind: nil, media_filename: nil, poll_question: nil,
                  poll_options: nil, poll_allow_multiple: nil, reply_to: nil,
-                 secret: nil, send_at: nil)
+                 secret: nil, send_at: nil, mentions: nil)
         body = {}
         body["type"] = type unless type.nil?
         body["text"] = text unless text.nil?
@@ -81,6 +87,7 @@ module Blueticks
         body["replyTo"] = reply_to unless reply_to.nil?
         body["secret"] = secret unless secret.nil?
         body["sendAt"] = send_at unless send_at.nil?
+        body["mentions"] = mentions unless mentions.nil?
         env = client.request("PATCH", "/v1/scheduled-messages/#{message_id}", body: body)
         Types::ScheduledMessage.from_hash(env && env["data"])
       end

data/lib/blueticks/resources/suno.rb

@@ -12,15 +12,16 @@ module Blueticks
         Types::SunoAccount.from_hash(env && env["data"])
       end
 
-      # Submit a song generation job. Requires `lyrics` and `style`; the many
+      # Submit a song generation job. Requires `style`; `lyrics` is required unless `instrumental` is true. The many
       # optional knobs mirror the Suno request (vocal_gender, weirdness,
       # style_influence, audio_influence, instrumental, model, title, upload_id,
       # captcha_token, negative_style).
-      def create_song(lyrics:, style:, negative_style: nil, vocal_gender: nil,
+      def create_song(style:, lyrics: nil, negative_style: nil, vocal_gender: nil,
                       weirdness: nil, style_influence: nil, audio_influence: nil,
                       instrumental: nil, model: nil, title: nil, upload_id: nil,
                       captcha_token: nil)
-        body = { "lyrics" => lyrics, "style" => style }
+        body = { "style" => style }
+        body["lyrics"] = lyrics unless lyrics.nil?
         body["negativeStyle"] = negative_style unless negative_style.nil?
         body["vocalGender"] = vocal_gender unless vocal_gender.nil?
         body["weirdness"] = weirdness unless weirdness.nil?

data/lib/blueticks/types/boards.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Blueticks
+  module Types
+    # A status/priority label with its colour (OptionRef).
+    class BoardOption < Base
+      field :label, :string
+      field :bgcolor, :string
+    end
+
+    # A board column definition (BoardColumn). `type` is the column kind
+    # (e.g. "status", "text"); `options` lists the selectable labels.
+    class BoardColumn < Base
+      field :column_id, :string
+      field :title, :string
+      field :type, :string
+      field :options, [:array, BoardOption]
+    end
+
+    # A board summary (BoardRow) as returned by boards.list.
+    class Board < Base
+      field :board_id, :string
+      field :name, :string
+      field :description, :string, optional: true
+      field :domain, :string, optional: true
+      field :agent_managed, :boolean
+      field :memory_retention_days, :integer, optional: true
+      field :item_count, :integer, optional: true
+      field :web_url, :string
+      field :created_at, :string
+      field :updated_at, :string
+    end
+
+    # A board with its columns (BoardDetail) as returned by boards.create and
+    # boards.retrieve.
+    class BoardDetail < Base
+      field :board_id, :string
+      field :name, :string
+      field :description, :string, optional: true
+      field :domain, :string, optional: true
+      field :agent_managed, :boolean
+      field :memory_retention_days, :integer, optional: true
+      field :item_count, :integer, optional: true
+      field :web_url, :string
+      field :created_at, :string
+      field :updated_at, :string
+      field :columns, [:array, BoardColumn]
+    end
+
+    # Short board reference (BoardRef) embedded in a bulk-upsert result.
+    class BoardRef < Base
+      field :board_id, :string
+      field :name, :string
+      field :description, :string, optional: true
+      field :domain, :string, optional: true
+      field :web_url, :string
+    end
+
+    # The chat message an item was extracted from (ItemSource).
+    class ItemSource < Base
+      field :chat_id, :string, optional: true
+      field :chat_name, :string, optional: true
+      field :message_key, :string, optional: true
+      field :excerpt, :string, optional: true
+      field :extracted_at, :integer, optional: true
+    end
+
+    # A board item / task (BoardItem). `cells` holds custom column values keyed
+    # by column title (string or number).
+    class BoardItem < Base
+      field :item_id, :string
+      field :text, :string
+      field :status, BoardOption, optional: true
+      field :priority, BoardOption, optional: true
+      field :due_date, :string, optional: true
+      field :cells, :hash, optional: true
+      field :source, ItemSource, optional: true
+      field :confidence, :number, optional: true
+      field :last_seen_at, :integer, optional: true
+      field :web_url, :string
+      field :created_at, :string
+      field :updated_at, :string
+    end
+
+    # Result of a bulk upsert (BulkItemsResponse).
+    class BulkItemsResult < Base
+      field :created, [:array, BoardItem]
+      field :updated, [:array, BoardItem]
+      field :unchanged, :integer
+      field :board, BoardRef
+    end
+
+    # One candidate-to-existing-item match (FindSimilarResponse.matches[]).
+    class SimilarMatch < Base
+      field :candidate_index, :integer
+      field :item_id, :string
+      field :text, :string
+      field :score, :number
+    end
+
+    # Result of boards.find_similar_items (FindSimilarResponse). `misses` holds
+    # the indexes of candidates with no match.
+    class FindSimilarResult < Base
+      field :matches, [:array, SimilarMatch]
+      field :misses, %i[array integer]
+    end
+  end
+end

data/lib/blueticks/types/chats.rb

@@ -9,12 +9,12 @@ module Blueticks
     # A chat row (Chat) returned by chats.list / chats.retrieve.
     class Chat < Base
       field :chat_id, :string, wire_name: "chatId"
-      field :name, :string, nullable: true
+      field :name, :string, nullable: true, optional: true
       field :chat_type, [:enum, CHAT_TYPES], wire_name: "chatType"
       field :pinned, :boolean, optional: true
       field :archived, :boolean, optional: true
-      field :last_message_at, :string, nullable: true, wire_name: "lastMessageAt"
-      field :unread_count, :integer, nullable: true, wire_name: "unreadCount"
+      field :last_message_at, :string, nullable: true, optional: true, wire_name: "lastMessageAt"
+      field :unread_count, :integer, nullable: true, optional: true, wire_name: "unreadCount"
       field :marked_unread, :boolean, wire_name: "markedUnread"
       field :last_message_text, :string, nullable: true, optional: true, wire_name: "lastMessageText"
       field :last_message_from_me, :boolean, nullable: true, optional: true, wire_name: "lastMessageFromMe"

data/lib/blueticks/types/coverage.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Blueticks
+  module Types
+    # How far back a chat is loaded (LoadCoverage). `oldest_loaded_iso` is the
+    # deterministic answer to "have I reached far enough back?".
+    class Coverage < Base
+      field :oldest_loaded_timestamp, :number, optional: true, wire_name: "oldestLoadedTimestamp"
+      field :oldest_loaded_iso, :string, optional: true, wire_name: "oldestLoadedIso"
+    end
+  end
+end

data/lib/blueticks/types/groups.rb

@@ -27,6 +27,17 @@ module Blueticks
       field :participants, [:array, GroupParticipant], nullable: true
     end
 
+    # Current group picture (GroupPicture). `url` is a short-lived WhatsApp CDN
+    # URL, or nil when the group has no picture.
+    class GroupPicture < Base
+      field :url, :string, nullable: true
+    end
+
+    # Result of removing a group picture (GroupPictureRemoved).
+    class GroupPictureRemoved < Base
+      field :ok, :boolean
+    end
+
     # A group row in the groups.list / contacts.common_groups page
     # (GroupListItem) — a slimmer projection without announce/participants.
     class GroupListItem < Base

data/lib/blueticks/types/identity.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Blueticks
+  module Types
+    IDENTITY_TYPES = %w[user group unknown].freeze
+    IDENTITY_SOURCES = %w[engine cache unknown].freeze
+
+    # A resolved WhatsApp identity (Identity). `canonical`, `phone` and `lid`
+    # are absent/null when the identity could not be resolved.
+    class Identity < Base
+      field :input, :string
+      field :resolved, :boolean
+      field :canonical, :string, optional: true, nullable: true
+      field :phone, :string, optional: true, nullable: true
+      field :lid, :string, optional: true, nullable: true
+      field :aliases, %i[array string]
+      field :type, [:enum, IDENTITY_TYPES]
+      field :source, [:enum, IDENTITY_SOURCES]
+    end
+
+    # Batch identity-resolution result (IdentityBatchResponse).
+    class IdentityBatch < Base
+      field :data, [:array, Identity]
+    end
+  end
+end

data/lib/blueticks/types/latest_chats.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "chats"
+require_relative "messages"
+
+module Blueticks
+  module Types
+    # A chat row together with its latest messages (LatestChatWithMessages).
+    class LatestChat < Base
+      field :chat_id, :string, wire_name: "chatId"
+      field :name, :string, optional: true, nullable: true
+      field :chat_type, [:enum, CHAT_TYPES], wire_name: "chatType"
+      field :pinned, :boolean, optional: true
+      field :archived, :boolean, optional: true
+      field :last_message_at, :string, optional: true, nullable: true, wire_name: "lastMessageAt"
+      field :unread_count, :integer, optional: true, nullable: true, wire_name: "unreadCount"
+      field :marked_unread, :boolean, wire_name: "markedUnread"
+      field :last_message_text, :string, nullable: true, optional: true, wire_name: "lastMessageText"
+      field :last_message_from_me, :boolean, nullable: true, optional: true, wire_name: "lastMessageFromMe"
+      field :messages, [:array, PublicMessage]
+    end
+
+    # Latest chats and their messages (LatestChatsResponse) from GET /v1/latest-chats.
+    class LatestChats < Base
+      field :chats, [:array, LatestChat]
+      field :total_chats, :integer, wire_name: "totalChats"
+      field :number_of_chats, :integer, wire_name: "numberOfChats"
+      field :number_of_messages, :integer, wire_name: "numberOfMessages"
+    end
+  end
+end

data/lib/blueticks/types/messages.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "base"
+require_relative "coverage"
 
 module Blueticks
   module Types
     MESSAGE_KINDS = %w[text media poll].freeze
     MESSAGE_MEDIA_KINDS = %w[image video audio document sticker voice gif].freeze
     MEDIA_UNAVAILABLE_REASONS = %w[expired fetching awaiting_sender error no_media].freeze
+    MESSAGE_SOURCES = %w[vault backup].freeze
     MESSAGE_STATUSES = %w[
       pending before-wa-send bt-sent sending sent sent_pending_ack confirmed
       delivered received read played cancelled error failed expired
@@ -65,6 +67,8 @@ module Blueticks
       field :filename, :string, optional: true
       field :link_preview, PublicLinkPreview, optional: true, wire_name: "linkPreview"
       field :quoted_message, QuotedMessage, optional: true, wire_name: "quotedMessage"
+      field :source, [:enum, MESSAGE_SOURCES], optional: true
+      field :secret, :string, optional: true
     end
 
     # Media payload for a message (Media) returned by messages.get_media.
@@ -97,13 +101,17 @@ module Blueticks
       field :text, :string, nullable: true
     end
 
-    # Result of a load-older request (LoadOlderResult).
+    # Result of a load-older request (LoadOlderResult). `pages_executed` is how
+    # many older pages this call pulled; `coverage` says how far back the chat is
+    # now loaded.
     class LoadOlderResult < Base
       field :total_messages, :integer, nullable: true, wire_name: "totalMessages"
       field :added, :integer, nullable: true
       field :can_load_more, :boolean, wire_name: "canLoadMore"
       field :history_unavailable, :boolean, wire_name: "historyUnavailable"
       field :error, :string, nullable: true
+      field :pages_executed, :integer, wire_name: "pagesExecuted"
+      field :coverage, Coverage
     end
 
     # A sent/queued outbound message record — the shape returned by

data/lib/blueticks/types/paginated.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base"
+require_relative "coverage"
 require_relative "../errors"
 
 module Blueticks
@@ -11,21 +12,23 @@ module Blueticks
     # Iterate `data` for the current page; advance by passing `skip: skip + limit`
     # (or any offset) back on the next list call. `total` is the full match count
     # across all pages. `has_more` is populated only by endpoints that echo a
-    # `hasMore` flag (e.g. messages.list); nil elsewhere.
+    # `hasMore` flag (e.g. messages.list); nil elsewhere. `coverage` (Types::Coverage) is
+    # likewise populated only by messages.list.
     class PaginatedPage
-      attr_reader :data, :limit, :skip, :total, :has_more
+      attr_reader :data, :limit, :skip, :total, :has_more, :coverage
 
-      def initialize(data:, limit:, skip:, total:, has_more: nil)
+      def initialize(data:, limit:, skip:, total:, has_more: nil, coverage: nil)
         @data = data
         @limit = limit
         @skip = skip
         @total = total
         @has_more = has_more
+        @coverage = coverage
       end
 
       # Build a PaginatedPage from a raw list envelope, decoding each item via
       # item_type.from_hash. Reads `data`/`limit`/`skip`/`total` (and optional
-      # `hasMore`) off the envelope; ignores the `success` flag.
+      # `hasMore` / `coverage`) off the envelope; ignores the `success` flag.
       def self.from_hash(raw, item_type:)
         unless raw.is_a?(Hash)
           raise Errors::ValidationError.new(message: "Expected Hash for PaginatedPage, got #{raw.class}")
@@ -43,11 +46,13 @@ module Blueticks
           raise Errors::ValidationError.new(message: "Field 'hasMore' must be boolean or absent in PaginatedPage")
         end
 
+        coverage = raw["coverage"].nil? ? nil : Coverage.from_hash(raw["coverage"], context: "PaginatedPage.coverage")
+
         decoded = raw["data"].each_with_index.map do |item, i|
           item_type.from_hash(item, context: "PaginatedPage.data[#{i}]")
         end
 
-        new(data: decoded, limit: limit, skip: skip, total: total, has_more: has_more)
+        new(data: decoded, limit: limit, skip: skip, total: total, has_more: has_more, coverage: coverage)
       end
 
       def self.require_integer(raw, key)
@@ -62,7 +67,7 @@ module Blueticks
       def to_h
         {
           data: data.map { |d| d.respond_to?(:to_h) ? d.to_h : d },
-          limit: limit, skip: skip, total: total, has_more: has_more
+          limit: limit, skip: skip, total: total, has_more: has_more, coverage: coverage&.to_h
         }
       end
     end

data/lib/blueticks/types/realtime.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Blueticks
+  module Types
+    # MQTT topics the realtime credentials are authorised for.
+    class RealtimeTopics < Base
+      field :messages, :string
+    end
+
+    # Short-lived MQTT credentials for receiving messages in real time
+    # (RealtimeTokenResponse).
+    class RealtimeToken < Base
+      field :broker_url, :string, wire_name: "brokerUrl"
+      field :username, :string
+      field :password, :string
+      field :expires_at, :string, wire_name: "expiresAt"
+      field :expires_in_seconds, :integer, wire_name: "expiresInSeconds"
+      field :topics, RealtimeTopics
+    end
+  end
+end

data/lib/blueticks/types/webhooks.rb

@@ -16,11 +16,11 @@ module Blueticks
       group_admin_changed_webhook group_name_changed_webhook group_description_changed_webhook
       group_message_pinned_webhook poll_vote_webhook reply_to_my_message_webhook
       message_deleted_revoked_webhook message_edited_webhook
+      new_message_received_from_me_webhook
     ].freeze
 
-    # A webhook subscription (WebhookResponse). The signing secret is returned
-    # only out-of-band at creation time in the dashboard; it is not part of the
-    # API response body in 2.x.
+    # A webhook subscription (WebhookResponse). `signing_secret` is present only
+    # when the API includes it in the response body.
     class Webhook < Base
       field :id, :string
       field :url, :string
@@ -28,6 +28,7 @@ module Blueticks
       field :description, :string, nullable: true
       field :status, [:enum, WEBHOOK_STATUSES]
       field :created_at, :string, wire_name: "createdAt"
+      field :signing_secret, :string, optional: true, wire_name: "signingSecret"
     end
 
     # A delivered webhook event, as parsed by Blueticks::Webhooks.verify. Note

data/lib/blueticks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blueticks
-  VERSION = "2.0.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueticks
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Blueticks
@@ -68,14 +68,18 @@ files:
 - lib/blueticks/errors.rb
 - lib/blueticks/resources/account.rb
 - lib/blueticks/resources/audiences.rb
+- lib/blueticks/resources/boards.rb
 - lib/blueticks/resources/campaigns.rb
 - lib/blueticks/resources/chats.rb
 - lib/blueticks/resources/contacts.rb
 - lib/blueticks/resources/engines.rb
 - lib/blueticks/resources/groups.rb
+- lib/blueticks/resources/identity.rb
+- lib/blueticks/resources/latest_chats.rb
 - lib/blueticks/resources/messages.rb
 - lib/blueticks/resources/newsletters.rb
 - lib/blueticks/resources/ping.rb
+- lib/blueticks/resources/realtime.rb
 - lib/blueticks/resources/scheduled_messages.rb
 - lib/blueticks/resources/suno.rb
 - lib/blueticks/resources/utils.rb
@@ -84,18 +88,23 @@ files:
 - lib/blueticks/types/account.rb
 - lib/blueticks/types/audiences.rb
 - lib/blueticks/types/base.rb
+- lib/blueticks/types/boards.rb
 - lib/blueticks/types/campaigns.rb
 - lib/blueticks/types/chats.rb
 - lib/blueticks/types/contacts.rb
+- lib/blueticks/types/coverage.rb
 - lib/blueticks/types/deleted_resource.rb
 - lib/blueticks/types/engines.rb
 - lib/blueticks/types/groups.rb
+- lib/blueticks/types/identity.rb
+- lib/blueticks/types/latest_chats.rb
 - lib/blueticks/types/messages.rb
 - lib/blueticks/types/newsletter.rb
 - lib/blueticks/types/ok_result.rb
 - lib/blueticks/types/page.rb
 - lib/blueticks/types/paginated.rb
 - lib/blueticks/types/ping.rb
+- lib/blueticks/types/realtime.rb
 - lib/blueticks/types/scheduled_messages.rb
 - lib/blueticks/types/suno.rb
 - lib/blueticks/types/utils.rb