Class: Twilio::REST::Studio::V1::FlowList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FlowList

Initialize the FlowList



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 26

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

Instance Method Details

#each ⇒ Object

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



99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 99

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 FlowInstance records from the API. Request is executed immediately.



136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 136

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

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

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



46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 46

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

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

Lists FlowPageMetadata records from the API as a list.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 82

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    FlowPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 116

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

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

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



64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 64

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



147
148
149
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 147

def to_s
    '#<Twilio.Studio.V1.FlowList>'
end