telnyx 5.122.0 → 5.124.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 (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +5 -0
  5. data/lib/telnyx/models/ai/assistant_create_params.rb +780 -1
  6. data/lib/telnyx/models/ai/assistant_update_params.rb +780 -1
  7. data/lib/telnyx/models/ai/assistants/update_assistant.rb +785 -1
  8. data/lib/telnyx/models/ai/inference_embedding.rb +767 -1
  9. data/lib/telnyx/models/{ai_create_response_params.rb → ai_create_response_deprecated_params.rb} +2 -2
  10. data/lib/telnyx/models/{ai_create_response_response.rb → ai_create_response_deprecated_response.rb} +1 -1
  11. data/lib/telnyx/models/messaging_profile_update_params.rb +9 -1
  12. data/lib/telnyx/models/sip_registration_status_retrieve_params.rb +45 -0
  13. data/lib/telnyx/models/sip_registration_status_retrieve_response.rb +160 -0
  14. data/lib/telnyx/models/speech_to_text_list_providers_params.rb +16 -5
  15. data/lib/telnyx/models/speech_to_text_list_providers_response.rb +55 -23
  16. data/lib/telnyx/models.rb +3 -1
  17. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
  18. data/lib/telnyx/resources/ai/assistants.rb +6 -2
  19. data/lib/telnyx/resources/ai.rb +4 -4
  20. data/lib/telnyx/resources/messaging_profiles.rb +3 -1
  21. data/lib/telnyx/resources/sip_registration_status.rb +45 -0
  22. data/lib/telnyx/resources/speech_to_text.rb +6 -5
  23. data/lib/telnyx/version.rb +1 -1
  24. data/lib/telnyx.rb +5 -2
  25. data/rbi/telnyx/client.rbi +4 -0
  26. data/rbi/telnyx/models/ai/assistant_create_params.rbi +1411 -0
  27. data/rbi/telnyx/models/ai/assistant_update_params.rbi +1411 -0
  28. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +1417 -0
  29. data/rbi/telnyx/models/ai/inference_embedding.rbi +1454 -0
  30. data/rbi/telnyx/models/{ai_create_response_params.rbi → ai_create_response_deprecated_params.rbi} +5 -2
  31. data/rbi/telnyx/models/{ai_create_response_response.rbi → ai_create_response_deprecated_response.rbi} +1 -1
  32. data/rbi/telnyx/models/messaging_profile_update_params.rbi +8 -0
  33. data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi +93 -0
  34. data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi +343 -0
  35. data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +27 -7
  36. data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi +107 -43
  37. data/rbi/telnyx/models.rbi +5 -1
  38. data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
  39. data/rbi/telnyx/resources/ai/assistants.rbi +16 -0
  40. data/rbi/telnyx/resources/ai.rbi +1 -1
  41. data/rbi/telnyx/resources/messaging_profiles.rbi +3 -0
  42. data/rbi/telnyx/resources/sip_registration_status.rbi +34 -0
  43. data/rbi/telnyx/resources/speech_to_text.rbi +11 -5
  44. data/sig/telnyx/client.rbs +2 -0
  45. data/sig/telnyx/models/ai/assistant_create_params.rbs +508 -0
  46. data/sig/telnyx/models/ai/assistant_update_params.rbs +508 -0
  47. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +511 -0
  48. data/sig/telnyx/models/ai/inference_embedding.rbs +526 -0
  49. data/sig/telnyx/models/{ai_create_response_params.rbs → ai_create_response_deprecated_params.rbs} +2 -2
  50. data/sig/telnyx/models/ai_create_response_deprecated_response.rbs +7 -0
  51. data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
  52. data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs +41 -0
  53. data/sig/telnyx/models/sip_registration_status_retrieve_response.rbs +164 -0
  54. data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +4 -4
  55. data/sig/telnyx/models/speech_to_text_list_providers_response.rbs +33 -16
  56. data/sig/telnyx/models.rbs +3 -1
  57. data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
  58. data/sig/telnyx/resources/ai/assistants.rbs +2 -0
  59. data/sig/telnyx/resources/ai.rbs +2 -2
  60. data/sig/telnyx/resources/messaging_profiles.rbs +1 -0
  61. data/sig/telnyx/resources/sip_registration_status.rbs +13 -0
  62. metadata +17 -8
  63. data/sig/telnyx/models/ai_create_response_response.rbs +0 -7
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Telnyx
4
4
  module Models
5
- # @see Telnyx::Resources::AI#create_response
6
- class AICreateResponseParams < Telnyx::Internal::Type::BaseModel
5
+ # @see Telnyx::Resources::AI#create_response_deprecated
6
+ class AICreateResponseDeprecatedParams < Telnyx::Internal::Type::BaseModel
7
7
  extend Telnyx::Internal::Type::RequestParameters::Converter
8
8
  include Telnyx::Internal::Type::RequestParameters
9
9
 
@@ -3,6 +3,6 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  # @type [Telnyx::Internal::Type::Converter]
6
- AICreateResponseResponse = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
6
+ AICreateResponseDeprecatedResponse = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
7
7
  end
8
8
  end
@@ -12,6 +12,12 @@ module Telnyx
12
12
  # @return [String]
13
13
  required :messaging_profile_id, String
14
14
 
15
+ # @!attribute ai_assistant_id
16
+ # The ID of the AI assistant associated with this messaging profile.
17
+ #
18
+ # @return [String, nil]
19
+ optional :ai_assistant_id, String, nil?: true
20
+
15
21
  # @!attribute alpha_sender
16
22
  # The alphanumeric sender ID to use when sending to destinations that require an
17
23
  # alphanumeric sender ID.
@@ -128,12 +134,14 @@ module Telnyx
128
134
  # @return [Array<String>, nil]
129
135
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
130
136
 
131
- # @!method initialize(messaging_profile_id:, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
137
+ # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
132
138
  # Some parameter documentations has been truncated, see
133
139
  # {Telnyx::Models::MessagingProfileUpdateParams} for more details.
134
140
  #
135
141
  # @param messaging_profile_id [String]
136
142
  #
143
+ # @param ai_assistant_id [String, nil] The ID of the AI assistant associated with this messaging profile.
144
+ #
137
145
  # @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
138
146
  #
139
147
  # @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::SipRegistrationStatus#retrieve
6
+ class SipRegistrationStatusRetrieveParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute connection_id
11
+ # Identifier of the UAC connection to look up.
12
+ #
13
+ # @return [String]
14
+ required :connection_id, String
15
+
16
+ # @!attribute credential_type
17
+ # The kind of credential to look up. Only `uac_external_credential` is supported
18
+ # today.
19
+ #
20
+ # @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType]
21
+ required :credential_type, enum: -> { Telnyx::SipRegistrationStatusRetrieveParams::CredentialType }
22
+
23
+ # @!method initialize(connection_id:, credential_type:, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
26
+ #
27
+ # @param connection_id [String] Identifier of the UAC connection to look up.
28
+ #
29
+ # @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. Only `uac_external_credential` is supported t
30
+ #
31
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
32
+
33
+ # The kind of credential to look up. Only `uac_external_credential` is supported
34
+ # today.
35
+ module CredentialType
36
+ extend Telnyx::Internal::Type::Enum
37
+
38
+ UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
39
+
40
+ # @!method self.values
41
+ # @return [Array<Symbol>]
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,160 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::SipRegistrationStatus#retrieve
6
+ class SipRegistrationStatusRetrieveResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute connection_id
8
+ # Identifier of the UAC connection.
9
+ #
10
+ # @return [String, nil]
11
+ optional :connection_id, String
12
+
13
+ # @!attribute connection_name
14
+ # Human-readable connection name.
15
+ #
16
+ # @return [String, nil]
17
+ optional :connection_name, String
18
+
19
+ # @!attribute credential_type
20
+ # The credential type that was looked up.
21
+ #
22
+ # @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType, nil]
23
+ optional :credential_type,
24
+ enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType }
25
+
26
+ # @!attribute credential_username
27
+ # SIP username used for the registration.
28
+ #
29
+ # @return [String, nil]
30
+ optional :credential_username, String
31
+
32
+ # @!attribute last_registration_response
33
+ # SIP response from the last registration attempt.
34
+ #
35
+ # @return [String, nil]
36
+ optional :last_registration_response, String
37
+
38
+ # @!attribute registered
39
+ # True if the endpoint is currently registered.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :registered, Telnyx::Internal::Type::Boolean
43
+
44
+ # @!attribute sip_registration_details
45
+ # Detailed registration information reported by the registrar.
46
+ #
47
+ # @return [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails, nil]
48
+ optional :sip_registration_details,
49
+ -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails }
50
+
51
+ # @!attribute sip_registration_status
52
+ # Human-readable registration status derived from the registrar state.
53
+ #
54
+ # @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus, nil]
55
+ optional :sip_registration_status,
56
+ enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus }
57
+
58
+ # @!method initialize(connection_id: nil, connection_name: nil, credential_type: nil, credential_username: nil, last_registration_response: nil, registered: nil, sip_registration_details: nil, sip_registration_status: nil)
59
+ # @param connection_id [String] Identifier of the UAC connection.
60
+ #
61
+ # @param connection_name [String] Human-readable connection name.
62
+ #
63
+ # @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType] The credential type that was looked up.
64
+ #
65
+ # @param credential_username [String] SIP username used for the registration.
66
+ #
67
+ # @param last_registration_response [String] SIP response from the last registration attempt.
68
+ #
69
+ # @param registered [Boolean] True if the endpoint is currently registered.
70
+ #
71
+ # @param sip_registration_details [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails] Detailed registration information reported by the registrar.
72
+ #
73
+ # @param sip_registration_status [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus] Human-readable registration status derived from the registrar state.
74
+
75
+ # The credential type that was looked up.
76
+ #
77
+ # @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#credential_type
78
+ module CredentialType
79
+ extend Telnyx::Internal::Type::Enum
80
+
81
+ UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
82
+
83
+ # @!method self.values
84
+ # @return [Array<Symbol>]
85
+ end
86
+
87
+ # @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#sip_registration_details
88
+ class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
89
+ # @!attribute auth_retries
90
+ # Number of authentication retries on the last attempt.
91
+ #
92
+ # @return [Integer, nil]
93
+ optional :auth_retries, Integer
94
+
95
+ # @!attribute expires
96
+ # Unix timestamp when the current registration expires.
97
+ #
98
+ # @return [Integer, nil]
99
+ optional :expires, Integer
100
+
101
+ # @!attribute failures
102
+ # Count of consecutive registration failures.
103
+ #
104
+ # @return [Integer, nil]
105
+ optional :failures, Integer
106
+
107
+ # @!attribute next_action_at
108
+ # Unix timestamp of the next scheduled registration action.
109
+ #
110
+ # @return [Integer, nil]
111
+ optional :next_action_at, Integer
112
+
113
+ # @!attribute sip_uri_user_host
114
+ # SIP URI user@host of the registered contact.
115
+ #
116
+ # @return [String, nil]
117
+ optional :sip_uri_user_host, String
118
+
119
+ # @!attribute uptime
120
+ # Registration uptime reported by the registrar.
121
+ #
122
+ # @return [Integer, nil]
123
+ optional :uptime, Integer
124
+
125
+ # @!method initialize(auth_retries: nil, expires: nil, failures: nil, next_action_at: nil, sip_uri_user_host: nil, uptime: nil)
126
+ # Detailed registration information reported by the registrar.
127
+ #
128
+ # @param auth_retries [Integer] Number of authentication retries on the last attempt.
129
+ #
130
+ # @param expires [Integer] Unix timestamp when the current registration expires.
131
+ #
132
+ # @param failures [Integer] Count of consecutive registration failures.
133
+ #
134
+ # @param next_action_at [Integer] Unix timestamp of the next scheduled registration action.
135
+ #
136
+ # @param sip_uri_user_host [String] SIP URI user@host of the registered contact.
137
+ #
138
+ # @param uptime [Integer] Registration uptime reported by the registrar.
139
+ end
140
+
141
+ # Human-readable registration status derived from the registrar state.
142
+ #
143
+ # @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#sip_registration_status
144
+ module SipRegistrationStatus
145
+ extend Telnyx::Internal::Type::Enum
146
+
147
+ UNREGISTERING = :unregistering
148
+ CONNECTION_DISABLED = :connection_disabled
149
+ STANDBY = :standby
150
+ FAILED = :failed
151
+ TRYING = :trying
152
+ REGISTERED = :registered
153
+ UNKNOWN = :unknown
154
+
155
+ # @!method self.values
156
+ # @return [Array<Symbol>]
157
+ end
158
+ end
159
+ end
160
+ end
@@ -18,7 +18,12 @@ module Telnyx
18
18
  optional :provider, enum: -> { Telnyx::SpeechToTextListProvidersParams::Provider }
