zavudev 0.6.0 → 0.8.0

data/rbi/zavudev/models/template_create_params.rbi

@@ -48,6 +48,33 @@ module Zavudev
       sig { params(code_expiration_minutes: Integer).void }
       attr_writer :code_expiration_minutes
 
+      # Footer text for the template.
+      sig { returns(T.nilable(String)) }
+      attr_reader :footer
+
+      sig { params(footer: String).void }
+      attr_writer :footer
+
+      # Header content (text string or media URL).
+      sig { returns(T.nilable(String)) }
+      attr_reader :header_content
+
+      sig { params(header_content: String).void }
+      attr_writer :header_content
+
+      # Type of header for the template.
+      sig do
+        returns(T.nilable(Zavudev::TemplateCreateParams::HeaderType::OrSymbol))
+      end
+      attr_reader :header_type
+
+      sig do
+        params(
+          header_type: Zavudev::TemplateCreateParams::HeaderType::OrSymbol
+        ).void
+      end
+      attr_writer :header_type
+
       # Channel-specific body for Instagram. Falls back to `body` if not set.
       sig { returns(T.nilable(String)) }
       attr_reader :instagram_body
@@ -92,6 +119,9 @@ module Zavudev
           add_security_recommendation: T::Boolean,
           buttons: T::Array[Zavudev::TemplateCreateParams::Button::OrHash],
           code_expiration_minutes: Integer,
+          footer: String,
+          header_content: String,
+          header_type: Zavudev::TemplateCreateParams::HeaderType::OrSymbol,
           instagram_body: String,
           sms_body: String,
           telegram_body: String,
@@ -111,6 +141,12 @@ module Zavudev
         buttons: nil,
         # Code expiration time in minutes. Only for AUTHENTICATION templates.
         code_expiration_minutes: nil,
+        # Footer text for the template.
+        footer: nil,
+        # Header content (text string or media URL).
+        header_content: nil,
+        # Type of header for the template.
+        header_type: nil,
         # Channel-specific body for Instagram. Falls back to `body` if not set.
         instagram_body: nil,
         # Channel-specific body for SMS. Falls back to `body` if not set.
@@ -133,6 +169,9 @@ module Zavudev
             add_security_recommendation: T::Boolean,
             buttons: T::Array[Zavudev::TemplateCreateParams::Button],
             code_expiration_minutes: Integer,
+            footer: String,
+            header_content: String,
+            header_type: Zavudev::TemplateCreateParams::HeaderType::OrSymbol,
             instagram_body: String,
             sms_body: String,
             telegram_body: String,
@@ -160,6 +199,15 @@ module Zavudev
         sig { returns(Zavudev::TemplateCreateParams::Button::Type::OrSymbol) }
         attr_accessor :type
 
+        # Sample value Meta uses to review templates with a dynamic URL button.
+        # Substituted into `{{1}}` of the URL when the template is submitted to Meta. Only
+        # meaningful when `url` contains `{{1}}`; ignored for static URLs.
+        sig { returns(T.nilable(String)) }
+        attr_reader :example
+
+        sig { params(example: String).void }
+        attr_writer :example
+
         # Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
         # Android autofill.
         sig do
@@ -196,6 +244,9 @@ module Zavudev
         sig { params(signature_hash: String).void }
         attr_writer :signature_hash
 
+        # Button destination. Use `{{1}}` exactly once for a dynamic URL (e.g.
+        # `https://example.com/orders/{{1}}`); WhatsApp only accepts the strict `{{1}}`
+        # form. Static URLs must not contain any `{{...}}` placeholder.
         sig { returns(T.nilable(String)) }
         attr_reader :url
 
