zavudev 0.7.0 → 0.8.0

data/lib/zavudev/models/usage_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Usage#retrieve
+    class UsageRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/usage_retrieve_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Usage#retrieve
+    class UsageRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute emails_sent
+      #   Emails sent this month.
+      #
+      #   @return [Integer]
+      required :emails_sent, Integer, api_name: :emailsSent
+
+      # @!attribute limits
+      #
+      #   @return [Zavudev::Models::UsageRetrieveResponse::Limits]
+      required :limits, -> { Zavudev::Models::UsageRetrieveResponse::Limits }
+
+      # @!attribute messages_a2_p
+      #   A2P messages sent this month (WhatsApp replies + Telegram).
+      #
+      #   @return [Integer]
+      required :messages_a2_p, Integer, api_name: :messagesA2P
+
+      # @!attribute month_key
+      #   Current month in YYYY-MM format.
+      #
+      #   @return [String]
+      required :month_key, String, api_name: :monthKey
+
+      # @!attribute tier
+      #
+      #   @return [Symbol, Zavudev::Models::UsageRetrieveResponse::Tier]
+      required :tier, enum: -> { Zavudev::Models::UsageRetrieveResponse::Tier }
+
+      # @!method initialize(emails_sent:, limits:, messages_a2_p:, month_key:, tier:)
+      #   @param emails_sent [Integer] Emails sent this month.
+      #
+      #   @param limits [Zavudev::Models::UsageRetrieveResponse::Limits]
+      #
+      #   @param messages_a2_p [Integer] A2P messages sent this month (WhatsApp replies + Telegram).
+      #
+      #   @param month_key [String] Current month in YYYY-MM format.
+      #
+      #   @param tier [Symbol, Zavudev::Models::UsageRetrieveResponse::Tier]
+
+      # @see Zavudev::Models::UsageRetrieveResponse#limits
+      class Limits < Zavudev::Internal::Type::BaseModel
+        # @!attribute emails
+        #
+        #   @return [Integer, nil]
+        optional :emails, Integer
+
+        # @!attribute messages_a2_p
+        #
+        #   @return [Integer, nil]
+        optional :messages_a2_p, Integer, api_name: :messagesA2P
+
+        # @!method initialize(emails: nil, messages_a2_p: nil)
+        #   @param emails [Integer]
+        #   @param messages_a2_p [Integer]
+      end
+
+      # @see Zavudev::Models::UsageRetrieveResponse#tier
+      module Tier
+        extend Zavudev::Internal::Type::Enum
+
+        FREE = :free
+        PRO = :pro
+        SCALE = :scale
+        ENTERPRISE = :enterprise
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/verified_url.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#list_verified
+    class VerifiedURL < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute domain
+      #   Domain extracted from the URL.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute status
+      #   Status of a verified URL.
+      #
+      #   @return [Symbol, Zavudev::Models::VerifiedURL::Status]
+      required :status, enum: -> { Zavudev::VerifiedURL::Status }
+
+      # @!attribute url
+      #   The verified URL.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute approval_type
+      #   How the URL was approved or rejected.
+      #
+      #   @return [Symbol, Zavudev::Models::VerifiedURL::ApprovalType, nil]
+      optional :approval_type, enum: -> { Zavudev::VerifiedURL::ApprovalType }, api_name: :approvalType
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, created_at:, domain:, status:, url:, approval_type: nil, updated_at: nil)
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param domain [String] Domain extracted from the URL.
+      #
+      #   @param status [Symbol, Zavudev::Models::VerifiedURL::Status] Status of a verified URL.
+      #
+      #   @param url [String] The verified URL.
+      #
+      #   @param approval_type [Symbol, Zavudev::Models::VerifiedURL::ApprovalType] How the URL was approved or rejected.
+      #
+      #   @param updated_at [Time]
+
+      # Status of a verified URL.
+      #
+      # @see Zavudev::Models::VerifiedURL#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        APPROVED = :approved
+        REJECTED = :rejected
+        MALICIOUS = :malicious
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # How the URL was approved or rejected.
+      #
+      # @see Zavudev::Models::VerifiedURL#approval_type
+      module ApprovalType
+        extend Zavudev::Internal::Type::Enum
+
+        MANUAL = :manual
+        AUTO_WEB_RISK = :auto_web_risk
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models.rb

@@ -53,6 +53,8 @@ module Zavudev
 
   AvailablePhoneNumber = Zavudev::Models::AvailablePhoneNumber
 