19
19
 
20
20
  # @!attribute service_type
21
- # Filter to entries that support the given service type.
21
+ # Filter to entries that support the given service type. For backward
22
+ # compatibility with the values that briefly shipped before the product-aligned
23
+ # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
24
+ # `ai_assistant_transcription` are silently accepted and normalized to
25
+ # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
26
+ # emits the canonical (post-rename) values.
22
27
  #
23
28
  # @return [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType, nil]
24
29
  optional :service_type, enum: -> { Telnyx::SpeechToTextListProvidersParams::ServiceType }
@@ -29,7 +34,7 @@ module Telnyx
29
34
  #
30
35
  # @param provider [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::Provider] Filter to entries for a specific STT provider. The enum mirrors the providers ad
31
36
  #
32
- # @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type.
37
+ # @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type. For backward compatibilit
33
38
  #
34
39
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
35
40
 
@@ -55,13 +60,19 @@ module Telnyx
55
60
  # @return [Array<Symbol>]
56
61
  end
57
62
 
58
- # Filter to entries that support the given service type.
63
+ # Filter to entries that support the given service type. For backward
64
+ # compatibility with the values that briefly shipped before the product-aligned
65
+ # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
66
+ # `ai_assistant_transcription` are silently accepted and normalized to
67
+ # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
68
+ # emits the canonical (post-rename) values.
59
69
  module ServiceType
