zavudev 0.7.0 → 0.8.0

data/rbi/zavudev/models/sub_accounts/api_key_revoke_params.rbi

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

data/rbi/zavudev/models/template.rbi

@@ -217,6 +217,14 @@ module Zavudev
             T.any(Zavudev::Template::Button, Zavudev::Internal::AnyHash)
           end
 
+        # Sample value used to substitute `{{1}}` in the URL when submitting the template
+        # to Meta for review. Only present for dynamic URL buttons.
+        sig { returns(T.nilable(String)) }
+        attr_reader :example
+
+        sig { params(example: String).void }
+        attr_writer :example
+
         # OTP button type. Required when type is 'otp'.
         sig do
           returns(T.nilable(Zavudev::Template::Button::OtpType::TaggedSymbol))
@@ -270,6 +278,7 @@ module Zavudev
 
         sig do
           params(
+            example: String,
             otp_type: Zavudev::Template::Button::OtpType::OrSymbol,
             package_name: String,
             phone_number: String,
@@ -280,6 +289,9 @@ module Zavudev
           ).returns(T.attached_class)
         end
         def self.new(
+          # Sample value used to substitute `{{1}}` in the URL when submitting the template
+          # to Meta for review. Only present for dynamic URL buttons.
+          example: nil,
           # OTP button type. Required when type is 'otp'.
           otp_type: nil,
           # Android package name. Required for ONE_TAP buttons.
@@ -296,6 +308,7 @@ module Zavudev
         sig do
           override.returns(
             {
+              example: String,
               otp_type: Zavudev::Template::Button::OtpType::TaggedSymbol,
               package_name: String,
               phone_number: String,

data/rbi/zavudev/models/template_create_params.rbi

@@ -199,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
@@ -235,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
 
@@ -245,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,
@@ -255,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,
@@ -263,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
@@ -272,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,

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

data/rbi/zavudev/models/verified_url.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class VerifiedURL < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Zavudev::VerifiedURL, Zavudev::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Domain extracted from the URL.
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Status of a verified URL.
+      sig { returns(Zavudev::VerifiedURL::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # The verified URL.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # How the URL was approved or rejected.
+      sig do
+        returns(T.nilable(Zavudev::VerifiedURL::ApprovalType::TaggedSymbol))
+      end
+      attr_reader :approval_type
+
+      sig do
+        params(approval_type: Zavudev::VerifiedURL::ApprovalType::OrSymbol).void
+      end
+      attr_writer :approval_type
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          domain: String,
+          status: Zavudev::VerifiedURL::Status::OrSymbol,
+          url: String,
+          approval_type: Zavudev::VerifiedURL::ApprovalType::OrSymbol,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        # Domain extracted from the URL.
+        domain:,
+        # Status of a verified URL.
+        status:,
+        # The verified URL.
+        url:,
+        # How the URL was approved or rejected.
+        approval_type: nil,
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            domain: String,
+            status: Zavudev::VerifiedURL::Status::TaggedSymbol,
+            url: String,
+            approval_type: Zavudev::VerifiedURL::ApprovalType::TaggedSymbol,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Status of a verified URL.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::VerifiedURL::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:pending, Zavudev::VerifiedURL::Status::TaggedSymbol)
+        APPROVED = T.let(:approved, Zavudev::VerifiedURL::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, Zavudev::VerifiedURL::Status::TaggedSymbol)
+        MALICIOUS =
+          T.let(:malicious, Zavudev::VerifiedURL::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Zavudev::VerifiedURL::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # How the URL was approved or rejected.
+      module ApprovalType
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::VerifiedURL::ApprovalType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MANUAL =
+          T.let(:manual, Zavudev::VerifiedURL::ApprovalType::TaggedSymbol)
+        AUTO_WEB_RISK =
+          T.let(
+            :auto_web_risk,
+            Zavudev::VerifiedURL::ApprovalType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::VerifiedURL::ApprovalType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end