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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid: nil) ⇒ ExecutionList

Initialize the ExecutionList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Flow.



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 22

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

Parameters:

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

    The Contact phone number to start a Studio Flow Execution, available as variable ‘Twilio::REST::Studio::V2::FlowContext::ExecutionList.{contact{contact.channel{contact.channel.address}`.

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

    The Twilio phone number to send messages or initiate calls from during the Flow’s Execution. Available as variable ‘Twilio::REST::Studio::V2::FlowContext::ExecutionList.{flow{flow.channel{flow.channel.address}`.

  • parameters (Hash) (defaults to: :unset) —

    JSON data that will be added to the Flow’s context and that can be accessed as variables inside your Flow. For example, if you pass in ‘Parameters=“name”:“Zeke”`, a widget in your Flow can reference the variable `Twilio::REST::Studio::V2::FlowContext::ExecutionList.{flow{flow.data{flow.data.name}`, which returns “Zeke”. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.

Returns:



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 153

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

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

  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.



89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 89

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ExecutionInstance



131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 131

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.

Parameters:

  • date_created_from (Time) (defaults to: :unset) —

    Only show Execution resources starting on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • date_created_to (Time) (defaults to: :unset) —

    Only show Execution resources starting before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • 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



47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 47

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.

Parameters:

  • date_created_from (Time) (defaults to: :unset) —

    Only show Execution resources starting on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • date_created_to (Time) (defaults to: :unset) —

    Only show Execution resources starting before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • 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 ExecutionInstance



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

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 ExecutionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • date_created_from (Time) (defaults to: :unset) —

    Only show Execution resources starting on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • date_created_to (Time) (defaults to: :unset) —

    Only show Execution resources starting before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

  • 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



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

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



167
168
169
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 167

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