telnyx 5.171.0 → 5.173.0

data/lib/telnyx/models/ai/privacy_settings.rb

@@ -32,13 +32,80 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :in_transit_data_locality, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(data_retention: nil, in_transit_data_locality: nil)
+        # @!attribute pii_redaction
+        #   Controls redaction of personally identifiable information (PII) from the
+        #   conversation history that is stored for this assistant. `disabled` (default)
+        #   stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+        #   placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+        #   written: message content (user, assistant, and tool-result messages) and
+        #   tool-call arguments are redacted when written to conversation history, so the
+        #   stored transcript, its read-back via the history API, and any insights generated
+        #   from the stored messages contain the placeholders instead of the PII; response
+        #   bodies returned by webhook tools are redacted too, as stored in the webhook logs
+        #   — a per-conversation record separate from the transcript. In the Mission Control
+        #   Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+        #   corresponds to `redact`. Redaction runs when the stored copy is written, after
+        #   the LLM has generated its reply: the live conversation is not redacted, the
+        #   assistant's tools keep receiving the full (unredacted) values during the call,
+        #   and the LLM still sees full content in its context window. Call recordings
+        #   (including any recording layout configured under telephony settings) and the
+        #   payloads of messages/webhooks delivered during the call are never redacted by
+        #   this setting. The set of detected PII types (names, street addresses, phone
+        #   numbers, email addresses, government identifiers like SSN and driver's license
+        #   numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+        #   other identifiers unique to a person) is fixed by Telnyx and cannot be
+        #   configured or extended per assistant. Assistants with `redact` cannot be used
+        #   for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+        #   voice and web chat are unaffected.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::PrivacySettings::PiiRedaction, nil]
+        optional :pii_redaction, enum: -> { Telnyx::AI::PrivacySettings::PiiRedaction }
+
+        # @!method initialize(data_retention: nil, in_transit_data_locality: nil, pii_redaction: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::PrivacySettings} for more details.
         #
         #   @param data_retention [Boolean] If true, conversation history and insights will be stored. If false, they will n
         #
         #   @param in_transit_data_locality [Boolean] Requires every model call made for a web chat turn to be received and served ins
+        #
+        #   @param pii_redaction [Symbol, Telnyx::Models::AI::PrivacySettings::PiiRedaction] Controls redaction of personally identifiable information (PII) from the convers
+
+        # Controls redaction of personally identifiable information (PII) from the
+        # conversation history that is stored for this assistant. `disabled` (default)
+        # stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+        # placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+        # written: message content (user, assistant, and tool-result messages) and
+        # tool-call arguments are redacted when written to conversation history, so the
+        # stored transcript, its read-back via the history API, and any insights generated
+        # from the stored messages contain the placeholders instead of the PII; response
+        # bodies returned by webhook tools are redacted too, as stored in the webhook logs
+        # — a per-conversation record separate from the transcript. In the Mission Control
+        # Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+        # corresponds to `redact`. Redaction runs when the stored copy is written, after
+        # the LLM has generated its reply: the live conversation is not redacted, the
+        # assistant's tools keep receiving the full (unredacted) values during the call,
+        # and the LLM still sees full content in its context window. Call recordings
+        # (including any recording layout configured under telephony settings) and the
+        # payloads of messages/webhooks delivered during the call are never redacted by
+        # this setting. The set of detected PII types (names, street addresses, phone
+        # numbers, email addresses, government identifiers like SSN and driver's license
+        # numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+        # other identifiers unique to a person) is fixed by Telnyx and cannot be
+        # configured or extended per assistant. Assistants with `redact` cannot be used
+        # for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+        # voice and web chat are unaffected.
+        #
+        # @see Telnyx::Models::AI::PrivacySettings#pii_redaction
+        module PiiRedaction
+          extend Telnyx::Internal::Type::Enum
+
+          DISABLED = :disabled
+          REDACT = :redact
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/telnyx/models/ai/telephony_settings.rb

@@ -88,9 +88,16 @@ module Telnyx
 
         # @!attribute time_limit_secs
         #   Maximum duration in seconds for the AI assistant to participate on the call.
-        #   When this limit is reached the assistant will be stopped. This limit does not
-        #   apply to portions of a call without an active assistant (for instance, a call
-        #   transferred to a human representative).
+        #   When this limit is reached the assistant will be stopped. Stopping the assistant
+        #   does not itself hang up the call, and what happens next depends on how the
+        #   assistant is running. On Call Control (ai_assistant_start) the call leg stays
+        #   connected and continues to be billed until it is hung up (for example with the
+        #   Hangup call command) or until the call ends for another reason. On TeXML, the
+        #   assistant's `<Connect><AIAssistant>` instruction ends; in the default TeXML
+        #   setup for assistants no instructions follow it, so the call is hung up. Your
+        #   application receives a call.conversation.ended webhook when the assistant stops.
+        #   This limit does not apply to portions of a call without an active assistant (for
+        #   instance, a call transferred to a human representative).
         #
         #   @return [Integer, nil]
         optional :time_limit_secs, Integer
