zavudev 0.6.0 → 0.8.0

data/rbi/zavudev/models/invitation_create_params.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationCreateParams, Zavudev::Internal::AnyHash)
+        end
+
+      # ISO country codes for allowed phone numbers.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :allowed_phone_countries
+
+      sig { params(allowed_phone_countries: T::Array[String]).void }
+      attr_writer :allowed_phone_countries
+
+      # Email of the client being invited.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_email
+
+      sig { params(client_email: String).void }
+      attr_writer :client_email
+
+      # Name of the client being invited.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_name
+
+      sig { params(client_name: String).void }
+      attr_writer :client_name
+
+      # Phone number of the client in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_phone
+
+      sig { params(client_phone: String).void }
+      attr_writer :client_phone
+
+      # Number of days until the invitation expires.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :expires_in_days
+
+      sig { params(expires_in_days: Integer).void }
+      attr_writer :expires_in_days
+
+      # ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      # the client will use this number instead of their own.
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number_id
+
+      sig { params(phone_number_id: String).void }
+      attr_writer :phone_number_id
+
+      sig do
+        params(
+          allowed_phone_countries: T::Array[String],
+          client_email: String,
+          client_name: String,
+          client_phone: String,
+          expires_in_days: Integer,
+          phone_number_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ISO country codes for allowed phone numbers.
+        allowed_phone_countries: nil,
+        # Email of the client being invited.
+        client_email: nil,
+        # Name of the client being invited.
+        client_name: nil,
+        # Phone number of the client in E.164 format.
+        client_phone: nil,
+        # Number of days until the invitation expires.
+        expires_in_days: nil,
+        # ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+        # the client will use this number instead of their own.
+        phone_number_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allowed_phone_countries: T::Array[String],
+            client_email: String,
+            client_name: String,
+            client_phone: String,
+            expires_in_days: Integer,
+            phone_number_id: String,
+            request_options: Zavudev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_create_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCreateResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::InvitationCreateResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Invitation) }
+      attr_reader :invitation
+
+      sig { params(invitation: Zavudev::Invitation::OrHash).void }
+      attr_writer :invitation
+
+      sig do
+        params(invitation: Zavudev::Invitation::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(invitation:)
+      end
+
+      sig { override.returns({ invitation: Zavudev::Invitation }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_list_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationListParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Current status of the partner invitation.
+      sig do
+        returns(T.nilable(Zavudev::InvitationListParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: Zavudev::InvitationListParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::InvitationListParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        cursor: nil,
+        limit: nil,
+        # Current status of the partner invitation.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            limit: Integer,
+            status: Zavudev::InvitationListParams::Status::OrSymbol,
+            request_options: Zavudev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Current status of the partner invitation.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::InvitationListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(:pending, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        IN_PROGRESS =
+          T.let(
+            :in_progress,
+            Zavudev::InvitationListParams::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(:completed, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        EXPIRED =
+          T.let(:expired, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        CANCELLED =
+          T.let(:cancelled, Zavudev::InvitationListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::InvitationListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationRetrieveParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :invitation_id
+
+      sig do
+        params(
+          invitation_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(invitation_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { invitation_id: String, request_options: Zavudev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_retrieve_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::InvitationRetrieveResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Invitation) }
+      attr_reader :invitation
+
+      sig { params(invitation: Zavudev::Invitation::OrHash).void }
+      attr_writer :invitation
+
+      sig do
+        params(invitation: Zavudev::Invitation::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(invitation:)
+      end
+
+      sig { override.returns({ invitation: Zavudev::Invitation }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/message_content.rbi

@@ -28,6 +28,50 @@ module Zavudev
       end
       attr_writer :contacts
 
+      # Button label for cta_url messages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cta_display_text
+
+      sig { params(cta_display_text: String).void }
+      attr_writer :cta_display_text
+
+      # Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or
+      # 'document'. WhatsApp fetches this URL — it must be publicly reachable and return
+      # the declared content type.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cta_header_media_url
+
+      sig { params(cta_header_media_url: String).void }
+      attr_writer :cta_header_media_url
+
+      # Header text when ctaHeaderType is 'text'.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cta_header_text
+
+      sig { params(cta_header_text: String).void }
+      attr_writer :cta_header_text
+
+      # Optional header type for cta_url messages.
+      sig do
+        returns(T.nilable(Zavudev::MessageContent::CtaHeaderType::OrSymbol))
+      end
+      attr_reader :cta_header_type
+
+      sig do
+        params(
+          cta_header_type: Zavudev::MessageContent::CtaHeaderType::OrSymbol
+        ).void
+      end
+      attr_writer :cta_header_type
+
+      # Destination URL opened in the device's default browser when the button is
+      # tapped. Used with messageType=cta_url. WhatsApp requires HTTPS in production.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cta_url
+
+      sig { params(cta_url: String).void }
+      attr_writer :cta_url
+
       # Emoji for reaction messages.
       sig { returns(T.nilable(String)) }
       attr_reader :emoji
@@ -42,6 +86,13 @@ module Zavudev
       sig { params(filename: String).void }
       attr_writer :filename
 
+      # Optional footer text for cta_url messages.
+      sig { returns(T.nilable(String)) }
+      attr_reader :footer_text
+
+      sig { params(footer_text: String).void }
+      attr_writer :footer_text
+
       # Latitude for location messages.
       sig { returns(T.nilable(Float)) }
       attr_reader :latitude
@@ -116,6 +167,26 @@ module Zavudev
       end
       attr_writer :sections
 
+      # Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys
+      # are the button index (0, 1, 2) in the template's `buttons` array — not the
+      # placeholder name. Values substitute the `{{1}}` placeholder inside that button's
+      # URL.
+      #
+      # **WhatsApp constraints:**
+      #
+      # - URL buttons only accept `{{1}}` — positional, numeric, no whitespace, no name.
+      #   Named placeholders like `{{token}}` are stored as literal URL text by Meta and
+      #   cannot be substituted.
+      # - At most one placeholder per URL button.
+      # - A template may have at most three buttons.
+      # - Static URL buttons (no placeholder) and `quick_reply` buttons are not included
+      #   here.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :template_button_variables
+
+      sig { params(template_button_variables: T::Hash[Symbol, String]).void }
+      attr_writer :template_button_variables
+
       # Template ID for template messages.
       sig { returns(T.nilable(String)) }
       attr_reader :template_id
@@ -123,7 +194,8 @@ module Zavudev
       sig { params(template_id: String).void }
       attr_writer :template_id
 
-      # Variables for template rendering. Keys are variable positions (1, 2, 3...).
+      # Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the
+      # order placeholders appear in the template body.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :template_variables
 
@@ -135,8 +207,14 @@ module Zavudev
         params(
           buttons: T::Array[Zavudev::MessageContent::Button::OrHash],
           contacts: T::Array[Zavudev::MessageContent::Contact::OrHash],
+          cta_display_text: String,
+          cta_header_media_url: String,
+          cta_header_text: String,
+          cta_header_type: Zavudev::MessageContent::CtaHeaderType::OrSymbol,
+          cta_url: String,
           emoji: String,
           filename: String,
+          footer_text: String,
           latitude: Float,
           list_button: String,
           location_address: String,
@@ -147,6 +225,7 @@ module Zavudev
           mime_type: String,
           react_to_message_id: String,
           sections: T::Array[Zavudev::MessageContent::Section::OrHash],
+          template_button_variables: T::Hash[Symbol, String],
           template_id: String,
           template_variables: T::Hash[Symbol, String]
         ).returns(T.attached_class)
@@ -156,10 +235,25 @@ module Zavudev
         buttons: nil,
         # Contact cards for contact messages.
         contacts: nil,
+        # Button label for cta_url messages.
+        cta_display_text: nil,
+        # Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or
+        # 'document'. WhatsApp fetches this URL — it must be publicly reachable and return
+        # the declared content type.
+        cta_header_media_url: nil,
+        # Header text when ctaHeaderType is 'text'.
+        cta_header_text: nil,
+        # Optional header type for cta_url messages.
+        cta_header_type: nil,
+        # Destination URL opened in the device's default browser when the button is
+        # tapped. Used with messageType=cta_url. WhatsApp requires HTTPS in production.
+        cta_url: nil,
         # Emoji for reaction messages.
         emoji: nil,
         # Filename for documents.
         filename: nil,
+        # Optional footer text for cta_url messages.
+        footer_text: nil,
         # Latitude for location messages.
         latitude: nil,
         # Button text for list messages.
@@ -180,9 +274,25 @@ module Zavudev
         react_to_message_id: nil,
         # Sections for list messages.
         sections: nil,
+        # Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys
+        # are the button index (0, 1, 2) in the template's `buttons` array — not the
+        # placeholder name. Values substitute the `{{1}}` placeholder inside that button's
+        # URL.
+        #
+        # **WhatsApp constraints:**
+        #
+        # - URL buttons only accept `{{1}}` — positional, numeric, no whitespace, no name.
+        #   Named placeholders like `{{token}}` are stored as literal URL text by Meta and
+        #   cannot be substituted.
+        # - At most one placeholder per URL button.
+        # - A template may have at most three buttons.
+        # - Static URL buttons (no placeholder) and `quick_reply` buttons are not included
+        #   here.
+        template_button_variables: nil,
         # Template ID for template messages.
         template_id: nil,
-        # Variables for template rendering. Keys are variable positions (1, 2, 3...).
+        # Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the
+        # order placeholders appear in the template body.
         template_variables: nil
       )
       end
@@ -192,8 +302,14 @@ module Zavudev
           {
             buttons: T::Array[Zavudev::MessageContent::Button],
             contacts: T::Array[Zavudev::MessageContent::Contact],
+            cta_display_text: String,
+            cta_header_media_url: String,
+            cta_header_text: String,
+            cta_header_type: Zavudev::MessageContent::CtaHeaderType::OrSymbol,
+            cta_url: String,
             emoji: String,
             filename: String,
+            footer_text: String,
             latitude: Float,
             list_button: String,
             location_address: String,
@@ -204,6 +320,7 @@ module Zavudev
             mime_type: String,
             react_to_message_id: String,
             sections: T::Array[Zavudev::MessageContent::Section],
+            template_button_variables: T::Hash[Symbol, String],
             template_id: String,
             template_variables: T::Hash[Symbol, String]
           }
@@ -264,6 +381,32 @@ module Zavudev
         end
       end
 
+      # Optional header type for cta_url messages.
+      module CtaHeaderType
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::MessageContent::CtaHeaderType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TEXT =
+          T.let(:text, Zavudev::MessageContent::CtaHeaderType::TaggedSymbol)
+        IMAGE =
+          T.let(:image, Zavudev::MessageContent::CtaHeaderType::TaggedSymbol)
+        VIDEO =
+          T.let(:video, Zavudev::MessageContent::CtaHeaderType::TaggedSymbol)
+        DOCUMENT =
+          T.let(:document, Zavudev::MessageContent::CtaHeaderType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::MessageContent::CtaHeaderType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Section < Zavudev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/zavudev/models/message_type.rbi

@@ -20,6 +20,7 @@ module Zavudev
       CONTACT = T.let(:contact, Zavudev::MessageType::TaggedSymbol)
       BUTTONS = T.let(:buttons, Zavudev::MessageType::TaggedSymbol)
       LIST = T.let(:list, Zavudev::MessageType::TaggedSymbol)
+      CTA_URL = T.let(:cta_url, Zavudev::MessageType::TaggedSymbol)
       REACTION = T.let(:reaction, Zavudev::MessageType::TaggedSymbol)
       TEMPLATE = T.let(:template, Zavudev::MessageType::TaggedSymbol)