60
70
  extend Telnyx::Internal::Type::Enum
61
71
 
62
72
  STREAMING = :streaming
63
- FILE_TRANSCRIPTION = :file_transcription
64
- IN_CALL_TRANSCRIPTION = :in_call_transcription
73
+ FILE_BASED = :file_based
74
+ IN_CALL = :in_call
75
+ AI_ASSISTANT = :ai_assistant
65
76
 
66
77
  # @!method self.values
67
78
  # @return [Array<Symbol>]
@@ -22,13 +22,6 @@ module Telnyx
22
22
  # @param meta [Telnyx::Models::SpeechToTextListProvidersResponse::Meta]
23
23
 
24
24
  class Data < Telnyx::Internal::Type::BaseModel
25
- # @!attribute languages
26
- # Languages this (provider, model) accepts, in the provider's native code format.
27
- # `auto` indicates the provider performs language detection.
28
- #
29
- # @return [Array<String>]
30
- required :languages, Telnyx::Internal::Type::ArrayOf[String]
31
-
32
25
  # @!attribute model
33
26
  # Provider-scoped model name.
34
27
  #
@@ -42,36 +35,75 @@ module Telnyx
42
35
  required :provider, String
43
36
 
44
37
  # @!attribute service_types
45
- # Service surfaces this (provider, model) supports.
38
+ # Service surfaces this (provider, model) supports. When the request filters by
39
+ # `service_type`, only the matching nested entry is returned for each matching
40
+ # model.
46
41
  #
