Class: Twilio::REST::Studio::V2::FlowContext::ExecutionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/execution.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid: nil) ⇒ ExecutionList

Initialize the ExecutionList



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 28

def initialize(version, flow_sid: nil)
    super(version)
    # Path Solution
    @solution = { flow_sid: flow_sid }
    @uri = "/Flows/#{@solution[:flow_sid]}/Executions"
    
end

Instance Method Details

#create(to: nil, from: nil, parameters: :unset) ⇒ ExecutionInstance

Create the ExecutionInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 41

def create(
    to: nil, 
    from: nil, 
    parameters: :unset
)

    data = Twilio::Values.of({
        'To' => to,
        'From' => from,
        'Parameters' => Twilio.serialize_object(parameters),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ExecutionInstance.new(
        @version,
        payload,
        flow_sid: @solution[:flow_sid],
    )
end

#each ⇒ Object

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



114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 114

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



152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 152

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

#list(date_created_from: :unset, date_created_to: :unset, limit: nil, page_size: nil) ⇒ Array

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



77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 77

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

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

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



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 133

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

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

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

#stream(date_created_from: :unset, date_created_to: :unset, 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.



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

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

    page = self.page(
        date_created_from: date_created_from,
        date_created_to: date_created_to,
        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



163
164
165
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 163

def to_s
    '#<Twilio.Studio.V2.ExecutionList>'
end