@@ -206,6 +257,7 @@ module Zavudev
           params(
             text: String,
             type: Zavudev::TemplateCreateParams::Button::Type::OrSymbol,
+            example: String,
             otp_type: Zavudev::TemplateCreateParams::Button::OtpType::OrSymbol,
             package_name: String,
             phone_number: String,
@@ -216,6 +268,10 @@ module Zavudev
         def self.new(
           text:,
           type:,
+          # Sample value Meta uses to review templates with a dynamic URL button.
+          # Substituted into `{{1}}` of the URL when the template is submitted to Meta. Only
+          # meaningful when `url` contains `{{1}}`; ignored for static URLs.
+          example: nil,
           # Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
           # Android autofill.
           otp_type: nil,
@@ -224,6 +280,9 @@ module Zavudev
           phone_number: nil,
           # Android app signature hash. Required for ONE_TAP buttons.
           signature_hash: nil,
+          # Button destination. Use `{{1}}` exactly once for a dynamic URL (e.g.
+          # `https://example.com/orders/{{1}}`); WhatsApp only accepts the strict `{{1}}`
+          # form. Static URLs must not contain any `{{...}}` placeholder.
           url: nil
         )
         end
@@ -233,6 +292,7 @@ module Zavudev
             {
               text: String,
               type: Zavudev::TemplateCreateParams::Button::Type::OrSymbol,
+              example: String,
               otp_type:
                 Zavudev::TemplateCreateParams::Button::OtpType::OrSymbol,
               package_name: String,
@@ -319,6 +379,37 @@ module Zavudev
           end
         end
       end
+
+      # Type of header for the template.
+      module HeaderType
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Zavudev::TemplateCreateParams::HeaderType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TEXT =
+          T.let(:text, Zavudev::TemplateCreateParams::HeaderType::TaggedSymbol)
+        IMAGE =
+          T.let(:image, Zavudev::TemplateCreateParams::HeaderType::TaggedSymbol)
+        VIDEO =
+          T.let(:video, Zavudev::TemplateCreateParams::HeaderType::TaggedSymbol)
+        DOCUMENT =
+          T.let(
+            :document,
+            Zavudev::TemplateCreateParams::HeaderType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::TemplateCreateParams::HeaderType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/zavudev/models/url_list_verified_params.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class URLListVerifiedParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::URLListVerifiedParams, 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
+
+      # Filter by verification status.
+      sig do
+        returns(T.nilable(Zavudev::URLListVerifiedParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: Zavudev::URLListVerifiedParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::URLListVerifiedParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        cursor: nil,
+        limit: nil,
+        # Filter by verification status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            limit: Integer,
+            status: Zavudev::URLListVerifiedParams::Status::OrSymbol,
+            request_options: Zavudev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by verification status.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::URLListVerifiedParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(:pending, Zavudev::URLListVerifiedParams::Status::TaggedSymbol)
+        APPROVED =
+          T.let(:approved, Zavudev::URLListVerifiedParams::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, Zavudev::URLListVerifiedParams::Status::TaggedSymbol)
+        MALICIOUS =
+          T.let(
+            :malicious,
+            Zavudev::URLListVerifiedParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::URLListVerifiedParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/url_retrieve_details_params.rbi

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

data/rbi/zavudev/models/url_retrieve_details_response.rbi

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

data/rbi/zavudev/models/url_submit_for_verification_params.rbi

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

data/rbi/zavudev/models/url_submit_for_verification_response.rbi

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

data/rbi/zavudev/models/usage_retrieve_params.rbi

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

data/rbi/zavudev/models/usage_retrieve_response.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class UsageRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::UsageRetrieveResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      # Emails sent this month.
+      sig { returns(Integer) }
+      attr_accessor :emails_sent
+
+      sig { returns(Zavudev::Models::UsageRetrieveResponse::Limits) }
+      attr_reader :limits
+
+      sig do
+        params(
+          limits: Zavudev::Models::UsageRetrieveResponse::Limits::OrHash
+        ).void
+      end
+      attr_writer :limits
+
+      # A2P messages sent this month (WhatsApp replies + Telegram).
+      sig { returns(Integer) }
+      attr_accessor :messages_a2_p
+
+      # Current month in YYYY-MM format.
+      sig { returns(String) }
+      attr_accessor :month_key
+
+      sig do
+        returns(Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol)
+      end
+      attr_accessor :tier
+
+      sig do
+        params(
+          emails_sent: Integer,
+          limits: Zavudev::Models::UsageRetrieveResponse::Limits::OrHash,
+          messages_a2_p: Integer,
+          month_key: String,
+          tier: Zavudev::Models::UsageRetrieveResponse::Tier::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Emails sent this month.
+        emails_sent:,
+        limits:,
+        # A2P messages sent this month (WhatsApp replies + Telegram).
+        messages_a2_p:,
+        # Current month in YYYY-MM format.
+        month_key:,
+        tier:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            emails_sent: Integer,
+            limits: Zavudev::Models::UsageRetrieveResponse::Limits,
+            messages_a2_p: Integer,
+            month_key: String,
+            tier: Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Limits < Zavudev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Zavudev::Models::UsageRetrieveResponse::Limits,
+              Zavudev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :emails
+
+        sig { params(emails: Integer).void }
+        attr_writer :emails
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :messages_a2_p
+
+        sig { params(messages_a2_p: Integer).void }
+        attr_writer :messages_a2_p
+
+        sig do
+          params(emails: Integer, messages_a2_p: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(emails: nil, messages_a2_p: nil)
+        end
+
+        sig { override.returns({ emails: Integer, messages_a2_p: Integer }) }
+        def to_hash
+        end
+      end
+
+      module Tier
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Zavudev::Models::UsageRetrieveResponse::Tier)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FREE =
+          T.let(
+            :free,
+            Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol
+          )
+        PRO =
+          T.let(
+            :pro,
+            Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol
+          )
+        SCALE =
+          T.let(
+            :scale,
+            Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol
+          )
+        ENTERPRISE =
+          T.let(
+            :enterprise,
+            Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::Models::UsageRetrieveResponse::Tier::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end