zavudev 0.6.0 → 0.8.0

data/rbi/zavudev/resources/sub_accounts.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class SubAccounts
+      sig { returns(Zavudev::Resources::SubAccounts::APIKeys) }
+      attr_reader :api_keys
+
+      # Create a new sub-account (project) with its own API key. All charges are billed
+      # to the parent team's balance. Use creditLimit to set a spending cap. The
+      # sub-account's API key is returned only in the creation response.
+      sig do
+        params(
+          name: String,
+          credit_limit: Integer,
+          external_id: String,
+          metadata: T::Hash[Symbol, T.anything],
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::SubAccountCreateResponse)
+      end
+      def create(
+        # Name of the sub-account.
+        name:,
+        # Spending cap in cents. When reached, messages from this sub-account will be
+        # blocked. Omit or set to 0 for no limit.
+        credit_limit: nil,
+        # External reference ID for your own tracking.
+        external_id: nil,
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Get sub-account
+      sig do
+        params(
+          id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::SubAccountRetrieveResponse)
+      end
+      def retrieve(
+        # Sub-account ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update sub-account
+      sig do
+        params(
+          id: String,
+          credit_limit: T.nilable(Integer),
+          external_id: String,
+          metadata: T::Hash[Symbol, T.anything],
+          name: String,
+          status: Zavudev::SubAccountUpdateParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::SubAccountUpdateResponse)
+      end
+      def update(
+        # Sub-account ID.
+        id,
+        credit_limit: nil,
+        external_id: nil,
+        metadata: nil,
+        name: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # List sub-accounts for this team.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Internal::Cursor[Zavudev::SubAccount])
+      end
+      def list(cursor: nil, limit: nil, request_options: {})
+      end
+
+      # Deactivate a sub-account. Remaining balance is returned to the parent team and
+      # all API keys are revoked.
+      sig do
+        params(
+          id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::SubAccountDeactivateResponse)
+      end
+      def deactivate(
+        # Sub-account ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get spending information for a sub-account. Returns the parent team's balance,
+      # the sub-account's total spending, and its credit limit (spending cap).
+      sig do
+        params(
+          id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::SubAccountGetBalanceResponse)
+      end
+      def get_balance(
+        # Sub-account ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Zavudev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/templates.rbi

@@ -13,6 +13,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,
@@ -32,6 +35,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.

data/rbi/zavudev/resources/urls.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class URLs
+      # List URLs that have been verified for this project.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::URLListVerifiedParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Internal::Cursor[Zavudev::VerifiedURL])
+      end
+      def list_verified(
+        cursor: nil,
+        limit: nil,
+        # Filter by verification status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Get details of a specific verified URL.
+      sig do
+        params(
+          url_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::URLRetrieveDetailsResponse)
+      end
+      def retrieve_details(url_id, request_options: {})
+      end
+
+      # Submit a URL for verification. URLs are automatically checked against Google Web
+      # Risk API. Safe URLs are auto-approved, malicious URLs are blocked. URL
+      # shorteners (bit.ly, t.co, etc.) are always blocked.
+      #
+      # **Important:** All SMS and Email messages containing URLs require those URLs to
+      # be verified before the message can be sent. This endpoint allows
+      # pre-verification of URLs.
+      sig do
+        params(
+          url: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::URLSubmitForVerificationResponse)
+      end
+      def submit_for_verification(
+        # The URL to submit for verification.
+        url:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Zavudev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/usage.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Usage
+      # Get the current month's usage counters for A2P messages and emails, along with
+      # the tier limits.
+      sig do
+        params(request_options: Zavudev::RequestOptions::OrHash).returns(
+          Zavudev::Models::UsageRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Zavudev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/zavudev/client.rbs

@@ -28,6 +28,22 @@ module Zavudev
 
     attr_reader regulatory_documents: Zavudev::Resources::RegulatoryDocuments
 
+    attr_reader invitations: Zavudev::Resources::Invitations
+
+    attr_reader exports: Zavudev::Resources::Exports
+
+    attr_reader urls: Zavudev::Resources::URLs
+
+    attr_reader balance: Zavudev::Resources::Balance
+
+    attr_reader plan: Zavudev::Resources::Plan
+
+    attr_reader usage: Zavudev::Resources::Usage
+
+    attr_reader sub_accounts: Zavudev::Resources::SubAccounts
+
+    attr_reader number_10dlc: Zavudev::Resources::Number10dlc
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/zavudev/models/balance_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module Zavudev
+  module Models
+    type balance_retrieve_params =
+      {  } & Zavudev::Internal::Type::request_parameters
+
+    class BalanceRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Zavudev::request_opts) -> void
+
+      def to_hash: -> { request_options: Zavudev::RequestOptions }
+    end
+  end
+end

data/sig/zavudev/models/balance_retrieve_response.rbs

@@ -0,0 +1,42 @@
+module Zavudev
+  module Models
+    type balance_retrieve_response =
+      {
+        balance: Integer,
+        currency: String,
+        credit_limit: Integer?,
+        is_sub_account: bool,
+        total_spent: Integer?
+      }
+
+    class BalanceRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      attr_accessor balance: Integer
+
+      attr_accessor currency: String
+
+      attr_accessor credit_limit: Integer?
+
+      attr_reader is_sub_account: bool?
+
+      def is_sub_account=: (bool) -> bool
+
+      attr_accessor total_spent: Integer?
+
+      def initialize: (
+        balance: Integer,
+        currency: String,
+        ?credit_limit: Integer?,
+        ?is_sub_account: bool,
+        ?total_spent: Integer?
+      ) -> void
+
+      def to_hash: -> {
+        balance: Integer,
+        currency: String,
+        credit_limit: Integer?,
+        is_sub_account: bool,
+        total_spent: Integer?
+      }
+    end
+  end
+end

data/sig/zavudev/models/broadcast_contact.rbs

@@ -12,6 +12,7 @@ module Zavudev
         error_message: String,
         message_id: String,
         processed_at: Time,
+        template_button_variables: ::Hash[Symbol, String],
         template_variables: ::Hash[Symbol, String]
       }
 
@@ -44,6 +45,12 @@ module Zavudev
 
       def processed_at=: (Time) -> Time
 
+      attr_reader template_button_variables: ::Hash[Symbol, String]?
+
+      def template_button_variables=: (
+        ::Hash[Symbol, String]
+      ) -> ::Hash[Symbol, String]
+
       attr_reader template_variables: ::Hash[Symbol, String]?
 
       def template_variables=: (
@@ -61,6 +68,7 @@ module Zavudev
         ?error_message: String,
         ?message_id: String,
         ?processed_at: Time,
+        ?template_button_variables: ::Hash[Symbol, String],
         ?template_variables: ::Hash[Symbol, String]
       ) -> void
 
@@ -75,6 +83,7 @@ module Zavudev
         error_message: String,
         message_id: String,
         processed_at: Time,
+        template_button_variables: ::Hash[Symbol, String],
         template_variables: ::Hash[Symbol, String]
       }
 

data/sig/zavudev/models/broadcast_content.rbs

@@ -6,6 +6,7 @@ module Zavudev
         media_id: String,
         media_url: String,
         mime_type: String,
+        template_button_variables: ::Hash[Symbol, String],
         template_id: String,
         template_variables: ::Hash[Symbol, String]
       }
@@ -27,6 +28,12 @@ module Zavudev
 
       def mime_type=: (String) -> String
 
+      attr_reader template_button_variables: ::Hash[Symbol, String]?
+
+      def template_button_variables=: (
+        ::Hash[Symbol, String]
+      ) -> ::Hash[Symbol, String]
+
       attr_reader template_id: String?
 
       def template_id=: (String) -> String
@@ -42,6 +49,7 @@ module Zavudev
         ?media_id: String,
         ?media_url: String,
         ?mime_type: String,
+        ?template_button_variables: ::Hash[Symbol, String],
         ?template_id: String,
         ?template_variables: ::Hash[Symbol, String]
       ) -> void
@@ -51,6 +59,7 @@ module Zavudev
         media_id: String,
         media_url: String,
         mime_type: String,
+        template_button_variables: ::Hash[Symbol, String],
         template_id: String,
         template_variables: ::Hash[Symbol, String]
       }

data/sig/zavudev/models/broadcast_escalate_review_params.rbs

@@ -0,0 +1,23 @@
+module Zavudev
+  module Models
+    type broadcast_escalate_review_params =
+      { broadcast_id: String } & Zavudev::Internal::Type::request_parameters
+
+    class BroadcastEscalateReviewParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      attr_accessor broadcast_id: String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Zavudev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Zavudev::RequestOptions
+      }
+    end
+  end
+end

data/sig/zavudev/models/broadcast_escalate_review_response.rbs

@@ -0,0 +1,13 @@
+module Zavudev
+  module Models
+    type broadcast_escalate_review_response = { broadcast: Zavudev::Broadcast }
+
+    class BroadcastEscalateReviewResponse < Zavudev::Internal::Type::BaseModel
+      attr_accessor broadcast: Zavudev::Broadcast
+
+      def initialize: (broadcast: Zavudev::Broadcast) -> void
+
+      def to_hash: -> { broadcast: Zavudev::Broadcast }
+    end
+  end
+end

data/sig/zavudev/models/broadcast_retry_review_params.rbs

@@ -0,0 +1,23 @@
+module Zavudev
+  module Models
+    type broadcast_retry_review_params =
+      { broadcast_id: String } & Zavudev::Internal::Type::request_parameters
+
+    class BroadcastRetryReviewParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      attr_accessor broadcast_id: String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Zavudev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Zavudev::RequestOptions
+      }
+    end
+  end
+end

