wavix-ruby-sdk 1.1.1 → 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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +5 -4
- data/.fern/replay.lock +7 -1
- data/.fernignore +1 -0
- data/lib/wavix/call_control/streams/client.rb +3 -3
- data/lib/wavix/call_webhooks/client.rb +13 -0
- data/lib/wavix/call_webhooks/types/call_webhooks_create_request.rb +2 -0
- data/lib/wavix/call_webhooks/types/delete_call_webhooks_request.rb +2 -0
- data/lib/wavix/cdrs/client.rb +2 -1
- data/lib/wavix/client.rb +1 -1
- data/lib/wavix/numbers/client.rb +7 -0
- data/lib/wavix/numbers/types/number_update_request.rb +2 -0
- data/lib/wavix/sip_trunks/client.rb +9 -7
- data/lib/wavix/sip_trunks/types/sip_trunk_create_request.rb +53 -0
- data/lib/wavix/sip_trunks/types/sip_trunk_create_request_allowed_ips_item.rb +11 -0
- data/lib/wavix/sip_trunks/types/sip_trunk_create_request_host_request.rb +13 -0
- data/lib/wavix/sip_trunks/types/sip_trunk_update_request.rb +55 -0
- data/lib/wavix/sip_trunks/types/sip_trunk_update_request_allowed_ips_item.rb +11 -0
- data/lib/wavix/sip_trunks/types/sip_trunk_update_request_host_request.rb +14 -0
- data/lib/wavix/sub_accounts/client.rb +1 -1
- data/lib/wavix/types/webhook_in_use_error_response.rb +14 -0
- data/lib/wavix/types/whats_app_business_account.rb +16 -0
- data/lib/wavix/types/whats_app_business_account_messaging_limit.rb +15 -0
- data/lib/wavix/types/whats_app_message.rb +2 -1
- data/lib/wavix/types/whats_app_message_get_response.rb +1 -0
- data/lib/wavix/types/whats_app_message_list_item.rb +3 -1
- data/lib/wavix/types/whats_app_message_list_item_status.rb +0 -1
- data/lib/wavix/types/whats_app_message_list_response.rb +1 -0
- data/lib/wavix/types/whats_app_message_send_request.rb +4 -1
- data/lib/wavix/types/whats_app_message_send_response.rb +1 -0
- data/lib/wavix/types/whats_app_message_status.rb +0 -1
- data/lib/wavix/types/whats_app_message_template.rb +3 -3
- data/lib/wavix/types/whats_app_problem.rb +2 -1
- data/lib/wavix/types/{whats_app_message_send_request_template.rb → whats_app_send_template.rb} +4 -3
- data/lib/wavix/types/whats_app_send_template_button.rb +27 -0
- data/lib/wavix/types/whats_app_send_template_button_type.rb +18 -0
- data/lib/wavix/types/{whats_app_message_send_request_template_header.rb → whats_app_send_template_header.rb} +7 -5
- data/lib/wavix/types/whats_app_send_template_header_type.rb +16 -0
- data/lib/wavix/types/whats_app_sender.rb +5 -3
- data/lib/wavix/types/whats_app_sender_list_response.rb +12 -0
- data/lib/wavix/types/whats_app_template.rb +6 -2
- data/lib/wavix/types/whats_app_template_body_component_request.rb +12 -0
- data/lib/wavix/types/whats_app_template_body_component_request_example.rb +10 -0
- data/lib/wavix/types/whats_app_template_button_request.rb +21 -0
- data/lib/wavix/types/whats_app_template_buttons_component_request.rb +10 -0
- data/lib/wavix/types/whats_app_template_component_request.rb +21 -0
- data/lib/wavix/types/whats_app_template_copy_code_button_request.rb +10 -0
- data/lib/wavix/types/whats_app_template_create_request.rb +6 -1
- data/lib/wavix/types/whats_app_template_footer_component_request.rb +10 -0
- data/lib/wavix/types/whats_app_template_header_component_request.rb +23 -0
- data/lib/wavix/types/whats_app_template_location_header_component_request.rb +11 -0
- data/lib/wavix/types/whats_app_template_location_header_component_request_type.rb +11 -0
- data/lib/wavix/types/whats_app_template_media_header_component_request.rb +12 -0
- data/lib/wavix/types/whats_app_template_media_header_component_request_example.rb +10 -0
- data/lib/wavix/types/whats_app_template_media_header_component_request_type.rb +11 -0
- data/lib/wavix/types/whats_app_template_page_response.rb +12 -0
- data/lib/wavix/types/whats_app_template_phone_number_button_request.rb +12 -0
- data/lib/wavix/types/whats_app_template_quick_reply_button_request.rb +10 -0
- data/lib/wavix/types/whats_app_template_response.rb +1 -0
- data/lib/wavix/types/whats_app_template_response_component.rb +20 -0
- data/lib/wavix/types/whats_app_template_response_component_format.rb +15 -0
- data/lib/wavix/types/whats_app_template_text_header_component_request.rb +14 -0
- data/lib/wavix/types/whats_app_template_text_header_component_request_example.rb +10 -0
- data/lib/wavix/types/whats_app_template_text_header_component_request_type.rb +11 -0
- data/lib/wavix/types/whats_app_template_url_button_request.rb +14 -0
- data/lib/wavix/types/whats_app_waba.rb +12 -0
- data/lib/wavix/types/whats_app_waba_list_response.rb +12 -0
- data/lib/wavix/version.rb +1 -1
- data/lib/wavix.rb +42 -17
- data/reference.md +401 -29
- metadata +41 -16
- data/lib/wavix/sip_trunks/types/update_sip_trunks_request.rb +0 -13
- data/lib/wavix/types/sip_trunk_create_request.rb +0 -51
- data/lib/wavix/types/sip_trunk_create_request_allowed_ips_item.rb +0 -9
- data/lib/wavix/types/sip_trunk_create_request_host_request.rb +0 -11
- data/lib/wavix/types/whats_app_message_send_request_template_buttons_item.rb +0 -9
- data/lib/wavix/types/whats_app_message_send_request_template_buttons_item_type.rb +0 -18
- data/lib/wavix/types/whats_app_message_send_request_template_header_type.rb +0 -16
- data/lib/wavix/types/whats_app_sender_message_tier.rb +0 -16
- data/lib/wavix/types/whats_app_template_component.rb +0 -18
- data/lib/wavix/types/whats_app_template_component_format.rb +0 -15
- data/lib/wavix/types/whats_app_template_component_type.rb +0 -14
- data/lib/wavix/types/whats_app_template_list_response.rb +0 -9
data/reference.md
CHANGED
|
@@ -684,7 +684,184 @@ client.sip_trunks.create(
|
|
|
684
684
|
<dl>
|
|
685
685
|
<dd>
|
|
686
686
|
|
|
687
|
-
**
|
|
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.
|
|
688
865
|
|
|
689
866
|
</dd>
|
|
690
867
|
</dl>
|
|
@@ -778,7 +955,7 @@ client.sip_trunks.get(id: 3107)
|
|
|
778
955
|
<dl>
|
|
779
956
|
<dd>
|
|
780
957
|
|
|
781
|
-
|
|
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.
|
|
782
959
|
</dd>
|
|
783
960
|
</dl>
|
|
784
961
|
</dd>
|
|
@@ -793,19 +970,7 @@ Replaces the configuration of the SIP trunk identified by `id`. Omitted fields r
|
|
|
793
970
|
<dd>
|
|
794
971
|
|
|
795
972
|
```ruby
|
|
796
|
-
client.sip_trunks.update(
|
|
797
|
-
id: 3107,
|
|
798
|
-
label: "My trunk",
|
|
799
|
-
password: "4r=h;EaCB85QNtr2",
|
|
800
|
-
callerid: "13132847320",
|
|
801
|
-
ip_restrict: false,
|
|
802
|
-
didinfo_enabled: true,
|
|
803
|
-
call_restrict: true,
|
|
804
|
-
channels_restrict: false,
|
|
805
|
-
rewrite_enabled: true,
|
|
806
|
-
transcription_enabled: true,
|
|
807
|
-
transcription_threshold: 10
|
|
808
|
-
)
|
|
973
|
+
client.sip_trunks.update(id: 3107)
|
|
809
974
|
```
|
|
810
975
|
</dd>
|
|
811
976
|
</dl>
|
|
@@ -828,7 +993,184 @@ client.sip_trunks.update(
|
|
|
828
993
|
<dl>
|
|
829
994
|
<dd>
|
|
830
995
|
|
|
831
|
-
**
|
|
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.
|
|
832
1174
|
|
|
833
1175
|
</dd>
|
|
834
1176
|
</dl>
|
|
@@ -1527,6 +1869,8 @@ client.numbers.get(id: 123)
|
|
|
1527
1869
|
<dd>
|
|
1528
1870
|
|
|
1529
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.
|
|
1530
1874
|
</dd>
|
|
1531
1875
|
</dl>
|
|
1532
1876
|
</dd>
|
|
@@ -1580,7 +1924,15 @@ client.numbers.update(id: 123)
|
|
|
1580
1924
|
<dl>
|
|
1581
1925
|
<dd>
|
|
1582
1926
|
|
|
1583
|
-
**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`.
|
|
1584
1936
|
|
|
1585
1937
|
</dd>
|
|
1586
1938
|
</dl>
|
|
@@ -1948,7 +2300,7 @@ Call disposition to filter results. If omitted, returns only answered
|
|
|
1948
2300
|
<dl>
|
|
1949
2301
|
<dd>
|
|
1950
2302
|
|
|
1951
|
-
Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the transcription endpoint for the result. Billed per minute at the account's call-transcription rate; fails with an insufficient-funds error when the balance cannot cover it.
|
|
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.
|
|
1952
2304
|
</dd>
|
|
1953
2305
|
</dl>
|
|
1954
2306
|
</dd>
|
|
@@ -2885,6 +3237,8 @@ client.call_webhooks.list
|
|
|
2885
3237
|
<dd>
|
|
2886
3238
|
|
|
2887
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.
|
|
2888
3242
|
</dd>
|
|
2889
3243
|
</dl>
|
|
2890
3244
|
</dd>
|
|
@@ -2940,6 +3294,14 @@ Allowed values: `on-call`, `post-call`.
|
|
|
2940
3294
|
<dl>
|
|
2941
3295
|
<dd>
|
|
2942
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
|
+
|
|
2943
3305
|
**request_options:** `Wavix::CallWebhooks::RequestOptions`
|
|
2944
3306
|
|
|
2945
3307
|
</dd>
|
|
@@ -2965,6 +3327,8 @@ Allowed values: `on-call`, `post-call`.
|
|
|
2965
3327
|
<dd>
|
|
2966
3328
|
|
|
2967
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.
|
|
2968
3332
|
</dd>
|
|
2969
3333
|
</dl>
|
|
2970
3334
|
</dd>
|
|
@@ -2979,7 +3343,10 @@ Removes the call webhook for the given event type. Wavix stops sending callbacks
|
|
|
2979
3343
|
<dd>
|
|
2980
3344
|
|
|
2981
3345
|
```ruby
|
|
2982
|
-
client.call_webhooks.delete(
|
|
3346
|
+
client.call_webhooks.delete(
|
|
3347
|
+
event_type: "post-call",
|
|
3348
|
+
expected_url: "https://your-site.com/webhook"
|
|
3349
|
+
)
|
|
2983
3350
|
```
|
|
2984
3351
|
</dd>
|
|
2985
3352
|
</dl>
|
|
@@ -3002,6 +3369,14 @@ client.call_webhooks.delete(event_type: "post-call")
|
|
|
3002
3369
|
<dl>
|
|
3003
3370
|
<dd>
|
|
3004
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
|
+
|
|
3005
3380
|
**request_options:** `Wavix::CallWebhooks::RequestOptions`
|
|
3006
3381
|
|
|
3007
3382
|
</dd>
|
|
@@ -3446,7 +3821,7 @@ client.call_control.answer(id: "id")
|
|
|
3446
3821
|
<dl>
|
|
3447
3822
|
<dd>
|
|
3448
3823
|
|
|
3449
|
-
**stream_url:** `String` — WebSocket URL
|
|
3824
|
+
**stream_url:** `String` — WebSocket URL (`ws://` or `wss://`) that receives the call's audio, which can include the caller's voice.
|
|
3450
3825
|
|
|
3451
3826
|
</dd>
|
|
3452
3827
|
</dl>
|
|
@@ -4400,7 +4775,7 @@ client.sub_accounts.get(id: 123)
|
|
|
4400
4775
|
<dl>
|
|
4401
4776
|
<dd>
|
|
4402
4777
|
|
|
4403
|
-
|
|
4778
|
+
Updates the sub-account identified by `id`. Only the provided fields are changed.
|
|
4404
4779
|
</dd>
|
|
4405
4780
|
</dl>
|
|
4406
4781
|
</dd>
|
|
@@ -5135,7 +5510,7 @@ client.buy.numbers.list(
|
|
|
5135
5510
|
<dl>
|
|
5136
5511
|
<dd>
|
|
5137
5512
|
|
|
5138
|
-
Starts streaming the audio of the call identified by `call_id` to
|
|
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.
|
|
5139
5514
|
</dd>
|
|
5140
5515
|
</dl>
|
|
5141
5516
|
</dd>
|
|
@@ -5178,7 +5553,7 @@ client.call_control.streams.create(
|
|
|
5178
5553
|
<dl>
|
|
5179
5554
|
<dd>
|
|
5180
5555
|
|
|
5181
|
-
**stream_url:** `String` — WebSocket URL
|
|
5556
|
+
**stream_url:** `String` — WebSocket URL (`ws://` or `wss://`) that receives the call's audio.
|
|
5182
5557
|
|
|
5183
5558
|
</dd>
|
|
5184
5559
|
</dl>
|
|
@@ -7317,7 +7692,7 @@ Business segment the Brand operates in. One of:
|
|
|
7317
7692
|
<dl>
|
|
7318
7693
|
<dd>
|
|
7319
7694
|
|
|
7320
|
-
**state_or_province:** `String` — State or province. For the United States,
|
|
7695
|
+
**state_or_province:** `String` — State or province. For the United States, it is a 2-character code.
|
|
7321
7696
|
|
|
7322
7697
|
</dd>
|
|
7323
7698
|
</dl>
|
|
@@ -9402,10 +9777,7 @@ client.ten_dlc.campaigns.nudge(
|
|
|
9402
9777
|
<dl>
|
|
9403
9778
|
<dd>
|
|
9404
9779
|
|
|
9405
|
-
**nudge_intent:** `String`
|
|
9406
|
-
|
|
9407
|
-
Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`.
|
|
9408
|
-
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.
|
|
9409
9781
|
|
|
9410
9782
|
</dd>
|
|
9411
9783
|
</dl>
|
|
@@ -10428,7 +10800,7 @@ client.webrtc.tokens.create(
|
|
|
10428
10800
|
<dl>
|
|
10429
10801
|
<dd>
|
|
10430
10802
|
|
|
10431
|
-
**ttl:** `Integer` — Time to live in seconds. Default `3600
|
|
10803
|
+
**ttl:** `Integer` — Time to live in seconds. Default `3600`; `null` means no expiration.
|
|
10432
10804
|
|
|
10433
10805
|
</dd>
|
|
10434
10806
|
</dl>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: wavix-ruby-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Wavix
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-11-04 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The Wavix Ruby library provides convenient access to the Wavix API from
|
|
14
14
|
Ruby.
|
|
@@ -149,7 +149,12 @@ files:
|
|
|
149
149
|
- lib/wavix/sip_trunks/types/delete_sip_trunks_request.rb
|
|
150
150
|
- lib/wavix/sip_trunks/types/get_sip_trunks_request.rb
|
|
151
151
|
- lib/wavix/sip_trunks/types/list_sip_trunks_request.rb
|
|
152
|
-
- lib/wavix/sip_trunks/types/
|
|
152
|
+
- lib/wavix/sip_trunks/types/sip_trunk_create_request.rb
|
|
153
|
+
- lib/wavix/sip_trunks/types/sip_trunk_create_request_allowed_ips_item.rb
|
|
154
|
+
- lib/wavix/sip_trunks/types/sip_trunk_create_request_host_request.rb
|
|
155
|
+
- lib/wavix/sip_trunks/types/sip_trunk_update_request.rb
|
|
156
|
+
- lib/wavix/sip_trunks/types/sip_trunk_update_request_allowed_ips_item.rb
|
|
157
|
+
- lib/wavix/sip_trunks/types/sip_trunk_update_request_host_request.rb
|
|
153
158
|
- lib/wavix/sms_and_mms/client.rb
|
|
154
159
|
- lib/wavix/sms_and_mms/messages/client.rb
|
|
155
160
|
- lib/wavix/sms_and_mms/messages/types/get_messages_request.rb
|
|
@@ -353,9 +358,6 @@ files:
|
|
|
353
358
|
- lib/wavix/types/short_link_metrics_item.rb
|
|
354
359
|
- lib/wavix/types/short_link_metrics_response.rb
|
|
355
360
|
- lib/wavix/types/short_link_response.rb
|
|
356
|
-
- lib/wavix/types/sip_trunk_create_request.rb
|
|
357
|
-
- lib/wavix/types/sip_trunk_create_request_allowed_ips_item.rb
|
|
358
|
-
- lib/wavix/types/sip_trunk_create_request_host_request.rb
|
|
359
361
|
- lib/wavix/types/sip_trunk_list_response.rb
|
|
360
362
|
- lib/wavix/types/sip_trunk_response.rb
|
|
361
363
|
- lib/wavix/types/sip_trunk_summary.rb
|
|
@@ -434,6 +436,9 @@ files:
|
|
|
434
436
|
- lib/wavix/types/web_rtc_token.rb
|
|
435
437
|
- lib/wavix/types/web_rtc_token_response.rb
|
|
436
438
|
- lib/wavix/types/web_rtc_tokens_list_response.rb
|
|
439
|
+
- lib/wavix/types/webhook_in_use_error_response.rb
|
|
440
|
+
- lib/wavix/types/whats_app_business_account.rb
|
|
441
|
+
- lib/wavix/types/whats_app_business_account_messaging_limit.rb
|
|
437
442
|
- lib/wavix/types/whats_app_message.rb
|
|
438
443
|
- lib/wavix/types/whats_app_message_get_response.rb
|
|
439
444
|
- lib/wavix/types/whats_app_message_list_item.rb
|
|
@@ -441,31 +446,51 @@ files:
|
|
|
441
446
|
- lib/wavix/types/whats_app_message_list_item_status.rb
|
|
442
447
|
- lib/wavix/types/whats_app_message_list_response.rb
|
|
443
448
|
- lib/wavix/types/whats_app_message_send_request.rb
|
|
444
|
-
- lib/wavix/types/whats_app_message_send_request_template.rb
|
|
445
|
-
- lib/wavix/types/whats_app_message_send_request_template_buttons_item.rb
|
|
446
|
-
- lib/wavix/types/whats_app_message_send_request_template_buttons_item_type.rb
|
|
447
|
-
- lib/wavix/types/whats_app_message_send_request_template_header.rb
|
|
448
|
-
- lib/wavix/types/whats_app_message_send_request_template_header_type.rb
|
|
449
449
|
- lib/wavix/types/whats_app_message_send_response.rb
|
|
450
450
|
- lib/wavix/types/whats_app_message_status.rb
|
|
451
451
|
- lib/wavix/types/whats_app_message_template.rb
|
|
452
452
|
- lib/wavix/types/whats_app_problem.rb
|
|
453
453
|
- lib/wavix/types/whats_app_problem_error_class.rb
|
|
454
|
+
- lib/wavix/types/whats_app_send_template.rb
|
|
455
|
+
- lib/wavix/types/whats_app_send_template_button.rb
|
|
456
|
+
- lib/wavix/types/whats_app_send_template_button_type.rb
|
|
457
|
+
- lib/wavix/types/whats_app_send_template_header.rb
|
|
458
|
+
- lib/wavix/types/whats_app_send_template_header_type.rb
|
|
454
459
|
- lib/wavix/types/whats_app_sender.rb
|
|
455
|
-
- lib/wavix/types/
|
|
460
|
+
- lib/wavix/types/whats_app_sender_list_response.rb
|
|
456
461
|
- lib/wavix/types/whats_app_sender_quality_rating.rb
|
|
457
462
|
- lib/wavix/types/whats_app_sender_status.rb
|
|
458
463
|
- lib/wavix/types/whats_app_template.rb
|
|
464
|
+
- lib/wavix/types/whats_app_template_body_component_request.rb
|
|
465
|
+
- lib/wavix/types/whats_app_template_body_component_request_example.rb
|
|
466
|
+
- lib/wavix/types/whats_app_template_button_request.rb
|
|
467
|
+
- lib/wavix/types/whats_app_template_buttons_component_request.rb
|
|
459
468
|
- lib/wavix/types/whats_app_template_category.rb
|
|
460
|
-
- lib/wavix/types/
|
|
461
|
-
- lib/wavix/types/
|
|
462
|
-
- lib/wavix/types/whats_app_template_component_type.rb
|
|
469
|
+
- lib/wavix/types/whats_app_template_component_request.rb
|
|
470
|
+
- lib/wavix/types/whats_app_template_copy_code_button_request.rb
|
|
463
471
|
- lib/wavix/types/whats_app_template_create_request.rb
|
|
464
472
|
- lib/wavix/types/whats_app_template_create_request_category.rb
|
|
465
|
-
- lib/wavix/types/
|
|
473
|
+
- lib/wavix/types/whats_app_template_footer_component_request.rb
|
|
474
|
+
- lib/wavix/types/whats_app_template_header_component_request.rb
|
|
475
|
+
- lib/wavix/types/whats_app_template_location_header_component_request.rb
|
|
476
|
+
- lib/wavix/types/whats_app_template_location_header_component_request_type.rb
|
|
477
|
+
- lib/wavix/types/whats_app_template_media_header_component_request.rb
|
|
478
|
+
- lib/wavix/types/whats_app_template_media_header_component_request_example.rb
|
|
479
|
+
- lib/wavix/types/whats_app_template_media_header_component_request_type.rb
|
|
480
|
+
- lib/wavix/types/whats_app_template_page_response.rb
|
|
481
|
+
- lib/wavix/types/whats_app_template_phone_number_button_request.rb
|
|
466
482
|
- lib/wavix/types/whats_app_template_quality_rating.rb
|
|
483
|
+
- lib/wavix/types/whats_app_template_quick_reply_button_request.rb
|
|
467
484
|
- lib/wavix/types/whats_app_template_response.rb
|
|
485
|
+
- lib/wavix/types/whats_app_template_response_component.rb
|
|
486
|
+
- lib/wavix/types/whats_app_template_response_component_format.rb
|
|
468
487
|
- lib/wavix/types/whats_app_template_status.rb
|
|
488
|
+
- lib/wavix/types/whats_app_template_text_header_component_request.rb
|
|
489
|
+
- lib/wavix/types/whats_app_template_text_header_component_request_example.rb
|
|
490
|
+
- lib/wavix/types/whats_app_template_text_header_component_request_type.rb
|
|
491
|
+
- lib/wavix/types/whats_app_template_url_button_request.rb
|
|
492
|
+
- lib/wavix/types/whats_app_waba.rb
|
|
493
|
+
- lib/wavix/types/whats_app_waba_list_response.rb
|
|
469
494
|
- lib/wavix/version.rb
|
|
470
495
|
- lib/wavix/voice_campaigns/client.rb
|
|
471
496
|
- lib/wavix/voice_campaigns/types/create_voice_campaigns_request.rb
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Wavix
|
|
4
|
-
module SipTrunks
|
|
5
|
-
module Types
|
|
6
|
-
class UpdateSipTrunksRequest < Internal::Types::Model
|
|
7
|
-
field :id, -> { Integer }, optional: false, nullable: false
|
|
8
|
-
|
|
9
|
-
field :body, -> { Wavix::Types::SipTrunkCreateRequest }, optional: false, nullable: false
|
|
10
|
-
end
|
|
11
|
-
end
|
|
12
|
-
end
|
|
13
|
-
end
|