Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::IpMessaging::V2::ServiceContext::UserList
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
Instance Method Summary collapse
-
#create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Create the UserInstance.
-
#each ⇒ Object
When passed a block, yields UserInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of UserInstance records from the API.
-
#initialize(version, service_sid: nil) ⇒ UserList
constructor
Initialize the UserList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists UserInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of UserInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UserInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil) ⇒ UserList
Initialize the UserList
20 21 22 23 24 25 26 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 20 def initialize(version, service_sid: nil) super(version) # Path Solution @solution = {service_sid: service_sid} @uri = "/Services/#{@solution[:service_sid]}/Users" end |
Instance Method Details
#create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Create the UserInstance
37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 37 def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) data = Twilio::Values.of({ 'Identity' => identity, 'RoleSid' => role_sid, 'Attributes' => attributes, 'FriendlyName' => friendly_name, }) headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.create('POST', @uri, data: data, headers: headers) UserInstance.new(@version, payload, service_sid: @solution[:service_sid], ) end |
#each ⇒ Object
When passed a block, yields UserInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
89 90 91 92 93 94 95 96 97 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 89 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 UserInstance records from the API. Request is executed immediately.
123 124 125 126 127 128 129 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 123 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) UserPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists UserInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
62 63 64 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 62 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 UserInstance records from the API. Request is executed immediately.
106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 106 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: params) UserPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UserInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
77 78 79 80 81 82 83 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 77 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
133 134 135 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 133 def to_s '#<Twilio.IpMessaging.V2.UserList>' end |