telnyx 5.159.0 → 5.160.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 +3 -4
- data/lib/telnyx/models/actions/purchase_create_response.rb +3 -3
- data/lib/telnyx/models/actions/register_create_response.rb +3 -3
- data/lib/telnyx/models/actions/wireless_error_c5290d5308.rb +61 -0
- data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
- data/lib/telnyx/models/ai/assistant_tool.rb +28 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
- data/lib/telnyx/models/ai/collection.rb +82 -0
- data/lib/telnyx/models/ai/collection_create_params.rb +56 -0
- data/lib/telnyx/models/ai/collection_delete_params.rb +22 -0
- data/lib/telnyx/models/ai/collection_envelope.rb +18 -0
- data/lib/telnyx/models/ai/collection_list_params.rb +32 -0
- data/lib/telnyx/models/ai/collection_retrieve_by_id_params.rb +22 -0
- data/lib/telnyx/models/ai/collection_retrieve_documents_params.rb +104 -0
- data/lib/telnyx/models/ai/collection_retrieve_documents_response.rb +180 -0
- data/lib/telnyx/models/ai/collection_retrieve_params.rb +22 -0
- data/lib/telnyx/models/ai/collection_update_params.rb +34 -0
- data/lib/telnyx/models/ai/collections/retrieval_settings.rb +49 -0
- data/lib/telnyx/models/ai/collections/retrieval_settings_wrapper.rb +30 -0
- data/lib/telnyx/models/ai/collections/setting_create_params.rb +24 -0
- data/lib/telnyx/models/ai/collections/setting_list_params.rb +24 -0
- data/lib/telnyx/models/ai/collections/setting_patch_all_params.rb +24 -0
- data/lib/telnyx/models/ai/collections/settings_envelope.rb +20 -0
- data/lib/telnyx/models/ai/collections/settings_request.rb +20 -0
- data/lib/telnyx/models/ai/collections/source.rb +62 -0
- data/lib/telnyx/models/ai/collections/source_create_params.rb +24 -0
- data/lib/telnyx/models/ai/collections/source_create_response.rb +22 -0
- data/lib/telnyx/models/ai/collections/source_delete_params.rb +30 -0
- data/lib/telnyx/models/ai/collections/source_list_params.rb +24 -0
- data/lib/telnyx/models/ai/collections/source_list_response.rb +20 -0
- data/lib/telnyx/models/ai/collections/source_replace_params.rb +30 -0
- data/lib/telnyx/models/ai/collections/source_replace_response.rb +58 -0
- data/lib/telnyx/models/ai/collections/source_request.rb +34 -0
- data/lib/telnyx/models/ai/collections/source_type.rb +24 -0
- data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
- data/lib/telnyx/models/ai/telephony_settings.rb +11 -1
- data/lib/telnyx/models/ai/tool_create_params.rb +19 -1
- data/lib/telnyx/models/ai/tool_update_params.rb +20 -1
- data/lib/telnyx/models/ai/update_dynamic_variables_tool_params.rb +78 -0
- data/lib/telnyx/models/credential_connection.rb +11 -1
- data/lib/telnyx/models/credential_connection_update_params.rb +11 -1
- data/lib/telnyx/models/fqdn_connection.rb +11 -1
- data/lib/telnyx/models/fqdn_connection_update_params.rb +11 -1
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication.rb +142 -0
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication_list_params.rb +22 -0
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication_list_response.rb +18 -0
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rb +119 -0
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_response.rb +18 -0
- data/lib/telnyx/models/inbound_message_webhook_event.rb +594 -3
- data/lib/telnyx/models/ip_connection.rb +11 -1
- data/lib/telnyx/models/ip_connection_update_params.rb +11 -1
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta_705dfa7312.rb +39 -0
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rb +3 -3
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rb +3 -3
- data/lib/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta_ffba4faa88.rb +39 -0
- data/lib/telnyx/models/message_cancel_scheduled_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +595 -5
- 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/message_whatsapp_params.rb +71 -0
- data/lib/telnyx/models/message_whatsapp_response.rb +178 -0
- data/lib/telnyx/models/messaging_error_0b38e7044b.rb +59 -0
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +597 -0
- data/lib/telnyx/models/messaging_pagination_meta_0b38e7044b.rb +33 -0
- data/lib/telnyx/models/messaging_profile_metric_list_response.rb +3 -3
- data/lib/telnyx/models/messaging_profiles/autoresp_config_list_response.rb +3 -3
- data/lib/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_entity_type.rb +23 -0
- data/lib/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_tf_verification_request.rb +312 -0
- data/lib/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_verification_request_egress.rb +296 -0
- data/lib/telnyx/models/messaging_tollfree/verification/request_create_params.rb +1 -1
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb +310 -0
- data/lib/telnyx/models/messaging_tollfree/verification/request_update_params.rb +1 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +0 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +1 -1
- data/lib/telnyx/models/netapps_location_17904fcfbc.rb +48 -0
- data/lib/telnyx/models/network_coverage_list_response.rb +3 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +405 -0
- data/lib/telnyx/models/numbers_phone_number_detailed.rb +369 -0
- data/lib/telnyx/models/oauth_oauth_pagination_meta.rb +40 -0
- data/lib/telnyx/models/phone_number_detailed.rb +0 -1
- data/lib/telnyx/models/phone_number_retrieve_response.rb +3 -3
- data/lib/telnyx/models/phone_number_update_response.rb +3 -3
- data/lib/telnyx/models/pricing/product_retrieve_params.rb +8 -1
- data/lib/telnyx/models/rcs/agent_campaign_configuration.rb +47 -0
- data/lib/telnyx/models/rcs/agent_configuration.rb +227 -0
- data/lib/telnyx/models/rcs/agent_consent_configuration.rb +110 -0
- data/lib/telnyx/models/rcs/agent_create_params.rb +70 -0
- data/lib/telnyx/models/rcs/agent_email_contact.rb +23 -0
- data/lib/telnyx/models/rcs/agent_interaction.rb +41 -0
- data/lib/telnyx/models/rcs/agent_launch_params.rb +62 -0
- data/lib/telnyx/models/rcs/agent_list_params.rb +24 -0
- data/lib/telnyx/models/rcs/agent_list_response.rb +10 -0
- data/lib/telnyx/models/rcs/agent_phone_contact.rb +23 -0
- data/lib/telnyx/models/rcs/agent_response.rb +131 -0
- data/lib/telnyx/models/rcs/agent_retrieve_carrier_approvals_params.rb +22 -0
- data/lib/telnyx/models/rcs/agent_retrieve_carrier_approvals_response.rb +11 -0
- data/lib/telnyx/models/rcs/agent_retrieve_params.rb +22 -0
- data/lib/telnyx/models/rcs/agent_submission_status.rb +18 -0
- data/lib/telnyx/models/rcs/agent_submit_params.rb +22 -0
- data/lib/telnyx/models/rcs/agent_testing_configuration.rb +32 -0
- data/lib/telnyx/models/rcs/agent_update_params.rb +52 -0
- data/lib/telnyx/models/rcs/agent_use_case.rb +19 -0
- data/lib/telnyx/models/rcs/agent_website_contact.rb +23 -0
- data/lib/telnyx/models/rcs/agents/test_device_create_params.rb +30 -0
- data/lib/telnyx/models/rcs/agents/test_device_delete_params.rb +30 -0
- data/lib/telnyx/models/rcs/agents/test_device_list_params.rb +24 -0
- data/lib/telnyx/models/rcs/agents/test_device_list_response.rb +14 -0
- data/lib/telnyx/models/rcs/agents/test_device_response.rb +44 -0
- data/lib/telnyx/models/rcs/brand_contact.rb +63 -0
- data/lib/telnyx/models/rcs/brand_create_params.rb +184 -0
- data/lib/telnyx/models/rcs/brand_legal_entity_type.rb +20 -0
- data/lib/telnyx/models/rcs/brand_list_params.rb +16 -0
- data/lib/telnyx/models/rcs/brand_list_response.rb +10 -0
- data/lib/telnyx/models/rcs/brand_organization_type.rb +20 -0
- data/lib/telnyx/models/rcs/brand_response.rb +159 -0
- data/lib/telnyx/models/rcs/brand_retrieve_params.rb +22 -0
- data/lib/telnyx/models/rcs/brand_submit_params.rb +22 -0
- data/lib/telnyx/models/rcs/brand_update_params.rb +189 -0
- data/lib/telnyx/models/rcs/capabilities_response.rb +65 -0
- data/lib/telnyx/models/rcs/carrier_approval_response.rb +78 -0
- data/lib/telnyx/models/rcs/ein_brand_identifier.rb +25 -0
- data/lib/telnyx/models/rcs/rcs_agent.rb +84 -0
- data/lib/telnyx/models/rcs/rcs_agent_response.rb +19 -0
- data/lib/telnyx/models/rcs/stock_symbol_brand_identifier.rb +25 -0
- data/lib/telnyx/models/report_list_mdrs_response.rb +3 -3
- data/lib/telnyx/models/reports/reporting_pagination_meta_77109e5d17.rb +37 -0
- data/lib/telnyx/models/sim_cards/action_disable_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/action_enable_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/action_remove_public_ip_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/action_retrieve_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/action_set_public_ip_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/action_set_standby_response.rb +3 -3
- data/lib/telnyx/models/sim_cards/sim_card_action.rb +0 -1
- data/lib/telnyx/models/sim_cards/wireless_sim_card_action.rb +153 -0
- data/lib/telnyx/models/sip_registration_status_retrieve_params.rb +8 -5
- data/lib/telnyx/models/sip_registration_status_retrieve_response.rb +39 -31
- data/lib/telnyx/models/speech_to_text_list_providers_response.rb +10 -1
- data/lib/telnyx/models/text_to_speech_list_voices_response.rb +13 -1
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +2 -2
- data/lib/telnyx/models/unwrap_webhook_event.rb +2 -2
- data/lib/telnyx/models/user_address.rb +0 -1
- data/lib/telnyx/models/user_address_create_response.rb +3 -3
- data/lib/telnyx/models/user_address_retrieve_response.rb +3 -3
- data/lib/telnyx/models/user_addresses_user_address.rb +153 -0
- data/lib/telnyx/models/virtual_cross_connects_coverage_list_response.rb +3 -3
- data/lib/telnyx/models/whatsapp/phone_number_get_params.rb +28 -0
- data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +110 -0
- data/lib/telnyx/models.rb +21 -3
- data/lib/telnyx/resources/access_ip_address.rb +4 -4
- data/lib/telnyx/resources/access_ip_ranges.rb +3 -3
- data/lib/telnyx/resources/addresses/actions.rb +3 -2
- data/lib/telnyx/resources/advanced_orders.rb +8 -4
- data/lib/telnyx/resources/ai/assistants/tags.rb +3 -3
- data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/ai/clusters.rb +4 -4
- data/lib/telnyx/resources/ai/collections/settings.rb +88 -0
- data/lib/telnyx/resources/ai/collections/sources.rb +121 -0
- data/lib/telnyx/resources/ai/collections.rb +244 -0
- data/lib/telnyx/resources/ai/tools.rb +21 -7
- data/lib/telnyx/resources/ai.rb +11 -7
- data/lib/telnyx/resources/available_phone_number_blocks.rb +3 -1
- data/lib/telnyx/resources/available_phone_numbers.rb +4 -1
- data/lib/telnyx/resources/balance.rb +2 -1
- data/lib/telnyx/resources/billing_groups.rb +6 -5
- data/lib/telnyx/resources/calls/actions.rb +4 -2
- data/lib/telnyx/resources/comments.rb +8 -4
- data/lib/telnyx/resources/credential_connections.rb +3 -1
- data/lib/telnyx/resources/email_blocks.rb +2 -1
- data/lib/telnyx/resources/email_domains/webhooks.rb +6 -3
- data/lib/telnyx/resources/email_domains.rb +11 -5
- data/lib/telnyx/resources/email_templates.rb +4 -2
- data/lib/telnyx/resources/email_unsubscribe_groups.rb +3 -2
- data/lib/telnyx/resources/external_connections.rb +2 -1
- data/lib/telnyx/resources/faxes.rb +3 -3
- data/lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb +78 -0
- data/lib/telnyx/resources/fqdn_connections.rb +8 -1
- data/lib/telnyx/resources/global_ip_assignment_health.rb +1 -1
- data/lib/telnyx/resources/global_ip_assignments_usage.rb +1 -1
- data/lib/telnyx/resources/global_ip_latency.rb +1 -1
- data/lib/telnyx/resources/global_ip_usage.rb +1 -1
- data/lib/telnyx/resources/ip_connections.rb +3 -1
- data/lib/telnyx/resources/ledger_billing_group_reports.rb +4 -2
- data/lib/telnyx/resources/messages/rcs.rb +2 -1
- data/lib/telnyx/resources/messages.rb +43 -5
- data/lib/telnyx/resources/messaging/rcs/agents.rb +9 -9
- data/lib/telnyx/resources/messaging/rcs.rb +3 -2
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +3 -1
- data/lib/telnyx/resources/messaging_10dlc/campaign/osr.rb +3 -1
- data/lib/telnyx/resources/messaging_10dlc/campaign/usecase.rb +2 -1
- data/lib/telnyx/resources/messaging_10dlc/campaign.rb +2 -1
- data/lib/telnyx/resources/messaging_10dlc/partner_campaigns.rb +1 -1
- data/lib/telnyx/resources/messaging_10dlc/phone_number_campaigns.rb +5 -3
- data/lib/telnyx/resources/messaging_10dlc.rb +2 -1
- data/lib/telnyx/resources/messaging_hosted_number_orders/actions.rb +1 -1
- data/lib/telnyx/resources/messaging_hosted_number_orders.rb +8 -4
- data/lib/telnyx/resources/messaging_hosted_numbers.rb +1 -1
- data/lib/telnyx/resources/messaging_numbers_bulk_updates.rb +4 -2
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +7 -5
- data/lib/telnyx/resources/messaging_profiles.rb +14 -7
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +8 -8
- data/lib/telnyx/resources/messaging_url_domains.rb +2 -1
- data/lib/telnyx/resources/mobile_phone_numbers/messaging.rb +2 -2
- data/lib/telnyx/resources/mobile_phone_numbers.rb +3 -3
- data/lib/telnyx/resources/mobile_voice_connections.rb +5 -5
- data/lib/telnyx/resources/number_order_phone_numbers.rb +2 -1
- data/lib/telnyx/resources/ota_updates.rb +2 -1
- data/lib/telnyx/resources/payment.rb +1 -1
- data/lib/telnyx/resources/phone_number_blocks/jobs.rb +5 -2
- data/lib/telnyx/resources/phone_numbers/actions.rb +6 -3
- data/lib/telnyx/resources/phone_numbers/csv_downloads.rb +7 -3
- data/lib/telnyx/resources/phone_numbers/jobs.rb +4 -2
- data/lib/telnyx/resources/phone_numbers/messaging.rb +6 -3
- data/lib/telnyx/resources/phone_numbers/voice.rb +7 -3
- data/lib/telnyx/resources/phone_numbers.rb +11 -6
- data/lib/telnyx/resources/phone_numbers_regulatory_requirements.rb +3 -1
- data/lib/telnyx/resources/pricing/products.rb +11 -5
- data/lib/telnyx/resources/rcs/agents/test_devices.rb +92 -0
- data/lib/telnyx/resources/rcs/agents.rb +213 -0
- data/lib/telnyx/resources/rcs/brands.rb +163 -0
- data/lib/telnyx/resources/rcs.rb +24 -0
- data/lib/telnyx/resources/regulatory_requirements.rb +3 -1
- data/lib/telnyx/resources/requirement_groups.rb +13 -6
- data/lib/telnyx/resources/room_compositions.rb +5 -2
- data/lib/telnyx/resources/room_participants.rb +4 -2
- data/lib/telnyx/resources/room_recordings.rb +8 -3
- data/lib/telnyx/resources/rooms/sessions/actions.rb +9 -3
- data/lib/telnyx/resources/rooms/sessions.rb +11 -4
- data/lib/telnyx/resources/rooms.rb +5 -2
- data/lib/telnyx/resources/short_codes.rb +4 -2
- data/lib/telnyx/resources/sim_cards/actions.rb +2 -2
- data/lib/telnyx/resources/sip_registration_status.rb +16 -4
- data/lib/telnyx/resources/storage/migration_sources.rb +5 -3
- data/lib/telnyx/resources/storage/migrations/actions.rb +1 -1
- data/lib/telnyx/resources/storage/migrations.rb +2 -2
- data/lib/telnyx/resources/storage.rb +1 -1
- data/lib/telnyx/resources/sub_number_orders.rb +3 -1
- data/lib/telnyx/resources/user_addresses.rb +2 -2
- data/lib/telnyx/resources/verifications/actions.rb +3 -1
- data/lib/telnyx/resources/verifications/by_phone_number/actions.rb +2 -1
- data/lib/telnyx/resources/verifications/by_phone_number.rb +2 -1
- data/lib/telnyx/resources/verifications.rb +13 -5
- data/lib/telnyx/resources/verified_numbers/actions.rb +2 -1
- data/lib/telnyx/resources/verified_numbers.rb +2 -2
- data/lib/telnyx/resources/verify_profiles.rb +3 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/resources/whatsapp/business_accounts/phone_numbers.rb +3 -2
- data/lib/telnyx/resources/whatsapp/business_accounts/settings.rb +3 -2
- data/lib/telnyx/resources/whatsapp/business_accounts.rb +4 -3
- data/lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb +2 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers/conversational_components.rb +4 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb +5 -3
- data/lib/telnyx/resources/whatsapp/phone_numbers/profile.rb +3 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +27 -4
- data/lib/telnyx/resources/whatsapp/templates.rb +4 -2
- data/lib/telnyx/resources/whatsapp/user_data.rb +4 -2
- data/lib/telnyx/resources/whatsapp_message_templates.rb +4 -3
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +104 -4
- data/rbi/telnyx/client.rbi +2 -3
- data/rbi/telnyx/models/actions/purchase_create_response.rbi +10 -4
- data/rbi/telnyx/models/actions/register_create_response.rbi +10 -4
- data/rbi/telnyx/models/actions/wireless_error_c5290d5308.rbi +112 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
- data/rbi/telnyx/models/ai/assistant_tool.rbi +58 -1
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
- data/rbi/telnyx/models/ai/collection.rbi +133 -0
- data/rbi/telnyx/models/ai/collection_create_params.rbi +101 -0
- data/rbi/telnyx/models/ai/collection_delete_params.rbi +37 -0
- data/rbi/telnyx/models/ai/collection_envelope.rbi +30 -0
- data/rbi/telnyx/models/ai/collection_list_params.rbi +59 -0
- data/rbi/telnyx/models/ai/collection_retrieve_by_id_params.rbi +40 -0
- data/rbi/telnyx/models/ai/collection_retrieve_documents_params.rbi +195 -0
- data/rbi/telnyx/models/ai/collection_retrieve_documents_response.rbi +334 -0
- data/rbi/telnyx/models/ai/collection_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/ai/collection_update_params.rbi +56 -0
- data/rbi/telnyx/models/ai/collections/retrieval_settings.rbi +115 -0
- data/rbi/telnyx/models/ai/collections/retrieval_settings_wrapper.rbi +62 -0
- data/rbi/telnyx/models/ai/collections/setting_create_params.rbi +42 -0
- data/rbi/telnyx/models/ai/collections/setting_list_params.rbi +42 -0
- data/rbi/telnyx/models/ai/collections/setting_patch_all_params.rbi +42 -0
- data/rbi/telnyx/models/ai/collections/settings_envelope.rbi +49 -0
- data/rbi/telnyx/models/ai/collections/settings_request.rbi +49 -0
- data/rbi/telnyx/models/ai/collections/source.rbi +105 -0
- data/rbi/telnyx/models/ai/collections/source_create_params.rbi +42 -0
- data/rbi/telnyx/models/ai/collections/source_create_response.rbi +38 -0
- data/rbi/telnyx/models/ai/collections/source_delete_params.rbi +50 -0
- data/rbi/telnyx/models/ai/collections/source_list_params.rbi +42 -0
- data/rbi/telnyx/models/ai/collections/source_list_response.rbi +43 -0
- data/rbi/telnyx/models/ai/collections/source_replace_params.rbi +50 -0
- data/rbi/telnyx/models/ai/collections/source_replace_response.rbi +125 -0
- data/rbi/telnyx/models/ai/collections/source_request.rbi +61 -0
- data/rbi/telnyx/models/ai/collections/source_type.rbi +40 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
- data/rbi/telnyx/models/ai/telephony_settings.rbi +15 -0
- data/rbi/telnyx/models/ai/tool_create_params.rbi +18 -0
- data/rbi/telnyx/models/ai/tool_update_params.rbi +18 -0
- data/rbi/telnyx/models/ai/update_dynamic_variables_tool_params.rbi +136 -0
- data/rbi/telnyx/models/credential_connection.rbi +15 -0
- data/rbi/telnyx/models/credential_connection_update_params.rbi +15 -0
- data/rbi/telnyx/models/fqdn_connection.rbi +15 -0
- data/rbi/telnyx/models/fqdn_connection_update_params.rbi +15 -0
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication.rbi +273 -0
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication_list_params.rbi +43 -0
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication_list_response.rbi +51 -0
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rbi +241 -0
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_response.rbi +51 -0
- data/rbi/telnyx/models/inbound_message_payload.rbi +18 -29
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +1435 -4
- data/rbi/telnyx/models/ip_connection.rbi +15 -0
- data/rbi/telnyx/models/ip_connection_update_params.rbi +15 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta_705dfa7312.rbi +74 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbi +4 -4
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbi +4 -4
- data/rbi/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta_ffba4faa88.rbi +74 -0
- data/rbi/telnyx/models/message_cancel_scheduled_response.rbi +6 -4
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +12 -6
- data/rbi/telnyx/models/message_retrieve_response.rbi +1442 -5
- data/rbi/telnyx/models/message_schedule_response.rbi +6 -4
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +6 -4
- data/rbi/telnyx/models/message_send_long_code_response.rbi +6 -4
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +6 -4
- data/rbi/telnyx/models/message_send_response.rbi +6 -4
- data/rbi/telnyx/models/message_send_short_code_response.rbi +6 -4
- data/rbi/telnyx/models/message_whatsapp_params.rbi +115 -0
- data/rbi/telnyx/models/message_whatsapp_response.rbi +373 -0
- data/rbi/telnyx/models/messaging_error_0b38e7044b.rbi +103 -0
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +1317 -0
- data/rbi/telnyx/models/messaging_pagination_meta_0b38e7044b.rbi +51 -0
- data/rbi/telnyx/models/messaging_profile_metric_list_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_profiles/autoresp_config_list_response.rbi +6 -4
- data/rbi/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_entity_type.rbi +59 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_tf_verification_request.rbi +370 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_verification_request_egress.rbi +362 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_create_params.rbi +1 -1
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rbi +373 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_update_params.rbi +1 -1
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +8 -10
- data/rbi/telnyx/models/netapps_location_17904fcfbc.rbi +84 -0
- data/rbi/telnyx/models/network_coverage_list_response.rbi +4 -4
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +885 -0
- data/rbi/telnyx/models/numbers_phone_number_detailed.rbi +659 -0
- data/rbi/telnyx/models/oauth_oauth_pagination_meta.rbi +73 -0
- data/rbi/telnyx/models/phone_number_detailed.rbi +10 -16
- data/rbi/telnyx/models/phone_number_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/phone_number_update_response.rbi +4 -4
- data/rbi/telnyx/models/pricing/product_retrieve_params.rbi +6 -0
- data/rbi/telnyx/models/rcs/agent_campaign_configuration.rbi +90 -0
- data/rbi/telnyx/models/rcs/agent_configuration.rbi +461 -0
- data/rbi/telnyx/models/rcs/agent_consent_configuration.rbi +201 -0
- data/rbi/telnyx/models/rcs/agent_create_params.rbi +88 -0
- data/rbi/telnyx/models/rcs/agent_email_contact.rbi +28 -0
- data/rbi/telnyx/models/rcs/agent_interaction.rbi +105 -0
- data/rbi/telnyx/models/rcs/agent_launch_params.rbi +120 -0
- data/rbi/telnyx/models/rcs/agent_list_params.rbi +45 -0
- data/rbi/telnyx/models/rcs/agent_list_response.rbi +13 -0
- data/rbi/telnyx/models/rcs/agent_phone_contact.rbi +28 -0
- data/rbi/telnyx/models/rcs/agent_response.rbi +218 -0
- data/rbi/telnyx/models/rcs/agent_retrieve_carrier_approvals_params.rbi +40 -0
- data/rbi/telnyx/models/rcs/agent_retrieve_carrier_approvals_response.rbi +13 -0
- data/rbi/telnyx/models/rcs/agent_retrieve_params.rbi +37 -0
- data/rbi/telnyx/models/rcs/agent_submission_status.rbi +30 -0
- data/rbi/telnyx/models/rcs/agent_submit_params.rbi +37 -0
- data/rbi/telnyx/models/rcs/agent_testing_configuration.rbi +54 -0
- data/rbi/telnyx/models/rcs/agent_update_params.rbi +90 -0
- data/rbi/telnyx/models/rcs/agent_use_case.rbi +27 -0
- data/rbi/telnyx/models/rcs/agent_website_contact.rbi +28 -0
- data/rbi/telnyx/models/rcs/agents/test_device_create_params.rbi +50 -0
- data/rbi/telnyx/models/rcs/agents/test_device_delete_params.rbi +50 -0
- data/rbi/telnyx/models/rcs/agents/test_device_list_params.rbi +42 -0
- data/rbi/telnyx/models/rcs/agents/test_device_list_response.rbi +17 -0
- data/rbi/telnyx/models/rcs/agents/test_device_response.rbi +95 -0
- data/rbi/telnyx/models/rcs/brand_contact.rbi +115 -0
- data/rbi/telnyx/models/rcs/brand_create_params.rbi +345 -0
- data/rbi/telnyx/models/rcs/brand_legal_entity_type.rbi +40 -0
- data/rbi/telnyx/models/rcs/brand_list_params.rbi +29 -0
- data/rbi/telnyx/models/rcs/brand_list_response.rbi +13 -0
- data/rbi/telnyx/models/rcs/brand_organization_type.rbi +40 -0
- data/rbi/telnyx/models/rcs/brand_response.rbi +242 -0
- data/rbi/telnyx/models/rcs/brand_retrieve_params.rbi +37 -0
- data/rbi/telnyx/models/rcs/brand_submit_params.rbi +37 -0
- data/rbi/telnyx/models/rcs/brand_update_params.rbi +383 -0
- data/rbi/telnyx/models/rcs/capabilities_response.rbi +85 -0
- data/rbi/telnyx/models/rcs/carrier_approval_response.rbi +160 -0
- data/rbi/telnyx/models/rcs/ein_brand_identifier.rbi +37 -0
- data/rbi/telnyx/models/rcs/rcs_agent.rbi +123 -0
- data/rbi/telnyx/models/rcs/rcs_agent_response.rbi +32 -0
- data/rbi/telnyx/models/rcs/stock_symbol_brand_identifier.rbi +40 -0
- data/rbi/telnyx/models/report_list_mdrs_response.rbi +8 -4
- data/rbi/telnyx/models/reports/reporting_pagination_meta_77109e5d17.rbi +73 -0
- data/rbi/telnyx/models/sim_cards/action_disable_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/action_enable_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/action_remove_public_ip_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/action_retrieve_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/action_set_public_ip_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/action_set_standby_response.rbi +8 -4
- data/rbi/telnyx/models/sim_cards/sim_card_action.rbi +4 -5
- data/rbi/telnyx/models/sim_cards/wireless_sim_card_action.rbi +312 -0
- data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi +15 -7
- data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi +48 -38
- data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi +10 -0
- data/rbi/telnyx/models/text_to_speech_list_voices_response.rbi +13 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +1 -1
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +1 -1
- data/rbi/telnyx/models/user_address_create_response.rbi +6 -4
- data/rbi/telnyx/models/user_address_retrieve_response.rbi +6 -4
- data/rbi/telnyx/models/user_addresses_user_address.rbi +226 -0
- data/rbi/telnyx/models/virtual_cross_connects_coverage_list_response.rbi +4 -4
- data/rbi/telnyx/models/whatsapp/phone_number_get_params.rbi +54 -0
- data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +204 -0
- data/rbi/telnyx/models.rbi +24 -3
- data/rbi/telnyx/resources/access_ip_address.rbi +4 -4
- data/rbi/telnyx/resources/access_ip_ranges.rbi +3 -3
- data/rbi/telnyx/resources/addresses/actions.rbi +3 -2
- data/rbi/telnyx/resources/advanced_orders.rbi +8 -4
- data/rbi/telnyx/resources/ai/assistants/tags.rbi +3 -3
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
- data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
- data/rbi/telnyx/resources/ai/clusters.rbi +4 -4
- data/rbi/telnyx/resources/ai/collections/settings.rbi +66 -0
- data/rbi/telnyx/resources/ai/collections/sources.rbi +89 -0
- data/rbi/telnyx/resources/ai/collections.rbi +208 -0
- data/rbi/telnyx/resources/ai/tools.rbi +13 -5
- data/rbi/telnyx/resources/ai.rbi +10 -7
- data/rbi/telnyx/resources/available_phone_number_blocks.rbi +3 -1
- data/rbi/telnyx/resources/available_phone_numbers.rbi +4 -1
- data/rbi/telnyx/resources/balance.rbi +2 -1
- data/rbi/telnyx/resources/billing_groups.rbi +6 -5
- data/rbi/telnyx/resources/calls/actions.rbi +4 -2
- data/rbi/telnyx/resources/comments.rbi +8 -4
- data/rbi/telnyx/resources/credential_connections.rbi +5 -0
- data/rbi/telnyx/resources/email_blocks.rbi +2 -1
- data/rbi/telnyx/resources/email_domains/webhooks.rbi +6 -3
- data/rbi/telnyx/resources/email_domains.rbi +11 -5
- data/rbi/telnyx/resources/email_templates.rbi +4 -2
- data/rbi/telnyx/resources/email_unsubscribe_groups.rbi +3 -2
- data/rbi/telnyx/resources/external_connections.rbi +2 -1
- data/rbi/telnyx/resources/faxes.rbi +3 -3
- data/rbi/telnyx/resources/fqdn_connections/fqdn_authentication.rbi +77 -0
- data/rbi/telnyx/resources/fqdn_connections.rbi +9 -0
- data/rbi/telnyx/resources/global_ip_assignment_health.rbi +1 -1
- data/rbi/telnyx/resources/global_ip_assignments_usage.rbi +1 -1
- data/rbi/telnyx/resources/global_ip_latency.rbi +1 -1
- data/rbi/telnyx/resources/global_ip_usage.rbi +1 -1
- data/rbi/telnyx/resources/ip_connections.rbi +5 -0
- data/rbi/telnyx/resources/ledger_billing_group_reports.rbi +4 -2
- data/rbi/telnyx/resources/messages/rcs.rbi +2 -1
- data/rbi/telnyx/resources/messages.rbi +39 -5
- data/rbi/telnyx/resources/messaging/rcs/agents.rbi +8 -6
- data/rbi/telnyx/resources/messaging/rcs.rbi +3 -2
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +3 -1
- data/rbi/telnyx/resources/messaging_10dlc/campaign/osr.rbi +3 -1
- data/rbi/telnyx/resources/messaging_10dlc/campaign/usecase.rbi +2 -1
- data/rbi/telnyx/resources/messaging_10dlc/campaign.rbi +2 -1
- data/rbi/telnyx/resources/messaging_10dlc/partner_campaigns.rbi +1 -1
- data/rbi/telnyx/resources/messaging_10dlc/phone_number_campaigns.rbi +5 -3
- data/rbi/telnyx/resources/messaging_10dlc.rbi +2 -1
- data/rbi/telnyx/resources/messaging_hosted_number_orders/actions.rbi +1 -1
- data/rbi/telnyx/resources/messaging_hosted_number_orders.rbi +8 -4
- data/rbi/telnyx/resources/messaging_hosted_numbers.rbi +1 -1
- data/rbi/telnyx/resources/messaging_numbers_bulk_updates.rbi +4 -2
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +7 -5
- data/rbi/telnyx/resources/messaging_profiles.rbi +14 -7
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +5 -5
- data/rbi/telnyx/resources/messaging_url_domains.rbi +2 -1
- data/rbi/telnyx/resources/mobile_phone_numbers/messaging.rbi +2 -2
- data/rbi/telnyx/resources/mobile_phone_numbers.rbi +3 -3
- data/rbi/telnyx/resources/mobile_voice_connections.rbi +5 -5
- data/rbi/telnyx/resources/number_order_phone_numbers.rbi +2 -1
- data/rbi/telnyx/resources/ota_updates.rbi +2 -1
- data/rbi/telnyx/resources/payment.rbi +1 -1
- data/rbi/telnyx/resources/phone_number_blocks/jobs.rbi +5 -2
- data/rbi/telnyx/resources/phone_numbers/actions.rbi +6 -3
- data/rbi/telnyx/resources/phone_numbers/csv_downloads.rbi +7 -3
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +4 -2
- data/rbi/telnyx/resources/phone_numbers/messaging.rbi +6 -3
- data/rbi/telnyx/resources/phone_numbers/voice.rbi +7 -3
- data/rbi/telnyx/resources/phone_numbers.rbi +12 -5
- data/rbi/telnyx/resources/phone_numbers_regulatory_requirements.rbi +3 -1
- data/rbi/telnyx/resources/pricing/products.rbi +3 -1
- data/rbi/telnyx/resources/rcs/agents/test_devices.rbi +66 -0
- data/rbi/telnyx/resources/rcs/agents.rbi +163 -0
- data/rbi/telnyx/resources/rcs/brands.rbi +127 -0
- data/rbi/telnyx/resources/rcs.rbi +20 -0
- data/rbi/telnyx/resources/regulatory_requirements.rbi +3 -1
- data/rbi/telnyx/resources/requirement_groups.rbi +13 -6
- data/rbi/telnyx/resources/room_compositions.rbi +5 -2
- data/rbi/telnyx/resources/room_participants.rbi +4 -2
- data/rbi/telnyx/resources/room_recordings.rbi +8 -3
- data/rbi/telnyx/resources/rooms/sessions/actions.rbi +9 -3
- data/rbi/telnyx/resources/rooms/sessions.rbi +11 -4
- data/rbi/telnyx/resources/rooms.rbi +5 -2
- data/rbi/telnyx/resources/short_codes.rbi +4 -2
- data/rbi/telnyx/resources/sim_cards/actions.rbi +1 -1
- data/rbi/telnyx/resources/sip_registration_status.rbi +19 -6
- data/rbi/telnyx/resources/storage/migration_sources.rbi +5 -3
- data/rbi/telnyx/resources/storage/migrations/actions.rbi +1 -1
- data/rbi/telnyx/resources/storage/migrations.rbi +2 -2
- data/rbi/telnyx/resources/storage.rbi +1 -1
- data/rbi/telnyx/resources/sub_number_orders.rbi +3 -1
- data/rbi/telnyx/resources/user_addresses.rbi +5 -1
- data/rbi/telnyx/resources/verifications/actions.rbi +3 -1
- data/rbi/telnyx/resources/verifications/by_phone_number/actions.rbi +2 -1
- data/rbi/telnyx/resources/verifications/by_phone_number.rbi +2 -1
- data/rbi/telnyx/resources/verifications.rbi +13 -5
- data/rbi/telnyx/resources/verified_numbers/actions.rbi +2 -1
- data/rbi/telnyx/resources/verified_numbers.rbi +2 -2
- data/rbi/telnyx/resources/verify_profiles.rbi +3 -2
- data/rbi/telnyx/resources/webhooks.rbi +2 -2
- data/rbi/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbi +3 -2
- data/rbi/telnyx/resources/whatsapp/business_accounts/settings.rbi +3 -2
- data/rbi/telnyx/resources/whatsapp/business_accounts.rbi +4 -3
- data/rbi/telnyx/resources/whatsapp/phone_numbers/calling_settings.rbi +2 -2
- data/rbi/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbi +4 -2
- data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi +5 -3
- data/rbi/telnyx/resources/whatsapp/phone_numbers/profile.rbi +3 -2
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +15 -4
- data/rbi/telnyx/resources/whatsapp/templates.rbi +4 -2
- data/rbi/telnyx/resources/whatsapp/user_data.rbi +4 -2
- data/rbi/telnyx/resources/whatsapp_message_templates.rbi +4 -3
- data/sig/telnyx/client.rbs +1 -1
- data/sig/telnyx/models/actions/purchase_create_response.rbs +6 -6
- data/sig/telnyx/models/actions/register_create_response.rbs +6 -6
- data/sig/telnyx/models/actions/wireless_error_c5290d5308.rbs +66 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +23 -0
- data/sig/telnyx/models/ai/collection.rbs +91 -0
- data/sig/telnyx/models/ai/collection_create_params.rbs +60 -0
- data/sig/telnyx/models/ai/collection_delete_params.rbs +25 -0
- data/sig/telnyx/models/ai/collection_envelope.rbs +17 -0
- data/sig/telnyx/models/ai/collection_list_params.rbs +34 -0
- data/sig/telnyx/models/ai/collection_retrieve_by_id_params.rbs +25 -0
- data/sig/telnyx/models/ai/collection_retrieve_documents_params.rbs +91 -0
- data/sig/telnyx/models/ai/collection_retrieve_documents_response.rbs +206 -0
- data/sig/telnyx/models/ai/collection_retrieve_params.rbs +25 -0
- data/sig/telnyx/models/ai/collection_update_params.rbs +38 -0
- data/sig/telnyx/models/ai/collections/retrieval_settings.rbs +47 -0
- data/sig/telnyx/models/ai/collections/retrieval_settings_wrapper.rbs +35 -0
- data/sig/telnyx/models/ai/collections/setting_create_params.rbs +29 -0
- data/sig/telnyx/models/ai/collections/setting_list_params.rbs +27 -0
- data/sig/telnyx/models/ai/collections/setting_patch_all_params.rbs +29 -0
- data/sig/telnyx/models/ai/collections/settings_envelope.rbs +26 -0
- data/sig/telnyx/models/ai/collections/settings_request.rbs +26 -0
- data/sig/telnyx/models/ai/collections/source.rbs +63 -0
- data/sig/telnyx/models/ai/collections/source_create_params.rbs +29 -0
- data/sig/telnyx/models/ai/collections/source_create_response.rbs +21 -0
- data/sig/telnyx/models/ai/collections/source_delete_params.rbs +32 -0
- data/sig/telnyx/models/ai/collections/source_list_params.rbs +27 -0
- data/sig/telnyx/models/ai/collections/source_list_response.rbs +24 -0
- data/sig/telnyx/models/ai/collections/source_replace_params.rbs +35 -0
- data/sig/telnyx/models/ai/collections/source_replace_response.rbs +70 -0
- data/sig/telnyx/models/ai/collections/source_request.rbs +31 -0
- data/sig/telnyx/models/ai/collections/source_type.rbs +20 -0
- data/sig/telnyx/models/ai/telephony_settings.rbs +7 -0
- data/sig/telnyx/models/ai/tool_create_params.rbs +9 -0
- data/sig/telnyx/models/ai/tool_update_params.rbs +9 -0
- data/sig/telnyx/models/ai/update_dynamic_variables_tool_params.rbs +55 -0
- data/sig/telnyx/models/credential_connection.rbs +7 -0
- data/sig/telnyx/models/credential_connection_update_params.rbs +7 -0
- data/sig/telnyx/models/fqdn_connection.rbs +7 -0
- data/sig/telnyx/models/fqdn_connection_update_params.rbs +7 -0
- data/sig/telnyx/models/fqdn_connections/fqdn_authentication.rbs +135 -0
- data/sig/telnyx/models/fqdn_connections/fqdn_authentication_list_params.rbs +26 -0
- data/sig/telnyx/models/fqdn_connections/fqdn_authentication_list_response.rbs +24 -0
- data/sig/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_params.rbs +118 -0
- data/sig/telnyx/models/fqdn_connections/fqdn_authentication_patch_all_response.rbs +24 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +613 -6
- data/sig/telnyx/models/ip_connection.rbs +7 -0
- data/sig/telnyx/models/ip_connection_update_params.rbs +7 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta_705dfa7312.rbs +49 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbs +6 -6
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbs +6 -6
- data/sig/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta_ffba4faa88.rbs +49 -0
- data/sig/telnyx/models/message_cancel_scheduled_response.rbs +6 -6
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +8 -6
- data/sig/telnyx/models/message_retrieve_response.rbs +610 -1
- data/sig/telnyx/models/message_schedule_response.rbs +7 -6
- 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 +7 -6
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/message_whatsapp_params.rbs +69 -0
- data/sig/telnyx/models/message_whatsapp_response.rbs +189 -0
- data/sig/telnyx/models/messaging_error_0b38e7044b.rbs +64 -0
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +581 -0
- data/sig/telnyx/models/messaging_pagination_meta_0b38e7044b.rbs +35 -0
- data/sig/telnyx/models/messaging_profile_metric_list_response.rbs +6 -6
- data/sig/telnyx/models/messaging_profiles/autoresp_config_list_response.rbs +4 -4
- data/sig/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_entity_type.rbs +26 -0
- data/sig/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_tf_verification_request.rbs +190 -0
- data/sig/telnyx/models/messaging_tollfree/verification/messaging_toll_free_verification_verification_request_egress.rbs +233 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_create_params.rbs +1 -1
- data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rbs +245 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_update_params.rbs +1 -1
- data/sig/telnyx/models/netapps_location_17904fcfbc.rbs +44 -0
- data/sig/telnyx/models/network_coverage_list_response.rbs +7 -5
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +395 -0
- data/sig/telnyx/models/numbers_phone_number_detailed.rbs +293 -0
- data/sig/telnyx/models/oauth_oauth_pagination_meta.rbs +43 -0
- data/sig/telnyx/models/phone_number_retrieve_response.rbs +8 -5
- data/sig/telnyx/models/phone_number_update_response.rbs +8 -5
- data/sig/telnyx/models/pricing/product_retrieve_params.rbs +10 -1
- data/sig/telnyx/models/rcs/agent_campaign_configuration.rbs +53 -0
- data/sig/telnyx/models/rcs/agent_configuration.rbs +250 -0
- data/sig/telnyx/models/rcs/agent_consent_configuration.rbs +100 -0
- data/sig/telnyx/models/rcs/agent_create_params.rbs +58 -0
- data/sig/telnyx/models/rcs/agent_email_contact.rbs +17 -0
- data/sig/telnyx/models/rcs/agent_interaction.rbs +50 -0
- data/sig/telnyx/models/rcs/agent_launch_params.rbs +82 -0
- data/sig/telnyx/models/rcs/agent_list_params.rbs +27 -0
- data/sig/telnyx/models/rcs/agent_list_response.rbs +9 -0
- data/sig/telnyx/models/rcs/agent_phone_contact.rbs +17 -0
- data/sig/telnyx/models/rcs/agent_response.rbs +130 -0
- data/sig/telnyx/models/rcs/agent_retrieve_carrier_approvals_params.rbs +22 -0
- data/sig/telnyx/models/rcs/agent_retrieve_carrier_approvals_response.rbs +10 -0
- data/sig/telnyx/models/rcs/agent_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/rcs/agent_submission_status.rbs +17 -0
- data/sig/telnyx/models/rcs/agent_submit_params.rbs +22 -0
- data/sig/telnyx/models/rcs/agent_testing_configuration.rbs +32 -0
- data/sig/telnyx/models/rcs/agent_update_params.rbs +67 -0
- data/sig/telnyx/models/rcs/agent_use_case.rbs +18 -0
- data/sig/telnyx/models/rcs/agent_website_contact.rbs +17 -0
- data/sig/telnyx/models/rcs/agents/test_device_create_params.rbs +32 -0
- data/sig/telnyx/models/rcs/agents/test_device_delete_params.rbs +32 -0
- data/sig/telnyx/models/rcs/agents/test_device_list_params.rbs +27 -0
- data/sig/telnyx/models/rcs/agents/test_device_list_response.rbs +12 -0
- data/sig/telnyx/models/rcs/agents/test_device_response.rbs +46 -0
- data/sig/telnyx/models/rcs/brand_contact.rbs +70 -0
- data/sig/telnyx/models/rcs/brand_create_params.rbs +182 -0
- data/sig/telnyx/models/rcs/brand_legal_entity_type.rbs +24 -0
- data/sig/telnyx/models/rcs/brand_list_params.rbs +16 -0
- data/sig/telnyx/models/rcs/brand_list_response.rbs +9 -0
- data/sig/telnyx/models/rcs/brand_organization_type.rbs +20 -0
- data/sig/telnyx/models/rcs/brand_response.rbs +154 -0
- data/sig/telnyx/models/rcs/brand_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/rcs/brand_submit_params.rbs +22 -0
- data/sig/telnyx/models/rcs/brand_update_params.rbs +215 -0
- data/sig/telnyx/models/rcs/capabilities_response.rbs +62 -0
- data/sig/telnyx/models/rcs/carrier_approval_response.rbs +77 -0
- data/sig/telnyx/models/rcs/ein_brand_identifier.rbs +17 -0
- data/sig/telnyx/models/rcs/rcs_agent.rbs +76 -0
- data/sig/telnyx/models/rcs/rcs_agent_response.rbs +19 -0
- data/sig/telnyx/models/rcs/stock_symbol_brand_identifier.rbs +18 -0
- data/sig/telnyx/models/report_list_mdrs_response.rbs +6 -6
- data/sig/telnyx/models/reports/reporting_pagination_meta_77109e5d17.rbs +47 -0
- data/sig/telnyx/models/sim_cards/action_disable_response.rbs +7 -6
- data/sig/telnyx/models/sim_cards/action_enable_response.rbs +7 -6
- data/sig/telnyx/models/sim_cards/action_remove_public_ip_response.rbs +6 -6
- data/sig/telnyx/models/sim_cards/action_retrieve_response.rbs +7 -6
- data/sig/telnyx/models/sim_cards/action_set_public_ip_response.rbs +6 -6
- data/sig/telnyx/models/sim_cards/action_set_standby_response.rbs +6 -6
- data/sig/telnyx/models/sim_cards/wireless_sim_card_action.rbs +130 -0
- data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs +5 -1
- data/sig/telnyx/models/sip_registration_status_retrieve_response.rbs +9 -14
- data/sig/telnyx/models/speech_to_text_list_providers_response.rbs +5 -0
- data/sig/telnyx/models/text_to_speech_list_voices_response.rbs +7 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +1 -1
- data/sig/telnyx/models/unwrap_webhook_event.rbs +1 -1
- data/sig/telnyx/models/user_address_create_response.rbs +8 -5
- data/sig/telnyx/models/user_address_retrieve_response.rbs +8 -5
- data/sig/telnyx/models/user_addresses_user_address.rbs +134 -0
- data/sig/telnyx/models/virtual_cross_connects_coverage_list_response.rbs +7 -5
- data/sig/telnyx/models/whatsapp/phone_number_get_params.rbs +34 -0
- data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +124 -0
- data/sig/telnyx/models.rbs +21 -3
- data/sig/telnyx/resources/ai/collections/settings.rbs +28 -0
- data/sig/telnyx/resources/ai/collections/sources.rbs +35 -0
- data/sig/telnyx/resources/ai/collections.rbs +59 -0
- data/sig/telnyx/resources/ai/tools.rbs +2 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- data/sig/telnyx/resources/credential_connections.rbs +1 -0
- data/sig/telnyx/resources/fqdn_connections/fqdn_authentication.rbs +28 -0
- data/sig/telnyx/resources/fqdn_connections.rbs +3 -0
- data/sig/telnyx/resources/ip_connections.rbs +1 -0
- data/sig/telnyx/resources/messages.rbs +10 -0
- data/sig/telnyx/resources/messaging/rcs/agents.rbs +3 -3
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +5 -5
- data/sig/telnyx/resources/phone_numbers.rbs +1 -1
- data/sig/telnyx/resources/pricing/products.rbs +2 -1
- data/sig/telnyx/resources/rcs/agents/test_devices.rbs +28 -0
- data/sig/telnyx/resources/rcs/agents.rbs +59 -0
- data/sig/telnyx/resources/rcs/brands.rbs +50 -0
- data/sig/telnyx/resources/rcs.rbs +11 -0
- data/sig/telnyx/resources/sim_cards/actions.rbs +1 -1
- data/sig/telnyx/resources/user_addresses.rbs +1 -1
- data/sig/telnyx/resources/webhooks.rbs +2 -2
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +6 -0
- metadata +311 -11
- data/lib/telnyx/models/rcs_agent.rb +0 -80
- data/lib/telnyx/models/rcs_agent_response.rb +0 -15
- data/lib/telnyx/resources/rcs_agents.rb +0 -14
- data/rbi/telnyx/models/rcs_agent.rbi +0 -117
- data/rbi/telnyx/models/rcs_agent_response.rbi +0 -26
- data/rbi/telnyx/resources/rcs_agents.rbi +0 -12
- data/sig/telnyx/models/rcs_agent.rbs +0 -72
- data/sig/telnyx/models/rcs_agent_response.rbs +0 -15
- data/sig/telnyx/resources/rcs_agents.rbs +0 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5d395ac243c19bbd84171e5b158b44af82f684714df67d8b13ff06208e6f1388
|
|
4
|
+
data.tar.gz: 4e9d4f1eee61be8feeb4e9e44e608c3bdb01744cefccd5abf57292c9f552a0ce
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e777aa5bec26f33b56182ebce351ffc7d24ae41a9138087af8e404815fe8ea3083ccd3e7ed1de577cd362ec15f3fc5a94e3c1afeecc5fa960c3ceabc07c771fd
|
|
7
|
+
data.tar.gz: d6da175b5769d63fbe5de9ab5b994ba51d4f3ca96ac04cb3b9769f9de1a99ecd07df838c427028b920ce0254ba6ab3de1a66eac0e12c35eb6fbed2fb570efc48
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [5.160.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.159.0...v5.160.0) (2026-08-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* promote from staging 6d802d8 ([6997207](https://github.com/team-telnyx/telnyx-ruby/commit/6997207468e5c2bd5224f2d0fbdcf469518819c6))
|
|
9
|
+
|
|
3
10
|
## [5.159.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.158.0...v5.159.0) (2026-08-03)
|
|
4
11
|
|
|
5
12
|
|
data/README.md
CHANGED
data/lib/telnyx/client.rb
CHANGED
|
@@ -275,7 +275,6 @@ module Telnyx
|
|
|
275
275
|
# @return [Telnyx::Resources::Media]
|
|
276
276
|
attr_reader :media
|
|
277
277
|
|
|
278
|
-
# Messages
|
|
279
278
|
# @return [Telnyx::Resources::Messages]
|
|
280
279
|
attr_reader :messages
|
|
281
280
|
|
|
@@ -421,8 +420,8 @@ module Telnyx
|
|
|
421
420
|
# @return [Telnyx::Resources::Queues]
|
|
422
421
|
attr_reader :queues
|
|
423
422
|
|
|
424
|
-
# @return [Telnyx::Resources::
|
|
425
|
-
attr_reader :
|
|
423
|
+
# @return [Telnyx::Resources::Rcs]
|
|
424
|
+
attr_reader :rcs
|
|
426
425
|
|
|
427
426
|
# Call Recordings operations.
|
|
428
427
|
# @return [Telnyx::Resources::RecordingTranscriptions]
|
|
@@ -942,7 +941,7 @@ module Telnyx
|
|
|
942
941
|
@private_wireless_gateways = Telnyx::Resources::PrivateWirelessGateways.new(client: self)
|
|
943
942
|
@public_internet_gateways = Telnyx::Resources::PublicInternetGateways.new(client: self)
|
|
944
943
|
@queues = Telnyx::Resources::Queues.new(client: self)
|
|
945
|
-
@
|
|
944
|
+
@rcs = Telnyx::Resources::Rcs.new(client: self)
|
|
946
945
|
@recording_transcriptions = Telnyx::Resources::RecordingTranscriptions.new(client: self)
|
|
947
946
|
@recordings = Telnyx::Resources::Recordings.new(client: self)
|
|
948
947
|
@regions = Telnyx::Resources::Regions.new(client: self)
|
|
@@ -13,13 +13,13 @@ module Telnyx
|
|
|
13
13
|
|
|
14
14
|
# @!attribute errors
|
|
15
15
|
#
|
|
16
|
-
# @return [Array<Telnyx::Models::
|
|
17
|
-
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
16
|
+
# @return [Array<Telnyx::Models::Actions::WirelessErrorC5290d5308>, nil]
|
|
17
|
+
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Actions::WirelessErrorC5290d5308] }
|
|
18
18
|
|
|
19
19
|
# @!method initialize(data: nil, errors: nil)
|
|
20
20
|
# @param data [Array<Telnyx::Models::SimpleSimCard>] Successfully registered SIM cards.
|
|
21
21
|
#
|
|
22
|
-
# @param errors [Array<Telnyx::Models::
|
|
22
|
+
# @param errors [Array<Telnyx::Models::Actions::WirelessErrorC5290d5308>]
|
|
23
23
|
end
|
|
24
24
|
end
|
|
25
25
|
end
|
|
@@ -13,13 +13,13 @@ module Telnyx
|
|
|
13
13
|
|
|
14
14
|
# @!attribute errors
|
|
15
15
|
#
|
|
16
|
-
# @return [Array<Telnyx::Models::
|
|
17
|
-
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
16
|
+
# @return [Array<Telnyx::Models::Actions::WirelessErrorC5290d5308>, nil]
|
|
17
|
+
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Actions::WirelessErrorC5290d5308] }
|
|
18
18
|
|
|
19
19
|
# @!method initialize(data: nil, errors: nil)
|
|
20
20
|
# @param data [Array<Telnyx::Models::SimpleSimCard>] Successfully registered SIM cards.
|
|
21
21
|
#
|
|
22
|
-
# @param errors [Array<Telnyx::Models::
|
|
22
|
+
# @param errors [Array<Telnyx::Models::Actions::WirelessErrorC5290d5308>]
|
|
23
23
|
end
|
|
24
24
|
end
|
|
25
25
|
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Actions
|
|
6
|
+
class WirelessErrorC5290d5308 < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute code
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :code, String
|
|
11
|
+
|
|
12
|
+
# @!attribute title
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :title, String
|
|
16
|
+
|
|
17
|
+
# @!attribute detail
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :detail, String
|
|
21
|
+
|
|
22
|
+
# @!attribute meta
|
|
23
|
+
#
|
|
24
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
25
|
+
optional :meta, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
26
|
+
|
|
27
|
+
# @!attribute source
|
|
28
|
+
#
|
|
29
|
+
# @return [Telnyx::Models::Actions::WirelessErrorC5290d5308::Source, nil]
|
|
30
|
+
optional :source, -> { Telnyx::Actions::WirelessErrorC5290d5308::Source }
|
|
31
|
+
|
|
32
|
+
# @!method initialize(code:, title:, detail: nil, meta: nil, source: nil)
|
|
33
|
+
# @param code [String]
|
|
34
|
+
# @param title [String]
|
|
35
|
+
# @param detail [String]
|
|
36
|
+
# @param meta [Hash{Symbol=>Object}]
|
|
37
|
+
# @param source [Telnyx::Models::Actions::WirelessErrorC5290d5308::Source]
|
|
38
|
+
|
|
39
|
+
# @see Telnyx::Models::Actions::WirelessErrorC5290d5308#source
|
|
40
|
+
class Source < Telnyx::Internal::Type::BaseModel
|
|
41
|
+
# @!attribute parameter
|
|
42
|
+
# Indicates which query parameter caused the error.
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :parameter, String
|
|
46
|
+
|
|
47
|
+
# @!attribute pointer
|
|
48
|
+
# JSON pointer (RFC6901) to the offending entity.
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :pointer, String
|
|
52
|
+
|
|
53
|
+
# @!method initialize(parameter: nil, pointer: nil)
|
|
54
|
+
# @param parameter [String] Indicates which query parameter caused the error.
|
|
55
|
+
#
|
|
56
|
+
# @param pointer [String] JSON pointer (RFC6901) to the offending entity.
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -192,7 +192,7 @@ module Telnyx
|
|
|
192
192
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
193
193
|
# endpoints.
|
|
194
194
|
#
|
|
195
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
|
|
195
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>, nil]
|
|
196
196
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
197
197
|
|
|
198
198
|
# @!attribute transcription
|
|
@@ -263,7 +263,7 @@ module Telnyx
|
|
|
263
263
|
#
|
|
264
264
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
265
265
|
#
|
|
266
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
266
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
267
267
|
#
|
|
268
268
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
269
269
|
#
|
|
@@ -38,6 +38,9 @@ module Telnyx
|
|
|
38
38
|
# (BETA) The pay tool allows the assistant to collect card payments from the caller via DTMF during the conversation. Recording is automatically paused while the pay tool is active and resumes when the payment flow completes. The connector_name must reference a pay connector configured in the Telnyx API.
|
|
39
39
|
variant :pay, -> { Telnyx::AI::AssistantTool::Pay }
|
|
40
40
|
|
|
41
|
+
# The update_dynamic_variables tool lets the assistant write values into the conversation's dynamic-variables context during the call. Updated variables are available to later `{{variable}}` interpolation (prompts, speak nodes, message templates) and to flow edge conditions. Declare each variable the assistant is allowed to set under `updatable_variables`.
|
|
42
|
+
variant :update_dynamic_variables, -> { Telnyx::AI::AssistantTool::UpdateDynamicVariables }
|
|
43
|
+
|
|
41
44
|
class ClientSideTool < Telnyx::Internal::Type::BaseModel
|
|
42
45
|
# @!attribute client_side_tool
|
|
43
46
|
#
|
|
@@ -1069,8 +1072,32 @@ module Telnyx
|
|
|
1069
1072
|
# @param type [Symbol, :pay]
|
|
1070
1073
|
end
|
|
1071
1074
|
|
|
1075
|
+
class UpdateDynamicVariables < Telnyx::Internal::Type::BaseModel
|
|
1076
|
+
# @!attribute type
|
|
1077
|
+
#
|
|
1078
|
+
# @return [Symbol, :update_dynamic_variables]
|
|
1079
|
+
required :type, const: :update_dynamic_variables
|
|
1080
|
+
|
|
1081
|
+
# @!attribute update_dynamic_variables
|
|
1082
|
+
# Configuration for an update_dynamic_variables tool.
|
|
1083
|
+
#
|
|
1084
|
+
# @return [Telnyx::Models::AI::UpdateDynamicVariablesToolParams]
|
|
1085
|
+
required :update_dynamic_variables, -> { Telnyx::AI::UpdateDynamicVariablesToolParams }
|
|
1086
|
+
|
|
1087
|
+
# @!method initialize(update_dynamic_variables:, type: :update_dynamic_variables)
|
|
1088
|
+
# The update_dynamic_variables tool lets the assistant write values into the
|
|
1089
|
+
# conversation's dynamic-variables context during the call. Updated variables are
|
|
1090
|
+
# available to later `{{variable}}` interpolation (prompts, speak nodes, message
|
|
1091
|
+
# templates) and to flow edge conditions. Declare each variable the assistant is
|
|
1092
|
+
# allowed to set under `updatable_variables`.
|
|
1093
|
+
#
|
|
1094
|
+
# @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
|
|
1095
|
+
#
|
|
1096
|
+
# @param type [Symbol, :update_dynamic_variables]
|
|
1097
|
+
end
|
|
1098
|
+
|
|
1072
1099
|
# @!method self.variants
|
|
1073
|
-
# @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay)]
|
|
1100
|
+
# @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables)]
|
|
1074
1101
|
end
|
|
1075
1102
|
end
|
|
1076
1103
|
end
|
|
@@ -204,7 +204,7 @@ module Telnyx
|
|
|
204
204
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
205
205
|
# endpoints.
|
|
206
206
|
#
|
|
207
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
|
|
207
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>, nil]
|
|
208
208
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
209
209
|
|
|
210
210
|
# @!attribute transcription
|
|
@@ -285,7 +285,7 @@ module Telnyx
|
|
|
285
285
|
#
|
|
286
286
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
287
287
|
#
|
|
288
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
288
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
289
289
|
#
|
|
290
290
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
291
291
|
#
|
|
@@ -189,7 +189,7 @@ module Telnyx
|
|
|
189
189
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
190
190
|
# endpoints.
|
|
191
191
|
#
|
|
192
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
|
|
192
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>, nil]
|
|
193
193
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
194
194
|
|
|
195
195
|
# @!attribute transcription
|
|
@@ -266,7 +266,7 @@ module Telnyx
|
|
|
266
266
|
#
|
|
267
267
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
268
268
|
#
|
|
269
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
269
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
270
270
|
#
|
|
271
271
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
272
272
|
#
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#list
|
|
7
|
+
class Collection < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute created_at
|
|
9
|
+
#
|
|
10
|
+
# @return [Time, nil]
|
|
11
|
+
optional :created_at, Time
|
|
12
|
+
|
|
13
|
+
# @!attribute description
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :description, String
|
|
17
|
+
|
|
18
|
+
# @!attribute name
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :name, String
|
|
22
|
+
|
|
23
|
+
# @!attribute record_type
|
|
24
|
+
# Identifies the record type. Always `ai_collection`.
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :record_type, String
|
|
28
|
+
|
|
29
|
+
# @!attribute settings
|
|
30
|
+
#
|
|
31
|
+
# @return [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper, nil]
|
|
32
|
+
optional :settings, -> { Telnyx::AI::Collections::RetrievalSettingsWrapper }
|
|
33
|
+
|
|
34
|
+
# @!attribute slug
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :slug, String
|
|
38
|
+
|
|
39
|
+
# @!attribute sources
|
|
40
|
+
#
|
|
41
|
+
# @return [Array<Telnyx::Models::AI::Collections::Source>, nil]
|
|
42
|
+
optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::Source] }
|
|
43
|
+
|
|
44
|
+
# @!attribute status
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :status, String
|
|
48
|
+
|
|
49
|
+
# @!attribute updated_at
|
|
50
|
+
#
|
|
51
|
+
# @return [Time, nil]
|
|
52
|
+
optional :updated_at, Time
|
|
53
|
+
|
|
54
|
+
# @!attribute uuid
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :uuid, String
|
|
58
|
+
|
|
59
|
+
# @!method initialize(created_at: nil, description: nil, name: nil, record_type: nil, settings: nil, slug: nil, sources: nil, status: nil, updated_at: nil, uuid: nil)
|
|
60
|
+
# @param created_at [Time]
|
|
61
|
+
#
|
|
62
|
+
# @param description [String]
|
|
63
|
+
#
|
|
64
|
+
# @param name [String]
|
|
65
|
+
#
|
|
66
|
+
# @param record_type [String] Identifies the record type. Always `ai_collection`.
|
|
67
|
+
#
|
|
68
|
+
# @param settings [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper]
|
|
69
|
+
#
|
|
70
|
+
# @param slug [String]
|
|
71
|
+
#
|
|
72
|
+
# @param sources [Array<Telnyx::Models::AI::Collections::Source>]
|
|
73
|
+
#
|
|
74
|
+
# @param status [String]
|
|
75
|
+
#
|
|
76
|
+
# @param updated_at [Time]
|
|
77
|
+
#
|
|
78
|
+
# @param uuid [String]
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#create
|
|
7
|
+
class CollectionCreateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute name
|
|
12
|
+
# Human-readable collection name.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :name, String
|
|
16
|
+
|
|
17
|
+
# @!attribute description
|
|
18
|
+
# Optional description.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :description, String
|
|
22
|
+
|
|
23
|
+
# @!attribute settings
|
|
24
|
+
# Optional retrieval settings.
|
|
25
|
+
#
|
|
26
|
+
# @return [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper, nil]
|
|
27
|
+
optional :settings, -> { Telnyx::AI::Collections::RetrievalSettingsWrapper }
|
|
28
|
+
|
|
29
|
+
# @!attribute slug
|
|
30
|
+
# Optional slug (unique per organization). Derived from `name` when omitted.
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :slug, String
|
|
34
|
+
|
|
35
|
+
# @!attribute sources
|
|
36
|
+
# Optional sources to attach at creation time.
|
|
37
|
+
#
|
|
38
|
+
# @return [Array<Telnyx::Models::AI::Collections::SourceRequest>, nil]
|
|
39
|
+
optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::SourceRequest] }
|
|
40
|
+
|
|
41
|
+
# @!method initialize(name:, description: nil, settings: nil, slug: nil, sources: nil, request_options: {})
|
|
42
|
+
# @param name [String] Human-readable collection name.
|
|
43
|
+
#
|
|
44
|
+
# @param description [String] Optional description.
|
|
45
|
+
#
|
|
46
|
+
# @param settings [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper] Optional retrieval settings.
|
|
47
|
+
#
|
|
48
|
+
# @param slug [String] Optional slug (unique per organization). Derived from `name` when omitted.
|
|
49
|
+
#
|
|
50
|
+
# @param sources [Array<Telnyx::Models::AI::Collections::SourceRequest>] Optional sources to attach at creation time.
|
|
51
|
+
#
|
|
52
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#delete
|
|
7
|
+
class CollectionDeleteParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute uuid
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :uuid, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(uuid:, request_options: {})
|
|
17
|
+
# @param uuid [String]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#create
|
|
7
|
+
class CollectionEnvelope < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::AI::Collection, nil]
|
|
11
|
+
optional :data, -> { Telnyx::AI::Collection }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::AI::Collection]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#list
|
|
7
|
+
class CollectionListParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute page_number
|
|
12
|
+
# Page number to return (1-based). Defaults to 1.
|
|
13
|
+
#
|
|
14
|
+
# @return [Integer, nil]
|
|
15
|
+
optional :page_number, Integer
|
|
16
|
+
|
|
17
|
+
# @!attribute page_size
|
|
18
|
+
# Number of results per page. Defaults to 20.
|
|
19
|
+
#
|
|
20
|
+
# @return [Integer, nil]
|
|
21
|
+
optional :page_size, Integer
|
|
22
|
+
|
|
23
|
+
# @!method initialize(page_number: nil, page_size: nil, request_options: {})
|
|
24
|
+
# @param page_number [Integer] Page number to return (1-based). Defaults to 1.
|
|
25
|
+
#
|
|
26
|
+
# @param page_size [Integer] Number of results per page. Defaults to 20.
|
|
27
|
+
#
|
|
28
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#retrieve_by_id
|
|
7
|
+
class CollectionRetrieveByIDParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute uuid
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :uuid, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(uuid:, request_options: {})
|
|
17
|
+
# @param uuid [String]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Collections#retrieve_documents
|
|
7
|
+
class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute slug
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :slug, String
|
|
15
|
+
|
|
16
|
+
# @!attribute filter
|
|
17
|
+
# Field filters applied before ranking, using `filter[field][operator]=value`.
|
|
18
|
+
# Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
|
|
19
|
+
# Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
|
|
20
|
+
# `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
|
|
21
|
+
# `filter[record_id][eq]=rec_123`.
|
|
22
|
+
#
|
|
23
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
24
|
+
optional :filter, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
25
|
+
|
|
26
|
+
# @!attribute page_number
|
|
27
|
+
# Page number to return (1-based). Defaults to 1.
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer, nil]
|
|
30
|
+
optional :page_number, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute page_size
|
|
33
|
+
# Number of results per page. Defaults to 20.
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :page_size, Integer
|
|
37
|
+
|
|
38
|
+
# @!attribute query
|
|
39
|
+
# Natural-language search query. When provided, the text is matched against the
|
|
40
|
+
# collection's document chunks using the collection's `retrieval_type` (vector or
|
|
41
|
+
# hybrid). When omitted, documents are returned as a plain catalog listing.
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :query, String
|
|
45
|
+
|
|
46
|
+
# @!attribute retrieval_type
|
|
47
|
+
# Override the collection's configured retrieval strategy for this request. Echoed
|
|
48
|
+
# back in `meta.retrieval_type`.
|
|
49
|
+
#
|
|
50
|
+
# @return [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType, nil]
|
|
51
|
+
optional :retrieval_type, enum: -> { Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType }
|
|
52
|
+
|
|
53
|
+
# @!attribute sources
|
|
54
|
+
# Comma-separated list of source types to restrict the search to. When omitted,
|
|
55
|
+
# all of the collection's sources are searched.
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :sources, String
|
|
59
|
+
|
|
60
|
+
# @!attribute top_k
|
|
61
|
+
# Maximum number of ranked results to consider. When omitted, the collection's
|
|
62
|
+
# configured `top_k` setting is used.
|
|
63
|
+
#
|
|
64
|
+
# @return [Integer, nil]
|
|
65
|
+
optional :top_k, Integer
|
|
66
|
+
|
|
67
|
+
# @!method initialize(slug:, filter: nil, page_number: nil, page_size: nil, query: nil, retrieval_type: nil, sources: nil, top_k: nil, request_options: {})
|
|
68
|
+
# Some parameter documentations has been truncated, see
|
|
69
|
+
# {Telnyx::Models::AI::CollectionRetrieveDocumentsParams} for more details.
|
|
70
|
+
#
|
|
71
|
+
# @param slug [String]
|
|
72
|
+
#
|
|
73
|
+
# @param filter [Hash{Symbol=>Object}] Field filters applied before ranking, using `filter[field][operator]=value`. Sup
|
|
74
|
+
#
|
|
75
|
+
# @param page_number [Integer] Page number to return (1-based). Defaults to 1.
|
|
76
|
+
#
|
|
77
|
+
# @param page_size [Integer] Number of results per page. Defaults to 20.
|
|
78
|
+
#
|
|
79
|
+
# @param query [String] Natural-language search query. When provided, the text is matched against the co
|
|
80
|
+
#
|
|
81
|
+
# @param retrieval_type [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType] Override the collection's configured retrieval strategy for this request. Echoed
|
|
82
|
+
#
|
|
83
|
+
# @param sources [String] Comma-separated list of source types to restrict the search to. When omitted, al
|
|
84
|
+
#
|
|
85
|
+
# @param top_k [Integer] Maximum number of ranked results to consider. When omitted, the collection's con
|
|
86
|
+
#
|
|
87
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
88
|
+
|
|
89
|
+
# Override the collection's configured retrieval strategy for this request. Echoed
|
|
90
|
+
# back in `meta.retrieval_type`.
|
|
91
|
+
module RetrievalType
|
|
92
|
+
extend Telnyx::Internal::Type::Enum
|
|
93
|
+
|
|
94
|
+
VECTOR = :vector
|
|
95
|
+
HYBRID = :hybrid
|
|
96
|
+
KEYWORD = :keyword
|
|
97
|
+
|
|
98
|
+
# @!method self.values
|
|
99
|
+
# @return [Array<Symbol>]
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|