Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ UserList

Initialize the UserList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Parameters:

  • identity (String) (defaults to: nil)
  • role_sid (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (UserEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 44

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({'Content-Type' => 'application/x-www-form-urlencoded', '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

#create_with_metadata(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Create the UserInstanceMetadata

Parameters:

  • identity (String) (defaults to: nil)
  • role_sid (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (UserEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 81

def create_with_metadata(
  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({'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)
    user_instance = UserInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
    )
    UserInstanceMetadata.new(
        @version,
        user_instance,
        response.headers,
        response.status_code
    )
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.



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 185

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UserInstance



226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 226

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.

Parameters:

  • limit (Integer) (defaults to: nil) —

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

  • page_size (Integer) (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) —

    Array of up to limit results



128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 128

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

Parameters:

  • limit (Integer) (defaults to: nil) —

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

  • page_size (Integer) (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) —

    Array of up to limit results



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 168

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)

    UserPageMetadata.new(@version, response, @solution, limits[:limit])
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.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of UserInstance



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 206

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)

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

Parameters:

  • limit (Integer) (defaults to: nil) —

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

  • page_size (Integer) (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) —

    Enumerable that will yield up to limit results



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 146

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

    page = self.page(
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



237
238
239
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 237

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