telnyx 5.168.0 → 5.169.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 +40 -0
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +6 -6
- data/lib/telnyx/models/ai/assistant_tool.rb +285 -12
- data/lib/telnyx/models/ai/assistant_update_params.rb +20 -9
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +20 -9
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/flow_node.rb +2 -2
- data/lib/telnyx/models/ai/inference_embedding.rb +13 -10
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +21 -1
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +268 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +222 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models.rb +18 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/typesafe/v1.rb +62 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +4 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_messages.rb +5 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +33 -0
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +16 -12
- data/rbi/telnyx/models/ai/assistant_tool.rbi +423 -20
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +42 -16
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +42 -16
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/flow_node.rbi +4 -2
- data/rbi/telnyx/models/ai/inference_embedding.rbi +24 -16
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +29 -3
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +504 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +348 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models.rbi +21 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +19 -7
- data/rbi/telnyx/resources/ai/assistants.rbi +25 -12
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +61 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +3 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +6 -5
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_messages.rbi +5 -3
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +162 -23
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +10 -3
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +195 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +141 -0
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +17 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- metadata +101 -2
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::Connections#retrieve_count
|
|
6
|
+
class ConnectionRetrieveCountResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::ConnectionRetrieveCountResponse::Data]
|
|
10
|
+
required :data, -> { Telnyx::Models::ConnectionRetrieveCountResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# @param data [Telnyx::Models::ConnectionRetrieveCountResponse::Data]
|
|
14
|
+
|
|
15
|
+
# @see Telnyx::Models::ConnectionRetrieveCountResponse#data
|
|
16
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
17
|
+
# @!attribute counts
|
|
18
|
+
# Counts of the authenticated user's connections, grouped by connection type.
|
|
19
|
+
# Forward-only connections are excluded.
|
|
20
|
+
#
|
|
21
|
+
# @return [Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts]
|
|
22
|
+
required :counts, -> { Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts }
|
|
23
|
+
|
|
24
|
+
# @!attribute limits
|
|
25
|
+
# Connection limits that apply to the user. Contains a single global_limit when a
|
|
26
|
+
# global connection limit applies, or per-type limits (standard_limit, texml_limit
|
|
27
|
+
# and uac_limit) when the user has per-type connection count capabilities.
|
|
28
|
+
#
|
|
29
|
+
# @return [Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit, Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits]
|
|
30
|
+
required :limits, union: -> { Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits }
|
|
31
|
+
|
|
32
|
+
# @!attribute record_type
|
|
33
|
+
# Identifies the type of the resource.
|
|
34
|
+
#
|
|
35
|
+
# @return [String]
|
|
36
|
+
required :record_type, String
|
|
37
|
+
|
|
38
|
+
# @!method initialize(counts:, limits:, record_type:)
|
|
39
|
+
# Some parameter documentations has been truncated, see
|
|
40
|
+
# {Telnyx::Models::ConnectionRetrieveCountResponse::Data} for more details.
|
|
41
|
+
#
|
|
42
|
+
# @param counts [Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts] Counts of the authenticated user's connections, grouped by connection type. Forw
|
|
43
|
+
#
|
|
44
|
+
# @param limits [Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit, Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits] Connection limits that apply to the user. Contains a single global_limit when a
|
|
45
|
+
#
|
|
46
|
+
# @param record_type [String] Identifies the type of the resource.
|
|
47
|
+
|
|
48
|
+
# @see Telnyx::Models::ConnectionRetrieveCountResponse::Data#counts
|
|
49
|
+
class Counts < Telnyx::Internal::Type::BaseModel
|
|
50
|
+
# @!attribute call_control_applications
|
|
51
|
+
# Number of Call Control applications.
|
|
52
|
+
#
|
|
53
|
+
# @return [Integer]
|
|
54
|
+
required :call_control_applications, Integer
|
|
55
|
+
|
|
56
|
+
# @!attribute credential_connections
|
|
57
|
+
# Number of credential connections.
|
|
58
|
+
#
|
|
59
|
+
# @return [Integer]
|
|
60
|
+
required :credential_connections, Integer
|
|
61
|
+
|
|
62
|
+
# @!attribute external_connections
|
|
63
|
+
# Number of external connections.
|
|
64
|
+
#
|
|
65
|
+
# @return [Integer]
|
|
66
|
+
required :external_connections, Integer
|
|
67
|
+
|
|
68
|
+
# @!attribute fax_connections
|
|
69
|
+
# Number of Fax applications.
|
|
70
|
+
#
|
|
71
|
+
# @return [Integer]
|
|
72
|
+
required :fax_connections, Integer
|
|
73
|
+
|
|
74
|
+
# @!attribute fqdn_connections
|
|
75
|
+
# Number of FQDN connections.
|
|
76
|
+
#
|
|
77
|
+
# @return [Integer]
|
|
78
|
+
required :fqdn_connections, Integer
|
|
79
|
+
|
|
80
|
+
# @!attribute ip_connections
|
|
81
|
+
# Number of IP connections.
|
|
82
|
+
#
|
|
83
|
+
# @return [Integer]
|
|
84
|
+
required :ip_connections, Integer
|
|
85
|
+
|
|
86
|
+
# @!attribute microsoft_teams_sbc_connections
|
|
87
|
+
# Number of Microsoft Teams SBC (direct routing) connections.
|
|
88
|
+
#
|
|
89
|
+
# @return [Integer]
|
|
90
|
+
required :microsoft_teams_sbc_connections, Integer
|
|
91
|
+
|
|
92
|
+
# @!attribute mobile_voice_connections
|
|
93
|
+
# Number of mobile voice (IMS) connections.
|
|
94
|
+
#
|
|
95
|
+
# @return [Integer]
|
|
96
|
+
required :mobile_voice_connections, Integer
|
|
97
|
+
|
|
98
|
+
# @!attribute operator_connect_connections
|
|
99
|
+
# Number of Microsoft Operator Connect connections.
|
|
100
|
+
#
|
|
101
|
+
# @return [Integer]
|
|
102
|
+
required :operator_connect_connections, Integer
|
|
103
|
+
|
|
104
|
+
# @!attribute texml_applications
|
|
105
|
+
# Number of TeXML applications.
|
|
106
|
+
#
|
|
107
|
+
# @return [Integer]
|
|
108
|
+
required :texml_applications, Integer
|
|
109
|
+
|
|
110
|
+
# @!attribute third_party_provider_connections
|
|
111
|
+
# Number of third-party provider connections.
|
|
112
|
+
#
|
|
113
|
+
# @return [Integer]
|
|
114
|
+
required :third_party_provider_connections, Integer
|
|
115
|
+
|
|
116
|
+
# @!attribute uac_connections
|
|
117
|
+
# Number of UAC connections.
|
|
118
|
+
#
|
|
119
|
+
# @return [Integer]
|
|
120
|
+
required :uac_connections, Integer
|
|
121
|
+
|
|
122
|
+
# @!attribute zoom_sbc_connections
|
|
123
|
+
# Number of Zoom SBC connections.
|
|
124
|
+
#
|
|
125
|
+
# @return [Integer]
|
|
126
|
+
required :zoom_sbc_connections, Integer
|
|
127
|
+
|
|
128
|
+
# @!method initialize(call_control_applications:, credential_connections:, external_connections:, fax_connections:, fqdn_connections:, ip_connections:, microsoft_teams_sbc_connections:, mobile_voice_connections:, operator_connect_connections:, texml_applications:, third_party_provider_connections:, uac_connections:, zoom_sbc_connections:)
|
|
129
|
+
# Counts of the authenticated user's connections, grouped by connection type.
|
|
130
|
+
# Forward-only connections are excluded.
|
|
131
|
+
#
|
|
132
|
+
# @param call_control_applications [Integer] Number of Call Control applications.
|
|
133
|
+
#
|
|
134
|
+
# @param credential_connections [Integer] Number of credential connections.
|
|
135
|
+
#
|
|
136
|
+
# @param external_connections [Integer] Number of external connections.
|
|
137
|
+
#
|
|
138
|
+
# @param fax_connections [Integer] Number of Fax applications.
|
|
139
|
+
#
|
|
140
|
+
# @param fqdn_connections [Integer] Number of FQDN connections.
|
|
141
|
+
#
|
|
142
|
+
# @param ip_connections [Integer] Number of IP connections.
|
|
143
|
+
#
|
|
144
|
+
# @param microsoft_teams_sbc_connections [Integer] Number of Microsoft Teams SBC (direct routing) connections.
|
|
145
|
+
#
|
|
146
|
+
# @param mobile_voice_connections [Integer] Number of mobile voice (IMS) connections.
|
|
147
|
+
#
|
|
148
|
+
# @param operator_connect_connections [Integer] Number of Microsoft Operator Connect connections.
|
|
149
|
+
#
|
|
150
|
+
# @param texml_applications [Integer] Number of TeXML applications.
|
|
151
|
+
#
|
|
152
|
+
# @param third_party_provider_connections [Integer] Number of third-party provider connections.
|
|
153
|
+
#
|
|
154
|
+
# @param uac_connections [Integer] Number of UAC connections.
|
|
155
|
+
#
|
|
156
|
+
# @param zoom_sbc_connections [Integer] Number of Zoom SBC connections.
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Connection limits that apply to the user. Contains a single global_limit when a
|
|
160
|
+
# global connection limit applies, or per-type limits (standard_limit, texml_limit
|
|
161
|
+
# and uac_limit) when the user has per-type connection count capabilities.
|
|
162
|
+
#
|
|
163
|
+
# @see Telnyx::Models::ConnectionRetrieveCountResponse::Data#limits
|
|
164
|
+
module Limits
|
|
165
|
+
extend Telnyx::Internal::Type::Union
|
|
166
|
+
|
|
167
|
+
variant -> { Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit }
|
|
168
|
+
|
|
169
|
+
variant -> { Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits }
|
|
170
|
+
|
|
171
|
+
class GlobalConnectionLimit < Telnyx::Internal::Type::BaseModel
|
|
172
|
+
# @!attribute global_limit
|
|
173
|
+
# Maximum total number of connections allowed, when a global limit applies.
|
|
174
|
+
#
|
|
175
|
+
# @return [Integer]
|
|
176
|
+
required :global_limit, Integer
|
|
177
|
+
|
|
178
|
+
# @!method initialize(global_limit:)
|
|
179
|
+
# @param global_limit [Integer] Maximum total number of connections allowed, when a global limit applies.
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
class PerTypeConnectionLimits < Telnyx::Internal::Type::BaseModel
|
|
183
|
+
# @!attribute standard_limit
|
|
184
|
+
# Maximum number of standard connections allowed, when per-type limits apply.
|
|
185
|
+
#
|
|
186
|
+
# @return [Integer]
|
|
187
|
+
required :standard_limit, Integer
|
|
188
|
+
|
|
189
|
+
# @!attribute texml_limit
|
|
190
|
+
# Maximum number of TeXML applications allowed, when per-type limits apply.
|
|
191
|
+
#
|
|
192
|
+
# @return [Integer]
|
|
193
|
+
required :texml_limit, Integer
|
|
194
|
+
|
|
195
|
+
# @!attribute uac_limit
|
|
196
|
+
# Maximum number of UAC connections allowed, when per-type limits apply.
|
|
197
|
+
#
|
|
198
|
+
# @return [Integer]
|
|
199
|
+
required :uac_limit, Integer
|
|
200
|
+
|
|
201
|
+
# @!method initialize(standard_limit:, texml_limit:, uac_limit:)
|
|
202
|
+
# @param standard_limit [Integer] Maximum number of standard connections allowed, when per-type limits apply.
|
|
203
|
+
#
|
|
204
|
+
# @param texml_limit [Integer] Maximum number of TeXML applications allowed, when per-type limits apply.
|
|
205
|
+
#
|
|
206
|
+
# @param uac_limit [Integer] Maximum number of UAC connections allowed, when per-type limits apply.
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# @!method self.variants
|
|
210
|
+
# @return [Array(Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit, Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits)]
|
|
211
|
+
end
|
|
212
|
+
end
|
|
213
|
+
end
|
|
214
|
+
end
|
|
215
|
+
end
|
|
@@ -10,6 +10,12 @@ module Telnyx
|
|
|
10
10
|
# @!attribute filter
|
|
11
11
|
# Filter records on a given record attribute and value. <br/>Example:
|
|
12
12
|
# filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
|
|
13
|
+
# <br/>The valid filter fields depend on the record_type: filtering by a field
|
|
14
|
+
# that does not exist for the selected record_type is rejected with a 400 error.
|
|
15
|
+
# Call-control and sip-trunking records use started_at, finished_at and
|
|
16
|
+
# answered_at (they have no created_at); messaging records use created_at. To list
|
|
17
|
+
# the fields available for a record_type, use the /v2/detail_records/options
|
|
18
|
+
# endpoint.
|
|
13
19
|
#
|
|
14
20
|
# @return [Telnyx::Models::DetailRecordListParams::Filter, nil]
|
|
15
21
|
optional :filter, -> { Telnyx::DetailRecordListParams::Filter }
|
|
@@ -25,7 +31,12 @@ module Telnyx
|
|
|
25
31
|
optional :page_size, Integer
|
|
26
32
|
|
|
27
33
|
# @!attribute sort
|
|
28
|
-
# Specifies the sort order for results. <br/>Example: sort=-created_at
|
|
34
|
+
# Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
|
|
35
|
+
# valid sort fields depend on the record_type: sort by a field that does not exist
|
|
36
|
+
# for the selected record_type is rejected with a 400 error. Call-control and
|
|
37
|
+
# sip-trunking records use started_at, finished_at and answered_at (they have no
|
|
38
|
+
# created_at); messaging records use created_at. To list the fields available for
|
|
39
|
+
# a record_type, use the /v2/detail_records/options endpoint.
|
|
29
40
|
#
|
|
30
41
|
# @return [Array<String>, nil]
|
|
31
42
|
optional :sort, Telnyx::Internal::Type::ArrayOf[String]
|
|
@@ -40,7 +51,7 @@ module Telnyx
|
|
|
40
51
|
#
|
|
41
52
|
# @param page_size [Integer]
|
|
42
53
|
#
|
|
43
|
-
# @param sort [Array<String>] Specifies the sort order for results. <br/>Example: sort=-created_at
|
|
54
|
+
# @param sort [Array<String>] Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The va
|
|
44
55
|
#
|
|
45
56
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
46
57
|
|
|
@@ -64,6 +75,12 @@ module Telnyx
|
|
|
64
75
|
#
|
|
65
76
|
# Filter records on a given record attribute and value. <br/>Example:
|
|
66
77
|
# filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
|
|
78
|
+
# <br/>The valid filter fields depend on the record_type: filtering by a field
|
|
79
|
+
# that does not exist for the selected record_type is rejected with a 400 error.
|
|
80
|
+
# Call-control and sip-trunking records use started_at, finished_at and
|
|
81
|
+
# answered_at (they have no created_at); messaging records use created_at. To list
|
|
82
|
+
# the fields available for a record_type, use the /v2/detail_records/options
|
|
83
|
+
# endpoint.
|
|
67
84
|
#
|
|
68
85
|
# @param record_type [Symbol, Telnyx::Models::DetailRecordListParams::Filter::RecordType] Filter by the given record type.
|
|
69
86
|
#
|
|
@@ -5,78 +5,11 @@ module Telnyx
|
|
|
5
5
|
class InboundMessageWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute data
|
|
7
7
|
#
|
|
8
|
-
# @return [Telnyx::Models::
|
|
9
|
-
optional :data, -> { Telnyx::
|
|
8
|
+
# @return [Telnyx::Models::MessagingInboundMessage, nil]
|
|
9
|
+
optional :data, -> { Telnyx::MessagingInboundMessage }
|
|
10
10
|
|
|
11
11
|
# @!method initialize(data: nil)
|
|
12
|
-
# @param data [Telnyx::Models::
|
|
13
|
-
|
|
14
|
-
# @see Telnyx::Models::InboundMessageWebhookEvent#data
|
|
15
|
-
class Data < Telnyx::Internal::Type::BaseModel
|
|
16
|
-
# @!attribute id
|
|
17
|
-
# Identifies the type of resource.
|
|
18
|
-
#
|
|
19
|
-
# @return [String, nil]
|
|
20
|
-
optional :id, String
|
|
21
|
-
|
|
22
|
-
# @!attribute event_type
|
|
23
|
-
# The type of event being delivered.
|
|
24
|
-
#
|
|
25
|
-
# @return [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::EventType, nil]
|
|
26
|
-
optional :event_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::EventType }
|
|
27
|
-
|
|
28
|
-
# @!attribute occurred_at
|
|
29
|
-
# ISO 8601 formatted date indicating when the resource was created.
|
|
30
|
-
#
|
|
31
|
-
# @return [Time, nil]
|
|
32
|
-
optional :occurred_at, Time
|
|
33
|
-
|
|
34
|
-
# @!attribute payload
|
|
35
|
-
#
|
|
36
|
-
# @return [Telnyx::Models::MessagingInboundMessagePayload, nil]
|
|
37
|
-
optional :payload, -> { Telnyx::MessagingInboundMessagePayload }
|
|
38
|
-
|
|
39
|
-
# @!attribute record_type
|
|
40
|
-
# Identifies the type of the resource.
|
|
41
|
-
#
|
|
42
|
-
# @return [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::RecordType, nil]
|
|
43
|
-
optional :record_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::RecordType }
|
|
44
|
-
|
|
45
|
-
# @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
|
|
46
|
-
# @param id [String] Identifies the type of resource.
|
|
47
|
-
#
|
|
48
|
-
# @param event_type [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::EventType] The type of event being delivered.
|
|
49
|
-
#
|
|
50
|
-
# @param occurred_at [Time] ISO 8601 formatted date indicating when the resource was created.
|
|
51
|
-
#
|
|
52
|
-
# @param payload [Telnyx::Models::MessagingInboundMessagePayload]
|
|
53
|
-
#
|
|
54
|
-
# @param record_type [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::RecordType] Identifies the type of the resource.
|
|
55
|
-
|
|
56
|
-
# The type of event being delivered.
|
|
57
|
-
#
|
|
58
|
-
# @see Telnyx::Models::InboundMessageWebhookEvent::Data#event_type
|
|
59
|
-
module EventType
|
|
60
|
-
extend Telnyx::Internal::Type::Enum
|
|
61
|
-
|
|
62
|
-
MESSAGE_RECEIVED = :"message.received"
|
|
63
|
-
|
|
64
|
-
# @!method self.values
|
|
65
|
-
# @return [Array<Symbol>]
|
|
66
|
-
end
|
|
67
|
-
|
|
68
|
-
# Identifies the type of the resource.
|
|
69
|
-
#
|
|
70
|
-
# @see Telnyx::Models::InboundMessageWebhookEvent::Data#record_type
|
|
71
|
-
module RecordType
|
|
72
|
-
extend Telnyx::Internal::Type::Enum
|
|
73
|
-
|
|
74
|
-
EVENT = :event
|
|
75
|
-
|
|
76
|
-
# @!method self.values
|
|
77
|
-
# @return [Array<Symbol>]
|
|
78
|
-
end
|
|
79
|
-
end
|
|
12
|
+
# @param data [Telnyx::Models::MessagingInboundMessage]
|
|
80
13
|
end
|
|
81
14
|
end
|
|
82
15
|
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MachinePayments#account_credit
|
|
6
|
+
class MachinePaymentAccountCreditParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute amount_usd
|
|
11
|
+
# Amount to credit in USD, as a decimal string with up to two fractional digits
|
|
12
|
+
# (by default between 5.00 and 500.00). The request body is required on the
|
|
13
|
+
# initial challenge request and remains required on a paid retry, where you
|
|
14
|
+
# re-send the identical body plus the payment credential — the credential, not the
|
|
15
|
+
# body, selects the payment, and the retried body is not re-validated.
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :amount_usd, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(amount_usd:, request_options: {})
|
|
21
|
+
# Some parameter documentations has been truncated, see
|
|
22
|
+
# {Telnyx::Models::MachinePaymentAccountCreditParams} for more details.
|
|
23
|
+
#
|
|
24
|
+
# @param amount_usd [String] Amount to credit in USD, as a decimal string with up to two fractional digits (b
|
|
25
|
+
#
|
|
26
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::MachinePayments#account_credit
|
|
6
|
+
class MachinePaymentAccountCreditResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# An account-credit transaction settled through the Machine Payment Protocol.
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::MachinePaymentAccountCreditResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::MachinePaymentAccountCreditResponse::Data] An account-credit transaction settled through the Machine Payment Protocol.
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute id
|
|
19
|
+
# Unique identifier of the account-credit transaction.
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute account_id
|
|
25
|
+
# Identifier of the credited Telnyx account. Derived from the authenticated user
|
|
26
|
+
# on the initial request and from the verified payment credential on a paid retry
|
|
27
|
+
# — never from the request body.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :account_id, String
|
|
31
|
+
|
|
32
|
+
# @!attribute amount
|
|
33
|
+
# Credited amount as a decimal string with two fractional digits.
|
|
34
|
+
#
|
|
35
|
+
# @return [String]
|
|
36
|
+
required :amount, String
|
|
37
|
+
|
|
38
|
+
# @!attribute currency
|
|
39
|
+
# ISO 4217 currency code of the credited amount (currently always USD).
|
|
40
|
+
#
|
|
41
|
+
# @return [String]
|
|
42
|
+
required :currency, String
|
|
43
|
+
|
|
44
|
+
# @!attribute payment_source
|
|
45
|
+
# Payment source identifier distinguishing machine payments from other
|
|
46
|
+
# account-credit sources.
|
|
47
|
+
#
|
|
48
|
+
# @return [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentSource]
|
|
49
|
+
required :payment_source,
|
|
50
|
+
enum: -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentSource }
|
|
51
|
+
|
|
52
|
+
# @!attribute record_type
|
|
53
|
+
# Record type identifier.
|
|
54
|
+
#
|
|
55
|
+
# @return [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::RecordType]
|
|
56
|
+
required :record_type, enum: -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data::RecordType }
|
|
57
|
+
|
|
58
|
+
# @!attribute created
|
|
59
|
+
# True when this response created a new account credit, false when an existing
|
|
60
|
+
# transaction was returned for a duplicate paid retry.
|
|
61
|
+
#
|
|
62
|
+
# @return [Boolean, nil]
|
|
63
|
+
optional :created, Telnyx::Internal::Type::Boolean
|
|
64
|
+
|
|
65
|
+
# @!attribute created_at
|
|
66
|
+
# ISO 8601 timestamp when the transaction was created.
|
|
67
|
+
#
|
|
68
|
+
# @return [Time, nil]
|
|
69
|
+
optional :created_at, Time
|
|
70
|
+
|
|
71
|
+
# @!attribute mpp_resource
|
|
72
|
+
# Machine Payment Protocol resource identifier the payment credential was bound
|
|
73
|
+
# to.
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :mpp_resource, String, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute payment_intent_id
|
|
79
|
+
# Stripe PaymentIntent identifier for Stripe settlements. Absent for Tempo
|
|
80
|
+
# settlements.
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :payment_intent_id, String, nil?: true
|
|
84
|
+
|
|
85
|
+
# @!attribute payment_method
|
|
86
|
+
# Payment method used by the provider: `stripe_spt` for Stripe Shared Payment
|
|
87
|
+
# Token payments, `tempo_usdc` for Tempo USDC payments.
|
|
88
|
+
#
|
|
89
|
+
# @return [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentMethod, nil]
|
|
90
|
+
optional :payment_method,
|
|
91
|
+
enum: -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentMethod },
|
|
92
|
+
nil?: true
|
|
93
|
+
|
|
94
|
+
# @!attribute provider
|
|
95
|
+
# Upstream payment provider that settled the payment.
|
|
96
|
+
#
|
|
97
|
+
# @return [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Provider, nil]
|
|
98
|
+
optional :provider,
|
|
99
|
+
enum: -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Provider },
|
|
100
|
+
nil?: true
|
|
101
|
+
|
|
102
|
+
# @!attribute receipt_reference
|
|
103
|
+
# Provider receipt reference: the Stripe PaymentIntent identifier for Stripe
|
|
104
|
+
# settlements, or the on-chain transaction hash for Tempo settlements.
|
|
105
|
+
#
|
|
106
|
+
# @return [String, nil]
|
|
107
|
+
optional :receipt_reference, String, nil?: true
|
|
108
|
+
|
|
109
|
+
# @!attribute status
|
|
110
|
+
# Status of the transaction. Successful machine payment credits are recorded as
|
|
111
|
+
# `settled`.
|
|
112
|
+
#
|
|
113
|
+
# @return [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Status, nil]
|
|
114
|
+
optional :status,
|
|
115
|
+
enum: -> { Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Status },
|
|
116
|
+
nil?: true
|
|
117
|
+
|
|
118
|
+
# @!method initialize(id:, account_id:, amount:, currency:, payment_source:, record_type:, created: nil, created_at: nil, mpp_resource: nil, payment_intent_id: nil, payment_method: nil, provider: nil, receipt_reference: nil, status: nil)
|
|
119
|
+
# Some parameter documentations has been truncated, see
|
|
120
|
+
# {Telnyx::Models::MachinePaymentAccountCreditResponse::Data} for more details.
|
|
121
|
+
#
|
|
122
|
+
# An account-credit transaction settled through the Machine Payment Protocol.
|
|
123
|
+
#
|
|
124
|
+
# @param id [String] Unique identifier of the account-credit transaction.
|
|
125
|
+
#
|
|
126
|
+
# @param account_id [String] Identifier of the credited Telnyx account. Derived from the authenticated user o
|
|
127
|
+
#
|
|
128
|
+
# @param amount [String] Credited amount as a decimal string with two fractional digits.
|
|
129
|
+
#
|
|
130
|
+
# @param currency [String] ISO 4217 currency code of the credited amount (currently always USD).
|
|
131
|
+
#
|
|
132
|
+
# @param payment_source [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentSource] Payment source identifier distinguishing machine payments from other account-cre
|
|
133
|
+
#
|
|
134
|
+
# @param record_type [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::RecordType] Record type identifier.
|
|
135
|
+
#
|
|
136
|
+
# @param created [Boolean] True when this response created a new account credit, false when an existing tra
|
|
137
|
+
#
|
|
138
|
+
# @param created_at [Time] ISO 8601 timestamp when the transaction was created.
|
|
139
|
+
#
|
|
140
|
+
# @param mpp_resource [String, nil] Machine Payment Protocol resource identifier the payment credential was bound to
|
|
141
|
+
#
|
|
142
|
+
# @param payment_intent_id [String, nil] Stripe PaymentIntent identifier for Stripe settlements. Absent for Tempo settlem
|
|
143
|
+
#
|
|
144
|
+
# @param payment_method [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::PaymentMethod, nil] Payment method used by the provider: `stripe_spt` for Stripe Shared Payment Toke
|
|
145
|
+
#
|
|
146
|
+
# @param provider [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Provider, nil] Upstream payment provider that settled the payment.
|
|
147
|
+
#
|
|
148
|
+
# @param receipt_reference [String, nil] Provider receipt reference: the Stripe PaymentIntent identifier for Stripe settl
|
|
149
|
+
#
|
|
150
|
+
# @param status [Symbol, Telnyx::Models::MachinePaymentAccountCreditResponse::Data::Status, nil] Status of the transaction. Successful machine payment credits are recorded as `s
|
|
151
|
+
|
|
152
|
+
# Payment source identifier distinguishing machine payments from other
|
|
153
|
+
# account-credit sources.
|
|
154
|
+
#
|
|
155
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse::Data#payment_source
|
|
156
|
+
module PaymentSource
|
|
157
|
+
extend Telnyx::Internal::Type::Enum
|
|
158
|
+
|
|
159
|
+
MACHINE_PAYMENT = :machine_payment
|
|
160
|
+
|
|
161
|
+
# @!method self.values
|
|
162
|
+
# @return [Array<Symbol>]
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Record type identifier.
|
|
166
|
+
#
|
|
167
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse::Data#record_type
|
|
168
|
+
module RecordType
|
|
169
|
+
extend Telnyx::Internal::Type::Enum
|
|
170
|
+
|
|
171
|
+
MACHINE_PAYMENT_ACCOUNT_CREDIT = :machine_payment_account_credit
|
|
172
|
+
|
|
173
|
+
# @!method self.values
|
|
174
|
+
# @return [Array<Symbol>]
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Payment method used by the provider: `stripe_spt` for Stripe Shared Payment
|
|
178
|
+
# Token payments, `tempo_usdc` for Tempo USDC payments.
|
|
179
|
+
#
|
|
180
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse::Data#payment_method
|
|
181
|
+
module PaymentMethod
|
|
182
|
+
extend Telnyx::Internal::Type::Enum
|
|
183
|
+
|
|
184
|
+
STRIPE_SPT = :stripe_spt
|
|
185
|
+
TEMPO_USDC = :tempo_usdc
|
|
186
|
+
|
|
187
|
+
# @!method self.values
|
|
188
|
+
# @return [Array<Symbol>]
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Upstream payment provider that settled the payment.
|
|
192
|
+
#
|
|
193
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse::Data#provider
|
|
194
|
+
module Provider
|
|
195
|
+
extend Telnyx::Internal::Type::Enum
|
|
196
|
+
|
|
197
|
+
STRIPE = :stripe
|
|
198
|
+
TEMPO = :tempo
|
|
199
|
+
|
|
200
|
+
# @!method self.values
|
|
201
|
+
# @return [Array<Symbol>]
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
# Status of the transaction. Successful machine payment credits are recorded as
|
|
205
|
+
# `settled`.
|
|
206
|
+
#
|
|
207
|
+
# @see Telnyx::Models::MachinePaymentAccountCreditResponse::Data#status
|
|
208
|
+
module Status
|
|
209
|
+
extend Telnyx::Internal::Type::Enum
|
|
210
|
+
|
|
211
|
+
NEW = :new
|
|
212
|
+
PROCESSING = :processing
|
|
213
|
+
SETTLED = :settled
|
|
214
|
+
EXPIRED = :expired
|
|
215
|
+
INVALID = :invalid
|
|
216
|
+
|
|
217
|
+
# @!method self.values
|
|
218
|
+
# @return [Array<Symbol>]
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
end
|
|
@@ -6,11 +6,11 @@ module Telnyx
|
|
|
6
6
|
class MessageRetrieveGroupMessagesResponse < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
|
-
# @return [Array<Telnyx::Models::
|
|
10
|
-
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
9
|
+
# @return [Array<Telnyx::Models::OutboundMessagePayload>, nil]
|
|
10
|
+
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::OutboundMessagePayload] }
|
|
11
11
|
|
|
12
12
|
# @!method initialize(data: nil)
|
|
13
|
-
# @param data [Array<Telnyx::Models::
|
|
13
|
+
# @param data [Array<Telnyx::Models::OutboundMessagePayload>]
|
|
14
14
|
end
|
|
15
15
|
end
|
|
16
16
|
end
|
|
@@ -6,11 +6,11 @@ module Telnyx
|
|
|
6
6
|
class MessageRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
|
-
# @return [Telnyx::Models::
|
|
9
|
+
# @return [Telnyx::Models::OutboundMessagePayload, Telnyx::Models::MessagingInboundMessagePayload, nil]
|
|
10
10
|
optional :data, union: -> { Telnyx::Models::MessageRetrieveResponse::Data }
|
|
11
11
|
|
|
12
12
|
# @!method initialize(data: nil)
|
|
13
|
-
# @param data [Telnyx::Models::
|
|
13
|
+
# @param data [Telnyx::Models::OutboundMessagePayload, Telnyx::Models::MessagingInboundMessagePayload]
|
|
14
14
|
|
|
15
15
|
# @see Telnyx::Models::MessageRetrieveResponse#data
|
|
16
16
|
module Data
|
|
@@ -18,12 +18,12 @@ module Telnyx
|
|
|
18
18
|
|
|
19
19
|
discriminator :direction
|
|
20
20
|
|
|
21
|
-
variant :outbound, -> { Telnyx::
|
|
21
|
+
variant :outbound, -> { Telnyx::OutboundMessagePayload }
|
|
22
22
|
|
|
23
23
|
variant :inbound, -> { Telnyx::MessagingInboundMessagePayload }
|
|
24
24
|
|
|
25
25
|
# @!method self.variants
|
|
26
|
-
# @return [Array(Telnyx::Models::
|
|
26
|
+
# @return [Array(Telnyx::Models::OutboundMessagePayload, Telnyx::Models::MessagingInboundMessagePayload)]
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
end
|
|
@@ -6,11 +6,11 @@ module Telnyx
|
|
|
6
6
|
class MessageScheduleResponse < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
|
-
# @return [Telnyx::Models::
|
|
10
|
-
optional :data, -> { Telnyx::
|
|
9
|
+
# @return [Telnyx::Models::OutboundMessagePayload, nil]
|
|
10
|
+
optional :data, -> { Telnyx::OutboundMessagePayload }
|
|
11
11
|
|
|
12
12
|
# @!method initialize(data: nil)
|
|
13
|
-
# @param data [Telnyx::Models::
|
|
13
|
+
# @param data [Telnyx::Models::OutboundMessagePayload]
|
|
14
14
|
end
|
|
15
15
|
end
|
|
16
16
|
end
|
|
@@ -6,11 +6,11 @@ module Telnyx
|
|
|
6
6
|
class MessageSendGroupMmsResponse < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
|
-
# @return [Telnyx::Models::
|
|
10
|
-
optional :data, -> { Telnyx::
|
|
9
|
+
# @return [Telnyx::Models::OutboundMessagePayload, nil]
|
|
10
|
+
optional :data, -> { Telnyx::OutboundMessagePayload }
|
|
11
11
|
|
|
12
12
|
# @!method initialize(data: nil)
|
|
13
|
-
# @param data [Telnyx::Models::
|
|
13
|
+
# @param data [Telnyx::Models::OutboundMessagePayload]
|
|
14
14
|
end
|
|
15
15
|
end
|
|
16
16
|
end
|