wavix-ruby-sdk 1.0.0 → 1.1.1
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 +3 -3
- data/.fern/replay.lock +16 -0
- data/.fernignore +3 -0
- data/lib/wavix/api_keys/client.rb +1 -1
- data/lib/wavix/billing/invoices/client.rb +2 -2
- data/lib/wavix/billing/transactions/client.rb +2 -2
- data/lib/wavix/buy/cities/client.rb +2 -2
- data/lib/wavix/buy/countries/client.rb +2 -2
- data/lib/wavix/buy/numbers/client.rb +2 -2
- data/lib/wavix/buy/region_cities/client.rb +2 -2
- data/lib/wavix/buy/regions/client.rb +2 -2
- data/lib/wavix/call_control/audio/client.rb +2 -1
- data/lib/wavix/call_control/client.rb +4 -3
- data/lib/wavix/call_control/streams/client.rb +3 -2
- data/lib/wavix/call_control/types/call_dtmf_collect_request_prompt_say.rb +3 -1
- data/lib/wavix/call_recording/client.rb +1 -1
- data/lib/wavix/call_webhooks/client.rb +2 -1
- data/lib/wavix/cart/client.rb +9 -9
- data/lib/wavix/cdrs/client.rb +2 -1
- data/lib/wavix/cdrs/types/cdr_search_request.rb +3 -3
- data/lib/wavix/client.rb +1 -1
- data/lib/wavix/number_validator/client.rb +6 -3
- data/lib/wavix/number_validator/types/phone_validation_request.rb +2 -2
- data/lib/wavix/numbers/client.rb +2 -2
- data/lib/wavix/profile/config/client.rb +2 -2
- data/lib/wavix/sms_and_mms/messages/client.rb +6 -6
- data/lib/wavix/sms_and_mms/opt_outs/client.rb +2 -2
- data/lib/wavix/sms_and_mms/sender_ids/client.rb +4 -3
- data/lib/wavix/speech_analytics/client.rb +4 -4
- data/lib/wavix/sub_accounts/client.rb +4 -0
- data/lib/wavix/sub_accounts/types/list_sub_accounts_request.rb +4 -0
- data/lib/wavix/sub_accounts/types/sub_accounts_update_request.rb +1 -1
- data/lib/wavix/ten_dlc/brand_appeals/client.rb +2 -2
- data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_request.rb +1 -1
- data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_request_appeal_categories_item.rb +17 -0
- data/lib/wavix/ten_dlc/brand_evidence/client.rb +4 -4
- data/lib/wavix/ten_dlc/brand_vetting_appeals/client.rb +2 -2
- data/lib/wavix/ten_dlc/brand_vetting_appeals/types/ten_dlc_brand_vetting_appeal_create_request.rb +1 -1
- data/lib/wavix/ten_dlc/brand_vetting_appeals/types/ten_dlc_brand_vetting_appeal_create_request_appeal_categories_item.rb +18 -0
- data/lib/wavix/ten_dlc/brand_vettings/client.rb +2 -1
- data/lib/wavix/ten_dlc/brands/client.rb +16 -14
- data/lib/wavix/ten_dlc/campaign_numbers/client.rb +6 -6
- data/lib/wavix/ten_dlc/campaigns/client.rb +12 -12
- data/lib/wavix/ten_dlc/campaigns/types/ten_dlc_campaign_create_request.rb +6 -6
- data/lib/wavix/ten_dlc/subscriptions/client.rb +4 -4
- data/lib/wavix/two_fa/verification/client.rb +11 -9
- data/lib/wavix/types/{document_type_id.rb → api_key_with_secret.rb} +2 -2
- data/lib/wavix/types/available_number.rb +1 -1
- data/lib/wavix/types/cart_response.rb +1 -1
- data/lib/wavix/types/cdr_transcription_response.rb +1 -1
- data/lib/wavix/types/document_type.rb +5 -5
- data/lib/wavix/types/document_type_info.rb +14 -0
- data/lib/wavix/types/file_transcription_response.rb +2 -2
- data/lib/wavix/types/message_body.rb +1 -1
- data/lib/wavix/types/number.rb +1 -1
- data/lib/wavix/types/number_document.rb +1 -1
- data/lib/wavix/types/number_list_response.rb +1 -1
- data/lib/wavix/types/sip_trunk_create_request.rb +1 -1
- data/lib/wavix/types/ten_dlc_brand.rb +1 -1
- data/lib/wavix/types/ten_dlc_brand_appeal_create_request.rb +1 -1
- data/lib/wavix/types/ten_dlc_brand_appeal_create_request_appeal_categories_item.rb +13 -0
- data/lib/wavix/types/ten_dlc_brand_appeal_outcome.rb +1 -1
- data/lib/wavix/types/{not_found_error_body.rb → too_many_requests_error_response.rb} +1 -1
- data/lib/wavix/types/transcription_filter.rb +3 -3
- data/lib/wavix/types/unprocessable_entity_error_body.rb +2 -2
- data/lib/wavix/types/whats_app_message.rb +19 -0
- data/lib/wavix/types/whats_app_message_get_response.rb +9 -0
- data/lib/wavix/types/whats_app_message_list_item.rb +21 -0
- data/lib/wavix/types/{file_transcription_response_status.rb → whats_app_message_list_item_direction.rb} +3 -3
- data/lib/wavix/types/whats_app_message_list_item_status.rb +17 -0
- data/lib/wavix/types/whats_app_message_list_response.rb +11 -0
- data/lib/wavix/types/whats_app_message_send_request.rb +13 -0
- data/lib/wavix/types/whats_app_message_send_request_template.rb +17 -0
- data/lib/wavix/types/whats_app_message_send_request_template_buttons_item.rb +9 -0
- data/lib/wavix/types/whats_app_message_send_request_template_buttons_item_type.rb +18 -0
- data/lib/wavix/types/whats_app_message_send_request_template_header.rb +24 -0
- data/lib/wavix/types/whats_app_message_send_request_template_header_type.rb +16 -0
- data/lib/wavix/types/whats_app_message_send_response.rb +9 -0
- data/lib/wavix/types/whats_app_message_status.rb +17 -0
- data/lib/wavix/types/whats_app_message_template.rb +12 -0
- data/lib/wavix/types/whats_app_problem.rb +22 -0
- data/lib/wavix/types/whats_app_problem_error_class.rb +14 -0
- data/lib/wavix/types/whats_app_sender.rb +17 -0
- data/lib/wavix/types/whats_app_sender_message_tier.rb +16 -0
- data/lib/wavix/types/whats_app_sender_quality_rating.rb +14 -0
- data/lib/wavix/types/whats_app_sender_status.rb +21 -0
- data/lib/wavix/types/whats_app_template.rb +25 -0
- data/lib/wavix/types/whats_app_template_category.rb +13 -0
- data/lib/wavix/types/whats_app_template_component.rb +18 -0
- data/lib/wavix/types/whats_app_template_component_format.rb +15 -0
- data/lib/wavix/types/whats_app_template_component_type.rb +14 -0
- data/lib/wavix/types/whats_app_template_create_request.rb +15 -0
- data/lib/wavix/types/whats_app_template_create_request_category.rb +13 -0
- data/lib/wavix/types/whats_app_template_list_response.rb +9 -0
- data/lib/wavix/types/whats_app_template_quality_rating.rb +14 -0
- data/lib/wavix/types/whats_app_template_response.rb +9 -0
- data/lib/wavix/types/whats_app_template_status.rb +21 -0
- data/lib/wavix/version.rb +1 -1
- data/lib/wavix/voice_campaigns/client.rb +2 -2
- data/lib/wavix/webrtc/tokens/client.rb +11 -3
- data/lib/wavix/webrtc/tokens/types/list_tokens_request.rb +15 -0
- data/lib/wavix/webrtc/tokens/types/web_rtc_token_create_request.rb +1 -1
- data/lib/wavix.rb +60 -83
- data/reference.md +114 -90
- metadata +42 -64
- data/lib/wavix/billing/invoices/types/list_invoices_response.rb +0 -17
- data/lib/wavix/billing/transactions/types/list_transactions_response.rb +0 -17
- data/lib/wavix/buy/cities/types/list_cities_response.rb +0 -13
- data/lib/wavix/buy/countries/types/list_countries_response.rb +0 -13
- data/lib/wavix/buy/numbers/types/list_numbers_response.rb +0 -15
- data/lib/wavix/buy/region_cities/types/list_region_cities_response.rb +0 -13
- data/lib/wavix/buy/regions/types/list_regions_response.rb +0 -13
- data/lib/wavix/cart/types/checkout_cart_response.rb +0 -11
- data/lib/wavix/cart/types/get_cart_response.rb +0 -13
- data/lib/wavix/cart/types/remove_cart_response.rb +0 -11
- data/lib/wavix/cdrs/types/cdr_search_request_disposition.rb +0 -17
- data/lib/wavix/number_validator/types/get_number_validator_response.rb +0 -43
- data/lib/wavix/numbers/types/delete_numbers_response.rb +0 -11
- data/lib/wavix/profile/config/types/get_config_response.rb +0 -15
- data/lib/wavix/sms_and_mms/messages/types/get_messages_response.rb +0 -45
- data/lib/wavix/sms_and_mms/messages/types/list_messages_response.rb +0 -15
- data/lib/wavix/sms_and_mms/opt_outs/types/create_opt_outs_response.rb +0 -13
- data/lib/wavix/sms_and_mms/sender_ids/types/delete_sender_ids_response.rb +0 -13
- data/lib/wavix/speech_analytics/types/create_speech_analytics_response.rb +0 -15
- data/lib/wavix/speech_analytics/types/get_speech_analytics_response.rb +0 -31
- data/lib/wavix/speech_analytics/types/get_speech_analytics_response_language.rb +0 -17
- data/lib/wavix/speech_analytics/types/get_speech_analytics_response_status.rb +0 -14
- data/lib/wavix/ten_dlc/brand_appeals/types/create_brand_appeals_response.rb +0 -13
- data/lib/wavix/ten_dlc/brand_evidence/types/delete_brand_evidence_response.rb +0 -13
- data/lib/wavix/ten_dlc/brand_evidence/types/upload_brand_evidence_response.rb +0 -19
- data/lib/wavix/ten_dlc/brand_vetting_appeals/types/create_brand_vetting_appeals_response.rb +0 -13
- data/lib/wavix/ten_dlc/brands/types/create_brands_response.rb +0 -61
- data/lib/wavix/ten_dlc/brands/types/create_brands_response_entity_type.rb +0 -18
- data/lib/wavix/ten_dlc/brands/types/create_brands_response_status.rb +0 -19
- data/lib/wavix/ten_dlc/brands/types/delete_brands_response.rb +0 -13
- data/lib/wavix/ten_dlc/brands/types/get_brands_response.rb +0 -61
- data/lib/wavix/ten_dlc/brands/types/get_brands_response_entity_type.rb +0 -18
- data/lib/wavix/ten_dlc/brands/types/get_brands_response_status.rb +0 -19
- data/lib/wavix/ten_dlc/brands/types/list_brands_response.rb +0 -16
- data/lib/wavix/ten_dlc/brands/types/list_brands_response_pagination.rb +0 -20
- data/lib/wavix/ten_dlc/brands/types/qualify_usecase_brands_response.rb +0 -17
- data/lib/wavix/ten_dlc/brands/types/update_brands_response.rb +0 -61
- data/lib/wavix/ten_dlc/brands/types/update_brands_response_entity_type.rb +0 -18
- data/lib/wavix/ten_dlc/brands/types/update_brands_response_status.rb +0 -19
- data/lib/wavix/ten_dlc/campaign_numbers/types/link_campaign_numbers_response.rb +0 -13
- data/lib/wavix/ten_dlc/campaign_numbers/types/list_campaign_numbers_response.rb +0 -17
- data/lib/wavix/ten_dlc/campaign_numbers/types/unlink_campaign_numbers_response.rb +0 -13
- data/lib/wavix/ten_dlc/campaigns/types/create_campaigns_response.rb +0 -89
- data/lib/wavix/ten_dlc/campaigns/types/delete_campaigns_response.rb +0 -13
- data/lib/wavix/ten_dlc/campaigns/types/get_campaigns_response.rb +0 -89
- data/lib/wavix/ten_dlc/campaigns/types/list_by_brand_campaigns_response.rb +0 -16
- data/lib/wavix/ten_dlc/campaigns/types/list_by_brand_campaigns_response_pagination.rb +0 -20
- data/lib/wavix/ten_dlc/campaigns/types/list_campaigns_response.rb +0 -16
- data/lib/wavix/ten_dlc/campaigns/types/list_campaigns_response_pagination.rb +0 -20
- data/lib/wavix/ten_dlc/campaigns/types/update_campaigns_response.rb +0 -89
- data/lib/wavix/ten_dlc/subscriptions/types/create_subscriptions_response.rb +0 -16
- data/lib/wavix/ten_dlc/subscriptions/types/delete_subscriptions_response.rb +0 -13
- data/lib/wavix/two_fa/verification/types/check_verification_response.rb +0 -13
- data/lib/wavix/two_fa/verification/types/create_verification_response.rb +0 -25
- data/lib/wavix/two_fa/verification/types/resend_verification_response.rb +0 -19
- data/lib/wavix/types/bad_request_error_body.rb +0 -11
- data/lib/wavix/types/file_transcription_response_language.rb +0 -15
- data/lib/wavix/types/ten_dlc_brand_appeal_outcome_vetting_status.rb +0 -15
- 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,
|
|
@@ -802,7 +801,6 @@ client.sip_trunks.update(
|
|
|
802
801
|
ip_restrict: false,
|
|
803
802
|
didinfo_enabled: true,
|
|
804
803
|
call_restrict: true,
|
|
805
|
-
cost_limit: true,
|
|
806
804
|
channels_restrict: false,
|
|
807
805
|
rewrite_enabled: true,
|
|
808
806
|
transcription_enabled: true,
|
|
@@ -913,7 +911,7 @@ client.sip_trunks.delete(id: 3107)
|
|
|
913
911
|
</details>
|
|
914
912
|
|
|
915
913
|
## Cart
|
|
916
|
-
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">get</a>() -> Wavix::
|
|
914
|
+
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">get</a>() -> Wavix::Types::CartResponse</code></summary>
|
|
917
915
|
<dl>
|
|
918
916
|
<dd>
|
|
919
917
|
|
|
@@ -967,7 +965,7 @@ client.cart.get
|
|
|
967
965
|
</dl>
|
|
968
966
|
</details>
|
|
969
967
|
|
|
970
|
-
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">add</a>(request) -> Internal::Types::Array[
|
|
968
|
+
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">add</a>(request) -> Internal::Types::Array[Wavix::Types::AvailableNumber]</code></summary>
|
|
971
969
|
<dl>
|
|
972
970
|
<dd>
|
|
973
971
|
|
|
@@ -1029,7 +1027,7 @@ client.cart.add(ids: %w[541139862174 541139862175])
|
|
|
1029
1027
|
</dl>
|
|
1030
1028
|
</details>
|
|
1031
1029
|
|
|
1032
|
-
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">remove</a>(request) -> Wavix::
|
|
1030
|
+
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">remove</a>(request) -> Wavix::Types::SuccessResponse</code></summary>
|
|
1033
1031
|
<dl>
|
|
1034
1032
|
<dd>
|
|
1035
1033
|
|
|
@@ -1091,7 +1089,7 @@ client.cart.remove(ids: %w[541139862174 541139862175])
|
|
|
1091
1089
|
</dl>
|
|
1092
1090
|
</details>
|
|
1093
1091
|
|
|
1094
|
-
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">checkout</a>(request) -> Wavix::
|
|
1092
|
+
<details><summary><code>client.cart.<a href="/lib/wavix/cart/client.rb">checkout</a>(request) -> Wavix::Types::SuccessResponse</code></summary>
|
|
1095
1093
|
<dl>
|
|
1096
1094
|
<dd>
|
|
1097
1095
|
|
|
@@ -1103,7 +1101,7 @@ client.cart.remove(ids: %w[541139862174 541139862175])
|
|
|
1103
1101
|
<dl>
|
|
1104
1102
|
<dd>
|
|
1105
1103
|
|
|
1106
|
-
Purchases the listed phone numbers from the cart. Activation and monthly fees are
|
|
1104
|
+
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
1105
|
</dd>
|
|
1108
1106
|
</dl>
|
|
1109
1107
|
</dd>
|
|
@@ -1263,7 +1261,7 @@ client.numbers.list(
|
|
|
1263
1261
|
</dl>
|
|
1264
1262
|
</details>
|
|
1265
1263
|
|
|
1266
|
-
<details><summary><code>client.numbers.<a href="/lib/wavix/numbers/client.rb">delete</a>() -> Wavix::
|
|
1264
|
+
<details><summary><code>client.numbers.<a href="/lib/wavix/numbers/client.rb">delete</a>() -> Wavix::Types::SuccessResponse</code></summary>
|
|
1267
1265
|
<dl>
|
|
1268
1266
|
<dd>
|
|
1269
1267
|
|
|
@@ -1711,7 +1709,7 @@ client.cdrs.list(
|
|
|
1711
1709
|
<dl>
|
|
1712
1710
|
<dd>
|
|
1713
1711
|
|
|
1714
|
-
**disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `
|
|
1712
|
+
**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
1713
|
|
|
1716
1714
|
</dd>
|
|
1717
1715
|
</dl>
|
|
@@ -1809,9 +1807,7 @@ Searches call transcriptions for the given keywords or phrases and returns the m
|
|
|
1809
1807
|
client.cdrs.search(
|
|
1810
1808
|
type: "placed",
|
|
1811
1809
|
from: "2023-08-01",
|
|
1812
|
-
to: "2023-08-31"
|
|
1813
|
-
page: 1,
|
|
1814
|
-
per_page: 50
|
|
1810
|
+
to: "2023-08-31"
|
|
1815
1811
|
)
|
|
1816
1812
|
```
|
|
1817
1813
|
</dd>
|
|
@@ -1899,10 +1895,10 @@ client.cdrs.search(
|
|
|
1899
1895
|
<dl>
|
|
1900
1896
|
<dd>
|
|
1901
1897
|
|
|
1902
|
-
**disposition:** `Wavix::
|
|
1898
|
+
**disposition:** `Wavix::Types::CallDisposition`
|
|
1903
1899
|
|
|
1904
1900
|
Call disposition to filter results. If omitted, returns only answered
|
|
1905
|
-
calls. Allowed values: `answered`, `
|
|
1901
|
+
calls. Allowed values: `answered`, `noanswer`, `busy`,
|
|
1906
1902
|
`failed`, `all`. Use `all` to return calls
|
|
1907
1903
|
regardless of their disposition.
|
|
1908
1904
|
|
|
@@ -1952,7 +1948,7 @@ Call disposition to filter results. If omitted, returns only answered
|
|
|
1952
1948
|
<dl>
|
|
1953
1949
|
<dd>
|
|
1954
1950
|
|
|
1955
|
-
Transcribes the recording of the call identified by `call_id`. Transcription is asynchronous; poll the transcription endpoint for the result.
|
|
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.
|
|
1956
1952
|
</dd>
|
|
1957
1953
|
</dl>
|
|
1958
1954
|
</dd>
|
|
@@ -1967,7 +1963,7 @@ Transcribes the recording of the call identified by `call_id`. Transcription is
|
|
|
1967
1963
|
<dd>
|
|
1968
1964
|
|
|
1969
1965
|
```ruby
|
|
1970
|
-
client.cdrs.retranscribe(call_id: "bbaa37bf-430a-46da-ade3-
|
|
1966
|
+
client.cdrs.retranscribe(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
|
|
1971
1967
|
```
|
|
1972
1968
|
</dd>
|
|
1973
1969
|
</dl>
|
|
@@ -2045,7 +2041,7 @@ Returns the transcription of the recorded call identified by `call_id`. Alias of
|
|
|
2045
2041
|
<dd>
|
|
2046
2042
|
|
|
2047
2043
|
```ruby
|
|
2048
|
-
client.cdrs.transcriptions(call_id: "bbaa37bf-430a-46da-ade3-
|
|
2044
|
+
client.cdrs.transcriptions(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
|
|
2049
2045
|
```
|
|
2050
2046
|
</dd>
|
|
2051
2047
|
</dl>
|
|
@@ -2229,7 +2225,7 @@ client.cdrs.list_all(
|
|
|
2229
2225
|
<dl>
|
|
2230
2226
|
<dd>
|
|
2231
2227
|
|
|
2232
|
-
**disposition:** `Wavix::Types::CallDisposition` — Filters CDRs by call disposition. One of `answered` (the called party answered), `
|
|
2228
|
+
**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
2229
|
|
|
2234
2230
|
</dd>
|
|
2235
2231
|
</dl>
|
|
@@ -2560,7 +2556,7 @@ client.call_recording.get(id: 123)
|
|
|
2560
2556
|
<dl>
|
|
2561
2557
|
<dd>
|
|
2562
2558
|
|
|
2563
|
-
Deletes the call recording identified by `id`. Deletion is permanent
|
|
2559
|
+
Deletes the call recording identified by `id`. Deletion is permanent — the audio file is unrecoverable.
|
|
2564
2560
|
</dd>
|
|
2565
2561
|
</dl>
|
|
2566
2562
|
</dd>
|
|
@@ -2611,7 +2607,7 @@ client.call_recording.delete(id: 123)
|
|
|
2611
2607
|
</details>
|
|
2612
2608
|
|
|
2613
2609
|
## Speech Analytics
|
|
2614
|
-
<details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">create</a>(request) -> Wavix::
|
|
2610
|
+
<details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">create</a>(request) -> Wavix::Types::SubmitFileTranscriptionResponse</code></summary>
|
|
2615
2611
|
<dl>
|
|
2616
2612
|
<dd>
|
|
2617
2613
|
|
|
@@ -2678,7 +2674,7 @@ client.speech_analytics.create
|
|
|
2678
2674
|
</dl>
|
|
2679
2675
|
</details>
|
|
2680
2676
|
|
|
2681
|
-
<details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">get</a>(request_id) -> Wavix::
|
|
2677
|
+
<details><summary><code>client.speech_analytics.<a href="/lib/wavix/speech_analytics/client.rb">get</a>(request_id) -> Wavix::Types::FileTranscriptionResponse</code></summary>
|
|
2682
2678
|
<dl>
|
|
2683
2679
|
<dd>
|
|
2684
2680
|
|
|
@@ -2888,7 +2884,7 @@ client.call_webhooks.list
|
|
|
2888
2884
|
<dl>
|
|
2889
2885
|
<dd>
|
|
2890
2886
|
|
|
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.
|
|
2887
|
+
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.
|
|
2892
2888
|
</dd>
|
|
2893
2889
|
</dl>
|
|
2894
2890
|
</dd>
|
|
@@ -3085,7 +3081,7 @@ client.call_control.list
|
|
|
3085
3081
|
<dl>
|
|
3086
3082
|
<dd>
|
|
3087
3083
|
|
|
3088
|
-
Places
|
|
3084
|
+
Places a real, billable outbound PSTN call. Returns the call with its `uuid` for tracking and control.
|
|
3089
3085
|
</dd>
|
|
3090
3086
|
</dl>
|
|
3091
3087
|
</dd>
|
|
@@ -3261,7 +3257,7 @@ client.call_control.get(id: "id")
|
|
|
3261
3257
|
<dl>
|
|
3262
3258
|
<dd>
|
|
3263
3259
|
|
|
3264
|
-
Ends the active call identified by `id` by hanging up.
|
|
3260
|
+
Ends the active call identified by `id` by hanging up. Irreversible — the call cannot be resumed once ended.
|
|
3265
3261
|
</dd>
|
|
3266
3262
|
</dl>
|
|
3267
3263
|
</dd>
|
|
@@ -3396,7 +3392,7 @@ client.call_control.update(
|
|
|
3396
3392
|
<dl>
|
|
3397
3393
|
<dd>
|
|
3398
3394
|
|
|
3399
|
-
Answers the inbound call identified by `id`. Optionally starts media streaming on answer.
|
|
3395
|
+
Answers the inbound call identified by `id`. Optionally starts recording, post-call transcription, or live media streaming on answer.
|
|
3400
3396
|
</dd>
|
|
3401
3397
|
</dl>
|
|
3402
3398
|
</dd>
|
|
@@ -3592,7 +3588,7 @@ Prompt to play before collecting digits.
|
|
|
3592
3588
|
</details>
|
|
3593
3589
|
|
|
3594
3590
|
## NumberValidator
|
|
3595
|
-
<details><summary><code>client.number_validator.<a href="/lib/wavix/number_validator/client.rb">get</a>() -> Wavix::
|
|
3591
|
+
<details><summary><code>client.number_validator.<a href="/lib/wavix/number_validator/client.rb">get</a>() -> Wavix::Types::PhoneValidationResponse</code></summary>
|
|
3596
3592
|
<dl>
|
|
3597
3593
|
<dd>
|
|
3598
3594
|
|
|
@@ -3604,7 +3600,7 @@ Prompt to play before collecting digits.
|
|
|
3604
3600
|
<dl>
|
|
3605
3601
|
<dd>
|
|
3606
3602
|
|
|
3607
|
-
Validates a single phone number and returns line type, carrier, portability, and reachability details.
|
|
3603
|
+
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
3604
|
</dd>
|
|
3609
3605
|
</dl>
|
|
3610
3606
|
</dd>
|
|
@@ -3694,9 +3690,7 @@ Validates a batch of phone numbers. When `async` is `true`, returns a `request_i
|
|
|
3694
3690
|
```ruby
|
|
3695
3691
|
client.number_validator.create_bulk(
|
|
3696
3692
|
phone_numbers: %w[971501390098 971504359195],
|
|
3697
|
-
type: "format"
|
|
3698
|
-
async: true,
|
|
3699
|
-
force: true
|
|
3693
|
+
type: "format"
|
|
3700
3694
|
)
|
|
3701
3695
|
```
|
|
3702
3696
|
</dd>
|
|
@@ -3712,7 +3706,7 @@ client.number_validator.create_bulk(
|
|
|
3712
3706
|
<dl>
|
|
3713
3707
|
<dd>
|
|
3714
3708
|
|
|
3715
|
-
**phone_numbers:** `Internal::Types::Array[String]` — List of phone numbers to get detailed information about.
|
|
3709
|
+
**phone_numbers:** `Internal::Types::Array[String]` — List of phone numbers to get detailed information about. Maximum 1000 numbers per request.
|
|
3716
3710
|
|
|
3717
3711
|
</dd>
|
|
3718
3712
|
</dl>
|
|
@@ -3728,7 +3722,7 @@ client.number_validator.create_bulk(
|
|
|
3728
3722
|
<dl>
|
|
3729
3723
|
<dd>
|
|
3730
3724
|
|
|
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
|
|
3725
|
+
**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
3726
|
|
|
3733
3727
|
</dd>
|
|
3734
3728
|
</dl>
|
|
@@ -3736,7 +3730,7 @@ client.number_validator.create_bulk(
|
|
|
3736
3730
|
<dl>
|
|
3737
3731
|
<dd>
|
|
3738
3732
|
|
|
3739
|
-
**force:** `Internal::Types::Boolean` — Indicates whether to force a fresh validation instead of returning a previously cached result.
|
|
3733
|
+
**force:** `Internal::Types::Boolean` — Indicates whether to force a fresh validation instead of returning a previously cached result. Defaults to `false`.
|
|
3740
3734
|
|
|
3741
3735
|
</dd>
|
|
3742
3736
|
</dl>
|
|
@@ -3769,7 +3763,7 @@ client.number_validator.create_bulk(
|
|
|
3769
3763
|
<dl>
|
|
3770
3764
|
<dd>
|
|
3771
3765
|
|
|
3772
|
-
Launches a voice campaign that places
|
|
3766
|
+
Launches a voice campaign that places a real outbound call using a pre-configured scenario. Track progress with the returned voice campaign `id`.
|
|
3773
3767
|
</dd>
|
|
3774
3768
|
</dl>
|
|
3775
3769
|
</dd>
|
|
@@ -3928,7 +3922,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
|
|
|
3928
3922
|
<dl>
|
|
3929
3923
|
<dd>
|
|
3930
3924
|
|
|
3931
|
-
**link:** `String` — Target URL to shorten.
|
|
3925
|
+
**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
3926
|
|
|
3933
3927
|
</dd>
|
|
3934
3928
|
</dl>
|
|
@@ -3944,7 +3938,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
|
|
|
3944
3938
|
<dl>
|
|
3945
3939
|
<dd>
|
|
3946
3940
|
|
|
3947
|
-
**fallback_url:** `String` — Fallback URL for expired or invalid links.
|
|
3941
|
+
**fallback_url:** `String` — Fallback URL for expired or invalid links. Must be `https://` — same open-redirect/phishing considerations as `link` apply.
|
|
3948
3942
|
|
|
3949
3943
|
</dd>
|
|
3950
3944
|
</dl>
|
|
@@ -3952,7 +3946,7 @@ client.link_shortener.create(link: "https://your-site.com/long-url")
|
|
|
3952
3946
|
<dl>
|
|
3953
3947
|
<dd>
|
|
3954
3948
|
|
|
3955
|
-
**phone:** `String` — Phone number
|
|
3949
|
+
**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
3950
|
|
|
3957
3951
|
</dd>
|
|
3958
3952
|
</dl>
|
|
@@ -4228,6 +4222,22 @@ client.sub_accounts.list
|
|
|
4228
4222
|
<dl>
|
|
4229
4223
|
<dd>
|
|
4230
4224
|
|
|
4225
|
+
**page:** `Integer` — Page number to retrieve. Default `1`.
|
|
4226
|
+
|
|
4227
|
+
</dd>
|
|
4228
|
+
</dl>
|
|
4229
|
+
|
|
4230
|
+
<dl>
|
|
4231
|
+
<dd>
|
|
4232
|
+
|
|
4233
|
+
**per_page:** `Integer` — Number of records to return per page. Default `25`.
|
|
4234
|
+
|
|
4235
|
+
</dd>
|
|
4236
|
+
</dl>
|
|
4237
|
+
|
|
4238
|
+
<dl>
|
|
4239
|
+
<dd>
|
|
4240
|
+
|
|
4231
4241
|
**request_options:** `Wavix::SubAccounts::RequestOptions`
|
|
4232
4242
|
|
|
4233
4243
|
</dd>
|
|
@@ -4473,7 +4483,7 @@ client.sub_accounts.update(
|
|
|
4473
4483
|
</details>
|
|
4474
4484
|
|
|
4475
4485
|
## Billing Transactions
|
|
4476
|
-
<details><summary><code>client.billing.transactions.<a href="/lib/wavix/billing/transactions/client.rb">list</a>() -> Wavix::
|
|
4486
|
+
<details><summary><code>client.billing.transactions.<a href="/lib/wavix/billing/transactions/client.rb">list</a>() -> Wavix::Types::BillingTransactionListResponse</code></summary>
|
|
4477
4487
|
<dl>
|
|
4478
4488
|
<dd>
|
|
4479
4489
|
|
|
@@ -4591,7 +4601,7 @@ client.billing.transactions.list(
|
|
|
4591
4601
|
</details>
|
|
4592
4602
|
|
|
4593
4603
|
## Billing Invoices
|
|
4594
|
-
<details><summary><code>client.billing.invoices.<a href="/lib/wavix/billing/invoices/client.rb">list</a>() -> Wavix::
|
|
4604
|
+
<details><summary><code>client.billing.invoices.<a href="/lib/wavix/billing/invoices/client.rb">list</a>() -> Wavix::Types::InvoiceListResponse</code></summary>
|
|
4595
4605
|
<dl>
|
|
4596
4606
|
<dd>
|
|
4597
4607
|
|
|
@@ -4727,7 +4737,7 @@ client.billing.invoices.download(id: 1)
|
|
|
4727
4737
|
</details>
|
|
4728
4738
|
|
|
4729
4739
|
## Buy Countries
|
|
4730
|
-
<details><summary><code>client.buy.countries.<a href="/lib/wavix/buy/countries/client.rb">list</a>() -> Wavix::
|
|
4740
|
+
<details><summary><code>client.buy.countries.<a href="/lib/wavix/buy/countries/client.rb">list</a>() -> Wavix::Types::CountryListResponse</code></summary>
|
|
4731
4741
|
<dl>
|
|
4732
4742
|
<dd>
|
|
4733
4743
|
|
|
@@ -4790,7 +4800,7 @@ client.buy.countries.list
|
|
|
4790
4800
|
</details>
|
|
4791
4801
|
|
|
4792
4802
|
## Buy Regions
|
|
4793
|
-
<details><summary><code>client.buy.regions.<a href="/lib/wavix/buy/regions/client.rb">list</a>(country_id) -> Wavix::
|
|
4803
|
+
<details><summary><code>client.buy.regions.<a href="/lib/wavix/buy/regions/client.rb">list</a>(country_id) -> Wavix::Types::RegionListResponse</code></summary>
|
|
4794
4804
|
<dl>
|
|
4795
4805
|
<dd>
|
|
4796
4806
|
|
|
@@ -4861,7 +4871,7 @@ client.buy.regions.list(country_id: 1892)
|
|
|
4861
4871
|
</details>
|
|
4862
4872
|
|
|
4863
4873
|
## Buy Cities
|
|
4864
|
-
<details><summary><code>client.buy.cities.<a href="/lib/wavix/buy/cities/client.rb">list</a>(country_id) -> Wavix::
|
|
4874
|
+
<details><summary><code>client.buy.cities.<a href="/lib/wavix/buy/cities/client.rb">list</a>(country_id) -> Wavix::Types::CityListResponse</code></summary>
|
|
4865
4875
|
<dl>
|
|
4866
4876
|
<dd>
|
|
4867
4877
|
|
|
@@ -4933,7 +4943,7 @@ client.buy.cities.list(country_id: 1891)
|
|
|
4933
4943
|
</details>
|
|
4934
4944
|
|
|
4935
4945
|
## 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::
|
|
4946
|
+
<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
4947
|
<dl>
|
|
4938
4948
|
<dd>
|
|
4939
4949
|
|
|
@@ -5015,7 +5025,7 @@ client.buy.region_cities.list(
|
|
|
5015
5025
|
</details>
|
|
5016
5026
|
|
|
5017
5027
|
## Buy Numbers
|
|
5018
|
-
<details><summary><code>client.buy.numbers.<a href="/lib/wavix/buy/numbers/client.rb">list</a>(country_id, city_id) -> Wavix::
|
|
5028
|
+
<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
5029
|
<dl>
|
|
5020
5030
|
<dd>
|
|
5021
5031
|
|
|
@@ -5125,7 +5135,7 @@ client.buy.numbers.list(
|
|
|
5125
5135
|
<dl>
|
|
5126
5136
|
<dd>
|
|
5127
5137
|
|
|
5128
|
-
Starts streaming the
|
|
5138
|
+
Starts streaming the audio of the call identified by `call_id` to a WebSocket destination you supply, in the direction (`stream_type`) and channel (`stream_channel`) you configure. The destination can be any URL you specify — Wavix does not restrict it. Returns the `stream_id`.
|
|
5129
5139
|
</dd>
|
|
5130
5140
|
</dl>
|
|
5131
5141
|
</dd>
|
|
@@ -5290,7 +5300,7 @@ client.call_control.streams.delete(
|
|
|
5290
5300
|
<dl>
|
|
5291
5301
|
<dd>
|
|
5292
5302
|
|
|
5293
|
-
Plays an audio prompt into the active call identified by `id`.
|
|
5303
|
+
Plays an audio prompt into the active call identified by `id`. The audio is audible to the remote party in real time.
|
|
5294
5304
|
</dd>
|
|
5295
5305
|
</dl>
|
|
5296
5306
|
</dd>
|
|
@@ -5441,7 +5451,7 @@ Returns the transcription of the recorded call identified by `call_id`, includin
|
|
|
5441
5451
|
<dd>
|
|
5442
5452
|
|
|
5443
5453
|
```ruby
|
|
5444
|
-
client.cdrs.transcription.get(call_id: "bbaa37bf-430a-46da-ade3-
|
|
5454
|
+
client.cdrs.transcription.get(call_id: "bbaa37bf-430a-46da-ade3-c248e4070160")
|
|
5445
5455
|
```
|
|
5446
5456
|
</dd>
|
|
5447
5457
|
</dl>
|
|
@@ -5710,7 +5720,7 @@ client.numbers.papers.upload
|
|
|
5710
5720
|
</details>
|
|
5711
5721
|
|
|
5712
5722
|
## Profile Config
|
|
5713
|
-
<details><summary><code>client.profile.config.<a href="/lib/wavix/profile/config/client.rb">get</a>() -> Wavix::
|
|
5723
|
+
<details><summary><code>client.profile.config.<a href="/lib/wavix/profile/config/client.rb">get</a>() -> Wavix::Types::ProfileConfigResponse</code></summary>
|
|
5714
5724
|
<dl>
|
|
5715
5725
|
<dd>
|
|
5716
5726
|
|
|
@@ -5831,7 +5841,7 @@ client.sms_and_mms.sender_ids.list
|
|
|
5831
5841
|
<dl>
|
|
5832
5842
|
<dd>
|
|
5833
5843
|
|
|
5834
|
-
Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
|
|
5844
|
+
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
5845
|
</dd>
|
|
5836
5846
|
</dl>
|
|
5837
5847
|
</dd>
|
|
@@ -5988,7 +5998,7 @@ client.sms_and_mms.sender_ids.get(id: "id")
|
|
|
5988
5998
|
</dl>
|
|
5989
5999
|
</details>
|
|
5990
6000
|
|
|
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::
|
|
6001
|
+
<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
6002
|
<dl>
|
|
5993
6003
|
<dd>
|
|
5994
6004
|
|
|
@@ -6158,7 +6168,7 @@ client.sms_and_mms.opt_outs.list(
|
|
|
6158
6168
|
</dl>
|
|
6159
6169
|
</details>
|
|
6160
6170
|
|
|
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::
|
|
6171
|
+
<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
6172
|
<dl>
|
|
6163
6173
|
<dd>
|
|
6164
6174
|
|
|
@@ -6224,7 +6234,7 @@ client.sms_and_mms.opt_outs.create(opt_out: {
|
|
|
6224
6234
|
</details>
|
|
6225
6235
|
|
|
6226
6236
|
## SmsAndMms Messages
|
|
6227
|
-
<details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">list</a>() -> Wavix::
|
|
6237
|
+
<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
6238
|
<dl>
|
|
6229
6239
|
<dd>
|
|
6230
6240
|
|
|
@@ -6379,8 +6389,7 @@ client.sms_and_mms.messages.list(
|
|
|
6379
6389
|
<dl>
|
|
6380
6390
|
<dd>
|
|
6381
6391
|
|
|
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.
|
|
6392
|
+
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
6393
|
</dd>
|
|
6385
6394
|
</dl>
|
|
6386
6395
|
</dd>
|
|
@@ -6399,8 +6408,7 @@ client.sms_and_mms.messages.send_(
|
|
|
6399
6408
|
from: "Wavix",
|
|
6400
6409
|
to: "+447537151866",
|
|
6401
6410
|
message_body: {
|
|
6402
|
-
text: "Hi there, this is a message from Wavix"
|
|
6403
|
-
media: nil
|
|
6411
|
+
text: "Hi there, this is a message from Wavix"
|
|
6404
6412
|
},
|
|
6405
6413
|
callback_url: "https://you-site.com/webhook",
|
|
6406
6414
|
validity: 3600,
|
|
@@ -6480,7 +6488,7 @@ client.sms_and_mms.messages.send_(
|
|
|
6480
6488
|
</dl>
|
|
6481
6489
|
</details>
|
|
6482
6490
|
|
|
6483
|
-
<details><summary><code>client.sms_and_mms.messages.<a href="/lib/wavix/sms_and_mms/messages/client.rb">get</a>(id) -> Wavix::
|
|
6491
|
+
<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
6492
|
<dl>
|
|
6485
6493
|
<dd>
|
|
6486
6494
|
|
|
@@ -6840,7 +6848,7 @@ client.sub_accounts.transactions.list(
|
|
|
6840
6848
|
</details>
|
|
6841
6849
|
|
|
6842
6850
|
## TenDlc Brands
|
|
6843
|
-
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">list</a>() -> Wavix::
|
|
6851
|
+
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">list</a>() -> Wavix::Types::TenDlcBrandListResponse</code></summary>
|
|
6844
6852
|
<dl>
|
|
6845
6853
|
<dd>
|
|
6846
6854
|
|
|
@@ -7003,7 +7011,7 @@ client.ten_dlc.brands.list(
|
|
|
7003
7011
|
</dl>
|
|
7004
7012
|
</details>
|
|
7005
7013
|
|
|
7006
|
-
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">create</a>(request) -> Wavix::
|
|
7014
|
+
<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
7015
|
<dl>
|
|
7008
7016
|
<dd>
|
|
7009
7017
|
|
|
@@ -7015,7 +7023,7 @@ client.ten_dlc.brands.list(
|
|
|
7015
7023
|
<dl>
|
|
7016
7024
|
<dd>
|
|
7017
7025
|
|
|
7018
|
-
Registers a 10DLC Brand. TCR
|
|
7026
|
+
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
7027
|
</dd>
|
|
7020
7028
|
</dl>
|
|
7021
7029
|
</dd>
|
|
@@ -7065,7 +7073,7 @@ client.ten_dlc.brands.create(request: {})
|
|
|
7065
7073
|
</dl>
|
|
7066
7074
|
</details>
|
|
7067
7075
|
|
|
7068
|
-
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">get</a>(brand_id) -> Wavix::
|
|
7076
|
+
<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
7077
|
<dl>
|
|
7070
7078
|
<dd>
|
|
7071
7079
|
|
|
@@ -7127,7 +7135,7 @@ client.ten_dlc.brands.get(brand_id: "BM20QP9")
|
|
|
7127
7135
|
</dl>
|
|
7128
7136
|
</details>
|
|
7129
7137
|
|
|
7130
|
-
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">update</a>(brand_id, request) -> Wavix::
|
|
7138
|
+
<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
7139
|
<dl>
|
|
7132
7140
|
<dd>
|
|
7133
7141
|
|
|
@@ -7353,7 +7361,7 @@ Business segment the Brand operates in. One of:
|
|
|
7353
7361
|
</dl>
|
|
7354
7362
|
</details>
|
|
7355
7363
|
|
|
7356
|
-
<details><summary><code>client.ten_dlc.brands.<a href="/lib/wavix/ten_dlc/brands/client.rb">delete</a>(brand_id) -> Wavix::
|
|
7364
|
+
<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
7365
|
<dl>
|
|
7358
7366
|
<dd>
|
|
7359
7367
|
|
|
@@ -7415,7 +7423,7 @@ client.ten_dlc.brands.delete(brand_id: "BM20QP9")
|
|
|
7415
7423
|
</dl>
|
|
7416
7424
|
</details>
|
|
7417
7425
|
|
|
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::
|
|
7426
|
+
<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
7427
|
<dl>
|
|
7420
7428
|
<dd>
|
|
7421
7429
|
|
|
@@ -7551,7 +7559,7 @@ client.ten_dlc.brand_appeals.list(brand_id: "BM20QP9")
|
|
|
7551
7559
|
</dl>
|
|
7552
7560
|
</details>
|
|
7553
7561
|
|
|
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::
|
|
7562
|
+
<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
7563
|
<dl>
|
|
7556
7564
|
<dd>
|
|
7557
7565
|
|
|
@@ -7566,7 +7574,7 @@ client.ten_dlc.brand_appeals.list(brand_id: "BM20QP9")
|
|
|
7566
7574
|
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
7575
|
- `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
7576
|
- `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.
|
|
7577
|
+
- `VERIFY_GOVERNMENT` — Use if a government brand is UNVERIFIED or VERIFIED but missing government entity status.
|
|
7570
7578
|
</dd>
|
|
7571
7579
|
</dl>
|
|
7572
7580
|
</dd>
|
|
@@ -7608,7 +7616,7 @@ client.ten_dlc.brand_appeals.create(
|
|
|
7608
7616
|
<dl>
|
|
7609
7617
|
<dd>
|
|
7610
7618
|
|
|
7611
|
-
**appeal_categories:** `Internal::Types::Array[
|
|
7619
|
+
**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
7620
|
|
|
7613
7621
|
</dd>
|
|
7614
7622
|
</dl>
|
|
@@ -7707,7 +7715,7 @@ client.ten_dlc.brand_evidence.list(brand_id: "B6AI7PA")
|
|
|
7707
7715
|
</dl>
|
|
7708
7716
|
</details>
|
|
7709
7717
|
|
|
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::
|
|
7718
|
+
<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
7719
|
<dl>
|
|
7712
7720
|
<dd>
|
|
7713
7721
|
|
|
@@ -7842,7 +7850,7 @@ client.ten_dlc.brand_evidence.get(
|
|
|
7842
7850
|
</dl>
|
|
7843
7851
|
</details>
|
|
7844
7852
|
|
|
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::
|
|
7853
|
+
<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
7854
|
<dl>
|
|
7847
7855
|
<dd>
|
|
7848
7856
|
|
|
@@ -7990,7 +7998,7 @@ client.ten_dlc.brand_vettings.list(brand_id: "B6AI7PA")
|
|
|
7990
7998
|
<dl>
|
|
7991
7999
|
<dd>
|
|
7992
8000
|
|
|
7993
|
-
Requests external vetting for a 10DLC Brand. Supported providers: `AEGIS`, `CV`, `WMC`. Supported classes: `STANDARD`, `ENHANCED`.
|
|
8001
|
+
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
8002
|
</dd>
|
|
7995
8003
|
</dl>
|
|
7996
8004
|
</dd>
|
|
@@ -8214,7 +8222,7 @@ client.ten_dlc.brand_vetting_appeals.list(brand_id: "BMQFB7X")
|
|
|
8214
8222
|
</dl>
|
|
8215
8223
|
</details>
|
|
8216
8224
|
|
|
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::
|
|
8225
|
+
<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
8226
|
<dl>
|
|
8219
8227
|
<dd>
|
|
8220
8228
|
|
|
@@ -8268,7 +8276,7 @@ client.ten_dlc.brand_vetting_appeals.create(
|
|
|
8268
8276
|
<dl>
|
|
8269
8277
|
<dd>
|
|
8270
8278
|
|
|
8271
|
-
**appeal_categories:** `Internal::Types::Array[
|
|
8279
|
+
**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
8280
|
|
|
8273
8281
|
</dd>
|
|
8274
8282
|
</dl>
|
|
@@ -8321,7 +8329,7 @@ client.ten_dlc.brand_vetting_appeals.create(
|
|
|
8321
8329
|
</details>
|
|
8322
8330
|
|
|
8323
8331
|
## TenDlc Campaigns
|
|
8324
|
-
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list</a>() -> Wavix::
|
|
8332
|
+
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list</a>() -> Wavix::Types::TenDlcCampaignListResponse</code></summary>
|
|
8325
8333
|
<dl>
|
|
8326
8334
|
<dd>
|
|
8327
8335
|
|
|
@@ -8448,7 +8456,7 @@ client.ten_dlc.campaigns.list(
|
|
|
8448
8456
|
</dl>
|
|
8449
8457
|
</details>
|
|
8450
8458
|
|
|
8451
|
-
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">list_by_brand</a>(brand_id) -> Wavix::
|
|
8459
|
+
<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
8460
|
<dl>
|
|
8453
8461
|
<dd>
|
|
8454
8462
|
|
|
@@ -8584,7 +8592,7 @@ client.ten_dlc.campaigns.list_by_brand(
|
|
|
8584
8592
|
</dl>
|
|
8585
8593
|
</details>
|
|
8586
8594
|
|
|
8587
|
-
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">create</a>(brand_id, request) -> Wavix::
|
|
8595
|
+
<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
8596
|
<dl>
|
|
8589
8597
|
<dd>
|
|
8590
8598
|
|
|
@@ -8900,7 +8908,7 @@ client.ten_dlc.campaigns.create(
|
|
|
8900
8908
|
</dl>
|
|
8901
8909
|
</details>
|
|
8902
8910
|
|
|
8903
|
-
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">get</a>(brand_id, campaign_id) -> Wavix::
|
|
8911
|
+
<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
8912
|
<dl>
|
|
8905
8913
|
<dd>
|
|
8906
8914
|
|
|
@@ -8973,7 +8981,7 @@ client.ten_dlc.campaigns.get(
|
|
|
8973
8981
|
</dl>
|
|
8974
8982
|
</details>
|
|
8975
8983
|
|
|
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::
|
|
8984
|
+
<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
8985
|
<dl>
|
|
8978
8986
|
<dd>
|
|
8979
8987
|
|
|
@@ -9254,7 +9262,7 @@ client.ten_dlc.campaigns.update(
|
|
|
9254
9262
|
</dl>
|
|
9255
9263
|
</details>
|
|
9256
9264
|
|
|
9257
|
-
<details><summary><code>client.ten_dlc.campaigns.<a href="/lib/wavix/ten_dlc/campaigns/client.rb">delete</a>(brand_id, campaign_id) -> Wavix::
|
|
9265
|
+
<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
9266
|
<dl>
|
|
9259
9267
|
<dd>
|
|
9260
9268
|
|
|
@@ -9480,7 +9488,7 @@ client.ten_dlc.subscriptions.list
|
|
|
9480
9488
|
</dl>
|
|
9481
9489
|
</details>
|
|
9482
9490
|
|
|
9483
|
-
<details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">create</a>(request) -> Wavix::
|
|
9491
|
+
<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
9492
|
<dl>
|
|
9485
9493
|
<dd>
|
|
9486
9494
|
|
|
@@ -9545,7 +9553,7 @@ client.ten_dlc.subscriptions.create(
|
|
|
9545
9553
|
</dl>
|
|
9546
9554
|
</details>
|
|
9547
9555
|
|
|
9548
|
-
<details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">delete</a>() -> Wavix::
|
|
9556
|
+
<details><summary><code>client.ten_dlc.subscriptions.<a href="/lib/wavix/ten_dlc/subscriptions/client.rb">delete</a>() -> Wavix::Types::SuccessResponse</code></summary>
|
|
9549
9557
|
<dl>
|
|
9550
9558
|
<dd>
|
|
9551
9559
|
|
|
@@ -9608,7 +9616,7 @@ client.ten_dlc.subscriptions.delete(subscription_category: "number")
|
|
|
9608
9616
|
</details>
|
|
9609
9617
|
|
|
9610
9618
|
## 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::
|
|
9619
|
+
<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
9620
|
<dl>
|
|
9613
9621
|
<dd>
|
|
9614
9622
|
|
|
@@ -9690,7 +9698,7 @@ client.ten_dlc.campaign_numbers.link(
|
|
|
9690
9698
|
</dl>
|
|
9691
9699
|
</details>
|
|
9692
9700
|
|
|
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::
|
|
9701
|
+
<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
9702
|
<dl>
|
|
9695
9703
|
<dd>
|
|
9696
9704
|
|
|
@@ -9772,7 +9780,7 @@ client.ten_dlc.campaign_numbers.unlink(
|
|
|
9772
9780
|
</dl>
|
|
9773
9781
|
</details>
|
|
9774
9782
|
|
|
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::
|
|
9783
|
+
<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
9784
|
<dl>
|
|
9777
9785
|
<dd>
|
|
9778
9786
|
|
|
@@ -9846,7 +9854,7 @@ client.ten_dlc.campaign_numbers.list(
|
|
|
9846
9854
|
</details>
|
|
9847
9855
|
|
|
9848
9856
|
## TwoFa Verification
|
|
9849
|
-
<details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">create</a>(request) -> Wavix::
|
|
9857
|
+
<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
9858
|
<dl>
|
|
9851
9859
|
<dd>
|
|
9852
9860
|
|
|
@@ -9858,7 +9866,7 @@ client.ten_dlc.campaign_numbers.list(
|
|
|
9858
9866
|
<dl>
|
|
9859
9867
|
<dd>
|
|
9860
9868
|
|
|
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.
|
|
9869
|
+
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
9870
|
|
|
9863
9871
|
The verification proceeds through three steps:
|
|
9864
9872
|
1. Create a verification to generate and send an OTP.
|
|
@@ -9933,7 +9941,7 @@ client.two_fa.verification.create(
|
|
|
9933
9941
|
</dl>
|
|
9934
9942
|
</details>
|
|
9935
9943
|
|
|
9936
|
-
<details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">resend</a>(session_id, request) -> Wavix::
|
|
9944
|
+
<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
9945
|
<dl>
|
|
9938
9946
|
<dd>
|
|
9939
9947
|
|
|
@@ -10006,7 +10014,7 @@ client.two_fa.verification.resend(
|
|
|
10006
10014
|
</dl>
|
|
10007
10015
|
</details>
|
|
10008
10016
|
|
|
10009
|
-
<details><summary><code>client.two_fa.verification.<a href="/lib/wavix/two_fa/verification/client.rb">check</a>(session_id, request) -> Wavix::
|
|
10017
|
+
<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
10018
|
<dl>
|
|
10011
10019
|
<dd>
|
|
10012
10020
|
|
|
@@ -10018,7 +10026,7 @@ client.two_fa.verification.resend(
|
|
|
10018
10026
|
<dl>
|
|
10019
10027
|
<dd>
|
|
10020
10028
|
|
|
10021
|
-
Validates the OTP submitted by the end user against the verification identified by `session_id`.
|
|
10029
|
+
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
10030
|
</dd>
|
|
10023
10031
|
</dl>
|
|
10024
10032
|
</dd>
|
|
@@ -10300,7 +10308,7 @@ client.two_fa.events.list(session_id: "8753d4308f2e11ecb75fcdafd6d2d690")
|
|
|
10300
10308
|
<dl>
|
|
10301
10309
|
<dd>
|
|
10302
10310
|
|
|
10303
|
-
Returns a paginated list of
|
|
10311
|
+
Returns a paginated list of Wavix Embeddable widget tokens for the authenticated account.
|
|
10304
10312
|
</dd>
|
|
10305
10313
|
</dl>
|
|
10306
10314
|
</dd>
|
|
@@ -10330,6 +10338,22 @@ client.webrtc.tokens.list
|
|
|
10330
10338
|
<dl>
|
|
10331
10339
|
<dd>
|
|
10332
10340
|
|
|
10341
|
+
**page:** `Integer` — Page number to retrieve. Default `1`.
|
|
10342
|
+
|
|
10343
|
+
</dd>
|
|
10344
|
+
</dl>
|
|
10345
|
+
|
|
10346
|
+
<dl>
|
|
10347
|
+
<dd>
|
|
10348
|
+
|
|
10349
|
+
**per_page:** `Integer` — Number of records to return per page. Default `25`.
|
|
10350
|
+
|
|
10351
|
+
</dd>
|
|
10352
|
+
</dl>
|
|
10353
|
+
|
|
10354
|
+
<dl>
|
|
10355
|
+
<dd>
|
|
10356
|
+
|
|
10333
10357
|
**request_options:** `Wavix::Webrtc::Tokens::RequestOptions`
|
|
10334
10358
|
|
|
10335
10359
|
</dd>
|
|
@@ -10404,7 +10428,7 @@ client.webrtc.tokens.create(
|
|
|
10404
10428
|
<dl>
|
|
10405
10429
|
<dd>
|
|
10406
10430
|
|
|
10407
|
-
**ttl:** `Integer` — Time to live in seconds. Pass `null` for no expiration.
|
|
10431
|
+
**ttl:** `Integer` — Time to live in seconds. Default `3600`. Pass `null` for no expiration.
|
|
10408
10432
|
|
|
10409
10433
|
</dd>
|
|
10410
10434
|
</dl>
|