Class: Telnyx::Resources::MessagingURLDomains

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

Overview

Messaging URL Domains

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ MessagingURLDomains

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

Parameters:



35
36
37
 
# File 'lib/telnyx/resources/messaging_url_domains.rb', line 35

def initialize(client:)
  @client = client
end

Instance Method Details

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::MessagingURLDomainListResponse>

Returns the URL domains available to the authenticated account for message URL shortening.

Parameters:

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

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/telnyx/resources/messaging_url_domains.rb', line 19

def list(params = {})
  parsed, options = Telnyx::MessagingURLDomainListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "messaging_url_domains",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::MessagingURLDomainListResponse,
    options: options
  )
end