Class: Telnyx::Resources::Whatsapp::UserData

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/whatsapp/user_data.rb,
sig/telnyx/resources/whatsapp/user_data.rbs

Overview

Manage Whatsapp business accounts

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ UserData

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 UserData.

Parameters:



55
56
57
 
# File 'lib/telnyx/resources/whatsapp/user_data.rb', line 55

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Telnyx::Models::Whatsapp::UserDataRetrieveResponse

Returns the WhatsApp user-data settings associated with the authenticated Telnyx account.

Parameters:

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/telnyx/resources/whatsapp/user_data.rb', line 18

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "v2/whatsapp/user_data",
    model: Telnyx::Models::Whatsapp::UserDataRetrieveResponse,
    options: params[:request_options]
  )
end

#update(webhook_failover_url: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::Whatsapp::UserDataUpdateResponse

Updates the supplied WhatsApp user-data settings for the authenticated Telnyx account.

Parameters:

  • webhook_failover_url (String) —

    Failover URL to send Whatsapp signup events

  • webhook_url (String) —

    URL to send Whatsapp signup events

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

Returns:

See Also:



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

def update(params = {})
  parsed, options = Telnyx::Whatsapp::UserDataUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: "v2/whatsapp/user_data",
    body: parsed,
    model: Telnyx::Models::Whatsapp::UserDataUpdateResponse,
    options: options
  )
end