47
- # @return [Array<Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>]
42
+ # @return [Array<Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>]
48
43
  required :service_types,
49
- -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType] }
44
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType] }
50
45
 
51
- # @!method initialize(languages:, model:, provider:, service_types:)
46
+ # @!method initialize(model:, provider:, service_types:)
52
47
  # Some parameter documentations has been truncated, see
53
48
  # {Telnyx::Models::SpeechToTextListProvidersResponse::Data} for more details.
54
49
  #
55
- # A (provider, model) tuple along with its supported service types and languages.
56
- #
57
- # @param languages [Array<String>] Languages this (provider, model) accepts, in the provider's native code format.
50
+ # A (provider, model) tuple along with the service surfaces it supports. Each
51
+ # entry in `service_types` describes one surface and the languages accepted on it.
58
52
  #
59
53
  # @param model [String] Provider-scoped model name.
60
54
  #
61
55
  # @param provider [String] STT provider name.
62
56
  #
63
- # @param service_types [Array<Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>] Service surfaces this (provider, model) supports.
57
+ # @param service_types [Array<Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>] Service surfaces this (provider, model) supports. When the request filters by `s
58
+
59
+ class ServiceType < Telnyx::Internal::Type::BaseModel
60
+ # @!attribute languages
61
+ # Languages accepted on this service surface, in the provider's native code
62
+ # format. `auto` indicates the provider performs language detection.
63
+ #
64
+ # @return [Array<String>]
65
+ required :languages, Telnyx::Internal::Type::ArrayOf[String]
66
+
67
+ # @!attribute type
68
+ # Service surface a model is available on. `ai_assistant` is the STT surface
69
+ # configured via Call Control voice-assistant transcription; it covers both
70
+ # live-streaming and non-streaming/batch models (matching the
71
+ # `TranscriptionConfig.model` enum on `call-control` voice assistants).
72
+ #
73
+ # @return [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type]
74
+ required :type, enum: -> { Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type }
75
+
76
+ # @!method initialize(languages:, type:)
77
+ # Some parameter documentations has been truncated, see
78
+ # {Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType} for more
79
+ # details.
80
+ #
81
+ # A supported service surface for a given (provider, model), along with the
82
+ # language codes accepted on that surface. Language support can differ per surface
83
+ # — for example, a model may accept a narrower language set for streaming than for
84
+ # file transcription.
85
+ #
86
+ # @param languages [Array<String>] Languages accepted on this service surface, in the provider's native code format
87
+ #
88
+ # @param type [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type] Service surface a model is available on. `ai_assistant` is the STT surface confi
64
89
 
