telnyx 5.160.0 → 5.161.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +8 -0
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +152 -0
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +103 -0
- data/lib/telnyx/models/call_dial_params.rb +7 -7
- data/lib/telnyx/models/calls/action_answer_params.rb +7 -6
- data/lib/telnyx/models/calls/action_transfer_params.rb +7 -6
- data/lib/telnyx/models/meeting_session.rb +380 -0
- data/lib/telnyx/models/meeting_session_create_params.rb +309 -0
- data/lib/telnyx/models/meeting_session_delete_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_delete_recording_media_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_delete_recording_media_response.rb +61 -0
- data/lib/telnyx/models/meeting_session_list_params.rb +39 -0
- data/lib/telnyx/models/meeting_session_list_response.rb +16 -0
- data/lib/telnyx/models/meeting_session_response.rb +22 -0
- data/lib/telnyx/models/meeting_session_retrieve_events_params.rb +37 -0
- data/lib/telnyx/models/meeting_session_retrieve_events_response.rb +45 -0
- data/lib/telnyx/models/meeting_session_retrieve_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_retrieve_recordings_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_retrieve_recordings_response.rb +49 -0
- data/lib/telnyx/models/meeting_session_retrieve_transcript_params.rb +50 -0
- data/lib/telnyx/models/meeting_session_retrieve_transcript_response.rb +80 -0
- data/lib/telnyx/models/meeting_session_update_params.rb +37 -0
- data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb +29 -0
- data/lib/telnyx/models/meeting_sessions/action_send_chat_params.rb +31 -0
- data/lib/telnyx/models/meeting_sessions/action_speak_params.rb +52 -0
- data/lib/telnyx/models/meeting_sessions/action_stop_speaking_params.rb +22 -0
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +42 -0
- data/lib/telnyx/models/meeting_sessions/artifact_list_params.rb +22 -0
- data/lib/telnyx/models/meeting_sessions/artifact_list_response.rb +18 -0
- data/lib/telnyx/models/meeting_sessions/artifact_retrieve_params.rb +28 -0
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +120 -0
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact_response.rb +20 -0
- data/lib/telnyx/models/phone_numbers/voicemail_pref_response.rb +64 -1
- data/lib/telnyx/models/phone_numbers/voicemail_request.rb +63 -1
- data/lib/telnyx/models/private_wireless_gateway_status.rb +2 -2
- data/lib/telnyx/models/recording_available_webhook_event.rb +82 -0
- data/lib/telnyx/models/session_status_changed_webhook_event.rb +102 -0
- data/lib/telnyx/models/sim_cards/action_bulk_enable_voice_params.rb +16 -1
- data/lib/telnyx/models/sim_cards/action_disable_voice_params.rb +22 -0
- data/lib/telnyx/models/sim_cards/action_disable_voice_response.rb +23 -0
- data/lib/telnyx/models/sim_cards/action_enable_voice_params.rb +37 -0
- data/lib/telnyx/models/sim_cards/action_enable_voice_response.rb +23 -0
- data/lib/telnyx/models/sim_cards/action_list_params.rb +2 -0
- data/lib/telnyx/models/sim_cards/wireless_sim_card_action.rb +6 -0
- data/lib/telnyx/models/storage/edge_compute_pagination_meta.rb +35 -0
- data/lib/telnyx/models/storage/sql_database.rb +75 -0
- data/lib/telnyx/models/storage/sql_database_response_wrapper.rb +18 -0
- data/lib/telnyx/models/storage/sqldb_create_params.rb +28 -0
- data/lib/telnyx/models/storage/sqldb_delete_params.rb +35 -0
- data/lib/telnyx/models/storage/sqldb_list_params.rb +85 -0
- data/lib/telnyx/models/storage/sqldb_retrieve_params.rb +22 -0
- data/lib/telnyx/models/storage/sqldbs/action_query_params.rb +66 -0
- data/lib/telnyx/models/storage/sqldbs/action_query_response.rb +109 -0
- data/lib/telnyx/models/transcript_completed_webhook_event.rb +98 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +11 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +11 -1
- data/lib/telnyx/models/web_search/research_citation.rb +34 -0
- data/lib/telnyx/models/web_search/research_create_params.rb +65 -0
- data/lib/telnyx/models/web_search/research_create_response.rb +93 -0
- data/lib/telnyx/models/web_search/research_retrieve_params.rb +22 -0
- data/lib/telnyx/models/web_search/research_retrieve_response.rb +77 -0
- data/lib/telnyx/models/web_search_contents_params.rb +63 -0
- data/lib/telnyx/models/web_search_contents_response.rb +97 -0
- data/lib/telnyx/models/web_search_create_params.rb +95 -0
- data/lib/telnyx/models/web_search_create_response.rb +47 -0
- data/lib/telnyx/models/web_search_result.rb +56 -0
- data/lib/telnyx/models.rb +42 -0
- data/lib/telnyx/resources/calls/actions.rb +2 -2
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/meeting_sessions/actions.rb +92 -0
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +92 -0
- data/lib/telnyx/resources/meeting_sessions.rb +290 -0
- data/lib/telnyx/resources/phone_numbers/voicemail.rb +20 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +66 -1
- data/lib/telnyx/resources/storage/sqldbs/actions.rb +50 -0
- data/lib/telnyx/resources/storage/sqldbs.rb +140 -0
- data/lib/telnyx/resources/storage.rb +5 -0
- data/lib/telnyx/resources/web_search/research.rb +86 -0
- data/lib/telnyx/resources/web_search.rb +96 -0
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +61 -0
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +283 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +185 -0
- data/rbi/telnyx/models/call_dial_params.rbi +12 -12
- data/rbi/telnyx/models/calls/action_answer_params.rbi +12 -10
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +12 -10
- data/rbi/telnyx/models/meeting_session.rbi +544 -0
- data/rbi/telnyx/models/meeting_session_create_params.rbi +526 -0
- data/rbi/telnyx/models/meeting_session_delete_params.rbi +35 -0
- data/rbi/telnyx/models/meeting_session_delete_recording_media_params.rbi +38 -0
- data/rbi/telnyx/models/meeting_session_delete_recording_media_response.rbi +143 -0
- data/rbi/telnyx/models/meeting_session_list_params.rbi +101 -0
- data/rbi/telnyx/models/meeting_session_list_response.rbi +30 -0
- data/rbi/telnyx/models/meeting_session_response.rbi +36 -0
- data/rbi/telnyx/models/meeting_session_retrieve_events_params.rbi +66 -0
- data/rbi/telnyx/models/meeting_session_retrieve_events_response.rbi +92 -0
- data/rbi/telnyx/models/meeting_session_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/meeting_session_retrieve_recordings_params.rbi +38 -0
- data/rbi/telnyx/models/meeting_session_retrieve_recordings_response.rbi +97 -0
- data/rbi/telnyx/models/meeting_session_retrieve_transcript_params.rbi +81 -0
- data/rbi/telnyx/models/meeting_session_retrieve_transcript_response.rbi +154 -0
- data/rbi/telnyx/models/meeting_session_update_params.rbi +63 -0
- data/rbi/telnyx/models/meeting_sessions/action_accepted_response.rbi +64 -0
- data/rbi/telnyx/models/meeting_sessions/action_send_chat_params.rbi +54 -0
- data/rbi/telnyx/models/meeting_sessions/action_speak_params.rbi +80 -0
- data/rbi/telnyx/models/meeting_sessions/action_stop_speaking_params.rbi +40 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +89 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_list_params.rbi +40 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_list_response.rbi +39 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +264 -0
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbi +46 -0
- data/rbi/telnyx/models/phone_numbers/voicemail_pref_response.rbi +149 -2
- data/rbi/telnyx/models/phone_numbers/voicemail_request.rbi +145 -2
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +2 -2
- data/rbi/telnyx/models/recording_available_webhook_event.rbi +146 -0
- data/rbi/telnyx/models/session_status_changed_webhook_event.rbi +171 -0
- data/rbi/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbi +21 -1
- data/rbi/telnyx/models/sim_cards/action_disable_voice_params.rbi +40 -0
- data/rbi/telnyx/models/sim_cards/action_disable_voice_response.rbi +45 -0
- data/rbi/telnyx/models/sim_cards/action_enable_voice_params.rbi +63 -0
- data/rbi/telnyx/models/sim_cards/action_enable_voice_response.rbi +45 -0
- data/rbi/telnyx/models/sim_cards/action_list_params.rbi +10 -0
- data/rbi/telnyx/models/sim_cards/wireless_sim_card_action.rbi +16 -0
- data/rbi/telnyx/models/storage/edge_compute_pagination_meta.rbi +70 -0
- data/rbi/telnyx/models/storage/sql_database.rbi +131 -0
- data/rbi/telnyx/models/storage/sql_database_response_wrapper.rbi +35 -0
- data/rbi/telnyx/models/storage/sqldb_create_params.rbi +44 -0
- data/rbi/telnyx/models/storage/sqldb_delete_params.rbi +56 -0
- data/rbi/telnyx/models/storage/sqldb_list_params.rbi +198 -0
- data/rbi/telnyx/models/storage/sqldb_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi +125 -0
- data/rbi/telnyx/models/storage/sqldbs/action_query_response.rbi +226 -0
- data/rbi/telnyx/models/transcript_completed_webhook_event.rbi +166 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +5 -0
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +5 -0
- data/rbi/telnyx/models/web_search/research_citation.rbi +53 -0
- data/rbi/telnyx/models/web_search/research_create_params.rbi +138 -0
- data/rbi/telnyx/models/web_search/research_create_response.rbi +235 -0
- data/rbi/telnyx/models/web_search/research_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/web_search/research_retrieve_response.rbi +179 -0
- data/rbi/telnyx/models/web_search_contents_params.rbi +119 -0
- data/rbi/telnyx/models/web_search_contents_response.rbi +232 -0
- data/rbi/telnyx/models/web_search_create_params.rbi +162 -0
- data/rbi/telnyx/models/web_search_create_response.rbi +127 -0
- data/rbi/telnyx/models/web_search_result.rbi +83 -0
- data/rbi/telnyx/models.rbi +49 -0
- data/rbi/telnyx/resources/calls/actions.rbi +10 -8
- data/rbi/telnyx/resources/calls.rbi +5 -5
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +71 -0
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +67 -0
- data/rbi/telnyx/resources/meeting_sessions.rbi +256 -0
- data/rbi/telnyx/resources/phone_numbers/voicemail.rbi +22 -2
- data/rbi/telnyx/resources/sim_cards/actions.rbi +56 -1
- data/rbi/telnyx/resources/storage/sqldbs/actions.rbi +50 -0
- data/rbi/telnyx/resources/storage/sqldbs.rbi +105 -0
- data/rbi/telnyx/resources/storage.rbi +4 -0
- data/rbi/telnyx/resources/web_search/research.rbi +71 -0
- data/rbi/telnyx/resources/web_search.rbi +86 -0
- data/rbi/telnyx/resources/webhooks.rbi +10 -0
- data/sig/telnyx/client.rbs +4 -0
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +120 -0
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +88 -0
- data/sig/telnyx/models/call_dial_params.rbs +7 -5
- data/sig/telnyx/models/calls/action_answer_params.rbs +7 -5
- data/sig/telnyx/models/calls/action_transfer_params.rbs +7 -5
- data/sig/telnyx/models/meeting_session.rbs +277 -0
- data/sig/telnyx/models/meeting_session_create_params.rbs +222 -0
- data/sig/telnyx/models/meeting_session_delete_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_delete_recording_media_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_delete_recording_media_response.rbs +61 -0
- data/sig/telnyx/models/meeting_session_list_params.rbs +53 -0
- data/sig/telnyx/models/meeting_session_list_response.rbs +14 -0
- data/sig/telnyx/models/meeting_session_response.rbs +13 -0
- data/sig/telnyx/models/meeting_session_retrieve_events_params.rbs +36 -0
- data/sig/telnyx/models/meeting_session_retrieve_events_response.rbs +52 -0
- data/sig/telnyx/models/meeting_session_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_retrieve_recordings_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_retrieve_recordings_response.rbs +34 -0
- data/sig/telnyx/models/meeting_session_retrieve_transcript_params.rbs +42 -0
- data/sig/telnyx/models/meeting_session_retrieve_transcript_response.rbs +77 -0
- data/sig/telnyx/models/meeting_session_update_params.rbs +36 -0
- data/sig/telnyx/models/meeting_sessions/action_accepted_response.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/action_send_chat_params.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/action_speak_params.rbs +42 -0
- data/sig/telnyx/models/meeting_sessions/action_stop_speaking_params.rbs +22 -0
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +44 -0
- data/sig/telnyx/models/meeting_sessions/artifact_list_params.rbs +22 -0
- data/sig/telnyx/models/meeting_sessions/artifact_list_response.rbs +20 -0
- data/sig/telnyx/models/meeting_sessions/artifact_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +109 -0
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbs +22 -0
- data/sig/telnyx/models/phone_numbers/voicemail_pref_response.rbs +59 -3
- data/sig/telnyx/models/phone_numbers/voicemail_request.rbs +59 -3
- data/sig/telnyx/models/recording_available_webhook_event.rbs +65 -0
- data/sig/telnyx/models/session_status_changed_webhook_event.rbs +82 -0
- data/sig/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbs +7 -1
- data/sig/telnyx/models/sim_cards/action_disable_voice_params.rbs +22 -0
- data/sig/telnyx/models/sim_cards/action_disable_voice_response.rbs +20 -0
- data/sig/telnyx/models/sim_cards/action_enable_voice_params.rbs +32 -0
- data/sig/telnyx/models/sim_cards/action_enable_voice_response.rbs +20 -0
- data/sig/telnyx/models/sim_cards/action_list_params.rbs +4 -0
- data/sig/telnyx/models/sim_cards/wireless_sim_card_action.rbs +8 -1
- data/sig/telnyx/models/storage/edge_compute_pagination_meta.rbs +45 -0
- data/sig/telnyx/models/storage/sql_database.rbs +80 -0
- data/sig/telnyx/models/storage/sql_database_response_wrapper.rbs +20 -0
- data/sig/telnyx/models/storage/sqldb_create_params.rbs +25 -0
- data/sig/telnyx/models/storage/sqldb_delete_params.rbs +31 -0
- data/sig/telnyx/models/storage/sqldb_list_params.rbs +97 -0
- data/sig/telnyx/models/storage/sqldb_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/storage/sqldbs/action_query_params.rbs +52 -0
- data/sig/telnyx/models/storage/sqldbs/action_query_response.rbs +124 -0
- data/sig/telnyx/models/transcript_completed_webhook_event.rbs +82 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +5 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +5 -0
- data/sig/telnyx/models/web_search/research_citation.rbs +21 -0
- data/sig/telnyx/models/web_search/research_create_params.rbs +63 -0
- data/sig/telnyx/models/web_search/research_create_response.rbs +95 -0
- data/sig/telnyx/models/web_search/research_retrieve_params.rbs +25 -0
- data/sig/telnyx/models/web_search/research_retrieve_response.rbs +80 -0
- data/sig/telnyx/models/web_search_contents_params.rbs +59 -0
- data/sig/telnyx/models/web_search_contents_response.rbs +104 -0
- data/sig/telnyx/models/web_search_create_params.rbs +89 -0
- data/sig/telnyx/models/web_search_create_response.rbs +65 -0
- data/sig/telnyx/models/web_search_result.rbs +49 -0
- data/sig/telnyx/models.rbs +42 -0
- data/sig/telnyx/resources/calls/actions.rbs +2 -2
- data/sig/telnyx/resources/calls.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions/actions.rbs +28 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +26 -0
- data/sig/telnyx/resources/meeting_sessions.rbs +75 -0
- data/sig/telnyx/resources/phone_numbers/voicemail.rbs +2 -0
- data/sig/telnyx/resources/sim_cards/actions.rbs +12 -0
- data/sig/telnyx/resources/storage/sqldbs/actions.rbs +18 -0
- data/sig/telnyx/resources/storage/sqldbs.rbs +36 -0
- data/sig/telnyx/resources/storage.rbs +2 -0
- data/sig/telnyx/resources/web_search/research.rbs +22 -0
- data/sig/telnyx/resources/web_search.rbs +29 -0
- data/sig/telnyx/resources/webhooks.rbs +10 -0
- metadata +185 -2
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class TranscriptCompletedWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# Unique event id; deduplicate deliveries on it.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute data
|
|
13
|
+
# Finalized transcript details.
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::TranscriptCompletedWebhookEvent::Data]
|
|
16
|
+
required :data, -> { Telnyx::TranscriptCompletedWebhookEvent::Data }
|
|
17
|
+
|
|
18
|
+
# @!attribute event
|
|
19
|
+
# Event type.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, Telnyx::Models::TranscriptCompletedWebhookEvent::Event]
|
|
22
|
+
required :event, enum: -> { Telnyx::TranscriptCompletedWebhookEvent::Event }
|
|
23
|
+
|
|
24
|
+
# @!attribute occurred_at
|
|
25
|
+
# When the event occurred.
|
|
26
|
+
#
|
|
27
|
+
# @return [Time]
|
|
28
|
+
required :occurred_at, Time
|
|
29
|
+
|
|
30
|
+
# @!attribute version
|
|
31
|
+
# Envelope version.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :version, String
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, data:, event:, occurred_at:, version:)
|
|
37
|
+
# @param id [String] Unique event id; deduplicate deliveries on it.
|
|
38
|
+
#
|
|
39
|
+
# @param data [Telnyx::Models::TranscriptCompletedWebhookEvent::Data] Finalized transcript details.
|
|
40
|
+
#
|
|
41
|
+
# @param event [Symbol, Telnyx::Models::TranscriptCompletedWebhookEvent::Event] Event type.
|
|
42
|
+
#
|
|
43
|
+
# @param occurred_at [Time] When the event occurred.
|
|
44
|
+
#
|
|
45
|
+
# @param version [String] Envelope version.
|
|
46
|
+
|
|
47
|
+
# @see Telnyx::Models::TranscriptCompletedWebhookEvent#data
|
|
48
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
49
|
+
# @!attribute ended_at
|
|
50
|
+
# Session end time, or null when unavailable.
|
|
51
|
+
#
|
|
52
|
+
# @return [Time, nil]
|
|
53
|
+
required :ended_at, Time, nil?: true
|
|
54
|
+
|
|
55
|
+
# @!attribute last_seq
|
|
56
|
+
# Last transcript segment sequence number, or null for an empty transcript.
|
|
57
|
+
#
|
|
58
|
+
# @return [Integer, nil]
|
|
59
|
+
required :last_seq, Integer, nil?: true
|
|
60
|
+
|
|
61
|
+
# @!attribute segment_count
|
|
62
|
+
# Number of transcript segments observed during finalization.
|
|
63
|
+
#
|
|
64
|
+
# @return [Integer]
|
|
65
|
+
required :segment_count, Integer
|
|
66
|
+
|
|
67
|
+
# @!attribute session_id
|
|
68
|
+
# The meeting session this event belongs to.
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :session_id, String
|
|
72
|
+
|
|
73
|
+
# @!method initialize(ended_at:, last_seq:, segment_count:, session_id:)
|
|
74
|
+
# Finalized transcript details.
|
|
75
|
+
#
|
|
76
|
+
# @param ended_at [Time, nil] Session end time, or null when unavailable.
|
|
77
|
+
#
|
|
78
|
+
# @param last_seq [Integer, nil] Last transcript segment sequence number, or null for an empty transcript.
|
|
79
|
+
#
|
|
80
|
+
# @param segment_count [Integer] Number of transcript segments observed during finalization.
|
|
81
|
+
#
|
|
82
|
+
# @param session_id [String] The meeting session this event belongs to.
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Event type.
|
|
86
|
+
#
|
|
87
|
+
# @see Telnyx::Models::TranscriptCompletedWebhookEvent#event
|
|
88
|
+
module Event
|
|
89
|
+
extend Telnyx::Internal::Type::Enum
|
|
90
|
+
|
|
91
|
+
TRANSCRIPT_COMPLETED = :"transcript.completed"
|
|
92
|
+
|
|
93
|
+
# @!method self.values
|
|
94
|
+
# @return [Array<Symbol>]
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
@@ -11,6 +11,10 @@ module Telnyx
|
|
|
11
11
|
|
|
12
12
|
variant -> { Telnyx::CallAIGatherPartialResultsWebhookEvent }
|
|
13
13
|
|
|
14
|
+
variant -> { Telnyx::ArtifactCompletedWebhookEvent }
|
|
15
|
+
|
|
16
|
+
variant -> { Telnyx::ArtifactFailedWebhookEvent }
|
|
17
|
+
|
|
14
18
|
variant -> { Telnyx::CallAnsweredWebhookEvent }
|
|
15
19
|
|
|
16
20
|
variant -> { Telnyx::CallBridgedWebhookEvent }
|
|
@@ -137,12 +141,18 @@ module Telnyx
|
|
|
137
141
|
|
|
138
142
|
variant -> { Telnyx::NumberOrderStatusUpdateWebhookEvent }
|
|
139
143
|
|
|
144
|
+
variant -> { Telnyx::RecordingAvailableWebhookEvent }
|
|
145
|
+
|
|
140
146
|
variant -> { Telnyx::ReplacedLinkClickWebhookEvent }
|
|
141
147
|
|
|
148
|
+
variant -> { Telnyx::SessionStatusChangedWebhookEvent }
|
|
149
|
+
|
|
150
|
+
variant -> { Telnyx::TranscriptCompletedWebhookEvent }
|
|
151
|
+
|
|
142
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
143
153
|
|
|
144
154
|
# @!method self.variants
|
|
145
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
155
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
146
156
|
end
|
|
147
157
|
end
|
|
148
158
|
end
|
|
@@ -11,6 +11,10 @@ module Telnyx
|
|
|
11
11
|
|
|
12
12
|
variant -> { Telnyx::CallAIGatherPartialResultsWebhookEvent }
|
|
13
13
|
|
|
14
|
+
variant -> { Telnyx::ArtifactCompletedWebhookEvent }
|
|
15
|
+
|
|
16
|
+
variant -> { Telnyx::ArtifactFailedWebhookEvent }
|
|
17
|
+
|
|
14
18
|
variant -> { Telnyx::CallAnsweredWebhookEvent }
|
|
15
19
|
|
|
16
20
|
variant -> { Telnyx::CallBridgedWebhookEvent }
|
|
@@ -137,12 +141,18 @@ module Telnyx
|
|
|
137
141
|
|
|
138
142
|
variant -> { Telnyx::NumberOrderStatusUpdateWebhookEvent }
|
|
139
143
|
|
|
144
|
+
variant -> { Telnyx::RecordingAvailableWebhookEvent }
|
|
145
|
+
|
|
140
146
|
variant -> { Telnyx::ReplacedLinkClickWebhookEvent }
|
|
141
147
|
|
|
148
|
+
variant -> { Telnyx::SessionStatusChangedWebhookEvent }
|
|
149
|
+
|
|
150
|
+
variant -> { Telnyx::TranscriptCompletedWebhookEvent }
|
|
151
|
+
|
|
142
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
143
153
|
|
|
144
154
|
# @!method self.variants
|
|
145
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
155
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
146
156
|
end
|
|
147
157
|
end
|
|
148
158
|
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
class ResearchCitation < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute title
|
|
8
|
+
# Title of the source page.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :title, String
|
|
12
|
+
|
|
13
|
+
# @!attribute url
|
|
14
|
+
# Source URL.
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :url, String
|
|
18
|
+
|
|
19
|
+
# @!attribute snippet
|
|
20
|
+
# Relevant excerpt from the source (if available).
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :snippet, String
|
|
24
|
+
|
|
25
|
+
# @!method initialize(title:, url:, snippet: nil)
|
|
26
|
+
# @param title [String] Title of the source page.
|
|
27
|
+
#
|
|
28
|
+
# @param url [String] Source URL.
|
|
29
|
+
#
|
|
30
|
+
# @param snippet [String] Relevant excerpt from the source (if available).
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
# @see Telnyx::Resources::WebSearch::Research#create
|
|
7
|
+
class ResearchCreateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute query
|
|
12
|
+
# The research question or topic.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :query, String
|
|
16
|
+
|
|
17
|
+
# @!attribute background
|
|
18
|
+
# When `true`, the research runs asynchronously. The response returns a `task_id`
|
|
19
|
+
# immediately instead of waiting for the result. Poll
|
|
20
|
+
# `GET /web_search/research/{task_id}` to check status.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean, nil]
|
|
23
|
+
optional :background, Telnyx::Internal::Type::Boolean
|
|
24
|
+
|
|
25
|
+
# @!attribute max_sources
|
|
26
|
+
# Maximum number of sources to use.
|
|
27
|
+
#
|
|
28
|
+
# @return [Integer, nil]
|
|
29
|
+
optional :max_sources, Integer
|
|
30
|
+
|
|
31
|
+
# @!attribute research_effort
|
|
32
|
+
# Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort, nil]
|
|
35
|
+
optional :research_effort, enum: -> { Telnyx::WebSearch::ResearchCreateParams::ResearchEffort }
|
|
36
|
+
|
|
37
|
+
# @!method initialize(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {Telnyx::Models::WebSearch::ResearchCreateParams} for more details.
|
|
40
|
+
#
|
|
41
|
+
# @param query [String] The research question or topic.
|
|
42
|
+
#
|
|
43
|
+
# @param background [Boolean] When `true`, the research runs asynchronously. The response returns a `task_id`
|
|
44
|
+
#
|
|
45
|
+
# @param max_sources [Integer] Maximum number of sources to use.
|
|
46
|
+
#
|
|
47
|
+
# @param research_effort [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort] Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
48
|
+
#
|
|
49
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
+
|
|
51
|
+
# Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
52
|
+
module ResearchEffort
|
|
53
|
+
extend Telnyx::Internal::Type::Enum
|
|
54
|
+
|
|
55
|
+
LITE = :lite
|
|
56
|
+
STANDARD = :standard
|
|
57
|
+
DEEP = :deep
|
|
58
|
+
|
|
59
|
+
# @!method self.values
|
|
60
|
+
# @return [Array<Symbol>]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
# @see Telnyx::Resources::WebSearch::Research#create
|
|
7
|
+
class ResearchCreateResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
# Synchronous research response (when `background` is false or unset).
|
|
10
|
+
#
|
|
11
|
+
# @return [Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync, nil]
|
|
12
|
+
optional :data, union: -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(data: nil)
|
|
15
|
+
# @param data [Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync] Synchronous research response (when `background` is false or unset).
|
|
16
|
+
|
|
17
|
+
# Synchronous research response (when `background` is false or unset).
|
|
18
|
+
#
|
|
19
|
+
# @see Telnyx::Models::WebSearch::ResearchCreateResponse#data
|
|
20
|
+
module Data
|
|
21
|
+
extend Telnyx::Internal::Type::Union
|
|
22
|
+
|
|
23
|
+
# Synchronous research response (when `background` is false or unset).
|
|
24
|
+
variant -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync }
|
|
25
|
+
|
|
26
|
+
# Asynchronous research response (when `background` is true).
|
|
27
|
+
variant -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync }
|
|
28
|
+
|
|
29
|
+
class ResearchResponseSync < Telnyx::Internal::Type::BaseModel
|
|
30
|
+
# @!attribute answer
|
|
31
|
+
# The synthesized research answer.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :answer, String
|
|
35
|
+
|
|
36
|
+
# @!attribute citations
|
|
37
|
+
# Sources cited in the answer.
|
|
38
|
+
#
|
|
39
|
+
# @return [Array<Telnyx::Models::WebSearch::ResearchCitation>, nil]
|
|
40
|
+
optional :citations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearch::ResearchCitation] }
|
|
41
|
+
|
|
42
|
+
# @!method initialize(answer:, citations: nil)
|
|
43
|
+
# Synchronous research response (when `background` is false or unset).
|
|
44
|
+
#
|
|
45
|
+
# @param answer [String] The synthesized research answer.
|
|
46
|
+
#
|
|
47
|
+
# @param citations [Array<Telnyx::Models::WebSearch::ResearchCitation>] Sources cited in the answer.
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
class ResearchResponseAsync < Telnyx::Internal::Type::BaseModel
|
|
51
|
+
# @!attribute status
|
|
52
|
+
# Current status of the research task.
|
|
53
|
+
#
|
|
54
|
+
# @return [Symbol, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status]
|
|
55
|
+
required :status,
|
|
56
|
+
enum: -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status }
|
|
57
|
+
|
|
58
|
+
# @!attribute task_id
|
|
59
|
+
# Unique identifier for the research task. Use this to poll the status.
|
|
60
|
+
#
|
|
61
|
+
# @return [String]
|
|
62
|
+
required :task_id, String
|
|
63
|
+
|
|
64
|
+
# @!method initialize(status:, task_id:)
|
|
65
|
+
# Asynchronous research response (when `background` is true).
|
|
66
|
+
#
|
|
67
|
+
# @param status [Symbol, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status] Current status of the research task.
|
|
68
|
+
#
|
|
69
|
+
# @param task_id [String] Unique identifier for the research task. Use this to poll the status.
|
|
70
|
+
|
|
71
|
+
# Current status of the research task.
|
|
72
|
+
#
|
|
73
|
+
# @see Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync#status
|
|
74
|
+
module Status
|
|
75
|
+
extend Telnyx::Internal::Type::Enum
|
|
76
|
+
|
|
77
|
+
PENDING = :pending
|
|
78
|
+
RUNNING = :running
|
|
79
|
+
COMPLETED = :completed
|
|
80
|
+
FAILED = :failed
|
|
81
|
+
|
|
82
|
+
# @!method self.values
|
|
83
|
+
# @return [Array<Symbol>]
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# @!method self.variants
|
|
88
|
+
# @return [Array(Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync)]
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
# @see Telnyx::Resources::WebSearch::Research#retrieve
|
|
7
|
+
class ResearchRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute task_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :task_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(task_id:, request_options: {})
|
|
17
|
+
# @param task_id [String]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
# @see Telnyx::Resources::WebSearch::Research#retrieve
|
|
7
|
+
class ResearchRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::WebSearch::ResearchRetrieveResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute status
|
|
19
|
+
# Current status of the research task.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status]
|
|
22
|
+
required :status, enum: -> { Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status }
|
|
23
|
+
|
|
24
|
+
# @!attribute task_id
|
|
25
|
+
# The research task identifier.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :task_id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute answer
|
|
31
|
+
# The synthesized research answer (present when status is `completed`).
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :answer, String
|
|
35
|
+
|
|
36
|
+
# @!attribute citations
|
|
37
|
+
# Sources cited in the answer (present when status is `completed`).
|
|
38
|
+
#
|
|
39
|
+
# @return [Array<Telnyx::Models::WebSearch::ResearchCitation>, nil]
|
|
40
|
+
optional :citations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearch::ResearchCitation] }
|
|
41
|
+
|
|
42
|
+
# @!attribute error
|
|
43
|
+
# Always present in poll responses; `null` unless the task failed.
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :error, String, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!method initialize(status:, task_id:, answer: nil, citations: nil, error: nil)
|
|
49
|
+
# @param status [Symbol, Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status] Current status of the research task.
|
|
50
|
+
#
|
|
51
|
+
# @param task_id [String] The research task identifier.
|
|
52
|
+
#
|
|
53
|
+
# @param answer [String] The synthesized research answer (present when status is `completed`).
|
|
54
|
+
#
|
|
55
|
+
# @param citations [Array<Telnyx::Models::WebSearch::ResearchCitation>] Sources cited in the answer (present when status is `completed`).
|
|
56
|
+
#
|
|
57
|
+
# @param error [String, nil] Always present in poll responses; `null` unless the task failed.
|
|
58
|
+
|
|
59
|
+
# Current status of the research task.
|
|
60
|
+
#
|
|
61
|
+
# @see Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data#status
|
|
62
|
+
module Status
|
|
63
|
+
extend Telnyx::Internal::Type::Enum
|
|
64
|
+
|
|
65
|
+
PENDING = :pending
|
|
66
|
+
RUNNING = :running
|
|
67
|
+
COMPLETED = :completed
|
|
68
|
+
FAILED = :failed
|
|
69
|
+
|
|
70
|
+
# @!method self.values
|
|
71
|
+
# @return [Array<Symbol>]
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::WebSearch#contents
|
|
6
|
+
class WebSearchContentsParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute urls
|
|
11
|
+
# List of URLs to retrieve content from (max 20 for public API).
|
|
12
|
+
#
|
|
13
|
+
# @return [Array<String>]
|
|
14
|
+
required :urls, Telnyx::Internal::Type::ArrayOf[String]
|
|
15
|
+
|
|
16
|
+
# @!attribute crawl_timeout
|
|
17
|
+
# Timeout for crawling each URL, in seconds (1-60).
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
optional :crawl_timeout, Integer
|
|
21
|
+
|
|
22
|
+
# @!attribute formats
|
|
23
|
+
# Content formats to return. If omitted, `html` and `metadata` are returned by
|
|
24
|
+
# default. Retrieval is best-effort per URL: a format field appears only when that
|
|
25
|
+
# content could be produced, and a freshly crawled page may also include `html`
|
|
26
|
+
# even when not requested.
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>, nil]
|
|
29
|
+
optional :formats, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::WebSearchContentsParams::Format] }
|
|
30
|
+
|
|
31
|
+
# @!attribute max_age
|
|
32
|
+
# Maximum age of cached content in seconds. `null` means no limit.
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :max_age, Integer, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!method initialize(urls:, crawl_timeout: nil, formats: nil, max_age: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {Telnyx::Models::WebSearchContentsParams} for more details.
|
|
40
|
+
#
|
|
41
|
+
# @param urls [Array<String>] List of URLs to retrieve content from (max 20 for public API).
|
|
42
|
+
#
|
|
43
|
+
# @param crawl_timeout [Integer] Timeout for crawling each URL, in seconds (1-60).
|
|
44
|
+
#
|
|
45
|
+
# @param formats [Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>] Content formats to return. If omitted, `html` and `metadata` are returned by def
|
|
46
|
+
#
|
|
47
|
+
# @param max_age [Integer, nil] Maximum age of cached content in seconds. `null` means no limit.
|
|
48
|
+
#
|
|
49
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
+
|
|
51
|
+
module Format
|
|
52
|
+
extend Telnyx::Internal::Type::Enum
|
|
53
|
+
|
|
54
|
+
HTML = :html
|
|
55
|
+
MARKDOWN = :markdown
|
|
56
|
+
METADATA = :metadata
|
|
57
|
+
|
|
58
|
+
# @!method self.values
|
|
59
|
+
# @return [Array<Symbol>]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::WebSearch#contents
|
|
6
|
+
class WebSearchContentsResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::WebSearchContentsResponse::Data, nil]
|
|
10
|
+
optional :data, -> { Telnyx::Models::WebSearchContentsResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data: nil)
|
|
13
|
+
# @param data [Telnyx::Models::WebSearchContentsResponse::Data]
|
|
14
|
+
|
|
15
|
+
# @see Telnyx::Models::WebSearchContentsResponse#data
|
|
16
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
17
|
+
# @!attribute results
|
|
18
|
+
#
|
|
19
|
+
# @return [Array<Telnyx::Models::WebSearchContentsResponse::Data::Result>, nil]
|
|
20
|
+
optional :results,
|
|
21
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::WebSearchContentsResponse::Data::Result] }
|
|
22
|
+
|
|
23
|
+
# @!method initialize(results: nil)
|
|
24
|
+
# @param results [Array<Telnyx::Models::WebSearchContentsResponse::Data::Result>]
|
|
25
|
+
|
|
26
|
+
class Result < Telnyx::Internal::Type::BaseModel
|
|
27
|
+
# @!attribute url
|
|
28
|
+
# The source URL.
|
|
29
|
+
#
|
|
30
|
+
# @return [String]
|
|
31
|
+
required :url, String
|
|
32
|
+
|
|
33
|
+
# @!attribute html
|
|
34
|
+
# Cleaned HTML content (if `html` format requested; may also be present on freshly
|
|
35
|
+
# crawled pages).
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :html, String
|
|
39
|
+
|
|
40
|
+
# @!attribute markdown
|
|
41
|
+
# Markdown content (if `markdown` format requested).
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :markdown, String
|
|
45
|
+
|
|
46
|
+
# @!attribute metadata
|
|
47
|
+
# Page metadata (if `metadata` format requested).
|
|
48
|
+
#
|
|
49
|
+
# @return [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata, nil]
|
|
50
|
+
optional :metadata, -> { Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata }
|
|
51
|
+
|
|
52
|
+
# @!attribute title
|
|
53
|
+
# Page title (if available).
|
|
54
|
+
#
|
|
55
|
+
# @return [String, nil]
|
|
56
|
+
optional :title, String
|
|
57
|
+
|
|
58
|
+
# @!method initialize(url:, html: nil, markdown: nil, metadata: nil, title: nil)
|
|
59
|
+
# Some parameter documentations has been truncated, see
|
|
60
|
+
# {Telnyx::Models::WebSearchContentsResponse::Data::Result} for more details.
|
|
61
|
+
#
|
|
62
|
+
# @param url [String] The source URL.
|
|
63
|
+
#
|
|
64
|
+
# @param html [String] Cleaned HTML content (if `html` format requested; may also be present on freshly
|
|
65
|
+
#
|
|
66
|
+
# @param markdown [String] Markdown content (if `markdown` format requested).
|
|
67
|
+
#
|
|
68
|
+
# @param metadata [Telnyx::Models::WebSearchContentsResponse::Data::Result::Metadata] Page metadata (if `metadata` format requested).
|
|
69
|
+
#
|
|
70
|
+
# @param title [String] Page title (if available).
|
|
71
|
+
|
|
72
|
+
# @see Telnyx::Models::WebSearchContentsResponse::Data::Result#metadata
|
|
73
|
+
class Metadata < Telnyx::Internal::Type::BaseModel
|
|
74
|
+
# @!attribute favicon_url
|
|
75
|
+
# Favicon URL (if available).
|
|
76
|
+
#
|
|
77
|
+
# @return [String, nil]
|
|
78
|
+
optional :favicon_url, String
|
|
79
|
+
|
|
80
|
+
# @!attribute site_name
|
|
81
|
+
# Site name. Often empty.
|
|
82
|
+
#
|
|
83
|
+
# @return [String, nil]
|
|
84
|
+
optional :site_name, String
|
|
85
|
+
|
|
86
|
+
# @!method initialize(favicon_url: nil, site_name: nil)
|
|
87
|
+
# Page metadata (if `metadata` format requested).
|
|
88
|
+
#
|
|
89
|
+
# @param favicon_url [String] Favicon URL (if available).
|
|
90
|
+
#
|
|
91
|
+
# @param site_name [String] Site name. Often empty.
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|