telnyx 5.171.0 → 5.173.0

data/lib/telnyx/models/browser_sessions/click_action.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class ClickAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute observation_id
+        #
+        #   @return [String]
+        required :observation_id, String
+
+        # @!attribute ref
+        #
+        #   @return [String]
+        required :ref, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :click]
+        required :type, const: :click
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!attribute timeout_ms
+        #
+        #   @return [Integer, nil]
+        optional :timeout_ms, Integer
+
+        # @!attribute wait
+        #
+        #   @return [Symbol, Telnyx::Models::BrowserSessions::ClickAction::Wait, nil]
+        optional :wait, enum: -> { Telnyx::BrowserSessions::ClickAction::Wait }
+
+        # @!method initialize(observation_id:, ref:, idempotency_key: nil, include_observation: nil, timeout_ms: nil, wait: nil, type: :click)
+        #   Click an element identified by observation_id + ref.
+        #
+        #   @param observation_id [String]
+        #   @param ref [String]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param timeout_ms [Integer]
+        #   @param wait [Symbol, Telnyx::Models::BrowserSessions::ClickAction::Wait]
+        #   @param type [Symbol, :click]
+
+        # @see Telnyx::Models::BrowserSessions::ClickAction#wait
+        module Wait
+          extend Telnyx::Internal::Type::Enum
+
+          NO_WAIT = :no_wait
+          DOM_STABLE = :dom_stable
+          URL_CHANGE = :url_change
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/fill_action.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class FillAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute observation_id
+        #
+        #   @return [String]
+        required :observation_id, String
+
+        # @!attribute ref
+        #
+        #   @return [String]
+        required :ref, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :fill]
+        required :type, const: :fill
+
+        # @!attribute value
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(observation_id:, ref:, value:, idempotency_key: nil, include_observation: nil, type: :fill)
+        #   Type text into the element identified by observation_id + ref.
+        #
+        #   @param observation_id [String]
+        #   @param ref [String]
+        #   @param value [String]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :fill]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/navigate_action.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class NavigateAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :navigate]
+        required :type, const: :navigate
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!attribute wait_until
+        #
+        #   @return [Symbol, Telnyx::Models::BrowserSessions::NavigateAction::WaitUntil, nil]
+        optional :wait_until, enum: -> { Telnyx::BrowserSessions::NavigateAction::WaitUntil }
+
+        # @!method initialize(url:, idempotency_key: nil, include_observation: nil, wait_until: nil, type: :navigate)
+        #   Navigate to a URL.
+        #
+        #   @param url [String]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param wait_until [Symbol, Telnyx::Models::BrowserSessions::NavigateAction::WaitUntil]
+        #   @param type [Symbol, :navigate]
+
+        # @see Telnyx::Models::BrowserSessions::NavigateAction#wait_until
+        module WaitUntil
+          extend Telnyx::Internal::Type::Enum
+
+          LOAD = :load
+          DOM_STABLE = :dom_stable
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/observe_action.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class ObserveAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :observe]
+        required :type, const: :observe
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(idempotency_key: nil, include_observation: nil, type: :observe)
+        #   Capture an observation (DOM snapshot) of the current page.
+        #
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :observe]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/press_action.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class PressAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute key
+        #
+        #   @return [Symbol, Telnyx::Models::BrowserSessions::PressAction::Key]
+        required :key, enum: -> { Telnyx::BrowserSessions::PressAction::Key }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :press]
+        required :type, const: :press
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(key:, idempotency_key: nil, include_observation: nil, type: :press)
+        #   Press a keyboard key.
+        #
+        #   @param key [Symbol, Telnyx::Models::BrowserSessions::PressAction::Key]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :press]
+
+        # @see Telnyx::Models::BrowserSessions::PressAction#key
+        module Key
+          extend Telnyx::Internal::Type::Enum
+
+          ENTER = :Enter
+          TAB = :Tab
+          ESCAPE = :Escape
+          BACKSPACE = :Backspace
+          ARROW_UP = :ArrowUp
+          ARROW_DOWN = :ArrowDown
+          ARROW_LEFT = :ArrowLeft
+          ARROW_RIGHT = :ArrowRight
+          PAGE_UP = :PageUp
+          PAGE_DOWN = :PageDown
+          HOME = :Home
+          END_ = :End
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/screenshot_action.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class ScreenshotAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :screenshot]
+        required :type, const: :screenshot
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(idempotency_key: nil, include_observation: nil, type: :screenshot)
+        #   Capture a screenshot of the current page.
+        #
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :screenshot]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/scroll_action.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class ScrollAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :scroll]
+        required :type, const: :scroll
+
+        # @!attribute delta_x
+        #
+        #   @return [Integer, nil]
+        optional :delta_x, Integer
+
+        # @!attribute delta_y
+        #
+        #   @return [Integer, nil]
+        optional :delta_y, Integer
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(delta_x: nil, delta_y: nil, idempotency_key: nil, include_observation: nil, type: :scroll)
+        #   Scroll the page.
+        #
+        #   @param delta_x [Integer]
+        #   @param delta_y [Integer]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :scroll]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/select_action.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class SelectAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute observation_id
+        #
+        #   @return [String]
+        required :observation_id, String
+
+        # @!attribute ref
+        #
+        #   @return [String]
+        required :ref, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :select]
+        required :type, const: :select
+
+        # @!attribute value
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(observation_id:, ref:, value:, idempotency_key: nil, include_observation: nil, type: :select)
+        #   Select an option on the element identified by observation_id + ref.
+        #
+        #   @param observation_id [String]
+        #   @param ref [String]
+        #   @param value [String]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param type [Symbol, :select]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_sessions/wait_for_action.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module BrowserSessions
+      class WaitForAction < Telnyx::Internal::Type::BaseModel
+        # @!attribute condition
+        #
+        #   @return [Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember0, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember1, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember2, Telnyx::Models::BrowserSessions::WaitForAction::Condition::Kind]
+        required :condition, union: -> { Telnyx::BrowserSessions::WaitForAction::Condition }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :wait_for]
+        required :type, const: :wait_for
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute include_observation
+        #
+        #   @return [Boolean, nil]
+        optional :include_observation, Telnyx::Internal::Type::Boolean
+
+        # @!attribute timeout_ms
+        #
+        #   @return [Integer, nil]
+        optional :timeout_ms, Integer
+
+        # @!method initialize(condition:, idempotency_key: nil, include_observation: nil, timeout_ms: nil, type: :wait_for)
+        #   Wait for a condition before continuing.
+        #
+        #   @param condition [Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember0, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember1, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember2, Telnyx::Models::BrowserSessions::WaitForAction::Condition::Kind]
+        #   @param idempotency_key [String]
+        #   @param include_observation [Boolean]
+        #   @param timeout_ms [Integer]
+        #   @param type [Symbol, :wait_for]
+
+        # @see Telnyx::Models::BrowserSessions::WaitForAction#condition
+        module Condition
+          extend Telnyx::Internal::Type::Union
+
+          variant -> { Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember0 }
+
+          variant -> { Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember1 }
+
+          variant -> { Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember2 }
+
+          variant -> { Telnyx::BrowserSessions::WaitForAction::Condition::Kind }
+
+          class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            # @!attribute kind
+            #
+            #   @return [Symbol, :url_pattern]
+            required :kind, const: :url_pattern
+
+            # @!attribute pattern
+            #
+            #   @return [String]
+            required :pattern, String
+
+            # @!method initialize(pattern:, kind: :url_pattern)
+            #   @param pattern [String]
+            #   @param kind [Symbol, :url_pattern]
+          end
+
+          class UnionMember1 < Telnyx::Internal::Type::BaseModel
+            # @!attribute kind
+            #
+            #   @return [Symbol, :ref]
+            required :kind, const: :ref
+
+            # @!attribute observation_id
+            #
+            #   @return [String]
+            required :observation_id, String
+
+            # @!attribute ref
+            #
+            #   @return [String]
+            required :ref, String
+
+            # @!method initialize(observation_id:, ref:, kind: :ref)
+            #   @param observation_id [String]
+            #   @param ref [String]
+            #   @param kind [Symbol, :ref]
+          end
+
+          class UnionMember2 < Telnyx::Internal::Type::BaseModel
+            # @!attribute kind
+            #
+            #   @return [Symbol, :text]
+            required :kind, const: :text
+
+            # @!attribute text
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!method initialize(text:, kind: :text)
+            #   @param text [String]
+            #   @param kind [Symbol, :text]
+          end
+
+          class Kind < Telnyx::Internal::Type::BaseModel
+            # @!attribute kind
+            #
+            #   @return [Symbol, :dom_stable]
+            required :kind, const: :dom_stable
+
+            # @!method initialize(kind: :dom_stable)
+            #   @param kind [Symbol, :dom_stable]
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember0, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember1, Telnyx::Models::BrowserSessions::WaitForAction::Condition::UnionMember2, Telnyx::Models::BrowserSessions::WaitForAction::Condition::Kind)]
+        end
+      end
+    end
+  end
+end