65
- # Service surface a model is available on.
66
- module ServiceType
67
- extend Telnyx::Internal::Type::Enum
90
+ # Service surface a model is available on. `ai_assistant` is the STT surface
91
+ # configured via Call Control voice-assistant transcription; it covers both
92
+ # live-streaming and non-streaming/batch models (matching the
93
+ # `TranscriptionConfig.model` enum on `call-control` voice assistants).
94
+ #
95
+ # @see Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType#type
96
+ module Type
97
+ extend Telnyx::Internal::Type::Enum
68
98
 
69
- STREAMING = :streaming
70
- FILE_TRANSCRIPTION = :file_transcription
71
- IN_CALL_TRANSCRIPTION = :in_call_transcription
99
+ STREAMING = :streaming
100
+ FILE_BASED = :file_based
101
+ IN_CALL = :in_call
102
+ AI_ASSISTANT = :ai_assistant
72
103
 
73
- # @!method self.values
74
- # @return [Array<Symbol>]
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
75
107
  end
76
108
  end
77
109
 
data/lib/telnyx/models.rb CHANGED
@@ -83,7 +83,7 @@ module Telnyx
83
83
 
84
84
  AI = Telnyx::Models::AI
85
85
 
86
- AICreateResponseParams = Telnyx::Models::AICreateResponseParams
86
+ AICreateResponseDeprecatedParams = Telnyx::Models::AICreateResponseDeprecatedParams
87
87
 
88
88
  AIRetrieveModelsParams = Telnyx::Models::AIRetrieveModelsParams
89
89
 
@@ -1529,6 +1529,8 @@ module Telnyx
1529
1529
 
1530
1530
  SiprecConnectorUpdateParams = Telnyx::Models::SiprecConnectorUpdateParams
1531
1531
 
1532
+ SipRegistrationStatusRetrieveParams = Telnyx::Models::SipRegistrationStatusRetrieveParams
1533
+
1532
1534
  SoundModifications = Telnyx::Models::SoundModifications
1533
1535
 
1534
1536
  SpeechToTextListProvidersParams = Telnyx::Models::SpeechToTextListProvidersParams
@@ -43,12 +43,14 @@ module Telnyx
43
43
  # Updates the configuration of a specific assistant version. Can not update main
44
44
  # version
45
45
  #
46
- # @overload update(version_id, assistant_id:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
46
+ # @overload update(version_id, assistant_id:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
47
47
  #
48
48
  # @param version_id [String] Path param
49
49
  #
50
50
  # @param assistant_id [String] Path param
51
51
  #
