telnyx 4.3.0 → 4.4.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 (182) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +7 -0
  5. data/lib/telnyx/internal/transport/pooled_net_requester.rb +30 -24
  6. data/lib/telnyx/internal/type/union.rb +6 -6
  7. data/lib/telnyx/models/access_ip_address_list_response.rb +3 -32
  8. data/lib/telnyx/models/access_ip_range_list_response.rb +3 -32
  9. data/lib/telnyx/models/advanced_order.rb +93 -0
  10. data/lib/telnyx/models/advanced_order_create_params.rb +2 -87
  11. data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +2 -88
  12. data/lib/telnyx/models/ai/assistants_list.rb +3 -162
  13. data/lib/telnyx/models/ai/{assistant_create_response.rb → inference_embedding.rb} +2 -2
  14. data/lib/telnyx/models/call_dial_params.rb +3 -18
  15. data/lib/telnyx/models/calls/action_start_streaming_params.rb +3 -18
  16. data/lib/telnyx/models/calls/telnyx_transcription_language.rb +116 -0
  17. data/lib/telnyx/models/calls/transcription_engine_b_config.rb +3 -114
  18. data/lib/telnyx/models/calls/transcription_start_request.rb +3 -115
  19. data/lib/telnyx/models/document_upload_json_params.rb +50 -0
  20. data/lib/telnyx/models/document_upload_json_response.rb +16 -0
  21. data/lib/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rb +39 -0
  22. data/lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rb +3 -32
  23. data/lib/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rb +3 -32
  24. data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rb +3 -32
  25. data/lib/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rb +39 -0
  26. data/lib/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rb +3 -32
  27. data/lib/telnyx/models/{verify_profile_create_template_response.rb → message_template.rb} +1 -1
  28. data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +3 -19
  29. data/lib/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rb +23 -0
  30. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +3 -21
  31. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +3 -21
  32. data/lib/telnyx/models/oauth_client_list_response.rb +3 -39
  33. data/lib/telnyx/models/oauth_grant_list_response.rb +3 -39
  34. data/lib/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rb +33 -0
  35. data/lib/telnyx/models/pagination_meta_oauth.rb +40 -0
  36. data/lib/telnyx/models/phone_number_blocks/job.rb +3 -70
  37. data/lib/telnyx/models/phone_number_blocks/job_error.rb +73 -0
  38. data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +3 -70
  39. data/lib/telnyx/models/report_list_mdrs_response.rb +3 -32
  40. data/lib/telnyx/models/reports/mdr_usage_report_list_response.rb +3 -32
  41. data/lib/telnyx/models/reports/pagination_meta_reporting.rb +35 -0
  42. data/lib/telnyx/models/stream_bidirectional_sampling_rate.rb +19 -0
  43. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +140 -0
  44. data/lib/telnyx/models/verifications/by_phone_number_list_response.rb +3 -32
  45. data/lib/telnyx/models/verifications/verify_meta.rb +35 -0
  46. data/lib/telnyx/models/verify_profile_list_response.rb +3 -32
  47. data/lib/telnyx/models/webhook_unsafe_unwrap_params.rb +14 -0
  48. data/lib/telnyx/models.rb +16 -0
  49. data/lib/telnyx/resources/advanced_orders.rb +4 -4
  50. data/lib/telnyx/resources/ai/assistants/versions.rb +6 -6
  51. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  52. data/lib/telnyx/resources/calls/actions.rb +1 -1
  53. data/lib/telnyx/resources/calls.rb +1 -1
  54. data/lib/telnyx/resources/documents.rb +33 -1
  55. data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +2 -2
  56. data/lib/telnyx/resources/verify_profiles.rb +4 -4
  57. data/lib/telnyx/resources/webhooks.rb +8 -0
  58. data/lib/telnyx/version.rb +1 -1
  59. data/lib/telnyx.rb +81 -8
  60. data/rbi/telnyx/client.rbi +6 -0
  61. data/rbi/telnyx/models/access_ip_address_list_response.rbi +4 -52
  62. data/rbi/telnyx/models/access_ip_range_list_response.rbi +4 -52
  63. data/rbi/telnyx/models/advanced_order.rbi +171 -0
  64. data/rbi/telnyx/models/advanced_order_create_params.rbi +5 -199
  65. data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +5 -224
  66. data/rbi/telnyx/models/ai/assistants_list.rbi +3 -278
  67. data/rbi/telnyx/models/ai/{assistant_clone_response.rbi → inference_embedding.rbi} +2 -5
  68. data/rbi/telnyx/models/call_dial_params.rbi +4 -58
  69. data/rbi/telnyx/models/calls/action_start_streaming_params.rbi +4 -58
  70. data/rbi/telnyx/models/calls/telnyx_transcription_language.rbi +230 -0
  71. data/rbi/telnyx/models/calls/transcription_engine_b_config.rbi +4 -531
  72. data/rbi/telnyx/models/calls/transcription_start_request.rbi +4 -530
  73. data/rbi/telnyx/models/document_upload_json_params.rbi +75 -0
  74. data/rbi/telnyx/models/document_upload_json_response.rbi +33 -0
  75. data/rbi/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbi +74 -0
  76. data/rbi/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbi +4 -67
  77. data/rbi/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbi +4 -67
  78. data/rbi/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbi +4 -67
  79. data/rbi/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbi +74 -0
  80. data/rbi/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbi +4 -67
  81. data/rbi/telnyx/models/{verify_profile_create_template_response.rbi → message_template.rbi} +2 -5
  82. data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +3 -53
  83. data/rbi/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbi +59 -0
  84. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +4 -54
  85. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +4 -54
  86. data/rbi/telnyx/models/oauth_client_list_response.rbi +4 -77
  87. data/rbi/telnyx/models/oauth_grant_list_response.rbi +4 -77
  88. data/rbi/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbi +51 -0
  89. data/rbi/telnyx/models/pagination_meta_oauth.rbi +73 -0
  90. data/rbi/telnyx/models/phone_number_blocks/job.rbi +4 -172
  91. data/rbi/telnyx/models/phone_number_blocks/job_error.rbi +140 -0
  92. data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +4 -174
  93. data/rbi/telnyx/models/report_list_mdrs_response.rbi +4 -67
  94. data/rbi/telnyx/models/reports/mdr_usage_report_list_response.rbi +4 -75
  95. data/rbi/telnyx/models/reports/pagination_meta_reporting.rbi +70 -0
  96. data/rbi/telnyx/models/stream_bidirectional_sampling_rate.rbi +33 -0
  97. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +85 -0
  98. data/rbi/telnyx/models/verifications/by_phone_number_list_response.rbi +4 -78
  99. data/rbi/telnyx/models/verifications/verify_meta.rbi +67 -0
  100. data/rbi/telnyx/models/verify_profile_list_response.rbi +4 -71
  101. data/rbi/telnyx/models/webhook_unsafe_unwrap_params.rbi +27 -0
  102. data/rbi/telnyx/models.rbi +18 -0
  103. data/rbi/telnyx/resources/advanced_orders.rbi +4 -10
  104. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -3
  105. data/rbi/telnyx/resources/ai/assistants.rbi +3 -3
  106. data/rbi/telnyx/resources/calls/actions.rbi +1 -1
  107. data/rbi/telnyx/resources/calls.rbi +1 -1
  108. data/rbi/telnyx/resources/documents.rbi +25 -0
  109. data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +2 -2
  110. data/rbi/telnyx/resources/verify_profiles.rbi +2 -2
  111. data/rbi/telnyx/resources/webhooks.rbi +76 -0
  112. data/sig/telnyx/client.rbs +3 -0
  113. data/sig/telnyx/models/access_ip_address_list_response.rbs +4 -36
  114. data/sig/telnyx/models/access_ip_range_list_response.rbs +4 -36
  115. data/sig/telnyx/models/advanced_order.rbs +105 -0
  116. data/sig/telnyx/models/advanced_order_create_params.rbs +4 -100
  117. data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +4 -100
  118. data/sig/telnyx/models/ai/assistants_list.rbs +4 -159
  119. data/sig/telnyx/models/ai/{assistant_clone_response.rbs → inference_embedding.rbs} +2 -2
  120. data/sig/telnyx/models/call_dial_params.rbs +6 -21
  121. data/sig/telnyx/models/calls/action_start_streaming_params.rbs +6 -21
  122. data/sig/telnyx/models/calls/telnyx_transcription_language.rbs +214 -0
  123. data/sig/telnyx/models/calls/transcription_engine_b_config.rbs +6 -215
  124. data/sig/telnyx/models/calls/transcription_start_request.rbs +6 -215
  125. data/sig/telnyx/models/document_upload_json_params.rbs +45 -0
  126. data/sig/telnyx/models/document_upload_json_response.rbs +15 -0
  127. data/sig/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbs +49 -0
  128. data/sig/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbs +6 -46
  129. data/sig/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbs +6 -46
  130. data/sig/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbs +6 -46
  131. data/sig/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbs +49 -0
  132. data/sig/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbs +6 -46
  133. data/sig/telnyx/models/{verify_profile_create_template_response.rbs → message_template.rbs} +2 -2
  134. data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +4 -23
  135. data/sig/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbs +26 -0
  136. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +6 -25
  137. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +6 -25
  138. data/sig/telnyx/models/oauth_client_list_response.rbs +5 -50
  139. data/sig/telnyx/models/oauth_grant_list_response.rbs +5 -50
  140. data/sig/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbs +35 -0
  141. data/sig/telnyx/models/pagination_meta_oauth.rbs +43 -0
  142. data/sig/telnyx/models/phone_number_blocks/job.rbs +6 -81
  143. data/sig/telnyx/models/phone_number_blocks/job_error.rbs +80 -0
  144. data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +6 -81
  145. data/sig/telnyx/models/report_list_mdrs_response.rbs +6 -46
  146. data/sig/telnyx/models/reports/mdr_usage_report_list_response.rbs +6 -46
  147. data/sig/telnyx/models/reports/pagination_meta_reporting.rbs +45 -0
  148. data/sig/telnyx/models/stream_bidirectional_sampling_rate.rbs +18 -0
  149. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +75 -0
  150. data/sig/telnyx/models/verifications/by_phone_number_list_response.rbs +4 -44
  151. data/sig/telnyx/models/verifications/verify_meta.rbs +45 -0
  152. data/sig/telnyx/models/verify_profile_list_response.rbs +4 -44
  153. data/sig/telnyx/models/webhook_unsafe_unwrap_params.rbs +15 -0
  154. data/sig/telnyx/models.rbs +16 -0
  155. data/sig/telnyx/resources/advanced_orders.rbs +4 -4
  156. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  157. data/sig/telnyx/resources/ai/assistants.rbs +3 -3
  158. data/sig/telnyx/resources/calls/actions.rbs +1 -1
  159. data/sig/telnyx/resources/calls.rbs +1 -1
  160. data/sig/telnyx/resources/documents.rbs +8 -0
  161. data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -2
  162. data/sig/telnyx/resources/verify_profiles.rbs +2 -2
  163. data/sig/telnyx/resources/webhooks.rbs +67 -0
  164. metadata +58 -28
  165. data/lib/telnyx/models/ai/assistant_clone_response.rb +0 -167
  166. data/lib/telnyx/models/ai/assistant_retrieve_response.rb +0 -167
  167. data/lib/telnyx/models/ai/assistants/version_promote_response.rb +0 -169
  168. data/lib/telnyx/models/ai/assistants/version_retrieve_response.rb +0 -169
  169. data/lib/telnyx/models/ai/assistants/version_update_response.rb +0 -169
  170. data/lib/telnyx/models/verify_profile_update_template_response.rb +0 -16
  171. data/rbi/telnyx/models/ai/assistant_create_response.rbi +0 -277
  172. data/rbi/telnyx/models/ai/assistant_retrieve_response.rbi +0 -277
  173. data/rbi/telnyx/models/ai/assistants/version_promote_response.rbi +0 -287
  174. data/rbi/telnyx/models/ai/assistants/version_retrieve_response.rbi +0 -287
  175. data/rbi/telnyx/models/ai/assistants/version_update_response.rbi +0 -287
  176. data/rbi/telnyx/models/verify_profile_update_template_response.rbi +0 -37
  177. data/sig/telnyx/models/ai/assistant_create_response.rbs +0 -158
  178. data/sig/telnyx/models/ai/assistant_retrieve_response.rbs +0 -158
  179. data/sig/telnyx/models/ai/assistants/version_promote_response.rbs +0 -160
  180. data/sig/telnyx/models/ai/assistants/version_retrieve_response.rbs +0 -160
  181. data/sig/telnyx/models/ai/assistants/version_update_response.rbs +0 -160
  182. data/sig/telnyx/models/verify_profile_update_template_response.rbs +0 -20
