Class: Telnyx::Resources::DocumentLinks

Inherits:

Object

• Object
• Telnyx::Resources::DocumentLinks

Defined in:

lib/telnyx/resources/document_links.rb

Instance Method Summary

• #initialize(client:) ⇒ DocumentLinks constructor private

  A new instance of DocumentLinks.

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

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

Constructor Details

#initialize(client:) ⇒ DocumentLinks

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

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/document_links.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

List all documents links ordered by created_at descending.

Parameters:

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

  Consolidated filter parameter for document links (deepObject style). Originally:

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

Returns:

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

See Also:

• Models::DocumentLinkListParams

# File 'lib/telnyx/resources/document_links.rb', line 24

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