telnyx 5.174.0 → 5.175.0

data/lib/telnyx/models/calendar_connection_create_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#create
+    class CalendarConnectionCreateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CalendarConnectionCreateResponse::Data]
+      required :data, -> { Telnyx::Models::CalendarConnectionCreateResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::CalendarConnectionCreateResponse::Data]
+
+      # @see Telnyx::Models::CalendarConnectionCreateResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute oauth_url
+        #   Open in a browser to authorize calendar access.
+        #
+        #   @return [String]
+        required :oauth_url, String
+
+        # @!attribute platform
+        #   Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        #   @return [Symbol, Telnyx::Models::CalendarConnectionCreateResponse::Data::Platform]
+        required :platform, enum: -> { Telnyx::Models::CalendarConnectionCreateResponse::Data::Platform }
+
+        # @!attribute status
+        #   Authorization has not completed.
+        #
+        #   @return [Symbol, :pending_oauth]
+        required :status, const: :pending_oauth
+
+        # @!method initialize(oauth_url:, platform:, status: :pending_oauth)
+        #   @param oauth_url [String] Open in a browser to authorize calendar access.
+        #
+        #   @param platform [Symbol, Telnyx::Models::CalendarConnectionCreateResponse::Data::Platform] Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        #   @param status [Symbol, :pending_oauth] Authorization has not completed.
+
+        # Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        # @see Telnyx::Models::CalendarConnectionCreateResponse::Data#platform
+        module Platform
+          extend Telnyx::Internal::Type::Enum
+
+          GOOGLE_CALENDAR = :google_calendar
+          MICROSOFT_OUTLOOK = :microsoft_outlook
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/calendar_connection_delete_params.rb

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

data/lib/telnyx/models/calendar_connection_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#list
+    class CalendarConnectionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/calendar_connection_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#list
+    class CalendarConnectionListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::CalendarConnection>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CalendarConnection] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::CalendarConnection>]
+    end
+  end
+end

data/lib/telnyx/models/calendar_connection_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#retrieve
+    class CalendarConnectionResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CalendarConnection]
+      required :data, -> { Telnyx::CalendarConnection }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::CalendarConnection]
+    end
+  end
+end

data/lib/telnyx/models/calendar_connection_retrieve_params.rb

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