@@ -105,9 +112,16 @@ module Telnyx
 
         # @!attribute user_idle_timeout_secs
         #   Maximum duration in seconds of end user silence on the call. When this limit is
-        #   reached the assistant will be stopped. This limit does not apply to portions of
-        #   a call without an active assistant (for instance, a call transferred to a human
-        #   representative).
+        #   reached the assistant will be stopped. Stopping the assistant does not itself
+        #   hang up the call, and what happens next depends on how the assistant is running.
+        #   On Call Control (ai_assistant_start) the call leg stays connected and continues
+        #   to be billed until it is hung up (for example with the Hangup call command) or
+        #   until the call ends for another reason. On TeXML, the assistant's
+        #   `<Connect><AIAssistant>` instruction ends; in the default TeXML setup for
+        #   assistants no instructions follow it, so the call is hung up. Your application
+        #   receives a call.conversation.ended webhook when the assistant stops. This limit
+        #   does not apply to portions of a call without an active assistant (for instance,
+        #   a call transferred to a human representative).
         #
         #   @return [Integer, nil]
         optional :user_idle_timeout_secs, Integer

data/lib/telnyx/models/ai/telnyx_avatar_settings.rb

@@ -5,10 +5,10 @@ module Telnyx
     module AI
       class TelnyxAvatarSettings < Telnyx::Internal::Type::BaseModel
         # @!attribute avatar_id
-        #   The Telnyx avatar to render.
+        #   The Telnyx stock avatar or organization-owned custom avatar to render.
         #
-        #   @return [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::AvatarID]
-        required :avatar_id, enum: -> { Telnyx::AI::TelnyxAvatarSettings::AvatarID }
+        #   @return [String]
+        required :avatar_id, String
 
         # @!attribute background_id
         #   The background to render.
@@ -33,10 +33,12 @@ module Telnyx
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::TelnyxAvatarSettings} for more details.
         #
-        #   **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
-        #   catalog supports six avatars and office, studio, or reception backgrounds.
+        #   **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+        #   avatar or an organization-owned custom avatar returned by the Avatars API.
+        #   Discover the available stock catalog with GET /v2/ai/avatars and
+        #   filter[avatar_type]=stock; follow meta.total_pages to load every page.
         #
-        #   @param avatar_id [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::AvatarID] The Telnyx avatar to render.
+        #   @param avatar_id [String] The Telnyx stock avatar or organization-owned custom avatar to render.
         #
         #   @param background_id [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::BackgroundID] The background to render.
         #
@@ -44,23 +46,6 @@ module Telnyx
         #
         #   @param provider [Symbol, :telnyx] Selects the Telnyx open-source avatar provider.
 
-        # The Telnyx avatar to render.
-        #
-        # @see Telnyx::Models::AI::TelnyxAvatarSettings#avatar_id
-        module AvatarID
-          extend Telnyx::Internal::Type::Enum
-
-          ELENA = :elena
-          BEN = :ben
-          JORDAN = :jordan
-          LIN = :lin
-          AVERY = :avery
-          RAPHAEL = :raphael
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # The background to render.
         #
         # @see Telnyx::Models::AI::TelnyxAvatarSettings#background_id
@@ -70,6 +55,7 @@ module Telnyx
           OFFICE = :office
           STUDIO = :studio
           RECEPTION = :reception
