ruby-whatsapp 0.4.2 → 0.6.2

data/lib/ruby/whatsapp/webhook/user_preferences.rb

@@ -3,43 +3,64 @@
 module Whatsapp
   module Webhook
     # User marketing message preference changes (e.g. a customer opting out of
-    # marketing messages).
+    # marketing messages) — one of the fields with a confirmed, JSON-example-backed
+    # schema, alongside {Messages}, {UserIdUpdate}, and {BusinessUsernameUpdates}.
     #
-    # Best-effort schema: Meta's public docs describe this field in one line with
-    # no published JSON example. Validate against a real payload (App Dashboard
-    # "send test payload") before relying on these attribute names in production.
-    # Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/overview
+    # Structurally identical to {UserIdUpdate}: the value carries the notification's
+    # own identity (`messaging_product`, `metadata`, `contacts`) plus an array of
+    # entries nested under a repeat of the field's own name.
+    # Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids
     class UserPreferences
-      # @!attribute [rw] wa_id
+      # @!attribute [rw] messaging_product
       #   @return [String, nil]
-      attr_accessor :wa_id
+      attr_accessor :messaging_product
 
-      # @!attribute [rw] detail
-      #   @return [String, nil]
-      attr_accessor :detail
+      # @!attribute [rw] metadata
+      #   @return [Metadata, nil]
+      attr_accessor :metadata
 
-      # @!attribute [rw] value
-      #   @return [String, nil] e.g. `"stop"`, `"resume"`.
-      attr_accessor :value
+      # @!attribute [rw] contacts
+      #   @return [Array<Contact>] The users whose preferences changed, carrying the same
+      #     BSUID identifiers as every other `contacts[]` entry — which is how a
+      #     username-adopted user is identifiable here at all once their phone number
+      #     stops being shared.
+      attr_accessor :contacts
 
-      # @!attribute [rw] timestamp
-      #   @return [String, nil]
-      attr_accessor :timestamp
+      # @!attribute [rw] preferences
+      #   @return [Array<Entry>]
+      attr_accessor :preferences
+
+      # @!attribute [r] raw
+      #   @return [Hash] The untouched `value` hash. A diagnostic escape hatch, not part
+      #     of the supported API: {#preferences} reads `value["user_preferences"]` —
+      #     entries nested under a repeat of the field's own name, which is what Meta's
+      #     published example shows — so a key that drifts would otherwise leave
+      #     `preferences` empty with no other trace. Reach for it when a typed accessor is
+      #     unexpectedly `nil`, log what you find, and treat it as read-only: it is the
+      #     object `JSON.parse` returned, not a copy.
+      attr_reader :raw
 
-      def initialize(wa_id:, detail:, value:, timestamp:)
-        @wa_id = wa_id
-        @detail = detail
-        @value = value
-        @timestamp = timestamp
+      def initialize(messaging_product:, metadata:, contacts:, preferences:, raw: {})
+        @messaging_product = messaging_product
+        @metadata = metadata
+        @contacts = contacts
+        @preferences = preferences
+        @raw = raw
       end
 
       class << self
-        # @param data [Hash] The raw `value` hash.
+        # @param data [Hash] The raw `user_preferences` field's `value` hash.
         # @return [UserPreferences]
         def deserialize(data)
           data ||= {}
 
-          new(wa_id: data["wa_id"], detail: data["detail"], value: data["value"], timestamp: data["timestamp"])
+          new(
+            messaging_product: data["messaging_product"],
+            metadata: data["metadata"] ? Metadata.deserialize(data["metadata"]) : nil,
+            contacts: Array(data["contacts"]).map { |contact_data| Contact.deserialize(contact_data) },
+            preferences: Array(data["user_preferences"]).map { |entry_data| Entry.deserialize(entry_data) },
+            raw: data
+          )
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-whatsapp
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.2
 platform: ruby
 authors:
 - Raniery
@@ -85,7 +85,9 @@ files:
 - docs/README.md
 - docs/business_phone_number/README.md
 - docs/business_phone_number/account.md
+- docs/business_phone_number/contact_book.md
 - docs/business_phone_number/profile.md
+- docs/business_phone_number/username.md
 - docs/configuration.md
 - docs/errors.md
 - docs/media/README.md