data/sig/zavudev/models/broadcast_retry_review_response.rbs

@@ -0,0 +1,13 @@
+module Zavudev
+  module Models
+    type broadcast_retry_review_response = { broadcast: Zavudev::Broadcast }
+
+    class BroadcastRetryReviewResponse < Zavudev::Internal::Type::BaseModel
+      attr_accessor broadcast: Zavudev::Broadcast
+
+      def initialize: (broadcast: Zavudev::Broadcast) -> void
+
+      def to_hash: -> { broadcast: Zavudev::Broadcast }
+    end
+  end
+end

data/sig/zavudev/models/broadcasts/contact_add_params.rbs

@@ -29,11 +29,21 @@ module Zavudev
         }
 
         type contact =
-          { recipient: String, template_variables: ::Hash[Symbol, String] }
+          {
+            recipient: String,
+            template_button_variables: ::Hash[Symbol, String],
+            template_variables: ::Hash[Symbol, String]
+          }
 
         class Contact < Zavudev::Internal::Type::BaseModel
           attr_accessor recipient: String
 
+          attr_reader template_button_variables: ::Hash[Symbol, String]?
+
+          def template_button_variables=: (
+            ::Hash[Symbol, String]
+          ) -> ::Hash[Symbol, String]
+
           attr_reader template_variables: ::Hash[Symbol, String]?
 
           def template_variables=: (
@@ -42,11 +52,13 @@ module Zavudev
 
           def initialize: (
             recipient: String,
+            ?template_button_variables: ::Hash[Symbol, String],
             ?template_variables: ::Hash[Symbol, String]
           ) -> void
 
           def to_hash: -> {
             recipient: String,
+            template_button_variables: ::Hash[Symbol, String],
             template_variables: ::Hash[Symbol, String]
           }
         end

data/sig/zavudev/models/contact.rbs

@@ -7,7 +7,7 @@ module Zavudev
         created_at: Time,
         metadata: ::Hash[Symbol, String],
         verified: bool,
-        channels: ::Array[Zavudev::Contact::Channel],
+        channels: ::Array[Zavudev::ContactChannel],
         country_code: String,
         default_channel: Zavudev::Models::Contact::default_channel,
         display_name: String,
@@ -30,11 +30,11 @@ module Zavudev
 
       attr_accessor verified: bool
 
-      attr_reader channels: ::Array[Zavudev::Contact::Channel]?
+      attr_reader channels: ::Array[Zavudev::ContactChannel]?
 
       def channels=: (
-        ::Array[Zavudev::Contact::Channel]
-      ) -> ::Array[Zavudev::Contact::Channel]
+        ::Array[Zavudev::ContactChannel]
+      ) -> ::Array[Zavudev::ContactChannel]
 
       attr_reader country_code: String?
 
