Class: Twilio::REST::Conversations::V1::ConversationContext::ParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 28

def initialize(version, conversation_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { conversation_sid: conversation_sid }
    @uri = "/Conversations/#{@solution[:conversation_sid]}/Participants"
    
end

Instance Method Details

#create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ParticipantInstance

Create the ParticipantInstance



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 48

def create(
    identity: :unset, 
    messaging_binding_address: :unset, 
    messaging_binding_proxy_address: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    messaging_binding_projected_address: :unset, 
    role_sid: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'Identity' => identity,
        'MessagingBinding.Address' => messaging_binding_address,
        'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
        'RoleSid' => role_sid,
    })

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

#create_with_metadata(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ParticipantInstance

Create the ParticipantInstanceMetadata



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 97

def create_with_metadata(
  identity: :unset, 
  messaging_binding_address: :unset, 
  messaging_binding_proxy_address: :unset, 
  date_created: :unset, 
  date_updated: :unset, 
  attributes: :unset, 
  messaging_binding_projected_address: :unset, 
  role_sid: :unset, 
  x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'Identity' => identity,
        'MessagingBinding.Address' => messaging_binding_address,
        'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
        'RoleSid' => role_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    participant_instance = ParticipantInstance.new(
        @version,
        response.body,
        conversation_sid: @solution[:conversation_sid],
    )
    ParticipantInstanceMetadata.new(
        @version,
        participant_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 205

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



242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 242

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

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

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



152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 152

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 ParticipantPageMetadata records from the API as a list.



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 188

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)

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

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

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 222

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)

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



170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 170

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



253
254
255
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 253

def to_s
    '#<Twilio.Conversations.V1.ParticipantList>'
end