@@ -112,6 +114,7 @@ files:
 - docs/messages/template.md
 - docs/messages/text.md
 - docs/messages/video.md
+- docs/schedule/README.md
 - docs/subscribed_app/README.md
 - docs/webhooks/README.md
 - docs/webhooks/account_alerts.md
@@ -119,6 +122,7 @@ files:
 - docs/webhooks/account_update.md
 - docs/webhooks/automatic_events.md
 - docs/webhooks/business_capability_update.md
+- docs/webhooks/business_username_updates.md
 - docs/webhooks/history.md
 - docs/webhooks/message_template_components_update.md
 - docs/webhooks/message_template_quality_update.md
@@ -132,6 +136,7 @@ files:
 - docs/webhooks/smb_app_state_sync.md
 - docs/webhooks/smb_message_echoes.md
 - docs/webhooks/template_category_update.md
+- docs/webhooks/user_id_update.md
 - docs/webhooks/user_preferences.md
 - lib/ruby/whatsapp.rb
 - lib/ruby/whatsapp/business_phone_number.rb
@@ -140,6 +145,9 @@ files:
 - lib/ruby/whatsapp/business_phone_number/account/get.rb
 - lib/ruby/whatsapp/business_phone_number/account/transport.rb
 - lib/ruby/whatsapp/business_phone_number/account/update.rb
+- lib/ruby/whatsapp/business_phone_number/contact_book.rb
+- lib/ruby/whatsapp/business_phone_number/contact_book/delete.rb
+- lib/ruby/whatsapp/business_phone_number/contact_book/deletion.rb
 - lib/ruby/whatsapp/business_phone_number/deregister.rb
 - lib/ruby/whatsapp/business_phone_number/profile.rb
 - lib/ruby/whatsapp/business_phone_number/profile/details.rb
@@ -150,6 +158,13 @@ files:
 - lib/ruby/whatsapp/business_phone_number/request_code.rb
 - lib/ruby/whatsapp/business_phone_number/response.rb
 - lib/ruby/whatsapp/business_phone_number/transport.rb
+- lib/ruby/whatsapp/business_phone_number/username.rb
+- lib/ruby/whatsapp/business_phone_number/username/claim.rb
+- lib/ruby/whatsapp/business_phone_number/username/delete.rb
+- lib/ruby/whatsapp/business_phone_number/username/details.rb
+- lib/ruby/whatsapp/business_phone_number/username/get.rb
+- lib/ruby/whatsapp/business_phone_number/username/suggest.rb
+- lib/ruby/whatsapp/business_phone_number/username/suggestions.rb
 - lib/ruby/whatsapp/business_phone_number/verify_code.rb
 - lib/ruby/whatsapp/client.rb
 - lib/ruby/whatsapp/configuration.rb
@@ -163,6 +178,7 @@ files:
 - lib/ruby/whatsapp/message_templates/button/otp/supported_app.rb
 - lib/ruby/whatsapp/message_templates/button/phone_number.rb
 - lib/ruby/whatsapp/message_templates/button/quick_reply.rb
+- lib/ruby/whatsapp/message_templates/button/request_contact_info.rb
 - lib/ruby/whatsapp/message_templates/button/url.rb
 - lib/ruby/whatsapp/message_templates/categories.rb
 - lib/ruby/whatsapp/message_templates/component.rb
@@ -221,6 +237,7 @@ files:
 - lib/ruby/whatsapp/messages/interactive/product_carousel/card.rb
 - lib/ruby/whatsapp/messages/interactive/reply_buttons.rb
 - lib/ruby/whatsapp/messages/interactive/reply_buttons/button.rb
+- lib/ruby/whatsapp/messages/interactive/request_contact_info.rb
 - lib/ruby/whatsapp/messages/interactive/url_button.rb
 - lib/ruby/whatsapp/messages/location.rb
 - lib/ruby/whatsapp/messages/location_request.rb
@@ -240,6 +257,15 @@ files:
 - lib/ruby/whatsapp/railtie.rb
 - lib/ruby/whatsapp/request_error.rb
 - lib/ruby/whatsapp/response_handling.rb
