zavudev 0.7.0 → 0.8.0

data/rbi/zavudev/models.rbi

@@ -15,6 +15,8 @@ module Zavudev
 
   AvailablePhoneNumber = Zavudev::Models::AvailablePhoneNumber
 
+  BalanceRetrieveParams = Zavudev::Models::BalanceRetrieveParams
+
   Broadcast = Zavudev::Models::Broadcast
 
   BroadcastCancelParams = Zavudev::Models::BroadcastCancelParams
@@ -31,6 +33,8 @@ module Zavudev
 
   BroadcastDeleteParams = Zavudev::Models::BroadcastDeleteParams
 
+  BroadcastEscalateReviewParams = Zavudev::Models::BroadcastEscalateReviewParams
+
   BroadcastListParams = Zavudev::Models::BroadcastListParams
 
   BroadcastMessageType = Zavudev::Models::BroadcastMessageType
@@ -43,6 +47,8 @@ module Zavudev
 
   BroadcastRetrieveParams = Zavudev::Models::BroadcastRetrieveParams
 
+  BroadcastRetryReviewParams = Zavudev::Models::BroadcastRetryReviewParams
+
   Broadcasts = Zavudev::Models::Broadcasts
 
   BroadcastSendParams = Zavudev::Models::BroadcastSendParams
@@ -57,16 +63,43 @@ module Zavudev
 
   ContactChannel = Zavudev::Models::ContactChannel
 
+  ContactCreateParams = Zavudev::Models::ContactCreateParams
+
+  ContactDismissMergeSuggestionParams =
+    Zavudev::Models::ContactDismissMergeSuggestionParams
+
   ContactListParams = Zavudev::Models::ContactListParams
 
+  ContactMergeParams = Zavudev::Models::ContactMergeParams
+
   ContactRetrieveByPhoneParams = Zavudev::Models::ContactRetrieveByPhoneParams
 
   ContactRetrieveParams = Zavudev::Models::ContactRetrieveParams
 
+  Contacts = Zavudev::Models::Contacts
+
   ContactUpdateParams = Zavudev::Models::ContactUpdateParams
 
+  DataExport = Zavudev::Models::DataExport
+
+  ExportCreateParams = Zavudev::Models::ExportCreateParams
+
+  ExportListParams = Zavudev::Models::ExportListParams
+
+  ExportRetrieveParams = Zavudev::Models::ExportRetrieveParams
+
   IntrospectValidatePhoneParams = Zavudev::Models::IntrospectValidatePhoneParams
 
+  Invitation = Zavudev::Models::Invitation
+
+  InvitationCancelParams = Zavudev::Models::InvitationCancelParams
+
+  InvitationCreateParams = Zavudev::Models::InvitationCreateParams
+
+  InvitationListParams = Zavudev::Models::InvitationListParams
+
+  InvitationRetrieveParams = Zavudev::Models::InvitationRetrieveParams
+
   LineType = Zavudev::Models::LineType
 
   Message = Zavudev::Models::Message
@@ -87,6 +120,8 @@ module Zavudev
 
   MessageType = Zavudev::Models::MessageType
 
+  Number10dlc = Zavudev::Models::Number10dlc
+
   OwnedPhoneNumber = Zavudev::Models::OwnedPhoneNumber
 
   OwnedPhoneNumberPricing = Zavudev::Models::OwnedPhoneNumberPricing
@@ -114,6 +149,8 @@ module Zavudev
 
   PhoneNumberUpdateParams = Zavudev::Models::PhoneNumberUpdateParams
 
+  PlanRetrieveParams = Zavudev::Models::PlanRetrieveParams
+
   RegulatoryDocument = Zavudev::Models::RegulatoryDocument
 
   RegulatoryDocumentCreateParams =
@@ -164,6 +201,22 @@ module Zavudev
 
   SenderWebhook = Zavudev::Models::SenderWebhook
 
