Class: Twilio::REST::Notify::V1::ServiceContext::UserList

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ UserList

Initialize the UserList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The service_sid



20
21
22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/notify/v1/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, segment: :unset) ⇒ UserInstance

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

Parameters:

  • identity (String) (defaults to: nil) —

    The identity

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

    The segment

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 36

def create(identity: nil, segment: :unset)
  data = Twilio::Values.of({
      'Identity' => identity,
      'Segment' => segment,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  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.



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 106

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



148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 148

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

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

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

    The identity

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

    The segment

  • 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



68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 68

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

#page(identity: :unset, segment: :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:

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

    The identity

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

    The segment

  • 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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 127

def page(identity: :unset, segment: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Identity' => identity,
      'Segment' => segment,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  UserPage.new(@version, response, @solution)
end

#stream(identity: :unset, segment: :unset, 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.

Parameters:

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

    The identity

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

    The segment

  • 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



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 90

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

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



158
159
160
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 158

def to_s
  '#<Twilio.Notify.V1.UserList>'
end