zernio-sdk 0.0.620 → 0.0.621

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfc0d84231d1ffa546bbe77fd562c98e3b7ab2bc8ed46c62e2d1ec30ad1a66c
-  data.tar.gz: 790435d67bb5a058c08812a011aca6310d8f00f800339f3e4b0b5e646426ebc8
+  metadata.gz: 0c9db4f09edf26d95f63f75a133d52beccee2bd2fd4857a2a46b3b85514ee0ba
+  data.tar.gz: 1ebb55ed871c2949b9eb8ed1c9c88839a92fa739107c79aa4544620863891700
 SHA512:
-  metadata.gz: 456376164b0713502318a93b95268c86d77957d90e9686455f06cd8c45acb5287d5bd4affdb77376cc621d47233004be1eef0edf3b936b05ecf7046f6d68730d
-  data.tar.gz: 80d60a5d8b1c16b9cd8e3b42d77856bc77c91905bd2ee97f740e333a020a6c169720abb7685ab7d61817aedddbc693ccced4a651de582caab0d465178bd7aa9a
+  metadata.gz: 137b1c72c30ec88401fb645802620f292482438d8394115844dc0cf973842f53f37d4d04cecb3f1114cfedfeb42f95b783f8f38e162bf5a08196e93e8af87713
+  data.tar.gz: c59bda91be19462a686a47c6795fc038aac5ea3ad0745361f817ad4683b2b4034d7bde32e5acb7e43d8e64355fbe247fdb6f6899de25469b0ec68ed5ca6407ac

data/README.md

