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: ScimUser

Instance Method Summary collapse

Constructor Details

#initialize(version, organization_sid: nil) ⇒ UserList

Initialize the UserList

Parameters:

  • Version that contains the resource



87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 87

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:

  • (defaults to: nil)

Returns:

  • Created UserInstance



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 99

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:

  • (defaults to: nil)

Returns:

  • Created UserInstance



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 120

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.



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

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:

  • API-generated URL for the requested results page

Returns:

  • Page of UserInstance



253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 253

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:

  • (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



156
157
158
159
160
161
162
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 156

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:

  • (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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 196

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:

  • (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 UserInstance



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

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:

  • (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



176
177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 176

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



264
265
266
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 264

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