+- lib/ruby/whatsapp/schedule.rb
+- lib/ruby/whatsapp/schedule/create.rb
+- lib/ruby/whatsapp/schedule/list.rb
+- lib/ruby/whatsapp/schedule/response.rb
+- lib/ruby/whatsapp/schedule/response/collection.rb
+- lib/ruby/whatsapp/schedule/response/created.rb
+- lib/ruby/whatsapp/schedule/response/node.rb
+- lib/ruby/whatsapp/schedule/statuses.rb
+- lib/ruby/whatsapp/schedule/transport.rb
 - lib/ruby/whatsapp/subscribed_app.rb
 - lib/ruby/whatsapp/subscribed_app/list.rb
 - lib/ruby/whatsapp/subscribed_app/response.rb
@@ -259,11 +285,14 @@ files:
 - lib/ruby/whatsapp/webhook/account_update/ban_info.rb
 - lib/ruby/whatsapp/webhook/automatic_events.rb
 - lib/ruby/whatsapp/webhook/business_capability_update.rb
+- lib/ruby/whatsapp/webhook/business_username_updates.rb
 - lib/ruby/whatsapp/webhook/change.rb
 - lib/ruby/whatsapp/webhook/contact.rb
 - lib/ruby/whatsapp/webhook/entry.rb
 - lib/ruby/whatsapp/webhook/error.rb
 - lib/ruby/whatsapp/webhook/history.rb
+- lib/ruby/whatsapp/webhook/history/chunk.rb
+- lib/ruby/whatsapp/webhook/history/thread.rb
 - lib/ruby/whatsapp/webhook/installer.rb
 - lib/ruby/whatsapp/webhook/message.rb
 - lib/ruby/whatsapp/webhook/message/audio.rb
@@ -279,6 +308,7 @@ files:
 - lib/ruby/whatsapp/webhook/message/contacts/url.rb
 - lib/ruby/whatsapp/webhook/message/context.rb
 - lib/ruby/whatsapp/webhook/message/document.rb
+- lib/ruby/whatsapp/webhook/message/edit.rb
 - lib/ruby/whatsapp/webhook/message/image.rb
 - lib/ruby/whatsapp/webhook/message/interactive.rb
 - lib/ruby/whatsapp/webhook/message/location.rb
@@ -287,6 +317,7 @@ files:
 - lib/ruby/whatsapp/webhook/message/order/product_item.rb
 - lib/ruby/whatsapp/webhook/message/reaction.rb
 - lib/ruby/whatsapp/webhook/message/referral.rb
+- lib/ruby/whatsapp/webhook/message/revoke.rb
 - lib/ruby/whatsapp/webhook/message/sticker.rb
 - lib/ruby/whatsapp/webhook/message/system.rb
 - lib/ruby/whatsapp/webhook/message/text.rb
@@ -305,15 +336,21 @@ files:
 - lib/ruby/whatsapp/webhook/security.rb
 - lib/ruby/whatsapp/webhook/signature.rb
 - lib/ruby/whatsapp/webhook/smb_app_state_sync.rb
+- lib/ruby/whatsapp/webhook/smb_app_state_sync/contact.rb
 - lib/ruby/whatsapp/webhook/smb_app_state_sync/state_sync.rb
 - lib/ruby/whatsapp/webhook/smb_message_echoes.rb
+- lib/ruby/whatsapp/webhook/smb_message_echoes/echo.rb
 - lib/ruby/whatsapp/webhook/status.rb
 - lib/ruby/whatsapp/webhook/status/conversation.rb
 - lib/ruby/whatsapp/webhook/status/pricing.rb
 - lib/ruby/whatsapp/webhook/template_category_update.rb
 - lib/ruby/whatsapp/webhook/templates/webhooks_controller.rb.tt
 - lib/ruby/whatsapp/webhook/unknown_field.rb
+- lib/ruby/whatsapp/webhook/user_id_update.rb
+- lib/ruby/whatsapp/webhook/user_id_update/entry.rb
+- lib/ruby/whatsapp/webhook/user_id_update/id_change.rb
 - lib/ruby/whatsapp/webhook/user_preferences.rb
+- lib/ruby/whatsapp/webhook/user_preferences/entry.rb
 - lib/ruby/whatsapp/webhook/verification.rb
 - lib/tasks/whatsapp.rake
 - sig/ruby/whatsapp.rbs