Class: Telnyx::Resources::UserTags

Inherits:

Object

Object
Telnyx::Resources::UserTags

show all

Defined in:: lib/telnyx/resources/user_tags.rb,
sig/telnyx/resources/user_tags.rbs

Overview

User-defined tags for Telnyx resources

Instance Method Summary collapse

#initialize(client:) ⇒ UserTags constructor private
A new instance of UserTags.
#list(filter: nil, request_options: {}) ⇒ Telnyx::Models::UserTagListResponse
Some parameter documentations has been truncated, see Models::UserTagListParams for more details.

Constructor Details

#initialize(client:) ⇒ `UserTags`

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

Parameters:

client (Telnyx::Client)
client: (Telnyx::Client)



37
38
39

# File 'lib/telnyx/resources/user_tags.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, request_options: {}) ⇒ `Telnyx::Models::UserTagListResponse`

Some parameter documentations has been truncated, see Models::UserTagListParams for more details.

Returns the user tags defined on your account, with support for filtering. Tags help organize resources such as phone numbers.

Parameters:

filter (Telnyx::Models::UserTagListParams::Filter) —
Consolidated filter parameter (deepObject style). Originally: filter[starts_with
request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

(Telnyx::Models::UserTagListResponse)

See Also:

Models::UserTagListParams

# File 'lib/telnyx/resources/user_tags.rb', line 22

def list(params = {})
  parsed, options = Telnyx::UserTagListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "user_tags",
    query: query,
    model: Telnyx::Models::UserTagListResponse,
    options: options
  )
end