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.
Files changed (245) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +8 -0
  5. data/lib/telnyx/models/artifact_completed_webhook_event.rb +152 -0
  6. data/lib/telnyx/models/artifact_failed_webhook_event.rb +103 -0
  7. data/lib/telnyx/models/call_dial_params.rb +7 -7
  8. data/lib/telnyx/models/calls/action_answer_params.rb +7 -6
  9. data/lib/telnyx/models/calls/action_transfer_params.rb +7 -6
  10. data/lib/telnyx/models/meeting_session.rb +380 -0
  11. data/lib/telnyx/models/meeting_session_create_params.rb +309 -0
  12. data/lib/telnyx/models/meeting_session_delete_params.rb +20 -0
  13. data/lib/telnyx/models/meeting_session_delete_recording_media_params.rb +20 -0
  14. data/lib/telnyx/models/meeting_session_delete_recording_media_response.rb +61 -0
  15. data/lib/telnyx/models/meeting_session_list_params.rb +39 -0
  16. data/lib/telnyx/models/meeting_session_list_response.rb +16 -0
  17. data/lib/telnyx/models/meeting_session_response.rb +22 -0
  18. data/lib/telnyx/models/meeting_session_retrieve_events_params.rb +37 -0
  19. data/lib/telnyx/models/meeting_session_retrieve_events_response.rb +45 -0
  20. data/lib/telnyx/models/meeting_session_retrieve_params.rb +20 -0
  21. data/lib/telnyx/models/meeting_session_retrieve_recordings_params.rb +20 -0
  22. data/lib/telnyx/models/meeting_session_retrieve_recordings_response.rb +49 -0
  23. data/lib/telnyx/models/meeting_session_retrieve_transcript_params.rb +50 -0
  24. data/lib/telnyx/models/meeting_session_retrieve_transcript_response.rb +80 -0
  25. data/lib/telnyx/models/meeting_session_update_params.rb +37 -0
  26. data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb +29 -0
  27. data/lib/telnyx/models/meeting_sessions/action_send_chat_params.rb +31 -0
  28. data/lib/telnyx/models/meeting_sessions/action_speak_params.rb +52 -0
  29. data/lib/telnyx/models/meeting_sessions/action_stop_speaking_params.rb +22 -0
  30. data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +42 -0
  31. data/lib/telnyx/models/meeting_sessions/artifact_list_params.rb +22 -0
  32. data/lib/telnyx/models/meeting_sessions/artifact_list_response.rb +18 -0
  33. data/lib/telnyx/models/meeting_sessions/artifact_retrieve_params.rb +28 -0
  34. data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +120 -0
  35. data/lib/telnyx/models/meeting_sessions/meeting_session_artifact_response.rb +20 -0
  36. data/lib/telnyx/models/phone_numbers/voicemail_pref_response.rb +64 -1
  37. data/lib/telnyx/models/phone_numbers/voicemail_request.rb +63 -1
  38. data/lib/telnyx/models/private_wireless_gateway_status.rb +2 -2
  39. data/lib/telnyx/models/recording_available_webhook_event.rb +82 -0
  40. data/lib/telnyx/models/session_status_changed_webhook_event.rb +102 -0
  41. data/lib/telnyx/models/sim_cards/action_bulk_enable_voice_params.rb +16 -1
  42. data/lib/telnyx/models/sim_cards/action_disable_voice_params.rb +22 -0
  43. data/lib/telnyx/models/sim_cards/action_disable_voice_response.rb +23 -0
  44. data/lib/telnyx/models/sim_cards/action_enable_voice_params.rb +37 -0
  45. data/lib/telnyx/models/sim_cards/action_enable_voice_response.rb +23 -0
  46. data/lib/telnyx/models/sim_cards/action_list_params.rb +2 -0
  47. data/lib/telnyx/models/sim_cards/wireless_sim_card_action.rb +6 -0
  48. data/lib/telnyx/models/storage/edge_compute_pagination_meta.rb +35 -0
  49. data/lib/telnyx/models/storage/sql_database.rb +75 -0
  50. data/lib/telnyx/models/storage/sql_database_response_wrapper.rb +18 -0
  51. data/lib/telnyx/models/storage/sqldb_create_params.rb +28 -0
  52. data/lib/telnyx/models/storage/sqldb_delete_params.rb +35 -0
  53. data/lib/telnyx/models/storage/sqldb_list_params.rb +85 -0
  54. data/lib/telnyx/models/storage/sqldb_retrieve_params.rb +22 -0
  55. data/lib/telnyx/models/storage/sqldbs/action_query_params.rb +66 -0
  56. data/lib/telnyx/models/storage/sqldbs/action_query_response.rb +109 -0
  57. data/lib/telnyx/models/transcript_completed_webhook_event.rb +98 -0
  58. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +11 -1
  59. data/lib/telnyx/models/unwrap_webhook_event.rb +11 -1
  60. data/lib/telnyx/models/web_search/research_citation.rb +34 -0
  61. data/lib/telnyx/models/web_search/research_create_params.rb +65 -0
  62. data/lib/telnyx/models/web_search/research_create_response.rb +93 -0
  63. data/lib/telnyx/models/web_search/research_retrieve_params.rb +22 -0
  64. data/lib/telnyx/models/web_search/research_retrieve_response.rb +77 -0
  65. data/lib/telnyx/models/web_search_contents_params.rb +63 -0
  66. data/lib/telnyx/models/web_search_contents_response.rb +97 -0
  67. data/lib/telnyx/models/web_search_create_params.rb +95 -0
  68. data/lib/telnyx/models/web_search_create_response.rb +47 -0
  69. data/lib/telnyx/models/web_search_result.rb +56 -0
  70. data/lib/telnyx/models.rb +42 -0
  71. data/lib/telnyx/resources/calls/actions.rb +2 -2
  72. data/lib/telnyx/resources/calls.rb +1 -1
  73. data/lib/telnyx/resources/meeting_sessions/actions.rb +92 -0
  74. data/lib/telnyx/resources/meeting_sessions/artifacts.rb +92 -0
  75. data/lib/telnyx/resources/meeting_sessions.rb +290 -0
  76. data/lib/telnyx/resources/phone_numbers/voicemail.rb +20 -4
  77. data/lib/telnyx/resources/sim_cards/actions.rb +66 -1
  78. data/lib/telnyx/resources/storage/sqldbs/actions.rb +50 -0
  79. data/lib/telnyx/resources/storage/sqldbs.rb +140 -0
  80. data/lib/telnyx/resources/storage.rb +5 -0
  81. data/lib/telnyx/resources/web_search/research.rb +86 -0
  82. data/lib/telnyx/resources/web_search.rb +96 -0
  83. data/lib/telnyx/resources/webhooks.rb +2 -2
  84. data/lib/telnyx/version.rb +1 -1
  85. data/lib/telnyx.rb +61 -0
  86. data/rbi/telnyx/client.rbi +6 -0
  87. data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +283 -0
  88. data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +185 -0
  89. data/rbi/telnyx/models/call_dial_params.rbi +12 -12
  90. data/rbi/telnyx/models/calls/action_answer_params.rbi +12 -10
  91. data/rbi/telnyx/models/calls/action_transfer_params.rbi +12 -10
  92. data/rbi/telnyx/models/meeting_session.rbi +544 -0
  93. data/rbi/telnyx/models/meeting_session_create_params.rbi +526 -0
  94. data/rbi/telnyx/models/meeting_session_delete_params.rbi +35 -0
  95. data/rbi/telnyx/models/meeting_session_delete_recording_media_params.rbi +38 -0
  96. data/rbi/telnyx/models/meeting_session_delete_recording_media_response.rbi +143 -0
  97. data/rbi/telnyx/models/meeting_session_list_params.rbi +101 -0
  98. data/rbi/telnyx/models/meeting_session_list_response.rbi +30 -0
  99. data/rbi/telnyx/models/meeting_session_response.rbi +36 -0
  100. data/rbi/telnyx/models/meeting_session_retrieve_events_params.rbi +66 -0
  101. data/rbi/telnyx/models/meeting_session_retrieve_events_response.rbi +92 -0
  102. data/rbi/telnyx/models/meeting_session_retrieve_params.rbi +35 -0
  103. data/rbi/telnyx/models/meeting_session_retrieve_recordings_params.rbi +38 -0
  104. data/rbi/telnyx/models/meeting_session_retrieve_recordings_response.rbi +97 -0
  105. data/rbi/telnyx/models/meeting_session_retrieve_transcript_params.rbi +81 -0
  106. data/rbi/telnyx/models/meeting_session_retrieve_transcript_response.rbi +154 -0
  107. data/rbi/telnyx/models/meeting_session_update_params.rbi +63 -0
  108. data/rbi/telnyx/models/meeting_sessions/action_accepted_response.rbi +64 -0
  109. data/rbi/telnyx/models/meeting_sessions/action_send_chat_params.rbi +54 -0
  110. data/rbi/telnyx/models/meeting_sessions/action_speak_params.rbi +80 -0
  111. data/rbi/telnyx/models/meeting_sessions/action_stop_speaking_params.rbi +40 -0
  112. data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +89 -0
  113. data/rbi/telnyx/models/meeting_sessions/artifact_list_params.rbi +40 -0
  114. data/rbi/telnyx/models/meeting_sessions/artifact_list_response.rbi +39 -0
  115. data/rbi/telnyx/models/meeting_sessions/artifact_retrieve_params.rbi +48 -0
  116. data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +264 -0
  117. data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbi +46 -0
  118. data/rbi/telnyx/models/phone_numbers/voicemail_pref_response.rbi +149 -2
  119. data/rbi/telnyx/models/phone_numbers/voicemail_request.rbi +145 -2
  120. data/rbi/telnyx/models/private_wireless_gateway_status.rbi +2 -2
  121. data/rbi/telnyx/models/recording_available_webhook_event.rbi +146 -0
  122. data/rbi/telnyx/models/session_status_changed_webhook_event.rbi +171 -0
  123. data/rbi/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbi +21 -1
  124. data/rbi/telnyx/models/sim_cards/action_disable_voice_params.rbi +40 -0
  125. data/rbi/telnyx/models/sim_cards/action_disable_voice_response.rbi +45 -0
  126. data/rbi/telnyx/models/sim_cards/action_enable_voice_params.rbi +63 -0
  127. data/rbi/telnyx/models/sim_cards/action_enable_voice_response.rbi +45 -0
  128. data/rbi/telnyx/models/sim_cards/action_list_params.rbi +10 -0
  129. data/rbi/telnyx/models/sim_cards/wireless_sim_card_action.rbi +16 -0
  130. data/rbi/telnyx/models/storage/edge_compute_pagination_meta.rbi +70 -0
  131. data/rbi/telnyx/models/storage/sql_database.rbi +131 -0
  132. data/rbi/telnyx/models/storage/sql_database_response_wrapper.rbi +35 -0
  133. data/rbi/telnyx/models/storage/sqldb_create_params.rbi +44 -0
  134. data/rbi/telnyx/models/storage/sqldb_delete_params.rbi +56 -0
  135. data/rbi/telnyx/models/storage/sqldb_list_params.rbi +198 -0
  136. data/rbi/telnyx/models/storage/sqldb_retrieve_params.rbi +40 -0
  137. data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi +125 -0
  138. data/rbi/telnyx/models/storage/sqldbs/action_query_response.rbi +226 -0
  139. data/rbi/telnyx/models/transcript_completed_webhook_event.rbi +166 -0
  140. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +5 -0
  141. data/rbi/telnyx/models/unwrap_webhook_event.rbi +5 -0
  142. data/rbi/telnyx/models/web_search/research_citation.rbi +53 -0
  143. data/rbi/telnyx/models/web_search/research_create_params.rbi +138 -0
  144. data/rbi/telnyx/models/web_search/research_create_response.rbi +235 -0
  145. data/rbi/telnyx/models/web_search/research_retrieve_params.rbi +40 -0
  146. data/rbi/telnyx/models/web_search/research_retrieve_response.rbi +179 -0
  147. data/rbi/telnyx/models/web_search_contents_params.rbi +119 -0
  148. data/rbi/telnyx/models/web_search_contents_response.rbi +232 -0
  149. data/rbi/telnyx/models/web_search_create_params.rbi +162 -0
  150. data/rbi/telnyx/models/web_search_create_response.rbi +127 -0
  151. data/rbi/telnyx/models/web_search_result.rbi +83 -0
  152. data/rbi/telnyx/models.rbi +49 -0
  153. data/rbi/telnyx/resources/calls/actions.rbi +10 -8
  154. data/rbi/telnyx/resources/calls.rbi +5 -5
  155. data/rbi/telnyx/resources/meeting_sessions/actions.rbi +71 -0
  156. data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +67 -0
  157. data/rbi/telnyx/resources/meeting_sessions.rbi +256 -0
  158. data/rbi/telnyx/resources/phone_numbers/voicemail.rbi +22 -2
  159. data/rbi/telnyx/resources/sim_cards/actions.rbi +56 -1
  160. data/rbi/telnyx/resources/storage/sqldbs/actions.rbi +50 -0
  161. data/rbi/telnyx/resources/storage/sqldbs.rbi +105 -0
  162. data/rbi/telnyx/resources/storage.rbi +4 -0
  163. data/rbi/telnyx/resources/web_search/research.rbi +71 -0
  164. data/rbi/telnyx/resources/web_search.rbi +86 -0
  165. data/rbi/telnyx/resources/webhooks.rbi +10 -0
  166. data/sig/telnyx/client.rbs +4 -0
  167. data/sig/telnyx/models/artifact_completed_webhook_event.rbs +120 -0
  168. data/sig/telnyx/models/artifact_failed_webhook_event.rbs +88 -0
  169. data/sig/telnyx/models/call_dial_params.rbs +7 -5
  170. data/sig/telnyx/models/calls/action_answer_params.rbs +7 -5
  171. data/sig/telnyx/models/calls/action_transfer_params.rbs +7 -5
  172. data/sig/telnyx/models/meeting_session.rbs +277 -0
  173. data/sig/telnyx/models/meeting_session_create_params.rbs +222 -0
  174. data/sig/telnyx/models/meeting_session_delete_params.rbs +20 -0
  175. data/sig/telnyx/models/meeting_session_delete_recording_media_params.rbs +20 -0
  176. data/sig/telnyx/models/meeting_session_delete_recording_media_response.rbs +61 -0
  177. data/sig/telnyx/models/meeting_session_list_params.rbs +53 -0
  178. data/sig/telnyx/models/meeting_session_list_response.rbs +14 -0
  179. data/sig/telnyx/models/meeting_session_response.rbs +13 -0
  180. data/sig/telnyx/models/meeting_session_retrieve_events_params.rbs +36 -0
  181. data/sig/telnyx/models/meeting_session_retrieve_events_response.rbs +52 -0
  182. data/sig/telnyx/models/meeting_session_retrieve_params.rbs +20 -0
  183. data/sig/telnyx/models/meeting_session_retrieve_recordings_params.rbs +20 -0
  184. data/sig/telnyx/models/meeting_session_retrieve_recordings_response.rbs +34 -0
  185. data/sig/telnyx/models/meeting_session_retrieve_transcript_params.rbs +42 -0
  186. data/sig/telnyx/models/meeting_session_retrieve_transcript_response.rbs +77 -0
  187. data/sig/telnyx/models/meeting_session_update_params.rbs +36 -0
  188. data/sig/telnyx/models/meeting_sessions/action_accepted_response.rbs +30 -0
  189. data/sig/telnyx/models/meeting_sessions/action_send_chat_params.rbs +30 -0
  190. data/sig/telnyx/models/meeting_sessions/action_speak_params.rbs +42 -0
  191. data/sig/telnyx/models/meeting_sessions/action_stop_speaking_params.rbs +22 -0
  192. data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +44 -0
  193. data/sig/telnyx/models/meeting_sessions/artifact_list_params.rbs +22 -0
  194. data/sig/telnyx/models/meeting_sessions/artifact_list_response.rbs +20 -0
  195. data/sig/telnyx/models/meeting_sessions/artifact_retrieve_params.rbs +30 -0
  196. data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +109 -0
  197. data/sig/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbs +22 -0
  198. data/sig/telnyx/models/phone_numbers/voicemail_pref_response.rbs +59 -3
  199. data/sig/telnyx/models/phone_numbers/voicemail_request.rbs +59 -3
  200. data/sig/telnyx/models/recording_available_webhook_event.rbs +65 -0
  201. data/sig/telnyx/models/session_status_changed_webhook_event.rbs +82 -0
  202. data/sig/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbs +7 -1
  203. data/sig/telnyx/models/sim_cards/action_disable_voice_params.rbs +22 -0
  204. data/sig/telnyx/models/sim_cards/action_disable_voice_response.rbs +20 -0
  205. data/sig/telnyx/models/sim_cards/action_enable_voice_params.rbs +32 -0
  206. data/sig/telnyx/models/sim_cards/action_enable_voice_response.rbs +20 -0
  207. data/sig/telnyx/models/sim_cards/action_list_params.rbs +4 -0
  208. data/sig/telnyx/models/sim_cards/wireless_sim_card_action.rbs +8 -1
  209. data/sig/telnyx/models/storage/edge_compute_pagination_meta.rbs +45 -0
  210. data/sig/telnyx/models/storage/sql_database.rbs +80 -0
  211. data/sig/telnyx/models/storage/sql_database_response_wrapper.rbs +20 -0
  212. data/sig/telnyx/models/storage/sqldb_create_params.rbs +25 -0
  213. data/sig/telnyx/models/storage/sqldb_delete_params.rbs +31 -0
  214. data/sig/telnyx/models/storage/sqldb_list_params.rbs +97 -0
  215. data/sig/telnyx/models/storage/sqldb_retrieve_params.rbs +22 -0
  216. data/sig/telnyx/models/storage/sqldbs/action_query_params.rbs +52 -0
  217. data/sig/telnyx/models/storage/sqldbs/action_query_response.rbs +124 -0
  218. data/sig/telnyx/models/transcript_completed_webhook_event.rbs +82 -0
  219. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +5 -0
  220. data/sig/telnyx/models/unwrap_webhook_event.rbs +5 -0
  221. data/sig/telnyx/models/web_search/research_citation.rbs +21 -0
  222. data/sig/telnyx/models/web_search/research_create_params.rbs +63 -0
  223. data/sig/telnyx/models/web_search/research_create_response.rbs +95 -0
  224. data/sig/telnyx/models/web_search/research_retrieve_params.rbs +25 -0
  225. data/sig/telnyx/models/web_search/research_retrieve_response.rbs +80 -0
  226. data/sig/telnyx/models/web_search_contents_params.rbs +59 -0
  227. data/sig/telnyx/models/web_search_contents_response.rbs +104 -0
  228. data/sig/telnyx/models/web_search_create_params.rbs +89 -0
  229. data/sig/telnyx/models/web_search_create_response.rbs +65 -0
  230. data/sig/telnyx/models/web_search_result.rbs +49 -0
  231. data/sig/telnyx/models.rbs +42 -0
  232. data/sig/telnyx/resources/calls/actions.rbs +2 -2
  233. data/sig/telnyx/resources/calls.rbs +1 -1
  234. data/sig/telnyx/resources/meeting_sessions/actions.rbs +28 -0
  235. data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +26 -0
  236. data/sig/telnyx/resources/meeting_sessions.rbs +75 -0
  237. data/sig/telnyx/resources/phone_numbers/voicemail.rbs +2 -0
  238. data/sig/telnyx/resources/sim_cards/actions.rbs +12 -0
  239. data/sig/telnyx/resources/storage/sqldbs/actions.rbs +18 -0
  240. data/sig/telnyx/resources/storage/sqldbs.rbs +36 -0
  241. data/sig/telnyx/resources/storage.rbs +2 -0
  242. data/sig/telnyx/resources/web_search/research.rbs +22 -0
  243. data/sig/telnyx/resources/web_search.rbs +29 -0
  244. data/sig/telnyx/resources/webhooks.rbs +10 -0
  245. metadata +185 -2
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ # @see Telnyx::Resources::MeetingSessions::Artifacts#create
7
+ class ArtifactCreateParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute type
17
+ # Type of artifact to generate from the session.
18
+ #
19
+ # @return [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Type]
20
+ required :type, enum: -> { Telnyx::MeetingSessions::ArtifactCreateParams::Type }
21
+
22
+ # @!method initialize(id:, type:, request_options: {})
23
+ # @param id [String]
24
+ #
25
+ # @param type [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Type] Type of artifact to generate from the session.
26
+ #
27
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
28
+
29
+ # Type of artifact to generate from the session.
30
+ module Type
31
+ extend Telnyx::Internal::Type::Enum
32
+
33
+ SUMMARY = :summary
34
+ ACTION_ITEMS = :action_items
35
+
36
+ # @!method self.values
37
+ # @return [Array<Symbol>]
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ # @see Telnyx::Resources::MeetingSessions::Artifacts#list
7
+ class ArtifactListParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!method initialize(id:, request_options: {})
17
+ # @param id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ # @see Telnyx::Resources::MeetingSessions::Artifacts#list
7
+ class ArtifactListResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Array<Telnyx::Models::MeetingSessions::MeetingSessionArtifact>]
11
+ required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MeetingSessions::MeetingSessionArtifact] }
12
+
13
+ # @!method initialize(data:)
14
+ # @param data [Array<Telnyx::Models::MeetingSessions::MeetingSessionArtifact>]
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ # @see Telnyx::Resources::MeetingSessions::Artifacts#retrieve
7
+ class ArtifactRetrieveParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute artifact_id
17
+ #
18
+ # @return [String]
19
+ required :artifact_id, String
20
+
21
+ # @!method initialize(id:, artifact_id:, request_options: {})
22
+ # @param id [String]
23
+ # @param artifact_id [String]
24
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,120 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ class MeetingSessionArtifact < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute content
13
+ #
14
+ # @return [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Content, nil]
15
+ required :content, -> { Telnyx::MeetingSessions::MeetingSessionArtifact::Content }, nil?: true
16
+
17
+ # @!attribute created_at
18
+ #
19
+ # @return [Time]
20
+ required :created_at, Time
21
+
22
+ # @!attribute failure_reason
23
+ #
24
+ # @return [String, nil]
25
+ required :failure_reason, String, nil?: true
26
+
27
+ # @!attribute model_provenance
28
+ #
29
+ # @return [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::ModelProvenance, nil]
30
+ required :model_provenance,
31
+ -> { Telnyx::MeetingSessions::MeetingSessionArtifact::ModelProvenance },
32
+ nil?: true
33
+
34
+ # @!attribute session_id
35
+ #
36
+ # @return [String]
37
+ required :session_id, String
38
+
39
+ # @!attribute status
40
+ #
41
+ # @return [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Status]
42
+ required :status, enum: -> { Telnyx::MeetingSessions::MeetingSessionArtifact::Status }
43
+
44
+ # @!attribute type
45
+ #
46
+ # @return [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Type]
47
+ required :type, enum: -> { Telnyx::MeetingSessions::MeetingSessionArtifact::Type }
48
+
49
+ # @!attribute updated_at
50
+ #
51
+ # @return [Time]
52
+ required :updated_at, Time
53
+
54
+ # @!method initialize(id:, content:, created_at:, failure_reason:, model_provenance:, session_id:, status:, type:, updated_at:)
55
+ # @param id [String]
56
+ # @param content [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Content, nil]
57
+ # @param created_at [Time]
58
+ # @param failure_reason [String, nil]
59
+ # @param model_provenance [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::ModelProvenance, nil]
60
+ # @param session_id [String]
61
+ # @param status [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Status]
62
+ # @param type [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Type]
63
+ # @param updated_at [Time]
64
+
65
+ # @see Telnyx::Models::MeetingSessions::MeetingSessionArtifact#content
66
+ class Content < Telnyx::Internal::Type::BaseModel
67
+ # @!attribute text
68
+ #
69
+ # @return [String]
70
+ required :text, String
71
+
72
+ # @!method initialize(text:)
73
+ # @param text [String]
74
+ end
75
+
76
+ # @see Telnyx::Models::MeetingSessions::MeetingSessionArtifact#model_provenance
77
+ class ModelProvenance < Telnyx::Internal::Type::BaseModel
78
+ # @!attribute model
79
+ #
80
+ # @return [String]
81
+ required :model, String
82
+
83
+ # @!attribute provider
84
+ #
85
+ # @return [String]
86
+ required :provider, String
87
+
88
+ # @!method initialize(model:, provider:)
89
+ # @param model [String]
90
+ # @param provider [String]
91
+ end
92
+
93
+ # @see Telnyx::Models::MeetingSessions::MeetingSessionArtifact#status
94
+ module Status
95
+ extend Telnyx::Internal::Type::Enum
96
+
97
+ PENDING = :pending
98
+ COMPLETED = :completed
99
+ FAILED = :failed
100
+
101
+ # @!method self.values
102
+ # @return [Array<Symbol>]
103
+ end
104
+
105
+ # @see Telnyx::Models::MeetingSessions::MeetingSessionArtifact#type
106
+ module Type
107
+ extend Telnyx::Internal::Type::Enum
108
+
109
+ SUMMARY = :summary
110
+ ACTION_ITEMS = :action_items
111
+
112
+ # @!method self.values
113
+ # @return [Array<Symbol>]
114
+ end
115
+ end
116
+ end
117
+
118
+ MeetingSessionArtifact = MeetingSessions::MeetingSessionArtifact
119
+ end
120
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module MeetingSessions
6
+ # @see Telnyx::Resources::MeetingSessions::Artifacts#create
7
+ class MeetingSessionArtifactResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Telnyx::Models::MeetingSessions::MeetingSessionArtifact]
11
+ required :data, -> { Telnyx::MeetingSessions::MeetingSessionArtifact }
12
+
13
+ # @!method initialize(data:)
14
+ # @param data [Telnyx::Models::MeetingSessions::MeetingSessionArtifact]
15
+ end
16
+ end
17
+
18
+ MeetingSessionArtifactResponse = MeetingSessions::MeetingSessionArtifactResponse
19
+ end
20
+ end
@@ -10,16 +10,79 @@ module Telnyx
10
10
  # @return [Boolean, nil]
