telnyx 5.156.0 → 5.157.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 (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +209 -0
  5. data/lib/telnyx/models/ai/anthropic/v1_messages_response.rb +12 -0
  6. data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
  7. data/lib/telnyx/models/ai/assistant_tool.rb +25 -1
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
  9. data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
  10. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rb +103 -0
  11. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rb +54 -0
  12. data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
  13. data/lib/telnyx/models/ai/pay_tool_params.rb +46 -0
  14. data/lib/telnyx/models/ai/tool_create_params.rb +7 -1
  15. data/lib/telnyx/models/ai/tool_update_params.rb +7 -1
  16. data/lib/telnyx/models/ai/transcription_settings.rb +3 -3
  17. data/lib/telnyx/models/call_dial_params.rb +13 -1
  18. data/lib/telnyx/models/calls/transcription_config.rb +8 -4
  19. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
  20. data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
  21. data/lib/telnyx/models/inbound_message.rb +278 -28
  22. data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
  23. data/lib/telnyx/models/managed_account_list_params.rb +45 -3
  24. data/lib/telnyx/models/requirement_list_params.rb +10 -1
  25. data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
  26. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
  27. data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
  28. data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
  29. data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
  30. data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
  31. data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
  32. data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
  33. data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
  34. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
  35. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
  36. data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
  37. data/lib/telnyx/models/verify_profile.rb +2 -2
  38. data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
  39. data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
  40. data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
  41. data/lib/telnyx/resources/ai/anthropic.rb +20 -0
  42. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  43. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  44. data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
  45. data/lib/telnyx/resources/ai/conversations.rb +5 -0
  46. data/lib/telnyx/resources/ai/tools.rb +5 -2
  47. data/lib/telnyx/resources/ai.rb +4 -0
  48. data/lib/telnyx/resources/calls.rb +3 -1
  49. data/lib/telnyx/resources/requirements.rb +13 -3
  50. data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
  51. data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
  52. data/lib/telnyx/resources/storage.rb +6 -0
  53. data/lib/telnyx/version.rb +1 -1
  54. data/lib/telnyx.rb +20 -0
  55. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
  56. data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
  57. data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
  58. data/rbi/telnyx/models/ai/assistant_tool.rbi +37 -1
  59. data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
  60. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
  61. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
  62. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
  63. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
  64. data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
  65. data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
  66. data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
  67. data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
  68. data/rbi/telnyx/models/call_dial_params.rbi +19 -0
  69. data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
  70. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
  71. data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
  72. data/rbi/telnyx/models/inbound_message.rbi +324 -58
  73. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
  74. data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
  75. data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
  76. data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
  77. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
  78. data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
  79. data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
  80. data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
  81. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
  82. data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
  83. data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
  84. data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
  85. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
  86. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
  87. data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
  88. data/rbi/telnyx/models/verify_profile.rbi +2 -2
  89. data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
  90. data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
  91. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
  92. data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
  93. data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
  94. data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
  95. data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
  96. data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
  97. data/rbi/telnyx/resources/ai/tools.rbi +4 -0
  98. data/rbi/telnyx/resources/ai.rbi +3 -0
  99. data/rbi/telnyx/resources/calls.rbi +7 -0
  100. data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
  101. data/rbi/telnyx/resources/requirements.rbi +8 -0
  102. data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
  103. data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
  104. data/rbi/telnyx/resources/storage.rbi +5 -0
  105. data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
  106. data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
  107. data/sig/telnyx/models/ai/assistant_tool.rbs +13 -0
  108. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
  109. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
  110. data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
  111. data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
  112. data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
  113. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
  114. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  115. data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
  116. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
  117. data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
  118. data/sig/telnyx/models/inbound_message.rbs +204 -35
  119. data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
  120. data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
  121. data/sig/telnyx/models/requirement_list_params.rbs +8 -1
  122. data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
  123. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
  124. data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
  125. data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
  126. data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
  127. data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
  128. data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
  129. data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
  130. data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
  131. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
  132. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
  133. data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
  134. data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
  135. data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
  136. data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
  137. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  138. data/sig/telnyx/resources/ai/tools.rbs +2 -0
  139. data/sig/telnyx/resources/ai.rbs +2 -0
  140. data/sig/telnyx/resources/calls.rbs +1 -0
  141. data/sig/telnyx/resources/requirements.rbs +2 -0
  142. data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
  143. data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
  144. data/sig/telnyx/resources/storage.rbs +2 -0
  145. metadata +62 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 90d7decc9cec24949a0d9beb4809b4c21521a283afc48f53ce0bc401d7db77d0
4
- data.tar.gz: b0dd0d0bb56c06a18079fcc8e9aa77bc65dc2c0e2ec8da2c674686c3f197f90a
3
+ metadata.gz: d5b9ffed476341dbc8eb0fbd2245dc0554a2d0d2bcb10e483b8565b380f126b8
4
+ data.tar.gz: 928fb90fc99dc45aaa32115149cb68ccc0fd8389eea0b514b077d321f088cce3
5
5
  SHA512:
6
- metadata.gz: 6cbcb63aa2277c0750355a893354d1025f689192b7e2be70267d5e7d96249cb3a16dafd3fa54adecbcfe4940987725b671d37e4ac80d1e014e8e7d7406886727
7
- data.tar.gz: d6432420d78f51ef8dd197756c310071bca69ae741d449645f5701819f6ac92b0ff3dd2a29747d19b5d3f40228577d8c3097096e4cb1546e5b949442f7b69e51
6
+ metadata.gz: c36fe657f30fac2ede9294e51b892997ca7d4842034c340ed7988825fe75d4787b98ba36dd047b9b17595f6aea405daf7cf3eed0f8ec2d0055bf8d775d29409b
7
+ data.tar.gz: 30771b79640ba029739c62938a934ae1095eeea5af831c5db68969a5fb2b844c8171fce515b48001b7fba4bb8ee4d8ab0e92154af543b3f2b5c75250d60a238c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## [5.157.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.156.0...v5.157.0) (2026-07-17)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **release:** assert a release PR exists for unreleased commits ([#326](https://github.com/team-telnyx/telnyx-ruby/issues/326)) ([d8a97f0](https://github.com/team-telnyx/telnyx-ruby/commit/d8a97f00ce88d2d91f7529644eb36b7bf75ab996))
9
+ * **release:** make the --local scan clone see the repointed release branch ([#324](https://github.com/team-telnyx/telnyx-ruby/issues/324)) ([82dfdae](https://github.com/team-telnyx/telnyx-ruby/commit/82dfdae237576a2a71c3ca8ebc470ae590b81fb9))
10
+
3
11
  ## [5.156.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.155.0...v5.156.0) (2026-07-09)
4
12
 
5
13
 
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.156.0"
27
+ gem "telnyx", "~> 5.157.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -0,0 +1,209 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Anthropic
7
+ # @see Telnyx::Resources::AI::Anthropic::V1#messages
8
+ class V1MessagesParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute max_tokens
13
+ # The maximum number of tokens to generate in the response.
14
+ #
15
+ # @return [Integer]
16
+ required :max_tokens, Integer
17
+
18
+ # @!attribute messages
19
+ # The messages to send to the model, following the
20
+ # [Anthropic Messages API](https://docs.anthropic.com/en/api/messages) format.
21
+ #
22
+ # @return [Array<Hash{Symbol=>Object}>]
23
+ required :messages,
24
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
25
+
26
+ # @!attribute model
27
+ # The model to use for generating the response, for example `zai-org/GLM-5.2` or
28
+ # another model available from the Telnyx models endpoint.
29
+ #
30
+ # @return [String]
31
+ required :model, String
32
+
33
+ # @!attribute api_key_ref
34
+ # If you are using an external inference provider, this field allows you to pass
35
+ # along a reference to your API key. After creating an
36
+ # [integration secret](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
37
+ # for your API key, pass the secret's `identifier` in this field.
38
+ #
39
+ # @return [String, nil]
40
+ optional :api_key_ref, String
41
+
42
+ # @!attribute billing_group_id
43
+ # The billing group ID to associate with this request.
44
+ #
45
+ # @return [String, nil]
46
+ optional :billing_group_id, String
47
+
48
+ # @!attribute fallback_config
49
+ # Configuration for model fallback behavior when the primary model is unavailable.
50
+ #
51
+ # @return [Hash{Symbol=>Object}, nil]
52
+ optional :fallback_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
53
+
54
+ # @!attribute max_retries
55
+ # Maximum number of retries for the request.
56
+ #
57
+ # @return [Integer, nil]
58
+ optional :max_retries, Integer
59
+
60
+ # @!attribute mcp_servers
61
+ # List of MCP (Model Context Protocol) servers to make available to the model.
62
+ #
63
+ # @return [Array<Hash{Symbol=>Object}>, nil]
64
+ optional :mcp_servers,
65
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
66
+
67
+ # @!attribute metadata
68
+ # An object describing metadata about the request.
69
+ #
70
+ # @return [Hash{Symbol=>Object}, nil]
71
+ optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
72
+
73
+ # @!attribute service_tier
74
+ # Service tier for the request.
75
+ #
76
+ # @return [String, nil]
77
+ optional :service_tier, String
78
+
79
+ # @!attribute stop_sequences
80
+ # Custom sequences that will cause the model to stop generating.
81
+ #
82
+ # @return [Array<String>, nil]
83
+ optional :stop_sequences, Telnyx::Internal::Type::ArrayOf[String]
84
+
85
+ # @!attribute stream
86
+ # Whether to stream the response as Anthropic-format Server-Sent Events.
87
+ #
88
+ # @return [Boolean, nil]
89
+ optional :stream, Telnyx::Internal::Type::Boolean
90
+
91
+ # @!attribute system_
92
+ # System prompt. Can be a string or an array of content blocks following the
93
+ # Anthropic API format.
94
+ #
95
+ # @return [String, Array<Hash{Symbol=>Object}>, nil]
96
+ optional :system_, union: -> { Telnyx::AI::Anthropic::V1MessagesParams::System }, api_name: :system
97
+
98
+ # @!attribute temperature
99
+ # Amount of randomness injected into the response. Ranges from 0 to 1.
100
+ #
101
+ # @return [Float, nil]
102
+ optional :temperature, Float
103
+
104
+ # @!attribute thinking
105
+ # Extended thinking configuration for models that support it. Set `type` to
106
+ # `enabled` to turn on extended thinking.
107
+ #
108
+ # @return [Hash{Symbol=>Object}, nil]
109
+ optional :thinking, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
110
+
111
+ # @!attribute timeout
112
+ # Request timeout in seconds.
113
+ #
114
+ # @return [Float, nil]
115
+ optional :timeout, Float
116
+
117
+ # @!attribute tool_choice
118
+ # Controls how the model uses tools, following the Anthropic API format.
119
+ #
120
+ # @return [Hash{Symbol=>Object}, nil]
121
+ optional :tool_choice, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
122
+
123
+ # @!attribute tools
124
+ # Definitions of tools that the model may use, following the Anthropic API format.
125
+ #
126
+ # @return [Array<Hash{Symbol=>Object}>, nil]
127
+ optional :tools,
128
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
129
+
130
+ # @!attribute top_k
131
+ # Top-k sampling parameter. Only sample from the top K options for each subsequent
132
+ # token.
133
+ #
134
+ # @return [Integer, nil]
135
+ optional :top_k, Integer
136
+
137
+ # @!attribute top_p
138
+ # Nucleus sampling parameter. Use temperature or top_p, but not both.
139
+ #
140
+ # @return [Float, nil]
141
+ optional :top_p, Float
142
+
143
+ # @!method initialize(max_tokens:, messages:, model:, api_key_ref: nil, billing_group_id: nil, fallback_config: nil, max_retries: nil, mcp_servers: nil, metadata: nil, service_tier: nil, stop_sequences: nil, stream: nil, system_: nil, temperature: nil, thinking: nil, timeout: nil, tool_choice: nil, tools: nil, top_k: nil, top_p: nil, request_options: {})
144
+ # Some parameter documentations has been truncated, see
145
+ # {Telnyx::Models::AI::Anthropic::V1MessagesParams} for more details.
146
+ #
147
+ # @param max_tokens [Integer] The maximum number of tokens to generate in the response.
148
+ #
149
+ # @param messages [Array<Hash{Symbol=>Object}>] The messages to send to the model, following the [Anthropic Messages API](https:
150
+ #
151
+ # @param model [String] The model to use for generating the response, for example `zai-org/GLM-5.2` or a
152
+ #
153
+ # @param api_key_ref [String] If you are using an external inference provider, this field allows you to pass a
154
+ #
155
+ # @param billing_group_id [String] The billing group ID to associate with this request.
156
+ #
157
+ # @param fallback_config [Hash{Symbol=>Object}] Configuration for model fallback behavior when the primary model is unavailable.
158
+ #
159
+ # @param max_retries [Integer] Maximum number of retries for the request.
160
+ #
161
+ # @param mcp_servers [Array<Hash{Symbol=>Object}>] List of MCP (Model Context Protocol) servers to make available to the model.
162
+ #
163
+ # @param metadata [Hash{Symbol=>Object}] An object describing metadata about the request.
164
+ #
165
+ # @param service_tier [String] Service tier for the request.
166
+ #
167
+ # @param stop_sequences [Array<String>] Custom sequences that will cause the model to stop generating.
168
+ #
169
+ # @param stream [Boolean] Whether to stream the response as Anthropic-format Server-Sent Events.
170
+ #
171
+ # @param system_ [String, Array<Hash{Symbol=>Object}>] System prompt. Can be a string or an array of content blocks following the Anthr
172
+ #
173
+ # @param temperature [Float] Amount of randomness injected into the response. Ranges from 0 to 1.
174
+ #
175
+ # @param thinking [Hash{Symbol=>Object}] Extended thinking configuration for models that support it. Set `type` to `enabl
176
+ #
177
+ # @param timeout [Float] Request timeout in seconds.
178
+ #
179
+ # @param tool_choice [Hash{Symbol=>Object}] Controls how the model uses tools, following the Anthropic API format.
180
+ #
181
+ # @param tools [Array<Hash{Symbol=>Object}>] Definitions of tools that the model may use, following the Anthropic API format.
182
+ #
183
+ # @param top_k [Integer] Top-k sampling parameter. Only sample from the top K options for each subsequent
184
+ #
185
+ # @param top_p [Float] Nucleus sampling parameter. Use temperature or top_p, but not both.
186
+ #
187
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
188
+
189
+ # System prompt. Can be a string or an array of content blocks following the
190
+ # Anthropic API format.
191
+ module System
192
+ extend Telnyx::Internal::Type::Union
193
+
194
+ variant String
195
+
196
+ variant -> { Telnyx::Models::AI::Anthropic::V1MessagesParams::System::UnionMember1Array }
197
+
198
+ # @!method self.variants
199
+ # @return [Array(String, Array<Hash{Symbol=>Object}>)]
200
+
201
+ # @type [Telnyx::Internal::Type::Converter]
202
+ UnionMember1Array =
203
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
204
+ end
205
+ end
206
+ end
207
+ end
208
+ end
209
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Anthropic
7
+ # @type [Telnyx::Internal::Type::Converter]
8
+ V1MessagesResponse = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
9
+ end
10
+ end
11
+ end
12
+ end
@@ -192,7 +192,7 @@ module Telnyx
192
192
  # assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
193
193
  # endpoints.
194
194
  #
195
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
195
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
196
196
  optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
197
197
 
198
198
  # @!attribute transcription
@@ -263,7 +263,7 @@ module Telnyx
263
263
  #
264
264
  # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
265
265
  #
266
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
266
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
267
267
  #
268
268
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
269
269
  #
@@ -35,6 +35,9 @@ module Telnyx
35
35
 
36
36
  variant :skip_turn, -> { Telnyx::AI::AssistantTool::SkipTurn }
37
37
 
38
+ # (BETA) The pay tool allows the assistant to collect card payments from the caller via DTMF during the conversation. Recording is automatically paused while the pay tool is active and resumes when the payment flow completes. The connector_name must reference a pay connector configured in the Telnyx API.
39
+ variant :pay, -> { Telnyx::AI::AssistantTool::Pay }
40
+
38
41
  class ClientSideTool < Telnyx::Internal::Type::BaseModel
39
42
  # @!attribute client_side_tool
40
43
  #
@@ -1045,8 +1048,29 @@ module Telnyx
1045
1048
  end
1046
1049
  end
1047
1050
 
1051
+ class Pay < Telnyx::Internal::Type::BaseModel
1052
+ # @!attribute pay
1053
+ #
1054
+ # @return [Telnyx::Models::AI::PayToolParams]
1055
+ required :pay, -> { Telnyx::AI::PayToolParams }
1056
+
1057
+ # @!attribute type
1058
+ #
1059
+ # @return [Symbol, :pay]
1060
+ required :type, const: :pay
1061
+
1062
+ # @!method initialize(pay:, type: :pay)
1063
+ # (BETA) The pay tool allows the assistant to collect card payments from the
1064
+ # caller via DTMF during the conversation. Recording is automatically paused while
1065
+ # the pay tool is active and resumes when the payment flow completes. The
1066
+ # connector_name must reference a pay connector configured in the Telnyx API.
1067
+ #
1068
+ # @param pay [Telnyx::Models::AI::PayToolParams]
1069
+ # @param type [Symbol, :pay]
1070
+ end
1071
+
1048
1072
  # @!method self.variants
1049
- # @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn)]
1073
+ # @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay)]
1050
1074
  end
1051
1075
  end
1052
1076
  end
@@ -204,7 +204,7 @@ module Telnyx
204
204
  # assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
205
205
  # endpoints.
206
206
  #
207
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
207
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
208
208
  optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
209
209
 
210
210
  # @!attribute transcription
@@ -285,7 +285,7 @@ module Telnyx
285
285
  #
286
286
  # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
287
287
  #
288
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
288
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
289
289
  #
290
290
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
291
291
  #
@@ -189,7 +189,7 @@ module Telnyx
189
189
  # assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
190
190
  # endpoints.
191
191
  #
192
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
192
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
193
193
  optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
194
194
 
195
195
  # @!attribute transcription
@@ -266,7 +266,7 @@ module Telnyx
266
266
  #
267
267
  # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
268
268
  #
269
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
269
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
270
270
  #
271
271
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
272
272
  #
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Conversations
7
+ # @see Telnyx::Resources::AI::Conversations::ConversationInsights#retrieve_aggregates
8
+ class ConversationInsightRetrieveAggregatesParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute created_at
13
+ # Filter by creation datetime to scope the aggregation window. Supports range
14
+ # operators (e.g., `created_at=gte.2025-01-01T00:00:00Z` for the start of the
15
+ # range, `created_at=lt.2025-01-02T00:00:00Z` for the end). To build per-day time
16
+ # series (as the portal does for the 'Insights Over Time' chart), issue one
17
+ # request per day bounded by `created_at=gte.<day_start>` and
18
+ # `created_at=lt.<next_day_start>`.
19
+ #
20
+ # @return [String, nil]
21
+ optional :created_at, String
22
+
23
+ # @!attribute group_by
24
+ # Fields to group by (can be comma-separated or multiple parameters). Prefix a
25
+ # field with 'metadata.' (e.g. 'metadata.assistant_id') to group by the
26
+ # conversation's metadata instead of the insight result.
27
+ #
28
+ # Common fields used for over-time charts:
29
+ #
30
+ # - `score` — Group by the insight's score value (e.g. for Agent Instruction
31
+ # Following, User Satisfaction).
32
+ # - `metadata.assistant_id` — Group by the assistant that handled the
33
+ # conversation.
34
+ # - `metadata.assistant_version_id` — Group by the assistant version, useful for
35
+ # comparing performance across versions in the portal's 'Insights Over Time'
36
+ # chart.
37
+ # - `metadata.telnyx_conversation_channel` — Group by conversation channel
38
+ # (phone_call, web_chat, etc.).
39
+ #
40
+ # @return [Array<String>, nil]
41
+ optional :group_by, Telnyx::Internal::Type::ArrayOf[String]
42
+
43
+ # @!attribute insight_id
44
+ # Optional insight ID to filter conversation insights. Only insights matching this
45
+ # ID will be included in the aggregation.
46
+ #
47
+ # @return [String, nil]
48
+ optional :insight_id, String
49
+
50
+ # @!attribute metadata
51
+ #
52
+ # @return [Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata, nil]
53
+ optional :metadata,
54
+ -> { Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata }
55
+
56
+ # @!attribute show
57
+ # Fields to include in the result (can be comma-separated or multiple parameters).
58
+ # Supports the same 'metadata.<key>' prefix as group_by. Each returned row will
59
+ # contain the grouped field values plus a `record_count` indicating how many
60
+ # conversation insights match that combination.
61
+ #
62
+ # @return [Array<String>, nil]
63
+ optional :show, Telnyx::Internal::Type::ArrayOf[String]
64
+
65
+ # @!method initialize(created_at: nil, group_by: nil, insight_id: nil, metadata: nil, show: nil, request_options: {})
66
+ # Some parameter documentations has been truncated, see
67
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams}
68
+ # for more details.
69
+ #
70
+ # @param created_at [String] Filter by creation datetime to scope the aggregation window. Supports range oper
71
+ #
72
+ # @param group_by [Array<String>] Fields to group by (can be comma-separated or multiple parameters). Prefix a fie
73
+ #
74
+ # @param insight_id [String] Optional insight ID to filter conversation insights. Only insights matching this
75
+ #
76
+ # @param metadata [Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata]
77
+ #
78
+ # @param show [Array<String>] Fields to include in the result (can be comma-separated or multiple parameters).
79
+ #
80
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
81
+
82
+ class Metadata < Telnyx::Internal::Type::BaseModel
83
+ # @!attribute assistant_id
84
+ # Filter by assistant ID (e.g., `metadata.assistant_id=eq.<assistant_id>`). When
85
+ # provided, only conversation insights for the specified assistant are aggregated.
86
+ # Used by the portal to scope the 'Insights Over Time' chart to a single
87
+ # assistant.
88
+ #
89
+ # @return [String, nil]
90
+ optional :assistant_id, String
91
+
92
+ # @!method initialize(assistant_id: nil)
93
+ # Some parameter documentations has been truncated, see
94
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata}
95
+ # for more details.
96
+ #
97
+ # @param assistant_id [String] Filter by assistant ID (e.g., `metadata.assistant_id=eq.<assistant_id>`). When p
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Conversations
7
+ # @see Telnyx::Resources::AI::Conversations::ConversationInsights#retrieve_aggregates
8
+ class ConversationInsightRetrieveAggregatesResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ # Aggregation result rows. Each row contains the grouped field values and a
11
+ # `record_count`.
12
+ #
13
+ # @return [Array<Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data>]
14
+ required :data,
15
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data] }
16
+
17
+ # @!method initialize(data:)
18
+ # Some parameter documentations has been truncated, see
19
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse}
20
+ # for more details.
21
+ #
22
+ # Aggregated conversation insight counts grouped by the specified fields. Each
23
+ # item in `data` contains the grouped field values and a `record_count` indicating
24
+ # how many conversation insights match that combination.
25
+ #
26
+ # @param data [Array<Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data>] Aggregation result rows. Each row contains the grouped field values and a `recor
27
+
28
+ class Data < Telnyx::Internal::Type::BaseModel
29
+ # @!attribute record_count
30
+ # Number of conversation insights that match this combination of grouped field
31
+ # values.
32
+ #
33
+ # @return [Integer]
34
+ required :record_count, Integer
35
+
36
+ # @!method initialize(record_count:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data}
39
+ # for more details.
40
+ #
41
+ # An aggregation row. Contains the grouped field values (keyed by the group_by
42
+ # field names) and a `record_count` integer. For example, when grouping by
43
+ # `score`, each row has a `score` value and a `record_count` of conversations with
44
+ # that score. When also splitting by `metadata.assistant_version_id`, each row
45
+ # includes both `score` and `metadata.assistant_version_id` plus their combined
46
+ # `record_count`.
47
+ #
48
+ # @param record_count [Integer] Number of conversation insights that match this combination of grouped field val
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -199,7 +199,7 @@ module Telnyx
199
199
  # assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
