blueticks 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36b093b9a84f49a90a4879b8c804dfbcbaef3facbce8e8e6d55d1a14977d9f7
-  data.tar.gz: befdb19cf0c64e60eec29804a03b202987e28d26c9ca3502e1ec96591eca7ac2
+  metadata.gz: 19df800ede192ab6e262f3faeff874072d9c880466ad6d17cd5de461cdbf0b07
+  data.tar.gz: 25804da58032e239b22ef1027365fb05f12dd778633a542d52b41910eab3bffb
 SHA512:
-  metadata.gz: e5004e9c6a34d01463d01d2e094ed9a86b18cd3b464ad8ca1796336fdb4d60b0f195fbdc976a69be862f672ce90c755f4a2f56231e86f633300e719ff20e4f6b
-  data.tar.gz: 731a42669ae6dc5dd916edb3a12c6939ea5a3ab9dff35e269c622e25cd2c8e420b2d41d91854bafbf2fd2f743bab0eea52f2de68b1daf8502fd22c07c87d1667
+  metadata.gz: a2a0ab6b4d585f6a93a51a0a13d55dda3e87d2499c32ae932c36a29448ce09e2a886e97c9d8c4b8ba6457ae63aa9de15d79d5a8e8530eaee2451ce02a9d1bd97
+  data.tar.gz: 05c7bcd1cc42f0604961fe157234a3dc1604304f93e276b57425504aea42453eaeb2f3e9da3c6b6f01350d1d7a33134d76cd8247c98f1c59928d45aea03becbc

data/lib/blueticks/resources/audiences.rb

@@ -2,6 +2,7 @@
 
 require_relative "../base_resource"
 require_relative "../types/audiences"
+require_relative "../types/deleted_resource"
 require_relative "../types/page"
 
 module Blueticks
@@ -35,8 +36,8 @@ module Blueticks
       end
 
       def delete(audience_id)
-        client.request("DELETE", "/v1/audiences/#{audience_id}")
-        nil
+        data = client.request("DELETE", "/v1/audiences/#{audience_id}")
+        Types::DeletedResource.from_hash(data)
       end
 
       def append_contacts(audience_id, contacts:)

data/lib/blueticks/resources/chats.rb

@@ -35,12 +35,14 @@ module Blueticks
 
       # Mark a chat as read (sends read receipts if enabled).
       def mark_read(chat_id)
-        client.request("POST", "/v1/chats/#{chat_id}/mark_read")
+        data = client.request("POST", "/v1/chats/#{chat_id}/mark_read")
+        Types::OkResponse.from_hash(data)
       end
 
       # Open a chat on the engine (useful for UI-assisted workflows).
       def open(chat_id)
-        client.request("POST", "/v1/chats/#{chat_id}/open")
+        data = client.request("POST", "/v1/chats/#{chat_id}/open")
+        Types::ChatRef.from_hash(data)
       end
 
       # List messages in a chat. `mode` is "latest" or "history".
@@ -57,38 +59,54 @@ module Blueticks
         Types::Page.from_hash(data, item_type: Types::ChatMessage)
       end
 
+      # Retrieve a single message in a chat by its key.
       def get_message(chat_id, key)
         data = client.request("GET", "/v1/chats/#{chat_id}/messages/#{key}")
         Types::ChatMessage.from_hash(data)
       end
 
+      # Get message delivery status (ack value: -1=error, 0=pending, 1=server, 2=device, 3=read, 4=played).
       def get_message_ack(chat_id, key)
-        client.request("GET", "/v1/chats/#{chat_id}/messages/#{key}/ack")
+        data = client.request("GET", "/v1/chats/#{chat_id}/messages/#{key}/ack")
+        Types::MessageAck.from_hash(data)
       end
 
+      # React to a message. Pass an empty `emoji` string to remove a reaction.
       def react(chat_id, key, emoji:)
