Class: Twilio::REST::PreviewIam::Versionless::OrganizationContext::UserList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb

Defined Under Namespace

Classes: ScimPatchOperation, ScimPatchRequest, ScimUser

Instance Method Summary collapse

Constructor Details

#initialize(version, organization_sid: nil) ⇒ UserList

Initialize the UserList

Parameters:

  • version (Version) —

    Version that contains the resource



216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 216

def initialize(version, organization_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { organization_sid: organization_sid }
    @uri = "/#{@solution[:organization_sid]}/scim/Users"
    
end

Instance Method Details

#create(scim_user: nil) ⇒ UserInstance

Create the UserInstance

Parameters:

  • scim_user (ScimUser) (defaults to: nil)

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 228

def create(scim_user: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    headers['Content-Type'] = 'application/scim+json'
    
    headers['Accept'] = 'application/scim+json'
    
    payload = @version.create('POST', @uri, headers: headers, data: scim_user.to_json)
    UserInstance.new(
        @version,
        payload,
        organization_sid: @solution[:organization_sid],
    )
end

#create_with_metadata(scim_user: nil) ⇒ UserInstance

Create the UserInstanceMetadata

Parameters:

  • scim_user (ScimUser) (defaults to: nil)

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 249

def create_with_metadata(scim_user: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    headers['Content-Type'] = 'application/scim+json'
    
    headers['Accept'] = 'application/scim+json'
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: scim_user.to_json)
    user_instance = UserInstance.new(
        @version,
        response.body,
        organization_sid: @solution[:organization_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.



343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 343

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UserInstance



382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 382

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

#list(filter: :unset, 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:

  • filter (String) (defaults to: :unset)
  • 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



285
286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 285

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

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

Returns Array of up to limit results.

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 325

def list_with_metadata(filter: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'filter' => filter,
        
        '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(filter: :unset, 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:

  • filter (String) (defaults to: :unset)
  • 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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 361

def page(filter: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'filter' => filter,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    headers['Accept'] = 'application/scim+json'

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

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

#stream(filter: :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:

  • filter (String) (defaults to: :unset)
  • 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



305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 305

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

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



393
394
395
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 393

def to_s
    '#<Twilio.PreviewIam.Versionless.UserList>'
end