zavudev 0.7.0 → 0.8.0

data/rbi/zavudev/resources/number_10dlc/campaigns/phone_numbers.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Campaigns
+        class PhoneNumbers
+          # List phone numbers assigned to a 10DLC campaign.
+          sig do
+            params(
+              campaign_id: String,
+              request_options: Zavudev::RequestOptions::OrHash
+            ).returns(
+              Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListResponse
+            )
+          end
+          def list(
+            # 10DLC campaign ID.
+            campaign_id,
+            request_options: {}
+          )
+          end
+
+          # Assign a US phone number to an approved 10DLC campaign. The campaign must be in
+          # approved status.
+          sig do
+            params(
+              campaign_id: String,
+              phone_number_id: String,
+              request_options: Zavudev::RequestOptions::OrHash
+            ).returns(
+              Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignResponse
+            )
+          end
+          def assign(
+            # 10DLC campaign ID.
+            campaign_id,
+            # ID of the phone number to assign.
+            phone_number_id:,
+            request_options: {}
+          )
+          end
+
+          # Remove a phone number assignment from a 10DLC campaign.
+          sig do
+            params(
+              assignment_id: String,
+              campaign_id: String,
+              request_options: Zavudev::RequestOptions::OrHash
+            ).void
+          end
+          def unassign(
+            # Phone number assignment ID.
+            assignment_id,
+            # 10DLC campaign ID.
+            campaign_id:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Zavudev::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/number_10dlc/campaigns.rbi

@@ -0,0 +1,177 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Campaigns
+        sig do
+          returns(Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers)
+        end
+        attr_reader :phone_numbers
+
+        # Create a 10DLC campaign under an existing brand. The campaign starts in draft
+        # status. Submit it for carrier review using the submit endpoint.
+        sig do
+          params(
+            affiliate_marketing: T::Boolean,
+            age_gated: T::Boolean,
+            brand_id: String,
+            description: String,
+            direct_lending: T::Boolean,
+            embedded_link: T::Boolean,
+            embedded_phone: T::Boolean,
+            name: String,
+            number_pooling: T::Boolean,
+            sample_messages: T::Array[String],
+            subscriber_help: T::Boolean,
+            subscriber_opt_in: T::Boolean,
+            subscriber_opt_out: T::Boolean,
+            use_case: String,
+            help_message: String,
+            message_flow: String,
+            opt_in_keywords: T::Array[String],
+            opt_out_keywords: T::Array[String],
+            sub_use_cases: T::Array[String],
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::CampaignCreateResponse)
+        end
+        def create(
+          affiliate_marketing:,
+          age_gated:,
+          # ID of the brand to create this campaign under.
+          brand_id:,
+          description:,
+          direct_lending:,
+          embedded_link:,
+          embedded_phone:,
+          name:,
+          number_pooling:,
+          sample_messages:,
+          subscriber_help:,
+          subscriber_opt_in:,
+          subscriber_opt_out:,
+          # Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).
+          use_case:,
+          help_message: nil,
+          message_flow: nil,
+          opt_in_keywords: nil,
+          opt_out_keywords: nil,
+          sub_use_cases: nil,
+          request_options: {}
+        )
+        end
+
+        # Get 10DLC campaign
+        sig do
+          params(
+            campaign_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::CampaignRetrieveResponse)
+        end
+        def retrieve(
+          # 10DLC campaign ID.
+          campaign_id,
+          request_options: {}
+        )
+        end
+
+        # Update a 10DLC campaign in draft status. Cannot update after submission.
+        sig do
+          params(
+            campaign_id: String,
+            description: String,
+            help_message: String,
+            message_flow: String,
+            name: String,
+            opt_in_keywords: T::Array[String],
+            opt_out_keywords: T::Array[String],
+            sample_messages: T::Array[String],
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::CampaignUpdateResponse)
+        end
+        def update(
+          # 10DLC campaign ID.
+          campaign_id,
+          description: nil,
+          help_message: nil,
+          message_flow: nil,
+          name: nil,
+          opt_in_keywords: nil,
+          opt_out_keywords: nil,
+          sample_messages: nil,
+          request_options: {}
+        )
+        end
+
+        # List 10DLC campaign registrations for this project.
+        sig do
+          params(
+            brand_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(
+            Zavudev::Internal::Cursor[Zavudev::Number10dlc::TenDlcCampaign]
+          )
+        end
+        def list(
+          # Filter campaigns by brand ID.
+          brand_id: nil,
+          cursor: nil,
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # Delete 10DLC campaign
+        sig do
+          params(
+            campaign_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # 10DLC campaign ID.
+          campaign_id,
+          request_options: {}
+        )
+        end
+
+        # Submit a draft campaign for carrier review. The campaign must be in draft status
+        # and its brand must be verified.
+        sig do
+          params(
+            campaign_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::CampaignSubmitResponse)
+        end
+        def submit(
+          # 10DLC campaign ID.
+          campaign_id,
+          request_options: {}
+        )
+        end
+
+        # Sync the campaign status with the registration provider. Use this to check for
+        # approval updates after submission.
+        sig do
+          params(
+            campaign_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::CampaignSyncStatusResponse)
+        end
+        def sync_status(
+          # 10DLC campaign ID.
+          campaign_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Zavudev::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/number_10dlc.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      sig { returns(Zavudev::Resources::Number10dlc::Brands) }
+      attr_reader :brands
+
+      sig { returns(Zavudev::Resources::Number10dlc::Campaigns) }
+      attr_reader :campaigns
+
+      # @api private
+      sig { params(client: Zavudev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/plan.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Plan
+      # Get the current subscription plan for the API key's team, including tier,
+      # billing interval, and period dates.
+      sig do
+        params(request_options: Zavudev::RequestOptions::OrHash).returns(
+          Zavudev::Models::PlanRetrieveResponse
+        )
+      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/rbi/zavudev/resources/senders/whatsapp_sync.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Senders
+      class WhatsappSync
+        # Get the current sync status for a sender's WhatsApp coexistence account. Only
+        # available for senders connected in coexistence mode (WhatsApp Business App +
+        # Cloud API).
+        sig do
+          params(
+            sender_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Senders::WhatsappSyncRetrieveResponse)
+        end
+        def retrieve(sender_id, request_options: {})
+        end
+
+        # Initiate contact names sync from the WhatsApp Business App. This imports contact
+        # names stored in the app to Zavu. Only available for coexistence accounts with
+        # active status.
+        sig do
+          params(
+            sender_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(
+            Zavudev::Models::Senders::WhatsappSyncStartContactsSyncResponse
+          )
+        end
+        def start_contacts_sync(sender_id, request_options: {})
+        end
+
+        # Initiate message history sync from the WhatsApp Business App. This sends a
+        # request to the account owner to approve sharing their conversation history. Only
+        # available for coexistence accounts with active status.
+        sig do
+          params(
+            sender_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(
+            Zavudev::Models::Senders::WhatsappSyncStartHistorySyncResponse
+          )
+        end
+        def start_history_sync(sender_id, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Zavudev::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/resources/senders.rbi

@@ -6,6 +6,9 @@ module Zavudev
       sig { returns(Zavudev::Resources::Senders::Agent) }
       attr_reader :agent
 
+      sig { returns(Zavudev::Resources::Senders::WhatsappSync) }
+      attr_reader :whatsapp_sync
+
       # Create sender
       sig do
         params(

data/rbi/zavudev/resources/sub_accounts/api_keys.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class SubAccounts
+      class APIKeys
+        # Create sub-account API key
+        sig do
+          params(
+            id: String,
+            name: String,
+            environment:
+              Zavudev::SubAccounts::APIKeyCreateParams::Environment::OrSymbol,
+            permissions: T::Array[String],
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::SubAccounts::APIKeyCreateResponse)
+        end
+        def create(
+          # Sub-account ID.
+          id,
+          name:,
+          environment: nil,
+          permissions: nil,
+          request_options: {}
+        )
+        end
+
+        # List sub-account API keys
+        sig do
+          params(
+            id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::SubAccounts::APIKeyListResponse)
+        end
+        def list(
+          # Sub-account ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Revoke sub-account API key
+        sig do
+          params(
+            key_id: String,
+            id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).void
+        end
+        def revoke(
+          # API key ID.
+          key_id,
+          # 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
+end

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/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