Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelContext::InteractionChannelInviteList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, interaction_sid: nil, channel_sid: nil) ⇒ InteractionChannelInviteList

Initialize the InteractionChannelInviteList



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 29

def initialize(version, interaction_sid: nil, channel_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { interaction_sid: interaction_sid, channel_sid: channel_sid }
    @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:channel_sid]}/Invites"
    
end

Instance Method Details

#create(routing: nil) ⇒ InteractionChannelInviteInstance

Create the InteractionChannelInviteInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 41

def create(
    routing: nil
)

    data = Twilio::Values.of({
        'Routing' => Twilio.serialize_object(routing),
    })

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

#create_with_metadata(routing: nil) ⇒ InteractionChannelInviteInstance

Create the InteractionChannelInviteInstanceMetadata



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 68

def create_with_metadata(
  routing: nil
)

    data = Twilio::Values.of({
        'Routing' => Twilio.serialize_object(routing),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    interaction_channel_invite_instance = InteractionChannelInviteInstance.new(
        @version,
        response.body,
        interaction_sid: @solution[:interaction_sid],
        channel_sid: @solution[:channel_sid],
    )
    InteractionChannelInviteInstanceMetadata.new(
        @version,
        interaction_channel_invite_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



162
163
164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 162

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



199
200
201
202
203
204
205
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 199

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

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

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



109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 109

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



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 145

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)

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

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

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 179

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)

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



127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 127

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



210
211
212
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb', line 210

def to_s
    '#<Twilio.FlexApi.V1.InteractionChannelInviteList>'
end