telnyx 5.167.0 → 5.168.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -0
- data/lib/telnyx/models/ai/assistant_a2_a_agent.rb +195 -0
- data/lib/telnyx/models/ai/assistant_create_params.rb +16 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +17 -1
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +17 -1
- data/lib/telnyx/models/ai/chat_completion_request.rb +125 -48
- data/lib/telnyx/models/ai/inference_embedding.rb +16 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +15 -1
- data/lib/telnyx/models/compute/func_retrieve_logs_params.rb +66 -0
- data/lib/telnyx/models/compute/func_retrieve_logs_response.rb +161 -0
- data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_params.rb +69 -0
- data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_response.rb +137 -0
- data/lib/telnyx/models/compute/func_retrieve_revisions_params.rb +34 -0
- data/lib/telnyx/models/compute/func_retrieve_revisions_response.rb +101 -0
- data/lib/telnyx/models/compute/func_retrieve_ship_inspection_params.rb +22 -0
- data/lib/telnyx/models/compute/func_retrieve_ship_inspection_response.rb +94 -0
- data/lib/telnyx/models/compute/functions_observability_pagination_meta.rb +35 -0
- data/lib/telnyx/models/compute/logs_meta.rb +23 -0
- data/lib/telnyx/models/credential_connection.rb +4 -1
- data/lib/telnyx/models/email_inboxes/email_message.rb +12 -1
- data/lib/telnyx/models/email_message_batch_params.rb +4 -1
- data/lib/telnyx/models/email_message_batch_response.rb +1 -0
- data/lib/telnyx/models/fqdn_connection.rb +5 -2
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication.rb +9 -2
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +210 -67
- data/lib/telnyx/models/messaging_messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_features.rb +26 -0
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/uac_connection.rb +4 -1
- data/lib/telnyx/models/uac_external_settings.rb +6 -2
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +104 -1
- data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +103 -1
- data/lib/telnyx/models/whatsapp/phone_number_list_response.rb +103 -1
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rb +22 -0
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +207 -0
- data/lib/telnyx/models/whatsapp_account_update.rb +112 -0
- data/lib/telnyx/models/whatsapp_message_echo.rb +340 -0
- data/lib/telnyx/models/x402/credit_account/payment_list_params.rb +34 -0
- data/lib/telnyx/models/x402/credit_account/payment_retrieve_params.rb +24 -0
- data/lib/telnyx/models/x402/credit_account/payment_retrieve_response.rb +21 -0
- data/lib/telnyx/models/x402/credit_account/x402_transaction_record.rb +113 -0
- data/lib/telnyx/models.rb +8 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
- data/lib/telnyx/resources/ai/assistants.rb +6 -2
- data/lib/telnyx/resources/ai/openai/chat.rb +2 -8
- data/lib/telnyx/resources/compute/funcs.rb +141 -0
- data/lib/telnyx/resources/compute.rb +18 -0
- data/lib/telnyx/resources/email_messages.rb +4 -2
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +22 -0
- data/lib/telnyx/resources/x402/credit_account/payments.rb +71 -0
- data/lib/telnyx/resources/x402/credit_account.rb +8 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +23 -0
- data/rbi/telnyx/client.rbi +3 -0
- data/rbi/telnyx/models/ai/assistant_a2_a_agent.rbi +345 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +29 -0
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +31 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +31 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +224 -92
- data/rbi/telnyx/models/ai/inference_embedding.rbi +29 -0
- data/rbi/telnyx/models/ai/telephony_settings.rbi +23 -0
- data/rbi/telnyx/models/compute/func_retrieve_logs_params.rbi +130 -0
- data/rbi/telnyx/models/compute/func_retrieve_logs_response.rbi +410 -0
- data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbi +102 -0
- data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbi +231 -0
- data/rbi/telnyx/models/compute/func_retrieve_revisions_params.rbi +59 -0
- data/rbi/telnyx/models/compute/func_retrieve_revisions_response.rbi +213 -0
- data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_params.rbi +40 -0
- data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_response.rbi +252 -0
- data/rbi/telnyx/models/compute/functions_observability_pagination_meta.rbi +70 -0
- data/rbi/telnyx/models/compute/logs_meta.rbi +38 -0
- data/rbi/telnyx/models/credential_connection.rbi +8 -2
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +22 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +6 -0
- data/rbi/telnyx/models/email_message_batch_response.rbi +5 -0
- data/rbi/telnyx/models/fqdn_connection.rbi +8 -2
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication.rbi +8 -2
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +450 -193
- data/rbi/telnyx/models/messaging_messaging_profile.rbi +19 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +19 -0
- data/rbi/telnyx/models/messaging_profile_features.rbi +43 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +19 -0
- data/rbi/telnyx/models/uac_connection.rbi +8 -2
- data/rbi/telnyx/models/uac_external_settings.rbi +10 -2
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +3 -1
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +3 -1
- data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_list_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbi +40 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +401 -0
- data/rbi/telnyx/models/whatsapp_account_update.rbi +236 -0
- data/rbi/telnyx/models/whatsapp_message_echo.rbi +611 -0
- data/rbi/telnyx/models/x402/credit_account/payment_list_params.rbi +64 -0
- data/rbi/telnyx/models/x402/credit_account/payment_retrieve_params.rbi +42 -0
- data/rbi/telnyx/models/x402/credit_account/payment_retrieve_response.rbi +53 -0
- data/rbi/telnyx/models/x402/credit_account/x402_transaction_record.rbi +219 -0
- data/rbi/telnyx/models.rbi +8 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +12 -0
- data/rbi/telnyx/resources/ai/assistants.rbi +21 -0
- data/rbi/telnyx/resources/ai/openai/chat.rbi +9 -13
- data/rbi/telnyx/resources/compute/funcs.rbi +111 -0
- data/rbi/telnyx/resources/compute.rbi +15 -0
- data/rbi/telnyx/resources/email_messages.rbi +6 -2
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/webhooks.rbi +6 -2
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +18 -0
- data/rbi/telnyx/resources/x402/credit_account/payments.rbi +60 -0
- data/rbi/telnyx/resources/x402/credit_account.rbi +5 -0
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant_a2_a_agent.rbs +140 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistant_update_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +9 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +86 -44
- data/sig/telnyx/models/ai/inference_embedding.rbs +9 -0
- data/sig/telnyx/models/ai/telephony_settings.rbs +7 -0
- data/sig/telnyx/models/compute/func_retrieve_logs_params.rbs +69 -0
- data/sig/telnyx/models/compute/func_retrieve_logs_response.rbs +210 -0
- data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbs +66 -0
- data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbs +149 -0
- data/sig/telnyx/models/compute/func_retrieve_revisions_params.rbs +38 -0
- data/sig/telnyx/models/compute/func_retrieve_revisions_response.rbs +131 -0
- data/sig/telnyx/models/compute/func_retrieve_ship_inspection_params.rbs +22 -0
- data/sig/telnyx/models/compute/func_retrieve_ship_inspection_response.rbs +117 -0
- data/sig/telnyx/models/compute/functions_observability_pagination_meta.rbs +45 -0
- data/sig/telnyx/models/compute/logs_meta.rbs +21 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +12 -3
- data/sig/telnyx/models/email_message_batch_response.rbs +2 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +207 -95
- data/sig/telnyx/models/messaging_messaging_profile.rbs +5 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +5 -0
- data/sig/telnyx/models/messaging_profile_features.rbs +15 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_list_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbs +25 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +201 -0
- data/sig/telnyx/models/whatsapp_account_update.rbs +107 -0
- data/sig/telnyx/models/whatsapp_message_echo.rbs +291 -0
- data/sig/telnyx/models/x402/credit_account/payment_list_params.rbs +36 -0
- data/sig/telnyx/models/x402/credit_account/payment_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/x402/credit_account/payment_retrieve_response.rbs +26 -0
- data/sig/telnyx/models/x402/credit_account/x402_transaction_record.rbs +104 -0
- data/sig/telnyx/models.rbs +8 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +2 -0
- data/sig/telnyx/resources/ai/openai/chat.rbs +1 -4
- data/sig/telnyx/resources/compute/funcs.rbs +41 -0
- data/sig/telnyx/resources/compute.rbs +9 -0
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/webhooks.rbs +6 -2
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +5 -0
- data/sig/telnyx/resources/x402/credit_account/payments.rbs +22 -0
- data/sig/telnyx/resources/x402/credit_account.rbs +2 -0
- metadata +71 -2
|
@@ -36,6 +36,14 @@ module Telnyx
|
|
|
36
36
|
# @return [Boolean, nil]
|
|
37
37
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
38
38
|
|
|
39
|
+
# @!attribute features
|
|
40
|
+
# Telnyx product features the messaging customer can enable on the messaging
|
|
41
|
+
# profile. Keys map to individual feature flags; unknown keys are accepted and
|
|
42
|
+
# preserved for forward compatibility with rolling deployments.
|
|
43
|
+
#
|
|
44
|
+
# @return [Telnyx::Models::MessagingProfileFeatures, nil]
|
|
45
|
+
optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
|
|
46
|
+
|
|
39
47
|
# @!attribute health_webhook_url
|
|
40
48
|
# DEPRECATED: health check url service checking
|
|
41
49
|
#
|
|
@@ -187,7 +195,7 @@ module Telnyx
|
|
|
187
195
|
optional :updated_at, Time
|
|
188
196
|
end
|
|
189
197
|
|
|
190
|
-
# @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
198
|
+
# @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
191
199
|
# Some parameter documentations has been truncated, see
|
|
192
200
|
# {Telnyx::Models::MessagingMessagingProfile} for more details.
|
|
193
201
|
#
|
|
@@ -205,6 +213,8 @@ module Telnyx
|
|
|
205
213
|
#
|
|
206
214
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
207
215
|
#
|
|
216
|
+
# @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
|
|
217
|
+
#
|
|
208
218
|
# @param health_webhook_url [String, nil] DEPRECATED: health check url service checking
|
|
209
219
|
#
|
|
210
220
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|
|
@@ -53,6 +53,14 @@ module Telnyx
|
|
|
53
53
|
# @return [Boolean, nil]
|
|
54
54
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
55
55
|
|
|
56
|
+
# @!attribute features
|
|
57
|
+
# Telnyx product features the messaging customer can enable on the messaging
|
|
58
|
+
# profile. Keys map to individual feature flags; unknown keys are accepted and
|
|
59
|
+
# preserved for forward compatibility with rolling deployments.
|
|
60
|
+
#
|
|
61
|
+
# @return [Telnyx::Models::MessagingProfileFeatures, nil]
|
|
62
|
+
optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
|
|
63
|
+
|
|
56
64
|
# @!attribute health_webhook_url
|
|
57
65
|
# A URL to receive health check webhooks for numbers in this profile.
|
|
58
66
|
#
|
|
@@ -133,7 +141,7 @@ module Telnyx
|
|
|
133
141
|
# @return [String, nil]
|
|
134
142
|
optional :webhook_url, String, nil?: true
|
|
135
143
|
|
|
136
|
-
# @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
144
|
+
# @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
137
145
|
# Some parameter documentations has been truncated, see
|
|
138
146
|
# {Telnyx::Models::MessagingProfileCreateParams} for more details.
|
|
139
147
|
#
|
|
@@ -151,6 +159,8 @@ module Telnyx
|
|
|
151
159
|
#
|
|
152
160
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
153
161
|
#
|
|
162
|
+
# @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
|
|
163
|
+
#
|
|
154
164
|
# @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
|
|
155
165
|
#
|
|
156
166
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class MessagingProfileFeatures < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute ai_opt_out_detection_enabled
|
|
7
|
+
# Enables AI detection of inbound opt-out messages that do not follow the standard
|
|
8
|
+
# STOP/UNSTOP/HELP opt-out keyword pattern. When enabled, the messaging platform
|
|
9
|
+
# applies an AI model to identify non-standard opt-out requests (e.g.
|
|
10
|
+
# natural-language phrases) and treats them as opt-outs.
|
|
11
|
+
#
|
|
12
|
+
# @return [Boolean, nil]
|
|
13
|
+
optional :ai_opt_out_detection_enabled, Telnyx::Internal::Type::Boolean
|
|
14
|
+
|
|
15
|
+
# @!method initialize(ai_opt_out_detection_enabled: nil)
|
|
16
|
+
# Some parameter documentations has been truncated, see
|
|
17
|
+
# {Telnyx::Models::MessagingProfileFeatures} for more details.
|
|
18
|
+
#
|
|
19
|
+
# Telnyx product features the messaging customer can enable on the messaging
|
|
20
|
+
# profile. Keys map to individual feature flags; unknown keys are accepted and
|
|
21
|
+
# preserved for forward compatibility with rolling deployments.
|
|
22
|
+
#
|
|
23
|
+
# @param ai_opt_out_detection_enabled [Boolean] Enables AI detection of inbound opt-out messages that do not follow the standard
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -44,6 +44,14 @@ module Telnyx
|
|
|
44
44
|
# @return [Boolean, nil]
|
|
45
45
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
46
46
|
|
|
47
|
+
# @!attribute features
|
|
48
|
+
# Telnyx product features the messaging customer can enable on the messaging
|
|
49
|
+
# profile. Keys map to individual feature flags; unknown keys are accepted and
|
|
50
|
+
# preserved for forward compatibility with rolling deployments.
|
|
51
|
+
#
|
|
52
|
+
# @return [Telnyx::Models::MessagingProfileFeatures, nil]
|
|
53
|
+
optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
|
|
54
|
+
|
|
47
55
|
# @!attribute mms_fall_back_to_sms
|
|
48
56
|
# enables SMS fallback for MMS messages.
|
|
49
57
|
#
|
|
@@ -151,7 +159,7 @@ module Telnyx
|
|
|
151
159
|
# @return [Array<String>, nil]
|
|
152
160
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
153
161
|
|
|
154
|
-
# @!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, redaction_enabled: nil, redaction_level: 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: {})
|
|
162
|
+
# @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: 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: {})
|
|
155
163
|
# Some parameter documentations has been truncated, see
|
|
156
164
|
# {Telnyx::Models::MessagingProfileUpdateParams} for more details.
|
|
157
165
|
#
|
|
@@ -167,6 +175,8 @@ module Telnyx
|
|
|
167
175
|
#
|
|
168
176
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
169
177
|
#
|
|
178
|
+
# @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
|
|
179
|
+
#
|
|
170
180
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|
|
171
181
|
#
|
|
172
182
|
# @param mms_transcoding [Boolean] enables automated resizing of MMS media.
|
|
@@ -167,7 +167,10 @@ module Telnyx
|
|
|
167
167
|
|
|
168
168
|
# @!attribute password
|
|
169
169
|
# The password to be used as part of the credentials. Must be 8 to 128 characters
|
|
170
|
-
# long.
|
|
170
|
+
# long. For primary accounts created on or after September 8, 2026, this password
|
|
171
|
+
# is returned as `********`. The password is returned in full on create, and on
|
|
172
|
+
# update only when that update changed the password. Accounts created before
|
|
173
|
+
# September 8, 2026 are unaffected.
|
|
171
174
|
#
|
|
172
175
|
# @return [String, nil]
|
|
173
176
|
optional :password, String
|
|
@@ -32,7 +32,11 @@ module Telnyx
|
|
|
32
32
|
optional :outbound_proxy, String, nil?: true
|
|
33
33
|
|
|
34
34
|
# @!attribute password
|
|
35
|
-
# The SIP password used for digest authentication with the external SIP peer.
|
|
35
|
+
# The SIP password used for digest authentication with the external SIP peer. For
|
|
36
|
+
# primary accounts created on or after September 8, 2026, this password is
|
|
37
|
+
# returned as `********`. The password is returned in full on create, and on
|
|
38
|
+
# update only when that update changed the password. Accounts created before
|
|
39
|
+
# September 8, 2026 are unaffected.
|
|
36
40
|
#
|
|
37
41
|
# @return [String, nil]
|
|
38
42
|
optional :password, String
|
|
@@ -81,7 +85,7 @@ module Telnyx
|
|
|
81
85
|
#
|
|
82
86
|
# @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
|
|
83
87
|
#
|
|
84
|
-
# @param password [String] The SIP password used for digest authentication with the external SIP peer.
|
|
88
|
+
# @param password [String] The SIP password used for digest authentication with the external SIP peer. For
|
|
85
89
|
#
|
|
86
90
|
# @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
|
|
87
91
|
#
|
|
@@ -151,8 +151,12 @@ module Telnyx
|
|
|
151
151
|
|
|
152
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
153
153
|
|
|
154
|
+
variant -> { Telnyx::WhatsappAccountUpdate }
|
|
155
|
+
|
|
156
|
+
variant -> { Telnyx::WhatsappMessageEcho }
|
|
157
|
+
|
|
154
158
|
# @!method self.variants
|
|
155
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
159
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho)]
|
|
156
160
|
end
|
|
157
161
|
end
|
|
158
162
|
end
|
|
@@ -151,8 +151,12 @@ module Telnyx
|
|
|
151
151
|
|
|
152
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
153
153
|
|
|
154
|
+
variant -> { Telnyx::WhatsappAccountUpdate }
|
|
155
|
+
|
|
156
|
+
variant -> { Telnyx::WhatsappMessageEcho }
|
|
157
|
+
|
|
154
158
|
# @!method self.variants
|
|
155
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
159
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho)]
|
|
156
160
|
end
|
|
157
161
|
end
|
|
158
162
|
end
|
|
@@ -11,6 +11,15 @@ module Telnyx
|
|
|
11
11
|
# @return [Boolean, nil]
|
|
12
12
|
optional :calling_enabled, Telnyx::Internal::Type::Boolean
|
|
13
13
|
|
|
14
|
+
# @!attribute coexistence_state
|
|
15
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
16
|
+
# Cloud API number.
|
|
17
|
+
#
|
|
18
|
+
# @return [Symbol, Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState, nil]
|
|
19
|
+
optional :coexistence_state,
|
|
20
|
+
enum: -> { Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState },
|
|
21
|
+
nil?: true
|
|
22
|
+
|
|
14
23
|
# @!attribute created_at
|
|
15
24
|
#
|
|
16
25
|
# @return [Time, nil]
|
|
@@ -26,6 +35,13 @@ module Telnyx
|
|
|
26
35
|
# @return [Boolean, nil]
|
|
27
36
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
28
37
|
|
|
38
|
+
# @!attribute is_on_biz_app
|
|
39
|
+
# Indicates whether the number is connected to both the WhatsApp Business app and
|
|
40
|
+
# Cloud API through WhatsApp Coexistence.
|
|
41
|
+
#
|
|
42
|
+
# @return [Boolean, nil]
|
|
43
|
+
optional :is_on_biz_app, Telnyx::Internal::Type::Boolean
|
|
44
|
+
|
|
29
45
|
# @!attribute phone_number
|
|
30
46
|
# Phone number in E164 format
|
|
31
47
|
#
|
|
@@ -54,6 +70,22 @@ module Telnyx
|
|
|
54
70
|
# @return [String, nil]
|
|
55
71
|
optional :status, String
|
|
56
72
|
|
|
73
|
+
# @!attribute sync_deadline
|
|
74
|
+
# Deadline for initiating the current coexistence synchronization cycle. This is
|
|
75
|
+
# null when no deadline applies.
|
|
76
|
+
#
|
|
77
|
+
# @return [Time, nil]
|
|
78
|
+
optional :sync_deadline, Time, nil?: true
|
|
79
|
+
|
|
80
|
+
# @!attribute sync_progress
|
|
81
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
82
|
+
# number is synchronizing.
|
|
83
|
+
#
|
|
84
|
+
# @return [Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress, nil]
|
|
85
|
+
optional :sync_progress,
|
|
86
|
+
-> { Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress },
|
|
87
|
+
nil?: true
|
|
88
|
+
|
|
57
89
|
# @!attribute user_id
|
|
58
90
|
# User ID
|
|
59
91
|
#
|
|
@@ -66,15 +98,23 @@ module Telnyx
|
|
|
66
98
|
# @return [String, nil]
|
|
67
99
|
optional :waba_id, String
|
|
68
100
|
|
|
69
|
-
# @!method initialize(calling_enabled: nil, created_at: nil, display_name: nil, enabled: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, user_id: nil, waba_id: nil)
|
|
101
|
+
# @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
|
|
102
|
+
# Some parameter documentations has been truncated, see
|
|
103
|
+
# {Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse} for more
|
|
104
|
+
# details.
|
|
105
|
+
#
|
|
70
106
|
# @param calling_enabled [Boolean]
|
|
71
107
|
#
|
|
108
|
+
# @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
|
|
109
|
+
#
|
|
72
110
|
# @param created_at [Time]
|
|
73
111
|
#
|
|
74
112
|
# @param display_name [String]
|
|
75
113
|
#
|
|
76
114
|
# @param enabled [Boolean]
|
|
77
115
|
#
|
|
116
|
+
# @param is_on_biz_app [Boolean] Indicates whether the number is connected to both the WhatsApp Business app and
|
|
117
|
+
#
|
|
78
118
|
# @param phone_number [String] Phone number in E164 format
|
|
79
119
|
#
|
|
80
120
|
# @param phone_number_id [String] Whatsapp phone number ID
|
|
@@ -85,9 +125,72 @@ module Telnyx
|
|
|
85
125
|
#
|
|
86
126
|
# @param status [String]
|
|
87
127
|
#
|
|
128
|
+
# @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
|
|
129
|
+
#
|
|
130
|
+
# @param sync_progress [Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
|
|
131
|
+
#
|
|
88
132
|
# @param user_id [String] User ID
|
|
89
133
|
#
|
|
90
134
|
# @param waba_id [String] WABA ID of Whatsapp business account
|
|
135
|
+
|
|
136
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
137
|
+
# Cloud API number.
|
|
138
|
+
#
|
|
139
|
+
# @see Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse#coexistence_state
|
|
140
|
+
module CoexistenceState
|
|
141
|
+
extend Telnyx::Internal::Type::Enum
|
|
142
|
+
|
|
143
|
+
PENDING_ONBOARDING = :pending_onboarding
|
|
144
|
+
SYNC_PENDING = :sync_pending
|
|
145
|
+
SYNCING = :syncing
|
|
146
|
+
SYNC_COMPLETE = :sync_complete
|
|
147
|
+
ACTIVE = :active
|
|
148
|
+
HISTORY_DECLINED = :history_declined
|
|
149
|
+
SYNC_DEADLINE_EXPIRED = :sync_deadline_expired
|
|
150
|
+
OFFBOARDED = :offboarded
|
|
151
|
+
DISCONNECTED = :disconnected
|
|
152
|
+
|
|
153
|
+
# @!method self.values
|
|
154
|
+
# @return [Array<Symbol>]
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# @see Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse#sync_progress
|
|
158
|
+
class SyncProgress < Telnyx::Internal::Type::BaseModel
|
|
159
|
+
# @!attribute contacts_status
|
|
160
|
+
#
|
|
161
|
+
# @return [String, nil]
|
|
162
|
+
optional :contacts_status, String
|
|
163
|
+
|
|
164
|
+
# @!attribute history_chunk_order
|
|
165
|
+
#
|
|
166
|
+
# @return [Integer, nil]
|
|
167
|
+
optional :history_chunk_order, Integer, nil?: true
|
|
168
|
+
|
|
169
|
+
# @!attribute history_phase
|
|
170
|
+
#
|
|
171
|
+
# @return [Integer, nil]
|
|
172
|
+
optional :history_phase, Integer, nil?: true
|
|
173
|
+
|
|
174
|
+
# @!attribute history_progress
|
|
175
|
+
#
|
|
176
|
+
# @return [Integer, nil]
|
|
177
|
+
optional :history_progress, Integer, nil?: true
|
|
178
|
+
|
|
179
|
+
# @!attribute history_status
|
|
180
|
+
#
|
|
181
|
+
# @return [String, nil]
|
|
182
|
+
optional :history_status, String
|
|
183
|
+
|
|
184
|
+
# @!method initialize(contacts_status: nil, history_chunk_order: nil, history_phase: nil, history_progress: nil, history_status: nil)
|
|
185
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
186
|
+
# number is synchronizing.
|
|
187
|
+
#
|
|
188
|
+
# @param contacts_status [String]
|
|
189
|
+
# @param history_chunk_order [Integer, nil]
|
|
190
|
+
# @param history_phase [Integer, nil]
|
|
191
|
+
# @param history_progress [Integer, nil]
|
|
192
|
+
# @param history_status [String]
|
|
193
|
+
end
|
|
91
194
|
end
|
|
92
195
|
end
|
|
93
196
|
end
|
|
@@ -26,6 +26,15 @@ module Telnyx
|
|
|
26
26
|
# @return [Boolean, nil]
|
|
27
27
|
optional :calling_enabled, Telnyx::Internal::Type::Boolean
|
|
28
28
|
|
|
29
|
+
# @!attribute coexistence_state
|
|
30
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
31
|
+
# Cloud API number.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState, nil]
|
|
34
|
+
optional :coexistence_state,
|
|
35
|
+
enum: -> { Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState },
|
|
36
|
+
nil?: true
|
|
37
|
+
|
|
29
38
|
# @!attribute created_at
|
|
30
39
|
#
|
|
31
40
|
# @return [Time, nil]
|
|
@@ -41,6 +50,13 @@ module Telnyx
|
|
|
41
50
|
# @return [Boolean, nil]
|
|
42
51
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
43
52
|
|
|
53
|
+
# @!attribute is_on_biz_app
|
|
54
|
+
# Indicates whether the number is connected to both the WhatsApp Business app and
|
|
55
|
+
# Cloud API through WhatsApp Coexistence.
|
|
56
|
+
#
|
|
57
|
+
# @return [Boolean, nil]
|
|
58
|
+
optional :is_on_biz_app, Telnyx::Internal::Type::Boolean
|
|
59
|
+
|
|
44
60
|
# @!attribute phone_number
|
|
45
61
|
# Phone number in E164 format
|
|
46
62
|
#
|
|
@@ -69,6 +85,22 @@ module Telnyx
|
|
|
69
85
|
# @return [String, nil]
|
|
70
86
|
optional :status, String
|
|
71
87
|
|
|
88
|
+
# @!attribute sync_deadline
|
|
89
|
+
# Deadline for initiating the current coexistence synchronization cycle. This is
|
|
90
|
+
# null when no deadline applies.
|
|
91
|
+
#
|
|
92
|
+
# @return [Time, nil]
|
|
93
|
+
optional :sync_deadline, Time, nil?: true
|
|
94
|
+
|
|
95
|
+
# @!attribute sync_progress
|
|
96
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
97
|
+
# number is synchronizing.
|
|
98
|
+
#
|
|
99
|
+
# @return [Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress, nil]
|
|
100
|
+
optional :sync_progress,
|
|
101
|
+
-> { Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress },
|
|
102
|
+
nil?: true
|
|
103
|
+
|
|
72
104
|
# @!attribute user_id
|
|
73
105
|
# User ID
|
|
74
106
|
#
|
|
@@ -81,15 +113,22 @@ module Telnyx
|
|
|
81
113
|
# @return [String, nil]
|
|
82
114
|
optional :waba_id, String
|
|
83
115
|
|
|
84
|
-
# @!method initialize(calling_enabled: nil, created_at: nil, display_name: nil, enabled: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, user_id: nil, waba_id: nil)
|
|
116
|
+
# @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
|
|
117
|
+
# Some parameter documentations has been truncated, see
|
|
118
|
+
# {Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data} for more details.
|
|
119
|
+
#
|
|
85
120
|
# @param calling_enabled [Boolean]
|
|
86
121
|
#
|
|
122
|
+
# @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
|
|
123
|
+
#
|
|
87
124
|
# @param created_at [Time]
|
|
88
125
|
#
|
|
89
126
|
# @param display_name [String]
|
|
90
127
|
#
|
|
91
128
|
# @param enabled [Boolean]
|
|
92
129
|
#
|
|
130
|
+
# @param is_on_biz_app [Boolean] Indicates whether the number is connected to both the WhatsApp Business app and
|
|
131
|
+
#
|
|
93
132
|
# @param phone_number [String] Phone number in E164 format
|
|
94
133
|
#
|
|
95
134
|
# @param phone_number_id [String] Whatsapp phone number ID
|
|
@@ -100,9 +139,72 @@ module Telnyx
|
|
|
100
139
|
#
|
|
101
140
|
# @param status [String]
|
|
102
141
|
#
|
|
142
|
+
# @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
|
|
143
|
+
#
|
|
144
|
+
# @param sync_progress [Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
|
|
145
|
+
#
|
|
103
146
|
# @param user_id [String] User ID
|
|
104
147
|
#
|
|
105
148
|
# @param waba_id [String] WABA ID of Whatsapp business account
|
|
149
|
+
|
|
150
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
151
|
+
# Cloud API number.
|
|
152
|
+
#
|
|
153
|
+
# @see Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data#coexistence_state
|
|
154
|
+
module CoexistenceState
|
|
155
|
+
extend Telnyx::Internal::Type::Enum
|
|
156
|
+
|
|
157
|
+
PENDING_ONBOARDING = :pending_onboarding
|
|
158
|
+
SYNC_PENDING = :sync_pending
|
|
159
|
+
SYNCING = :syncing
|
|
160
|
+
SYNC_COMPLETE = :sync_complete
|
|
161
|
+
ACTIVE = :active
|
|
162
|
+
HISTORY_DECLINED = :history_declined
|
|
163
|
+
SYNC_DEADLINE_EXPIRED = :sync_deadline_expired
|
|
164
|
+
OFFBOARDED = :offboarded
|
|
165
|
+
DISCONNECTED = :disconnected
|
|
166
|
+
|
|
167
|
+
# @!method self.values
|
|
168
|
+
# @return [Array<Symbol>]
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# @see Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data#sync_progress
|
|
172
|
+
class SyncProgress < Telnyx::Internal::Type::BaseModel
|
|
173
|
+
# @!attribute contacts_status
|
|
174
|
+
#
|
|
175
|
+
# @return [String, nil]
|
|
176
|
+
optional :contacts_status, String
|
|
177
|
+
|
|
178
|
+
# @!attribute history_chunk_order
|
|
179
|
+
#
|
|
180
|
+
# @return [Integer, nil]
|
|
181
|
+
optional :history_chunk_order, Integer, nil?: true
|
|
182
|
+
|
|
183
|
+
# @!attribute history_phase
|
|
184
|
+
#
|
|
185
|
+
# @return [Integer, nil]
|
|
186
|
+
optional :history_phase, Integer, nil?: true
|
|
187
|
+
|
|
188
|
+
# @!attribute history_progress
|
|
189
|
+
#
|
|
190
|
+
# @return [Integer, nil]
|
|
191
|
+
optional :history_progress, Integer, nil?: true
|
|
192
|
+
|
|
193
|
+
# @!attribute history_status
|
|
194
|
+
#
|
|
195
|
+
# @return [String, nil]
|
|
196
|
+
optional :history_status, String
|
|
197
|
+
|
|
198
|
+
# @!method initialize(contacts_status: nil, history_chunk_order: nil, history_phase: nil, history_progress: nil, history_status: nil)
|
|
199
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
200
|
+
# number is synchronizing.
|
|
201
|
+
#
|
|
202
|
+
# @param contacts_status [String]
|
|
203
|
+
# @param history_chunk_order [Integer, nil]
|
|
204
|
+
# @param history_phase [Integer, nil]
|
|
205
|
+
# @param history_progress [Integer, nil]
|
|
206
|
+
# @param history_status [String]
|
|
207
|
+
end
|
|
106
208
|
end
|
|
107
209
|
end
|
|
108
210
|
end
|
|
@@ -10,6 +10,15 @@ module Telnyx
|
|
|
10
10
|
# @return [Boolean, nil]
|
|
11
11
|
optional :calling_enabled, Telnyx::Internal::Type::Boolean
|
|
12
12
|
|
|
13
|
+
# @!attribute coexistence_state
|
|
14
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
15
|
+
# Cloud API number.
|
|
16
|
+
#
|
|
17
|
+
# @return [Symbol, Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState, nil]
|
|
18
|
+
optional :coexistence_state,
|
|
19
|
+
enum: -> { Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState },
|
|
20
|
+
nil?: true
|
|
21
|
+
|
|
13
22
|
# @!attribute created_at
|
|
14
23
|
#
|
|
15
24
|
# @return [Time, nil]
|
|
@@ -25,6 +34,13 @@ module Telnyx
|
|
|
25
34
|
# @return [Boolean, nil]
|
|
26
35
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
27
36
|
|
|
37
|
+
# @!attribute is_on_biz_app
|
|
38
|
+
# Indicates whether the number is connected to both the WhatsApp Business app and
|
|
39
|
+
# Cloud API through WhatsApp Coexistence.
|
|
40
|
+
#
|
|
41
|
+
# @return [Boolean, nil]
|
|
42
|
+
optional :is_on_biz_app, Telnyx::Internal::Type::Boolean
|
|
43
|
+
|
|
28
44
|
# @!attribute phone_number
|
|
29
45
|
# Phone number in E164 format
|
|
30
46
|
#
|
|
@@ -53,6 +69,22 @@ module Telnyx
|
|
|
53
69
|
# @return [String, nil]
|
|
54
70
|
optional :status, String
|
|
55
71
|
|
|
72
|
+
# @!attribute sync_deadline
|
|
73
|
+
# Deadline for initiating the current coexistence synchronization cycle. This is
|
|
74
|
+
# null when no deadline applies.
|
|
75
|
+
#
|
|
76
|
+
# @return [Time, nil]
|
|
77
|
+
optional :sync_deadline, Time, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!attribute sync_progress
|
|
80
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
81
|
+
# number is synchronizing.
|
|
82
|
+
#
|
|
83
|
+
# @return [Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress, nil]
|
|
84
|
+
optional :sync_progress,
|
|
85
|
+
-> { Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress },
|
|
86
|
+
nil?: true
|
|
87
|
+
|
|
56
88
|
# @!attribute user_id
|
|
57
89
|
# User ID
|
|
58
90
|
#
|
|
@@ -65,15 +97,22 @@ module Telnyx
|
|
|
65
97
|
# @return [String, nil]
|
|
66
98
|
optional :waba_id, String
|
|
67
99
|
|
|
68
|
-
# @!method initialize(calling_enabled: nil, created_at: nil, display_name: nil, enabled: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, user_id: nil, waba_id: nil)
|
|
100
|
+
# @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
|
|
101
|
+
# Some parameter documentations has been truncated, see
|
|
102
|
+
# {Telnyx::Models::Whatsapp::PhoneNumberListResponse} for more details.
|
|
103
|
+
#
|
|
69
104
|
# @param calling_enabled [Boolean]
|
|
70
105
|
#
|
|
106
|
+
# @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
|
|
107
|
+
#
|
|
71
108
|
# @param created_at [Time]
|
|
72
109
|
#
|
|
73
110
|
# @param display_name [String]
|
|
74
111
|
#
|
|
75
112
|
# @param enabled [Boolean]
|
|
76
113
|
#
|
|
114
|
+
# @param is_on_biz_app [Boolean] Indicates whether the number is connected to both the WhatsApp Business app and
|
|
115
|
+
#
|
|
77
116
|
# @param phone_number [String] Phone number in E164 format
|
|
78
117
|
#
|
|
79
118
|
# @param phone_number_id [String] Whatsapp phone number ID
|
|
@@ -84,9 +123,72 @@ module Telnyx
|
|
|
84
123
|
#
|
|
85
124
|
# @param status [String]
|
|
86
125
|
#
|
|
126
|
+
# @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
|
|
127
|
+
#
|
|
128
|
+
# @param sync_progress [Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
|
|
129
|
+
#
|
|
87
130
|
# @param user_id [String] User ID
|
|
88
131
|
#
|
|
89
132
|
# @param waba_id [String] WABA ID of Whatsapp business account
|
|
133
|
+
|
|
134
|
+
# Current lifecycle state for a coexistence number. This is null for a standard
|
|
135
|
+
# Cloud API number.
|
|
136
|
+
#
|
|
137
|
+
# @see Telnyx::Models::Whatsapp::PhoneNumberListResponse#coexistence_state
|
|
138
|
+
module CoexistenceState
|
|
139
|
+
extend Telnyx::Internal::Type::Enum
|
|
140
|
+
|
|
141
|
+
PENDING_ONBOARDING = :pending_onboarding
|
|
142
|
+
SYNC_PENDING = :sync_pending
|
|
143
|
+
SYNCING = :syncing
|
|
144
|
+
SYNC_COMPLETE = :sync_complete
|
|
145
|
+
ACTIVE = :active
|
|
146
|
+
HISTORY_DECLINED = :history_declined
|
|
147
|
+
SYNC_DEADLINE_EXPIRED = :sync_deadline_expired
|
|
148
|
+
OFFBOARDED = :offboarded
|
|
149
|
+
DISCONNECTED = :disconnected
|
|
150
|
+
|
|
151
|
+
# @!method self.values
|
|
152
|
+
# @return [Array<Symbol>]
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# @see Telnyx::Models::Whatsapp::PhoneNumberListResponse#sync_progress
|
|
156
|
+
class SyncProgress < Telnyx::Internal::Type::BaseModel
|
|
157
|
+
# @!attribute contacts_status
|
|
158
|
+
#
|
|
159
|
+
# @return [String, nil]
|
|
160
|
+
optional :contacts_status, String
|
|
161
|
+
|
|
162
|
+
# @!attribute history_chunk_order
|
|
163
|
+
#
|
|
164
|
+
# @return [Integer, nil]
|
|
165
|
+
optional :history_chunk_order, Integer, nil?: true
|
|
166
|
+
|
|
167
|
+
# @!attribute history_phase
|
|
168
|
+
#
|
|
169
|
+
# @return [Integer, nil]
|
|
170
|
+
optional :history_phase, Integer, nil?: true
|
|
171
|
+
|
|
172
|
+
# @!attribute history_progress
|
|
173
|
+
#
|
|
174
|
+
# @return [Integer, nil]
|
|
175
|
+
optional :history_progress, Integer, nil?: true
|
|
176
|
+
|
|
177
|
+
# @!attribute history_status
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :history_status, String
|
|
181
|
+
|
|
182
|
+
# @!method initialize(contacts_status: nil, history_chunk_order: nil, history_phase: nil, history_progress: nil, history_status: nil)
|
|
183
|
+
# Synchronization progress. This object is returned only while a coexistence
|
|
184
|
+
# number is synchronizing.
|
|
185
|
+
#
|
|
186
|
+
# @param contacts_status [String]
|
|
187
|
+
# @param history_chunk_order [Integer, nil]
|
|
188
|
+
# @param history_phase [Integer, nil]
|
|
189
|
+
# @param history_progress [Integer, nil]
|
|
190
|
+
# @param history_status [String]
|
|
191
|
+
end
|
|
90
192
|
end
|
|
91
193
|
end
|
|
92
194
|
end
|