wavix-ruby-sdk 1.0.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +5 -4
  3. data/.fern/replay.lock +22 -0
  4. data/.fernignore +4 -0
  5. data/lib/wavix/api_keys/client.rb +1 -1
  6. data/lib/wavix/billing/invoices/client.rb +2 -2
  7. data/lib/wavix/billing/transactions/client.rb +2 -2
  8. data/lib/wavix/buy/cities/client.rb +2 -2
  9. data/lib/wavix/buy/countries/client.rb +2 -2
  10. data/lib/wavix/buy/numbers/client.rb +2 -2
  11. data/lib/wavix/buy/region_cities/client.rb +2 -2
  12. data/lib/wavix/buy/regions/client.rb +2 -2
  13. data/lib/wavix/call_control/audio/client.rb +2 -1
  14. data/lib/wavix/call_control/client.rb +4 -3
  15. data/lib/wavix/call_control/streams/client.rb +3 -2
  16. data/lib/wavix/call_control/types/call_dtmf_collect_request_prompt_say.rb +3 -1
  17. data/lib/wavix/call_recording/client.rb +1 -1
  18. data/lib/wavix/call_webhooks/client.rb +15 -1
  19. data/lib/wavix/call_webhooks/types/call_webhooks_create_request.rb +2 -0
  20. data/lib/wavix/call_webhooks/types/delete_call_webhooks_request.rb +2 -0
  21. data/lib/wavix/cart/client.rb +9 -9
  22. data/lib/wavix/cdrs/client.rb +3 -1
  23. data/lib/wavix/cdrs/types/cdr_search_request.rb +3 -3
  24. data/lib/wavix/client.rb +1 -1
  25. data/lib/wavix/number_validator/client.rb +6 -3
  26. data/lib/wavix/number_validator/types/phone_validation_request.rb +2 -2
  27. data/lib/wavix/numbers/client.rb +9 -2
  28. data/lib/wavix/numbers/types/number_update_request.rb +2 -0
  29. data/lib/wavix/profile/config/client.rb +2 -2
  30. data/lib/wavix/sip_trunks/client.rb +9 -7
  31. data/lib/wavix/sip_trunks/types/sip_trunk_create_request.rb +53 -0
  32. data/lib/wavix/sip_trunks/types/sip_trunk_create_request_allowed_ips_item.rb +11 -0
  33. data/lib/wavix/sip_trunks/types/sip_trunk_create_request_host_request.rb +13 -0
  34. data/lib/wavix/sip_trunks/types/sip_trunk_update_request.rb +55 -0
  35. data/lib/wavix/sip_trunks/types/sip_trunk_update_request_allowed_ips_item.rb +11 -0
  36. data/lib/wavix/sip_trunks/types/sip_trunk_update_request_host_request.rb +14 -0
  37. data/lib/wavix/sms_and_mms/messages/client.rb +6 -6
  38. data/lib/wavix/sms_and_mms/opt_outs/client.rb +2 -2
  39. data/lib/wavix/sms_and_mms/sender_ids/client.rb +4 -3
  40. data/lib/wavix/speech_analytics/client.rb +4 -4
  41. data/lib/wavix/sub_accounts/client.rb +5 -1
  42. data/lib/wavix/sub_accounts/types/list_sub_accounts_request.rb +4 -0
  43. data/lib/wavix/sub_accounts/types/sub_accounts_update_request.rb +1 -1
  44. data/lib/wavix/ten_dlc/brand_appeals/client.rb +2 -2
  45. data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_request.rb +1 -1
  46. data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_request_appeal_categories_item.rb +17 -0
  47. data/lib/wavix/ten_dlc/brand_evidence/client.rb +4 -4
  48. data/lib/wavix/ten_dlc/brand_vetting_appeals/client.rb +2 -2
  49. data/lib/wavix/ten_dlc/brand_vetting_appeals/types/ten_dlc_brand_vetting_appeal_create_request.rb +1 -1
  50. data/lib/wavix/ten_dlc/brand_vetting_appeals/types/ten_dlc_brand_vetting_appeal_create_request_appeal_categories_item.rb +18 -0
  51. data/lib/wavix/ten_dlc/brand_vettings/client.rb +2 -1
  52. data/lib/wavix/ten_dlc/brands/client.rb +16 -14
  53. data/lib/wavix/ten_dlc/campaign_numbers/client.rb +6 -6
  54. data/lib/wavix/ten_dlc/campaigns/client.rb +12 -12
  55. data/lib/wavix/ten_dlc/campaigns/types/ten_dlc_campaign_create_request.rb +6 -6
  56. data/lib/wavix/ten_dlc/subscriptions/client.rb +4 -4
  57. data/lib/wavix/two_fa/verification/client.rb +11 -9
  58. data/lib/wavix/types/{document_type_id.rb → api_key_with_secret.rb} +2 -2
  59. data/lib/wavix/types/available_number.rb +1 -1
  60. data/lib/wavix/types/cart_response.rb +1 -1
  61. data/lib/wavix/types/cdr_transcription_response.rb +1 -1
  62. data/lib/wavix/types/document_type.rb +5 -5
  63. data/lib/wavix/types/document_type_info.rb +14 -0
  64. data/lib/wavix/types/file_transcription_response.rb +2 -2
  65. data/lib/wavix/types/message_body.rb +1 -1
  66. data/lib/wavix/types/number.rb +1 -1
  67. data/lib/wavix/types/number_document.rb +1 -1
  68. data/lib/wavix/types/number_list_response.rb +1 -1
  69. data/lib/wavix/types/ten_dlc_brand.rb +1 -1
  70. data/lib/wavix/types/ten_dlc_brand_appeal_create_request.rb +1 -1
  71. data/lib/wavix/types/ten_dlc_brand_appeal_create_request_appeal_categories_item.rb +13 -0
  72. data/lib/wavix/types/ten_dlc_brand_appeal_outcome.rb +1 -1
  73. data/lib/wavix/types/{not_found_error_body.rb → too_many_requests_error_response.rb} +1 -1
  74. data/lib/wavix/types/transcription_filter.rb +3 -3
  75. data/lib/wavix/types/unprocessable_entity_error_body.rb +2 -2
  76. data/lib/wavix/types/webhook_in_use_error_response.rb +14 -0
  77. data/lib/wavix/types/whats_app_business_account.rb +16 -0
  78. data/lib/wavix/types/whats_app_business_account_messaging_limit.rb +15 -0
  79. data/lib/wavix/types/whats_app_message.rb +20 -0
  80. data/lib/wavix/types/whats_app_message_get_response.rb +10 -0
  81. data/lib/wavix/types/whats_app_message_list_item.rb +23 -0
  82. data/lib/wavix/types/whats_app_message_list_item_direction.rb +12 -0
  83. data/lib/wavix/types/whats_app_message_list_item_status.rb +16 -0
  84. data/lib/wavix/types/whats_app_message_list_response.rb +12 -0
  85. data/lib/wavix/types/whats_app_message_send_request.rb +16 -0
  86. data/lib/wavix/types/whats_app_message_send_response.rb +10 -0
  87. data/lib/wavix/types/whats_app_message_status.rb +16 -0
  88. data/lib/wavix/types/whats_app_message_template.rb +12 -0
  89. data/lib/wavix/types/whats_app_problem.rb +23 -0
  90. data/lib/wavix/types/whats_app_problem_error_class.rb +14 -0
  91. data/lib/wavix/types/whats_app_send_template.rb +18 -0
  92. data/lib/wavix/types/whats_app_send_template_button.rb +27 -0
  93. data/lib/wavix/types/whats_app_send_template_button_type.rb +18 -0
  94. data/lib/wavix/types/whats_app_send_template_header.rb +26 -0
  95. data/lib/wavix/types/whats_app_send_template_header_type.rb +16 -0
  96. data/lib/wavix/types/whats_app_sender.rb +19 -0
  97. data/lib/wavix/types/whats_app_sender_list_response.rb +12 -0
  98. data/lib/wavix/types/whats_app_sender_quality_rating.rb +14 -0
  99. data/lib/wavix/types/whats_app_sender_status.rb +21 -0
  100. data/lib/wavix/types/whats_app_template.rb +29 -0
  101. data/lib/wavix/types/whats_app_template_body_component_request.rb +12 -0
  102. data/lib/wavix/types/whats_app_template_body_component_request_example.rb +10 -0
  103. data/lib/wavix/types/whats_app_template_button_request.rb +21 -0
  104. data/lib/wavix/types/whats_app_template_buttons_component_request.rb +10 -0
  105. data/lib/wavix/types/whats_app_template_category.rb +13 -0
  106. data/lib/wavix/types/whats_app_template_component_request.rb +21 -0
  107. data/lib/wavix/types/whats_app_template_copy_code_button_request.rb +10 -0
  108. data/lib/wavix/types/whats_app_template_create_request.rb +20 -0
  109. data/lib/wavix/types/whats_app_template_create_request_category.rb +13 -0
  110. data/lib/wavix/types/whats_app_template_footer_component_request.rb +10 -0
  111. data/lib/wavix/types/whats_app_template_header_component_request.rb +23 -0
  112. data/lib/wavix/types/whats_app_template_location_header_component_request.rb +11 -0
  113. data/lib/wavix/types/{file_transcription_response_status.rb → whats_app_template_location_header_component_request_type.rb} +2 -3
  114. data/lib/wavix/types/whats_app_template_media_header_component_request.rb +12 -0
  115. data/lib/wavix/types/whats_app_template_media_header_component_request_example.rb +10 -0
  116. data/lib/wavix/types/whats_app_template_media_header_component_request_type.rb +11 -0
  117. data/lib/wavix/types/whats_app_template_page_response.rb +12 -0
  118. data/lib/wavix/types/whats_app_template_phone_number_button_request.rb +12 -0
  119. data/lib/wavix/types/whats_app_template_quality_rating.rb +14 -0
  120. data/lib/wavix/types/whats_app_template_quick_reply_button_request.rb +10 -0
  121. data/lib/wavix/types/whats_app_template_response.rb +10 -0
  122. data/lib/wavix/types/whats_app_template_response_component.rb +20 -0
  123. data/lib/wavix/types/whats_app_template_response_component_format.rb +15 -0
  124. data/lib/wavix/types/whats_app_template_status.rb +21 -0
  125. data/lib/wavix/types/whats_app_template_text_header_component_request.rb +14 -0
  126. data/lib/wavix/types/whats_app_template_text_header_component_request_example.rb +10 -0
  127. data/lib/wavix/types/whats_app_template_text_header_component_request_type.rb +11 -0
  128. data/lib/wavix/types/whats_app_template_url_button_request.rb +14 -0
  129. data/lib/wavix/types/whats_app_waba.rb +12 -0
  130. data/lib/wavix/types/whats_app_waba_list_response.rb +12 -0
  131. data/lib/wavix/version.rb +1 -1
  132. data/lib/wavix/voice_campaigns/client.rb +2 -2
  133. data/lib/wavix/webrtc/tokens/client.rb +11 -3
  134. data/lib/wavix/webrtc/tokens/types/list_tokens_request.rb +15 -0
  135. data/lib/wavix/webrtc/tokens/types/web_rtc_token_create_request.rb +1 -1
  136. data/lib/wavix.rb +89 -87
  137. data/reference.md +512 -116
  138. metadata +71 -68
  139. data/lib/wavix/billing/invoices/types/list_invoices_response.rb +0 -17
  140. data/lib/wavix/billing/transactions/types/list_transactions_response.rb +0 -17
  141. data/lib/wavix/buy/cities/types/list_cities_response.rb +0 -13
  142. data/lib/wavix/buy/countries/types/list_countries_response.rb +0 -13
  143. data/lib/wavix/buy/numbers/types/list_numbers_response.rb +0 -15
  144. data/lib/wavix/buy/region_cities/types/list_region_cities_response.rb +0 -13
  145. data/lib/wavix/buy/regions/types/list_regions_response.rb +0 -13
  146. data/lib/wavix/cart/types/checkout_cart_response.rb +0 -11
  147. data/lib/wavix/cart/types/get_cart_response.rb +0 -13
  148. data/lib/wavix/cart/types/remove_cart_response.rb +0 -11
  149. data/lib/wavix/cdrs/types/cdr_search_request_disposition.rb +0 -17
  150. data/lib/wavix/number_validator/types/get_number_validator_response.rb +0 -43
  151. data/lib/wavix/numbers/types/delete_numbers_response.rb +0 -11
  152. data/lib/wavix/profile/config/types/get_config_response.rb +0 -15
  153. data/lib/wavix/sip_trunks/types/update_sip_trunks_request.rb +0 -13
  154. data/lib/wavix/sms_and_mms/messages/types/get_messages_response.rb +0 -45
  155. data/lib/wavix/sms_and_mms/messages/types/list_messages_response.rb +0 -15
  156. data/lib/wavix/sms_and_mms/opt_outs/types/create_opt_outs_response.rb +0 -13
  157. data/lib/wavix/sms_and_mms/sender_ids/types/delete_sender_ids_response.rb +0 -13
  158. data/lib/wavix/speech_analytics/types/create_speech_analytics_response.rb +0 -15
  159. data/lib/wavix/speech_analytics/types/get_speech_analytics_response.rb +0 -31
  160. data/lib/wavix/speech_analytics/types/get_speech_analytics_response_language.rb +0 -17
  161. data/lib/wavix/speech_analytics/types/get_speech_analytics_response_status.rb +0 -14
  162. data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_response.rb +0 -13
  163. data/lib/wavix/ten_dlc/brand_evidence/types/delete_brand_evidence_response.rb +0 -13
  164. data/lib/wavix/ten_dlc/brand_evidence/types/upload_brand_evidence_response.rb +0 -19
  165. data/lib/wavix/ten_dlc/brand_vetting_appeals/types/create_brand_vetting_appeals_response.rb +0 -13
  166. data/lib/wavix/ten_dlc/brands/types/create_brands_response.rb +0 -61
  167. data/lib/wavix/ten_dlc/brands/types/create_brands_response_entity_type.rb +0 -18
  168. data/lib/wavix/ten_dlc/brands/types/create_brands_response_status.rb +0 -19
  169. data/lib/wavix/ten_dlc/brands/types/delete_brands_response.rb +0 -13
  170. data/lib/wavix/ten_dlc/brands/types/get_brands_response.rb +0 -61
  171. data/lib/wavix/ten_dlc/brands/types/get_brands_response_entity_type.rb +0 -18
  172. data/lib/wavix/ten_dlc/brands/types/get_brands_response_status.rb +0 -19
  173. data/lib/wavix/ten_dlc/brands/types/list_brands_response.rb +0 -16
  174. data/lib/wavix/ten_dlc/brands/types/list_brands_response_pagination.rb +0 -20
  175. data/lib/wavix/ten_dlc/brands/types/qualify_usecase_brands_response.rb +0 -17
  176. data/lib/wavix/ten_dlc/brands/types/update_brands_response.rb +0 -61
  177. data/lib/wavix/ten_dlc/brands/types/update_brands_response_entity_type.rb +0 -18
  178. data/lib/wavix/ten_dlc/brands/types/update_brands_response_status.rb +0 -19
  179. data/lib/wavix/ten_dlc/campaign_numbers/types/link_campaign_numbers_response.rb +0 -13
  180. data/lib/wavix/ten_dlc/campaign_numbers/types/list_campaign_numbers_response.rb +0 -17
  181. data/lib/wavix/ten_dlc/campaign_numbers/types/unlink_campaign_numbers_response.rb +0 -13
  182. data/lib/wavix/ten_dlc/campaigns/types/create_campaigns_response.rb +0 -89
  183. data/lib/wavix/ten_dlc/campaigns/types/delete_campaigns_response.rb +0 -13
  184. data/lib/wavix/ten_dlc/campaigns/types/get_campaigns_response.rb +0 -89
  185. data/lib/wavix/ten_dlc/campaigns/types/list_by_brand_campaigns_response.rb +0 -16
  186. data/lib/wavix/ten_dlc/campaigns/types/list_by_brand_campaigns_response_pagination.rb +0 -20
  187. data/lib/wavix/ten_dlc/campaigns/types/list_campaigns_response.rb +0 -16
  188. data/lib/wavix/ten_dlc/campaigns/types/list_campaigns_response_pagination.rb +0 -20
  189. data/lib/wavix/ten_dlc/campaigns/types/update_campaigns_response.rb +0 -89
  190. data/lib/wavix/ten_dlc/subscriptions/types/create_subscriptions_response.rb +0 -16
  191. data/lib/wavix/ten_dlc/subscriptions/types/delete_subscriptions_response.rb +0 -13
  192. data/lib/wavix/two_fa/verification/types/check_verification_response.rb +0 -13
  193. data/lib/wavix/two_fa/verification/types/create_verification_response.rb +0 -25
  194. data/lib/wavix/two_fa/verification/types/resend_verification_response.rb +0 -19
  195. data/lib/wavix/types/bad_request_error_body.rb +0 -11
  196. data/lib/wavix/types/file_transcription_response_language.rb +0 -15
  197. data/lib/wavix/types/sip_trunk_create_request.rb +0 -51
  198. data/lib/wavix/types/sip_trunk_create_request_allowed_ips_item.rb +0 -9
  199. data/lib/wavix/types/sip_trunk_create_request_host_request.rb +0 -11
  200. data/lib/wavix/types/ten_dlc_brand_appeal_outcome_vetting_status.rb +0 -15
  201. data/lib/wavix/types/ten_dlc_brand_status.rb +0 -15
