class Twilio::REST::IpMessaging::V2::ServiceContext::UserList

Public Class Methods

new(version, service_sid: nil) click to toggle source

Initialize the UserList @param [Version] version Version that contains the resource @param [String] service_sid The service_sid @return [UserList] UserList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
20 def initialize(version, service_sid: nil)
21   super(version)
22 
23   # Path Solution
24   @solution = {service_sid: service_sid}
25   @uri = "/Services/#{@solution[:service_sid]}/Users"
26 end

Public Instance Methods

create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) click to toggle source

Create the UserInstance @param [String] identity The identity @param [String] role_sid The role_sid @param [String] attributes The attributes @param [String] friendly_name The friendly_name @param [user.WebhookEnabledType] x_twilio_webhook_enabled The

X-Twilio-Webhook-Enabled HTTP request header

@return [UserInstance] Created UserInstance

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
37 def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
38   data = Twilio::Values.of({
39       'Identity' => identity,
40       'RoleSid' => role_sid,
41       'Attributes' => attributes,
42       'FriendlyName' => friendly_name,
43   })
44   headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
45 
46   payload = @version.create('POST', @uri, data: data, headers: headers)
47 
48   UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
49 end
each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
89 def each
90   limits = @version.read_limits
91 
92   page = self.page(page_size: limits[:page_size], )
93 
94   @version.stream(page,
95                   limit: limits[:limit],
96                   page_limit: limits[:page_limit]).each {|x| yield x}
97 end
get_page(target_url) click to toggle source

Retrieve a single page of UserInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of UserInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
123 def get_page(target_url)
124   response = @version.domain.request(
125       'GET',
126       target_url
127   )
128   UserPage.new(@version, response, @solution)
129 end
list(limit: nil, page_size: nil) click to toggle source

Lists UserInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
62 def list(limit: nil, page_size: nil)
63   self.stream(limit: limit, page_size: page_size).entries
64 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of UserInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of UserInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
106 def page(page_token: :unset, page_number: :unset, page_size: :unset)
107   params = Twilio::Values.of({
108       'PageToken' => page_token,
109       'Page' => page_number,
110       'PageSize' => page_size,
111   })
112 
113   response = @version.page('GET', @uri, params: params)
114 
115   UserPage.new(@version, response, @solution)
116 end
stream(limit: nil, page_size: nil) click to toggle source

Streams UserInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
77 def stream(limit: nil, page_size: nil)
78   limits = @version.read_limits(limit, page_size)
79 
80   page = self.page(page_size: limits[:page_size], )
81 
82   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
83 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
133 def to_s
134   '#<Twilio.IpMessaging.V2.UserList>'
135 end