data/lib/telnyx/models/calendar_connection_update_params.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#update
+    class CalendarConnectionUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute auto_join_policy
+      #   all_meetings joins eligible events; external_organizer_excluded requires the
+      #   connected user to be the organizer; per_meeting requires an explicit opt-in.
+      #
+      #   @return [Symbol, Telnyx::Models::CalendarConnectionUpdateParams::AutoJoinPolicy, nil]
+      optional :auto_join_policy, enum: -> { Telnyx::CalendarConnectionUpdateParams::AutoJoinPolicy }
+
+      # @!attribute bot_name
+      #   Bot display name; null clears the override.
+      #
+      #   @return [String, nil]
+      optional :bot_name, String, nil?: true
+
+      # @!attribute default_assistant
+      #   Default assistant for future calendar-scheduled Google Meet and Teams sessions.
+      #   The saved configuration must fit within 8 KiB. Use id, audio_gate,
+      #   dynamic_variables, and leave_on_end; avatar is not accepted. audio_gate defaults
+      #   to full_duplex.
+      #
+      #   @return [Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant, nil]
+      optional :default_assistant, -> { Telnyx::CalendarConnectionUpdateParams::DefaultAssistant }, nil?: true
+
+      # @!attribute default_barge_in
+      #   Default manual speech interruption. Cannot be true with default_assistant.
+      #
+      #   @return [Boolean, nil]
+      optional :default_barge_in, Telnyx::Internal::Type::Boolean, nil?: true
+
+      # @!attribute default_recording
+      #   Google Meet and Teams recording intent. When null, recording is enabled only if
+      #   a destination is set. True requires default_recording_export; false cannot be
+      #   combined with a destination.
+      #
+      #   @return [Boolean, nil]
+      optional :default_recording, Telnyx::Internal::Type::Boolean, nil?: true
+
+      # @!attribute default_recording_export
+      #   Customer-owned Telnyx Storage destination for recording exports. Uses the
+      #   authenticated organization and user; do not supply credentials, region,
+      #   organization ID or object key.
+      #
+      #   @return [Telnyx::Models::MeetingSessionRecordingDestination, nil]
+      optional :default_recording_export, -> { Telnyx::MeetingSessionRecordingDestination }, nil?: true
+
+      # @!attribute default_summarize_on_end
+      #   Generate a summary when each future session transcript finalizes.
+      #
+      #   @return [Boolean, nil]
+      optional :default_summarize_on_end, Telnyx::Internal::Type::Boolean, nil?: true
+
+      # @!attribute default_voice
+      #   Manual-speech voice; must be null when default_assistant is set.
+      #
+      #   @return [String, nil]
+      optional :default_voice, String, nil?: true
+
+      # @!attribute default_webhook_url
+      #   HTTPS destination for future session webhooks. Null clears the default. A
+      #   non-null update returns webhook_secret once; save it to verify signatures for
+      #   sessions created with this default. Existing sessions retain their original
+      #   signing secret.
+      #
+      #   @return [String, nil]
+      optional :default_webhook_url, String, nil?: true
+
+      # @!method initialize(id:, auto_join_policy: nil, bot_name: nil, default_assistant: nil, default_barge_in: nil, default_recording: nil, default_recording_export: nil, default_summarize_on_end: nil, default_voice: nil, default_webhook_url: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::CalendarConnectionUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param auto_join_policy [Symbol, Telnyx::Models::CalendarConnectionUpdateParams::AutoJoinPolicy] all_meetings joins eligible events; external_organizer_excluded requires the con
+      #
+      #   @param bot_name [String, nil] Bot display name; null clears the override.
+      #
+      #   @param default_assistant [Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant, nil] Default assistant for future calendar-scheduled Google Meet and Teams sessions.
+      #
+      #   @param default_barge_in [Boolean, nil] Default manual speech interruption. Cannot be true with default_assistant.
+      #
+      #   @param default_recording [Boolean, nil] Google Meet and Teams recording intent. When null, recording is enabled only if
+      #
+      #   @param default_recording_export [Telnyx::Models::MeetingSessionRecordingDestination, nil] Customer-owned Telnyx Storage destination for recording exports. Uses the authen
+      #
+      #   @param default_summarize_on_end [Boolean, nil] Generate a summary when each future session transcript finalizes.
+      #
+      #   @param default_voice [String, nil] Manual-speech voice; must be null when default_assistant is set.
+      #
+      #   @param default_webhook_url [String, nil] HTTPS destination for future session webhooks. Null clears the default. A non-nu
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # all_meetings joins eligible events; external_organizer_excluded requires the
+      # connected user to be the organizer; per_meeting requires an explicit opt-in.
+      module AutoJoinPolicy
+        extend Telnyx::Internal::Type::Enum
+
+        ALL_MEETINGS = :all_meetings
+        EXTERNAL_ORGANIZER_EXCLUDED = :external_organizer_excluded
+        PER_MEETING = :per_meeting
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class DefaultAssistant < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifier of the assistant to attach.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute audio_gate
+        #   Use full_duplex (default) to allow participants to interrupt, or half_duplex to
+        #   pause listening while the assistant speaks. Full-duplex pricing depends on
+        #   participant audio usage; see the Meeting pricing guide.
+        #
+        #   @return [Symbol, Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant::AudioGate, nil]
+        optional :audio_gate, enum: -> { Telnyx::CalendarConnectionUpdateParams::DefaultAssistant::AudioGate }
+
+        # @!attribute dynamic_variables
+        #   Per-conversation values for the
+        #   [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+        #   Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+        #   first utterance, so they resolve for the opening line as well as the rest of the
+        #   conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+        #   The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+        #   capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+        #   `meeting_session_id` are reserved and rejected with `400 invalid_request`.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]
+
+        # @!attribute leave_on_end
+        #   Leave when the assistant conversation ends or fails. Defaults to false. Other
+        #   leave-policy rules and explicit leave requests still apply.
+        #
+        #   @return [Boolean, nil]
+        optional :leave_on_end, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(id:, audio_gate: nil, dynamic_variables: nil, leave_on_end: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant} for more
+        #   details.
+        #
+        #   Default assistant for future calendar-scheduled Google Meet and Teams sessions.
+        #   The saved configuration must fit within 8 KiB. Use id, audio_gate,
+        #   dynamic_variables, and leave_on_end; avatar is not accepted. audio_gate defaults
+        #   to full_duplex.
+        #
+        #   @param id [String] Identifier of the assistant to attach.
+        #
+        #   @param audio_gate [Symbol, Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant::AudioGate] Use full_duplex (default) to allow participants to interrupt, or half_duplex to
+        #
+        #   @param dynamic_variables [Hash{Symbol=>String}] Per-conversation values for the [dynamic variables](/docs/inference/ai-assistant
+        #
+        #   @param leave_on_end [Boolean] Leave when the assistant conversation ends or fails. Defaults to false. Other le
+
+        # Use full_duplex (default) to allow participants to interrupt, or half_duplex to
+        # pause listening while the assistant speaks. Full-duplex pricing depends on
+        # participant audio usage; see the Meeting pricing guide.
+        #
+        # @see Telnyx::Models::CalendarConnectionUpdateParams::DefaultAssistant#audio_gate
+        module AudioGate
+          extend Telnyx::Internal::Type::Enum
+
+          HALF_DUPLEX = :half_duplex
+          FULL_DUPLEX = :full_duplex
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/calendar_connection_update_response.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::CalendarConnections#update
+    class CalendarConnectionUpdateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CalendarConnectionUpdateResponse::Data]
+      required :data, -> { Telnyx::Models::CalendarConnectionUpdateResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::CalendarConnectionUpdateResponse::Data]
+
+      # @see Telnyx::Models::CalendarConnectionUpdateResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Calendar connection ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute auto_join_policy
+        #   all_meetings joins eligible events; external_organizer_excluded requires the
+        #   connected user to be the organizer; per_meeting requires an explicit opt-in.
+        #
+        #   @return [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::AutoJoinPolicy]
+        required :auto_join_policy,
+                 enum: -> { Telnyx::Models::CalendarConnectionUpdateResponse::Data::AutoJoinPolicy }
+
+        # @!attribute bot_name
+        #   Bot display name; null clears the override.
+        #
+        #   @return [String, nil]
+        required :bot_name, String, nil?: true
+
+        # @!attribute created_at
+        #   Creation time.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute default_assistant
+        #
+        #   @return [Telnyx::Models::MeetingSessionAssistant, nil]
+        required :default_assistant, -> { Telnyx::MeetingSessionAssistant }, nil?: true
+
+        # @!attribute default_barge_in
+        #   Default manual speech interruption. Cannot be true with default_assistant.
+        #
+        #   @return [Boolean, nil]
+        required :default_barge_in, Telnyx::Internal::Type::Boolean, nil?: true
+
+        # @!attribute default_recording
+        #   Google Meet and Teams recording intent. When null, recording is enabled only if
+        #   a destination is set. True requires default_recording_export; false cannot be
+        #   combined with a destination.
+        #
+        #   @return [Boolean, nil]
+        required :default_recording, Telnyx::Internal::Type::Boolean, nil?: true
+
+        # @!attribute default_recording_export
+        #   Customer-owned Telnyx Storage destination for recording exports. Uses the
+        #   authenticated organization and user; do not supply credentials, region,
+        #   organization ID or object key.
+        #
+        #   @return [Telnyx::Models::MeetingSessionRecordingDestination, nil]
+        required :default_recording_export, -> { Telnyx::MeetingSessionRecordingDestination }, nil?: true
+
+        # @!attribute default_summarize_on_end
+        #   Generate a summary when each future session transcript finalizes.
+        #
+        #   @return [Boolean, nil]
+        required :default_summarize_on_end, Telnyx::Internal::Type::Boolean, nil?: true
+
+        # @!attribute default_voice
+        #   Manual-speech voice; must be null when default_assistant is set.
+        #
+        #   @return [String, nil]
+        required :default_voice, String, nil?: true
+
+        # @!attribute default_webhook_url
+        #   HTTPS destination for future session webhooks. Null clears the default. A
+        #   non-null update returns webhook_secret once; save it to verify signatures for
+        #   sessions created with this default. Existing sessions retain their original
+        #   signing secret.
+        #
+        #   @return [String, nil]
+        required :default_webhook_url, String, nil?: true
+
+        # @!attribute platform
+        #   Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        #   @return [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::Platform]
+        required :platform, enum: -> { Telnyx::Models::CalendarConnectionUpdateResponse::Data::Platform }
+
+        # @!attribute platform_email
+        #   Connected calendar email address.
+        #
+        #   @return [String, nil]
+        required :platform_email, String, nil?: true
+
+        # @!attribute status
+        #   Connection status.
+        #
+        #   @return [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::Status]
+        required :status, enum: -> { Telnyx::Models::CalendarConnectionUpdateResponse::Data::Status }
+
+        # @!attribute status_detail
+        #   Additional connection status detail.
+        #
+        #   @return [String, nil]
+        required :status_detail, String, nil?: true
+
+        # @!attribute updated_at
+        #   Last update time.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute webhook_secret
+        #   Returned only when PATCH supplies a non-null default_webhook_url. Not returned
+        #   by list or retrieve. Save this secret to verify webhooks for future sessions.
+        #
+        #   @return [String, nil]
+        optional :webhook_secret, String
+
+        # @!method initialize(id:, auto_join_policy:, bot_name:, created_at:, default_assistant:, default_barge_in:, default_recording:, default_recording_export:, default_summarize_on_end:, default_voice:, default_webhook_url:, platform:, platform_email:, status:, status_detail:, updated_at:, webhook_secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::CalendarConnectionUpdateResponse::Data} for more details.
+        #
+        #   @param id [String] Calendar connection ID.
+        #
+        #   @param auto_join_policy [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::AutoJoinPolicy] all_meetings joins eligible events; external_organizer_excluded requires the con
+        #
+        #   @param bot_name [String, nil] Bot display name; null clears the override.
+        #
+        #   @param created_at [Time] Creation time.
+        #
+        #   @param default_assistant [Telnyx::Models::MeetingSessionAssistant, nil]
+        #
+        #   @param default_barge_in [Boolean, nil] Default manual speech interruption. Cannot be true with default_assistant.
+        #
+        #   @param default_recording [Boolean, nil] Google Meet and Teams recording intent. When null, recording is enabled only if
+        #
+        #   @param default_recording_export [Telnyx::Models::MeetingSessionRecordingDestination, nil] Customer-owned Telnyx Storage destination for recording exports. Uses the authen
+        #
+        #   @param default_summarize_on_end [Boolean, nil] Generate a summary when each future session transcript finalizes.
+        #
+        #   @param default_voice [String, nil] Manual-speech voice; must be null when default_assistant is set.
+        #
+        #   @param default_webhook_url [String, nil] HTTPS destination for future session webhooks. Null clears the default. A non-nu
+        #
+        #   @param platform [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::Platform] Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        #   @param platform_email [String, nil] Connected calendar email address.
+        #
+        #   @param status [Symbol, Telnyx::Models::CalendarConnectionUpdateResponse::Data::Status] Connection status.
+        #
+        #   @param status_detail [String, nil] Additional connection status detail.
+        #
+        #   @param updated_at [Time] Last update time.
+        #
+        #   @param webhook_secret [String] Returned only when PATCH supplies a non-null default_webhook_url. Not returned b
+
+        # all_meetings joins eligible events; external_organizer_excluded requires the
+        # connected user to be the organizer; per_meeting requires an explicit opt-in.
+        #
+        # @see Telnyx::Models::CalendarConnectionUpdateResponse::Data#auto_join_policy
+        module AutoJoinPolicy
+          extend Telnyx::Internal::Type::Enum
+
+          ALL_MEETINGS = :all_meetings
+          EXTERNAL_ORGANIZER_EXCLUDED = :external_organizer_excluded
+          PER_MEETING = :per_meeting
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Calendar provider: Google Calendar or Microsoft Outlook.
+        #
+        # @see Telnyx::Models::CalendarConnectionUpdateResponse::Data#platform
+        module Platform
+          extend Telnyx::Internal::Type::Enum
+
+          GOOGLE_CALENDAR = :google_calendar
+          MICROSOFT_OUTLOOK = :microsoft_outlook
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Connection status.
+        #
+        # @see Telnyx::Models::CalendarConnectionUpdateResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          CONNECTED = :connected
+          DISCONNECTED = :disconnected
+          ERROR = :error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end