Class: Telnyx::Resources::Whatsapp::PhoneNumbers::CallingSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb

Overview

Manage Whatsapp phone numbers

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CallingSettings

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CallingSettings.

Parameters:



56
57
58
 
# File 'lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb', line 56

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(phone_number, request_options: {}) ⇒ Telnyx::Models::Whatsapp::PhoneNumbers::CallingSettingRetrieveResponse

Get calling settings for a phone number

Parameters:

  • phone_number (String) —

    Phone number (E.164 format)

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb', line 20

def retrieve(phone_number, params = {})
  @client.request(
    method: :get,
    path: ["v2/whatsapp/phone_numbers/%1$s/calling_settings", phone_number],
    model: Telnyx::Models::Whatsapp::PhoneNumbers::CallingSettingRetrieveResponse,
    options: params[:request_options]
  )
end

#update(phone_number, enabled:, request_options: {}) ⇒ Telnyx::Models::Whatsapp::PhoneNumbers::CallingSettingUpdateResponse

Enable or disable Whatsapp calling for a phone number

Parameters:

  • phone_number (String) —

    Phone number (E.164 format)

  • enabled (Boolean)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb', line 42

def update(phone_number, params)
  parsed, options = Telnyx::Whatsapp::PhoneNumbers::CallingSettingUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v2/whatsapp/phone_numbers/%1$s/calling_settings", phone_number],
    body: parsed,
    model: Telnyx::Models::Whatsapp::PhoneNumbers::CallingSettingUpdateResponse,
    options: options
  )
end