52
+ # @param conversation_flow [Telnyx::Models::AI::Assistants::UpdateAssistant::ConversationFlow] Body param: Conversation flow as supplied by API clients (create / update).
53
+ #
52
54
  # @param description [String] Body param
53
55
  #
54
56
  # @param dynamic_variables [Hash{Symbol=>Object}] Body param: Map of dynamic variables and their default values
@@ -34,12 +34,14 @@ module Telnyx
34
34
  #
35
35
  # Create a new AI Assistant.
36
36
  #
37
- # @overload create(instructions:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
37
+ # @overload create(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
38
38
  #
39
39
  # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
40
40
  #
41
41
  # @param name [String]
42
42
  #
43
+ # @param conversation_flow [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow] Conversation flow as supplied by API clients (create / update).
44
+ #
43
45
  # @param description [String]
44
46
  #
45
47
  # @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
@@ -137,10 +139,12 @@ module Telnyx
137
139
  #
138
140
  # Update an AI Assistant's attributes.
139
141
  #
140
- # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
142
+ # @overload update(assistant_id, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
141
143
  #
142
144
  # @param assistant_id [String]
143
145
  #
146
+ # @param conversation_flow [Telnyx::Models::AI::AssistantUpdateParams::ConversationFlow] Conversation flow as supplied by API clients (create / update).
147
+ #
144
148
  # @param description [String]
145
149
  #
146
150
  # @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
@@ -55,16 +55,16 @@ module Telnyx
55
55
  # supported at the moment. Use the `conversation` parameter with a Telnyx
56
56
  # Conversation ID to leverage persistent conversations.
57
57
  #
58
- # @overload create_response(body:, request_options: {})
58
+ # @overload create_response_deprecated(body:, request_options: {})
59
59
  #
60
60
  # @param body [Hash{Symbol=>Object}]
61
61
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
62
62
  #
63
63
  # @return [Hash{Symbol=>Object}]
64
64
  #
