Class: Twilio::REST::Trusthub::V1::SupportingDocumentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SupportingDocumentList

Initialize the SupportingDocumentList

Parameters:

  • version (Version) —

    Version that contains the resource



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 25

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/SupportingDocuments"
    
end

Instance Method Details

#create(friendly_name: nil, type: nil, attributes: :unset) ⇒ SupportingDocumentInstance

Create the SupportingDocumentInstance

Parameters:

  • friendly_name (String) (defaults to: nil) —

    The string that you assigned to describe the resource.

  • type (String) (defaults to: nil) —

    The type of the Supporting Document.

  • attributes (Object) (defaults to: :unset) —

    The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 38

def create(
    friendly_name: nil, 
    type: nil, 
    attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Type' => type,
        'Attributes' => Twilio.serialize_object(attributes),
    })

    payload = @version.create('POST', @uri, data: data)
    SupportingDocumentInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

When passed a block, yields SupportingDocumentInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



100
101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 100

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of SupportingDocumentInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SupportingDocumentInstance



134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 134

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
SupportingDocumentPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists SupportingDocumentInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 69

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SupportingDocumentInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of SupportingDocumentInstance



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 117

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    SupportingDocumentPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 87

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



145
146
147
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 145

def to_s
    '#<Twilio.Trusthub.V1.SupportingDocumentList>'
end