@@ -1,277 +0,0 @@
1
- # typed: strong
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class AssistantRetrieveResponse < Telnyx::Internal::Type::BaseModel
7
- OrHash =
8
- T.type_alias do
9
- T.any(
10
- Telnyx::Models::AI::AssistantRetrieveResponse,
11
- Telnyx::Internal::AnyHash
12
- )
13
- end
14
-
15
- sig { returns(String) }
16
- attr_accessor :id
17
-
18
- sig { returns(Time) }
19
- attr_accessor :created_at
20
-
21
- # System instructions for the assistant. These may be templated with
22
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
23
- sig { returns(String) }
24
- attr_accessor :instructions
25
-
26
- # ID of the model to use. You can use the
27
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
28
- # to see all of your available models,
29
- sig { returns(String) }
30
- attr_accessor :model
31
-
32
- sig { returns(String) }
33
- attr_accessor :name
34
-
35
- sig { returns(T.nilable(String)) }
36
- attr_reader :description
37
-
38
- sig { params(description: String).void }
39
- attr_writer :description
40
-
41
- # Map of dynamic variables and their values
42
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
43
- attr_reader :dynamic_variables
44
-
45
- sig { params(dynamic_variables: T::Hash[Symbol, T.anything]).void }
46
- attr_writer :dynamic_variables
47
-
48
- # If the dynamic_variables_webhook_url is set for the assistant, we will send a
49
- # request at the start of the conversation. See our
50
- # [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
51
- # for more information.
52
- sig { returns(T.nilable(String)) }
53
- attr_reader :dynamic_variables_webhook_url
54
-
55
- sig { params(dynamic_variables_webhook_url: String).void }
56
- attr_writer :dynamic_variables_webhook_url
57
-
58
- sig do
59
- returns(
60
- T.nilable(T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol])
61
- )
62
- end
63
- attr_reader :enabled_features
64
-
65
- sig do
66
- params(
67
- enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol]
68
- ).void
69
- end
70
- attr_writer :enabled_features
71
-
72
- # Text that the assistant will use to start the conversation. This may be
73
- # templated with
74
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
75
- sig { returns(T.nilable(String)) }
76
- attr_reader :greeting
77
-
78
- sig { params(greeting: String).void }
79
- attr_writer :greeting
80
-
81
- sig { returns(T.nilable(Telnyx::AI::ImportMetadata)) }
82
- attr_reader :import_metadata
83
-
84
- sig { params(import_metadata: Telnyx::AI::ImportMetadata::OrHash).void }
85
- attr_writer :import_metadata
86
-
87
- sig { returns(T.nilable(Telnyx::AI::InsightSettings)) }
88
- attr_reader :insight_settings
89
-
90
- sig do
91
- params(insight_settings: Telnyx::AI::InsightSettings::OrHash).void
92
- end
93
- attr_writer :insight_settings
94
-
95
- # This is only needed when using third-party inference providers. The `identifier`
96
- # for an integration secret
97
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
98
- # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
99
- # work with this integration.
100
- sig { returns(T.nilable(String)) }
101
- attr_reader :llm_api_key_ref
102
-
103
- sig { params(llm_api_key_ref: String).void }
104
- attr_writer :llm_api_key_ref
105
-
106
- sig { returns(T.nilable(Telnyx::AI::MessagingSettings)) }
107
- attr_reader :messaging_settings
108
-
109
- sig do
110
- params(messaging_settings: Telnyx::AI::MessagingSettings::OrHash).void
111
- end
112
- attr_writer :messaging_settings
113
-
114
- sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
115
- attr_reader :privacy_settings
116
-
117
- sig do
118
- params(privacy_settings: Telnyx::AI::PrivacySettings::OrHash).void
119
- end
120
- attr_writer :privacy_settings
121
-
122
- sig { returns(T.nilable(Telnyx::AI::TelephonySettings)) }
123
- attr_reader :telephony_settings
124
-
125
- sig do
126
- params(telephony_settings: Telnyx::AI::TelephonySettings::OrHash).void
127
- end
128
- attr_writer :telephony_settings
129
-
130
- # The tools that the assistant can use. These may be templated with
131
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
132
- sig do
133
- returns(T.nilable(T::Array[Telnyx::AI::AssistantTool::Variants]))
134
- end
135
- attr_reader :tools
136
-
137
- sig do
138
- params(
139
- tools:
140
- T::Array[
141
- T.any(
142
- Telnyx::AI::WebhookTool::OrHash,
143
- Telnyx::AI::RetrievalTool::OrHash,
144
- Telnyx::AI::AssistantTool::HandoffTool::OrHash,
145
- Telnyx::AI::HangupTool::OrHash,
146
- Telnyx::AI::TransferTool::OrHash,
147
- Telnyx::AI::AssistantTool::SipReferTool::OrHash,
148
- Telnyx::AI::AssistantTool::DtmfTool::OrHash
149
- )
150
- ]
151
- ).void
152
- end
153
- attr_writer :tools
154
-
155
- sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
156
- attr_reader :transcription
157
-
158
- sig do
159
- params(transcription: Telnyx::AI::TranscriptionSettings::OrHash).void
160
- end
161
- attr_writer :transcription
162
-
163
- sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
164
- attr_reader :voice_settings
165
-
166
- sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
167
- attr_writer :voice_settings
168
-
169
- sig do
170
- params(
171
- id: String,
172
- created_at: Time,
173
- instructions: String,
174
- model: String,
175
- name: String,
176
- description: String,
177
- dynamic_variables: T::Hash[Symbol, T.anything],
178
- dynamic_variables_webhook_url: String,
179
- enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
180
- greeting: String,
181
- import_metadata: Telnyx::AI::ImportMetadata::OrHash,
182
- insight_settings: Telnyx::AI::InsightSettings::OrHash,
183
- llm_api_key_ref: String,
184
- messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
185
- privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
186
- telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
187
- tools:
188
- T::Array[
189
- T.any(
190
- Telnyx::AI::WebhookTool::OrHash,
191
- Telnyx::AI::RetrievalTool::OrHash,
192
- Telnyx::AI::AssistantTool::HandoffTool::OrHash,
193
- Telnyx::AI::HangupTool::OrHash,
194
- Telnyx::AI::TransferTool::OrHash,
195
- Telnyx::AI::AssistantTool::SipReferTool::OrHash,
196
- Telnyx::AI::AssistantTool::DtmfTool::OrHash
197
- )
198
- ],
199
- transcription: Telnyx::AI::TranscriptionSettings::OrHash,
200
- voice_settings: Telnyx::AI::VoiceSettings::OrHash
201
- ).returns(T.attached_class)
202
- end
203
- def self.new(
204
- id:,
205
- created_at:,
206
- # System instructions for the assistant. These may be templated with
207
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
208
- instructions:,
209
- # ID of the model to use. You can use the
210
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
211
- # to see all of your available models,
212
- model:,
213
- name:,
214
- description: nil,
215
- # Map of dynamic variables and their values
216
- dynamic_variables: nil,
217
- # If the dynamic_variables_webhook_url is set for the assistant, we will send a
218
- # request at the start of the conversation. See our
219
- # [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
220
- # for more information.
221
- dynamic_variables_webhook_url: nil,
222
- enabled_features: nil,
223
- # Text that the assistant will use to start the conversation. This may be
224
- # templated with
225
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
226
- greeting: nil,
227
- import_metadata: nil,
228
- insight_settings: nil,
229
- # This is only needed when using third-party inference providers. The `identifier`
230
- # for an integration secret
231
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
232
- # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
233
- # work with this integration.
234
- llm_api_key_ref: nil,
235
- messaging_settings: nil,
236
- privacy_settings: nil,
237
- telephony_settings: nil,
238
- # The tools that the assistant can use. These may be templated with
239
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
240
- tools: nil,
241
- transcription: nil,
242
- voice_settings: nil
243
- )
244
- end
245
-
246
- sig do
247
- override.returns(
248
- {
249
- id: String,
250
- created_at: Time,
251
- instructions: String,
252
- model: String,
253
- name: String,
254
- description: String,
255
- dynamic_variables: T::Hash[Symbol, T.anything],
256
- dynamic_variables_webhook_url: String,
257
- enabled_features:
258
- T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol],
259
- greeting: String,
260
- import_metadata: Telnyx::AI::ImportMetadata,
261
- insight_settings: Telnyx::AI::InsightSettings,
262
- llm_api_key_ref: String,
263
- messaging_settings: Telnyx::AI::MessagingSettings,
264
- privacy_settings: Telnyx::AI::PrivacySettings,
265
- telephony_settings: Telnyx::AI::TelephonySettings,
266
- tools: T::Array[Telnyx::AI::AssistantTool::Variants],
267
- transcription: Telnyx::AI::TranscriptionSettings,
268
- voice_settings: Telnyx::AI::VoiceSettings
269
- }
270
- )
271
- end
272
- def to_hash
273
- end
274
- end
275
- end
276
- end
277
- end
@@ -1,287 +0,0 @@
1
- # typed: strong
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- module Assistants
7
- class VersionPromoteResponse < Telnyx::Internal::Type::BaseModel
8
- OrHash =
9
- T.type_alias do
10
- T.any(
11
- Telnyx::Models::AI::Assistants::VersionPromoteResponse,
12
- Telnyx::Internal::AnyHash
13
- )
14
- end
15
-
16
- sig { returns(String) }
17
- attr_accessor :id
18
-
19
- sig { returns(Time) }
20
- attr_accessor :created_at
21
-
22
- # System instructions for the assistant. These may be templated with
23
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
24
- sig { returns(String) }
25
- attr_accessor :instructions
26
-
27
- # ID of the model to use. You can use the
28
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
29
- # to see all of your available models,
30
- sig { returns(String) }
31
- attr_accessor :model
32
-
33
- sig { returns(String) }
34
- attr_accessor :name
35
-
36
- sig { returns(T.nilable(String)) }
37
- attr_reader :description
38
-
39
- sig { params(description: String).void }
40
- attr_writer :description
41
-
42
- # Map of dynamic variables and their values
43
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
44
- attr_reader :dynamic_variables
45
-
46
- sig { params(dynamic_variables: T::Hash[Symbol, T.anything]).void }
47
- attr_writer :dynamic_variables
48
-
49
- # If the dynamic_variables_webhook_url is set for the assistant, we will send a
50
- # request at the start of the conversation. See our
51
- # [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
52
- # for more information.
53
- sig { returns(T.nilable(String)) }
54
- attr_reader :dynamic_variables_webhook_url
55
-
56
- sig { params(dynamic_variables_webhook_url: String).void }
57
- attr_writer :dynamic_variables_webhook_url
58
-
59
- sig do
60
- returns(
61
- T.nilable(T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol])
62
- )
63
- end
64
- attr_reader :enabled_features
65
-
66
- sig do
67
- params(
68
- enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol]
69
- ).void
70
- end
71
- attr_writer :enabled_features
72
-
73
- # Text that the assistant will use to start the conversation. This may be
74
- # templated with
75
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
76
- sig { returns(T.nilable(String)) }
77
- attr_reader :greeting
78
-
79
- sig { params(greeting: String).void }
80
- attr_writer :greeting
81
-
82
- sig { returns(T.nilable(Telnyx::AI::ImportMetadata)) }
83
- attr_reader :import_metadata
84
-
85
- sig do
86
- params(import_metadata: Telnyx::AI::ImportMetadata::OrHash).void
87
- end
88
- attr_writer :import_metadata
89
-
90
- sig { returns(T.nilable(Telnyx::AI::InsightSettings)) }
91
- attr_reader :insight_settings
92
-
93
- sig do
94
- params(insight_settings: Telnyx::AI::InsightSettings::OrHash).void
95
- end
96
- attr_writer :insight_settings
97
-
98
- # This is only needed when using third-party inference providers. The `identifier`
99
- # for an integration secret
100
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
101
- # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
102
- # work with this integration.
103
- sig { returns(T.nilable(String)) }
104
- attr_reader :llm_api_key_ref
105
-
106
- sig { params(llm_api_key_ref: String).void }
107
- attr_writer :llm_api_key_ref
108
-
109
- sig { returns(T.nilable(Telnyx::AI::MessagingSettings)) }
110
- attr_reader :messaging_settings
111
-
112
- sig do
113
- params(
114
- messaging_settings: Telnyx::AI::MessagingSettings::OrHash
115
- ).void
116
- end
117
- attr_writer :messaging_settings
118
-
119
- sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
120
- attr_reader :privacy_settings
121
-
122
- sig do
123
- params(privacy_settings: Telnyx::AI::PrivacySettings::OrHash).void
124
- end
125
- attr_writer :privacy_settings
126
-
127
- sig { returns(T.nilable(Telnyx::AI::TelephonySettings)) }
128
- attr_reader :telephony_settings
129
-
130
- sig do
131
- params(
132
- telephony_settings: Telnyx::AI::TelephonySettings::OrHash
133
- ).void
134
- end
135
- attr_writer :telephony_settings
136
-
137
- # The tools that the assistant can use. These may be templated with
138
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
139
- sig do
140
- returns(T.nilable(T::Array[Telnyx::AI::AssistantTool::Variants]))
141
- end
142
- attr_reader :tools
143
-
144
- sig do
145
- params(
146
- tools:
147
- T::Array[
148
- T.any(
149
- Telnyx::AI::WebhookTool::OrHash,
150
- Telnyx::AI::RetrievalTool::OrHash,
151
- Telnyx::AI::AssistantTool::HandoffTool::OrHash,
152
- Telnyx::AI::HangupTool::OrHash,
153
- Telnyx::AI::TransferTool::OrHash,
154
- Telnyx::AI::AssistantTool::SipReferTool::OrHash,
155
- Telnyx::AI::AssistantTool::DtmfTool::OrHash
156
- )
157
- ]
158
- ).void
159
- end
160
- attr_writer :tools
161
-
162
- sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
163
- attr_reader :transcription
164
-
165
- sig do
166
- params(
167
- transcription: Telnyx::AI::TranscriptionSettings::OrHash
168
- ).void
169
- end
170
- attr_writer :transcription
171
-
172
- sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
173
- attr_reader :voice_settings
174
-
175
- sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
176
- attr_writer :voice_settings
177
-
178
- sig do
179
- params(
180
- id: String,
181
- created_at: Time,
182
- instructions: String,
183
- model: String,
184
- name: String,
185
- description: String,
186
- dynamic_variables: T::Hash[Symbol, T.anything],
187
- dynamic_variables_webhook_url: String,
188
- enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
189
- greeting: String,
190
- import_metadata: Telnyx::AI::ImportMetadata::OrHash,
191
- insight_settings: Telnyx::AI::InsightSettings::OrHash,
192
- llm_api_key_ref: String,
193
- messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
194
- privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
195
- telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
196
- tools:
197
- T::Array[
198
- T.any(
199
- Telnyx::AI::WebhookTool::OrHash,
200
- Telnyx::AI::RetrievalTool::OrHash,
201
- Telnyx::AI::AssistantTool::HandoffTool::OrHash,
202
- Telnyx::AI::HangupTool::OrHash,
203
- Telnyx::AI::TransferTool::OrHash,
204
- Telnyx::AI::AssistantTool::SipReferTool::OrHash,
205
- Telnyx::AI::AssistantTool::DtmfTool::OrHash
206
- )
207
- ],
208
- transcription: Telnyx::AI::TranscriptionSettings::OrHash,
209
- voice_settings: Telnyx::AI::VoiceSettings::OrHash
210
- ).returns(T.attached_class)
211
- end
212
- def self.new(
213
- id:,
214
- created_at:,
215
- # System instructions for the assistant. These may be templated with
216
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
217
- instructions:,
218
- # ID of the model to use. You can use the
219
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
220
- # to see all of your available models,
221
- model:,
222
- name:,
223
- description: nil,
224
- # Map of dynamic variables and their values
225
- dynamic_variables: nil,
226
- # If the dynamic_variables_webhook_url is set for the assistant, we will send a
227
- # request at the start of the conversation. See our
228
- # [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
229
- # for more information.
230
- dynamic_variables_webhook_url: nil,
231
- enabled_features: nil,
232
- # Text that the assistant will use to start the conversation. This may be
233
- # templated with
234
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
235
- greeting: nil,
236
- import_metadata: nil,
237
- insight_settings: nil,
238
- # This is only needed when using third-party inference providers. The `identifier`
239
- # for an integration secret
240
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
241
- # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
242
- # work with this integration.
243
- llm_api_key_ref: nil,
244
- messaging_settings: nil,
245
- privacy_settings: nil,
246
- telephony_settings: nil,
247
- # The tools that the assistant can use. These may be templated with
248
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
249
- tools: nil,
250
- transcription: nil,
251
- voice_settings: nil
252
- )
253
- end
254
-
255
- sig do
256
- override.returns(
257
- {
258
- id: String,
259
- created_at: Time,
260
- instructions: String,
261
- model: String,
262
- name: String,
263
- description: String,
264
- dynamic_variables: T::Hash[Symbol, T.anything],
265
- dynamic_variables_webhook_url: String,
266
- enabled_features:
267
- T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol],
268
- greeting: String,
269
- import_metadata: Telnyx::AI::ImportMetadata,
270
- insight_settings: Telnyx::AI::InsightSettings,
271
- llm_api_key_ref: String,
272
- messaging_settings: Telnyx::AI::MessagingSettings,
273
- privacy_settings: Telnyx::AI::PrivacySettings,
274
- telephony_settings: Telnyx::AI::TelephonySettings,
275
- tools: T::Array[Telnyx::AI::AssistantTool::Variants],
276
- transcription: Telnyx::AI::TranscriptionSettings,
277
- voice_settings: Telnyx::AI::VoiceSettings
278
- }
279
- )
280
- end
281
- def to_hash
282
- end
283
- end
284
- end
285
- end
286
- end
287
- end