65
- # @see Telnyx::Models::AICreateResponseParams
66
- def create_response(params)
67
- parsed, options = Telnyx::AICreateResponseParams.dump_request(params)
65
+ # @see Telnyx::Models::AICreateResponseDeprecatedParams
66
+ def create_response_deprecated(params)
67
+ parsed, options = Telnyx::AICreateResponseDeprecatedParams.dump_request(params)
68
68
  @client.request(
69
69
  method: :post,
70
70
  path: "ai/responses",
@@ -94,10 +94,12 @@ module Telnyx
94
94
  #
95
95
  # Update a messaging profile
96
96
  #
97
- # @overload update(messaging_profile_id, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
97
+ # @overload update(messaging_profile_id, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
98
98
  #
99
99
  # @param messaging_profile_id [String] The id of the messaging profile to retrieve
100
100
  #
101
+ # @param ai_assistant_id [String, nil] The ID of the AI assistant associated with this messaging profile.
102
+ #
101
103
  # @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
102
104
  #
103
105
  # @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ # UAC connection operations
6
+ class SipRegistrationStatus
7
+ # Some parameter documentations has been truncated, see
8
+ # {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
9
+ #
10
+ # Returns the live SIP registration state of a UAC connection: whether it is
11
+ # currently registered, when it last registered, and the last response Telnyx
12
+ # received from the registrar. Only `uac_external_credential` is supported today.
13
+ #
14
+ # @overload retrieve(connection_id:, credential_type:, request_options: {})
15
+ #
16
+ # @param connection_id [String] Identifier of the UAC connection to look up.
17
+ #
18
+ # @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. Only `uac_external_credential` is supported t
19
+ #
20
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
21
+ #
22
+ # @return [Telnyx::Models::SipRegistrationStatusRetrieveResponse]
23
+ #
24
+ # @see Telnyx::Models::SipRegistrationStatusRetrieveParams
25
+ def retrieve(params)
26
+ parsed, options = Telnyx::SipRegistrationStatusRetrieveParams.dump_request(params)
27
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
28
+ @client.request(
29
+ method: :get,
30
+ path: "sip_registration_status",
31
+ query: query,
32
+ model: Telnyx::Models::SipRegistrationStatusRetrieveResponse,
33
+ options: options
34
+ )
35
+ end
36
+
37
+ # @api private
38
+ #
39
+ # @param client [Telnyx::Client]
40
+ def initialize(client:)
41
+ @client = client
42
+ end
43
+ end
44
+ end
45
+ end
@@ -14,10 +14,11 @@ module Telnyx
14
14
  #
15
15
  # - `streaming` — standalone WebSocket transcription via
16
16
  # `/speech-to-text/transcription`.
17
- # - `file_transcription` — file-based transcription via
18
- # `/ai/audio/transcriptions`.
19
- # - `in_call_transcription` — live call transcription via Call Control
20
- # `transcription_start`.
17
+ # - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
18
+ # - `in_call` — live call transcription via Call Control `transcription_start`.
19
+ # - `ai_assistant` — STT configured on a Call Control AI Assistant via
20
+ # voice-assistant `TranscriptionConfig` (covers both live-streaming and
21
+ # non-streaming/batch models).
21
22
  #
22
23
  # Use this endpoint to discover which (provider, model) combinations are available
23
24
  # for the surface you need, and which language codes each accepts. `auto` in a
@@ -27,7 +28,7 @@ module Telnyx
27
28
  #
28
29
  # @param provider [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::Provider] Filter to entries for a specific STT provider. The enum mirrors the providers ad
29
30
  #
30
- # @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type.
31
+ # @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type. For backward compatibilit
31
32
  #
32
33
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
33
34
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.122.0"
4
+ VERSION = "5.124.0"
5
5
  end
data/lib/telnyx.rb CHANGED
@@ -412,8 +412,8 @@ require_relative "telnyx/models/ai/transfer_tool"
412
412
  require_relative "telnyx/models/ai/voice_settings"
413
413
  require_relative "telnyx/models/ai/webhook_tool"
414
414
  require_relative "telnyx/models/ai/widget_settings"
415
- require_relative "telnyx/models/ai_create_response_params"
416
- require_relative "telnyx/models/ai_create_response_response"
415
+ require_relative "telnyx/models/ai_create_response_deprecated_params"
416
+ require_relative "telnyx/models/ai_create_response_deprecated_response"
417
417
  require_relative "telnyx/models/ai_retrieve_models_params"
418
418
  require_relative "telnyx/models/ai_retrieve_models_response"
419
419
  require_relative "telnyx/models/ai_summarize_params"
@@ -2056,6 +2056,8 @@ require_relative "telnyx/models/siprec_connector_retrieve_params"
2056
2056
  require_relative "telnyx/models/siprec_connector_retrieve_response"
2057
2057
  require_relative "telnyx/models/siprec_connector_update_params"
2058
2058
  require_relative "telnyx/models/siprec_connector_update_response"
2059
+ require_relative "telnyx/models/sip_registration_status_retrieve_params"
2060
+ require_relative "telnyx/models/sip_registration_status_retrieve_response"
2059
2061
  require_relative "telnyx/models/sound_modifications"
2060
2062
  require_relative "telnyx/models/speech_to_text_list_providers_params"
2061
2063
  require_relative "telnyx/models/speech_to_text_list_providers_response"
@@ -2702,6 +2704,7 @@ require_relative "telnyx/resources/sim_card_orders"
2702
2704
  require_relative "telnyx/resources/sim_cards"
2703
2705
  require_relative "telnyx/resources/sim_cards/actions"
2704
2706
  require_relative "telnyx/resources/siprec_connectors"
2707
+ require_relative "telnyx/resources/sip_registration_status"
2705
2708
  require_relative "telnyx/resources/speech_to_text"
2706
2709
  require_relative "telnyx/resources/storage"
2707
2710
  require_relative "telnyx/resources/storage/buckets"
@@ -658,6 +658,10 @@ module Telnyx
658
658
  sig { returns(Telnyx::Resources::UacConnections) }
659
659
  attr_reader :uac_connections
660
660
 
661
+ # UAC connection operations
662
+ sig { returns(Telnyx::Resources::SipRegistrationStatus) }
663
+ attr_reader :sip_registration_status
664
+
661
665
  # Discover available speech-to-text providers, models, and supported languages.
662
666
  sig { returns(Telnyx::Resources::SpeechToText) }
663
667
  attr_reader :speech_to_text