revox 0.2.0 → 0.3.0

data/rbi/revox/models/campaign_update_params.rbi

@@ -0,0 +1,431 @@
+# typed: strong
+
+module Revox
+  module Models
+    class CampaignUpdateParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Revox::CampaignUpdateParams, Revox::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The ID of the assistant to use (draft only)
+      sig { returns(T.nilable(String)) }
+      attr_reader :assistant_id
+
+      sig { params(assistant_id: String).void }
+      attr_writer :assistant_id
+
+      # Configuration for call retry behavior including time windows, delays, and max
+      # iterations. If not provided, defaults will be used.
+      sig { returns(T.nilable(Revox::CampaignUpdateParams::CallRetryConfig)) }
+      attr_reader :call_retry_config
+
+      sig do
+        params(
+          call_retry_config:
+            T.nilable(Revox::CampaignUpdateParams::CallRetryConfig::OrHash)
+        ).void
+      end
+      attr_writer :call_retry_config
+
+      # Replace contact list (draft only)
+      sig { returns(T.nilable(T::Array[Revox::CampaignUpdateParams::Contact])) }
+      attr_reader :contacts
+
+      sig do
+        params(
+          contacts: T::Array[Revox::CampaignUpdateParams::Contact::OrHash]
+        ).void
+      end
+      attr_writer :contacts
+
+      # The phone number to use for outbound calls (draft only)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :from_phone_number
+
+      # Maximum concurrent calls (draft only)
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :max_concurrent_calls
+
+      # Campaign display name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Scheduled start time (draft only)
+      sig do
+        returns(T.nilable(Revox::CampaignUpdateParams::ScheduledAt::Variants))
+      end
+      attr_accessor :scheduled_at
+
+      # Campaign type (draft only)
+      sig { returns(T.nilable(Revox::CampaignUpdateParams::Type::OrSymbol)) }
+      attr_reader :type
+
+      sig { params(type: Revox::CampaignUpdateParams::Type::OrSymbol).void }
+      attr_writer :type
+
+      sig do
+        params(
+          id: String,
+          assistant_id: String,
+          call_retry_config:
+            T.nilable(Revox::CampaignUpdateParams::CallRetryConfig::OrHash),
+          contacts: T::Array[Revox::CampaignUpdateParams::Contact::OrHash],
+          from_phone_number: T.nilable(String),
+          max_concurrent_calls: T.nilable(Float),
+          name: String,
+          scheduled_at:
+            T.nilable(Revox::CampaignUpdateParams::ScheduledAt::Variants),
+          type: Revox::CampaignUpdateParams::Type::OrSymbol,
+          request_options: Revox::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # The ID of the assistant to use (draft only)
+        assistant_id: nil,
+        # Configuration for call retry behavior including time windows, delays, and max
+        # iterations. If not provided, defaults will be used.
+        call_retry_config: nil,
+        # Replace contact list (draft only)
+        contacts: nil,
+        # The phone number to use for outbound calls (draft only)
+        from_phone_number: nil,
+        # Maximum concurrent calls (draft only)
+        max_concurrent_calls: nil,
+        # Campaign display name
+        name: nil,
+        # Scheduled start time (draft only)
+        scheduled_at: nil,
+        # Campaign type (draft only)
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            assistant_id: String,
+            call_retry_config:
+              T.nilable(Revox::CampaignUpdateParams::CallRetryConfig),
+            contacts: T::Array[Revox::CampaignUpdateParams::Contact],
+            from_phone_number: T.nilable(String),
+            max_concurrent_calls: T.nilable(Float),
+            name: String,
+            scheduled_at:
+              T.nilable(Revox::CampaignUpdateParams::ScheduledAt::Variants),
+            type: Revox::CampaignUpdateParams::Type::OrSymbol,
+            request_options: Revox::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CallRetryConfig < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::CampaignUpdateParams::CallRetryConfig,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        # Days of the week when calls are allowed, in the recipient's timezone. Default:
+        # Monday through Friday.
+        sig do
+          returns(
+            T::Array[
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::OrSymbol
+            ]
+          )
+        end
+        attr_accessor :allowed_days
+
+        # 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.
+        sig { returns(T::Boolean) }
+        attr_accessor :call_twice_in_a_row
+
+        sig do
+          returns(
+            T::Array[
+              Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow
+            ]
+          )
+        end
+        attr_accessor :calling_windows
+
+        # Maximum number of call retry attempts. Default: 3.
+        sig { returns(Integer) }
+        attr_accessor :max_retry_attempts
+
+        # 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'.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :timezone
+
+        # Configuration for call retry behavior including time windows, delays, and max
+        # iterations. If not provided, defaults will be used.
+        sig do
+          params(
+            allowed_days:
+              T::Array[
+                Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::OrSymbol
+              ],
+            call_twice_in_a_row: T::Boolean,
+            calling_windows:
+              T::Array[
+                Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow::OrHash
+              ],
+            max_retry_attempts: Integer,
+            timezone: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Days of the week when calls are allowed, in the recipient's timezone. Default:
+          # Monday through Friday.
+          allowed_days:,
+          # 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.
+          call_twice_in_a_row:,
+          calling_windows:,
+          # Maximum number of call retry attempts. Default: 3.
+          max_retry_attempts:,
+          # 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'.
+          timezone: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allowed_days:
+                T::Array[
+                  Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::OrSymbol
+                ],
+              call_twice_in_a_row: T::Boolean,
+              calling_windows:
+                T::Array[
+                  Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow
+                ],
+              max_retry_attempts: Integer,
+              timezone: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AllowedDay
+          extend Revox::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MONDAY =
+            T.let(
+              :monday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          TUESDAY =
+            T.let(
+              :tuesday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          WEDNESDAY =
+            T.let(
+              :wednesday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          THURSDAY =
+            T.let(
+              :thursday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          FRIDAY =
+            T.let(
+              :friday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          SATURDAY =
+            T.let(
+              :saturday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+          SUNDAY =
+            T.let(
+              :sunday,
+              Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Revox::CampaignUpdateParams::CallRetryConfig::AllowedDay::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class CallingWindow < Revox::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Revox::CampaignUpdateParams::CallRetryConfig::CallingWindow,
+                Revox::Internal::AnyHash
+              )
+            end
+
+          # 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'.
+          sig { returns(String) }
+          attr_accessor :calling_window_end_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'.
+          sig { returns(String) }
+          attr_accessor :calling_window_start_time
+
+          # Delay between retry attempts in seconds. Default: 7200 (2 hours).
+          sig { returns(Integer) }
+          attr_accessor :retry_delay_seconds
+
+          sig do
+            params(
+              calling_window_end_time: String,
+              calling_window_start_time: String,
+              retry_delay_seconds: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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'.
+            calling_window_end_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'.
+            calling_window_start_time:,
+            # Delay between retry attempts in seconds. Default: 7200 (2 hours).
+            retry_delay_seconds:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                calling_window_end_time: String,
+                calling_window_start_time: String,
+                retry_delay_seconds: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Contact < Revox::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Revox::CampaignUpdateParams::Contact,
+              Revox::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :prompt_variables
+
+        sig { returns(String) }
+        attr_accessor :to_phone_number
+
+        sig do
+          params(
+            prompt_variables: T::Hash[Symbol, String],
+            to_phone_number: String
+          ).returns(T.attached_class)
+        end
+        def self.new(prompt_variables:, to_phone_number:)
+        end
+
+        sig do
+          override.returns(
+            {
+              prompt_variables: T::Hash[Symbol, String],
+              to_phone_number: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # Scheduled start time (draft only)
+      module ScheduledAt
+        extend Revox::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(Time, T.anything) }
+
+        sig do
+          override.returns(
+            T::Array[Revox::CampaignUpdateParams::ScheduledAt::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      # Campaign type (draft only)
+      module Type
+        extend Revox::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Revox::CampaignUpdateParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REGULAR =
+          T.let(:regular, Revox::CampaignUpdateParams::Type::TaggedSymbol)
+        JUMP_IN =
+          T.let(:jump_in, Revox::CampaignUpdateParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Revox::CampaignUpdateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end