11
11
  optional :enabled, Telnyx::Internal::Type::Boolean
12
12
 
13
+ # @!attribute greeting
14
+ # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
15
+ # `default` to play the standard system greeting, or to `custom_greeting` to play
16
+ # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
17
+ # must reference an audio file already uploaded to your account through the Media
18
+ # Storage API.
19
+ #
20
+ # @return [Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting, nil]
21
+ optional :greeting, -> { Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting }
22
+
13
23
  # @!attribute pin
14
24
  # The pin used for the voicemail.
15
25
  #
16
26
  # @return [String, nil]
17
27
  optional :pin, String
18
28
 
19
- # @!method initialize(enabled: nil, pin: nil)
29
+ # @!method initialize(enabled: nil, greeting: nil, pin: nil)
30
+ # Some parameter documentations has been truncated, see
31
+ # {Telnyx::Models::PhoneNumbers::VoicemailPrefResponse} for more details.
32
+ #
20
33
  # @param enabled [Boolean] Whether voicemail is enabled.
21
34
  #
35
+ # @param greeting [Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting] Controls the greeting a caller hears before leaving a voicemail. Set `mode` to `
36
+ #
22
37
  # @param pin [String] The pin used for the voicemail.
38
+
39
+ # @see Telnyx::Models::PhoneNumbers::VoicemailPrefResponse#greeting
40
+ class Greeting < Telnyx::Internal::Type::BaseModel
41
+ # @!attribute media_name
42
+ # The name of the media file to play as the greeting. Required when `mode` is
43
+ # `custom_greeting`; ignored when `mode` is `default`. The value must match the
44
+ # `media_name` of a file you previously uploaded with the Media Storage API
45
+ # (`POST /v2/media`).
46
+ #
47
+ # @return [String, nil]
48
+ optional :media_name, String, nil?: true
49
+
50
+ # @!attribute mode
51
+ # The greeting mode. `default` plays the standard system greeting.
52
+ # `custom_greeting` plays the audio referenced by `media_name`.
53
+ #
54
+ # @return [Symbol, Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode, nil]
55
+ optional :mode, enum: -> { Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode }
56
+
57
+ # @!method initialize(media_name: nil, mode: nil)
58
+ # Some parameter documentations has been truncated, see
59
+ # {Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting} for more
60
+ # details.
61
+ #
62
+ # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
63
+ # `default` to play the standard system greeting, or to `custom_greeting` to play
64
+ # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
65
+ # must reference an audio file already uploaded to your account through the Media
66
+ # Storage API.
67
+ #
68
+ # @param media_name [String, nil] The name of the media file to play as the greeting. Required when `mode` is `cus
69
+ #
70
+ # @param mode [Symbol, Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode] The greeting mode. `default` plays the standard system greeting. `custom_greetin
71
+
72
+ # The greeting mode. `default` plays the standard system greeting.
73
+ # `custom_greeting` plays the audio referenced by `media_name`.
74
+ #
75
+ # @see Telnyx::Models::PhoneNumbers::VoicemailPrefResponse::Greeting#mode
76
+ module Mode
77
+ extend Telnyx::Internal::Type::Enum
78
+
79
+ DEFAULT = :default
80
+ CUSTOM_GREETING = :custom_greeting
81
+
82
+ # @!method self.values
83
+ # @return [Array<Symbol>]
84
+ end
85
+ end
23
86
  end
