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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/engagement.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) ⇒ EngagementList

Initialize the EngagementList



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

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



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

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

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

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

#each ⇒ Object

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.



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

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.



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.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# 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
  )
  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.



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_s ⇒ Object

Provide a user friendly representation



131
132
133
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 131

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