Class: Telnyx::Resources::AuditEvents

Inherits:

Object

• Object
• Telnyx::Resources::AuditEvents

Defined in:

lib/telnyx/resources/audit_events.rb

Overview

Audit log operations.

Instance Method Summary

• #initialize(client:) ⇒ AuditEvents constructor private

  A new instance of AuditEvents.

• #list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AuditEventListResponse>

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

Constructor Details

#initialize(client:) ⇒ AuditEvents

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

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/audit_events.rb', line 44

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes.

Parameters:

• filter (Telnyx::Models::AuditEventListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter[created_bef

• page_number (Integer)
• page_size (Integer)
• sort (Symbol, Telnyx::Models::AuditEventListParams::Sort) —

  Set the order of the results by the creation date.

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

Returns:

• (Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AuditEventListResponse>)

See Also:

• Models::AuditEventListParams

# File 'lib/telnyx/resources/audit_events.rb', line 28

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