telnyx 5.0.0 → 5.1.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 +38 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -0
- data/lib/telnyx/internal/type/union.rb +1 -1
- data/lib/telnyx/models/ai/assistant.rb +39 -4
- data/lib/telnyx/models/ai/assistant_create_params.rb +187 -6
- data/lib/telnyx/models/ai/assistant_imports_params.rb +10 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +400 -3
- data/lib/telnyx/models/ai/assistant_update_params.rb +187 -6
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +189 -6
- data/lib/telnyx/models/ai/bucket_ids.rb +7 -1
- data/lib/telnyx/models/ai/chat_create_completion_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +187 -6
- data/lib/telnyx/models/ai/messaging_settings.rb +10 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +3 -3
- data/lib/telnyx/models/ai/telephony_settings.rb +142 -1
- data/lib/telnyx/models/ai/transfer_tool.rb +46 -3
- data/lib/telnyx/models/ai/voice_settings.rb +1 -1
- data/lib/telnyx/models/ai/webhook_tool.rb +256 -3
- data/lib/telnyx/models/call_control_application_list_params.rb +16 -18
- data/lib/telnyx/models/call_event_list_params.rb +16 -18
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +289 -0
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_response.rb +18 -0
- data/lib/telnyx/models/calls/action_start_noise_suppression_params.rb +7 -4
- data/lib/telnyx/models/conference_list_params.rb +16 -18
- data/lib/telnyx/models/conference_list_participants_params.rb +16 -18
- data/lib/telnyx/models/connection_list_active_calls_params.rb +16 -18
- data/lib/telnyx/models/fax_create_params.rb +10 -1
- data/lib/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rb +1 -9
- data/lib/telnyx/models/messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +14 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +17 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +17 -1
- data/lib/telnyx/models/organizations/user_get_groups_report_params.rb +32 -0
- data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +132 -0
- data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +118 -0
- data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +129 -0
- data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +133 -0
- data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
- data/lib/telnyx/models/queues/call_list_params.rb +16 -18
- data/lib/telnyx/models/sim_card_list_params.rb +11 -3
- data/lib/telnyx/models/texml/accounts/queue_list_params.rb +64 -0
- data/lib/telnyx/models/texml/accounts/queue_list_response.rb +155 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models/unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models.rb +2 -6
- data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +18 -16
- data/lib/telnyx/resources/ai/assistants.rb +15 -9
- data/lib/telnyx/resources/ai/clusters.rb +1 -1
- data/lib/telnyx/resources/ai/embeddings.rb +1 -1
- data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +1 -1
- data/lib/telnyx/resources/call_control_applications.rb +8 -4
- data/lib/telnyx/resources/call_events.rb +8 -4
- data/lib/telnyx/resources/calls/actions.rb +31 -0
- data/lib/telnyx/resources/conferences.rb +16 -8
- data/lib/telnyx/resources/connections.rb +8 -4
- data/lib/telnyx/resources/faxes.rb +3 -1
- data/lib/telnyx/resources/messages.rb +1 -1
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +10 -14
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +6 -6
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +6 -2
- data/lib/telnyx/resources/operator_connect/actions.rb +1 -1
- data/lib/telnyx/resources/organizations/users/actions.rb +38 -0
- data/lib/telnyx/resources/organizations/users.rb +114 -0
- data/lib/telnyx/resources/organizations.rb +18 -0
- data/lib/telnyx/resources/phone_numbers/jobs.rb +1 -1
- data/lib/telnyx/resources/queues/calls.rb +8 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
- data/lib/telnyx/resources/texml/accounts/calls/recordings.rb +1 -1
- data/lib/telnyx/resources/texml/accounts/queues.rb +41 -0
- data/lib/telnyx/resources/usage_reports.rb +2 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +15 -69
- data/rbi/telnyx/client.rbi +3 -0
- data/rbi/telnyx/models/ai/assistant.rbi +91 -5
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +449 -14
- data/rbi/telnyx/models/ai/assistant_imports_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +910 -2
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +449 -14
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +454 -17
- data/rbi/telnyx/models/ai/bucket_ids.rbi +6 -0
- data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +6 -13
- data/rbi/telnyx/models/ai/inference_embedding.rbi +447 -13
- data/rbi/telnyx/models/ai/messaging_settings.rbi +13 -0
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +4 -8
- data/rbi/telnyx/models/ai/telephony_settings.rbi +347 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +87 -6
- data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
- data/rbi/telnyx/models/ai/webhook_tool.rbi +584 -8
- data/rbi/telnyx/models/call_control_application_list_params.rbi +23 -35
- data/rbi/telnyx/models/call_event_list_params.rbi +23 -35
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +583 -0
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_response.rbi +39 -0
- data/rbi/telnyx/models/calls/action_start_noise_suppression_params.rbi +14 -6
- data/rbi/telnyx/models/conference_list_params.rbi +23 -35
- data/rbi/telnyx/models/conference_list_participants_params.rbi +23 -35
- data/rbi/telnyx/models/connection_list_active_calls_params.rbi +23 -35
- data/rbi/telnyx/models/fax_create_params.rbi +13 -0
- data/rbi/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbi +5 -21
- data/rbi/telnyx/models/messaging_profile.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +12 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +10 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +10 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi +93 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +253 -0
- data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +231 -0
- data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +275 -0
- data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +282 -0
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
- data/rbi/telnyx/models/queues/call_list_params.rbi +23 -35
- data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
- data/rbi/telnyx/models/texml/accounts/queue_list_params.rbi +103 -0
- data/rbi/telnyx/models/texml/accounts/queue_list_response.rbi +269 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models.rbi +2 -6
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +26 -19
- data/rbi/telnyx/resources/ai/assistants.rbi +32 -14
- data/rbi/telnyx/resources/ai/chat.rbi +1 -1
- data/rbi/telnyx/resources/ai/clusters.rbi +1 -1
- data/rbi/telnyx/resources/ai/embeddings.rbi +1 -1
- data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +1 -1
- data/rbi/telnyx/resources/call_control_applications.rbi +7 -1
- data/rbi/telnyx/resources/call_events.rbi +5 -1
- data/rbi/telnyx/resources/calls/actions.rbi +37 -2
- data/rbi/telnyx/resources/conferences.rbi +10 -2
- data/rbi/telnyx/resources/connections.rbi +5 -1
- data/rbi/telnyx/resources/faxes.rbi +4 -0
- data/rbi/telnyx/resources/messages.rbi +1 -1
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +8 -11
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +6 -6
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +10 -0
- data/rbi/telnyx/resources/operator_connect/actions.rbi +1 -1
- data/rbi/telnyx/resources/organizations/users/actions.rbi +32 -0
- data/rbi/telnyx/resources/organizations/users.rbi +88 -0
- data/rbi/telnyx/resources/organizations.rbi +15 -0
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +1 -1
- data/rbi/telnyx/resources/queues/calls.rbi +5 -1
- data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
- data/rbi/telnyx/resources/sim_cards.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/calls/recordings.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/queues.rbi +32 -0
- data/rbi/telnyx/resources/usage_reports.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +0 -6
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant.rbs +44 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +176 -1
- data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_tool.rbs +367 -2
- data/sig/telnyx/models/ai/assistant_update_params.rbs +176 -1
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +178 -3
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
- data/sig/telnyx/models/ai/inference_embedding.rbs +178 -3
- data/sig/telnyx/models/ai/messaging_settings.rbs +7 -0
- data/sig/telnyx/models/ai/retrieval_tool.rbs +4 -4
- data/sig/telnyx/models/ai/telephony_settings.rbs +133 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +42 -4
- data/sig/telnyx/models/ai/webhook_tool.rbs +241 -4
- data/sig/telnyx/models/call_control_application_list_params.rbs +17 -26
- data/sig/telnyx/models/call_event_list_params.rbs +18 -27
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +240 -0
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_response.rbs +20 -0
- data/sig/telnyx/models/calls/action_start_noise_suppression_params.rbs +2 -1
- data/sig/telnyx/models/conference_list_params.rbs +17 -26
- data/sig/telnyx/models/conference_list_participants_params.rbs +17 -26
- data/sig/telnyx/models/connection_list_active_calls_params.rbs +20 -27
- data/sig/telnyx/models/fax_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbs +3 -13
- data/sig/telnyx/models/messaging_profile.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +5 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_params.rbs +43 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +104 -0
- data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +99 -0
- data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +118 -0
- data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +122 -0
- data/sig/telnyx/models/queues/call_list_params.rbs +20 -27
- data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
- data/sig/telnyx/models/texml/accounts/queue_list_params.rbs +60 -0
- data/sig/telnyx/models/texml/accounts/queue_list_response.rbs +152 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models/unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models.rbs +2 -6
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +3 -0
- data/sig/telnyx/resources/call_control_applications.rbs +3 -1
- data/sig/telnyx/resources/call_events.rbs +3 -1
- data/sig/telnyx/resources/calls/actions.rbs +8 -0
- data/sig/telnyx/resources/conferences.rbs +6 -2
- data/sig/telnyx/resources/connections.rbs +3 -1
- data/sig/telnyx/resources/faxes.rbs +1 -0
- data/sig/telnyx/resources/messaging_10dlc/brand.rbs +1 -2
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -0
- data/sig/telnyx/resources/organizations/users/actions.rbs +16 -0
- data/sig/telnyx/resources/organizations/users.rbs +31 -0
- data/sig/telnyx/resources/organizations.rbs +9 -0
- data/sig/telnyx/resources/queues/calls.rbs +3 -1
- data/sig/telnyx/resources/texml/accounts/queues.rbs +10 -0
- data/sig/telnyx/resources/webhooks.rbs +0 -6
- metadata +47 -20
- data/lib/telnyx/models/ai/inference_embedding_bucket_ids.rb +0 -31
- data/lib/telnyx/models/ai/inference_embedding_transfer_tool_params.rb +0 -93
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +0 -265
- data/lib/telnyx/models/streaming_failed_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_started_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_stopped_webhook_event.rb +0 -15
- data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi +0 -54
- data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi +0 -185
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +0 -621
- data/rbi/telnyx/models/streaming_failed_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_started_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_stopped_webhook_event.rbi +0 -30
- data/sig/telnyx/models/ai/inference_embedding_bucket_ids.rbs +0 -26
- data/sig/telnyx/models/ai/inference_embedding_transfer_tool_params.rbs +0 -75
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +0 -242
- data/sig/telnyx/models/streaming_failed_webhook_event.rbs +0 -15
- data/sig/telnyx/models/streaming_started_webhook_event.rbs +0 -16
- data/sig/telnyx/models/streaming_stopped_webhook_event.rbs +0 -16
|
@@ -67,6 +67,14 @@ module Telnyx
|
|
|
67
67
|
# @return [Telnyx::Models::NumberPoolSettings, nil]
|
|
68
68
|
optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
|
|
69
69
|
|
|
70
|
+
# @!attribute smart_encoding
|
|
71
|
+
# Enables automatic character encoding optimization for SMS messages. When
|
|
72
|
+
# enabled, the system automatically selects the most efficient encoding (GSM-7 or
|
|
73
|
+
# UCS-2) based on message content to maximize character limits and minimize costs.
|
|
74
|
+
#
|
|
75
|
+
# @return [Boolean, nil]
|
|
76
|
+
optional :smart_encoding, Telnyx::Internal::Type::Boolean
|
|
77
|
+
|
|
70
78
|
# @!attribute url_shortener_settings
|
|
71
79
|
# The URL shortener feature allows automatic replacement of URLs that were
|
|
72
80
|
# generated using a public URL shortener service. Some examples include bit.do,
|
|
@@ -115,7 +123,7 @@ module Telnyx
|
|
|
115
123
|
# @return [Array<String>, nil]
|
|
116
124
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
117
125
|
|
|
118
|
-
# @!method initialize(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, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
126
|
+
# @!method initialize(alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
119
127
|
# Some parameter documentations has been truncated, see
|
|
120
128
|
# {Telnyx::Models::MessagingProfileUpdateParams} for more details.
|
|
121
129
|
#
|
|
@@ -137,6 +145,8 @@ module Telnyx
|
|
|
137
145
|
#
|
|
138
146
|
# @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
|
|
139
147
|
#
|
|
148
|
+
# @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
|
|
149
|
+
#
|
|
140
150
|
# @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
|
|
141
151
|
#
|
|
142
152
|
# @param v1_secret [String] Secret used to authenticate with v1 endpoints.
|
|
@@ -167,6 +167,17 @@ module Telnyx
|
|
|
167
167
|
# @return [String, nil]
|
|
168
168
|
optional :business_registration_type, String, api_name: :businessRegistrationType, nil?: true
|
|
169
169
|
|
|
170
|
+
# @!attribute campaign_verify_authorization_token
|
|
171
|
+
# Campaign Verify Authorization Token required for Political use case submissions
|
|
172
|
+
# starting February 17, 2026. This token is validated by Zipwhip and must be
|
|
173
|
+
# provided for all Political use case verifications after the deadline.
|
|
174
|
+
#
|
|
175
|
+
# @return [String, nil]
|
|
176
|
+
optional :campaign_verify_authorization_token,
|
|
177
|
+
String,
|
|
178
|
+
api_name: :campaignVerifyAuthorizationToken,
|
|
179
|
+
nil?: true
|
|
180
|
+
|
|
170
181
|
# @!attribute doing_business_as
|
|
171
182
|
# Doing Business As (DBA) name if different from legal name
|
|
172
183
|
#
|
|
@@ -220,7 +231,7 @@ module Telnyx
|
|
|
220
231
|
# @return [String, nil]
|
|
221
232
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
222
233
|
|
|
223
|
-
# @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil)
|
|
234
|
+
# @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil)
|
|
224
235
|
# Some parameter documentations has been truncated, see
|
|
225
236
|
# {Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest} for
|
|
226
237
|
# more details.
|
|
@@ -275,6 +286,8 @@ module Telnyx
|
|
|
275
286
|
#
|
|
276
287
|
# @param business_registration_type [String, nil] Type of business registration being provided. Required from January 2026.
|
|
277
288
|
#
|
|
289
|
+
# @param campaign_verify_authorization_token [String, nil] Campaign Verify Authorization Token required for Political use case submissions
|
|
290
|
+
#
|
|
278
291
|
# @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
|
|
279
292
|
#
|
|
280
293
|
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType, nil] Business entity classification
|
|
@@ -148,6 +148,16 @@ module Telnyx
|
|
|
148
148
|
# @return [String, nil]
|
|
149
149
|
optional :business_registration_type, String, api_name: :businessRegistrationType
|
|
150
150
|
|
|
151
|
+
# @!attribute campaign_verify_authorization_token
|
|
152
|
+
# Campaign Verify Authorization Token required for Political use case submissions
|
|
153
|
+
# starting February 17, 2026
|
|
154
|
+
#
|
|
155
|
+
# @return [String, nil]
|
|
156
|
+
optional :campaign_verify_authorization_token,
|
|
157
|
+
String,
|
|
158
|
+
api_name: :campaignVerifyAuthorizationToken,
|
|
159
|
+
nil?: true
|
|
160
|
+
|
|
151
161
|
# @!attribute doing_business_as
|
|
152
162
|
#
|
|
153
163
|
# @return [String, nil]
|
|
@@ -199,7 +209,11 @@ module Telnyx
|
|
|
199
209
|
# @return [String, nil]
|
|
200
210
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
201
211
|
|
|
202
|
-
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_request_id:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, verification_status: nil, webhook_url: nil)
|
|
212
|
+
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_request_id:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, verification_status: nil, webhook_url: nil)
|
|
213
|
+
# Some parameter documentations has been truncated, see
|
|
214
|
+
# {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress} for
|
|
215
|
+
# more details.
|
|
216
|
+
#
|
|
203
217
|
# A verification request as it comes out of the database
|
|
204
218
|
#
|
|
205
219
|
# @param id [String]
|
|
@@ -254,6 +268,8 @@ module Telnyx
|
|
|
254
268
|
#
|
|
255
269
|
# @param business_registration_type [String]
|
|
256
270
|
#
|
|
271
|
+
# @param campaign_verify_authorization_token [String, nil] Campaign Verify Authorization Token required for Political use case submissions
|
|
272
|
+
#
|
|
257
273
|
# @param doing_business_as [String]
|
|
258
274
|
#
|
|
259
275
|
# @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType] Business entity classification
|
|
@@ -151,6 +151,16 @@ module Telnyx
|
|
|
151
151
|
# @return [String, nil]
|
|
152
152
|
optional :business_registration_type, String, api_name: :businessRegistrationType
|
|
153
153
|
|
|
154
|
+
# @!attribute campaign_verify_authorization_token
|
|
155
|
+
# Campaign Verify Authorization Token required for Political use case submissions
|
|
156
|
+
# starting February 17, 2026
|
|
157
|
+
#
|
|
158
|
+
# @return [String, nil]
|
|
159
|
+
optional :campaign_verify_authorization_token,
|
|
160
|
+
String,
|
|
161
|
+
api_name: :campaignVerifyAuthorizationToken,
|
|
162
|
+
nil?: true
|
|
163
|
+
|
|
154
164
|
# @!attribute created_at
|
|
155
165
|
#
|
|
156
166
|
# @return [Time, nil]
|
|
@@ -209,7 +219,11 @@ module Telnyx
|
|
|
209
219
|
# @return [String, nil]
|
|
210
220
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
211
221
|
|
|
212
|
-
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil)
|
|
222
|
+
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, isv_reseller:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil)
|
|
223
|
+
# Some parameter documentations has been truncated, see
|
|
224
|
+
# {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus} for
|
|
225
|
+
# more details.
|
|
226
|
+
#
|
|
213
227
|
# A verification request and its status, suitable for returning to users
|
|
214
228
|
#
|
|
215
229
|
# @param id [String]
|
|
@@ -264,6 +278,8 @@ module Telnyx
|
|
|
264
278
|
#
|
|
265
279
|
# @param business_registration_type [String]
|
|
266
280
|
#
|
|
281
|
+
# @param campaign_verify_authorization_token [String, nil] Campaign Verify Authorization Token required for Political use case submissions
|
|
282
|
+
#
|
|
267
283
|
# @param created_at [Time]
|
|
268
284
|
#
|
|
269
285
|
# @param doing_business_as [String]
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#get_groups_report
|
|
7
|
+
class UserGetGroupsReportParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute accept
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportParams::Accept, nil]
|
|
14
|
+
optional :accept, enum: -> { Telnyx::Organizations::UserGetGroupsReportParams::Accept }
|
|
15
|
+
|
|
16
|
+
# @!method initialize(accept: nil, request_options: {})
|
|
17
|
+
# @param accept [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportParams::Accept]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
|
|
20
|
+
module Accept
|
|
21
|
+
extend Telnyx::Internal::Type::Enum
|
|
22
|
+
|
|
23
|
+
APPLICATION_JSON = :"application/json"
|
|
24
|
+
TEXT_CSV = :"text/csv"
|
|
25
|
+
|
|
26
|
+
# @!method self.values
|
|
27
|
+
# @return [Array<Symbol>]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#get_groups_report
|
|
7
|
+
class UserGetGroupsReportResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data>, nil]
|
|
11
|
+
optional :data,
|
|
12
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data] }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(data: nil)
|
|
15
|
+
# @param data [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data>]
|
|
16
|
+
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute id
|
|
19
|
+
# Identifies the specific resource.
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute created_at
|
|
25
|
+
# ISO 8601 formatted date indicating when the resource was created.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :created_at, String
|
|
29
|
+
|
|
30
|
+
# @!attribute email
|
|
31
|
+
# The email address of the user.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :email, String
|
|
35
|
+
|
|
36
|
+
# @!attribute groups
|
|
37
|
+
# The groups the user belongs to.
|
|
38
|
+
#
|
|
39
|
+
# @return [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::Group>]
|
|
40
|
+
required :groups,
|
|
41
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::Group] }
|
|
42
|
+
|
|
43
|
+
# @!attribute record_type
|
|
44
|
+
# Identifies the type of the resource. Can be 'organization_owner' or
|
|
45
|
+
# 'organization_sub_user'.
|
|
46
|
+
#
|
|
47
|
+
# @return [String]
|
|
48
|
+
required :record_type, String
|
|
49
|
+
|
|
50
|
+
# @!attribute user_status
|
|
51
|
+
# The status of the account.
|
|
52
|
+
#
|
|
53
|
+
# @return [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus]
|
|
54
|
+
required :user_status,
|
|
55
|
+
enum: -> { Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus }
|
|
56
|
+
|
|
57
|
+
# @!attribute last_sign_in_at
|
|
58
|
+
# ISO 8601 formatted date indicating when the resource last signed into the
|
|
59
|
+
# portal. Null if the user has never signed in.
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
optional :last_sign_in_at, String, nil?: true
|
|
63
|
+
|
|
64
|
+
# @!attribute organization_user_bypasses_sso
|
|
65
|
+
# Indicates whether this user is allowed to bypass SSO and use password
|
|
66
|
+
# authentication.
|
|
67
|
+
#
|
|
68
|
+
# @return [Boolean, nil]
|
|
69
|
+
optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
|
|
70
|
+
|
|
71
|
+
# @!method initialize(id:, created_at:, email:, groups:, record_type:, user_status:, last_sign_in_at: nil, organization_user_bypasses_sso: nil)
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data} for more
|
|
74
|
+
# details.
|
|
75
|
+
#
|
|
76
|
+
# An organization user with their group memberships always included.
|
|
77
|
+
#
|
|
78
|
+
# @param id [String] Identifies the specific resource.
|
|
79
|
+
#
|
|
80
|
+
# @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
|
|
81
|
+
#
|
|
82
|
+
# @param email [String] The email address of the user.
|
|
83
|
+
#
|
|
84
|
+
# @param groups [Array<Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::Group>] The groups the user belongs to.
|
|
85
|
+
#
|
|
86
|
+
# @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
|
|
87
|
+
#
|
|
88
|
+
# @param user_status [Symbol, Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data::UserStatus] The status of the account.
|
|
89
|
+
#
|
|
90
|
+
# @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
|
|
91
|
+
#
|
|
92
|
+
# @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
|
|
93
|
+
|
|
94
|
+
class Group < Telnyx::Internal::Type::BaseModel
|
|
95
|
+
# @!attribute id
|
|
96
|
+
# The unique identifier of the group.
|
|
97
|
+
#
|
|
98
|
+
# @return [String]
|
|
99
|
+
required :id, String
|
|
100
|
+
|
|
101
|
+
# @!attribute name
|
|
102
|
+
# The name of the group.
|
|
103
|
+
#
|
|
104
|
+
# @return [String]
|
|
105
|
+
required :name, String
|
|
106
|
+
|
|
107
|
+
# @!method initialize(id:, name:)
|
|
108
|
+
# A reference to a group that a user belongs to.
|
|
109
|
+
#
|
|
110
|
+
# @param id [String] The unique identifier of the group.
|
|
111
|
+
#
|
|
112
|
+
# @param name [String] The name of the group.
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# The status of the account.
|
|
116
|
+
#
|
|
117
|
+
# @see Telnyx::Models::Organizations::UserGetGroupsReportResponse::Data#user_status
|
|
118
|
+
module UserStatus
|
|
119
|
+
extend Telnyx::Internal::Type::Enum
|
|
120
|
+
|
|
121
|
+
ENABLED = :enabled
|
|
122
|
+
DISABLED = :disabled
|
|
123
|
+
BLOCKED = :blocked
|
|
124
|
+
|
|
125
|
+
# @!method self.values
|
|
126
|
+
# @return [Array<Symbol>]
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#list
|
|
7
|
+
class UserListParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute filter_email
|
|
12
|
+
# Filter by email address (partial match)
|
|
13
|
+
#
|
|
14
|
+
# @return [String, nil]
|
|
15
|
+
optional :filter_email, String
|
|
16
|
+
|
|
17
|
+
# @!attribute filter_user_status
|
|
18
|
+
# Filter by user status
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, Telnyx::Models::Organizations::UserListParams::FilterUserStatus, nil]
|
|
21
|
+
optional :filter_user_status, enum: -> { Telnyx::Organizations::UserListParams::FilterUserStatus }
|
|
22
|
+
|
|
23
|
+
# @!attribute include_groups
|
|
24
|
+
# When set to true, includes the groups array for each user in the response. The
|
|
25
|
+
# groups array contains objects with id and name for each group the user belongs
|
|
26
|
+
# to.
|
|
27
|
+
#
|
|
28
|
+
# @return [Boolean, nil]
|
|
29
|
+
optional :include_groups, Telnyx::Internal::Type::Boolean
|
|
30
|
+
|
|
31
|
+
# @!attribute page_number
|
|
32
|
+
# The page number to load
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :page_number, Integer
|
|
36
|
+
|
|
37
|
+
# @!attribute page_size
|
|
38
|
+
# The size of the page
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer, nil]
|
|
41
|
+
optional :page_size, Integer
|
|
42
|
+
|
|
43
|
+
# @!method initialize(filter_email: nil, filter_user_status: nil, include_groups: nil, page_number: nil, page_size: nil, request_options: {})
|
|
44
|
+
# Some parameter documentations has been truncated, see
|
|
45
|
+
# {Telnyx::Models::Organizations::UserListParams} for more details.
|
|
46
|
+
#
|
|
47
|
+
# @param filter_email [String] Filter by email address (partial match)
|
|
48
|
+
#
|
|
49
|
+
# @param filter_user_status [Symbol, Telnyx::Models::Organizations::UserListParams::FilterUserStatus] Filter by user status
|
|
50
|
+
#
|
|
51
|
+
# @param include_groups [Boolean] When set to true, includes the groups array for each user in the response. The g
|
|
52
|
+
#
|
|
53
|
+
# @param page_number [Integer] The page number to load
|
|
54
|
+
#
|
|
55
|
+
# @param page_size [Integer] The size of the page
|
|
56
|
+
#
|
|
57
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
58
|
+
|
|
59
|
+
# Filter by user status
|
|
60
|
+
module FilterUserStatus
|
|
61
|
+
extend Telnyx::Internal::Type::Enum
|
|
62
|
+
|
|
63
|
+
ENABLED = :enabled
|
|
64
|
+
DISABLED = :disabled
|
|
65
|
+
BLOCKED = :blocked
|
|
66
|
+
|
|
67
|
+
# @!method self.values
|
|
68
|
+
# @return [Array<Symbol>]
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#list
|
|
7
|
+
class UserListResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# Identifies the specific resource.
|
|
10
|
+
#
|
|
11
|
+
# @return [String, nil]
|
|
12
|
+
optional :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute created_at
|
|
15
|
+
# ISO 8601 formatted date indicating when the resource was created.
|
|
16
|
+
#
|
|
17
|
+
# @return [String, nil]
|
|
18
|
+
optional :created_at, String
|
|
19
|
+
|
|
20
|
+
# @!attribute email
|
|
21
|
+
# The email address of the user.
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :email, String
|
|
25
|
+
|
|
26
|
+
# @!attribute groups
|
|
27
|
+
# The groups the user belongs to. Only included when include_groups parameter is
|
|
28
|
+
# true.
|
|
29
|
+
#
|
|
30
|
+
# @return [Array<Telnyx::Models::Organizations::UserListResponse::Group>, nil]
|
|
31
|
+
optional :groups,
|
|
32
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Organizations::UserListResponse::Group] }
|
|
33
|
+
|
|
34
|
+
# @!attribute last_sign_in_at
|
|
35
|
+
# ISO 8601 formatted date indicating when the resource last signed into the
|
|
36
|
+
# portal. Null if the user has never signed in.
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :last_sign_in_at, String, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute organization_user_bypasses_sso
|
|
42
|
+
# Indicates whether this user is allowed to bypass SSO and use password
|
|
43
|
+
# authentication.
|
|
44
|
+
#
|
|
45
|
+
# @return [Boolean, nil]
|
|
46
|
+
optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
|
|
47
|
+
|
|
48
|
+
# @!attribute record_type
|
|
49
|
+
# Identifies the type of the resource. Can be 'organization_owner' or
|
|
50
|
+
# 'organization_sub_user'.
|
|
51
|
+
#
|
|
52
|
+
# @return [String, nil]
|
|
53
|
+
optional :record_type, String
|
|
54
|
+
|
|
55
|
+
# @!attribute user_status
|
|
56
|
+
# The status of the account.
|
|
57
|
+
#
|
|
58
|
+
# @return [Symbol, Telnyx::Models::Organizations::UserListResponse::UserStatus, nil]
|
|
59
|
+
optional :user_status, enum: -> { Telnyx::Models::Organizations::UserListResponse::UserStatus }
|
|
60
|
+
|
|
61
|
+
# @!method initialize(id: nil, created_at: nil, email: nil, groups: nil, last_sign_in_at: nil, organization_user_bypasses_sso: nil, record_type: nil, user_status: nil)
|
|
62
|
+
# Some parameter documentations has been truncated, see
|
|
63
|
+
# {Telnyx::Models::Organizations::UserListResponse} for more details.
|
|
64
|
+
#
|
|
65
|
+
# @param id [String] Identifies the specific resource.
|
|
66
|
+
#
|
|
67
|
+
# @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
|
|
68
|
+
#
|
|
69
|
+
# @param email [String] The email address of the user.
|
|
70
|
+
#
|
|
71
|
+
# @param groups [Array<Telnyx::Models::Organizations::UserListResponse::Group>] The groups the user belongs to. Only included when include_groups parameter is t
|
|
72
|
+
#
|
|
73
|
+
# @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
|
|
74
|
+
#
|
|
75
|
+
# @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
|
|
76
|
+
#
|
|
77
|
+
# @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
|
|
78
|
+
#
|
|
79
|
+
# @param user_status [Symbol, Telnyx::Models::Organizations::UserListResponse::UserStatus] The status of the account.
|
|
80
|
+
|
|
81
|
+
class Group < Telnyx::Internal::Type::BaseModel
|
|
82
|
+
# @!attribute id
|
|
83
|
+
# The unique identifier of the group.
|
|
84
|
+
#
|
|
85
|
+
# @return [String]
|
|
86
|
+
required :id, String
|
|
87
|
+
|
|
88
|
+
# @!attribute name
|
|
89
|
+
# The name of the group.
|
|
90
|
+
#
|
|
91
|
+
# @return [String]
|
|
92
|
+
required :name, String
|
|
93
|
+
|
|
94
|
+
# @!method initialize(id:, name:)
|
|
95
|
+
# A reference to a group that a user belongs to.
|
|
96
|
+
#
|
|
97
|
+
# @param id [String] The unique identifier of the group.
|
|
98
|
+
#
|
|
99
|
+
# @param name [String] The name of the group.
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# The status of the account.
|
|
103
|
+
#
|
|
104
|
+
# @see Telnyx::Models::Organizations::UserListResponse#user_status
|
|
105
|
+
module UserStatus
|
|
106
|
+
extend Telnyx::Internal::Type::Enum
|
|
107
|
+
|
|
108
|
+
ENABLED = :enabled
|
|
109
|
+
DISABLED = :disabled
|
|
110
|
+
BLOCKED = :blocked
|
|
111
|
+
|
|
112
|
+
# @!method self.values
|
|
113
|
+
# @return [Array<Symbol>]
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#retrieve
|
|
7
|
+
class UserRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute include_groups
|
|
12
|
+
# When set to true, includes the groups array for each user in the response. The
|
|
13
|
+
# groups array contains objects with id and name for each group the user belongs
|
|
14
|
+
# to.
|
|
15
|
+
#
|
|
16
|
+
# @return [Boolean, nil]
|
|
17
|
+
optional :include_groups, Telnyx::Internal::Type::Boolean
|
|
18
|
+
|
|
19
|
+
# @!method initialize(include_groups: nil, request_options: {})
|
|
20
|
+
# Some parameter documentations has been truncated, see
|
|
21
|
+
# {Telnyx::Models::Organizations::UserRetrieveParams} for more details.
|
|
22
|
+
#
|
|
23
|
+
# @param include_groups [Boolean] When set to true, includes the groups array for each user in the response. The g
|
|
24
|
+
#
|
|
25
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Organizations
|
|
6
|
+
# @see Telnyx::Resources::Organizations::Users#retrieve
|
|
7
|
+
class UserRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Organizations::UserRetrieveResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::Organizations::UserRetrieveResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Organizations::UserRetrieveResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::Organizations::UserRetrieveResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute id
|
|
19
|
+
# Identifies the specific resource.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute created_at
|
|
25
|
+
# ISO 8601 formatted date indicating when the resource was created.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :created_at, String
|
|
29
|
+
|
|
30
|
+
# @!attribute email
|
|
31
|
+
# The email address of the user.
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :email, String
|
|
35
|
+
|
|
36
|
+
# @!attribute groups
|
|
37
|
+
# The groups the user belongs to. Only included when include_groups parameter is
|
|
38
|
+
# true.
|
|
39
|
+
#
|
|
40
|
+
# @return [Array<Telnyx::Models::Organizations::UserRetrieveResponse::Data::Group>, nil]
|
|
41
|
+
optional :groups,
|
|
42
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Organizations::UserRetrieveResponse::Data::Group] }
|
|
43
|
+
|
|
44
|
+
# @!attribute last_sign_in_at
|
|
45
|
+
# ISO 8601 formatted date indicating when the resource last signed into the
|
|
46
|
+
# portal. Null if the user has never signed in.
|
|
47
|
+
#
|
|
48
|
+
# @return [String, nil]
|
|
49
|
+
optional :last_sign_in_at, String, nil?: true
|
|
50
|
+
|
|
51
|
+
# @!attribute organization_user_bypasses_sso
|
|
52
|
+
# Indicates whether this user is allowed to bypass SSO and use password
|
|
53
|
+
# authentication.
|
|
54
|
+
#
|
|
55
|
+
# @return [Boolean, nil]
|
|
56
|
+
optional :organization_user_bypasses_sso, Telnyx::Internal::Type::Boolean
|
|
57
|
+
|
|
58
|
+
# @!attribute record_type
|
|
59
|
+
# Identifies the type of the resource. Can be 'organization_owner' or
|
|
60
|
+
# 'organization_sub_user'.
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :record_type, String
|
|
64
|
+
|
|
65
|
+
# @!attribute user_status
|
|
66
|
+
# The status of the account.
|
|
67
|
+
#
|
|
68
|
+
# @return [Symbol, Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus, nil]
|
|
69
|
+
optional :user_status, enum: -> { Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus }
|
|
70
|
+
|
|
71
|
+
# @!method initialize(id: nil, created_at: nil, email: nil, groups: nil, last_sign_in_at: nil, organization_user_bypasses_sso: nil, record_type: nil, user_status: nil)
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {Telnyx::Models::Organizations::UserRetrieveResponse::Data} for more details.
|
|
74
|
+
#
|
|
75
|
+
# @param id [String] Identifies the specific resource.
|
|
76
|
+
#
|
|
77
|
+
# @param created_at [String] ISO 8601 formatted date indicating when the resource was created.
|
|
78
|
+
#
|
|
79
|
+
# @param email [String] The email address of the user.
|
|
80
|
+
#
|
|
81
|
+
# @param groups [Array<Telnyx::Models::Organizations::UserRetrieveResponse::Data::Group>] The groups the user belongs to. Only included when include_groups parameter is t
|
|
82
|
+
#
|
|
83
|
+
# @param last_sign_in_at [String, nil] ISO 8601 formatted date indicating when the resource last signed into the portal
|
|
84
|
+
#
|
|
85
|
+
# @param organization_user_bypasses_sso [Boolean] Indicates whether this user is allowed to bypass SSO and use password authentica
|
|
86
|
+
#
|
|
87
|
+
# @param record_type [String] Identifies the type of the resource. Can be 'organization_owner' or 'organizatio
|
|
88
|
+
#
|
|
89
|
+
# @param user_status [Symbol, Telnyx::Models::Organizations::UserRetrieveResponse::Data::UserStatus] The status of the account.
|
|
90
|
+
|
|
91
|
+
class Group < Telnyx::Internal::Type::BaseModel
|
|
92
|
+
# @!attribute id
|
|
93
|
+
# The unique identifier of the group.
|
|
94
|
+
#
|
|
95
|
+
# @return [String]
|
|
96
|
+
required :id, String
|
|
97
|
+
|
|
98
|
+
# @!attribute name
|
|
99
|
+
# The name of the group.
|
|
100
|
+
#
|
|
101
|
+
# @return [String]
|
|
102
|
+
required :name, String
|
|
103
|
+
|
|
104
|
+
# @!method initialize(id:, name:)
|
|
105
|
+
# A reference to a group that a user belongs to.
|
|
106
|
+
#
|
|
107
|
+
# @param id [String] The unique identifier of the group.
|
|
108
|
+
#
|
|
109
|
+
# @param name [String] The name of the group.
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# The status of the account.
|
|
113
|
+
#
|
|
114
|
+
# @see Telnyx::Models::Organizations::UserRetrieveResponse::Data#user_status
|
|
115
|
+
module UserStatus
|
|
116
|
+
extend Telnyx::Internal::Type::Enum
|
|
117
|
+
|
|
118
|
+
ENABLED = :enabled
|
|
119
|
+
DISABLED = :disabled
|
|
120
|
+
BLOCKED = :blocked
|
|
121
|
+
|
|
122
|
+
# @!method self.values
|
|
123
|
+
# @return [Array<Symbol>]
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|