+  SubAccount = Zavudev::Models::SubAccount
+
+  SubAccountCreateParams = Zavudev::Models::SubAccountCreateParams
+
+  SubAccountDeactivateParams = Zavudev::Models::SubAccountDeactivateParams
+
+  SubAccountGetBalanceParams = Zavudev::Models::SubAccountGetBalanceParams
+
+  SubAccountListParams = Zavudev::Models::SubAccountListParams
+
+  SubAccountRetrieveParams = Zavudev::Models::SubAccountRetrieveParams
+
+  SubAccounts = Zavudev::Models::SubAccounts
+
+  SubAccountUpdateParams = Zavudev::Models::SubAccountUpdateParams
+
   Template = Zavudev::Models::Template
 
   TemplateCreateParams = Zavudev::Models::TemplateCreateParams
@@ -176,6 +229,17 @@ module Zavudev
 
   TemplateSubmitParams = Zavudev::Models::TemplateSubmitParams
 
+  URLListVerifiedParams = Zavudev::Models::URLListVerifiedParams
+
+  URLRetrieveDetailsParams = Zavudev::Models::URLRetrieveDetailsParams
+
+  URLSubmitForVerificationParams =
+    Zavudev::Models::URLSubmitForVerificationParams
+
+  UsageRetrieveParams = Zavudev::Models::UsageRetrieveParams
+
+  VerifiedURL = Zavudev::Models::VerifiedURL
+
   WebhookEvent = Zavudev::Models::WebhookEvent
 
   WebhookSecretResponse = Zavudev::Models::WebhookSecretResponse

data/rbi/zavudev/resources/balance.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Balance
+      # Get balance for the API key's team. If the API key belongs to a sub-account,
+      # also includes the sub-account's total spending and credit limit.
+      sig do
+        params(request_options: Zavudev::RequestOptions::OrHash).returns(
+          Zavudev::Models::BalanceRetrieveResponse
+        )
+      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/broadcasts.rbi

@@ -124,6 +124,17 @@ module Zavudev
       def cancel(broadcast_id, request_options: {})
       end
 
+      # Request manual review by the Zavu team for a rejected broadcast. Use this after
+      # automated review rejection if you believe the content is legitimate.
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::BroadcastEscalateReviewResponse)
+      end
+      def escalate_review(broadcast_id, request_options: {})
+      end
+
       # Get real-time progress of a broadcast including delivery counts and estimated
       # completion time.
       sig do
@@ -152,6 +163,17 @@ module Zavudev
       )
       end
 
+      # Resubmit a rejected broadcast for AI review after editing content. Maximum 3
+      # review attempts allowed per broadcast.
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::BroadcastRetryReviewResponse)
+      end
+      def retry_review(broadcast_id, request_options: {})
+      end
+
       # Start sending the broadcast immediately or schedule for later. Broadcasts go
       # through automated AI content review before sending. If the review passes, the
       # broadcast proceeds. If rejected, use PATCH to edit content, then call POST

