zavudev 0.20.0 → 0.21.0

data/lib/zavudev/models/contact_list_params.rb

@@ -8,6 +8,7 @@ module Zavudev
       include Zavudev::Internal::Type::RequestParameters
 
       # @!attribute cursor
+      #   Opaque cursor from a previous response's `nextCursor`. Do not construct it.
       #
       #   @return [String, nil]
       optional :cursor, String
@@ -18,14 +19,52 @@ module Zavudev
       optional :limit, Integer
 
       # @!attribute phone_number
+      #   Exact match on the contact's primary phone number, in E.164.
       #
       #   @return [String, nil]
       optional :phone_number, String
 
-      # @!method initialize(cursor: nil, limit: nil, phone_number: nil, request_options: {})
-      #   @param cursor [String]
+      # @!attribute search
+      #   Free-text match over the contact's name (`displayName` and the WhatsApp profile
+      #   name), phone numbers and email addresses. Case- and accent-insensitive. A phone
+      #   number matches on a trailing fragment too, so `5551234` finds `+14155551234`.
+      #
+      #   Contacts created automatically from an inbound message have no `displayName` —
+      #   they are matched by their identifier until you set one with
+      #   `PATCH /v1/contacts/{contactId}`.
+      #
+      #   Results come back in relevance order rather than newest-first. `cursor` is
+      #   opaque in both modes; pass back exactly what the previous response returned, and
+      #   start a new pagination run when the search term changes.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
+      # @!attribute tag
+      #   Tag name. Repeatable: `?tag=vip&tag=chile` returns contacts carrying **every**
+      #   tag given, not any of them — the same rule the dashboard filter applies.
+      #
+      #   Tags are matched by name, case-insensitively. An unknown tag returns 400 rather
+      #   than being ignored, because a typo that silently matched every contact would be
+      #   a worse answer than an error.
+      #
+      #   @return [Array<String>, nil]
+      optional :tag, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(cursor: nil, limit: nil, phone_number: nil, search: nil, tag: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::ContactListParams} for more details.
+      #
+      #   @param cursor [String] Opaque cursor from a previous response's `nextCursor`. Do not construct it.
+      #
       #   @param limit [Integer]
-      #   @param phone_number [String]
+      #
+      #   @param phone_number [String] Exact match on the contact's primary phone number, in E.164.
+      #
+      #   @param search [String] Free-text match over the contact's name (`displayName` and the WhatsApp profile
+      #
+      #   @param tag [Array<String>] Tag name. Repeatable: `?tag=vip&tag=chile` returns contacts carrying **every** t
+      #
       #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/zavudev/models/contact_update_params.rb

@@ -21,16 +21,29 @@ module Zavudev
                api_name: :defaultChannel,
                nil?: true
 
+      # @!attribute display_name
+      #   Human-readable name for this contact. Set to null to clear it and fall back to
+      #   the contact's identifier. Contacts created automatically from an inbound message
+      #   have no display name until you set one.
+      #
+      #   @return [String, nil]
+      optional :display_name, String, api_name: :displayName, nil?: true
+
       # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Zavudev::Internal::Type::HashOf[String]
 
-      # @!method initialize(contact_id:, default_channel: nil, metadata: nil, request_options: {})
+      # @!method initialize(contact_id:, default_channel: nil, display_name: nil, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::ContactUpdateParams} for more details.
+      #
       #   @param contact_id [String]
       #
       #   @param default_channel [Symbol, Zavudev::Models::ContactUpdateParams::DefaultChannel, nil] Preferred channel for this contact. Set to null to clear.
       #
+      #   @param display_name [String, nil] Human-readable name for this contact. Set to null to clear it and fall back to t
+      #
       #   @param metadata [Hash{Symbol=>String}]
       #
       #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]

