Class: Twilio::REST::Studio::V1::FlowContext::EngagementList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid: nil) ⇒ EngagementList

Initialize the EngagementList

Parameters:

  • version (Version)

    Version that contains the resource

  • flow_sid (String) (defaults to: nil)

    The SID of the Flow.


20
21
22
23
24
25
26
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 20

def initialize(version, flow_sid: nil)
  super(version)

  # Path Solution
  @solution = {flow_sid: flow_sid}
  @uri = "/Flows/#{@solution[:flow_sid]}/Engagements"
end

Instance Method Details

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

Create the EngagementInstance

Parameters:

  • to (String) (defaults to: nil)

    The Contact phone number to start a Studio Flow Engagement, available as variable `Twilio::REST::Studio::V1::FlowContext::EngagementList.{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 Engagement. Available as variable `Twilio::REST::Studio::V1::FlowContext::EngagementList.{flow{flow.channel{flow.channel.address}`

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

    A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters='name':'Zeke'` then inside a widget you can reference the variable `Twilio::REST::Studio::V1::FlowContext::EngagementList.{flow{flow.data{flow.data.name}` which will return the string '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 your JSON string.

Returns:


123
124
125
126
127
128
129
130
131
132
133
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 123

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)

  EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
end

#eachObject

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


66
67
68
69
70
71
72
73
74
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 66

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

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of EngagementInstance


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

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

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

Lists EngagementInstance 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


39
40
41
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 39

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 EngagementInstance 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 EngagementInstance


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

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)

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

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

Streams EngagementInstance 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


54
55
56
57
58
59
60
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 54

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_sObject

Provide a user friendly representation


137
138
139
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 137

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