+  BalanceRetrieveParams = Zavudev::Models::BalanceRetrieveParams
+
   Broadcast = Zavudev::Models::Broadcast
 
   BroadcastCancelParams = Zavudev::Models::BroadcastCancelParams
@@ -69,6 +71,8 @@ module Zavudev
 
   BroadcastDeleteParams = Zavudev::Models::BroadcastDeleteParams
 
+  BroadcastEscalateReviewParams = Zavudev::Models::BroadcastEscalateReviewParams
+
   BroadcastListParams = Zavudev::Models::BroadcastListParams
 
   BroadcastMessageType = Zavudev::Models::BroadcastMessageType
@@ -81,6 +85,8 @@ module Zavudev
 
   BroadcastRetrieveParams = Zavudev::Models::BroadcastRetrieveParams
 
+  BroadcastRetryReviewParams = Zavudev::Models::BroadcastRetryReviewParams
+
   Broadcasts = Zavudev::Models::Broadcasts
 
   BroadcastSendParams = Zavudev::Models::BroadcastSendParams
@@ -95,16 +101,42 @@ 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
@@ -125,6 +157,8 @@ module Zavudev
 
   MessageType = Zavudev::Models::MessageType
 
+  Number10dlc = Zavudev::Models::Number10dlc
+
   OwnedPhoneNumber = Zavudev::Models::OwnedPhoneNumber
 
   OwnedPhoneNumberPricing = Zavudev::Models::OwnedPhoneNumberPricing
@@ -151,6 +185,8 @@ module Zavudev
 
   PhoneNumberUpdateParams = Zavudev::Models::PhoneNumberUpdateParams
 
+  PlanRetrieveParams = Zavudev::Models::PlanRetrieveParams
+
   RegulatoryDocument = Zavudev::Models::RegulatoryDocument
 
   RegulatoryDocumentCreateParams = Zavudev::Models::RegulatoryDocumentCreateParams
@@ -195,6 +231,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
@@ -207,6 +259,16 @@ 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/lib/zavudev/resources/balance.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BalanceRetrieveResponse]
+      #
+      # @see Zavudev::Models::BalanceRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "v1/balance",
+          model: Zavudev::Models::BalanceRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/zavudev/resources/broadcasts.rb

@@ -168,6 +168,26 @@ module Zavudev
         )
       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.
+      #
+      # @overload escalate_review(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastEscalateReviewResponse]
+      #
+      # @see Zavudev::Models::BroadcastEscalateReviewParams
+      def escalate_review(broadcast_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/broadcasts/%1$s/escalate", broadcast_id],
+          model: Zavudev::Models::BroadcastEscalateReviewResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Get real-time progress of a broadcast including delivery counts and estimated
       # completion time.
       #
@@ -213,6 +233,26 @@ module Zavudev
         )
       end
 