+          ILLUSTRATED_WORKSPACE = :illustrated_workspace
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_cron_jobs_params.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @see Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs#cron_jobs
+            class CronJobCronJobsParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute crontab_expression
+              #   Cron expression controlling when the job runs.
+              #
+              #   @return [String]
+              required :crontab_expression, String
+
+              # @!attribute agent
+              #
+              #   @return [Integer, nil]
+              optional :agent, Integer
+
+              # @!attribute execution_mode
+              #   Execution mode for the test runs, such as voice, text, or sip.
+              #
+              #   @return [String, nil]
+              optional :execution_mode, String
+
+              # @!attribute frequency
+              #
+              #   @return [Integer, nil]
+              optional :frequency, Integer
+
+              # @!attribute is_active
+              #
+              #   @return [Boolean, nil]
+              optional :is_active, Telnyx::Internal::Type::Boolean
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute notify_on
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Tests::Schedules::V1::CronJobCronJobsParams::NotifyOn, nil]
+              optional :notify_on, enum: -> { Telnyx::AI::Tests::Schedules::V1::CronJobCronJobsParams::NotifyOn }
+
+              # @!attribute personalities
+              #
+              #   @return [Array<Integer>, nil]
+              optional :personalities, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute run_as_text
+              #
+              #   @return [Boolean, nil]
+              optional :run_as_text, Telnyx::Internal::Type::Boolean
+
+              # @!attribute scenarios
+              #
+              #   @return [Array<Integer>, nil]
+              optional :scenarios, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute tags
+              #
+              #   @return [Array<String>, nil]
+              optional :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute timezone
+              #
+              #   @return [String, nil]
+              optional :timezone, String
+
+              # @!method initialize(crontab_expression:, agent: nil, execution_mode: nil, frequency: nil, is_active: nil, name: nil, notify_on: nil, personalities: nil, run_as_text: nil, scenarios: nil, tags: nil, timezone: nil, request_options: {})
+              #   @param crontab_expression [String] Cron expression controlling when the job runs.
+              #
+              #   @param agent [Integer]
+              #
+              #   @param execution_mode [String] Execution mode for the test runs, such as voice, text, or sip.
+              #
+              #   @param frequency [Integer]
+              #
+              #   @param is_active [Boolean]
+              #
+              #   @param name [String]
+              #
+              #   @param notify_on [Symbol, Telnyx::Models::AI::Tests::Schedules::V1::CronJobCronJobsParams::NotifyOn]
+              #
+              #   @param personalities [Array<Integer>]
+              #
+              #   @param run_as_text [Boolean]
+              #
+              #   @param scenarios [Array<Integer>]
+              #
+              #   @param tags [Array<String>]
+              #
+              #   @param timezone [String]
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+              module NotifyOn
+                extend Telnyx::Internal::Type::Enum
+
+                NEVER = :never
+                SUCCESS = :success
+                FAILURE = :failure
+                BOTH = :both
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @see Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs#delete
+            class CronJobDeleteParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!method initialize(id:, request_options: {})
+              #   @param id [Integer]
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @type [Telnyx::Internal::Type::Converter]
+            CronJobDeleteResponse = Telnyx::Internal::Type::Unknown
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_retrieve_cron_jobs_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @see Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs#retrieve_cron_jobs
+            class CronJobRetrieveCronJobsParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute agent_id
+              #   Filter jobs belonging to the specified test agent.
+              #
+              #   @return [Integer, nil]
+              optional :agent_id, Integer
+
+              # @!method initialize(agent_id: nil, request_options: {})
+              #   @param agent_id [Integer] Filter jobs belonging to the specified test agent.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_retrieve_cron_jobs_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @type [Telnyx::Internal::Type::Converter]
+            CronJobRetrieveCronJobsResponse =
+              Telnyx::Internal::Type::ArrayOf[-> { Telnyx::AI::Tests::Schedules::V1::ScheduledTestJob }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @see Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs#retrieve
+            class CronJobRetrieveParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!method initialize(id:, request_options: {})
+              #   @param id [Integer]
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/schedules/v1/cron_job_update_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module Schedules
+          module V1
+            # @see Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs#update
+            class CronJobUpdateParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent
+              #
+              #   @return [Integer, nil]
+              optional :agent, Integer, nil?: true
+
+              # @!attribute crontab_expression
+              #   Cron expression controlling when the job runs.
+              #
+              #   @return [String, nil]
+              optional :crontab_expression, String
+
+              # @!attribute execution_mode
+              #   Execution mode for the test runs, such as voice, text, or sip.
+              #
+              #   @return [String, nil]
+              optional :execution_mode, String
+
+              # @!attribute frequency
+              #
+              #   @return [Integer, nil]
+              optional :frequency, Integer
+
+              # @!attribute is_active
+              #
+              #   @return [Boolean, nil]
+              optional :is_active, Telnyx::Internal::Type::Boolean
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute notify_on
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Tests::Schedules::V1::CronJobUpdateParams::NotifyOn, nil]
+              optional :notify_on, enum: -> { Telnyx::AI::Tests::Schedules::V1::CronJobUpdateParams::NotifyOn }
+
+              # @!attribute personalities
+              #
+              #   @return [Array<Integer>, nil]
+              optional :personalities, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute run_as_text
+              #
+              #   @return [Boolean, nil]
+              optional :run_as_text, Telnyx::Internal::Type::Boolean
+
+              # @!attribute scenarios
+              #
+              #   @return [Array<Integer>, nil]
+              optional :scenarios, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute tags
+              #
+              #   @return [Array<String>, nil]
+              optional :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute timezone
+              #
+              #   @return [String, nil]
+              optional :timezone, String
+
+              # @!method initialize(id:, agent: nil, crontab_expression: nil, execution_mode: nil, frequency: nil, is_active: nil, name: nil, notify_on: nil, personalities: nil, run_as_text: nil, scenarios: nil, tags: nil, timezone: nil, request_options: {})
+              #   @param id [Integer]
+              #
+              #   @param agent [Integer, nil]
+              #
+              #   @param crontab_expression [String] Cron expression controlling when the job runs.
+              #
+              #   @param execution_mode [String] Execution mode for the test runs, such as voice, text, or sip.
+              #
+              #   @param frequency [Integer]
+              #
+              #   @param is_active [Boolean]
+              #
+              #   @param name [String]
+              #
+              #   @param notify_on [Symbol, Telnyx::Models::AI::Tests::Schedules::V1::CronJobUpdateParams::NotifyOn]
+              #
+              #   @param personalities [Array<Integer>]
+              #
+              #   @param run_as_text [Boolean]
+              #
+              #   @param scenarios [Array<Integer>]
+              #
+              #   @param tags [Array<String>]
+              #
+              #   @param timezone [String]
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+              module NotifyOn
+                extend Telnyx::Internal::Type::Enum
+
+                NEVER = :never
+                SUCCESS = :success
+                FAILURE = :failure
+                BOTH = :both
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end