revox 0.0.2 → 0.2.0

data/lib/revox/models/campaign_cancel_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#cancel
+    class CampaignCancelParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/revox/models/campaign_cancel_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#cancel
+    class CampaignCancelResponse < Revox::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Revox::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/revox/models/campaign_create_params.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#create
+    class CampaignCreateParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute assistant_id
+      #   The ID of the assistant to use
+      #
+      #   @return [String]
+      required :assistant_id, String
+
+      # @!attribute contacts
+      #   The list of contacts to call
+      #
+      #   @return [Array<Revox::Models::CampaignCreateParams::Contact>]
+      required :contacts, -> { Revox::Internal::Type::ArrayOf[Revox::CampaignCreateParams::Contact] }
+
+      # @!attribute launch
+      #   Whether to launch the campaign immediately. Set to false to save as a draft.
+      #
+      #   @return [Boolean]
+      required :launch, Revox::Internal::Type::Boolean
+
+      # @!attribute name
+      #   The name of the campaign
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   Campaign type. 'jump_in' campaigns only dial while someone is on the campaign
+      #   page and auto-pause when unattended.
+      #
+      #   @return [Symbol, Revox::Models::CampaignCreateParams::Type]
+      required :type, enum: -> { Revox::CampaignCreateParams::Type }
+
+      # @!attribute call_retry_config
+      #   Override retry configuration for calls in this campaign. If not provided, uses
+      #   the assistant's retry config.
+      #
+      #   @return [Revox::Models::CampaignCreateParams::CallRetryConfig, nil]
+      optional :call_retry_config, -> { Revox::CampaignCreateParams::CallRetryConfig }
+
+      # @!attribute from_phone_number
+      #   The phone number to use for outbound calls (E.164 format, e.g., +1234567890)
+      #
+      #   @return [String, nil]
+      optional :from_phone_number, String
+
+      # @!attribute max_concurrent_calls
+      #   Maximum number of concurrent calls allowed for this campaign
+      #
+      #   @return [Float, nil]
+      optional :max_concurrent_calls, Float
+
+      # @!attribute scheduled_at
+      #   Schedule all calls in this campaign to start at a specific date and time (ISO
+      #   8601 format)
+      #
+      #   @return [Time, Object, nil]
+      optional :scheduled_at, union: -> { Revox::CampaignCreateParams::ScheduledAt }
+
+      # @!method initialize(assistant_id:, contacts:, launch:, name:, type:, call_retry_config: nil, from_phone_number: nil, max_concurrent_calls: nil, scheduled_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::CampaignCreateParams} for more details.
+      #
+      #   @param assistant_id [String] The ID of the assistant to use
+      #
+      #   @param contacts [Array<Revox::Models::CampaignCreateParams::Contact>] The list of contacts to call
+      #
+      #   @param launch [Boolean] Whether to launch the campaign immediately. Set to false to save as a draft.
+      #
+      #   @param name [String] The name of the campaign
+      #
+      #   @param type [Symbol, Revox::Models::CampaignCreateParams::Type] Campaign type. 'jump_in' campaigns only dial while someone is on the campaign pa
+      #
+      #   @param call_retry_config [Revox::Models::CampaignCreateParams::CallRetryConfig] Override retry configuration for calls in this campaign. If not provided, uses t
+      #
+      #   @param from_phone_number [String] The phone number to use for outbound calls (E.164 format, e.g., +1234567890)
+      #
+      #   @param max_concurrent_calls [Float] Maximum number of concurrent calls allowed for this campaign
+      #
+      #   @param scheduled_at [Time, Object] Schedule all calls in this campaign to start at a specific date and time (ISO 86
+      #
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      class Contact < Revox::Internal::Type::BaseModel
+        # @!attribute prompt_variables
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :prompt_variables, Revox::Internal::Type::HashOf[String]
+
+        # @!attribute to_phone_number
+        #
+        #   @return [String]
+        required :to_phone_number, String
+
+        # @!method initialize(prompt_variables:, to_phone_number:)
+        #   @param prompt_variables [Hash{Symbol=>String}]
+        #   @param to_phone_number [String]
+      end
+
+      # Campaign type. 'jump_in' campaigns only dial while someone is on the campaign
+      # page and auto-pause when unattended.
+      module Type
+        extend Revox::Internal::Type::Enum
+
+        REGULAR = :regular
+        JUMP_IN = :jump_in
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class CallRetryConfig < Revox::Internal::Type::BaseModel
+        # @!attribute allowed_days
+        #   Days of the week when calls are allowed, in the recipient's timezone. Default:
+        #   Monday through Friday.
+        #
+        #   @return [Array<Symbol, Revox::Models::CampaignCreateParams::CallRetryConfig::AllowedDay>]
+        required :allowed_days,
+                 -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignCreateParams::CallRetryConfig::AllowedDay] }
+
+        # @!attribute call_twice_in_a_row
+        #   If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping
+        #   retry_delay_seconds) when attempt #1 didn't reach a human.
+        #   Calling-window/allowed-days checks still apply. Only affects the 1→2 transition.
+        #   Default: false.
+        #
+        #   @return [Boolean]
+        required :call_twice_in_a_row, Revox::Internal::Type::Boolean
+
+        # @!attribute calling_windows
+        #
+        #   @return [Array<Revox::Models::CampaignCreateParams::CallRetryConfig::CallingWindow>]
+        required :calling_windows,
+                 -> { Revox::Internal::Type::ArrayOf[Revox::CampaignCreateParams::CallRetryConfig::CallingWindow] }
+
+        # @!attribute max_retry_attempts
+        #   Maximum number of call retry attempts. Default: 3.
+        #
+        #   @return [Integer]
+        required :max_retry_attempts, Integer
+
+        # @!attribute timezone
+        #   Optional IANA timezone identifier to override the automatic timezone detection
+        #   from phone number. If not provided, timezone is determined from the recipient's
+        #   phone number country code. Examples: 'America/New_York', 'Europe/Paris'.
+        #
+        #   @return [String, nil]
+        optional :timezone, String, nil?: true
+
+        # @!method initialize(allowed_days:, call_twice_in_a_row:, calling_windows:, max_retry_attempts:, timezone: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::CampaignCreateParams::CallRetryConfig} for more details.
+        #
+        #   Override retry configuration for calls in this campaign. If not provided, uses
+        #   the assistant's retry config.
+        #
+        #   @param allowed_days [Array<Symbol, Revox::Models::CampaignCreateParams::CallRetryConfig::AllowedDay>] Days of the week when calls are allowed, in the recipient's timezone. Default: M
+        #
+        #   @param call_twice_in_a_row [Boolean] If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retr
+        #
+        #   @param calling_windows [Array<Revox::Models::CampaignCreateParams::CallRetryConfig::CallingWindow>]
+        #
+        #   @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
+        #
+        #   @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f
+
+        module AllowedDay
+          extend Revox::Internal::Type::Enum
+
+          MONDAY = :monday
+          TUESDAY = :tuesday
+          WEDNESDAY = :wednesday
+          THURSDAY = :thursday
+          FRIDAY = :friday
+          SATURDAY = :saturday
+          SUNDAY = :sunday
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class CallingWindow < Revox::Internal::Type::BaseModel
+          # @!attribute calling_window_end_time
+          #   End time for the calling window in the recipient's timezone (or
+          #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
+          #   Examples: '17:00', '6pm'. Default: '18:00'.
+          #
+          #   @return [String]
+          required :calling_window_end_time, String
+
+          # @!attribute calling_window_start_time
+          #   Start time for the calling window in the recipient's timezone (or
+          #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
+          #   Examples: '09:00', '10am'. Default: '10:00'.
+          #
+          #   @return [String]
+          required :calling_window_start_time, String
+
+          # @!attribute retry_delay_seconds
+          #   Delay between retry attempts in seconds. Default: 7200 (2 hours).
+          #
+          #   @return [Integer]
+          required :retry_delay_seconds, Integer
+
+          # @!method initialize(calling_window_end_time:, calling_window_start_time:, retry_delay_seconds:)
+          #   Some parameter documentations has been truncated, see
+          #   {Revox::Models::CampaignCreateParams::CallRetryConfig::CallingWindow} for more
+          #   details.
+          #
+          #   @param calling_window_end_time [String] End time for the calling window in the recipient's timezone (or timezone_overrid
+          #
+          #   @param calling_window_start_time [String] Start time for the calling window in the recipient's timezone (or timezone_overr
+          #
+          #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. Default: 7200 (2 hours).
+        end
+      end
+
+      # Schedule all calls in this campaign to start at a specific date and time (ISO
+      # 8601 format)
+      module ScheduledAt
+        extend Revox::Internal::Type::Union
+
+        variant Time
+
+        variant Revox::Internal::Type::Unknown
+
+        # @!method self.variants
+        #   @return [Array(Time, Object)]
+      end
+    end
+  end
+end