+      # Resubmit a rejected broadcast for AI review after editing content. Maximum 3
+      # review attempts allowed per broadcast.
+      #
+      # @overload retry_review(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastRetryReviewResponse]
+      #
+      # @see Zavudev::Models::BroadcastRetryReviewParams
+      def retry_review(broadcast_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/broadcasts/%1$s/retry-review", broadcast_id],
+          model: Zavudev::Models::BroadcastRetryReviewResponse,
+          options: params[: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/lib/zavudev/resources/contacts/channels.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Contacts
+      class Channels
+        # Update a contact's channel properties.
+        #
+        # @overload update(channel_id, contact_id:, label: nil, metadata: nil, verified: nil, request_options: {})
+        #
+        # @param channel_id [String] Path param: Channel ID.
+        #
+        # @param contact_id [String] Path param
+        #
+        # @param label [String, nil] Body param: Optional label for the channel. Set to null to clear.
+        #
+        # @param metadata [Hash{Symbol=>String}] Body param
+        #
+        # @param verified [Boolean] Body param: Whether the channel is verified.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Contacts::ChannelUpdateResponse]
+        #
+        # @see Zavudev::Models::Contacts::ChannelUpdateParams
+        def update(channel_id, params)
+          parsed, options = Zavudev::Contacts::ChannelUpdateParams.dump_request(params)
+          contact_id =
+            parsed.delete(:contact_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["v1/contacts/%1$s/channels/%2$s", contact_id, channel_id],
+            body: parsed,
+            model: Zavudev::Models::Contacts::ChannelUpdateResponse,
+            options: options
+          )
+        end
+
+        # Add a new communication channel to an existing contact.
+        #
+        # @overload add(contact_id, channel:, identifier:, country_code: nil, is_primary: nil, label: nil, request_options: {})
+        #
+        # @param contact_id [String]
+        #
+        # @param channel [Symbol, Zavudev::Models::Contacts::ChannelAddParams::Channel] Channel type.
+        #
+        # @param identifier [String] Channel identifier (phone number in E.164 format or email address).
+        #
+        # @param country_code [String] ISO country code for phone numbers.
+        #
+        # @param is_primary [Boolean] Whether this should be the primary channel for its type.
+        #
+        # @param label [String] Optional label for the channel.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Contacts::ChannelAddResponse]
+        #
+        # @see Zavudev::Models::Contacts::ChannelAddParams
+        def add(contact_id, params)
+          parsed, options = Zavudev::Contacts::ChannelAddParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/contacts/%1$s/channels", contact_id],
+            body: parsed,
+            model: Zavudev::Models::Contacts::ChannelAddResponse,
+            options: options
+          )
+        end
+
+        # Remove a communication channel from a contact. Cannot remove the last channel.
+        #
+        # @overload remove(channel_id, contact_id:, request_options: {})
+        #
+        # @param channel_id [String] Channel ID.
+        #
+        # @param contact_id [String]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Zavudev::Models::Contacts::ChannelRemoveParams
+        def remove(channel_id, params)
+          parsed, options = Zavudev::Contacts::ChannelRemoveParams.dump_request(params)
+          contact_id =
+            parsed.delete(:contact_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v1/contacts/%1$s/channels/%2$s", contact_id, channel_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Set a channel as the primary channel for its type.
+        #
+        # @overload set_primary(channel_id, contact_id:, request_options: {})
+        #
+        # @param channel_id [String] Channel ID.
+        #
+        # @param contact_id [String]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Contacts::ChannelSetPrimaryResponse]
+        #
+        # @see Zavudev::Models::Contacts::ChannelSetPrimaryParams
+        def set_primary(channel_id, params)
+          parsed, options = Zavudev::Contacts::ChannelSetPrimaryParams.dump_request(params)
+          contact_id =
+            parsed.delete(:contact_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["v1/contacts/%1$s/channels/%2$s/primary", contact_id, channel_id],
+            model: Zavudev::Models::Contacts::ChannelSetPrimaryResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Zavudev::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/resources/contacts.rb

@@ -3,6 +3,35 @@
 module Zavudev
   module Resources
     class Contacts
+      # @return [Zavudev::Resources::Contacts::Channels]
+      attr_reader :channels
+
+      # Create a new contact with one or more communication channels.
+      #
+      # @overload create(channels:, display_name: nil, metadata: nil, request_options: {})
+      #
+      # @param channels [Array<Zavudev::Models::ContactCreateParams::Channel>] Communication channels for the contact.
+      #
+      # @param display_name [String] Display name for the contact.
+      #
+      # @param metadata [Hash{Symbol=>String}] Arbitrary metadata to associate with the contact.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::Contact]
+      #
+      # @see Zavudev::Models::ContactCreateParams
+      def create(params)
+        parsed, options = Zavudev::ContactCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/contacts",
+          body: parsed,
+          model: Zavudev::Contact,
+          options: options
+        )
+      end
+
       # Get contact
       #
       # @overload retrieve(contact_id, request_options: {})
@@ -73,6 +102,54 @@ module Zavudev
         )
       end
 
+      # Dismiss the merge suggestion for a contact.
+      #
+      # @overload dismiss_merge_suggestion(contact_id, request_options: {})
+      #
+      # @param contact_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Zavudev::Models::ContactDismissMergeSuggestionParams
+      def dismiss_merge_suggestion(contact_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/contacts/%1$s/merge-suggestion", contact_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Zavudev::Models::ContactMergeParams} for more details.
+      #
+      # 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.
+      #
+      # @overload merge(contact_id, source_contact_id:, request_options: {})
+      #
+      # @param contact_id [String]
+      #
+      # @param source_contact_id [String] ID of the contact to merge into the target contact. The source contact will be m
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::Contact]
+      #
+      # @see Zavudev::Models::ContactMergeParams
+      def merge(contact_id, params)
+        parsed, options = Zavudev::ContactMergeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/contacts/%1$s/merge", contact_id],
+          body: parsed,
+          model: Zavudev::Contact,
+          options: options
+        )
+      end
+
       # Get contact by phone number
       #
       # @overload retrieve_by_phone(phone_number, request_options: {})
@@ -98,6 +175,7 @@ module Zavudev
       # @param client [Zavudev::Client]
       def initialize(client:)
         @client = client
+        @channels = Zavudev::Resources::Contacts::Channels.new(client: client)
       end
     end
   end