@@ -78,7 +78,7 @@ module Zavudev
         created_at: Time,
         metadata: ::Hash[Symbol, String],
         verified: bool,
-        ?channels: ::Array[Zavudev::Contact::Channel],
+        ?channels: ::Array[Zavudev::ContactChannel],
         ?country_code: String,
         ?default_channel: Zavudev::Models::Contact::default_channel,
         ?display_name: String,
@@ -96,7 +96,7 @@ module Zavudev
         created_at: Time,
         metadata: ::Hash[Symbol, String],
         verified: bool,
-        channels: ::Array[Zavudev::Contact::Channel],
+        channels: ::Array[Zavudev::ContactChannel],
         country_code: String,
         default_channel: Zavudev::Models::Contact::default_channel,
         display_name: String,
@@ -108,153 +108,6 @@ module Zavudev
         updated_at: Time
       }
 
-      type channel =
-        {
-          id: String,
-          channel: Zavudev::Models::Contact::Channel::channel,
-          created_at: Time,
-          identifier: String,
-          is_primary: bool,
-          verified: bool,
-          country_code: String,
-          label: String,
-          last_inbound_at: Time,
-          metadata: ::Hash[Symbol, String],
-          metrics: Zavudev::Contact::Channel::Metrics,
-          updated_at: Time
-        }
-
-      class Channel < Zavudev::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_accessor channel: Zavudev::Models::Contact::Channel::channel
-
-        attr_accessor created_at: Time
-
-        attr_accessor identifier: String
-
-        attr_accessor is_primary: bool
-
-        attr_accessor verified: bool
-
-        attr_reader country_code: String?
-
-        def country_code=: (String) -> String
-
-        attr_reader label: String?
-
-        def label=: (String) -> String
-
-        attr_reader last_inbound_at: Time?
-
-        def last_inbound_at=: (Time) -> Time
-
-        attr_reader metadata: ::Hash[Symbol, String]?
-
-        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
-
-        attr_reader metrics: Zavudev::Contact::Channel::Metrics?
-
-        def metrics=: (
-          Zavudev::Contact::Channel::Metrics
-        ) -> Zavudev::Contact::Channel::Metrics
-
-        attr_reader updated_at: Time?
-
-        def updated_at=: (Time) -> Time
-
-        def initialize: (
-          id: String,
-          channel: Zavudev::Models::Contact::Channel::channel,
-          created_at: Time,
-          identifier: String,
-          is_primary: bool,
-          verified: bool,
-          ?country_code: String,
-          ?label: String,
-          ?last_inbound_at: Time,
-          ?metadata: ::Hash[Symbol, String],
-          ?metrics: Zavudev::Contact::Channel::Metrics,
-          ?updated_at: Time
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          channel: Zavudev::Models::Contact::Channel::channel,
-          created_at: Time,
-          identifier: String,
-          is_primary: bool,
-          verified: bool,
-          country_code: String,
-          label: String,
-          last_inbound_at: Time,
-          metadata: ::Hash[Symbol, String],
-          metrics: Zavudev::Contact::Channel::Metrics,
-          updated_at: Time
-        }
-
-        type channel = :sms | :whatsapp | :email | :telegram | :voice
-
-        module Channel
-          extend Zavudev::Internal::Type::Enum
-
-          SMS: :sms
-          WHATSAPP: :whatsapp
-          EMAIL: :email
-          TELEGRAM: :telegram
-          VOICE: :voice
-
-          def self?.values: -> ::Array[Zavudev::Models::Contact::Channel::channel]
-        end
-
-        type metrics =
-          {
-            avg_delivery_time_ms: Float,
-            failure_count: Integer,
-            last_success_at: Time,
-            success_count: Integer,
-            total_attempts: Integer
-          }
-
-        class Metrics < Zavudev::Internal::Type::BaseModel
-          attr_reader avg_delivery_time_ms: Float?
-
-          def avg_delivery_time_ms=: (Float) -> Float
-
-          attr_reader failure_count: Integer?
-
-          def failure_count=: (Integer) -> Integer
-
-          attr_reader last_success_at: Time?
-
-          def last_success_at=: (Time) -> Time
-
-          attr_reader success_count: Integer?
-
-          def success_count=: (Integer) -> Integer
-
-          attr_reader total_attempts: Integer?
-
-          def total_attempts=: (Integer) -> Integer
-
-          def initialize: (
-            ?avg_delivery_time_ms: Float,
-            ?failure_count: Integer,
-            ?last_success_at: Time,
-            ?success_count: Integer,
-            ?total_attempts: Integer
-          ) -> void
-
-          def to_hash: -> {
-            avg_delivery_time_ms: Float,
-            failure_count: Integer,
-            last_success_at: Time,
-            success_count: Integer,
-            total_attempts: Integer
-          }
-        end
-      end
-
       type default_channel =
         :sms | :whatsapp | :telegram | :email | :instagram | :voice