zavudev 0.0.2

data/lib/zavudev/resources/broadcasts.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Broadcasts
+      # @return [Zavudev::Resources::Broadcasts::Contacts]
+      attr_reader :contacts
+
+      # Create a new broadcast campaign. Add contacts after creation, then send.
+      #
+      # @overload create(channel:, name:, content: nil, email_html_body: nil, email_subject: nil, idempotency_key: nil, message_type: nil, metadata: nil, scheduled_at: nil, sender_id: nil, text: nil, request_options: {})
+      #
+      # @param channel [Symbol, Zavudev::Models::BroadcastChannel] Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.
+      #
+      # @param name [String] Name of the broadcast campaign.
+      #
+      # @param content [Zavudev::Models::BroadcastContent] Content for non-text broadcast message types.
+      #
+      # @param email_html_body [String] HTML body for email broadcasts.
+      #
+      # @param email_subject [String] Email subject line. Required for email broadcasts.
+      #
+      # @param idempotency_key [String] Idempotency key to prevent duplicate broadcasts.
+      #
+      # @param message_type [Symbol, Zavudev::Models::BroadcastMessageType] Type of message for broadcast.
+      #
+      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param scheduled_at [Time] Schedule the broadcast for future delivery.
+      #
+      # @param sender_id [String] Sender profile ID. Uses default sender if omitted.
+      #
+      # @param text [String] Text content or caption. Supports template variables: {{name}}, {{1}}, etc.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastCreateResponse]
+      #
+      # @see Zavudev::Models::BroadcastCreateParams
+      def create(params)
+        parsed, options = Zavudev::BroadcastCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/broadcasts",
+          body: parsed,
+          model: Zavudev::Models::BroadcastCreateResponse,
+          options: options
+        )
+      end
+
+      # Get broadcast
+      #
+      # @overload retrieve(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastRetrieveResponse]
+      #
+      # @see Zavudev::Models::BroadcastRetrieveParams
+      def retrieve(broadcast_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/broadcasts/%1$s", broadcast_id],
+          model: Zavudev::Models::BroadcastRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a broadcast in draft status.
+      #
+      # @overload update(broadcast_id, content: nil, email_html_body: nil, email_subject: nil, metadata: nil, name: nil, text: nil, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param content [Zavudev::Models::BroadcastContent] Content for non-text broadcast message types.
+      #
+      # @param email_html_body [String]
+      #
+      # @param email_subject [String]
+      #
+      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param name [String]
+      #
+      # @param text [String]
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastUpdateResponse]
+      #
+      # @see Zavudev::Models::BroadcastUpdateParams
+      def update(broadcast_id, params = {})
+        parsed, options = Zavudev::BroadcastUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/broadcasts/%1$s", broadcast_id],
+          body: parsed,
+          model: Zavudev::Models::BroadcastUpdateResponse,
+          options: options
+        )
+      end
+
+      # List broadcasts for this project.
+      #
+      # @overload list(cursor: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param cursor [String]
+      #
+      # @param limit [Integer]
+      #
+      # @param status [Symbol, Zavudev::Models::BroadcastStatus] Current status of the broadcast.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::Broadcast>]
+      #
+      # @see Zavudev::Models::BroadcastListParams
+      def list(params = {})
+        parsed, options = Zavudev::BroadcastListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/broadcasts",
+          query: query,
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::Broadcast,
+          options: options
+        )
+      end
+
+      # Delete a broadcast in draft status.
+      #
+      # @overload delete(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Zavudev::Models::BroadcastDeleteParams
+      def delete(broadcast_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/broadcasts/%1$s", broadcast_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a broadcast. Pending contacts will be skipped, but already queued
+      # messages may still be delivered.
+      #
+      # @overload cancel(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastCancelResponse]
+      #
+      # @see Zavudev::Models::BroadcastCancelParams
+      def cancel(broadcast_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/broadcasts/%1$s/cancel", broadcast_id],
+          model: Zavudev::Models::BroadcastCancelResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get real-time progress of a broadcast including delivery counts and estimated
+      # completion time.
+      #
+      # @overload progress(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastProgress]
+      #
+      # @see Zavudev::Models::BroadcastProgressParams
+      def progress(broadcast_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/broadcasts/%1$s/progress", broadcast_id],
+          model: Zavudev::BroadcastProgress,
+          options: params[:request_options]
+        )
+      end
+
+      # Update the scheduled time for a broadcast. The broadcast must be in scheduled
+      # status.
+      #
+      # @overload reschedule(broadcast_id, scheduled_at:, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param scheduled_at [Time] New scheduled time for the broadcast.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastRescheduleResponse]
+      #
+      # @see Zavudev::Models::BroadcastRescheduleParams
+      def reschedule(broadcast_id, params)
+        parsed, options = Zavudev::BroadcastRescheduleParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/broadcasts/%1$s/schedule", broadcast_id],
+          body: parsed,
+          model: Zavudev::Models::BroadcastRescheduleResponse,
+          options: 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
+      # /retry-review. Reserves the estimated cost from your balance.
+      #
+      # @overload send_(broadcast_id, scheduled_at: nil, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param scheduled_at [Time] Schedule for future delivery. Omit to send immediately.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::BroadcastSendResponse]
+      #
+      # @see Zavudev::Models::BroadcastSendParams
+      def send_(broadcast_id, params = {})
+        parsed, options = Zavudev::BroadcastSendParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/broadcasts/%1$s/send", broadcast_id],
+          body: parsed,
+          model: Zavudev::Models::BroadcastSendResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+        @contacts = Zavudev::Resources::Broadcasts::Contacts.new(client: client)
+      end
+    end
+  end
+end

data/lib/zavudev/resources/contacts.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Contacts
+      # Get contact
+      #
+      # @overload retrieve(contact_id, request_options: {})
+      #
+      # @param contact_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::Contact]
+      #
+      # @see Zavudev::Models::ContactRetrieveParams
+      def retrieve(contact_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/contacts/%1$s", contact_id],
+          model: Zavudev::Contact,
+          options: params[:request_options]
+        )
+      end
+
+      # Update contact
+      #
+      # @overload update(contact_id, default_channel: nil, metadata: nil, request_options: {})
+      #
+      # @param contact_id [String]
+      #
+      # @param default_channel [Symbol, Zavudev::Models::ContactUpdateParams::DefaultChannel, nil] Preferred channel for this contact. Set to null to clear.
+      #
+      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::Contact]
+      #
+      # @see Zavudev::Models::ContactUpdateParams
+      def update(contact_id, params = {})
+        parsed, options = Zavudev::ContactUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/contacts/%1$s", contact_id],
+          body: parsed,
+          model: Zavudev::Contact,
+          options: options
+        )
+      end
+
+      # List contacts with their communication channels.
+      #
+      # @overload list(cursor: nil, limit: nil, phone_number: nil, request_options: {})
+      #
+      # @param cursor [String]
+      # @param limit [Integer]
+      # @param phone_number [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::Contact>]
+      #
+      # @see Zavudev::Models::ContactListParams
+      def list(params = {})
+        parsed, options = Zavudev::ContactListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/contacts",
+          query: query.transform_keys(phone_number: "phoneNumber"),
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::Contact,
+          options: options
+        )
+      end
+
+      # Get contact by phone number
+      #
+      # @overload retrieve_by_phone(phone_number, request_options: {})
+      #
+      # @param phone_number [String] E.164 phone number.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::Contact]
+      #
+      # @see Zavudev::Models::ContactRetrieveByPhoneParams
+      def retrieve_by_phone(phone_number, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/contacts/phone/%1$s", phone_number],
+          model: Zavudev::Contact,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/zavudev/resources/introspect.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Introspect
+      # Validate a phone number and check if a WhatsApp conversation window is open.
+      #
+      # @overload validate_phone(phone_number:, request_options: {})
+      #
+      # @param phone_number [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::IntrospectValidatePhoneResponse]
+      #
+      # @see Zavudev::Models::IntrospectValidatePhoneParams
+      def validate_phone(params)
+        parsed, options = Zavudev::IntrospectValidatePhoneParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/introspect/phone",
+          body: parsed,
+          model: Zavudev::Models::IntrospectValidatePhoneResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/zavudev/resources/messages.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Messages
+      # Get message by ID
+      #
+      # @overload retrieve(message_id, request_options: {})
+      #
+      # @param message_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::MessageResponse]
+      #
+      # @see Zavudev::Models::MessageRetrieveParams
+      def retrieve(message_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/messages/%1$s", message_id],
+          model: Zavudev::MessageResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List messages previously sent by this project.
+      #
+      # @overload list(channel: nil, cursor: nil, limit: nil, status: nil, to: nil, request_options: {})
+      #
+      # @param channel [Symbol, Zavudev::Models::Channel] Delivery channel. Use 'auto' for intelligent routing.
+      #
+      # @param cursor [String]
+      #
+      # @param limit [Integer]
+      #
+      # @param status [Symbol, Zavudev::Models::MessageStatus]
+      #
+      # @param to [String]
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::Message>]
+      #
+      # @see Zavudev::Models::MessageListParams
+      def list(params = {})
+        parsed, options = Zavudev::MessageListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/messages",
+          query: query,
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::Message,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Zavudev::Models::MessageReactParams} for more details.
+      #
+      # Send an emoji reaction to an existing WhatsApp message. Reactions are only
+      # supported for WhatsApp messages.
+      #
+      # @overload react(message_id, emoji:, zavu_sender: nil, request_options: {})
+      #
+      # @param message_id [String] Path param
+      #
+      # @param emoji [String] Body param: Single emoji character to react with.
+      #
+      # @param zavu_sender [String] Header param: Optional sender profile ID. If omitted, the project's default send
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::MessageResponse]
+      #
+      # @see Zavudev::Models::MessageReactParams
+      def react(message_id, params)
+        parsed, options = Zavudev::MessageReactParams.dump_request(params)
+        header_params = {zavu_sender: "zavu-sender"}
+        @client.request(
+          method: :post,
+          path: ["v1/messages/%1$s/reactions", message_id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Zavudev::MessageResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Zavudev::Models::MessageSendParams} for more details.
+      #
+      # Send a message to a recipient via SMS or WhatsApp.
+      #
+      # **Channel selection:**
+      #
+      # - If `channel` is omitted and `messageType` is `text`, defaults to SMS
+      # - If `messageType` is anything other than `text`, WhatsApp is used automatically
+      #
+      # **WhatsApp 24-hour window:**
+      #
+      # - Free-form messages (non-template) require an open 24h window
+      # - Window opens when the user messages you first
+      # - Use template messages to initiate conversations outside the window
+      #
+      # **Email requirements:**
+      #
+      # - Email channel requires KYC verification. Complete identity verification in the
+      #   dashboard before sending emails.
+      #
+      # @overload send_(to:, channel: nil, content: nil, fallback_enabled: nil, html_body: nil, idempotency_key: nil, message_type: nil, metadata: nil, reply_to: nil, subject: nil, text: nil, voice_language: nil, zavu_sender: nil, request_options: {})
+      #
+      # @param to [String] Body param: Recipient phone number in E.164 format or email address.
+      #
+      # @param channel [Symbol, Zavudev::Models::Channel] Body param: Delivery channel. Use 'auto' for intelligent routing. If omitted wit
+      #
+      # @param content [Zavudev::Models::MessageContent] Body param: Additional content for non-text message types.
+      #
+      # @param fallback_enabled [Boolean] Body param: Whether to enable automatic fallback to SMS if WhatsApp fails. Defau
+      #
+      # @param html_body [String] Body param: HTML body for email messages. If provided, email will be sent as mul
+      #
+      # @param idempotency_key [String] Body param: Optional idempotency key to avoid duplicate sends.
+      #
+      # @param message_type [Symbol, Zavudev::Models::MessageType] Body param: Type of message. Defaults to 'text'.
+      #
+      # @param metadata [Hash{Symbol=>String}] Body param: Arbitrary metadata to associate with the message.
+      #
+      # @param reply_to [String] Body param: Reply-To email address for email messages.
+      #
+      # @param subject [String] Body param: Email subject line. Required when channel is 'email' or recipient is
+      #
+      # @param text [String] Body param: Text body for text messages or caption for media messages.
+      #
+      # @param voice_language [String] Body param: Language code for voice text-to-speech (e.g., 'en-US', 'es-ES', 'pt-
+      #
+      # @param zavu_sender [String] Header param: Optional sender profile ID. If omitted, the project's default send
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::MessageResponse]
+      #
+      # @see Zavudev::Models::MessageSendParams
+      def send_(params)
+        parsed, options = Zavudev::MessageSendParams.dump_request(params)
+        header_params = {zavu_sender: "zavu-sender"}
+        @client.request(
+          method: :post,
+          path: "v1/messages",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Zavudev::MessageResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end