late-sdk 0.0.725 → 0.0.727
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/README.md +20 -0
- data/docs/AttachNumberToSipTrunk200Response.md +22 -0
- data/docs/AttachNumberToSipTrunkRequest.md +18 -0
- data/docs/CreateSipTrunk201Response.md +34 -0
- data/docs/CreateSipTrunk201ResponseTermination.md +20 -0
- data/docs/CreateSipTrunkRequest.md +24 -0
- data/docs/DetachNumberFromSipTrunk200Response.md +20 -0
- data/docs/GetPhoneNumber200ResponsePhoneNumber.md +3 -1
- data/docs/GetSipTrunk200Response.md +34 -0
- data/docs/GetSipTrunk200ResponseNumbersInner.md +20 -0
- data/docs/ListPhoneNumbers200ResponseNumbersInner.md +2 -0
- data/docs/ListSipTrunks200Response.md +20 -0
- data/docs/ListSipTrunks200ResponseTrunksInner.md +32 -0
- data/docs/ListSipTrunks200ResponseTrunksInnerTermination.md +20 -0
- data/docs/MessagesApi.md +1 -1
- data/docs/RotateSipTrunkCredentials200Response.md +20 -0
- data/docs/SendInboxMessage200ResponseData.md +4 -6
- data/docs/SendInboxMessage200ResponseDataAttachmentsInner.md +20 -0
- data/docs/VoiceApi.md +485 -0
- data/lib/zernio-sdk/api/messages_api.rb +2 -2
- data/lib/zernio-sdk/api/voice_api.rb +447 -0
- data/lib/zernio-sdk/models/attach_number_to_sip_trunk200_response.rb +165 -0
- data/lib/zernio-sdk/models/attach_number_to_sip_trunk_request.rb +165 -0
- data/lib/zernio-sdk/models/create_sip_trunk201_response.rb +255 -0
- data/lib/zernio-sdk/models/create_sip_trunk201_response_termination.rb +158 -0
- data/lib/zernio-sdk/models/create_sip_trunk_request.rb +283 -0
- data/lib/zernio-sdk/models/detach_number_from_sip_trunk200_response.rb +157 -0
- data/lib/zernio-sdk/models/get_phone_number200_response_phone_number.rb +15 -4
- data/lib/zernio-sdk/models/get_sip_trunk200_response.rb +256 -0
- data/lib/zernio-sdk/models/get_sip_trunk200_response_numbers_inner.rb +157 -0
- data/lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb +12 -1
- data/lib/zernio-sdk/models/list_sip_trunks200_response.rb +159 -0
- data/lib/zernio-sdk/models/list_sip_trunks200_response_trunks_inner.rb +245 -0
- data/lib/zernio-sdk/models/list_sip_trunks200_response_trunks_inner_termination.rb +156 -0
- data/lib/zernio-sdk/models/rotate_sip_trunk_credentials200_response.rb +156 -0
- data/lib/zernio-sdk/models/send_inbox_message200_response_data.rb +12 -23
- data/lib/zernio-sdk/models/send_inbox_message200_response_data_attachments_inner.rb +156 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +13 -0
- data/openapi.yaml +293 -4
- data/spec/api/messages_api_spec.rb +1 -1
- data/spec/api/voice_api_spec.rb +82 -0
- data/spec/models/attach_number_to_sip_trunk200_response_spec.rb +48 -0
- data/spec/models/attach_number_to_sip_trunk_request_spec.rb +36 -0
- data/spec/models/create_sip_trunk201_response_spec.rb +88 -0
- data/spec/models/create_sip_trunk201_response_termination_spec.rb +42 -0
- data/spec/models/create_sip_trunk_request_spec.rb +58 -0
- data/spec/models/detach_number_from_sip_trunk200_response_spec.rb +42 -0
- data/spec/models/get_phone_number200_response_phone_number_spec.rb +6 -0
- data/spec/models/get_sip_trunk200_response_numbers_inner_spec.rb +42 -0
- data/spec/models/get_sip_trunk200_response_spec.rb +88 -0
- data/spec/models/list_phone_numbers200_response_numbers_inner_spec.rb +6 -0
- data/spec/models/list_sip_trunks200_response_spec.rb +42 -0
- data/spec/models/list_sip_trunks200_response_trunks_inner_spec.rb +82 -0
- data/spec/models/list_sip_trunks200_response_trunks_inner_termination_spec.rb +42 -0
- data/spec/models/rotate_sip_trunk_credentials200_response_spec.rb +42 -0
- data/spec/models/send_inbox_message200_response_data_attachments_inner_spec.rb +42 -0
- data/spec/models/send_inbox_message200_response_data_spec.rb +1 -7
- data/zernio-sdk-0.0.727.gem +0 -0
- metadata +55 -3
- data/zernio-sdk-0.0.725.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6bf2470a239324d5b07dd39c7307b4db3979922a659ce0f7374e01f928c958ae
|
|
4
|
+
data.tar.gz: b6ed0ab6e0d81bdf01298822caabadb3ac750eeb1c3540ef5ce238d1e0c4ad60
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a4523818f53550cf351203aa281b053990030e7ad77057df40fdd767d6d319be7d4e84965854c38ffc126fa11d0d40666e3983b6a918e985393e2a5cab418044
|
|
7
|
+
data.tar.gz: e6657754285be968a3c0d4cd0fbcaf03ca65afc425471f5e2a70bf0f0aebe814394776225be0742e30111a021a54cfdb6f6da2cb3d182005a6fcd730554e353c
|
data/README.md
CHANGED
|
@@ -523,16 +523,23 @@ Class | Method | HTTP request | Description
|
|
|
523
523
|
*Zernio::VerifyApi* | [**check_verification**](docs/VerifyApi.md#check_verification) | **POST** /v1/verify/verifications/{verificationId}/check | Check a verification code
|
|
524
524
|
*Zernio::VerifyApi* | [**create_verification**](docs/VerifyApi.md#create_verification) | **POST** /v1/verify/verifications | Send a verification code
|
|
525
525
|
*Zernio::VerifyApi* | [**get_verification**](docs/VerifyApi.md#get_verification) | **GET** /v1/verify/verifications/{verificationId} | Get a verification
|
|
526
|
+
*Zernio::VoiceApi* | [**attach_number_to_sip_trunk**](docs/VoiceApi.md#attach_number_to_sip_trunk) | **POST** /v1/phone-numbers/{id}/sip-trunk | Attach a number to a SIP trunk
|
|
527
|
+
*Zernio::VoiceApi* | [**create_sip_trunk**](docs/VoiceApi.md#create_sip_trunk) | **POST** /v1/phone-numbers/sip-trunks | Create a SIP trunk
|
|
526
528
|
*Zernio::VoiceApi* | [**create_voice_call**](docs/VoiceApi.md#create_voice_call) | **POST** /v1/voice/calls | Place an outbound phone call
|
|
527
529
|
*Zernio::VoiceApi* | [**create_voice_web_session**](docs/VoiceApi.md#create_voice_web_session) | **POST** /v1/voice/calls/web | Mint a browser softphone session
|
|
530
|
+
*Zernio::VoiceApi* | [**delete_sip_trunk**](docs/VoiceApi.md#delete_sip_trunk) | **DELETE** /v1/phone-numbers/sip-trunks/{id} | Delete a SIP trunk
|
|
531
|
+
*Zernio::VoiceApi* | [**detach_number_from_sip_trunk**](docs/VoiceApi.md#detach_number_from_sip_trunk) | **DELETE** /v1/phone-numbers/{id}/sip-trunk | Detach a number from its SIP trunk
|
|
528
532
|
*Zernio::VoiceApi* | [**dial_voice_web_call**](docs/VoiceApi.md#dial_voice_web_call) | **POST** /v1/voice/calls/web/dial | Dial from the browser softphone
|
|
529
533
|
*Zernio::VoiceApi* | [**disable_voice_on_number**](docs/VoiceApi.md#disable_voice_on_number) | **DELETE** /v1/phone-numbers/{id}/voice | Disable phone calling on a number
|
|
530
534
|
*Zernio::VoiceApi* | [**enable_voice_on_number**](docs/VoiceApi.md#enable_voice_on_number) | **POST** /v1/phone-numbers/{id}/voice | Enable phone calling on a number
|
|
531
535
|
*Zernio::VoiceApi* | [**end_voice_call**](docs/VoiceApi.md#end_voice_call) | **POST** /v1/voice/calls/{id}/end | Hang up a live call
|
|
536
|
+
*Zernio::VoiceApi* | [**get_sip_trunk**](docs/VoiceApi.md#get_sip_trunk) | **GET** /v1/phone-numbers/sip-trunks/{id} | Get a SIP trunk
|
|
532
537
|
*Zernio::VoiceApi* | [**get_voice_call**](docs/VoiceApi.md#get_voice_call) | **GET** /v1/voice/calls/{id} | Get a phone call
|
|
533
538
|
*Zernio::VoiceApi* | [**get_voice_call_estimate**](docs/VoiceApi.md#get_voice_call_estimate) | **GET** /v1/voice/calls/estimate | Estimate call cost
|
|
534
539
|
*Zernio::VoiceApi* | [**get_voice_call_recording**](docs/VoiceApi.md#get_voice_call_recording) | **GET** /v1/voice/calls/{id}/recording | Get a call recording
|
|
540
|
+
*Zernio::VoiceApi* | [**list_sip_trunks**](docs/VoiceApi.md#list_sip_trunks) | **GET** /v1/phone-numbers/sip-trunks | List SIP trunks
|
|
535
541
|
*Zernio::VoiceApi* | [**list_voice_calls**](docs/VoiceApi.md#list_voice_calls) | **GET** /v1/voice/calls | List phone calls
|
|
542
|
+
*Zernio::VoiceApi* | [**rotate_sip_trunk_credentials**](docs/VoiceApi.md#rotate_sip_trunk_credentials) | **POST** /v1/phone-numbers/sip-trunks/{id}/rotate-credentials | Rotate a SIP trunk's password
|
|
536
543
|
*Zernio::VoiceApi* | [**transfer_voice_call**](docs/VoiceApi.md#transfer_voice_call) | **POST** /v1/voice/calls/{id}/transfer | Blind-transfer a live call
|
|
537
544
|
*Zernio::WebhooksApi* | [**create_webhook_settings**](docs/WebhooksApi.md#create_webhook_settings) | **POST** /v1/webhooks/settings | Create webhook
|
|
538
545
|
*Zernio::WebhooksApi* | [**delete_webhook_settings**](docs/WebhooksApi.md#delete_webhook_settings) | **DELETE** /v1/webhooks/settings | Delete webhook
|
|
@@ -711,6 +718,8 @@ Class | Method | HTTP request | Description
|
|
|
711
718
|
- [Zernio::AssignGoogleBusinessLocation200Response](docs/AssignGoogleBusinessLocation200Response.md)
|
|
712
719
|
- [Zernio::AssignGoogleBusinessLocation200ResponseAccount](docs/AssignGoogleBusinessLocation200ResponseAccount.md)
|
|
713
720
|
- [Zernio::AssignGoogleBusinessLocationRequest](docs/AssignGoogleBusinessLocationRequest.md)
|
|
721
|
+
- [Zernio::AttachNumberToSipTrunk200Response](docs/AttachNumberToSipTrunk200Response.md)
|
|
722
|
+
- [Zernio::AttachNumberToSipTrunkRequest](docs/AttachNumberToSipTrunkRequest.md)
|
|
714
723
|
- [Zernio::BatchGetGoogleBusinessReviews200Response](docs/BatchGetGoogleBusinessReviews200Response.md)
|
|
715
724
|
- [Zernio::BatchGetGoogleBusinessReviews200ResponseLocationReviewsInner](docs/BatchGetGoogleBusinessReviews200ResponseLocationReviewsInner.md)
|
|
716
725
|
- [Zernio::BatchGetGoogleBusinessReviewsRequest](docs/BatchGetGoogleBusinessReviewsRequest.md)
|
|
@@ -912,6 +921,9 @@ Class | Method | HTTP request | Description
|
|
|
912
921
|
- [Zernio::CreateSequenceRequestStepsInner](docs/CreateSequenceRequestStepsInner.md)
|
|
913
922
|
- [Zernio::CreateSequenceRequestStepsInnerTemplate](docs/CreateSequenceRequestStepsInnerTemplate.md)
|
|
914
923
|
- [Zernio::CreateSequenceRequestStepsInnerTemplateVariableMappingValue](docs/CreateSequenceRequestStepsInnerTemplateVariableMappingValue.md)
|
|
924
|
+
- [Zernio::CreateSipTrunk201Response](docs/CreateSipTrunk201Response.md)
|
|
925
|
+
- [Zernio::CreateSipTrunk201ResponseTermination](docs/CreateSipTrunk201ResponseTermination.md)
|
|
926
|
+
- [Zernio::CreateSipTrunkRequest](docs/CreateSipTrunkRequest.md)
|
|
915
927
|
- [Zernio::CreateSmsSenderId200Response](docs/CreateSmsSenderId200Response.md)
|
|
916
928
|
- [Zernio::CreateSmsSenderIdRequest](docs/CreateSmsSenderIdRequest.md)
|
|
917
929
|
- [Zernio::CreateStandaloneAd200Response](docs/CreateStandaloneAd200Response.md)
|
|
@@ -999,6 +1011,7 @@ Class | Method | HTTP request | Description
|
|
|
999
1011
|
- [Zernio::DeleteSmsSenderId200Response](docs/DeleteSmsSenderId200Response.md)
|
|
1000
1012
|
- [Zernio::DeleteValueRuleSet200Response](docs/DeleteValueRuleSet200Response.md)
|
|
1001
1013
|
- [Zernio::DeleteWhatsappBusinessUsernameRequest](docs/DeleteWhatsappBusinessUsernameRequest.md)
|
|
1014
|
+
- [Zernio::DetachNumberFromSipTrunk200Response](docs/DetachNumberFromSipTrunk200Response.md)
|
|
1002
1015
|
- [Zernio::DialVoiceWebCall200Response](docs/DialVoiceWebCall200Response.md)
|
|
1003
1016
|
- [Zernio::DialVoiceWebCallRequest](docs/DialVoiceWebCallRequest.md)
|
|
1004
1017
|
- [Zernio::DisableSmsOnNumber200Response](docs/DisableSmsOnNumber200Response.md)
|
|
@@ -1322,6 +1335,8 @@ Class | Method | HTTP request | Description
|
|
|
1322
1335
|
- [Zernio::GetSequence200ResponseSequence](docs/GetSequence200ResponseSequence.md)
|
|
1323
1336
|
- [Zernio::GetSequence200ResponseSequenceStepsInner](docs/GetSequence200ResponseSequenceStepsInner.md)
|
|
1324
1337
|
- [Zernio::GetSequence200ResponseSequenceStepsInnerTemplate](docs/GetSequence200ResponseSequenceStepsInnerTemplate.md)
|
|
1338
|
+
- [Zernio::GetSipTrunk200Response](docs/GetSipTrunk200Response.md)
|
|
1339
|
+
- [Zernio::GetSipTrunk200ResponseNumbersInner](docs/GetSipTrunk200ResponseNumbersInner.md)
|
|
1325
1340
|
- [Zernio::GetSlackSettings200Response](docs/GetSlackSettings200Response.md)
|
|
1326
1341
|
- [Zernio::GetSlackSettings200ResponseAccount](docs/GetSlackSettings200ResponseAccount.md)
|
|
1327
1342
|
- [Zernio::GetSmsRegistration200Response](docs/GetSmsRegistration200Response.md)
|
|
@@ -1611,6 +1626,9 @@ Class | Method | HTTP request | Description
|
|
|
1611
1626
|
- [Zernio::ListSequenceEnrollments200ResponseEnrollmentsInner](docs/ListSequenceEnrollments200ResponseEnrollmentsInner.md)
|
|
1612
1627
|
- [Zernio::ListSequences200Response](docs/ListSequences200Response.md)
|
|
1613
1628
|
- [Zernio::ListSequences200ResponseSequencesInner](docs/ListSequences200ResponseSequencesInner.md)
|
|
1629
|
+
- [Zernio::ListSipTrunks200Response](docs/ListSipTrunks200Response.md)
|
|
1630
|
+
- [Zernio::ListSipTrunks200ResponseTrunksInner](docs/ListSipTrunks200ResponseTrunksInner.md)
|
|
1631
|
+
- [Zernio::ListSipTrunks200ResponseTrunksInnerTermination](docs/ListSipTrunks200ResponseTrunksInnerTermination.md)
|
|
1614
1632
|
- [Zernio::ListSlackMembers200Response](docs/ListSlackMembers200Response.md)
|
|
1615
1633
|
- [Zernio::ListSlackMembers200ResponseMembersInner](docs/ListSlackMembers200ResponseMembersInner.md)
|
|
1616
1634
|
- [Zernio::ListSmsOptOuts200Response](docs/ListSmsOptOuts200Response.md)
|
|
@@ -1799,6 +1817,7 @@ Class | Method | HTTP request | Description
|
|
|
1799
1817
|
- [Zernio::ReviewWebhookReviewReviewer](docs/ReviewWebhookReviewReviewer.md)
|
|
1800
1818
|
- [Zernio::RevokeConnectedApp200Response](docs/RevokeConnectedApp200Response.md)
|
|
1801
1819
|
- [Zernio::RfPrediction](docs/RfPrediction.md)
|
|
1820
|
+
- [Zernio::RotateSipTrunkCredentials200Response](docs/RotateSipTrunkCredentials200Response.md)
|
|
1802
1821
|
- [Zernio::SavedTargetingAudience](docs/SavedTargetingAudience.md)
|
|
1803
1822
|
- [Zernio::ScheduleBroadcast200Response](docs/ScheduleBroadcast200Response.md)
|
|
1804
1823
|
- [Zernio::ScheduleBroadcast200ResponseBroadcast](docs/ScheduleBroadcast200ResponseBroadcast.md)
|
|
@@ -1862,6 +1881,7 @@ Class | Method | HTTP request | Description
|
|
|
1862
1881
|
- [Zernio::SendDiscordDirectMessageRequestAttachmentsInner](docs/SendDiscordDirectMessageRequestAttachmentsInner.md)
|
|
1863
1882
|
- [Zernio::SendInboxMessage200Response](docs/SendInboxMessage200Response.md)
|
|
1864
1883
|
- [Zernio::SendInboxMessage200ResponseData](docs/SendInboxMessage200ResponseData.md)
|
|
1884
|
+
- [Zernio::SendInboxMessage200ResponseDataAttachmentsInner](docs/SendInboxMessage200ResponseDataAttachmentsInner.md)
|
|
1865
1885
|
- [Zernio::SendInboxMessage400Response](docs/SendInboxMessage400Response.md)
|
|
1866
1886
|
- [Zernio::SendInboxMessage400ResponsePlatformError](docs/SendInboxMessage400ResponsePlatformError.md)
|
|
1867
1887
|
- [Zernio::SendInboxMessageRequest](docs/SendInboxMessageRequest.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::AttachNumberToSipTrunk200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attached** | **Boolean** | | [optional] |
|
|
8
|
+
| **phone_number** | **String** | | [optional] |
|
|
9
|
+
| **trunk_id** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::AttachNumberToSipTrunk200Response.new(
|
|
17
|
+
attached: null,
|
|
18
|
+
phone_number: null,
|
|
19
|
+
trunk_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::AttachNumberToSipTrunkRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **trunk_id** | **String** | SIP trunk ID (from POST /v1/phone-numbers/sip-trunks). | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::AttachNumberToSipTrunkRequest.new(
|
|
15
|
+
trunk_id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Zernio::CreateSipTrunk201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **label** | **String** | | [optional] |
|
|
9
|
+
| **sip_host** | **String** | | [optional] |
|
|
10
|
+
| **sip_port** | **Integer** | | [optional] |
|
|
11
|
+
| **transport** | **String** | | [optional] |
|
|
12
|
+
| **termination** | [**CreateSipTrunk201ResponseTermination**](CreateSipTrunk201ResponseTermination.md) | | [optional] |
|
|
13
|
+
| **numbers_attached** | **Integer** | | [optional] |
|
|
14
|
+
| **created_at** | **Time** | | [optional] |
|
|
15
|
+
| **digest_password** | **String** | SIP digest password, shown only in this response. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'zernio-sdk'
|
|
21
|
+
|
|
22
|
+
instance = Zernio::CreateSipTrunk201Response.new(
|
|
23
|
+
id: null,
|
|
24
|
+
label: null,
|
|
25
|
+
sip_host: null,
|
|
26
|
+
sip_port: null,
|
|
27
|
+
transport: null,
|
|
28
|
+
termination: null,
|
|
29
|
+
numbers_attached: null,
|
|
30
|
+
created_at: null,
|
|
31
|
+
digest_password: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::CreateSipTrunk201ResponseTermination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uri** | **String** | Telnyx termination host the platform dials for outbound (sip.telnyx.com). | [optional] |
|
|
8
|
+
| **username** | **String** | SIP digest username. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::CreateSipTrunk201ResponseTermination.new(
|
|
16
|
+
uri: null,
|
|
17
|
+
username: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zernio::CreateSipTrunkRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **label** | **String** | Display name for the trunk. | |
|
|
8
|
+
| **sip_host** | **String** | Fully-qualified hostname inbound calls are delivered to (e.g. sip.rtc.elevenlabs.io, sip.retellai.com). | |
|
|
9
|
+
| **sip_port** | **Integer** | Defaults to 5061 for tls, 5060 otherwise. | [optional] |
|
|
10
|
+
| **transport** | **String** | Signaling transport toward sipHost. Default tls (with SRTP media). | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zernio-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Zernio::CreateSipTrunkRequest.new(
|
|
18
|
+
label: null,
|
|
19
|
+
sip_host: null,
|
|
20
|
+
sip_port: null,
|
|
21
|
+
transport: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::DetachNumberFromSipTrunk200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attached** | **Boolean** | Always false after a successful detach. | [optional] |
|
|
8
|
+
| **phone_number** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::DetachNumberFromSipTrunk200Response.new(
|
|
16
|
+
attached: null,
|
|
17
|
+
phone_number: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
| **end_user_last_name** | **String** | | [optional] |
|
|
16
16
|
| **regulatory_decline_reason** | **String** | Reviewer rejection reason when status is regulatory_declined. | [optional] |
|
|
17
17
|
| **provisioned_at** | **Time** | | [optional] |
|
|
18
|
+
| **sip_trunk_id** | **String** | SIP trunk the number is attached to; null when not trunked. While attached, enabling Calls or WhatsApp calling, requesting WhatsApp verification, and releasing the number all return 409. | [optional] |
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,7 +33,8 @@ instance = Zernio::GetPhoneNumber200ResponsePhoneNumber.new(
|
|
|
32
33
|
end_user_first_name: null,
|
|
33
34
|
end_user_last_name: null,
|
|
34
35
|
regulatory_decline_reason: null,
|
|
35
|
-
provisioned_at: null
|
|
36
|
+
provisioned_at: null,
|
|
37
|
+
sip_trunk_id: null
|
|
36
38
|
)
|
|
37
39
|
```
|
|
38
40
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Zernio::GetSipTrunk200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **label** | **String** | | [optional] |
|
|
9
|
+
| **sip_host** | **String** | | [optional] |
|
|
10
|
+
| **sip_port** | **Integer** | | [optional] |
|
|
11
|
+
| **transport** | **String** | | [optional] |
|
|
12
|
+
| **termination** | [**ListSipTrunks200ResponseTrunksInnerTermination**](ListSipTrunks200ResponseTrunksInnerTermination.md) | | [optional] |
|
|
13
|
+
| **numbers_attached** | **Integer** | | [optional] |
|
|
14
|
+
| **created_at** | **Time** | | [optional] |
|
|
15
|
+
| **numbers** | [**Array<GetSipTrunk200ResponseNumbersInner>**](GetSipTrunk200ResponseNumbersInner.md) | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'zernio-sdk'
|
|
21
|
+
|
|
22
|
+
instance = Zernio::GetSipTrunk200Response.new(
|
|
23
|
+
id: null,
|
|
24
|
+
label: null,
|
|
25
|
+
sip_host: null,
|
|
26
|
+
sip_port: null,
|
|
27
|
+
transport: null,
|
|
28
|
+
termination: null,
|
|
29
|
+
numbers_attached: null,
|
|
30
|
+
created_at: null,
|
|
31
|
+
numbers: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::GetSipTrunk200ResponseNumbersInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Phone number record ID. | [optional] |
|
|
8
|
+
| **phone_number** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::GetSipTrunk200ResponseNumbersInner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
phone_number: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| **telnyx_order_id** | **String** | Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review. | [optional] |
|
|
13
13
|
| **monthly_cents** | **Integer** | Per-country monthly price in cents ($2..$25). | [optional] |
|
|
14
14
|
| **hosted_by_zernio** | **Boolean** | False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them. | [optional] |
|
|
15
|
+
| **sip_trunk_id** | **String** | SIP trunk the number is attached to; null when not trunked. While attached, enabling Calls or WhatsApp calling, requesting WhatsApp verification, and releasing the number all return 409. | [optional] |
|
|
15
16
|
| **profile_id** | **Object** | | [optional] |
|
|
16
17
|
| **provisioned_at** | **Time** | | [optional] |
|
|
17
18
|
| **meta_preverified_id** | **String** | | [optional] |
|
|
@@ -37,6 +38,7 @@ instance = Zernio::ListPhoneNumbers200ResponseNumbersInner.new(
|
|
|
37
38
|
telnyx_order_id: null,
|
|
38
39
|
monthly_cents: null,
|
|
39
40
|
hosted_by_zernio: null,
|
|
41
|
+
sip_trunk_id: null,
|
|
40
42
|
profile_id: null,
|
|
41
43
|
provisioned_at: null,
|
|
42
44
|
meta_preverified_id: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListSipTrunks200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **trunks** | [**Array<ListSipTrunks200ResponseTrunksInner>**](ListSipTrunks200ResponseTrunksInner.md) | | [optional] |
|
|
8
|
+
| **enabled** | **Boolean** | Whether this workspace can create SIP trunks. Managing existing trunks always works. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListSipTrunks200Response.new(
|
|
16
|
+
trunks: null,
|
|
17
|
+
enabled: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zernio::ListSipTrunks200ResponseTrunksInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **label** | **String** | | [optional] |
|
|
9
|
+
| **sip_host** | **String** | | [optional] |
|
|
10
|
+
| **sip_port** | **Integer** | | [optional] |
|
|
11
|
+
| **transport** | **String** | | [optional] |
|
|
12
|
+
| **termination** | [**ListSipTrunks200ResponseTrunksInnerTermination**](ListSipTrunks200ResponseTrunksInnerTermination.md) | | [optional] |
|
|
13
|
+
| **numbers_attached** | **Integer** | | [optional] |
|
|
14
|
+
| **created_at** | **Time** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zernio-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Zernio::ListSipTrunks200ResponseTrunksInner.new(
|
|
22
|
+
id: null,
|
|
23
|
+
label: null,
|
|
24
|
+
sip_host: null,
|
|
25
|
+
sip_port: null,
|
|
26
|
+
transport: null,
|
|
27
|
+
termination: null,
|
|
28
|
+
numbers_attached: null,
|
|
29
|
+
created_at: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListSipTrunks200ResponseTrunksInnerTermination
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uri** | **String** | | [optional] |
|
|
8
|
+
| **username** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListSipTrunks200ResponseTrunksInnerTermination.new(
|
|
16
|
+
uri: null,
|
|
17
|
+
username: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/MessagesApi.md
CHANGED
|
@@ -854,7 +854,7 @@ end
|
|
|
854
854
|
|
|
855
855
|
Send message
|
|
856
856
|
|
|
857
|
-
Send a message in a conversation. Supports text, attachments, quick replies, buttons, templates, and message tags. Attachment and interactive message support varies by platform. WhatsApp template messages: to send an approved template into this conversation (required when the 24-hour customer-service window is closed), use the `template` field with a single element carrying the template reference: `{ \"elements\": [{ \"name\": ..., \"language\": ..., \"components\": [...] }] }`. See the `template` field below for the exact shape. To send a template to a phone number you have no conversation with yet, use the create-conversation endpoint (POST /v1/inbox/conversations) instead. WhatsApp rich interactive messages (list, CTA URL, Flow, location request) are available via the `interactive` field. Tap events are delivered through the `message.received` webhook with WhatsApp-specific `metadata` fields (`interactiveType`, `interactiveId`, `flowResponseJson`, `flowResponseData`). **Idempotency:** send an `Idempotency-Key` header to make retries safe (e.g. after a client-side timeout where delivery is unknown): same key + same body replays the original response (with `Idempotent-Replayed: true`) instead of sending the message a second time; same key + different body returns 422; a key still in flight returns 409. Works for JSON and multipart (file upload) requests alike. Keys are retained for 24 hours.
|
|
857
|
+
Send a message in a conversation. Supports text, attachments, quick replies, buttons, templates, and message tags. Attachment and interactive message support varies by platform. WhatsApp template messages: to send an approved template into this conversation (required when the 24-hour customer-service window is closed), use the `template` field with a single element carrying the template reference: `{ \"elements\": [{ \"name\": ..., \"language\": ..., \"components\": [...] }] }`. See the `template` field below for the exact shape. To send a template to a phone number you have no conversation with yet, use the create-conversation endpoint (POST /v1/inbox/conversations) instead. WhatsApp rich interactive messages (list, CTA URL, Flow, location request) are available via the `interactive` field. Tap events are delivered through the `message.received` webhook with WhatsApp-specific `metadata` fields (`interactiveType`, `interactiveId`, `flowResponseJson`, `flowResponseData`). **Idempotency:** send an `Idempotency-Key` header to make retries safe (e.g. after a client-side timeout where delivery is unknown): same key + same body replays the original response (with `Idempotent-Replayed: true`) instead of sending the message a second time; same key + different body returns 422; a key still in flight returns 409. Works for JSON and multipart (file upload) requests alike. Keys are retained for 24 hours. Only successful (2xx) responses are stored for replay: if the request throws or returns a non-2xx status, the key is released so the same key can be retried once the problem is fixed. The header therefore protects the \"request succeeded but the response was lost\" case. For an ambiguous failure (a 5xx or a network timeout), reconcile before retrying: a failure after the platform already accepted the message also releases the key, and a blind retry could send it twice. List the conversation's messages first, and treat an empty result as inconclusive rather than as proof nothing was sent, since a send that failed while being recorded leaves no trace on our side.
|
|
858
858
|
|
|
859
859
|
### Examples
|
|
860
860
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::RotateSipTrunkCredentials200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **termination** | [**CreateSipTrunk201ResponseTermination**](CreateSipTrunk201ResponseTermination.md) | | [optional] |
|
|
8
|
+
| **digest_password** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::RotateSipTrunkCredentials200Response.new(
|
|
16
|
+
termination: null,
|
|
17
|
+
digest_password: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -4,10 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_id** | **String** |
|
|
8
|
-
| **conversation_id** | **String** | Twitter conversation
|
|
9
|
-
| **
|
|
10
|
-
| **message** | **String** | Success message (Reddit only) | [optional] |
|
|
7
|
+
| **message_id** | **String** | Platform id of the sent message (not returned for Reddit). For WhatsApp this is the raw Meta wamid, the same id delivered as message.platformMessageId on webhooks and delivery-status updates, and the value to pass as replyTo to quote-reply. | [optional] |
|
|
8
|
+
| **conversation_id** | **String** | Zernio conversation id, echoed so the thread can be read back or replied to. It equals the id the list-conversations endpoint returns for Telegram, WhatsApp, SMS and Slack; for Facebook, Instagram, Bluesky and Reddit that endpoint returns the platform thread id instead, so do not correlate the two by equality. For X (Twitter), when the request addressed the conversation by its Twitter dm_conversation_id, that platform id is echoed back instead. Omitted when the send succeeded but the conversation could not be resolved to a stored record. | [optional] |
|
|
9
|
+
| **attachments** | [**Array<SendInboxMessage200ResponseDataAttachmentsInner>**](SendInboxMessage200ResponseDataAttachmentsInner.md) | Echo of the sent attachment with its resolved public URL, when one is available (Facebook, Instagram, Telegram, WhatsApp). | [optional] |
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,8 +16,7 @@ require 'zernio-sdk'
|
|
|
17
16
|
instance = Zernio::SendInboxMessage200ResponseData.new(
|
|
18
17
|
message_id: null,
|
|
19
18
|
conversation_id: null,
|
|
20
|
-
|
|
21
|
-
message: null
|
|
19
|
+
attachments: null
|
|
22
20
|
)
|
|
23
21
|
```
|
|
24
22
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::SendInboxMessage200ResponseDataAttachmentsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | [optional] |
|
|
8
|
+
| **url** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::SendInboxMessage200ResponseDataAttachmentsInner.new(
|
|
16
|
+
type: null,
|
|
17
|
+
url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|