24
87
  end
25
88
  end
@@ -10,16 +10,78 @@ module Telnyx
10
10
  # @return [Boolean, nil]
11
11
  optional :enabled, Telnyx::Internal::Type::Boolean
12
12
 
13
+ # @!attribute greeting
14
+ # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
15
+ # `default` to play the standard system greeting, or to `custom_greeting` to play
16
+ # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
17
+ # must reference an audio file already uploaded to your account through the Media
18
+ # Storage API.
19
+ #
20
+ # @return [Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting, nil]
21
+ optional :greeting, -> { Telnyx::PhoneNumbers::VoicemailRequest::Greeting }
22
+
13
23
  # @!attribute pin
14
24
  # The pin used for voicemail
15
25
  #
16
26
  # @return [String, nil]
17
27
  optional :pin, String
18
28
 
19
- # @!method initialize(enabled: nil, pin: nil)
29
+ # @!method initialize(enabled: nil, greeting: nil, pin: nil)
30
+ # Some parameter documentations has been truncated, see
31
+ # {Telnyx::Models::PhoneNumbers::VoicemailRequest} for more details.
32
+ #
20
33
  # @param enabled [Boolean] Whether voicemail is enabled.
21
34
  #
35
+ # @param greeting [Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting] Controls the greeting a caller hears before leaving a voicemail. Set `mode` to `
36
+ #
22
37
  # @param pin [String] The pin used for voicemail