-        client.request(
+        data = client.request(
           "POST",
           "/v1/chats/#{chat_id}/messages/#{key}/reactions",
           body: { "emoji" => emoji }
         )
+        Types::OkResponse.from_hash(data)
       end
 
+      # Ask the engine to pull older history from the connected phone.
       def load_older_messages(chat_id)
-        client.request("POST", "/v1/chats/#{chat_id}/messages/load_older")
+        data = client.request("POST", "/v1/chats/#{chat_id}/messages/load_older")
+        Types::LoadOlderMessagesResponse.from_hash(data)
       end
 
+      # Get a hosted URL for the message media without inlining bytes.
+      def get_media_url(chat_id, key)
+        data = client.request("GET", "/v1/chats/#{chat_id}/messages/#{key}/media_url")
+        Types::MediaUrlResponse.from_hash(data)
+      end
+
+      # Fetch full media bytes (base64) for a message.
       def get_media(chat_id, key)
         data = client.request("GET", "/v1/chats/#{chat_id}/messages/#{key}/media")
         Types::ChatMedia.from_hash(data)
       end
 
+      # Batch get delivery status for up to 200 sent messages.
       def batch_message_acks(message_keys:)
-        client.request(
+        data = client.request(
           "POST",
           "/v1/chats/message_acks",
           body: { "message_keys" => message_keys }
         )
+        Types::BatchMessageAcksResponse.from_hash(data)
       end
     end
   end

data/lib/blueticks/resources/groups.rb

@@ -24,34 +24,48 @@ module Blueticks
         body = {}
         body["name"] = name unless name.nil?
         body["settings"] = settings unless settings.nil?
-        client.request("PATCH", "/v1/groups/#{group_id}", body: body)
+        data = client.request("PATCH", "/v1/groups/#{group_id}", body: body)
+        Types::Group.from_hash(data)
       end
 
+      # Add a participant to the group by chat_id (JID) or +E.164 phone.
       def add_member(group_id, chat_id:)
-        client.request("POST", "/v1/groups/#{group_id}/members", body: { "chat_id" => chat_id })
+        data = client.request("POST", "/v1/groups/#{group_id}/members",
+                              body: { "chat_id" => chat_id })
+        Types::Group.from_hash(data)
       end
 
+      # Remove a participant from the group.
       def remove_member(group_id, chat_id)
-        client.request("DELETE", "/v1/groups/#{group_id}/members/#{chat_id}")
+        data = client.request("DELETE", "/v1/groups/#{group_id}/members/#{chat_id}")
+        Types::Group.from_hash(data)
       end
 
+      # Grant admin privileges to a group member.
       def promote_admin(group_id, chat_id)
-        client.request("POST", "/v1/groups/#{group_id}/members/#{chat_id}/admin")
+        data = client.request("POST", "/v1/groups/#{group_id}/members/#{chat_id}/admin")
+        Types::Group.from_hash(data)
       end
 
+      # Revoke admin privileges from a group member.
       def demote_admin(group_id, chat_id)
-        client.request("DELETE", "/v1/groups/#{group_id}/members/#{chat_id}/admin")
+        data = client.request("DELETE", "/v1/groups/#{group_id}/members/#{chat_id}/admin")
+        Types::Group.from_hash(data)
       end
 
+      # Replace the group picture. `file_data_url` is a base64 data URL (PNG/JPEG, <=20 MiB).
       def set_picture(group_id, file_data_url:, file_name: nil, file_mime_type: nil)
         body = { "file_data_url" => file_data_url }
         body["file_name"] = file_name unless file_name.nil?
         body["file_mime_type"] = file_mime_type unless file_mime_type.nil?
-        client.request("PUT", "/v1/groups/#{group_id}/picture", body: body)
+        data = client.request("PUT", "/v1/groups/#{group_id}/picture", body: body)
+        Types::Group.from_hash(data)
       end
 
+      # Leave the group as the authenticated identity. Idempotent (204).
       def leave(group_id)
         client.request("DELETE", "/v1/groups/#{group_id}/members/me")
+        nil
       end
     end
   end

data/lib/blueticks/resources/scheduled_messages.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../base_resource"
+require_relative "../types/deleted_resource"
 require_relative "../types/scheduled_messages"
 require_relative "../types/page"
 
@@ -41,10 +42,11 @@ module Blueticks
 
       # Cancel scheduled message.
       #
-      # Removes the resource with id.
+      # Cancel a queued scheduled message before it fires. Soft-deletes the row
+      # (still queryable in audit logs). Returns the deleted ref.
       def delete(id)
         data = client.request("DELETE", "/v1/scheduled-messages/#{id}")
-        Types::ScheduledMessage.from_hash(data)
+        Types::DeletedResource.from_hash(data)
       end
     end
   end

data/lib/blueticks/resources/webhooks.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../base_resource"
+require_relative "../types/deleted_resource"
 require_relative "../types/webhooks"
 require_relative "../types/page"
 
@@ -39,8 +40,8 @@ module Blueticks
       end
 
       def delete(webhook_id)
-        client.request("DELETE", "/v1/webhooks/#{webhook_id}")
-        nil
+        data = client.request("DELETE", "/v1/webhooks/#{webhook_id}")
+        Types::DeletedResource.from_hash(data)
       end
 
       def rotate_secret(webhook_id)

data/lib/blueticks/types/chats.rb

@@ -47,5 +47,45 @@ module Blueticks
       field :original_quality, :boolean, nullable: true
       field :media_unavailable, [:enum, MEDIA_UNAVAILABLE_REASONS], nullable: true
     end
+
+    # Generic `{ "ok": true }` response envelope returned by acknowledged side-effects.
+    class OkResponse < Base
+      field :ok, :boolean
+    end
+
+    # `{ "chat_id": "..." }` envelope returned by /v1/chats/{chat_id}/open.
+    class ChatRef < Base
+      field :chat_id, :string
+    end
+
+    # `{ "ack": int|null }` envelope returned by .../messages/{key}/ack.
+    class MessageAck < Base
+      field :ack, :integer, nullable: true
+    end
+
+    # Response from POST /v1/chats/{chat_id}/messages/load_older.
+    class LoadOlderMessagesResponse < Base
+      field :total_messages, :integer, nullable: true
+      field :added, :integer, nullable: true
+      field :can_load_more, :boolean
+    end
+
+    # Response from GET /v1/chats/{chat_id}/messages/{key}/media_url.
+    class MediaUrlResponse < Base
+      field :url, :string, nullable: true
+    end
+
+    # Single entry in the BatchMessageAcksResponse `data` array.
+    # `{ "key": "<message key>", "ack": <int|null> }`.
+    class BatchMessageAckEntry < Base
+      field :key, :string
+      field :ack, :integer, nullable: true
+    end
+
+    # Response from POST /v1/chats/message_acks.
+    # `{ "data": [BatchMessageAckEntry, ...] }`.
+    class BatchMessageAcksResponse < Base
+      field :data, [:array, BatchMessageAckEntry]
+    end
   end
 end

data/lib/blueticks/types/deleted_resource.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Blueticks
+  module Types
+    # Response envelope returned by DELETE endpoints that confirm a soft-deletion.
+    # Shape: `{ "id": "<resource id>", "deleted": true }`.
+    class DeletedResource < Base
+      field :id, :string
+      field :deleted, [:enum, [true]]
+    end
+  end
+end

data/lib/blueticks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueticks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Blueticks
@@ -85,6 +85,7 @@ files:
 - lib/blueticks/types/campaigns.rb
 - lib/blueticks/types/chats.rb
 - lib/blueticks/types/contacts.rb
+- lib/blueticks/types/deleted_resource.rb
 - lib/blueticks/types/engines.rb
 - lib/blueticks/types/groups.rb
 - lib/blueticks/types/messages.rb