200
200
  # endpoints.
201
201
  #
202
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
202
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
203
203
  optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
204
204
 
205
205
  # @!attribute transcription
@@ -295,7 +295,7 @@ module Telnyx
295
295
  #
296
296
  # @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
297
297
  #
298
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
298
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
299
299
  #
300
300
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
301
301
  #
@@ -430,7 +430,7 @@ module Telnyx
430
430
  # follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
431
431
  # configure a node's tools.
432
432
  #
433
- # @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>, nil]
433
+ # @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>>, nil]
434
434
  optional :tools,
435
435
  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool]] }
436
436
 
@@ -486,7 +486,7 @@ module Telnyx
486
486
  #
487
487
  # @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
488
488
  #
489
- # @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
489
+ # @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
490
490
  #
491
491
  # @param tools_mode [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
492
492
  #
@@ -576,7 +576,7 @@ module Telnyx
576
576
  # responses so clients can render the node without a follow-up fetch. Ignored on
577
577
  # input — set `shared_tool_id`.
578
578
  #
579
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
579
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
580
580
  optional :tool, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
581
581
 
582
582
  # @!attribute type
@@ -600,7 +600,7 @@ module Telnyx
600
600
  #
601
601
  # @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
602
602
  #
603
- # @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
603
+ # @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
604
604
  #
