bandwidth-sdk 16.1.0 → 16.2.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/Gemfile.lock +5 -5
- data/README.md +6 -3
- data/bandwidth.yml +266 -11
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +501 -1
- data/coverage/index.html +6296 -970
- data/docs/BusinessEntityTypeEnum.md +15 -0
- data/docs/BusinessRegistrationTypeEnum.md +15 -0
- data/docs/CallTranscriptionMetadata.md +1 -1
- data/docs/ConferenceMember.md +1 -1
- data/docs/ListMessageItem.md +13 -1
- data/docs/MessagesApi.md +24 -0
- data/docs/MultiChannelMessageResponseData.md +2 -2
- data/docs/OptInWorkflow.md +3 -1
- data/docs/ProductTypeEnum.md +15 -0
- data/docs/RbmActionBase.md +1 -1
- data/docs/RbmSuggestionResponse.md +1 -1
- data/docs/TfvSubmissionInfo.md +7 -1
- data/docs/TranscriptionsApi.md +13 -13
- data/docs/VerificationRequest.md +11 -1
- data/docs/VerificationUpdateRequest.md +11 -1
- data/lib/bandwidth-sdk/api/messages_api.rb +36 -0
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +8 -8
- data/lib/bandwidth-sdk/models/business_entity_type_enum.rb +43 -0
- data/lib/bandwidth-sdk/models/business_registration_type_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +2 -1
- data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/conference_member.rb +1 -1
- data/lib/bandwidth-sdk/models/list_message_item.rb +71 -5
- data/lib/bandwidth-sdk/models/message_type_enum.rb +2 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +11 -11
- data/lib/bandwidth-sdk/models/opt_in_workflow.rb +38 -4
- data/lib/bandwidth-sdk/models/product_type_enum.rb +47 -0
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +72 -4
- data/lib/bandwidth-sdk/models/verification_request.rb +108 -4
- data/lib/bandwidth-sdk/models/verification_update_request.rb +108 -4
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +3 -0
- data/spec/smoke/messages_api_spec.rb +2 -1
- data/spec/spec_helper.rb +3 -2
- data/spec/unit/api/messages_api_spec.rb +6 -0
- data/spec/unit/models/bxml/verbs/stop_stream_spec.rb +6 -4
- metadata +44 -38
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7ae27f5c926913194eb8164d4e59e33e9d2cb81fafbf7ae89eb19b5442be00ab
|
4
|
+
data.tar.gz: 91654980df034ffb61ffa9e6713415d1ba794534f5cb7f7738639ffe7f407cfc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f34d9942768819b5112d83b48f4785850fcd6d2abd72cb0d6c5e0e2dc9609663c464dc553f631d0207eb4fc7e6fa783a24c4214ea9c89252c5c43c74b5d94b8a
|
7
|
+
data.tar.gz: a5572c054fec8d25eb112cf9651d9a515283e6d33199f9c1a6c4b73c7b7da190024b0ab844beb167baf684ce32874ddb04a7e985f4de20f7ba29aca16fef71cc
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
bandwidth-sdk (16.1
|
4
|
+
bandwidth-sdk (16.2.1)
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
6
6
|
faraday-multipart
|
7
7
|
marcel
|
@@ -11,7 +11,7 @@ GEM
|
|
11
11
|
remote: https://rubygems.org/
|
12
12
|
specs:
|
13
13
|
ast (2.4.3)
|
14
|
-
bigdecimal (3.2.
|
14
|
+
bigdecimal (3.2.3)
|
15
15
|
byebug (12.0.0)
|
16
16
|
coderay (1.1.3)
|
17
17
|
diff-lcs (1.6.2)
|
@@ -47,8 +47,8 @@ GEM
|
|
47
47
|
racc (1.8.1)
|
48
48
|
rainbow (3.1.1)
|
49
49
|
rake (13.2.1)
|
50
|
-
regexp_parser (2.11.
|
51
|
-
rexml (3.4.
|
50
|
+
regexp_parser (2.11.2)
|
51
|
+
rexml (3.4.3)
|
52
52
|
rspec (3.13.1)
|
53
53
|
rspec-core (~> 3.13.0)
|
54
54
|
rspec-expectations (~> 3.13.0)
|
@@ -61,7 +61,7 @@ GEM
|
|
61
61
|
rspec-mocks (3.13.5)
|
62
62
|
diff-lcs (>= 1.2.0, < 2.0)
|
63
63
|
rspec-support (~> 3.13.0)
|
64
|
-
rspec-support (3.13.
|
64
|
+
rspec-support (3.13.5)
|
65
65
|
rubocop (1.52.1)
|
66
66
|
json (~> 2.3)
|
67
67
|
parallel (~> 1.10)
|
data/README.md
CHANGED
@@ -153,9 +153,9 @@ Class | Method | HTTP request | Description
|
|
153
153
|
*Bandwidth::TollFreeVerificationApi* | [**request_toll_free_verification**](docs/TollFreeVerificationApi.md#request_toll_free_verification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
|
154
154
|
*Bandwidth::TollFreeVerificationApi* | [**update_toll_free_verification_request**](docs/TollFreeVerificationApi.md#update_toll_free_verification_request) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
|
155
155
|
*Bandwidth::TollFreeVerificationApi* | [**update_webhook_subscription**](docs/TollFreeVerificationApi.md#update_webhook_subscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
|
156
|
-
*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete
|
157
|
-
*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} |
|
158
|
-
*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions |
|
156
|
+
*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
|
157
|
+
*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
|
158
|
+
*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions
|
159
159
|
|
160
160
|
|
161
161
|
## Documentation for Models
|
@@ -167,6 +167,8 @@ Class | Method | HTTP request | Description
|
|
167
167
|
- [Bandwidth::BlockedWebhook](docs/BlockedWebhook.md)
|
168
168
|
- [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
|
169
169
|
- [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
|
170
|
+
- [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
|
171
|
+
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
|
170
172
|
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
|
171
173
|
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
|
172
174
|
- [Bandwidth::CallState](docs/CallState.md)
|
@@ -249,6 +251,7 @@ Class | Method | HTTP request | Description
|
|
249
251
|
- [Bandwidth::OptInWorkflow](docs/OptInWorkflow.md)
|
250
252
|
- [Bandwidth::PageInfo](docs/PageInfo.md)
|
251
253
|
- [Bandwidth::PriorityEnum](docs/PriorityEnum.md)
|
254
|
+
- [Bandwidth::ProductTypeEnum](docs/ProductTypeEnum.md)
|
252
255
|
- [Bandwidth::RbmActionBase](docs/RbmActionBase.md)
|
253
256
|
- [Bandwidth::RbmActionDial](docs/RbmActionDial.md)
|
254
257
|
- [Bandwidth::RbmActionOpenUrl](docs/RbmActionOpenUrl.md)
|
data/bandwidth.yml
CHANGED
@@ -179,6 +179,18 @@ paths:
|
|
179
179
|
- $ref: '#/components/parameters/fromDateTime'
|
180
180
|
- $ref: '#/components/parameters/toDateTime'
|
181
181
|
- $ref: '#/components/parameters/campaignId'
|
182
|
+
- $ref: '#/components/parameters/fromBwLatency'
|
183
|
+
- $ref: '#/components/parameters/bwQueued'
|
184
|
+
- $ref: '#/components/parameters/product'
|
185
|
+
- $ref: '#/components/parameters/location'
|
186
|
+
- $ref: '#/components/parameters/carrierQueued'
|
187
|
+
- $ref: '#/components/parameters/fromCarrierLatency'
|
188
|
+
- $ref: '#/components/parameters/callingNumberCountryA3'
|
189
|
+
- $ref: '#/components/parameters/calledNumberCountryA3'
|
190
|
+
- $ref: '#/components/parameters/fromSegmentCount'
|
191
|
+
- $ref: '#/components/parameters/toSegmentCount'
|
192
|
+
- $ref: '#/components/parameters/fromMessageSize'
|
193
|
+
- $ref: '#/components/parameters/toMessageSize'
|
182
194
|
- $ref: '#/components/parameters/sort'
|
183
195
|
- $ref: '#/components/parameters/pageToken'
|
184
196
|
- $ref: '#/components/parameters/limit'
|
@@ -1145,9 +1157,9 @@ paths:
|
|
1145
1157
|
get:
|
1146
1158
|
tags:
|
1147
1159
|
- Transcriptions
|
1148
|
-
summary:
|
1160
|
+
summary: List Real-time Transcriptions
|
1149
1161
|
description: >-
|
1150
|
-
|
1162
|
+
List the transcriptions created on this call via
|
1151
1163
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
1152
1164
|
operationId: listRealTimeTranscriptions
|
1153
1165
|
parameters:
|
@@ -1177,7 +1189,7 @@ paths:
|
|
1177
1189
|
get:
|
1178
1190
|
tags:
|
1179
1191
|
- Transcriptions
|
1180
|
-
summary:
|
1192
|
+
summary: Get Real-time Transcription
|
1181
1193
|
description: >-
|
1182
1194
|
Retrieve the specified transcription that was created on this call via
|
1183
1195
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
@@ -1208,7 +1220,7 @@ paths:
|
|
1208
1220
|
delete:
|
1209
1221
|
tags:
|
1210
1222
|
- Transcriptions
|
1211
|
-
summary: Delete
|
1223
|
+
summary: Delete Real-time Transcription
|
1212
1224
|
description: >-
|
1213
1225
|
Delete the specified transcription that was created on this call via
|
1214
1226
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
@@ -1716,7 +1728,22 @@ components:
|
|
1716
1728
|
enum:
|
1717
1729
|
- sms
|
1718
1730
|
- mms
|
1731
|
+
- rcs
|
1719
1732
|
example: sms
|
1733
|
+
productTypeEnum:
|
1734
|
+
type: string
|
1735
|
+
description: The type of product associated with the message.
|
1736
|
+
enum:
|
1737
|
+
- LOCAL_A2P
|
1738
|
+
- P2P
|
1739
|
+
- SHORT_CODE_REACH
|
1740
|
+
- TOLL_FREE
|
1741
|
+
- HOSTED_SHORT_CODE
|
1742
|
+
- ALPHA_NUMERIC
|
1743
|
+
- RBM_MEDIA
|
1744
|
+
- RBM_RICH
|
1745
|
+
- RBM_CONVERSATIONAL
|
1746
|
+
example: P2P
|
1720
1747
|
fieldError:
|
1721
1748
|
type: object
|
1722
1749
|
properties:
|
@@ -1819,6 +1846,41 @@ components:
|
|
1819
1846
|
description: The campaign ID of the message if it has one.
|
1820
1847
|
nullable: true
|
1821
1848
|
example: CJEUMDK
|
1849
|
+
bwLatency:
|
1850
|
+
type: integer
|
1851
|
+
description: >-
|
1852
|
+
The Bandwidth latency of the message in seconds. Only available for
|
1853
|
+
accounts with the Advanced Quality Metrics feature enabled.
|
1854
|
+
nullable: true
|
1855
|
+
example: 20
|
1856
|
+
carrierLatency:
|
1857
|
+
type: integer
|
1858
|
+
description: >-
|
1859
|
+
The carrier latency of the message in seconds. Only available for
|
1860
|
+
OUTBOUND messages from accounts with the Advanced Quality Metrics
|
1861
|
+
feature enabled.
|
1862
|
+
nullable: true
|
1863
|
+
example: 20
|
1864
|
+
callingNumberCountryA3:
|
1865
|
+
type: string
|
1866
|
+
description: The A3 country code of the calling number.
|
1867
|
+
nullable: true
|
1868
|
+
example: USA
|
1869
|
+
calledNumberCountryA3:
|
1870
|
+
type: string
|
1871
|
+
description: The A3 country code of the called number.
|
1872
|
+
nullable: true
|
1873
|
+
example: USA
|
1874
|
+
product:
|
1875
|
+
type: string
|
1876
|
+
description: The messaging product associated with the message.
|
1877
|
+
nullable: true
|
1878
|
+
example: P2P
|
1879
|
+
location:
|
1880
|
+
type: string
|
1881
|
+
description: The location ID associated with this message.
|
1882
|
+
nullable: true
|
1883
|
+
example: 123ID
|
1822
1884
|
pageInfo:
|
1823
1885
|
title: PageInfo
|
1824
1886
|
type: object
|
@@ -1867,7 +1929,7 @@ components:
|
|
1867
1929
|
required:
|
1868
1930
|
- type
|
1869
1931
|
- description
|
1870
|
-
|
1932
|
+
id:
|
1871
1933
|
type: string
|
1872
1934
|
description: The ID of the message.
|
1873
1935
|
example: 1589228074636lm4k2je7j7jklbn2
|
@@ -2487,8 +2549,8 @@ components:
|
|
2487
2549
|
description: The data returned in a multichannel message response.
|
2488
2550
|
type: object
|
2489
2551
|
properties:
|
2490
|
-
|
2491
|
-
$ref: '#/components/schemas/
|
2552
|
+
id:
|
2553
|
+
$ref: '#/components/schemas/id'
|
2492
2554
|
time:
|
2493
2555
|
description: The time the message was received by the Bandwidth API.
|
2494
2556
|
type: string
|
@@ -2524,7 +2586,7 @@ components:
|
|
2524
2586
|
expiration:
|
2525
2587
|
$ref: '#/components/schemas/expiration'
|
2526
2588
|
required:
|
2527
|
-
-
|
2589
|
+
- id
|
2528
2590
|
- time
|
2529
2591
|
- direction
|
2530
2592
|
- to
|
@@ -3676,11 +3738,12 @@ components:
|
|
3676
3738
|
the state of this conference member. This is the URL of this
|
3677
3739
|
member's
|
3678
3740
|
|
3679
|
-
[Get Conference
|
3741
|
+
[Get Conference
|
3742
|
+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
|
3680
3743
|
endpoint
|
3681
3744
|
|
3682
3745
|
and [Modify Conference
|
3683
|
-
Member](/apis/voice/#operation/updateConferenceMember)
|
3746
|
+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
|
3684
3747
|
|
3685
3748
|
endpoint.
|
3686
3749
|
example: >-
|
@@ -4032,7 +4095,7 @@ components:
|
|
4032
4095
|
points to the
|
4033
4096
|
|
4034
4097
|
[Get Call
|
4035
|
-
Transcription](/apis/voice/#operation/
|
4098
|
+
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
|
4036
4099
|
endpoint.
|
4037
4100
|
example: >-
|
4038
4101
|
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
@@ -5478,6 +5541,50 @@ components:
|
|
5478
5541
|
description: The company 'Doing Business As'.
|
5479
5542
|
example: Another Company Name Inc.
|
5480
5543
|
type: string
|
5544
|
+
businessRegistrationNumber:
|
5545
|
+
type: string
|
5546
|
+
description: >-
|
5547
|
+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
|
5548
|
+
until early 2026. If a value is provided for this field, a value must be
|
5549
|
+
provided for `businessRegistrationType` and `businessEntityType`.
|
5550
|
+
Available starting October 1st, 2025.
|
5551
|
+
nullable: true
|
5552
|
+
maxLength: 500
|
5553
|
+
example: 12-3456789
|
5554
|
+
businessRegistrationTypeEnum:
|
5555
|
+
type: string
|
5556
|
+
description: >-
|
5557
|
+
The type of business registration number. Optional until early 2026;
|
5558
|
+
required if `businessRegistrationNumber` is provided. Available starting
|
5559
|
+
October 1st, 2025.
|
5560
|
+
enum:
|
5561
|
+
- EIN
|
5562
|
+
- CBN
|
5563
|
+
nullable: true
|
5564
|
+
businessEntityTypeEnum:
|
5565
|
+
type: string
|
5566
|
+
description: >-
|
5567
|
+
The type of registered business. If no option is applicable, please
|
5568
|
+
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
|
5569
|
+
required if `businessRegistrationNumber` is provided. Available starting
|
5570
|
+
October 1st, 2025.
|
5571
|
+
enum:
|
5572
|
+
- SOLE_PROPRIETOR
|
5573
|
+
- PRIVATE_PROFIT
|
5574
|
+
- PUBLIC_PROFIT
|
5575
|
+
- NON_PROFIT
|
5576
|
+
- GOVERNMENT
|
5577
|
+
nullable: true
|
5578
|
+
helpMessageResponse:
|
5579
|
+
type: string
|
5580
|
+
description: A message that gets sent to users requesting help.
|
5581
|
+
nullable: true
|
5582
|
+
maxLength: 500
|
5583
|
+
example: Please contact support for assistance.
|
5584
|
+
ageGatedContent:
|
5585
|
+
type: boolean
|
5586
|
+
description: Indicates whether the content is age-gated.
|
5587
|
+
example: false
|
5481
5588
|
additionalDenialReason:
|
5482
5589
|
properties:
|
5483
5590
|
statusCode:
|
@@ -5564,6 +5671,16 @@ components:
|
|
5564
5671
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
5565
5672
|
businessDba:
|
5566
5673
|
$ref: '#/components/schemas/businessDba'
|
5674
|
+
businessRegistrationNumber:
|
5675
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
5676
|
+
businessRegistrationType:
|
5677
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
5678
|
+
businessEntityType:
|
5679
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
5680
|
+
helpMessageResponse:
|
5681
|
+
$ref: '#/components/schemas/helpMessageResponse'
|
5682
|
+
ageGatedContent:
|
5683
|
+
$ref: '#/components/schemas/ageGatedContent'
|
5567
5684
|
verificationUpdateRequest:
|
5568
5685
|
type: object
|
5569
5686
|
required:
|
@@ -5603,6 +5720,16 @@ components:
|
|
5603
5720
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
5604
5721
|
businessDba:
|
5605
5722
|
$ref: '#/components/schemas/businessDba'
|
5723
|
+
businessRegistrationNumber:
|
5724
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
5725
|
+
businessRegistrationType:
|
5726
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
5727
|
+
businessEntityType:
|
5728
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
5729
|
+
helpMessageResponse:
|
5730
|
+
$ref: '#/components/schemas/helpMessageResponse'
|
5731
|
+
ageGatedContent:
|
5732
|
+
$ref: '#/components/schemas/ageGatedContent'
|
5606
5733
|
tfvBasicAuthentication:
|
5607
5734
|
type: object
|
5608
5735
|
properties:
|
@@ -5806,6 +5933,12 @@ components:
|
|
5806
5933
|
example: https://www.example.com/path/to/resource
|
5807
5934
|
pattern: >-
|
5808
5935
|
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
5936
|
+
confirmationResponse:
|
5937
|
+
type: string
|
5938
|
+
minLength: 0
|
5939
|
+
maxLength: 500
|
5940
|
+
nullable: true
|
5941
|
+
example: Thank you for opting in!
|
5809
5942
|
isvReseller:
|
5810
5943
|
type: string
|
5811
5944
|
description: ISV name.
|
@@ -6079,6 +6212,22 @@ components:
|
|
6079
6212
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
6080
6213
|
businessDba:
|
6081
6214
|
$ref: '#/components/schemas/businessDba'
|
6215
|
+
businessRegistrationNumber:
|
6216
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
6217
|
+
description: >-
|
6218
|
+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
|
6219
|
+
Available starting October 1st, 2025.
|
6220
|
+
businessRegistrationType:
|
6221
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
6222
|
+
description: >-
|
6223
|
+
The type of business registration number. Available starting October
|
6224
|
+
1st, 2025.
|
6225
|
+
businessEntityType:
|
6226
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
6227
|
+
description: >-
|
6228
|
+
The type of registered business. If no option is applicable, please
|
6229
|
+
provide "SOLE_PROPRIETOR" as a value. Available starting October
|
6230
|
+
1st, 2025.
|
6082
6231
|
tfvStatusEnum:
|
6083
6232
|
type: string
|
6084
6233
|
enum:
|
@@ -6940,6 +7089,112 @@ components:
|
|
6940
7089
|
example: CJEUMDK
|
6941
7090
|
schema:
|
6942
7091
|
type: string
|
7092
|
+
fromBwLatency:
|
7093
|
+
in: query
|
7094
|
+
name: fromBwLatency
|
7095
|
+
required: false
|
7096
|
+
description: >-
|
7097
|
+
The minimum Bandwidth latency of the message in seconds. Only available
|
7098
|
+
for accounts with the Advanced Quality Metrics feature enabled.
|
7099
|
+
example: 5
|
7100
|
+
schema:
|
7101
|
+
type: integer
|
7102
|
+
bwQueued:
|
7103
|
+
in: query
|
7104
|
+
name: bwQueued
|
7105
|
+
required: false
|
7106
|
+
description: >-
|
7107
|
+
A boolean value indicating whether the message is queued in the
|
7108
|
+
Bandwidth network.
|
7109
|
+
example: true
|
7110
|
+
schema:
|
7111
|
+
type: boolean
|
7112
|
+
product:
|
7113
|
+
in: query
|
7114
|
+
name: product
|
7115
|
+
required: false
|
7116
|
+
description: Messaging product associated with the message.
|
7117
|
+
example: P2P
|
7118
|
+
schema:
|
7119
|
+
$ref: '#/components/schemas/productTypeEnum'
|
7120
|
+
location:
|
7121
|
+
in: query
|
7122
|
+
name: location
|
7123
|
+
required: false
|
7124
|
+
description: Location Id associated with the message.
|
7125
|
+
example: 123ABC
|
7126
|
+
schema:
|
7127
|
+
type: string
|
7128
|
+
carrierQueued:
|
7129
|
+
in: query
|
7130
|
+
name: carrierQueued
|
7131
|
+
required: false
|
7132
|
+
description: >-
|
7133
|
+
A boolean value indicating whether the message is queued in the carrier
|
7134
|
+
network. Only available for OUTBOUND messages from accounts with the
|
7135
|
+
Advanced Quality Metrics feature enabled.
|
7136
|
+
example: true
|
7137
|
+
schema:
|
7138
|
+
type: boolean
|
7139
|
+
fromCarrierLatency:
|
7140
|
+
in: query
|
7141
|
+
name: fromCarrierLatency
|
7142
|
+
required: false
|
7143
|
+
description: >-
|
7144
|
+
The minimum carrier latency of the message in seconds. Only available
|
7145
|
+
for OUTBOUND messages from accounts with the Advanced Quality Metrics
|
7146
|
+
feature enabled.
|
7147
|
+
example: 50
|
7148
|
+
schema:
|
7149
|
+
type: integer
|
7150
|
+
callingNumberCountryA3:
|
7151
|
+
in: query
|
7152
|
+
name: callingNumberCountryA3
|
7153
|
+
required: false
|
7154
|
+
description: Calling number country in A3 format.
|
7155
|
+
example: USA
|
7156
|
+
schema:
|
7157
|
+
type: string
|
7158
|
+
calledNumberCountryA3:
|
7159
|
+
in: query
|
7160
|
+
name: calledNumberCountryA3
|
7161
|
+
required: false
|
7162
|
+
description: Called number country in A3 format.
|
7163
|
+
example: USA
|
7164
|
+
schema:
|
7165
|
+
type: string
|
7166
|
+
fromSegmentCount:
|
7167
|
+
in: query
|
7168
|
+
name: fromSegmentCount
|
7169
|
+
required: false
|
7170
|
+
description: Segment count (start range).
|
7171
|
+
example: 1
|
7172
|
+
schema:
|
7173
|
+
type: integer
|
7174
|
+
toSegmentCount:
|
7175
|
+
in: query
|
7176
|
+
name: toSegmentCount
|
7177
|
+
required: false
|
7178
|
+
description: Segment count (end range).
|
7179
|
+
example: 3
|
7180
|
+
schema:
|
7181
|
+
type: integer
|
7182
|
+
fromMessageSize:
|
7183
|
+
in: query
|
7184
|
+
name: fromMessageSize
|
7185
|
+
required: false
|
7186
|
+
description: Message size (start range).
|
7187
|
+
example: 100
|
7188
|
+
schema:
|
7189
|
+
type: integer
|
7190
|
+
toMessageSize:
|
7191
|
+
in: query
|
7192
|
+
name: toMessageSize
|
7193
|
+
required: false
|
7194
|
+
description: Message size (end range).
|
7195
|
+
example: 120
|
7196
|
+
schema:
|
7197
|
+
type: integer
|
6943
7198
|
sort:
|
6944
7199
|
in: query
|
6945
7200
|
name: sort
|
data/coverage/.last_run.json
CHANGED