data/lib/zavudev/models/conversation_list_messages_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Conversations#list_messages
+    class ConversationListMessagesParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute conversation_id
+      #
+      #   @return [String]
+      required :conversation_id, String
+
+      # @!attribute cursor
+      #   Opaque cursor from a previous response's `nextCursor`.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(conversation_id:, cursor: nil, limit: nil, request_options: {})
+      #   @param conversation_id [String]
+      #
+      #   @param cursor [String] Opaque cursor from a previous response's `nextCursor`.
+      #
+      #   @param limit [Integer]
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/conversation_list_params.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Conversations#list
+    class ConversationListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute channel
+      #   Keep only threads that have carried this channel.
+      #
+      #   @return [Symbol, Zavudev::Models::ConversationListParams::Channel, nil]
+      optional :channel, enum: -> { Zavudev::ConversationListParams::Channel }
+
+      # @!attribute cursor
+      #   Opaque cursor from a previous response's `nextCursor`. Do not construct it.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute search
+      #   Search threads by identity: phone number (any format — `+1 (555) 123-4567` and
+      #   `15551234567` both match), email address (full or local part), WhatsApp group
+      #   subject, WhatsApp username, or BSUID. Matching is by whole word, with prefix
+      #   matching on the last term, so `mar` finds `maria@example.com` and `+1555` finds
+      #   `+15551234567`; a fragment from the middle or end of a number (`4567`) does not
+      #   match.
+      #
+      #   It does **not** search message bodies — only who the thread is with.
+      #
+      #   Results come back ranked by relevance rather than by recency, so the usual "most
+      #   recently active first" ordering does not apply while `q` is set. `senderId` and
+      #   `channel` still narrow the results, and `cursor` paginates them as usual. An
+      #   empty or whitespace-only `q` returns no items rather than the full list.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
+      # @!attribute sender_id
+      #   Keep only threads last handled by this sender.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String
+
+      # @!method initialize(channel: nil, cursor: nil, limit: nil, search: nil, sender_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::ConversationListParams} for more details.
+      #
+      #   @param channel [Symbol, Zavudev::Models::ConversationListParams::Channel] Keep only threads that have carried this channel.
+      #
+      #   @param cursor [String] Opaque cursor from a previous response's `nextCursor`. Do not construct it.
+      #
+      #   @param limit [Integer]
+      #
+      #   @param search [String] Search threads by identity: phone number (any format — `+1 (555) 123-4567` and `
+      #
+      #   @param sender_id [String] Keep only threads last handled by this sender.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Keep only threads that have carried this channel.
+      module Channel
+        extend Zavudev::Internal::Type::Enum
+
+        SMS = :sms
+        SMS_ONEWAY = :sms_oneway
+        WHATSAPP = :whatsapp
+        EMAIL = :email
+        TELEGRAM = :telegram
+        INSTAGRAM = :instagram
+        MESSENGER = :messenger
+        VOICE = :voice
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/conversation_list_response.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Conversations#list
+    class ConversationListResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channels
+      #   Every channel this thread has carried messages on.
+      #
+      #   @return [Array<String>]
+      required :channels, Zavudev::Internal::Type::ArrayOf[String]
+
+      # @!attribute contact_identifier
+      #   The key this thread is filed under: a phone number in E.164, a WhatsApp
+      #   business-scoped user ID (BSUID), a numeric chat ID
+      #   (Telegram/Instagram/Messenger), or a group JID. It is not always a phone number,
+      #   so do not parse it as one.
+      #
+      #   @return [String]
+      required :contact_identifier, String, api_name: :contactIdentifier
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute last_message
+      #   Denormalized preview of the most recent message, so a thread list needs no extra
+      #   fetch.
+      #
+      #   @return [Zavudev::Models::ConversationListResponse::LastMessage]
+      required :last_message,
+               -> { Zavudev::Models::ConversationListResponse::LastMessage },
+               api_name: :lastMessage
+
+      # @!attribute message_count
+      #
+      #   @return [Integer]
+      required :message_count, Integer, api_name: :messageCount
+
+      # @!attribute unread_count
+      #   Inbound messages not yet marked read. Reset with POST
+      #   /v1/conversations/{conversationId}/read.
+      #
+      #   @return [Integer]
+      required :unread_count, Integer, api_name: :unreadCount
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute contact_id
+      #   ID of the contact this thread belongs to. Absent on group threads and on threads
+      #   whose contact has not been resolved yet.
+      #
+      #   @return [String, nil]
+      optional :contact_id, String, api_name: :contactId
+
+      # @!attribute email
+      #   Email address of the thread, when the contact was reached by email.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute group
+      #   Present when the thread is a group chat rather than a one-to-one conversation.
+      #
+      #   @return [Zavudev::Models::ConversationListResponse::Group, nil]
+      optional :group, -> { Zavudev::Models::ConversationListResponse::Group }
+
+      # @!attribute sender_id
+      #   Sender that last handled this thread. Use it as the `Zavu-Sender` header when
+      #   replying so the answer leaves from the same number the contact knows.
+      #
+      #   @return [String, nil]
+      optional :sender_id, String, api_name: :senderId
+
+      # @!attribute whatsapp
+      #   WhatsApp identity, present when the contact adopted a username.
+      #
+      #   @return [Zavudev::Models::ConversationListResponse::Whatsapp, nil]
+      optional :whatsapp, -> { Zavudev::Models::ConversationListResponse::Whatsapp }
+
+      # @!method initialize(id:, channels:, contact_identifier:, created_at:, last_message:, message_count:, unread_count:, updated_at:, contact_id: nil, email: nil, group: nil, sender_id: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::ConversationListResponse} for more details.
+      #
+      #   An inbox thread with one contact. A conversation groups every message exchanged
+      #   with that contact across channels, so a contact who writes on WhatsApp and later
+      #   by email stays in one thread.
+      #
+      #   @param id [String]
+      #
+      #   @param channels [Array<String>] Every channel this thread has carried messages on.
+      #
+      #   @param contact_identifier [String] The key this thread is filed under: a phone number in E.164, a WhatsApp business
+      #
+      #   @param created_at [Time]
+      #
+      #   @param last_message [Zavudev::Models::ConversationListResponse::LastMessage] Denormalized preview of the most recent message, so a thread list needs no extra
+      #
+      #   @param message_count [Integer]
+      #
+      #   @param unread_count [Integer] Inbound messages not yet marked read. Reset with POST /v1/conversations/{convers
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param contact_id [String] ID of the contact this thread belongs to. Absent on group threads and on threads
+      #
+      #   @param email [String] Email address of the thread, when the contact was reached by email.
+      #
+      #   @param group [Zavudev::Models::ConversationListResponse::Group] Present when the thread is a group chat rather than a one-to-one conversation.
+      #
+      #   @param sender_id [String] Sender that last handled this thread. Use it as the `Zavu-Sender` header when re
+      #
+      #   @param whatsapp [Zavudev::Models::ConversationListResponse::Whatsapp] WhatsApp identity, present when the contact adopted a username.
+
+      # @see Zavudev::Models::ConversationListResponse#last_message
+      class LastMessage < Zavudev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute at
+        #
+        #   @return [Time]
+        required :at, Time
+
+        # @!attribute channel
+        #   Delivery channel. Use 'auto' for intelligent routing.
+        #
+        #   @return [Symbol, Zavudev::Models::Channel]
+        required :channel, enum: -> { Zavudev::Channel }
+
+        # @!attribute direction
+        #
+        #   @return [Symbol, Zavudev::Models::ConversationListResponse::LastMessage::Direction]
+        required :direction, enum: -> { Zavudev::Models::ConversationListResponse::LastMessage::Direction }
+
+        # @!attribute text
+        #   Text or caption. Empty when the last message carried no text (e.g. media).
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!method initialize(id:, at:, channel:, direction:, text:)
+        #   Denormalized preview of the most recent message, so a thread list needs no extra
+        #   fetch.
+        #
+        #   @param id [String]
+        #
+        #   @param at [Time]
+        #
+        #   @param channel [Symbol, Zavudev::Models::Channel] Delivery channel. Use 'auto' for intelligent routing.
+        #
+        #   @param direction [Symbol, Zavudev::Models::ConversationListResponse::LastMessage::Direction]
+        #
+        #   @param text [String] Text or caption. Empty when the last message carried no text (e.g. media).
+
+        # @see Zavudev::Models::ConversationListResponse::LastMessage#direction
+        module Direction
+          extend Zavudev::Internal::Type::Enum
+
+          INBOUND = :inbound
+          OUTBOUND = :outbound
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Zavudev::Models::ConversationListResponse#group
+      class Group < Zavudev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_count
+        #
+        #   @return [Integer, nil]
+        optional :participant_count, Integer, api_name: :participantCount
+
+        # @!attribute subject
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!method initialize(id:, participant_count: nil, subject: nil)
+        #   Present when the thread is a group chat rather than a one-to-one conversation.
+        #
+        #   @param id [String]
+        #   @param participant_count [Integer]
+        #   @param subject [String]
+      end
+
+      # @see Zavudev::Models::ConversationListResponse#whatsapp
+      class Whatsapp < Zavudev::Internal::Type::BaseModel
+        # @!attribute bsuid
+        #   Business-scoped user ID. Can be used as `to` when sending.
+        #
+        #   @return [String, nil]
+        optional :bsuid, String
+
+        # @!attribute username
+        #
+        #   @return [String, nil]
+        optional :username, String
+
+        # @!method initialize(bsuid: nil, username: nil)
+        #   WhatsApp identity, present when the contact adopted a username.
+        #
+        #   @param bsuid [String] Business-scoped user ID. Can be used as `to` when sending.
+        #
+        #   @param username [String]
+      end
+    end
+  end
+end

data/lib/zavudev/models/conversation_mark_as_read_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Conversations#mark_as_read
+    class ConversationMarkAsReadParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute conversation_id
+      #
+      #   @return [String]
+      required :conversation_id, String
+
+      # @!method initialize(conversation_id:, request_options: {})
+      #   @param conversation_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end