605
605
  # @param type [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Tool::Type] Node kind discriminator. Always `tool` for a tool node.
606
606
 
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ class PayToolParams < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute connector_name
8
+ # The name of the pay connector configured in the Telnyx API. Must reference an
9
+ # existing pay connector for this organization.
10
+ #
11
+ # @return [String]
12
+ required :connector_name, String
13
+
14
+ # @!attribute currency
15
+ # Default currency for payments processed by this tool.
16
+ #
17
+ # @return [String, nil]
18
+ optional :currency, String
19
+
20
+ # @!attribute description
21
+ # Optional description of the pay tool that will be passed to the assistant.
22
+ #
23
+ # @return [String, nil]
24
+ optional :description, String, nil?: true
25
+
26
+ # @!attribute payment_method
27
+ # Default payment method for payments processed by this tool.
28
+ #
29
+ # @return [String, nil]
30
+ optional :payment_method, String
31
+
32
+ # @!method initialize(connector_name:, currency: nil, description: nil, payment_method: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {Telnyx::Models::AI::PayToolParams} for more details.
35
+ #
36
+ # @param connector_name [String] The name of the pay connector configured in the Telnyx API. Must reference an ex
37
+ #
38
+ # @param currency [String] Default currency for payments processed by this tool.
39
+ #
40
+ # @param description [String, nil] Optional description of the pay tool that will be passed to the assistant.
41
+ #
42
+ # @param payment_method [String] Default payment method for payments processed by this tool.
43
+ end
44
+ end
45
+ end
46
+ end