late-sdk 0.0.726 → 0.0.727

data/docs/VoiceApi.md

@@ -4,19 +4,166 @@ All URIs are relative to *https://zernio.com/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**attach_number_to_sip_trunk**](VoiceApi.md#attach_number_to_sip_trunk) | **POST** /v1/phone-numbers/{id}/sip-trunk | Attach a number to a SIP trunk |
+| [**create_sip_trunk**](VoiceApi.md#create_sip_trunk) | **POST** /v1/phone-numbers/sip-trunks | Create a SIP trunk |
 | [**create_voice_call**](VoiceApi.md#create_voice_call) | **POST** /v1/voice/calls | Place an outbound phone call |
 | [**create_voice_web_session**](VoiceApi.md#create_voice_web_session) | **POST** /v1/voice/calls/web | Mint a browser softphone session |
+| [**delete_sip_trunk**](VoiceApi.md#delete_sip_trunk) | **DELETE** /v1/phone-numbers/sip-trunks/{id} | Delete a SIP trunk |
+| [**detach_number_from_sip_trunk**](VoiceApi.md#detach_number_from_sip_trunk) | **DELETE** /v1/phone-numbers/{id}/sip-trunk | Detach a number from its SIP trunk |
 | [**dial_voice_web_call**](VoiceApi.md#dial_voice_web_call) | **POST** /v1/voice/calls/web/dial | Dial from the browser softphone |
 | [**disable_voice_on_number**](VoiceApi.md#disable_voice_on_number) | **DELETE** /v1/phone-numbers/{id}/voice | Disable phone calling on a number |
 | [**enable_voice_on_number**](VoiceApi.md#enable_voice_on_number) | **POST** /v1/phone-numbers/{id}/voice | Enable phone calling on a number |
 | [**end_voice_call**](VoiceApi.md#end_voice_call) | **POST** /v1/voice/calls/{id}/end | Hang up a live call |
+| [**get_sip_trunk**](VoiceApi.md#get_sip_trunk) | **GET** /v1/phone-numbers/sip-trunks/{id} | Get a SIP trunk |
 | [**get_voice_call**](VoiceApi.md#get_voice_call) | **GET** /v1/voice/calls/{id} | Get a phone call |
 | [**get_voice_call_estimate**](VoiceApi.md#get_voice_call_estimate) | **GET** /v1/voice/calls/estimate | Estimate call cost |
 | [**get_voice_call_recording**](VoiceApi.md#get_voice_call_recording) | **GET** /v1/voice/calls/{id}/recording | Get a call recording |
+| [**list_sip_trunks**](VoiceApi.md#list_sip_trunks) | **GET** /v1/phone-numbers/sip-trunks | List SIP trunks |
 | [**list_voice_calls**](VoiceApi.md#list_voice_calls) | **GET** /v1/voice/calls | List phone calls |
+| [**rotate_sip_trunk_credentials**](VoiceApi.md#rotate_sip_trunk_credentials) | **POST** /v1/phone-numbers/sip-trunks/{id}/rotate-credentials | Rotate a SIP trunk's password |
 | [**transfer_voice_call**](VoiceApi.md#transfer_voice_call) | **POST** /v1/voice/calls/{id}/transfer | Blind-transfer a live call |
 
 
+## attach_number_to_sip_trunk
+
+> <AttachNumberToSipTrunk200Response> attach_number_to_sip_trunk(id, attach_number_to_sip_trunk_request)
+
+Attach a number to a SIP trunk
+
+Routes the number's calls to the trunk: the external platform receives its inbound directly and can present it as outbound caller ID. While attached, Zernio-side voice features are off for this number (call forwarding, IVR, voicemail, recording, the softphone, and WhatsApp calling), so the number must have Calls and WhatsApp calling disabled before attaching. SMS and WhatsApp messaging are unaffected. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+id = 'id_example' # String | Phone number record ID (from GET /v1/phone-numbers).
+attach_number_to_sip_trunk_request = Zernio::AttachNumberToSipTrunkRequest.new({trunk_id: 'trunk_id_example'}) # AttachNumberToSipTrunkRequest | 
+
+begin
+  # Attach a number to a SIP trunk
+  result = api_instance.attach_number_to_sip_trunk(id, attach_number_to_sip_trunk_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->attach_number_to_sip_trunk: #{e}"
+end
+```
+
+#### Using the attach_number_to_sip_trunk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AttachNumberToSipTrunk200Response>, Integer, Hash)> attach_number_to_sip_trunk_with_http_info(id, attach_number_to_sip_trunk_request)
+
+```ruby
+begin
+  # Attach a number to a SIP trunk
+  data, status_code, headers = api_instance.attach_number_to_sip_trunk_with_http_info(id, attach_number_to_sip_trunk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AttachNumberToSipTrunk200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->attach_number_to_sip_trunk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Phone number record ID (from GET /v1/phone-numbers). |  |
+| **attach_number_to_sip_trunk_request** | [**AttachNumberToSipTrunkRequest**](AttachNumberToSipTrunkRequest.md) |  |  |
+
+### Return type
+
+[**AttachNumberToSipTrunk200Response**](AttachNumberToSipTrunk200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_sip_trunk
+
+> <CreateSipTrunk201Response> create_sip_trunk(create_sip_trunk_request)
+
+Create a SIP trunk
+
+Creates a SIP trunk an external voice platform (Retell, ElevenLabs, Vapi, or any SIP endpoint) can import your Zernio numbers into. The trunk carries both directions: inbound calls on attached numbers are delivered to `sipHost`, and the platform originates outbound calls through `termination.uri` with the digest credentials.  The `digestPassword` is returned only by this call (and by rotate-credentials); store it immediately. Attach any number of numbers to a trunk. Several trunks may point at the same host — each carries its own credentials and spend cap, so separate destination workspaces (e.g. an agency's clients) stay isolated. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+create_sip_trunk_request = Zernio::CreateSipTrunkRequest.new({label: 'label_example', sip_host: 'sip_host_example'}) # CreateSipTrunkRequest | 
+
+begin
+  # Create a SIP trunk
+  result = api_instance.create_sip_trunk(create_sip_trunk_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->create_sip_trunk: #{e}"
+end
+```
+
+#### Using the create_sip_trunk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSipTrunk201Response>, Integer, Hash)> create_sip_trunk_with_http_info(create_sip_trunk_request)
+
+```ruby
+begin
+  # Create a SIP trunk
+  data, status_code, headers = api_instance.create_sip_trunk_with_http_info(create_sip_trunk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSipTrunk201Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->create_sip_trunk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_sip_trunk_request** | [**CreateSipTrunkRequest**](CreateSipTrunkRequest.md) |  |  |
+
+### Return type
+
+[**CreateSipTrunk201Response**](CreateSipTrunk201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_voice_call
 
 > <CreateVoiceCall200Response> create_voice_call(create_voice_call_request, opts)
@@ -156,6 +303,144 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## delete_sip_trunk
+
+> <DeleteSmsSenderId200Response> delete_sip_trunk(id)
+
+Delete a SIP trunk
+
+Tears down the trunk and its carrier-side objects. Refused while any number is still attached: detach them first. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete a SIP trunk
+  result = api_instance.delete_sip_trunk(id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->delete_sip_trunk: #{e}"
+end
+```
+
+#### Using the delete_sip_trunk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteSmsSenderId200Response>, Integer, Hash)> delete_sip_trunk_with_http_info(id)
+
+```ruby
+begin
+  # Delete a SIP trunk
+  data, status_code, headers = api_instance.delete_sip_trunk_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteSmsSenderId200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->delete_sip_trunk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**DeleteSmsSenderId200Response**](DeleteSmsSenderId200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## detach_number_from_sip_trunk
+
+> <DetachNumberFromSipTrunk200Response> detach_number_from_sip_trunk(id)
+
+Detach a number from its SIP trunk
+
+Returns the number's calls to Zernio routing. Idempotent when the number is not attached to any trunk. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+id = 'id_example' # String | 
+
+begin
+  # Detach a number from its SIP trunk
+  result = api_instance.detach_number_from_sip_trunk(id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->detach_number_from_sip_trunk: #{e}"
+end
+```
+
+#### Using the detach_number_from_sip_trunk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DetachNumberFromSipTrunk200Response>, Integer, Hash)> detach_number_from_sip_trunk_with_http_info(id)
+
+```ruby
+begin
+  # Detach a number from its SIP trunk
+  data, status_code, headers = api_instance.detach_number_from_sip_trunk_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DetachNumberFromSipTrunk200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->detach_number_from_sip_trunk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**DetachNumberFromSipTrunk200Response**](DetachNumberFromSipTrunk200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## dial_voice_web_call
 
 > <DialVoiceWebCall200Response> dial_voice_web_call(dial_voice_web_call_request)
@@ -436,6 +721,73 @@ end
 - **Accept**: application/json
 
 
+## get_sip_trunk
+
+> <GetSipTrunk200Response> get_sip_trunk(id)
+
+Get a SIP trunk
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a SIP trunk
+  result = api_instance.get_sip_trunk(id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->get_sip_trunk: #{e}"
+end
+```
+
+#### Using the get_sip_trunk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSipTrunk200Response>, Integer, Hash)> get_sip_trunk_with_http_info(id)
+
+```ruby
+begin
+  # Get a SIP trunk
+  data, status_code, headers = api_instance.get_sip_trunk_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSipTrunk200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->get_sip_trunk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetSipTrunk200Response**](GetSipTrunk200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_voice_call
 
 > <GetVoiceCall200Response> get_voice_call(id)
@@ -655,6 +1007,70 @@ end
 - **Accept**: application/json
 
 
+## list_sip_trunks
+
+> <ListSipTrunks200Response> list_sip_trunks
+
+List SIP trunks
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+
+begin
+  # List SIP trunks
+  result = api_instance.list_sip_trunks
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->list_sip_trunks: #{e}"
+end
+```
+
+#### Using the list_sip_trunks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSipTrunks200Response>, Integer, Hash)> list_sip_trunks_with_http_info
+
+```ruby
+begin
+  # List SIP trunks
+  data, status_code, headers = api_instance.list_sip_trunks_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSipTrunks200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->list_sip_trunks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListSipTrunks200Response**](ListSipTrunks200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_voice_calls
 
 > <ListVoiceCalls200Response> list_voice_calls(opts)
@@ -734,6 +1150,75 @@ end
 - **Accept**: application/json
 
 
+## rotate_sip_trunk_credentials
+
+> <RotateSipTrunkCredentials200Response> rotate_sip_trunk_credentials(id)
+
+Rotate a SIP trunk's password
+
+Mints a new digest password on the trunk. The old password stops working immediately, so update the destination platform right away. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::VoiceApi.new
+id = 'id_example' # String | 
+
+begin
+  # Rotate a SIP trunk's password
+  result = api_instance.rotate_sip_trunk_credentials(id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->rotate_sip_trunk_credentials: #{e}"
+end
+```
+
+#### Using the rotate_sip_trunk_credentials_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RotateSipTrunkCredentials200Response>, Integer, Hash)> rotate_sip_trunk_credentials_with_http_info(id)
+
+```ruby
+begin
+  # Rotate a SIP trunk's password
+  data, status_code, headers = api_instance.rotate_sip_trunk_credentials_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RotateSipTrunkCredentials200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling VoiceApi->rotate_sip_trunk_credentials_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**RotateSipTrunkCredentials200Response**](RotateSipTrunkCredentials200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## transfer_voice_call
 
 > <TransferVoiceCall200Response> transfer_voice_call(id, transfer_voice_call_request)