38
+
39
+ # @see Telnyx::Models::PhoneNumbers::VoicemailRequest#greeting
40
+ class Greeting < Telnyx::Internal::Type::BaseModel
41
+ # @!attribute media_name
42
+ # The name of the media file to play as the greeting. Required when `mode` is
43
+ # `custom_greeting`; ignored when `mode` is `default`. The value must match the
44
+ # `media_name` of a file you previously uploaded with the Media Storage API
45
+ # (`POST /v2/media`).
46
+ #
47
+ # @return [String, nil]
48
+ optional :media_name, String, nil?: true
49
+
50
+ # @!attribute mode
51
+ # The greeting mode. `default` plays the standard system greeting.
52
+ # `custom_greeting` plays the audio referenced by `media_name`.
53
+ #
54
+ # @return [Symbol, Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting::Mode, nil]
55
+ optional :mode, enum: -> { Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode }
56
+
57
+ # @!method initialize(media_name: nil, mode: nil)
58
+ # Some parameter documentations has been truncated, see
59
+ # {Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting} for more details.
60
+ #
61
+ # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
62
+ # `default` to play the standard system greeting, or to `custom_greeting` to play
63
+ # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
64
+ # must reference an audio file already uploaded to your account through the Media
65
+ # Storage API.
66
+ #
67
+ # @param media_name [String, nil] The name of the media file to play as the greeting. Required when `mode` is `cus
68
+ #
69
+ # @param mode [Symbol, Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting::Mode] The greeting mode. `default` plays the standard system greeting. `custom_greetin
70
+
71
+ # The greeting mode. `default` plays the standard system greeting.
72
+ # `custom_greeting` plays the audio referenced by `media_name`.
73
+ #
74
+ # @see Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting#mode
75
+ module Mode
76
+ extend Telnyx::Internal::Type::Enum
77
+
78
+ DEFAULT = :default
79
+ CUSTOM_GREETING = :custom_greeting
80
+
81
+ # @!method self.values
82
+ # @return [Array<Symbol>]
83
+ end
84
+ end
23
85
  end