data/rbi/zavudev/resources/contacts/channels.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Contacts
+      class Channels
+        # Update a contact's channel properties.
+        sig do
+          params(
+            channel_id: String,
+            contact_id: String,
+            label: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            verified: T::Boolean,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Contacts::ChannelUpdateResponse)
+        end
+        def update(
+          # Path param: Channel ID.
+          channel_id,
+          # Path param
+          contact_id:,
+          # Body param: Optional label for the channel. Set to null to clear.
+          label: nil,
+          # Body param
+          metadata: nil,
+          # Body param: Whether the channel is verified.
+          verified: nil,
+          request_options: {}
+        )
+        end
+
+        # Add a new communication channel to an existing contact.
+        sig do
+          params(
+            contact_id: String,
+            channel: Zavudev::Contacts::ChannelAddParams::Channel::OrSymbol,
+            identifier: String,
+            country_code: String,
+            is_primary: T::Boolean,
+            label: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Contacts::ChannelAddResponse)
+        end
+        def add(
+          contact_id,
+          # Channel type.
+          channel:,
+          # Channel identifier (phone number in E.164 format or email address).
+          identifier:,
+          # ISO country code for phone numbers.
+          country_code: nil,
+          # Whether this should be the primary channel for its type.
+          is_primary: nil,
+          # Optional label for the channel.
+          label: nil,
+          request_options: {}
+        )
+        end
+
+        # Remove a communication channel from a contact. Cannot remove the last channel.
+        sig do
+          params(
+            channel_id: String,
+            contact_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).void
+        end
+        def remove(
+          # Channel ID.
+          channel_id,
+          contact_id:,
+          request_options: {}
+        )
+        end
+
+        # Set a channel as the primary channel for its type.
+        sig do
+          params(
+            channel_id: String,
+            contact_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Contacts::ChannelSetPrimaryResponse)
+        end
+        def set_primary(
+          # Channel ID.
+          channel_id,
+          contact_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/contacts.rbi

@@ -3,6 +3,29 @@
 module Zavudev
   module Resources
     class Contacts
+      sig { returns(Zavudev::Resources::Contacts::Channels) }
+      attr_reader :channels
+
+      # Create a new contact with one or more communication channels.
+      sig do
+        params(
+          channels: T::Array[Zavudev::ContactCreateParams::Channel::OrHash],
+          display_name: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Contact)
+      end
+      def create(
+        # Communication channels for the contact.
+        channels:,
+        # Display name for the contact.
+        display_name: nil,
+        # Arbitrary metadata to associate with the contact.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
       # Get contact
       sig do
         params(
@@ -44,6 +67,35 @@ module Zavudev
       def list(cursor: nil, limit: nil, phone_number: nil, request_options: {})
       end
 
+      # Dismiss the merge suggestion for a contact.
+      sig do
+        params(
+          contact_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).void
+      end
+      def dismiss_merge_suggestion(contact_id, request_options: {})
+      end
+
+      # Merge a source contact into this contact. All channels from the source contact
+      # will be moved to the target contact, and the source contact will be marked as
+      # merged.
+      sig do
+        params(
+          contact_id: String,
+          source_contact_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Contact)
+      end
+      def merge(
+        contact_id,
+        # ID of the contact to merge into the target contact. The source contact will be
+        # marked as merged.
+        source_contact_id:,
+        request_options: {}
+      )
+      end
+
       # Get contact by phone number
       sig do
         params(

data/rbi/zavudev/resources/exports.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Exports
+      # Create a new data export job. The export will be processed asynchronously and
+      # the download URL will be available when status is 'completed'. Export links
+      # expire after 24 hours.
+      sig do
+        params(
+          data_types: T::Array[Zavudev::ExportCreateParams::DataType::OrSymbol],
+          date_from: Time,
+          date_to: Time,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::ExportCreateResponse)
+      end
+      def create(
+        # List of data types to include in the export.
+        data_types:,
+        # Start date for data to export (inclusive).
+        date_from: nil,
+        # End date for data to export (inclusive).
+        date_to: nil,
+        request_options: {}
+      )
+      end
+
+      # Get details of a specific data export, including download URL when completed.
+      sig do
+        params(
+          export_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::ExportRetrieveResponse)
+      end
+      def retrieve(export_id, request_options: {})
+      end
+
+      # List data exports for this project.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::ExportListParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Internal::Cursor[Zavudev::DataExport])
+      end
+      def list(
+        cursor: nil,
+        limit: nil,
+        # Status of a data export job.
+        status: nil,
+        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/invitations.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Invitations
+      # Create a partner invitation link for a client to connect their WhatsApp Business
+      # account. The client will complete Meta's embedded signup flow and the resulting
+      # sender will be created in your project.
+      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(Zavudev::Models::InvitationCreateResponse)
+      end
+      def create(
+        # 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
+
+      # Get invitation
+      sig do
+        params(
+          invitation_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::InvitationRetrieveResponse)
+      end
+      def retrieve(invitation_id, request_options: {})
+      end
+
+      # List partner invitations for this project.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::InvitationListParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Internal::Cursor[Zavudev::Invitation])
+      end
+      def list(
+        cursor: nil,
+        limit: nil,
+        # Current status of the partner invitation.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancel an active invitation. The client will no longer be able to use the
+      # invitation link.
+      sig do
+        params(
+          invitation_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(Zavudev::Models::InvitationCancelResponse)
+      end
+      def cancel(invitation_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/number_10dlc/brands.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Brands
+        # Create a 10DLC brand registration. The brand starts in draft status. Submit it
+        # for review using the submit endpoint.
+        sig do
+          params(
+            city: String,
+            country: String,
+            display_name: String,
+            email: String,
+            entity_type:
+              Zavudev::Number10dlc::BrandCreateParams::EntityType::OrSymbol,
+            phone: String,
+            postal_code: String,
+            state: String,
+            street: String,
+            vertical: String,
+            company_name: String,
+            ein: String,
+            first_name: String,
+            last_name: String,
+            stock_exchange: String,
+            stock_symbol: String,
+            website: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::BrandCreateResponse)
+        end
+        def create(
+          city:,
+          # Two-letter ISO country code.
+          country:,
+          # Display name of the brand.
+          display_name:,
+          email:,
+          # Business entity type for 10DLC brand registration.
+          entity_type:,
+          # Contact phone in E.164 format.
+          phone:,
+          postal_code:,
+          state:,
+          street:,
+          # Industry vertical.
+          vertical:,
+          # Legal company name.
+          company_name: nil,
+          # Employer Identification Number (format: XX-XXXXXXX).
+          ein: nil,
+          first_name: nil,
+          last_name: nil,
+          stock_exchange: nil,
+          stock_symbol: nil,
+          website: nil,
+          request_options: {}
+        )
+        end
+
+        # Get 10DLC brand
+        sig do
+          params(
+            brand_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::BrandRetrieveResponse)
+        end
+        def retrieve(
+          # 10DLC brand ID.
+          brand_id,
+          request_options: {}
+        )
+        end
+
+        # Update a 10DLC brand in draft status. Cannot update after submission.
+        sig do
+          params(
+            brand_id: String,
+            city: String,
+            company_name: String,
+            country: String,
+            display_name: String,
+            ein: String,
+            email: String,
+            entity_type:
+              Zavudev::Number10dlc::BrandUpdateParams::EntityType::OrSymbol,
+            first_name: String,
+            last_name: String,
+            phone: String,
+            postal_code: String,
+            state: String,
+            stock_exchange: String,
+            stock_symbol: String,
+            street: String,
+            vertical: String,
+            website: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::BrandUpdateResponse)
+        end
+        def update(
+          # 10DLC brand ID.
+          brand_id,
+          city: nil,
+          company_name: nil,
+          country: nil,
+          display_name: nil,
+          ein: nil,
+          email: nil,
+          # Business entity type for 10DLC brand registration.
+          entity_type: nil,
+          first_name: nil,
+          last_name: nil,
+          phone: nil,
+          postal_code: nil,
+          state: nil,
+          stock_exchange: nil,
+          stock_symbol: nil,
+          street: nil,
+          vertical: nil,
+          website: nil,
+          request_options: {}
+        )
+        end
+
+        # List 10DLC brand registrations for this project.
+        sig do
+          params(
+            cursor: String,
+            limit: Integer,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(
+            Zavudev::Internal::Cursor[Zavudev::Number10dlc::TenDlcBrand]
+          )
+        end
+        def list(cursor: nil, limit: nil, request_options: {})
+        end
+
+        # Delete 10DLC brand
+        sig do
+          params(
+            brand_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # 10DLC brand ID.
+          brand_id,
+          request_options: {}
+        )
+        end
+
+        # List available use cases for 10DLC campaign registration.
+        sig do
+          params(request_options: Zavudev::RequestOptions::OrHash).returns(
+            Zavudev::Models::Number10dlc::BrandListUseCasesResponse
+          )
+        end
+        def list_use_cases(request_options: {})
+        end
+
+        # Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
+        # be in draft status. A $35 registration fee is charged from your balance.
+        sig do
+          params(
+            brand_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::BrandSubmitResponse)
+        end
+        def submit(
+          # 10DLC brand ID.
+          brand_id,
+          request_options: {}
+        )
+        end
+
+        # Sync the brand status with the registration provider. Use this to check for
+        # approval updates after submission.
+        sig do
+          params(
+            brand_id: String,
+            request_options: Zavudev::RequestOptions::OrHash
+          ).returns(Zavudev::Models::Number10dlc::BrandSyncStatusResponse)
+        end
+        def sync_status(
+          # 10DLC brand ID.
+          brand_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Zavudev::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end