Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::InviteList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, channel_sid: nil) ⇒ InviteList

Initialize the InviteList

Parameters:

  • Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 29

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

Instance Method Details

#create(identity: nil, role_sid: :unset) ⇒ InviteInstance

Create the InviteInstance

Parameters:

  • (defaults to: nil)
  • (defaults to: :unset)

Returns:

  • Created InviteInstance



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 42

def create(
    identity: nil, 
    role_sid: :unset
)

    data = Twilio::Values.of({
        'Identity' => identity,
        'RoleSid' => role_sid,
    })

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

#create_with_metadata(identity: nil, role_sid: :unset) ⇒ InviteInstance

Create the InviteInstanceMetadata

Parameters:

  • (defaults to: nil)
  • (defaults to: :unset)

Returns:

  • Created InviteInstance



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 72

def create_with_metadata(
  identity: nil, 
  role_sid: :unset
)

    data = Twilio::Values.of({
        'Identity' => identity,
        'RoleSid' => role_sid,
    })

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

#each ⇒ Object

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



175
176
177
178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 175

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

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of InviteInstance



215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 215

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

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

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

Parameters:

  • (defaults to: :unset)
  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 116

def list(identity: :unset, limit: nil, page_size: nil)
    self.stream(
        identity: identity,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(identity: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 156

def list_with_metadata(identity: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'Identity' =>  Twilio.serialize_list(identity) { |e| e },
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

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

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

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

Parameters:

  • (defaults to: :unset)
  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of InviteInstance



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 193

def page(identity: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        
        'Identity' =>  Twilio.serialize_list(identity) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

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

#stream(identity: :unset, 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.

Parameters:

  • (defaults to: :unset)
  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 that will yield up to limit results



136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 136

def stream(identity: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        identity: identity,
        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



226
227
228
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 226

def to_s
    '#<Twilio.IpMessaging.V2.InviteList>'
end