Class: Telnyx::Resources::DocumentLinks

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

Overview

Documents

Instance Method Summary collapse

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:



41
42
43
 
# File 'lib/telnyx/resources/document_links.rb', line 41

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:

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/telnyx/resources/document_links.rb', line 25

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