data/reference.md CHANGED
@@ -665,7 +665,6 @@ client.sip_trunks.create(
665
665
  ip_restrict: false,
666
666
  didinfo_enabled: true,
667
667
  call_restrict: true,
668
- cost_limit: true,
669
668
  channels_restrict: false,
670
669
  rewrite_enabled: true,
671
670
  transcription_enabled: true,
@@ -685,7 +684,184 @@ client.sip_trunks.create(
685
684
  <dl>
686
685
  <dd>
687
686
 
688
- **request:** `Wavix::Types::SipTrunkCreateRequest`
687
+ **label:** `String` — User-defined name of the SIP trunk
688
+
689
+ </dd>
690
+ </dl>
691
+
692
+ <dl>
693
+ <dd>
694
+
695
+ **password:** `String` — Password set for the SIP trunk. A strong password helps keep the trunk secure.
696
+
697
+ </dd>
698
+ </dl>
699
+
700
+ <dl>
701
+ <dd>
702
+
703
+ **host_request:** `Wavix::SipTrunks::Types::SipTrunkCreateRequestHostRequest` — For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.
704
+
705
+ </dd>
706
+ </dl>
707
+
708
+ <dl>
709
+ <dd>
710
+
711
+ **callerid:** `String` — Caller ID associated with the SIP trunk. Must be an active or verified number on the account.
712
+
713
+ </dd>
714
+ </dl>
715
+
716
+ <dl>
717
+ <dd>
718
+
719
+ **multiple_numbers:** `Internal::Types::Boolean` — Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.
720
+
721
+ </dd>
722
+ </dl>
723
+
724
+ <dl>
725
+ <dd>
726
+
727
+ **ip_restrict:** `Internal::Types::Boolean` — Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.
728
+
729
+ </dd>
730
+ </dl>
731
+
732
+ <dl>
733
+ <dd>
734
+
735
+ **allowed_ips:** `Internal::Types::Array[Wavix::SipTrunks::Types::SipTrunkCreateRequestAllowedIpsItem]` — A list of public static IP addresses allowed to register with the SIP trunk
736
+
737
+ </dd>
738
+ </dl>
739
+
740
+ <dl>
741
+ <dd>
742
+
743
+ **didinfo_enabled:** `Internal::Types::Boolean` — Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests
744
+
745
+ </dd>
746
+ </dl>
747
+
748
+ <dl>
749
+ <dd>
750
+
751
+ **call_restrict:** `Internal::Types::Boolean` — Indicates whether a maximum call duration limit is enforced for the SIP trunk
752
+
753
+ </dd>
754
+ </dl>
755
+
756
+ <dl>
757
+ <dd>
758
+
759
+ **call_limit:** `Integer` — Maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for the account. Ignored when `call_restrict` is `false`.
760
+
761
+ </dd>
762
+ </dl>
763
+
764
+ <dl>
765
+ <dd>
766
+
767
+ **cost_limit:** `Internal::Types::Boolean` — Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
768
+
769
+ </dd>
770
+ </dl>
771
+
772
+ <dl>
773
+ <dd>
774
+
775
+ **max_call_cost:** `Integer` — Maximum cost for an outbound call, in USD
776
+
777
+ </dd>
778
+ </dl>
779
+
780
+ <dl>
781
+ <dd>
782
+
783
+ **channels_restrict:** `Internal::Types::Boolean` — Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk
784
+
785
+ </dd>
786
+ </dl>
787
+
788
+ <dl>
789
+ <dd>
790
+
791
+ **max_channels:** `Integer` — Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for the account. Ignored when `channels_restrict` is `false`.
792
+
793
+ </dd>
794
+ </dl>
795
+
796
+ <dl>
797
+ <dd>
798
+
799
+ **rewrite_enabled:** `Internal::Types::Boolean` — Indicates whether a custom dial plan is activated for the SIP trunk
800
+
801
+ </dd>
802
+ </dl>
803
+
804
+ <dl>
805
+ <dd>
806
+
807
+ **rewrite_prefix:** `String` — Digits to automatically prepend to each dialed phone number
808
+
809
+ </dd>
810
+ </dl>
811
+
812
+ <dl>
813
+ <dd>
814
+
815
+ **rewrite_cond:** `String` — Number of leading digits to automatically remove from each dialed phone number
816
+
817
+ </dd>
818
+ </dl>
819
+
820
+ <dl>
821
+ <dd>
822
+
823
+ **call_recording_enabled:** `Internal::Types::Boolean` — Indicates whether outbound call recording is enabled for the SIP trunk
824
+
825
+ </dd>
826
+ </dl>
827
+
828
+ <dl>
829
+ <dd>
830
+
831
+ **transcription_enabled:** `Internal::Types::Boolean`
832
+
833
+ Indicates whether automatic call transcription is enabled for the SIP trunk.
834
+ Available for `Flex Pro` customers only.
835
+
836
+ </dd>
837
+ </dl>
838
+
839
+ <dl>
840
+ <dd>
841
+
842
+ **transcription_threshold:** `Integer`
843
+
844
+ Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds.
845
+ Available for `Flex Pro` customers only.
846
+
847
+ </dd>
848
+ </dl>
849
+
850
+ <dl>
851
+ <dd>
852
+
853
+ **machine_detection_enabled:** `Internal::Types::Boolean`
854
+
855
+ Indicates whether automatic voicemail detection is enabled for the SIP trunk.
856
+ Available for `Flex Pro` customers only.
857
+
858
+ </dd>
859
+ </dl>
860
+
861
+ <dl>
862
+ <dd>
863
+
864
+ **encrypted_media:** `Internal::Types::Boolean` — Indicates whether SRTP media encryption is enabled for the SIP trunk.
689
865
 
690
866
  </dd>
691
867
  </dl>
@@ -779,7 +955,7 @@ client.sip_trunks.get(id: 3107)
779
955
  <dl>
780
956
  <dd>
781
957
 
782
- Replaces the configuration of the SIP trunk identified by `id`. Omitted fields revert to their defaults.
958
+ Updates the SIP trunk identified by `id`. Only the provided fields are changed. On trial accounts, every update also applies the trial limits: a `call_limit` of at most 300 seconds (300 when omitted) and one concurrent call.
783
959
  </dd>
784
960
  </dl>
785
961
  </dd>
@@ -794,20 +970,7 @@ Replaces the configuration of the SIP trunk identified by `id`. Omitted fields r
794
970
  <dd>
795
971
 
796
972
  ```ruby
797
- client.sip_trunks.update(
798
- id: 3107,
799
- label: "My trunk",
800
- password: "4r=h;EaCB85QNtr2",
801
- callerid: "13132847320",
802
- ip_restrict: false,
803
- didinfo_enabled: true,
804
- call_restrict: true,
805
- cost_limit: true,
806
- channels_restrict: false,
807
- rewrite_enabled: true,
808
- transcription_enabled: true,
809
- transcription_threshold: 10
810
- )
973
+ client.sip_trunks.update(id: 3107)
811
974
  ```
812
975
  </dd>
813
976
  </dl>
@@ -830,7 +993,184 @@ client.sip_trunks.update(
830
993
  <dl>
831
994
  <dd>
832
995
 
833
- **request:** `Wavix::Types::SipTrunkCreateRequest`
996
+ **label:** `String` — User-defined name of the SIP trunk
997
+
998
+ </dd>
999
+ </dl>
1000
+
1001
+ <dl>
1002
+ <dd>
1003
+
1004
+ **password:** `String` — Password set for the SIP trunk. A strong password helps keep the trunk secure.
1005
+
1006
+ </dd>
1007
+ </dl>
1008
+
1009
+ <dl>
1010
+ <dd>
1011
+
1012
+ **host_request:** `Wavix::SipTrunks::Types::SipTrunkUpdateRequestHostRequest` — For SIP trunks with IP authentication, the SIP endpoint public static IP address. Wavix authenticates all SIP traffic originating from this IP address. Ignored when the trunk already has a host request that is pending or approved. Not supported on trial accounts.
1013
+
1014
+ </dd>
1015
+ </dl>
1016
+
1017
+ <dl>
1018
+ <dd>
1019
+
1020
+ **callerid:** `String` — Caller ID associated with the SIP trunk. Must be an active or verified number on the account.
1021
+
1022
+ </dd>
1023
+ </dl>
1024
+
1025
+ <dl>
1026
+ <dd>
1027
+
1028
+ **multiple_numbers:** `Internal::Types::Boolean` — Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk. Setting it to `true` clears the trunk's `callerid`; on a trunk with Caller ID passthrough (`passthrough`) enabled, `true` is ignored.
1029
+
1030
+ </dd>
1031
+ </dl>
1032
+
1033
+ <dl>
1034
+ <dd>
1035
+
1036
+ **ip_restrict:** `Internal::Types::Boolean` — Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. It can be `true` only when the trunk has at least one allowed IP address, either already stored or sent in `allowed_ips`.
1037
+
1038
+ </dd>
1039
+ </dl>
1040
+
1041
+ <dl>
1042
+ <dd>
1043
+
1044
+ **allowed_ips:** `Internal::Types::Array[Wavix::SipTrunks::Types::SipTrunkUpdateRequestAllowedIpsItem]` — Public static IP addresses to add to the list allowed to register with the SIP trunk. Addresses already on the list are kept.
1045
+
1046
+ </dd>
1047
+ </dl>
1048
+
1049
+ <dl>
1050
+ <dd>
1051
+
1052
+ **didinfo_enabled:** `Internal::Types::Boolean` — Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests
1053
+
1054
+ </dd>
1055
+ </dl>
1056
+
1057
+ <dl>
1058
+ <dd>
1059
+
1060
+ **call_restrict:** `Internal::Types::Boolean` — Indicates whether a maximum call duration limit is enforced for the SIP trunk
1061
+
1062
+ </dd>
1063
+ </dl>
1064
+
1065
+ <dl>
1066
+ <dd>
1067
+
1068
+ **call_limit:** `Integer` — Maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for the account. Ignored when `call_restrict` is `false`.
1069
+
1070
+ </dd>
1071
+ </dl>
1072
+
1073
+ <dl>
1074
+ <dd>
1075
+
1076
+ **cost_limit:** `Internal::Types::Boolean` — Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
1077
+
1078
+ </dd>
1079
+ </dl>
1080
+
1081
+ <dl>
1082
+ <dd>
1083
+
1084
+ **max_call_cost:** `Integer` — Maximum cost for an outbound call, in USD
1085
+
1086
+ </dd>
1087
+ </dl>
1088
+
1089
+ <dl>
1090
+ <dd>
1091
+
1092
+ **channels_restrict:** `Internal::Types::Boolean` — Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk
1093
+
1094
+ </dd>
1095
+ </dl>
1096
+
1097
+ <dl>
1098
+ <dd>
1099
+
1100
+ **max_channels:** `Integer` — Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for the account. Ignored when `channels_restrict` is `false`.
1101
+
1102
+ </dd>
1103
+ </dl>
1104
+
1105
+ <dl>
1106
+ <dd>
1107
+
1108
+ **rewrite_enabled:** `Internal::Types::Boolean` — Indicates whether a custom dial plan is activated for the SIP trunk
1109
+
1110
+ </dd>
1111
+ </dl>
1112
+
1113
+ <dl>
1114
+ <dd>
1115
+
1116
+ **rewrite_prefix:** `String` — Digits to automatically prepend to each dialed phone number
1117
+
1118
+ </dd>
1119
+ </dl>
1120
+
1121
+ <dl>
1122
+ <dd>
1123
+
1124
+ **rewrite_cond:** `String` — Number of leading digits to automatically remove from each dialed phone number
1125
+
1126
+ </dd>
1127
+ </dl>
1128
+
1129
+ <dl>
1130
+ <dd>
1131
+
1132
+ **call_recording_enabled:** `Internal::Types::Boolean` — Indicates whether outbound call recording is enabled for the SIP trunk
1133
+
1134
+ </dd>
1135
+ </dl>
1136
+
1137
+ <dl>
1138
+ <dd>
1139
+
1140
+ **transcription_enabled:** `Internal::Types::Boolean`
1141
+
1142
+ Indicates whether automatic call transcription is enabled for the SIP trunk.
1143
+ Available for `Flex Pro` customers only.
1144
+
1145
+ </dd>
1146
+ </dl>
1147
+
1148
+ <dl>
1149
+ <dd>
1150
+
1151
+ **transcription_threshold:** `Integer`
1152
+
1153
+ Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds.
1154
+ Available for `Flex Pro` customers only.
1155
+
1156
+ </dd>
1157
+ </dl>
1158
+
1159
+ <dl>
1160
+ <dd>
1161
+
1162
+ **machine_detection_enabled:** `Internal::Types::Boolean`
1163
+
1164
+ Indicates whether automatic voicemail detection is enabled for the SIP trunk.
1165
+ Available for `Flex Pro` customers only.
1166
+
1167
+ </dd>
1168
+ </dl>
1169
+
1170
+ <dl>
1171
+ <dd>
1172
+
1173
+ **encrypted_media:** `Internal::Types::Boolean` — Indicates whether SRTP media encryption is enabled for the SIP trunk.
834
1174
 
835
1175
  </dd>
836
1176
  </dl>
@@ -913,7 +1253,7 @@ client.sip_trunks.delete(id: 3107)
913
1253
  </details>
914
1254
 
915
1255
  ## Cart
916
- <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">get</a>() -> Wavix::Cart::Types::GetCartResponse</code></summary>
1256
+ <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">get</a>() -> Wavix::Types::CartResponse</code></summary>
917
1257
  <dl>
918
1258
  <dd>
919
1259
 
@@ -967,7 +1307,7 @@ client.cart.get
967
1307
  </dl>
968
1308
  </details>
969
1309
 
970
- <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">add</a>(request) -> Internal::Types::Array[Object]</code></summary>
1310
+ <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">add</a>(request) -> Internal::Types::Array[Wavix::Types::AvailableNumber]</code></summary>
971
1311
  <dl>
972
1312
  <dd>
973
1313
 
@@ -1029,7 +1369,7 @@ client.cart.add(ids: %w[541139862174 541139862175])
1029
1369
  </dl>
1030
1370
  </details>
1031
1371
 
1032
- <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">remove</a>(request) -> Wavix::Cart::Types::RemoveCartResponse</code></summary>
1372
+ <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">remove</a>(request) -> Wavix::Types::SuccessResponse</code></summary>
1033
1373
  <dl>
1034
1374
  <dd>
1035
1375
 
@@ -1091,7 +1431,7 @@ client.cart.remove(ids: %w[541139862174 541139862175])
1091
1431
  </dl>
1092
1432
  </details>
1093
1433
 
1094
- <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">checkout</a>(request) -> Wavix::Cart::Types::CheckoutCartResponse</code></summary>
1434
+ <details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">checkout</a>(request) -> Wavix::Types::SuccessResponse</code></summary>
1095
1435
  <dl>
1096
1436
  <dd>
1097
1437
 
@@ -1103,7 +1443,7 @@ client.cart.remove(ids: %w[541139862174 541139862175])
1103
1443
  <dl>
1104
1444
  <dd>
1105
1445
 
1106
- Purchases the listed phone numbers from the cart. Activation and monthly fees are deducted from the account balance.
1446
+ Purchases the listed phone numbers from the cart. Activation and monthly fees are debited from the account balance immediately, and the purchase cannot be reversed through this API.
1107
1447
  </dd>
1108
1448
  </dl>
1109
1449
  </dd>
@@ -1263,7 +1603,7 @@ client.numbers.list(
1263
1603
  </dl>
1264
1604
  </details>
1265
1605
 
1266
- <details><summary><code>client.numbers.<a href="/lib/wavix/numbers/client.rb">delete</a>() -> Wavix::Numbers::Types::DeleteNumbersResponse</code></summary>
1606
+ <details><summary><code>client.numbers.<a href="/lib/wavix/numbers/client.rb">delete</a>() -> Wavix::Types::SuccessResponse</code></summary>
1267
1607
  <dl>
1268
1608
  <dd>
1269
1609
 
@@ -1529,6 +1869,8 @@ client.numbers.get(id: 123)
1529
1869
  <dd>
1530
1870
 
1531
1871
  Updates the phone number identified by `id`. Only the provided fields are changed.
1872
+
1873
+ **Behavior:** With `expected_sms_relay_url`, the `sms_relay_url` change is applied only while the number currently has that URL; an empty string matches a number with no `sms_relay_url`. Otherwise the call returns `409` and no field in the request is changed. Setting the URL the number already has succeeds. To clear `sms_relay_url`, send `null`, not an empty string. If the call returns a `Something went wrong` error, you can retry the request; repeating the `sms_relay_url` change is a no-op, so it is safe even if the first attempt already applied it.
1532
1874
  </dd>
1533
1875
  </dl>
1534
1876
  </dd>
@@ -1582,7 +1924,15 @@ client.numbers.update(id: 123)
1582
1924
  <dl>
1583
1925
  <dd>
1584
1926
 
1585
- **sms_relay_url:** `String` — Callback URL for inbound messages.
1927
+ **sms_relay_url:** `String` — Callback URL for inbound messages. Pass `null` to clear it.
1928
+
1929
+ </dd>
1930
+ </dl>
1931
+
1932
+ <dl>
1933
+ <dd>
1934
+
1935
+ **expected_sms_relay_url:** `String` — Applies the `sms_relay_url` change only if the number currently has this URL. Pass an empty string to set it only while it is unset, or your own URL to clear or replace it. Requires `sms_relay_url`.
1586
1936
 
1587
1937
  </dd>
1588
1938
  </dl>
@@ -1711,7 +2061,7 @@ client.cdrs.list(
1711
2061
  <dl>
1712
2062
  <dd>
1713
2063
 
1714
- **disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `busy` (the called party was busy), `rejected` (the call was declined), `failed` (the call could not be routed), or `all` (no disposition filter).
2064
+ **disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (no disposition filter).
1715
2065
 
1716
2066
  </dd>
1717
2067
  </dl>
@@ -1809,9 +2159,7 @@ Searches call transcriptions for the given keywords or phrases and returns the m
1809
2159
  client.cdrs.search(
1810
2160
  type: "placed",
1811
2161
  from: "2023-08-01",
1812
- to: "2023-08-31",
1813
- page: 1,
1814
- per_page: 50
2162
+ to: "2023-08-31"
1815
2163
  )
1816
2164
  ```
1817
2165
  </dd>
@@ -1899,10 +2247,10 @@ client.cdrs.search(
1899
2247
  <dl>
1900
2248
  <dd>
1901
2249
 
1902
- **disposition:** `Wavix::Cdrs::Types::CdrSearchRequestDisposition`
2250
+ **disposition:** `Wavix::Types::CallDisposition`
1903
2251
 
1904
2252
  Call disposition to filter results. If omitted, returns only answered
1905
- calls. Allowed values: `answered`, `busy`, `rejected`,
2253
+ calls. Allowed values: `answered`, `noanswer`, `busy`,
1906
2254
  `failed`, `all`. Use `all` to return calls
1907
2255
  regardless of their disposition.
1908
2256
 
@@ -1952,7 +2300,7 @@ Call disposition to filter results. If omitted, returns only answered
1952
2300
  <dl>
1953
2301
  <dd>
1954
2302
 
1955
- Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the transcription endpoint for the result.
2303
+ Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the transcription endpoint for the result. When it completes, the new transcription replaces any earlier one that the transcription endpoints return. Billed per minute at the account's call-transcription rate; fails with an insufficient-funds error when the balance cannot cover it.
1956
2304
  </dd>
1957
2305
  </dl>
1958
2306
  </dd>
@@ -1967,7 +2315,7 @@ Transcribes the recording of the call identified by `call_id`. Transcription is
1967
2315
  <dd>
1968
2316
 
1969
2317
  ```ruby
1970
- client.cdrs.retranscribe(call_id: "bbaa37bf-430a-46da-ade3-c248e407016")
2318
+ client.cdrs.retranscribe(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
1971
2319
  ```
1972
2320
  </dd>
1973
2321
  </dl>
@@ -2045,7 +2393,7 @@ Returns the transcription of the recorded call identified by `call_id`. Alias of
2045
2393
  <dd>
2046
2394
 
2047
2395
  ```ruby
2048
- client.cdrs.transcriptions(call_id: "bbaa37bf-430a-46da-ade3-c248e407016")
2396
+ client.cdrs.transcriptions(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
2049
2397
  ```
2050
2398
  </dd>
2051
2399
  </dl>
@@ -2229,7 +2577,7 @@ client.cdrs.list_all(
2229
2577
  <dl>
2230
2578
  <dd>
2231
2579
 
2232
- **disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `busy` (the called party was busy), `rejected` (the call was declined), `failed` (the call could not be routed), or `all` (no disposition filter).
2580
+ **disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (no disposition filter).
2233
2581
 
2234
2582
  </dd>
2235
2583
  </dl>
@@ -2560,7 +2908,7 @@ client.call_recording.get(id: 123)
2560
2908
  <dl>
2561
2909
  <dd>
2562
2910
 
2563
- Deletes the call recording identified by `id`. Deletion is permanent and removes the recording file.
2911
+ Deletes the call recording identified by `id`. Deletion is permanent — the audio file is unrecoverable.
2564
2912
  </dd>
2565
2913
  </dl>
2566
2914
  </dd>
@@ -2611,7 +2959,7 @@ client.call_recording.delete(id: 123)
2611
2959
  </details>
2612
2960
 
2613
2961
  ## Speech Analytics
2614
- <details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">create</a>(request) -> Wavix::SpeechAnalytics::Types::CreateSpeechAnalyticsResponse</code></summary>
2962
+ <details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">create</a>(request) -> Wavix::Types::SubmitFileTranscriptionResponse</code></summary>
2615
2963
  <dl>
2616
2964
  <dd>
2617
2965
 
@@ -2678,7 +3026,7 @@ client.speech_analytics.create
2678
3026
  </dl>
2679
3027
  </details>
2680
3028
 
2681
- <details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">get</a>(request_id) -> Wavix::SpeechAnalytics::Types::GetSpeechAnalyticsResponse</code></summary>
3029
+ <details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">get</a>(request_id) -> Wavix::Types::FileTranscriptionResponse</code></summary>
2682
3030
  <dl>
2683
3031
  <dd>
2684
3032
 
@@ -2888,7 +3236,9 @@ client.call_webhooks.list
2888
3236
  <dl>
2889
3237
  <dd>
2890
3238
 
2891
- Registers a callback URL for the `on-call` or `post-call` event. Wavix sends a POST callback to the URL when the event occurs.
3239
+ Registers a callback URL for the `on-call` or `post-call` event. Wavix sends a POST callback to the URL when the event occurs. Creates persistent configuration that forwards call metadata to the URL on every matching call until the webhook is deleted.
3240
+
3241
+ **Behavior:** Without `expected_url`, the webhook is set to `url` whatever it was before. With `expected_url`, the webhook is set only while it currently has that URL; an empty string matches an unset webhook. Otherwise the call returns `409` and the webhook is unchanged. Setting the URL the webhook already has succeeds. If the call returns a `Something went wrong` error, the webhook is unchanged and you can retry the request.
2892
3242
  </dd>
2893
3243
  </dl>
2894
3244
  </dd>
@@ -2944,6 +3294,14 @@ Allowed values: `on-call`, `post-call`.
2944
3294
  <dl>
2945
3295
  <dd>
2946
3296
 
3297
+ **expected_url:** `String` — Applies the change only if the webhook currently has this URL. Pass an empty string to set the webhook only while it is unset, or your own URL to replace your webhook. Setting the URL the webhook already has always succeeds.
3298
+
3299
+ </dd>
3300
+ </dl>
3301
+
3302
+ <dl>
3303
+ <dd>
3304
+
2947
3305
  **request_options:** `Wavix::CallWebhooks::RequestOptions`
2948
3306
 
2949
3307
  </dd>
@@ -2969,6 +3327,8 @@ Allowed values: `on-call`, `post-call`.
2969
3327
  <dd>
2970
3328
 
2971
3329
  Removes the call webhook for the given event type. Wavix stops sending callbacks for that event.
3330
+
3331
+ **Behavior:** Without `expected_url`, the webhook is cleared whatever URL it has. With `expected_url`, the webhook is cleared only while it currently has that URL; an empty value matches an unset webhook. Otherwise the call returns `409` and the webhook is unchanged. Clearing an unset webhook succeeds. Percent-encode the `expected_url` value in the query string. If the call returns a `Something went wrong` error, the webhook is unchanged and you can retry the request.
2972
3332
  </dd>
2973
3333
  </dl>
2974
3334
  </dd>
@@ -2983,7 +3343,10 @@ Removes the call webhook for the given event type. Wavix stops sending callbacks
2983
3343
  <dd>
2984
3344
 
2985
3345
  ```ruby
2986
- client.call_webhooks.delete(event_type: "post-call")
3346
+ client.call_webhooks.delete(
3347
+ event_type: "post-call",
3348
+ expected_url: "https://your-site.com/webhook"
3349
+ )
2987
3350
  ```
2988
3351
  </dd>
2989
3352
  </dl>
@@ -3006,6 +3369,14 @@ client.call_webhooks.delete(event_type: "post-call")
3006
3369
  <dl>
3007
3370
  <dd>
3008
3371
 
3372
+ **expected_url:** `String` — Clears the webhook only if it currently has this URL. Percent-encode the value. An empty value clears only an unset webhook.
3373
+
3374
+ </dd>
3375
+ </dl>
3376
+
3377
+ <dl>
3378
+ <dd>
3379
+
3009
3380
  **request_options:** `Wavix::CallWebhooks::RequestOptions`
3010
3381
 
3011
3382
  </dd>
@@ -3085,7 +3456,7 @@ client.call_control.list
3085
3456
  <dl>
3086
3457
  <dd>
3087
3458
 
3088
- Places an outbound call. Returns the call with its `uuid` for tracking and control.
3459
+ Places a real, billable outbound PSTN call. Returns the call with its `uuid` for tracking and control.
3089
3460
  </dd>
3090
3461
  </dl>
3091
3462
  </dd>
@@ -3261,7 +3632,7 @@ client.call_control.get(id: "id")
3261
3632
  <dl>
3262
3633
  <dd>
3263
3634
 
3264
- Ends the active call identified by `id` by hanging up.
3635
+ Ends the active call identified by `id` by hanging up. Irreversible — the call cannot be resumed once ended.
3265
3636
  </dd>
3266
3637
  </dl>
3267
3638
  </dd>
@@ -3396,7 +3767,7 @@ client.call_control.update(
3396
3767
  <dl>
3397
3768
  <dd>
3398
3769
 
3399
- Answers the inbound call identified by `id`. Optionally starts media streaming on answer.
3770
+ Answers the inbound call identified by `id`. Optionally starts recording, post-call transcription, or live media streaming on answer.
3400
3771
  </dd>
3401
3772
  </dl>
3402
3773
  </dd>
@@ -3450,7 +3821,7 @@ client.call_control.answer(id: "id")
3450
3821
  <dl>
3451
3822
  <dd>
3452
3823
 
3453
- **stream_url:** `String` — WebSocket URL to stream the call.
3824
+ **stream_url:** `String` — WebSocket URL (`ws://` or `wss://`) that receives the call's audio, which can include the caller's voice.
3454
3825
 
3455
3826
  </dd>
3456
3827
  </dl>
@@ -3592,7 +3963,7 @@ Prompt to play before collecting digits.
3592
3963
  </details>
3593
3964
 
3594
3965
  ## NumberValidator
3595
- <details><summary><code>client.number_validator.<a href="/lib/wavix/number_validator/client.rb">get</a>() -> Wavix::NumberValidator::Types::GetNumberValidatorResponse</code></summary>
3966
+ <details><summary><code>client.number_validator.<a href="/lib/wavix/number_validator/client.rb">get</a>() -> Wavix::Types::PhoneValidationResponse</code></summary>
3596
3967
  <dl>
3597
3968
  <dd>
3598
3969
 
@@ -3604,7 +3975,7 @@ Prompt to play before collecting digits.
3604
3975
  <dl>
3605
3976
  <dd>
3606
3977
 
3607
- Validates a single phone number and returns line type, carrier, portability, and reachability details.
3978
+ Validates a single phone number and returns line type, carrier, portability, and reachability details. The response's `error_code` is a per-number result code (`000` success; `013` internal error; `021` invalid format; `041` remote timeout; `042` remote query failed; `091` insufficient funds) — distinct from the HTTP status codes below.
3608
3979
  </dd>
3609
3980
  </dl>
3610
3981
  </dd>
@@ -3694,9 +4065,7 @@ Validates a batch of phone numbers. When `async` is `true`, returns a `request_i
3694
4065
  ```ruby
3695
4066
  client.number_validator.create_bulk(
3696
4067
  phone_numbers: %w[971501390098 971504359195],
3697
- type: "format",
3698
- async: true,
3699
- force: true
4068
+ type: "format"
3700
4069
  )
3701
4070
  ```
3702
4071
  </dd>
@@ -3712,7 +4081,7 @@ client.number_validator.create_bulk(
3712
4081
  <dl>
3713
4082
  <dd>
3714
4083
 
3715
- **phone_numbers:** `Internal::Types::Array[String]` — List of phone numbers to get detailed information about.
4084
+ **phone_numbers:** `Internal::Types::Array[String]` — List of phone numbers to get detailed information about. Maximum 1000 numbers per request.
3716
4085
 
3717
4086
  </dd>
3718
4087
  </dl>
@@ -3728,7 +4097,7 @@ client.number_validator.create_bulk(
3728
4097
  <dl>
3729
4098
  <dd>
3730
4099
 
3731
- **async:** `Internal::Types::Boolean` — Indicates whether the request should be executed asynchronously. If `true`, the response will include a `request_uuid` that can be used to poll for results. If `false`, the response will include validation results directly.
4100
+ **async:** `Internal::Types::Boolean` — Indicates whether the request should be executed asynchronously. If `true`, the response will include a `request_uuid` that can be used to poll for results. If `false` (default), the response will include validation results directly.
3732
4101
 
3733
4102
  </dd>
3734
4103
  </dl>
@@ -3736,7 +4105,7 @@ client.number_validator.create_bulk(
3736
4105
  <dl>
3737
4106
  <dd>
3738
4107
 
3739
- **force:** `Internal::Types::Boolean` — Indicates whether to force a fresh validation instead of returning a previously cached result.
4108
+ **force:** `Internal::Types::Boolean` — Indicates whether to force a fresh validation instead of returning a previously cached result. Defaults to `false`.
3740
4109
 
3741
4110
  </dd>
3742
4111
  </dl>
@@ -3769,7 +4138,7 @@ client.number_validator.create_bulk(
3769
4138
  <dl>
3770
4139
  <dd>
3771
4140
 
3772
- Launches a voice campaign that places an outbound call using a pre-configured scenario. Track progress with the returned voice campaign `id`.
4141
+ Launches a voice campaign that places a real outbound call using a pre-configured scenario. Track progress with the returned voice campaign `id`.
3773
4142
  </dd>
3774
4143
  </dl>
3775
4144
  </dd>
@@ -3928,7 +4297,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
3928
4297
  <dl>
3929
4298
  <dd>
3930
4299
 
3931
- **link:** `String` — Target URL to shorten.
4300
+ **link:** `String` — Target URL to shorten. Must be `https://` — the short link is publicly resolvable and redirects any visitor here, so only pass URLs you trust; this endpoint is a common target for open-redirect and phishing abuse.
3932
4301
 
3933
4302
  </dd>
3934
4303
  </dl>
@@ -3944,7 +4313,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
3944
4313
  <dl>
3945
4314
  <dd>
3946
4315
 
3947
- **fallback_url:** `String` — Fallback URL for expired or invalid links.
4316
+ **fallback_url:** `String` — Fallback URL for expired or invalid links. Must be `https://` — same open-redirect/phishing considerations as `link` apply.
3948
4317
 
3949
4318
  </dd>
3950
4319
  </dl>
@@ -3952,7 +4321,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
3952
4321
  <dl>
3953
4322
  <dd>
3954
4323
 
3955
- **phone:** `String` — Phone number for the short link.
4324
+ **phone:** `String` — Phone number the short link is associated with, in E.164 format (without the leading `+`). Used to attribute click metrics returned by short link metrics list.
3956
4325
 
3957
4326
  </dd>
3958
4327
  </dl>
@@ -4228,6 +4597,22 @@ client.sub_accounts.list
4228
4597
  <dl>
4229
4598
  <dd>
4230
4599
 
4600
+ **page:** `Integer` — Page number to retrieve. Default `1`.
4601
+
4602
+ </dd>
4603
+ </dl>
4604
+
4605
+ <dl>
4606
+ <dd>
4607
+
4608
+ **per_page:** `Integer` — Number of records to return per page. Default `25`.
4609
+
4610
+ </dd>
4611
+ </dl>
4612
+
4613
+ <dl>
4614
+ <dd>
4615
+
4231
4616
  **request_options:** `Wavix::SubAccounts::RequestOptions`
4232
4617
 
4233
4618
  </dd>
@@ -4390,7 +4775,7 @@ client.sub_accounts.get(id: 123)
4390
4775
  <dl>
4391
4776
  <dd>
4392
4777
 
4393
- Replaces the configuration of the sub-account identified by `id`. Omitted fields revert to their defaults.
4778
+ Updates the sub-account identified by `id`. Only the provided fields are changed.
4394
4779
  </dd>
4395
4780
  </dl>
4396
4781
  </dd>
@@ -4473,7 +4858,7 @@ client.sub_accounts.update(
4473
4858
  </details>
4474
4859
 
4475
4860
  ## Billing Transactions
4476
- <details><summary><code>client.billing.transactions.<a href="/lib/wavix/billing/transactions/client.rb">list</a>() -> Wavix::Billing::Transactions::Types::ListTransactionsResponse</code></summary>
4861
+ <details><summary><code>client.billing.transactions.<a href="/lib/wavix/billing/transactions/client.rb">list</a>() -> Wavix::Types::BillingTransactionListResponse</code></summary>
4477
4862
  <dl>
4478
4863
  <dd>
4479
4864
 
@@ -4591,7 +4976,7 @@ client.billing.transactions.list(
4591
4976
  </details>
4592
4977
 
4593
4978
  ## Billing Invoices
4594
- <details><summary><code>client.billing.invoices.<a href="/lib/wavix/billing/invoices/client.rb">list</a>() -> Wavix::Billing::Invoices::Types::ListInvoicesResponse</code></summary>
4979
+ <details><summary><code>client.billing.invoices.<a href="/lib/wavix/billing/invoices/client.rb">list</a>() -> Wavix::Types::InvoiceListResponse</code></summary>
4595
4980
  <dl>
4596
4981
  <dd>
4597
4982
 
@@ -4727,7 +5112,7 @@ client.billing.invoices.download(id: 1)
4727
5112
  </details>
4728
5113
 
4729
5114
  ## Buy Countries
4730
- <details><summary><code>client.buy.countries.<a href="/lib/wavix/buy/countries/client.rb">list</a>() -> Wavix::Buy::Countries::Types::ListCountriesResponse</code></summary>
5115
+ <details><summary><code>client.buy.countries.<a href="/lib/wavix/buy/countries/client.rb">list</a>() -> Wavix::Types::CountryListResponse</code></summary>
4731
5116
  <dl>
4732
5117
  <dd>
4733
5118
 
@@ -4790,7 +5175,7 @@ client.buy.countries.list
4790
5175
  </details>
4791
5176
 
4792
5177
  ## Buy Regions
4793
- <details><summary><code>client.buy.regions.<a href="/lib/wavix/buy/regions/client.rb">list</a>(country_id) -> Wavix::Buy::Regions::Types::ListRegionsResponse</code></summary>
5178
+ <details><summary><code>client.buy.regions.<a href="/lib/wavix/buy/regions/client.rb">list</a>(country_id) -> Wavix::Types::RegionListResponse</code></summary>
4794
5179
  <dl>
4795
5180
  <dd>
4796
5181
 
@@ -4861,7 +5246,7 @@ client.buy.regions.list(country_id: 1892)
4861
5246
  </details>
4862
5247
 
4863
5248
  ## Buy Cities
4864
- <details><summary><code>client.buy.cities.<a href="/lib/wavix/buy/cities/client.rb">list</a>(country_id) -> Wavix::Buy::Cities::Types::ListCitiesResponse</code></summary>
5249
+ <details><summary><code>client.buy.cities.<a href="/lib/wavix/buy/cities/client.rb">list</a>(country_id) -> Wavix::Types::CityListResponse</code></summary>
4865
5250
  <dl>
4866
5251
  <dd>
4867
5252
 
@@ -4933,7 +5318,7 @@ client.buy.cities.list(country_id: 1891)
4933
5318
  </details>
4934
5319
 
4935
5320
  ## Buy RegionCities
4936
- <details><summary><code>client.buy.region_cities.<a href="/lib/wavix/buy/region_cities/client.rb">list</a>(country_id, region_id) -> Wavix::Buy::RegionCities::Types::ListRegionCitiesResponse</code></summary>
5321
+ <details><summary><code>client.buy.region_cities.<a href="/lib/wavix/buy/region_cities/client.rb">list</a>(country_id, region_id) -> Wavix::Types::CityListResponse</code></summary>
4937
5322
  <dl>
4938
5323
  <dd>
4939
5324
 
@@ -5015,7 +5400,7 @@ client.buy.region_cities.list(
5015
5400
  </details>
5016
5401
 
5017
5402
  ## Buy Numbers
5018
- <details><summary><code>client.buy.numbers.<a href="/lib/wavix/buy/numbers/client.rb">list</a>(country_id, city_id) -> Wavix::Buy::Numbers::Types::ListNumbersResponse</code></summary>
5403
+ <details><summary><code>client.buy.numbers.<a href="/lib/wavix/buy/numbers/client.rb">list</a>(country_id, city_id) -> Wavix::Types::AvailableNumberListResponse</code></summary>
5019
5404
  <dl>
5020
5405
  <dd>
5021
5406
 
@@ -5125,7 +5510,7 @@ client.buy.numbers.list(
5125
5510
  <dl>
5126
5511
  <dd>
5127
5512
 
5128
- Starts streaming the media of the call identified by `call_id` to the configured destination. Returns the `stream_id`.
5513
+ Starts streaming the audio of the call identified by `call_id` to the WebSocket destination in `stream_url`, in the direction (`stream_type`) and channel (`stream_channel`) you configure. The streamed audio can include the remote party's voice.
5129
5514
  </dd>
5130
5515
  </dl>
5131
5516
  </dd>
@@ -5168,7 +5553,7 @@ client.call_control.streams.create(
5168
5553
  <dl>
5169
5554
  <dd>
5170
5555
 
5171
- **stream_url:** `String` — WebSocket URL for call streaming
5556
+ **stream_url:** `String` — WebSocket URL (`ws://` or `wss://`) that receives the call's audio.
5172
5557
 
5173
5558
  </dd>
5174
5559
  </dl>
@@ -5290,7 +5675,7 @@ client.call_control.streams.delete(
5290
5675
  <dl>
5291
5676
  <dd>
5292
5677
 
5293
- Plays an audio prompt into the active call identified by `id`.
5678
+ Plays an audio prompt into the active call identified by `id`. The audio is audible to the remote party in real time.
5294
5679
  </dd>
5295
5680
  </dl>
5296
5681
  </dd>
@@ -5441,7 +5826,7 @@ Returns the transcription of the recorded call identified by `call_id`, includin
5441
5826
  <dd>
5442
5827
 
5443
5828
  ```ruby
5444
- client.cdrs.transcription.get(call_id: "bbaa37bf-430a-46da-ade3-c248e407016")
5829
+ client.cdrs.transcription.get(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
5445
5830
  ```
5446
5831
  </dd>
5447
5832
  </dl>
@@ -5710,7 +6095,7 @@ client.numbers.papers.upload
5710
6095
  </details>
5711
6096
 
5712
6097
  ## Profile Config
5713
- <details><summary><code>client.profile.config.<a href="/lib/wavix/profile/config/client.rb">get</a>() -> Wavix::Profile::Config::Types::GetConfigResponse</code></summary>
6098
+ <details><summary><code>client.profile.config.<a href="/lib/wavix/profile/config/client.rb">get</a>() -> Wavix::Types::ProfileConfigResponse</code></summary>
5714
6099
  <dl>
5715
6100
  <dd>
5716
6101
 
@@ -5831,7 +6216,7 @@ client.sms_and_mms.sender_ids.list
5831
6216
  <dl>
5832
6217
  <dd>
5833
6218
 
5834
- Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
6219
+ Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US. Registering a Sender ID incurs a recurring monthly fee, billed to the account balance.
5835
6220
  </dd>
5836
6221
  </dl>
5837
6222
  </dd>
@@ -5988,7 +6373,7 @@ client.sms_and_mms.sender_ids.get(id: "id")
5988
6373
  </dl>
5989
6374
  </details>
5990
6375
 
5991
- <details><summary><code>client.sms_and_mms.sender_ids.<a href="/lib/wavix/sms_and_mms/sender_ids/client.rb">delete</a>(id) -> Wavix::SmsAndMms::SenderIDs::Types::DeleteSenderIDsResponse</code></summary>
6376
+ <details><summary><code>client.sms_and_mms.sender_ids.<a href="/lib/wavix/sms_and_mms/sender_ids/client.rb">delete</a>(id) -> Wavix::Types::SuccessResponse</code></summary>
5992
6377
  <dl>
5993
6378
  <dd>
5994
6379
 
@@ -6158,7 +6543,7 @@ client.sms_and_mms.opt_outs.list(
6158
6543
  </dl>
6159
6544
  </details>
6160
6545
 
6161
- <details><summary><code>client.sms_and_mms.opt_outs.<a href="/lib/wavix/sms_and_mms/opt_outs/client.rb">create</a>(request) -> Wavix::SmsAndMms::OptOuts::Types::CreateOptOutsResponse</code></summary>
6546
+ <details><summary><code>client.sms_and_mms.opt_outs.<a href="/lib/wavix/sms_and_mms/opt_outs/client.rb">create</a>(request) -> Wavix::Types::SuccessResponse</code></summary>
6162
6547
  <dl>
6163
6548
  <dd>
6164
6549
 
@@ -6224,7 +6609,7 @@ client.sms_and_mms.opt_outs.create(opt_out: {
6224
6609
  </details>
6225
6610
 
6226
6611
  ## SmsAndMms Messages
6227
- <details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">list</a>() -> Wavix::SmsAndMms::Messages::Types::ListMessagesResponse</code></summary>
6612
+ <details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">list</a>() -> Wavix::Types::MessageListResponse</code></summary>
6228
6613
  <dl>
6229
6614
  <dd>
6230
6615
 
@@ -6379,8 +6764,7 @@ client.sms_and_mms.messages.list(
6379
6764
  <dl>
6380
6765
  <dd>
6381
6766
 
6382
- Sends an SMS or MMS message. MMS is supported for U.S. numbers only. Track delivery using the returned `message_id` and the message status callback.
6383
- **Rate limit**: 20 messages per phone number in 24 hours.
6767
+ Sends an SMS or MMS message. MMS is supported for U.S. numbers only. Track delivery using the returned `message_id` and the message status callback. The recipient must be opted in to receive messages from the account; sending to an opted-out number fails.
6384
6768
  </dd>
6385
6769
  </dl>
6386
6770
  </dd>
@@ -6399,8 +6783,7 @@ client.sms_and_mms.messages.send_(
6399
6783
  from: "Wavix",
6400
6784
  to: "+447537151866",
6401
6785
  message_body: {
6402
- text: "Hi there, this is a message from Wavix",
6403
- media: nil
6786
+ text: "Hi there, this is a message from Wavix"
6404
6787
  },
6405
6788
  callback_url: "https://you-site.com/webhook",
6406
6789
  validity: 3600,
@@ -6480,7 +6863,7 @@ client.sms_and_mms.messages.send_(
6480
6863
  </dl>
6481
6864
  </details>
6482
6865
 
6483
- <details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">get</a>(id) -> Wavix::SmsAndMms::Messages::Types::GetMessagesResponse</code></summary>
6866
+ <details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">get</a>(id) -> Wavix::Types::MessageResponse</code></summary>
6484
6867
  <dl>
6485
6868
  <dd>
6486
6869
 
@@ -6840,7 +7223,7 @@ client.sub_accounts.transactions.list(
6840
7223
  </details>
6841
7224
 
6842
7225
  ## TenDlc Brands
6843
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">list</a>() -> Wavix::TenDlc::Brands::Types::ListBrandsResponse</code></summary>
7226
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">list</a>() -> Wavix::Types::TenDlcBrandListResponse</code></summary>
6844
7227
  <dl>
6845
7228
  <dd>
6846
7229
 
@@ -7003,7 +7386,7 @@ client.ten_dlc.brands.list(
7003
7386
  </dl>
7004
7387
  </details>
7005
7388
 
7006
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">create</a>(request) -> Wavix::TenDlc::Brands::Types::CreateBrandsResponse</code></summary>
7389
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">create</a>(request) -> Wavix::Types::TenDlcBrand</code></summary>
7007
7390
  <dl>
7008
7391
  <dd>
7009
7392
 
@@ -7015,7 +7398,7 @@ client.ten_dlc.brands.list(
7015
7398
  <dl>
7016
7399
  <dd>
7017
7400
 
7018
- Registers a 10DLC Brand. TCR automatically verifies the brand identity. Only brands with `VERIFIED` or `VETTED_VERIFIED` identity status can register 10DLC Campaigns.
7401
+ Registers a 10DLC Brand. Submits the company's legal identity data (EIN/Tax ID, legal company name, contact and address) to The Campaign Registry (TCR), which verifies the brand identity. Charges a 10DLC brand registration fee on successful submission; fails with an insufficient-funds error when the balance cannot cover it. Only brands with `VERIFIED` or `VETTED_VERIFIED` identity status can register 10DLC Campaigns.
7019
7402
  </dd>
7020
7403
  </dl>
7021
7404
  </dd>
@@ -7065,7 +7448,7 @@ client.ten_dlc.brands.create(request: {})
7065
7448
  </dl>
7066
7449
  </details>
7067
7450
 
7068
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">get</a>(brand_id) -> Wavix::TenDlc::Brands::Types::GetBrandsResponse</code></summary>
7451
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">get</a>(brand_id) -> Wavix::Types::TenDlcBrand</code></summary>
7069
7452
  <dl>
7070
7453
  <dd>
7071
7454
 
@@ -7127,7 +7510,7 @@ client.ten_dlc.brands.get(brand_id: "BM20QP9")
7127
7510
  </dl>
7128
7511
  </details>
7129
7512
 
7130
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">update</a>(brand_id, request) -> Wavix::TenDlc::Brands::Types::UpdateBrandsResponse</code></summary>
7513
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">update</a>(brand_id, request) -> Wavix::Types::TenDlcBrand</code></summary>
7131
7514
  <dl>
7132
7515
  <dd>
7133
7516
 
@@ -7309,7 +7692,7 @@ Business segment the Brand operates in. One of:
7309
7692
  <dl>
7310
7693
  <dd>
7311
7694
 
7312
- **state_or_province:** `String` — State or province. For the United States, use 2 character codes.
7695
+ **state_or_province:** `String` — State or province. For the United States, it is a 2-character code.
7313
7696
 
7314
7697
  </dd>
7315
7698
  </dl>
@@ -7353,7 +7736,7 @@ Business segment the Brand operates in. One of:
7353
7736
  </dl>
7354
7737
  </details>
7355
7738
 
7356
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">delete</a>(brand_id) -> Wavix::TenDlc::Brands::Types::DeleteBrandsResponse</code></summary>
7739
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">delete</a>(brand_id) -> Wavix::Types::SuccessResponse</code></summary>
7357
7740
  <dl>
7358
7741
  <dd>
7359
7742
 
@@ -7415,7 +7798,7 @@ client.ten_dlc.brands.delete(brand_id: "BM20QP9")
7415
7798
  </dl>
7416
7799
  </details>
7417
7800
 
7418
- <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">qualify_usecase</a>(brand_id, use_case) -> Wavix::TenDlc::Brands::Types::QualifyUsecaseBrandsResponse</code></summary>
7801
+ <details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">qualify_usecase</a>(brand_id, use_case) -> Wavix::Types::TenDlcBrandQualificationResult</code></summary>
7419
7802
  <dl>
7420
7803
  <dd>
7421
7804
 
@@ -7551,7 +7934,7 @@ client.ten_dlc.brand_appeals.list(brand_id: "BM20QP9")
7551
7934
  </dl>
7552
7935
  </details>
7553
7936
 
7554
- <details><summary><code>client.ten_dlc.brand_appeals.<a href="/lib/wavix/ten_dlc/brand_appeals/client.rb">create</a>(brand_id, request) -> Wavix::TenDlc::BrandAppeals::Types::CreateBrandAppealsResponse</code></summary>
7937
+ <details><summary><code>client.ten_dlc.brand_appeals.<a href="/lib/wavix/ten_dlc/brand_appeals/client.rb">create</a>(brand_id, request) -> Wavix::Types::SuccessResponse</code></summary>
7555
7938
  <dl>
7556
7939
  <dd>
7557
7940
 
@@ -7566,7 +7949,7 @@ client.ten_dlc.brand_appeals.list(brand_id: "BM20QP9")
7566
7949
  Submits an appeal for 10DLC brand identity verification. Provide any additional documentation to support the appeal. Use `appeal_category` to specify the appeal type:
7567
7950
  - `VERIFY_TAX_ID` — Use if the brand is UNVERIFIED due to a tax ID mismatch. Applies to private companies, public companies, non-profits, and government entities.
7568
7951
  - `VERIFY_NON_PROFIT` — Use if a non-profit brand is UNVERIFIED or VERIFIED but missing tax-exempt status.
7569
- - `VERIFY_GOVERNMENT` — Use if a government brand is UNVERIFIED or VERIFIED but missing government entity status.
7952
+ - `VERIFY_GOVERNMENT` — Use if a government brand is UNVERIFIED or VERIFIED but missing government entity status.
7570
7953
  </dd>
7571
7954
  </dl>
7572
7955
  </dd>
@@ -7608,7 +7991,7 @@ client.ten_dlc.brand_appeals.create(
7608
7991
  <dl>
7609
7992
  <dd>
7610
7993
 
7611
- **appeal_categories:** `Internal::Types::Array[String]` — List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`
7994
+ **appeal_categories:** `Internal::Types::Array[Wavix::TenDlc::BrandAppeals::Types::CreateBrandAppealsRequestAppealCategoriesItem]` — List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`
7612
7995
 
7613
7996
  </dd>
7614
7997
  </dl>
@@ -7707,7 +8090,7 @@ client.ten_dlc.brand_evidence.list(brand_id: "B6AI7PA")
7707
8090
  </dl>
7708
8091
  </details>
7709
8092
 
7710
- <details><summary><code>client.ten_dlc.brand_evidence.<a href="/lib/wavix/ten_dlc/brand_evidence/client.rb">upload</a>(brand_id, request) -> Wavix::TenDlc::BrandEvidence::Types::UploadBrandEvidenceResponse</code></summary>
8093
+ <details><summary><code>client.ten_dlc.brand_evidence.<a href="/lib/wavix/ten_dlc/brand_evidence/client.rb">upload</a>(brand_id, request) -> Wavix::Types::TenDlcBrandEvidence</code></summary>
7711
8094
  <dl>
7712
8095
  <dd>
7713
8096
 
@@ -7842,7 +8225,7 @@ client.ten_dlc.brand_evidence.get(
7842
8225
  </dl>
7843
8226
  </details>
7844
8227
 
7845
- <details><summary><code>client.ten_dlc.brand_evidence.<a href="/lib/wavix/ten_dlc/brand_evidence/client.rb">delete</a>(brand_id, id) -> Wavix::TenDlc::BrandEvidence::Types::DeleteBrandEvidenceResponse</code></summary>
8228
+ <details><summary><code>client.ten_dlc.brand_evidence.<a href="/lib/wavix/ten_dlc/brand_evidence/client.rb">delete</a>(brand_id, id) -> Wavix::Types::SuccessResponse</code></summary>
7846
8229
  <dl>
7847
8230
  <dd>
7848
8231
 
@@ -7990,7 +8373,7 @@ client.ten_dlc.brand_vettings.list(brand_id: "B6AI7PA")
7990
8373
  <dl>
7991
8374
  <dd>
7992
8375
 
7993
- Requests external vetting for a 10DLC Brand. Supported providers: `AEGIS`, `CV`, `WMC`. Supported classes: `STANDARD`, `ENHANCED`.
8376
+ Requests external vetting for a 10DLC Brand. Supported providers: `AEGIS`, `CV`, `WMC`. Supported classes: `STANDARD`, `ENHANCED`. Charges a 10DLC brand vetting fee (Standard or Enhanced); fails with an insufficient-funds error when the balance cannot cover it.
7994
8377
  </dd>
7995
8378
  </dl>
7996
8379
  </dd>
@@ -8214,7 +8597,7 @@ client.ten_dlc.brand_vetting_appeals.list(brand_id: "BMQFB7X")
8214
8597
  </dl>
8215
8598
  </details>
8216
8599
 
8217
- <details><summary><code>client.ten_dlc.brand_vetting_appeals.<a href="/lib/wavix/ten_dlc/brand_vetting_appeals/client.rb">create</a>(brand_id, request) -> Wavix::TenDlc::BrandVettingAppeals::Types::CreateBrandVettingAppealsResponse</code></summary>
8600
+ <details><summary><code>client.ten_dlc.brand_vetting_appeals.<a href="/lib/wavix/ten_dlc/brand_vetting_appeals/client.rb">create</a>(brand_id, request) -> Wavix::Types::SuccessResponse</code></summary>
8218
8601
  <dl>
8219
8602
  <dd>
8220
8603
 
@@ -8268,7 +8651,7 @@ client.ten_dlc.brand_vetting_appeals.create(
8268
8651
  <dl>
8269
8652
  <dd>
8270
8653
 
8271
- **appeal_categories:** `Internal::Types::Array[String]` — List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`.
8654
+ **appeal_categories:** `Internal::Types::Array[Wavix::TenDlc::BrandVettingAppeals::Types::TenDlcBrandVettingAppealCreateRequestAppealCategoriesItem]` — List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`. `LOW_SCORE` is only valid for vetting appeals — brand identity appeals (`ten_dlc_brand_appeals_create`) do not accept it.
8272
8655
 
8273
8656
  </dd>
8274
8657
  </dl>
@@ -8321,7 +8704,7 @@ client.ten_dlc.brand_vetting_appeals.create(
8321
8704
  </details>
8322
8705
 
8323
8706
  ## TenDlc Campaigns
8324
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list</a>() -> Wavix::TenDlc::Campaigns::Types::ListCampaignsResponse</code></summary>
8707
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list</a>() -> Wavix::Types::TenDlcCampaignListResponse</code></summary>
8325
8708
  <dl>
8326
8709
  <dd>
8327
8710
 
@@ -8448,7 +8831,7 @@ client.ten_dlc.campaigns.list(
8448
8831
  </dl>
8449
8832
  </details>
8450
8833
 
8451
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list_by_brand</a>(brand_id) -> Wavix::TenDlc::Campaigns::Types::ListByBrandCampaignsResponse</code></summary>
8834
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list_by_brand</a>(brand_id) -> Wavix::Types::TenDlcCampaignListResponse</code></summary>
8452
8835
  <dl>
8453
8836
  <dd>
8454
8837
 
@@ -8584,7 +8967,7 @@ client.ten_dlc.campaigns.list_by_brand(
8584
8967
  </dl>
8585
8968
  </details>
8586
8969
 
8587
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">create</a>(brand_id, request) -> Wavix::TenDlc::Campaigns::Types::CreateCampaignsResponse</code></summary>
8970
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">create</a>(brand_id, request) -> Wavix::Types::TenDlcCampaign</code></summary>
8588
8971
  <dl>
8589
8972
  <dd>
8590
8973
 
@@ -8900,7 +9283,7 @@ client.ten_dlc.campaigns.create(
8900
9283
  </dl>
8901
9284
  </details>
8902
9285
 
8903
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">get</a>(brand_id, campaign_id) -> Wavix::TenDlc::Campaigns::Types::GetCampaignsResponse</code></summary>
9286
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">get</a>(brand_id, campaign_id) -> Wavix::Types::TenDlcCampaign</code></summary>
8904
9287
  <dl>
8905
9288
  <dd>
8906
9289
 
@@ -8973,7 +9356,7 @@ client.ten_dlc.campaigns.get(
8973
9356
  </dl>
8974
9357
  </details>
8975
9358
 
8976
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">update</a>(brand_id, campaign_id, request) -> Wavix::TenDlc::Campaigns::Types::UpdateCampaignsResponse</code></summary>
9359
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">update</a>(brand_id, campaign_id, request) -> Wavix::Types::TenDlcCampaign</code></summary>
8977
9360
  <dl>
8978
9361
  <dd>
8979
9362
 
@@ -9254,7 +9637,7 @@ client.ten_dlc.campaigns.update(
9254
9637
  </dl>
9255
9638
  </details>
9256
9639
 
9257
- <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">delete</a>(brand_id, campaign_id) -> Wavix::TenDlc::Campaigns::Types::DeleteCampaignsResponse</code></summary>
9640
+ <details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">delete</a>(brand_id, campaign_id) -> Wavix::Types::SuccessResponse</code></summary>
9258
9641
  <dl>
9259
9642
  <dd>
9260
9643
 
@@ -9394,10 +9777,7 @@ client.ten_dlc.campaigns.nudge(
9394
9777
  <dl>
9395
9778
  <dd>
9396
9779
 
9397
- **nudge_intent:** `String`
9398
-
9399
- Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`.
9400
- Use `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
9780
+ **nudge_intent:** `String` — Action the nudge requests: `REVIEW` requests review of a pending Campaign, and `APPEAL_REJECTION` appeals a rejected Campaign.
9401
9781
 
9402
9782
  </dd>
9403
9783
  </dl>
@@ -9480,7 +9860,7 @@ client.ten_dlc.subscriptions.list
9480
9860
  </dl>
9481
9861
  </details>
9482
9862
 
9483
- <details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">create</a>(request) -> Wavix::TenDlc::Subscriptions::Types::CreateSubscriptionsResponse</code></summary>
9863
+ <details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">create</a>(request) -> Wavix::Types::TenDlcEventSubscription</code></summary>
9484
9864
  <dl>
9485
9865
  <dd>
9486
9866
 
@@ -9545,7 +9925,7 @@ client.ten_dlc.subscriptions.create(
9545
9925
  </dl>
9546
9926
  </details>
9547
9927
 
9548
- <details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">delete</a>() -> Wavix::TenDlc::Subscriptions::Types::DeleteSubscriptionsResponse</code></summary>
9928
+ <details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">delete</a>() -> Wavix::Types::SuccessResponse</code></summary>
9549
9929
  <dl>
9550
9930
  <dd>
9551
9931
 
@@ -9608,7 +9988,7 @@ client.ten_dlc.subscriptions.delete(subscription_category: "number")
9608
9988
  </details>
9609
9989
 
9610
9990
  ## TenDlc CampaignNumbers
9611
- <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">link</a>(brand_id, campaign_id, number) -> Wavix::TenDlc::CampaignNumbers::Types::LinkCampaignNumbersResponse</code></summary>
9991
+ <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">link</a>(brand_id, campaign_id, number) -> Wavix::Types::SuccessResponse</code></summary>
9612
9992
  <dl>
9613
9993
  <dd>
9614
9994
 
@@ -9690,7 +10070,7 @@ client.ten_dlc.campaign_numbers.link(
9690
10070
  </dl>
9691
10071
  </details>
9692
10072
 
9693
- <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">unlink</a>(brand_id, campaign_id, number) -> Wavix::TenDlc::CampaignNumbers::Types::UnlinkCampaignNumbersResponse</code></summary>
10073
+ <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">unlink</a>(brand_id, campaign_id, number) -> Wavix::Types::SuccessResponse</code></summary>
9694
10074
  <dl>
9695
10075
  <dd>
9696
10076
 
@@ -9772,7 +10152,7 @@ client.ten_dlc.campaign_numbers.unlink(
9772
10152
  </dl>
9773
10153
  </details>
9774
10154
 
9775
- <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">list</a>(brand_id, campaign_id) -> Wavix::TenDlc::CampaignNumbers::Types::ListCampaignNumbersResponse</code></summary>
10155
+ <details><summary><code>client.ten_dlc.campaign_numbers.<a href="/lib/wavix/ten_dlc/campaign_numbers/client.rb">list</a>(brand_id, campaign_id) -> Wavix::Types::TenDlcCampaignNumberListResponse</code></summary>
9776
10156
  <dl>
9777
10157
  <dd>
9778
10158
 
@@ -9846,7 +10226,7 @@ client.ten_dlc.campaign_numbers.list(
9846
10226
  </details>
9847
10227
 
9848
10228
  ## TwoFa Verification
9849
- <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">create</a>(request) -> Wavix::TwoFa::Verification::Types::CreateVerificationResponse</code></summary>
10229
+ <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">create</a>(request) -> Wavix::Types::TwoFactorVerificationResponse</code></summary>
9850
10230
  <dl>
9851
10231
  <dd>
9852
10232
 
@@ -9858,7 +10238,7 @@ client.ten_dlc.campaign_numbers.list(
9858
10238
  <dl>
9859
10239
  <dd>
9860
10240
 
9861
- Creates a 2FA verification and sends a one-time password (OTP) to the destination phone number over the selected channel. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and validate OTPs.
10241
+ Creates a 2FA verification and sends a real one-time password (OTP) to the destination phone number over the selected channel; this bills the account per OTP sent. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and validate OTPs.
9862
10242
 
9863
10243
  The verification proceeds through three steps:
9864
10244
  1. Create a verification to generate and send an OTP.
@@ -9933,7 +10313,7 @@ client.two_fa.verification.create(
9933
10313
  </dl>
9934
10314
  </details>
9935
10315
 
9936
- <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">resend</a>(session_id, request) -> Wavix::TwoFa::Verification::Types::ResendVerificationResponse</code></summary>
10316
+ <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">resend</a>(session_id, request) -> Wavix::Types::TwoFactorVerificationResendResponse</code></summary>
9937
10317
  <dl>
9938
10318
  <dd>
9939
10319
 
@@ -10006,7 +10386,7 @@ client.two_fa.verification.resend(
10006
10386
  </dl>
10007
10387
  </details>
10008
10388
 
10009
- <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">check</a>(session_id, request) -> Wavix::TwoFa::Verification::Types::CheckVerificationResponse</code></summary>
10389
+ <details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">check</a>(session_id, request) -> Wavix::Types::TwoFactorVerificationCheckResponse</code></summary>
10010
10390
  <dl>
10011
10391
  <dd>
10012
10392
 
@@ -10018,7 +10398,7 @@ client.two_fa.verification.resend(
10018
10398
  <dl>
10019
10399
  <dd>
10020
10400
 
10021
- Validates the OTP submitted by the end user against the verification identified by `session_id`.
10401
+ Validates the OTP submitted by the end user against the verification identified by `session_id`. Non-idempotent — each call consumes one of a limited number of attempts tracked server-side; once exhausted, the verification returns `429` until a new verification is created.
10022
10402
  </dd>
10023
10403
  </dl>
10024
10404
  </dd>
@@ -10300,7 +10680,7 @@ client.two_fa.events.list(session_id: "8753d4308f2e11ecb75fcdafd6d2d690")
10300
10680
  <dl>
10301
10681
  <dd>
10302
10682
 
10303
- Returns a paginated list of active Wavix Embeddable widget tokens for the authenticated account.
10683
+ Returns a paginated list of Wavix Embeddable widget tokens for the authenticated account.
10304
10684
  </dd>
10305
10685
  </dl>
10306
10686
  </dd>
@@ -10330,6 +10710,22 @@ client.webrtc.tokens.list
10330
10710
  <dl>
10331
10711
  <dd>
10332
10712
 
10713
+ **page:** `Integer` — Page number to retrieve. Default `1`.
10714
+
10715
+ </dd>
10716
+ </dl>
10717
+
10718
+ <dl>
10719
+ <dd>
10720
+
10721
+ **per_page:** `Integer` — Number of records to return per page. Default `25`.
10722
+
10723
+ </dd>
10724
+ </dl>
10725
+
10726
+ <dl>
10727
+ <dd>
10728
+
10333
10729
  **request_options:** `Wavix::Webrtc::Tokens::RequestOptions`
10334
10730
 
10335
10731
  </dd>
@@ -10404,7 +10800,7 @@ client.webrtc.tokens.create(
10404
10800
  <dl>
10405
10801
  <dd>
10406
10802
 
10407
- **ttl:** `Integer` — Time to live in seconds. Pass `null` for no expiration.
10803
+ **ttl:** `Integer` — Time to live in seconds. Default `3600`; `null` means no expiration.
10408
10804
 
10409
10805
  </dd>
10410
10806
  </dl>