24
86
  end
25
87
  end
@@ -6,7 +6,7 @@ module Telnyx
6
6
  response_only do
7
7
  # @!attribute error_code
8
8
  # This attribute is an
9
- # [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
9
+ # [error code](https://developers.telnyx.com/docs/development/api-fundamentals/api-errors)
10
10
  # related to the failure reason.
11
11
  #
12
12
  # @return [String, nil]
@@ -38,7 +38,7 @@ module Telnyx
38
38
  #
39
39
  # The current status or failure details of the Private Wireless Gateway.
40
40
  #
41
- # @param error_code [String, nil] This attribute is an [error code](https://developers.telnyx.com/development/api-
41
+ # @param error_code [String, nil] This attribute is an [error code](https://developers.telnyx.com/docs/development
42
42
  #
43
43
  # @param error_description [String, nil] This attribute provides a human-readable explanation of why a failure happened.
44
44
  #
@@ -0,0 +1,82 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class RecordingAvailableWebhookEvent < 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
+ # Available recording types.
14
+ #
15
+ # @return [Telnyx::Models::RecordingAvailableWebhookEvent::Data]
16
+ required :data, -> { Telnyx::RecordingAvailableWebhookEvent::Data }
17
+
18
+ # @!attribute event
19
+ # Event type.
20
+ #
21
+ # @return [Symbol, Telnyx::Models::RecordingAvailableWebhookEvent::Event]
22
+ required :event, enum: -> { Telnyx::RecordingAvailableWebhookEvent::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::RecordingAvailableWebhookEvent::Data] Available recording types.
40
+ #
41
+ # @param event [Symbol, Telnyx::Models::RecordingAvailableWebhookEvent::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::RecordingAvailableWebhookEvent#data
48
+ class Data < Telnyx::Internal::Type::BaseModel
49
+ # @!attribute recording_types
50
+ # Available recording types.
51
+ #
52
+ # @return [Array<String>]
53
+ required :recording_types, Telnyx::Internal::Type::ArrayOf[String]
54
+
55
+ # @!attribute session_id
56
+ # The meeting session this event belongs to.
57
+ #
58
+ # @return [String]
59
+ required :session_id, String
60
+
61
+ # @!method initialize(recording_types:, session_id:)
62
+ # Available recording types.
63
+ #
64
+ # @param recording_types [Array<String>] Available recording types.
65
+ #
66
+ # @param session_id [String] The meeting session this event belongs to.
67
+ end
68
+
69
+ # Event type.
70
+ #
71
+ # @see Telnyx::Models::RecordingAvailableWebhookEvent#event
72
+ module Event
73
+ extend Telnyx::Internal::Type::Enum
74
+
75
+ RECORDING_AVAILABLE = :"recording.available"
76
+
77
+ # @!method self.values
78
+ # @return [Array<Symbol>]
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class SessionStatusChangedWebhookEvent < 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
+ # Status transition details.
14
+ #
15
+ # @return [Telnyx::Models::SessionStatusChangedWebhookEvent::Data]
16
+ required :data, -> { Telnyx::SessionStatusChangedWebhookEvent::Data }
17
+
18
+ # @!attribute event
19
+ # Event type.
20
+ #
21
+ # @return [Symbol, Telnyx::Models::SessionStatusChangedWebhookEvent::Event]
22
+ required :event, enum: -> { Telnyx::SessionStatusChangedWebhookEvent::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::SessionStatusChangedWebhookEvent::Data] Status transition details.
40
+ #
41
+ # @param event [Symbol, Telnyx::Models::SessionStatusChangedWebhookEvent::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::SessionStatusChangedWebhookEvent#data
48
+ class Data < Telnyx::Internal::Type::BaseModel
49
+ # @!attribute recording
50
+ # Whether the session is recording at this lifecycle edge.
51
+ #
52
+ # @return [Boolean]
53
+ required :recording, Telnyx::Internal::Type::Boolean
54
+
55
+ # @!attribute session_id
56
+ # The meeting session this event belongs to.
57
+ #
58
+ # @return [String]
59
+ required :session_id, String
60
+
61
+ # @!attribute status
62
+ # The new session status.
63
+ #
64
+ # @return [String]
65
+ required :status, String
66
+
67
+ # @!attribute status_detail
68
+ # Additional detail about the status (for example `timeout_exceeded_everyone_left`
69
+ # or `cancelled`), or null.
70
+ #
71
+ # @return [String, nil]
72
+ required :status_detail, String, nil?: true
73
+
74
+ # @!method initialize(recording:, session_id:, status:, status_detail:)
75
+ # Some parameter documentations has been truncated, see
76
+ # {Telnyx::Models::SessionStatusChangedWebhookEvent::Data} for more details.
77
+ #
78
+ # Status transition details.
79
+ #
80
+ # @param recording [Boolean] Whether the session is recording at this lifecycle edge.
81
+ #
82
+ # @param session_id [String] The meeting session this event belongs to.
83
+ #
84
+ # @param status [String] The new session status.
85
+ #
86
+ # @param status_detail [String, nil] Additional detail about the status (for example `timeout_exceeded_everyone_left`
87
+ end
88
+
89
+ # Event type.
90
+ #
91
+ # @see Telnyx::Models::SessionStatusChangedWebhookEvent#event
92
+ module Event
93
+ extend Telnyx::Internal::Type::Enum
94
+
95
+ SESSION_STATUS_CHANGED = :"session.status_changed"
96
+
97
+ # @!method self.values
98
+ # @return [Array<Symbol>]
99
+ end
100
+ end
101
+ end
102
+ end
@@ -13,8 +13,23 @@ module Telnyx
13
13
  # @return [String]
14
14
  required :sim_card_group_id, String
15
15
 
16
- # @!method initialize(sim_card_group_id:, request_options: {})
16
+ # @!attribute connection_id
17
+ # The identifier of the Mobile Voice Connection to associate with the SIM cards.
18
+ # The connection must be owned by the same user and of type
19
+ # <code>mobile_voice</code>. If omitted, voice is enabled without a connection
20
+ # association.
21
+ #
22
+ # @return [String, nil]
23
+ optional :connection_id, String
24
+
25
+ # @!method initialize(sim_card_group_id:, connection_id: nil, request_options: {})
26
+ # Some parameter documentations has been truncated, see
27
+ # {Telnyx::Models::SimCards::ActionBulkEnableVoiceParams} for more details.
28
+ #
17
29
  # @param sim_card_group_id [String]
30
+ #
31
+ # @param connection_id [String] The identifier of the Mobile Voice Connection to associate with the SIM cards. T
32
+ #
18
33
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
34
  end
20
35
  end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module SimCards
6
+ # @see Telnyx::Resources::SimCards::Actions#disable_voice
7
+ class ActionDisableVoiceParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!method initialize(id:, request_options: {})
17
+ # @param id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end