Class: Telnyx::Resources::ExternalConnections::LogMessages

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/external_connections/log_messages.rb

Overview

External Connections operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LogMessages

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

Parameters:



83
84
85
 
# File 'lib/telnyx/resources/external_connections/log_messages.rb', line 83

def initialize(client:)
  @client = client
end

Instance Method Details

#dismiss(id, request_options: {}) ⇒ Telnyx::Models::ExternalConnections::LogMessageDismissResponse

Dismiss a log message for an external connection associated with your account.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



71
72
73
74
75
76
77
78
 
# File 'lib/telnyx/resources/external_connections/log_messages.rb', line 71

def dismiss(id, params = {})
  @client.request(
    method: :delete,
    path: ["external_connections/log_messages/%1$s", id],
    model: Telnyx::Models::ExternalConnections::LogMessageDismissResponse,
    options: params[:request_options]
  )
end

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultPaginationForLogMessages<Telnyx::Models::ExternalConnections::LogMessageListResponse>

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

Retrieve a list of log messages for all external connections associated with your account.

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/telnyx/resources/external_connections/log_messages.rb', line 47

def list(params = {})
  parsed, options = Telnyx::ExternalConnections::LogMessageListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "external_connections/log_messages",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultPaginationForLogMessages,
    model: Telnyx::Models::ExternalConnections::LogMessageListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::ExternalConnections::LogMessageRetrieveResponse

Retrieve a log message for an external connection associated with your account.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/telnyx/resources/external_connections/log_messages.rb', line 19

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["external_connections/log_messages/%1$s", id],
    model: Telnyx::Models::ExternalConnections::LogMessageRetrieveResponse,
    options: params[:request_options]
  )
end