@@ -546,8 +546,10 @@ Class | Method | HTTP request | Description
 *Zernio::WhatsAppCallingApi* | [**get_whats_app_calling_config**](docs/WhatsAppCallingApi.md#get_whats_app_calling_config) | **GET** /v1/whatsapp/calling | Get calling config for an account
 *Zernio::WhatsAppCallingApi* | [**initiate_whats_app_call**](docs/WhatsAppCallingApi.md#initiate_whats_app_call) | **POST** /v1/whatsapp/calls | Initiate outbound call
 *Zernio::WhatsAppCallingApi* | [**list_whats_app_calls**](docs/WhatsAppCallingApi.md#list_whats_app_calls) | **GET** /v1/whatsapp/calls | List call history for an account
+*Zernio::WhatsAppCallingApi* | [**start_whats_app_caller_id_verification**](docs/WhatsAppCallingApi.md#start_whats_app_caller_id_verification) | **POST** /v1/phone-numbers/{id}/whatsapp/caller-id-verification | Start caller-ID verification for a customer-brought number
 *Zernio::WhatsAppCallingApi* | [**update_whats_app_calling**](docs/WhatsAppCallingApi.md#update_whats_app_calling) | **PATCH** /v1/phone-numbers/{id}/whatsapp/calling | Update calling config
 *Zernio::WhatsAppCallingApi* | [**update_whats_app_calling_legacy**](docs/WhatsAppCallingApi.md#update_whats_app_calling_legacy) | **PATCH** /v1/whatsapp/phone-numbers/{id}/calling | Update calling config
+*Zernio::WhatsAppCallingApi* | [**verify_whats_app_caller_id**](docs/WhatsAppCallingApi.md#verify_whats_app_caller_id) | **POST** /v1/phone-numbers/{id}/whatsapp/caller-id-verification/verify | Confirm the caller-ID verification code
 *Zernio::WhatsAppFlowsApi* | [**create_whats_app_flow**](docs/WhatsAppFlowsApi.md#create_whats_app_flow) | **POST** /v1/whatsapp/flows | Create flow
 *Zernio::WhatsAppFlowsApi* | [**delete_whats_app_flow**](docs/WhatsAppFlowsApi.md#delete_whats_app_flow) | **DELETE** /v1/whatsapp/flows/{flowId} | Delete flow
 *Zernio::WhatsAppFlowsApi* | [**deprecate_whats_app_flow**](docs/WhatsAppFlowsApi.md#deprecate_whats_app_flow) | **POST** /v1/whatsapp/flows/{flowId}/deprecate | Deprecate flow
@@ -1803,6 +1805,8 @@ Class | Method | HTTP request | Description
  - [Zernio::StartSmsRegistrationRequestBrand](docs/StartSmsRegistrationRequestBrand.md)
  - [Zernio::StartSmsRegistrationRequestCampaign](docs/StartSmsRegistrationRequestCampaign.md)
  - [Zernio::StartSmsRegistrationRequestTollFree](docs/StartSmsRegistrationRequestTollFree.md)
+ - [Zernio::StartWhatsAppCallerIdVerification200Response](docs/StartWhatsAppCallerIdVerification200Response.md)
+ - [Zernio::StartWhatsAppCallerIdVerificationRequest](docs/StartWhatsAppCallerIdVerificationRequest.md)
  - [Zernio::SubmitPhoneNumberKyc200Response](docs/SubmitPhoneNumberKyc200Response.md)
  - [Zernio::SubmitPhoneNumberKyc200ResponseNumbersInner](docs/SubmitPhoneNumberKyc200ResponseNumbersInner.md)
  - [Zernio::SubmitPhoneNumberKyc200ResponsePhoneNumber](docs/SubmitPhoneNumberKyc200ResponsePhoneNumber.md)
@@ -2030,6 +2034,7 @@ Class | Method | HTTP request | Description
  - [Zernio::Verification](docs/Verification.md)
  - [Zernio::VerifySmsRegistrationOtp200Response](docs/VerifySmsRegistrationOtp200Response.md)
  - [Zernio::VerifySmsRegistrationOtpRequest](docs/VerifySmsRegistrationOtpRequest.md)
+ - [Zernio::VerifyWhatsAppCallerIdRequest](docs/VerifyWhatsAppCallerIdRequest.md)
  - [Zernio::VoteRedditThingRequest](docs/VoteRedditThingRequest.md)
  - [Zernio::Webhook](docs/Webhook.md)
  - [Zernio::WebhookLog](docs/WebhookLog.md)

data/docs/GetWhatsAppCallingConfig200Response.md

@@ -13,6 +13,8 @@
 | **sip_auth_username** | **String** |  | [optional] |
 | **sip_auth_password_configured** | **Boolean** | True when a SIP digest password is stored. The plaintext is never returned. | [optional] |
 | **call_icon_countries** | **Array<String>** |  | [optional] |
+| **caller_id_mode** | **String** | Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID; verify via /v1/phone-numbers/{id}/whatsapp/caller-id-verification). | [optional] |
+| **caller_id_verified** | **Boolean** | True once the number completed caller-ID verification. | [optional] |
 
 ## Example
 
@@ -28,7 +30,9 @@ instance = Zernio::GetWhatsAppCallingConfig200Response.new(
   recording_enabled: null,
   sip_auth_username: null,
   sip_auth_password_configured: null,
-  call_icon_countries: null
+  call_icon_countries: null,
+  caller_id_mode: null,
+  caller_id_verified: null
 )
 ```
 

data/docs/StartWhatsAppCallerIdVerification200Response.md

@@ -0,0 +1,22 @@
+# Zernio::StartWhatsAppCallerIdVerification200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verified** | **Boolean** |  | [optional] |
+| **code_sent** | **Boolean** |  | [optional] |
+| **method** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::StartWhatsAppCallerIdVerification200Response.new(
+  verified: null,
+  code_sent: null,
+  method: null
+)
+```
+

data/docs/StartWhatsAppCallerIdVerificationRequest.md

@@ -0,0 +1,18 @@
+# Zernio::StartWhatsAppCallerIdVerificationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  | [optional][default to 'sms'] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::StartWhatsAppCallerIdVerificationRequest.new(
+  method: null
+)
+```
+

data/docs/VerifyWhatsAppCallerIdRequest.md

@@ -0,0 +1,18 @@
+# Zernio::VerifyWhatsAppCallerIdRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::VerifyWhatsAppCallerIdRequest.new(
+  code: null
+)
+```
+

data/docs/WhatsAppCallingApi.md

@@ -16,8 +16,10 @@ All URIs are relative to *https://zernio.com/api*
 | [**get_whats_app_calling_config**](WhatsAppCallingApi.md#get_whats_app_calling_config) | **GET** /v1/whatsapp/calling | Get calling config for an account |
 | [**initiate_whats_app_call**](WhatsAppCallingApi.md#initiate_whats_app_call) | **POST** /v1/whatsapp/calls | Initiate outbound call |
 | [**list_whats_app_calls**](WhatsAppCallingApi.md#list_whats_app_calls) | **GET** /v1/whatsapp/calls | List call history for an account |
+| [**start_whats_app_caller_id_verification**](WhatsAppCallingApi.md#start_whats_app_caller_id_verification) | **POST** /v1/phone-numbers/{id}/whatsapp/caller-id-verification | Start caller-ID verification for a customer-brought number |
 | [**update_whats_app_calling**](WhatsAppCallingApi.md#update_whats_app_calling) | **PATCH** /v1/phone-numbers/{id}/whatsapp/calling | Update calling config |
 | [**update_whats_app_calling_legacy**](WhatsAppCallingApi.md#update_whats_app_calling_legacy) | **PATCH** /v1/whatsapp/phone-numbers/{id}/calling | Update calling config |
+| [**verify_whats_app_caller_id**](WhatsAppCallingApi.md#verify_whats_app_caller_id) | **POST** /v1/phone-numbers/{id}/whatsapp/caller-id-verification/verify | Confirm the caller-ID verification code |
 
 
 ## disable_whats_app_calling
@@ -888,6 +890,79 @@ end
 - **Accept**: application/json
 
 
+## start_whats_app_caller_id_verification
+
+> <StartWhatsAppCallerIdVerification200Response> start_whats_app_caller_id_verification(id, opts)
+
+Start caller-ID verification for a customer-brought number
+
+Customer-brought (BYO) WhatsApp numbers cannot present themselves as caller ID on `tel:` call forwards until verified (carrier anti-spoofing); until then forwarded calls show a Zernio number (`callerIdMode: platform` on the calling config). This sends a one-time code to the number by SMS or voice call. Re-POST to resend. Zernio-purchased numbers never need this and get a 400. 
+
+### 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::WhatsAppCallingApi.new
+id = 'id_example' # String | Phone number record ID (from GET /v1/phone-numbers).
+opts = {
+  start_whats_app_caller_id_verification_request: Zernio::StartWhatsAppCallerIdVerificationRequest.new # StartWhatsAppCallerIdVerificationRequest | 
+}
+
+begin
+  # Start caller-ID verification for a customer-brought number
+  result = api_instance.start_whats_app_caller_id_verification(id, opts)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppCallingApi->start_whats_app_caller_id_verification: #{e}"
+end
+```
+
+#### Using the start_whats_app_caller_id_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<StartWhatsAppCallerIdVerification200Response>, Integer, Hash)> start_whats_app_caller_id_verification_with_http_info(id, opts)
+
+```ruby
+begin
+  # Start caller-ID verification for a customer-brought number
+  data, status_code, headers = api_instance.start_whats_app_caller_id_verification_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StartWhatsAppCallerIdVerification200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppCallingApi->start_whats_app_caller_id_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Phone number record ID (from GET /v1/phone-numbers). |  |
+| **start_whats_app_caller_id_verification_request** | [**StartWhatsAppCallerIdVerificationRequest**](StartWhatsAppCallerIdVerificationRequest.md) |  | [optional] |
+
+### Return type
+
+[**StartWhatsAppCallerIdVerification200Response**](StartWhatsAppCallerIdVerification200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_whats_app_calling
 
 > update_whats_app_calling(id, update_whats_app_calling_legacy_request)
@@ -1027,3 +1102,74 @@ nil (empty response body)
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## verify_whats_app_caller_id
+
+> <VerifySmsRegistrationOtp200Response> verify_whats_app_caller_id(id, verify_whats_app_caller_id_request)
+
+Confirm the caller-ID verification code
+
+Submits the one-time code the number received. On success, `tel:` call forwards present the business number itself as caller ID (`callerIdMode: business`). 
+
+### 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::WhatsAppCallingApi.new
+id = 'id_example' # String | Phone number record ID (from GET /v1/phone-numbers).
+verify_whats_app_caller_id_request = Zernio::VerifyWhatsAppCallerIdRequest.new({code: 'code_example'}) # VerifyWhatsAppCallerIdRequest | 
+
+begin
+  # Confirm the caller-ID verification code
+  result = api_instance.verify_whats_app_caller_id(id, verify_whats_app_caller_id_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppCallingApi->verify_whats_app_caller_id: #{e}"
+end
+```
+
+#### Using the verify_whats_app_caller_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifySmsRegistrationOtp200Response>, Integer, Hash)> verify_whats_app_caller_id_with_http_info(id, verify_whats_app_caller_id_request)
+
+```ruby
+begin
+  # Confirm the caller-ID verification code
+  data, status_code, headers = api_instance.verify_whats_app_caller_id_with_http_info(id, verify_whats_app_caller_id_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifySmsRegistrationOtp200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppCallingApi->verify_whats_app_caller_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Phone number record ID (from GET /v1/phone-numbers). |  |
+| **verify_whats_app_caller_id_request** | [**VerifyWhatsAppCallerIdRequest**](VerifyWhatsAppCallerIdRequest.md) |  |  |
+
+### Return type
+
+[**VerifySmsRegistrationOtp200Response**](VerifySmsRegistrationOtp200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/lib/zernio-sdk/api/whats_app_calling_api.rb

@@ -908,6 +908,76 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Start caller-ID verification for a customer-brought number
+    # Customer-brought (BYO) WhatsApp numbers cannot present themselves as caller ID on `tel:` call forwards until verified (carrier anti-spoofing); until then forwarded calls show a Zernio number (`callerIdMode: platform` on the calling config). This sends a one-time code to the number by SMS or voice call. Re-POST to resend. Zernio-purchased numbers never need this and get a 400. 
+    # @param id [String] Phone number record ID (from GET /v1/phone-numbers).
+    # @param [Hash] opts the optional parameters
+    # @option opts [StartWhatsAppCallerIdVerificationRequest] :start_whats_app_caller_id_verification_request 
+    # @return [StartWhatsAppCallerIdVerification200Response]
+    def start_whats_app_caller_id_verification(id, opts = {})
+      data, _status_code, _headers = start_whats_app_caller_id_verification_with_http_info(id, opts)
+      data
+    end
+
+    # Start caller-ID verification for a customer-brought number
+    # Customer-brought (BYO) WhatsApp numbers cannot present themselves as caller ID on `tel:` call forwards until verified (carrier anti-spoofing); until then forwarded calls show a Zernio number (`callerIdMode: platform` on the calling config). This sends a one-time code to the number by SMS or voice call. Re-POST to resend. Zernio-purchased numbers never need this and get a 400. 
+    # @param id [String] Phone number record ID (from GET /v1/phone-numbers).
+    # @param [Hash] opts the optional parameters
+    # @option opts [StartWhatsAppCallerIdVerificationRequest] :start_whats_app_caller_id_verification_request 
+    # @return [Array<(StartWhatsAppCallerIdVerification200Response, Integer, Hash)>] StartWhatsAppCallerIdVerification200Response data, response status code and response headers
+    def start_whats_app_caller_id_verification_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhatsAppCallingApi.start_whats_app_caller_id_verification ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling WhatsAppCallingApi.start_whats_app_caller_id_verification"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/{id}/whatsapp/caller-id-verification'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'start_whats_app_caller_id_verification_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'StartWhatsAppCallerIdVerification200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WhatsAppCallingApi.start_whats_app_caller_id_verification",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhatsAppCallingApi#start_whats_app_caller_id_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update calling config
     # Update fields on an already-enabled number. Only fields present in the body are written; `undefined` leaves the stored value alone, explicit `null` clears a nullable field. No Meta side effect, this only changes local routing state consumed by the Telnyx webhook handler. 
     # @param id [String] 
@@ -1055,5 +1125,79 @@ module Zernio
       end
       return data, status_code, headers
     end
+
+    # Confirm the caller-ID verification code
+    # Submits the one-time code the number received. On success, `tel:` call forwards present the business number itself as caller ID (`callerIdMode: business`). 
+    # @param id [String] Phone number record ID (from GET /v1/phone-numbers).
+    # @param verify_whats_app_caller_id_request [VerifyWhatsAppCallerIdRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifySmsRegistrationOtp200Response]
+    def verify_whats_app_caller_id(id, verify_whats_app_caller_id_request, opts = {})
+      data, _status_code, _headers = verify_whats_app_caller_id_with_http_info(id, verify_whats_app_caller_id_request, opts)
+      data
+    end
+
+    # Confirm the caller-ID verification code
+    # Submits the one-time code the number received. On success, &#x60;tel:&#x60; call forwards present the business number itself as caller ID (&#x60;callerIdMode: business&#x60;). 
+    # @param id [String] Phone number record ID (from GET /v1/phone-numbers).
+    # @param verify_whats_app_caller_id_request [VerifyWhatsAppCallerIdRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifySmsRegistrationOtp200Response, Integer, Hash)>] VerifySmsRegistrationOtp200Response data, response status code and response headers
+    def verify_whats_app_caller_id_with_http_info(id, verify_whats_app_caller_id_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhatsAppCallingApi.verify_whats_app_caller_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling WhatsAppCallingApi.verify_whats_app_caller_id"
+      end
+      # verify the required parameter 'verify_whats_app_caller_id_request' is set
+      if @api_client.config.client_side_validation && verify_whats_app_caller_id_request.nil?
+        fail ArgumentError, "Missing the required parameter 'verify_whats_app_caller_id_request' when calling WhatsAppCallingApi.verify_whats_app_caller_id"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/{id}/whatsapp/caller-id-verification/verify'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(verify_whats_app_caller_id_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'VerifySmsRegistrationOtp200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WhatsAppCallingApi.verify_whats_app_caller_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhatsAppCallingApi#verify_whats_app_caller_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/zernio-sdk/models/get_whats_app_calling_config200_response.rb

@@ -37,6 +37,34 @@ module Zernio
 
     attr_accessor :call_icon_countries
 
+    # Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID; verify via /v1/phone-numbers/{id}/whatsapp/caller-id-verification).
+    attr_accessor :caller_id_mode
+
+    # True once the number completed caller-ID verification.
+    attr_accessor :caller_id_verified
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +76,9 @@ module Zernio
         :'recording_enabled' => :'recordingEnabled',
         :'sip_auth_username' => :'sipAuthUsername',
         :'sip_auth_password_configured' => :'sipAuthPasswordConfigured',
-        :'call_icon_countries' => :'callIconCountries'
+        :'call_icon_countries' => :'callIconCountries',
+        :'caller_id_mode' => :'callerIdMode',
+        :'caller_id_verified' => :'callerIdVerified'
       }
     end
 
@@ -73,7 +103,9 @@ module Zernio
         :'recording_enabled' => :'Boolean',
         :'sip_auth_username' => :'String',
         :'sip_auth_password_configured' => :'Boolean',
-        :'call_icon_countries' => :'Array<String>'
+        :'call_icon_countries' => :'Array<String>',
+        :'caller_id_mode' => :'String',
+        :'caller_id_verified' => :'Boolean'
       }
     end
 
@@ -83,7 +115,7 @@ module Zernio
         :'call_deep_link',
         :'forward_to',
         :'sip_auth_username',
-        :'call_icon_countries'
+        :'call_icon_countries',
       ])
     end
 
@@ -140,6 +172,14 @@ module Zernio
           self.call_icon_countries = value
         end
       end
+
+      if attributes.key?(:'caller_id_mode')
+        self.caller_id_mode = attributes[:'caller_id_mode']
+      end
+
+      if attributes.key?(:'caller_id_verified')
+        self.caller_id_verified = attributes[:'caller_id_verified']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -154,9 +194,21 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      caller_id_mode_validator = EnumAttributeValidator.new('String', ["business", "platform"])
+      return false unless caller_id_mode_validator.valid?(@caller_id_mode)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] caller_id_mode Object to be assigned
+    def caller_id_mode=(caller_id_mode)
+      validator = EnumAttributeValidator.new('String', ["business", "platform"])
+      unless validator.valid?(caller_id_mode)
+        fail ArgumentError, "invalid value for \"caller_id_mode\", must be one of #{validator.allowable_values}."
+      end
+      @caller_id_mode = caller_id_mode
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -170,7 +222,9 @@ module Zernio
           recording_enabled == o.recording_enabled &&
           sip_auth_username == o.sip_auth_username &&
           sip_auth_password_configured == o.sip_auth_password_configured &&
-          call_icon_countries == o.call_icon_countries
+          call_icon_countries == o.call_icon_countries &&
+          caller_id_mode == o.caller_id_mode &&
+          caller_id_verified == o.caller_id_verified
     end
 
     # @see the `==` method
@@ -182,7 +236,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number_doc_id, phone_number, calling_enabled, call_deep_link, forward_to, recording_enabled, sip_auth_username, sip_auth_password_configured, call_icon_countries].hash
+      [phone_number_doc_id, phone_number, calling_enabled, call_deep_link, forward_to, recording_enabled, sip_auth_username, sip_auth_password_configured, call_icon_countries, caller_id_mode, caller_id_verified].hash
     end
 
     # Builds the object from hash